Makefile

#
# SPDX-FileCopyrightText: © 2017-2025 Istari Digital, Inc.
# SPDX-License-Identifier: Apache-2.0
#

BUILD          ?= $(shell git rev-parse --short HEAD)
BUILD_CODENAME ?= dgraph
BUILD_DATE     ?= $(shell git log -1 --format=%ci)
BUILD_BRANCH   ?= $(shell git rev-parse --abbrev-ref HEAD)
BUILD_VERSION  ?= $(shell git describe --always --tags)

export GOPATH  ?= $(shell go env GOPATH)
GOHOSTOS       := $(shell go env GOHOSTOS)
GOHOSTARCH     := $(shell go env GOHOSTARCH)

# Guard against empty GOPATH, which would resolve paths to root (e.g. /bin)
ifeq ($(GOPATH),)
    $(error GOPATH is not set. Please set it explicitly, e.g. export GOPATH=$$HOME/go)
endif

# On non-Linux systems, use a separate directory for Linux binaries and
# a cross-compiler so that CGO is available (required for plugin support).
ifeq ($(GOHOSTOS),linux)
    export LINUX_GOBIN ?= $(GOPATH)/bin
    LINUX_CC          ?= gcc
else
    export LINUX_GOBIN ?= $(GOPATH)/linux_$(GOHOSTARCH)
    ifeq ($(GOHOSTARCH),arm64)
        LINUX_CC ?= aarch64-unknown-linux-gnu-gcc
    else ifeq ($(GOHOSTARCH),amd64)
        LINUX_CC ?= x86_64-unknown-linux-gnu-gcc
    else
        LINUX_CC ?= gcc
    endif
endif

######################
# Build & Release Parameters
# DGRAPH_VERSION flag facilitates setting the dgraph version
# DGRAPH_VERSION flag is used for our release pipelines, where it is set to our release version number automatically
# DGRAPH_VERSION defaults to local, if not specified, for development purposes
######################
DGRAPH_VERSION ?= local

.PHONY: all
all: dgraph ## Build all targets

.PHONY: dgraph
dgraph: ## Build dgraph binary
	$(MAKE) -w -C $@ all

.PHONY: dgraph-coverage
dgraph-coverage:
	$(MAKE) -w -C dgraph test-coverage-binary

.PHONY: version
version: ## Show build version info
	@echo Dgraph: ${BUILD_VERSION}
	@echo Build: ${BUILD}
	@echo Codename: ${BUILD_CODENAME}
	@echo Build date: ${BUILD_DATE}
	@echo Branch: ${BUILD_BRANCH}
	@echo Go version: $(shell go version)

.PHONY: install
install: ## Install dgraph binary
	@echo "Installing dgraph ($(GOHOSTOS)/$(GOHOSTARCH))..."
	@$(MAKE) -C dgraph install
ifneq ($(GOHOSTOS),linux)
	@mkdir -p $(LINUX_GOBIN)
	@echo "Installing dgraph (linux/$(GOHOSTARCH))..."
	@GOOS=linux GOARCH=$(GOHOSTARCH) CGO_ENABLED=1 CC=$(LINUX_CC) $(MAKE) -C dgraph BUILD_TAGS= EXTLDFLAGS=-fuse-ld=bfd dgraph
	@mv dgraph/dgraph $(LINUX_GOBIN)/dgraph
	@echo "Installed dgraph (linux/$(GOHOSTARCH)) to $(LINUX_GOBIN)/dgraph"
endif


.PHONY: uninstall
uninstall: ## Uninstall dgraph binary
	@echo "Uninstalling Dgraph ..."; \
		$(MAKE) -C dgraph uninstall; \

.PHONY: dgraph-installed
dgraph-installed:
	$(MAKE) install

.PHONY: check-deps
check-deps: ## Check test dependencies (pass AUTO_INSTALL=true to auto-install missing ones)
	$(MAKE) -C t check-deps

.PHONY: setup
setup: ## Install all test dependencies automatically
	$(MAKE) check-deps AUTO_INSTALL=true

.PHONY: test
test: check-deps dgraph-installed local-image ## Run tests (default: integration + integration2)
ifdef TAGS
	@echo "Running tests with tags: $(TAGS)"
	go test -v --tags="$(TAGS)" \
		$(if $(TEST),--run="$(TEST)") \
		$(if $(PKG),./$(PKG)/...,./...)
else ifdef FUZZ
	@echo "Discovering and running fuzz tests..."
ifdef PKG
	go test -v -fuzz=Fuzz -fuzztime=$(or $(FUZZTIME),300s) ./$(PKG)/...
else
	@grep -r "^func Fuzz" --include="*_test.go" -l . 2>/dev/null | \
		xargs -I{} dirname {} | sort -u | while read dir; do \
			echo "Fuzzing $$dir..."; \
			go test -v -fuzz=Fuzz -fuzztime=$(or $(FUZZTIME),300s) ./$$dir/...; \
		done
endif
else
ifdef SUITE
	@echo "Running test suite: $(SUITE)"
	$(MAKE) -C t test args="--suite=$(SUITE) $(if $(PKG),--pkg=\"$(PKG)\") $(if $(TEST),--test=\"$(TEST)\") $(if $(TIMEOUT),--timeout=$(TIMEOUT))"
else
	@echo "Running test suite: integration"
	$(MAKE) -C t test args="--suite=integration $(if $(PKG),--pkg=\"$(PKG)\") $(if $(TEST),--test=\"$(TEST)\") $(if $(TIMEOUT),--timeout=$(TIMEOUT))"
	@echo "Running integration2 tests..."
	go test -v --tags="integration2" \
		$(if $(TEST),--run="$(TEST)") \
		$(if $(PKG),./$(PKG)/...,./...)
endif
endif

.PHONY: test-unit
test-unit: ## True unit tests only — no Docker, no integration build tag (i.e. 'make test SUITE=unit')
	$(if $(filter command line,$(origin SUITE)),$(error SUITE= cannot be passed to test-unit; use 'make test SUITE=...' instead))
	@SUITE=unit $(MAKE) test

.PHONY: test-integration
test-integration: ## Integration tests via t/ runner with Docker (i.e. 'make test SUITE=integration')
	$(if $(filter command line,$(origin SUITE)),$(error SUITE= cannot be passed to test-integration; use 'make test SUITE=...' instead))
	@SUITE=integration $(MAKE) test

.PHONY: test-core
test-core: ## Core tests (i.e. 'make test SUITE=core')
	$(if $(filter command line,$(origin SUITE)),$(error SUITE= cannot be passed to test-core; use 'make test SUITE=...' instead))
	@SUITE=core $(MAKE) test

.PHONY: test-integration2
test-integration2: ## Integration2 tests via dgraphtest (i.e. 'make test TAGS=integration2')
	$(if $(filter command line,$(origin TAGS)),$(error TAGS= cannot be passed to test-integration2; use 'make test TAGS=...' instead))
	@TAGS=integration2 $(MAKE) test

.PHONY: test-upgrade
test-upgrade: ## Upgrade tests (i.e. 'make test TAGS=upgrade')
	$(if $(filter command line,$(origin TAGS)),$(error TAGS= cannot be passed to test-upgrade; use 'make test TAGS=...' instead))
	@TAGS=upgrade $(MAKE) test

.PHONY: test-systest
test-systest: ## All systest packages: systest-baseline + systest-heavy (i.e. 'make test SUITE=systest')
	$(if $(filter command line,$(origin SUITE)),$(error SUITE= cannot be passed to test-systest; use 'make test SUITE=...' instead))
	@SUITE=systest $(MAKE) test

.PHONY: test-integration-heavy
test-integration-heavy: ## All heavy tests: systest-heavy + ldbc + load
	$(if $(filter command line,$(origin SUITE)),$(error SUITE= cannot be passed to test-integration-heavy; use 'make test SUITE=...' instead))
	@SUITE=systest-heavy,ldbc,load $(MAKE) test

.PHONY: test-vector
test-vector: ## Vector search tests (i.e. 'make test SUITE=vector')
	$(if $(filter command line,$(origin SUITE)),$(error SUITE= cannot be passed to test-vector; use 'make test SUITE=...' instead))
	@SUITE=vector $(MAKE) test

.PHONY: test-fuzz
test-fuzz: ## Fuzz tests (i.e. 'make test FUZZ=1')
	$(if $(filter command line,$(origin FUZZ)),$(error FUZZ= cannot be passed to test-fuzz; use 'make test FUZZ=...' instead))
	@FUZZ=1 $(MAKE) test

.PHONY: test-all
test-all: ## Every test: all t/ suites + integration2 + upgrade + fuzz
	$(MAKE) test SUITE=all
	$(MAKE) test-integration2
	$(MAKE) test-upgrade
	$(MAKE) test-fuzz

.PHONY: test-benchmark
test-benchmark: check-deps ## Go benchmarks (i.e. 'go test -bench')
	go test -bench=. -benchmem $(if $(PKG),./$(PKG)/...,./...)

.PHONY: local-image
local-image: ## Build local Docker image (dgraph/dgraph:local)
	@echo building local docker image
ifneq ($(GOHOSTOS),linux)
	@GOOS=linux GOARCH=$(GOHOSTARCH) CGO_ENABLED=1 CC=$(LINUX_CC) $(MAKE) BUILD_TAGS= EXTLDFLAGS=-fuse-ld=bfd dgraph
else
	@GOOS=linux GOARCH=$(GOHOSTARCH) $(MAKE) dgraph
endif
	@mkdir -p linux
	@mv ./dgraph/dgraph ./linux/dgraph
	@docker build -f contrib/Dockerfile -t dgraph/dgraph:local .
	@rm -r linux

.PHONY: image-local
image-local: local-image ## Alias for local-image

.PHONY: clean
clean: ## Clean build artifacts
	$(MAKE) -C dgraph clean
	$(MAKE) -C compose clean
	@rm -rf linux
	@go clean -testcache

.PHONY: docker-image
docker-image: dgraph ## Build Docker image (dgraph/dgraph:$VERSION)
	@mkdir -p linux
	@cp ./dgraph/dgraph ./linux/dgraph
	docker build -f contrib/Dockerfile -t dgraph/dgraph:$(DGRAPH_VERSION) .

.PHONY: docker-image-standalone
docker-image-standalone: dgraph docker-image
	@mkdir -p linux
	@cp ./dgraph/dgraph ./linux/dgraph
	$(MAKE) -w -C contrib/standalone all DOCKER_TAG=$(DGRAPH_VERSION) DGRAPH_VERSION=$(DGRAPH_VERSION)

.PHONY: coverage-docker-image
coverage-docker-image: dgraph-coverage
	@mkdir -p linux
	@cp ./dgraph/dgraph ./linux/dgraph
	docker build -f contrib/Dockerfile -t dgraph/dgraph:$(DGRAPH_VERSION) .

# build and run dependencies for ubuntu linux
.PHONY: linux-dependency
linux-dependency:
	sudo apt-get update
	sudo apt-get -y upgrade
	sudo apt-get -y install ca-certificates
	sudo apt-get -y install curl
	sudo apt-get -y	install gnupg
	sudo apt-get -y install lsb-release
	sudo apt-get -y install build-essential
	sudo apt-get -y install protobuf-compiler

.PHONY: help
help: ## Show available targets and variables
	@echo "Usage: make [target] [VAR=value ...]"
	@echo ""
	@echo "Targets:"
	@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | \
		sort | \
		awk 'BEGIN {FS = ":.*?## "}; {printf "  %-20s %s\n", $$1, $$2}'
	@echo ""
	@echo "Variables that can be passed to 'test':"
	@echo "  SUITE     Select t/ runner suite (default: integration + integration2)"
	@echo "  TAGS      Go build tags - bypasses t/ runner (e.g., make test TAGS=integration2)"
	@echo "  PKG       Limit to specific package (e.g., make test PKG=systest/export)"
	@echo "  TEST      Run specific test function (e.g., make test TEST=TestGQLSchema)"
	@echo "  TIMEOUT   Per-package test timeout (e.g., make test TIMEOUT=60m). Default: 30m"
	@echo "  FUZZ      Enable fuzz testing (e.g., make test FUZZ=1)"
	@echo "  FUZZTIME  Fuzz duration per package (e.g., make test FUZZ=1 FUZZTIME=60s)"
	@echo ""
	@printf "  Available SUITE values: "
	@grep -o 'allowed := \[\]string{[^}]*}' t/t.go 2>/dev/null | \
		sed 's/allowed := \[\]string{"\([^}]*\)"}/\1/' | \
		tr -d '"' | tr ',' ' ' || echo "all, unit, core, systest, vector, ldbc, load"
	@printf "  Available TAGS values:  "
	@grep -roh "//go:build [a-z0-9]*" --include="*_test.go" . 2>/dev/null | \
		awk '{print $$2}' | \
		grep -E '^(integration2|upgrade)$$' | \
		sort -u | tr '\n' ' ' && echo ""
	@echo "  Note: 'integration' tests require the t/ runner (use SUITE=, not TAGS=)"
	@echo ""
	@echo "Examples:"
	@echo "  make test TAGS=integration2 PKG=systest/vector        # integration2 tests for vector"
	@echo "  make test TAGS=upgrade PKG=acl TEST=TestACL           # specific upgrade test"
	@echo "  make test FUZZ=1 PKG=dql FUZZTIME=30s                 # fuzz dql package for 30s"
	@echo "  make test SUITE=systest PKG=systest/backup/filesystem # systest for backup pkg"
	@echo "  make test TIMEOUT=90m                                  # all suites with 90m timeout"
	@echo "  make test-benchmark PKG=posting                       # benchmark posting package"