Makefile

SHELL=/bin/bash -o pipefail

export PWD := $(shell pwd)
export PATH := ${PWD}/.bin/gobin:${PWD}/.bin/brew/bin:${PWD}/.bin/brew/sbin:${PATH}

GO_DEPENDENCIES = golang.org/x/tools/cmd/goimports \
				  github.com/mattn/goveralls \
				  github.com/ory/go-acc \
				  github.com/bufbuild/buf/cmd/buf \
				  google.golang.org/protobuf/cmd/protoc-gen-go \
				  google.golang.org/grpc/cmd/protoc-gen-go-grpc \
				  github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc \
				  github.com/josephburnett/jd \
				  github.com/mikefarah/yq/v4 \
				  golang.org/x/tools/cmd/stringer \
				  github.com/mdempsky/go114-fuzz-build

BREW_DEPENDENCIES = go-swagger@0.29.0 \
					grype@0.40.1 \
					cli@0.1.35 \
					trivy@0.29.2

define make-go-dependency
  # go install is responsible for not re-building when the code hasn't changed
  tools/$2: .bin/gobin/go.mod .bin/gobin/go.sum Makefile
		cd .bin/gobin; GOBIN=$(PWD)/.bin/gobin go install $1
endef
$(foreach dep, $(GO_DEPENDENCIES), $(eval $(call make-go-dependency,$(dep),$(notdir $(dep)))))

tools/yq: .bin/gobin/go.mod .bin/gobin/go.sum Makefile
		cd .bin/gobin; GOBIN=$(PWD)/.bin/gobin go install github.com/mikefarah/yq/v4

define make-brew-dependency
  tools/$(firstword $(subst @, ,$(notdir $1))): tools/brew Makefile
		HOMEBREW_NO_AUTO_UPDATE=1 brew install keto/tools/$1
endef
$(foreach dep, $(BREW_DEPENDENCIES), $(eval $(call make-brew-dependency,$(dep))))

tools/protobuf: tools/brew Makefile
		HOMEBREW_NO_AUTO_UPDATE=1 brew install protobuf@3.19

node_modules: package.json package-lock.json Makefile
		npm ci

.PHONY: tools/brew
tools/brew:
		./scripts/install-brew.sh

# this is not using the tools/* prefix, as a github action has hardcoded paths for this
.PHONY: .bin/clidoc
.bin/clidoc:
		go build -o .bin/clidoc ./cmd/clidoc/.

.PHONY: format
format: tools/goimports node_modules
		goimports -w -local github.com/ory/keto *.go internal cmd contrib ketoctx ketoapi embedx
		npm run format

.PHONY: install
install:
		go install -tags sqlite .

.PHONY: docker
docker:
		docker build -t oryd/keto:latest -f .docker/Dockerfile-build .

# Generates the SDKs
.PHONY: sdk
sdk: tools/go-swagger tools/cli node_modules
		rm -rf internal/httpclient internal/httpclient-next
		swagger generate spec -m -o spec/swagger.json \
			-c github.com/ory/keto \
			-c github.com/ory/x/healthx \
			-x internal/httpclient \
			-x internal/e2e
		ory dev swagger sanitize ./spec/swagger.json
		swagger validate ./spec/swagger.json
		CIRCLE_PROJECT_USERNAME=ory CIRCLE_PROJECT_REPONAME=keto \
				ory dev openapi migrate \
					--health-path-tags metadata \
					-p https://raw.githubusercontent.com/ory/x/master/healthx/openapi/patch.yaml \
					-p file://.schema/openapi/patches/meta.yaml \
					spec/swagger.json spec/api.json

		mkdir -p internal/httpclient internal/httpclient-next
		swagger generate client -f ./spec/swagger.json -t internal/httpclient -A Ory_Keto

		npm run openapi-generator-cli -- generate -i "spec/api.json" \
				-g go \
				-o "internal/httpclient-next" \
				--git-user-id ory \
				--git-repo-id keto-client-go \
				--git-host github.com \
				-t .schema/openapi/templates/go \
				-c .schema/openapi/gen.go.yml

		make format

.PHONY: build
build:
		go build -tags sqlite

#
# Generate APIs and client stubs from the definitions
#
.PHONY: buf-gen
buf-gen: tools/buf tools/protobuf tools/protoc-gen-go tools/protoc-gen-go-grpc tools/protoc-gen-doc node_modules
		buf generate
		@echo "All code was generated successfully!"

#
# Lint API definitions
#
.PHONY: buf-lint
buf-lint: tools/buf
		buf lint
		@echo "All lint checks passed successfully!"

#
# Generate after linting succeeded
#
.PHONY: buf
buf: buf-lint buf-gen

.PHONY: test-e2e
test-e2e:
		go test -tags sqlite -failfast -v ./internal/e2e

.PHONY: test-docs-samples
test-docs-samples: tools/jd
		cd ./contrib/docs-code-samples \
		&& \
		npm i \
		&& \
		npm test

.PHONY: fuzz-test
fuzz-test:
		go test -tags=sqlite -fuzz=FuzzParser -fuzztime=10s ./internal/schema

.PHONY: libfuzzer-fuzz-test
libfuzzer-fuzz-test: .bin/go114-fuzz-build
		mkdir -p .fuzzer
		.bin/go114-fuzz-build -o ./.fuzzer/parser.a ./internal/schema
		clang -fsanitize=fuzzer ./.fuzzer/parser.a -o ./.fuzzer/parser
		./.fuzzer/parser -timeout=1 -max_total_time=10 -use_value_profile

.PHONY: cve-scan
cve-scan: docker tools/grype
		grype oryd/keto:latest

.PHONY: post-release
post-release: tools/yq
		cat docker-compose.yml | yq '.services.keto.image = "oryd/keto:'$$DOCKER_TAG'"' | sponge docker-compose.yml
		cat docker-compose-mysql.yml | yq '.services.keto-migrate.image = "oryd/keto:'$$DOCKER_TAG'"' | sponge docker-compose-mysql.yml
		cat docker-compose-postgres.yml | yq '.services.keto-migrate.image = "oryd/keto:'$$DOCKER_TAG'"' | sponge docker-compose-postgres.yml

.PHONY: generate
generate: tools/stringer
		go generate ./...