Makefile

SHELL := /bin/bash
.DEFAULT_GOAL := build
OPENAPI ?= data-repository-service-schemas/openapi/data_repository_service.openapi.yaml
OAPI_CODEGEN ?= go run github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen@v2.8.0
REDOCLY_IMAGE ?= redocly/cli:latest
YQ_IMAGE ?= mikefarah/yq:latest
MKDOCS_IMAGE ?= squidfunk/mkdocs-material:latest
OPENAPI_DIR ?= apigen/openapi
CODEGEN_CONFIG_DIR ?= apigen/codegen
LFS_OPENAPI ?= $(OPENAPI_DIR)/lfs.openapi.yaml
BUCKET_OPENAPI ?= $(OPENAPI_DIR)/bucket.openapi.yaml
METRICS_OPENAPI ?= $(OPENAPI_DIR)/metrics.openapi.yaml
INTERNAL_OPENAPI ?= $(OPENAPI_DIR)/internal.openapi.yaml
ERROR_OPENAPI ?= $(OPENAPI_DIR)/error.openapi.yaml
SCHEMAS_SUBMODULE ?= data-repository-service-schemas
OAPI_DRS_CONFIG ?= $(CODEGEN_CONFIG_DIR)/oapi-drs.yaml
OAPI_LFS_CONFIG ?= $(CODEGEN_CONFIG_DIR)/oapi-lfs.yaml
OAPI_BUCKET_CONFIG ?= $(CODEGEN_CONFIG_DIR)/oapi-bucket.yaml
OAPI_METRICS_CONFIG ?= $(CODEGEN_CONFIG_DIR)/oapi-metrics.yaml
OAPI_INTERNAL_CONFIG ?= $(CODEGEN_CONFIG_DIR)/oapi-internal.yaml
OAPI_ERROR_CONFIG ?= $(CODEGEN_CONFIG_DIR)/oapi-error.yaml

AUTO_INIT_SUBMODULE ?= 0
GOCACHE ?= $(PWD)/.gocache
BUILD_OUTPUT ?= bin/syfon
REMOTE ?= origin
VERSION ?=
DRY_RUN ?= 0
RUN_TESTS ?= 1
APIGEN_TAG_PREFIX ?= apigen
CLIENT_TAG_PREFIX ?= client

.PHONY: init-schemas
init-schemas:
	@git submodule update --init --recursive --depth 1 "$(SCHEMAS_SUBMODULE)"

GIT_VERSION ?= $(shell git describe --tags --always --match 'v[0-9]*' --dirty='-dirty' 2>/dev/null || echo dev)
GIT_COMMIT  ?= $(shell git rev-parse --short HEAD 2>/dev/null || echo unknown)
GIT_BRANCH  ?= $(shell git rev-parse --abbrev-ref HEAD 2>/dev/null || echo unknown)
BUILD_DATE  ?= $(shell date -u +%Y-%m-%dT%H:%M:%SZ)
GIT_UPSTREAM ?= $(shell git rev-parse --abbrev-ref --symbolic-full-name @{u} 2>/dev/null || echo unknown)
LDFLAGS     := -X github.com/calypr/syfon/internal/version.Version=$(GIT_VERSION) \
               -X github.com/calypr/syfon/internal/version.GitCommit=$(GIT_COMMIT) \
               -X github.com/calypr/syfon/internal/version.GitBranch=$(GIT_BRANCH) \
               -X github.com/calypr/syfon/internal/version.BuildDate=$(BUILD_DATE) \
               -X github.com/calypr/syfon/internal/version.GitUpstream=$(GIT_UPSTREAM)

.PHONY: build
build:
	@mkdir -p "$(dir $(BUILD_OUTPUT))"
	CGO_ENABLED=1 GOCACHE="$(GOCACHE)" go build -ldflags "$(LDFLAGS)" -o "$(BUILD_OUTPUT)" .

.PHONY: install
install:
	@GOCACHE="$(GOCACHE)" go install -ldflags "$(LDFLAGS)" .

.PHONY: gen
gen:
	@set -euo pipefail; \
	mkdir -p .tmp; \
	spec="$(OPENAPI)"; \
	if [[ ! -f "$$spec" ]]; then \
		  if [[ "$(AUTO_INIT_SUBMODULE)" == "1" ]]; then \
		    echo "OpenAPI spec '$$spec' not found. Initializing submodule..."; \
		    git submodule update --init --recursive --depth 1 "$(SCHEMAS_SUBMODULE)"; \
		  fi; \
	fi; \
	if [[ ! -f "$$spec" ]]; then \
	  echo "ERROR: OpenAPI spec '$$spec' not found."; \
	  echo "Run: make init-schemas"; \
	  echo "Or: make gen AUTO_INIT_SUBMODULE=1"; \
	  exit 1; \
	fi; \
	if ! command -v docker >/dev/null 2>&1; then \
	  echo "ERROR: docker is required for 'make gen'."; \
	  exit 1; \
	fi; \
	echo "Bundling canonical OpenAPI spec with Redocly..."; \
	docker run --rm \
	  --user "$$(id -u):$$(id -g)" \
	  -v "$(PWD):/local" \
	  $(REDOCLY_IMAGE) bundle /local/$$spec --output /local/.tmp/drs.base.yaml --ext yaml; \
	mkdir -p "$(OPENAPI_DIR)" apigen; \
	cp .tmp/drs.base.yaml "$(OPENAPI_DIR)/openapi.yaml"; \
	docker run --rm \
	  --user "$$(id -u):$$(id -g)" \
	  -v "$(PWD):/local" \
	  $(YQ_IMAGE) eval --from-file /local/$(OPENAPI_DIR)/syfon-error.yq -i /local/$(OPENAPI_DIR)/openapi.yaml; \
	echo "Bundled canonical DRS OpenAPI spec into ./$(OPENAPI_DIR)/openapi.yaml"; \
	$(MAKE) gen-api

.PHONY: gen-api
gen-api:
	@set -euo pipefail; \
	mkdir -p apigen/errorapi apigen/drs apigen/lfsapi apigen/bucketapi apigen/metricsapi apigen/internalapi; \
	echo "Generating the shared API error model..."; \
	$(OAPI_CODEGEN) -config "$(OAPI_ERROR_CONFIG)" "$(ERROR_OPENAPI)" > apigen/errorapi/error.gen.go; \
	echo "Generating combined DRS client and Fiber server bindings..."; \
	$(OAPI_CODEGEN) -config "$(OAPI_DRS_CONFIG)" "$(OPENAPI_DIR)/openapi.yaml" > apigen/drs/drs.gen.go; \
	echo "Generating combined LFS client and Fiber server bindings..."; \
	$(OAPI_CODEGEN) -config "$(OAPI_LFS_CONFIG)" "$(LFS_OPENAPI)" > apigen/lfsapi/lfs.gen.go; \
	python3 scripts/patch-lfs-streaming.py apigen/lfsapi/lfs.gen.go; \
	echo "Generating combined bucket client and Fiber server bindings..."; \
	$(OAPI_CODEGEN) -config "$(OAPI_BUCKET_CONFIG)" "$(BUCKET_OPENAPI)" > apigen/bucketapi/bucket.gen.go; \
	echo "Generating combined metrics client and Fiber server bindings..."; \
	$(OAPI_CODEGEN) -config "$(OAPI_METRICS_CONFIG)" "$(METRICS_OPENAPI)" > apigen/metricsapi/metrics.gen.go; \
	echo "Generating combined internal client and Fiber server bindings..."; \
	$(OAPI_CODEGEN) -config "$(OAPI_INTERNAL_CONFIG)" "$(INTERNAL_OPENAPI)" > apigen/internalapi/internal.gen.go; \
	echo "Generated API bindings into ./apigen/{errorapi,drs,lfsapi,bucketapi,metricsapi,internalapi}"

.PHONY: test
test:
	CGO_ENABLED=1 GOCACHE="$(GOCACHE)" go test -count=1 ./... ./client/... ./apigen/...

.PHONY: test-modules
test-modules:
	./scripts/check-independent-modules.sh

.PHONY: test-race
test-race:
	./scripts/run-race-tests.sh

.PHONY: test-unit
test-unit:
	@PKGS=$$(go list ./... ./client/... ./apigen/... | grep -Ev '/tests/endpoints$$'); \
	  CGO_ENABLED=1 GOCACHE="$(GOCACHE)" go test -v -count=1 $$PKGS

.PHONY: coverage
coverage:
	COVERAGE_MIN=75 ./scripts/run_coverage.sh

.PHONY: coverage-meaningful
coverage-meaningful:
	COVERAGE_SCOPE=meaningful COVERAGE_MIN=75 ./scripts/run_coverage.sh

.PHONY: coverage-client
coverage-client:
	COVERAGE_SCOPE=client COVERAGE_MIN=75 ./scripts/run_coverage.sh

.PHONY: coverage-full
coverage-full:
	COVERAGE_SCOPE=full ./scripts/run_coverage.sh

.PHONY: serve
serve:
	go run . serve $(ARGS)

.PHONY: docs
docs:
	docker run --rm \
	  -v "$(PWD):/docs" \
	  --user "$$(id -u):$$(id -g)" \
	  $(MKDOCS_IMAGE) \
	  build --strict

.PHONY: docs-serve
docs-serve:
	docker run --rm $$(test -t 0 && echo -it) \
	  -v "$(PWD):/docs" \
	  --user "$$(id -u):$$(id -g)" \
	  -p 8000:8000 \
	  $(MKDOCS_IMAGE) \
	  serve -a 0.0.0.0:8000

.PHONY: release-plan
release-plan:
	@set -euo pipefail; \
	if [[ -z "$(VERSION)" ]]; then \
	  echo "ERROR: VERSION is required (example: make release-apigen VERSION=v0.1.0)"; \
	  exit 1; \
	fi; \
	echo "remote:      $(REMOTE)"; \
	echo "version:     $(VERSION)"; \
	echo "apigen tag:  $(APIGEN_TAG_PREFIX)/$(VERSION)"; \
	echo "client tag:  $(CLIENT_TAG_PREFIX)/$(VERSION)"; \
	echo "dry run:     $(DRY_RUN)"

.PHONY: release-check-version
release-check-version:
	@set -euo pipefail; \
	if [[ -z "$(VERSION)" ]]; then \
	  echo "ERROR: VERSION is required (example: VERSION=v0.1.0)"; \
	  exit 1; \
	fi; \
	if [[ ! "$(VERSION)" =~ ^v[0-9]+\.[0-9]+\.[0-9]+([-.].+)?$$ ]]; then \
	  echo "ERROR: VERSION must look like vX.Y.Z (got: $(VERSION))"; \
	  exit 1; \
	fi

.PHONY: release-check-clean
release-check-clean:
	@set -euo pipefail; \
	if [[ -n "$$(git status --porcelain)" ]]; then \
	  if [[ "$(DRY_RUN)" == "1" ]]; then \
	    echo "WARN: git tree is dirty (dry run continuing)"; \
	    git status --short; \
	    exit 0; \
	  fi; \
	  echo "ERROR: git tree is dirty. Commit/stash changes before releasing."; \
	  git status --short; \
	  exit 1; \
	fi

.PHONY: release-check-clean-apigen
release-check-clean-apigen:
	@set -euo pipefail; \
	dirty="$$(git status --porcelain -- apigen)"; \
	if [[ -n "$$dirty" ]]; then \
	  if [[ "$(DRY_RUN)" == "1" ]]; then \
	    echo "WARN: apigen tree is dirty (dry run continuing)"; \
	    printf "%s\n" "$$dirty"; \
	    exit 0; \
	  fi; \
	  echo "ERROR: apigen tree is dirty. Commit/stash apigen changes before releasing apigen."; \
	  printf "%s\n" "$$dirty"; \
	  exit 1; \
	fi

.PHONY: release-check-clean-client
release-check-clean-client:
	@set -euo pipefail; \
	dirty="$$(git status --porcelain -- client)"; \
	if [[ -n "$$dirty" ]]; then \
	  if [[ "$(DRY_RUN)" == "1" ]]; then \
	    echo "WARN: client tree is dirty (dry run continuing)"; \
	    printf "%s\n" "$$dirty"; \
	    exit 0; \
	  fi; \
	  echo "ERROR: client tree is dirty. Commit/stash client changes before releasing client."; \
	  printf "%s\n" "$$dirty"; \
	  exit 1; \
	fi

.PHONY: release-check-apigen-tag
release-check-apigen-tag: release-check-version
	@set -euo pipefail; \
	tag="$(APIGEN_TAG_PREFIX)/$(VERSION)"; \
	if git rev-parse "$$tag" >/dev/null 2>&1; then \
	  if [[ "$(DRY_RUN)" == "1" ]]; then \
	    echo "WARN: tag already exists locally (dry run continuing): $$tag"; \
	    exit 0; \
	  fi; \
	  echo "ERROR: tag already exists locally: $$tag"; \
	  exit 1; \
	fi

.PHONY: release-check-client-tag
release-check-client-tag: release-check-version
	@set -euo pipefail; \
	tag="$(CLIENT_TAG_PREFIX)/$(VERSION)"; \
	if git rev-parse "$$tag" >/dev/null 2>&1; then \
	  if [[ "$(DRY_RUN)" == "1" ]]; then \
	    echo "WARN: tag already exists locally (dry run continuing): $$tag"; \
	    exit 0; \
	  fi; \
	  echo "ERROR: tag already exists locally: $$tag"; \
	  exit 1; \
	fi

.PHONY: release-test-apigen
release-test-apigen:
	@set -euo pipefail; \
	if [[ "$(RUN_TESTS)" != "1" ]]; then \
	  echo "Skipping apigen tests (RUN_TESTS=$(RUN_TESTS))"; \
	  exit 0; \
	fi; \
	cd apigen; \
	CGO_ENABLED=1 GOCACHE="$(GOCACHE)" go test ./...

.PHONY: release-test-client
release-test-client:
	@set -euo pipefail; \
	if [[ "$(RUN_TESTS)" != "1" ]]; then \
	  echo "Skipping client tests (RUN_TESTS=$(RUN_TESTS))"; \
	  exit 0; \
	fi; \
	cd client; \
	CGO_ENABLED=1 GOCACHE="$(GOCACHE)" go test ./...

.PHONY: release-apigen
release-apigen: release-check-clean-apigen release-check-apigen-tag release-test-apigen
	@set -euo pipefail; \
	tag="$(APIGEN_TAG_PREFIX)/$(VERSION)"; \
	if [[ "$(DRY_RUN)" == "1" ]]; then \
	  echo "[DRY RUN] git tag -a $$tag -m \"Release $$tag\""; \
	  echo "[DRY RUN] git push $(REMOTE) $$tag"; \
	  exit 0; \
	fi; \
	git tag -a "$$tag" -m "Release $$tag"; \
	git push "$(REMOTE)" "$$tag"; \
	echo "Released $$tag"

.PHONY: release-client
release-client: release-check-clean-client release-check-client-tag release-test-client
	@set -euo pipefail; \
	tag="$(CLIENT_TAG_PREFIX)/$(VERSION)"; \
	if [[ "$(DRY_RUN)" == "1" ]]; then \
	  echo "[DRY RUN] git tag -a $$tag -m \"Release $$tag\""; \
	  echo "[DRY RUN] git push $(REMOTE) $$tag"; \
	  exit 0; \
	fi; \
	git tag -a "$$tag" -m "Release $$tag"; \
	git push "$(REMOTE)" "$$tag"; \
	echo "Released $$tag"

.PHONY: build-local-auth-plugin
build-local-auth-plugin:
	cd plugin/local_auth && go build -o ../../bin/local_auth_plugin .

.PHONY: build-gen3-auth-plugin
build-gen3-auth-plugin:
	cd plugin/gen3_auth && go build -o ../../bin/gen3_auth_plugin .

.PHONY: build-plugins
build-plugins: build-local-auth-plugin build-gen3-auth-plugin

.PHONY: clean test-security test-install
clean:
	rm -rf bin coverage client/coverage apigen/coverage site build dist .tmp
	rm -f syfon *.out meaningful_report.txt test_report.json

test-security:
	GOCACHE="$(GOCACHE)" ./scripts/run-security-tests.sh

test-install:
	python3 -m unittest discover -s tests/install -v

.PHONY: test-release
test-release:
	GOCACHE="$(GOCACHE)" python3 -m unittest discover -s tests/release -v