Makefile

# Copyright SecureKey Technologies Inc.
#
# SPDX-License-Identifier: Apache-2.0

GO_CMD ?= go
ARIES_AGENT_REST_PATH=cmd/aries-agent-rest
ARIES_AGENT_MOBILE_PATH=cmd/aries-agent-mobile
SIDETREE_CLI_PATH=test/bdd/cmd/sidetree
OPENAPI_DOCKER_IMG=quay.io/goswagger/swagger
OPENAPI_SPEC_PATH=build/rest/openapi/spec
OPENAPI_DOCKER_IMG_VERSION=v0.23.0

# Namespace for the agent images
DOCKER_OUTPUT_NS   ?= aries-framework-go
AGENT_REST_IMAGE_NAME   ?= agent-rest
WEBHOOK_IMAGE_NAME ?= sample-webhook

# Tool commands (overridable)
DOCKER_CMD ?= docker
GO_CMD     ?= go
ALPINE_VER ?= 3.18
GO_TAGS    ?=
GO_VER ?= 1.20.5
PROJECT_ROOT = github.com/hyperledger/aries-framework-go
GOBIN_PATH=$(abspath .)/build/bin
MOCKGEN=$(GOBIN_PATH)/mockgen
GOMOCKS=pkg/internal/gomocks

.PHONY: all
all: clean checks unit-test unit-test-wasm unit-test-mobile bdd-test

.PHONY: checks
checks: license lint generate-openapi-spec

.PHONY: lint
lint: lint-core lint-components

.PHONY: lint-core
lint-core:
	@scripts/check_lint.sh

.PHONY: lint-components
lint-components:
	@scripts/check_lint_components.sh

.PHONY: license
license:
	@scripts/check_license.sh

.PHONY: unit-test
unit-test: mocks
	@scripts/check_unit.sh

.PHONY: unit-test-ursa
unit-test-ursa: mocks
	@scripts/check_unit_ursa.sh

.PHONY: benchmark
benchmark:
	@scripts/check_bench.sh

.PHONY: unit-test-wasm
unit-test-wasm: export GOBIN=$(GOBIN_PATH)
unit-test-wasm: depend
	@scripts/check_unit_wasm.sh

.PHONY: unit-test-mobile
unit-test-mobile:
	@echo "Running unit tests for mobile"
	@cd ${ARIES_AGENT_MOBILE_PATH} && $(MAKE) unit-test

.PHONY: bdd-test
bdd-test: clean generate-test-keys agent-rest-docker sample-webhook-docker sidetree-cli bdd-test-js bdd-test-go

.PHONY: bdd-test-go
bdd-test-go:
	@scripts/check_go_integration.sh

.PHONY: bdd-test-js
bdd-test-js:
	@scripts/check_js_integration.sh

bdd-test-js-local:
	@scripts/check_js_integration.sh test-local

bdd-test-js-debug:
	@scripts/check_js_integration.sh test-debug


.PHONY: vc-test-suite
vc-test-suite: clean
	@scripts/run_vc_test_suite.sh

.PHONY: bbs-interop-test
bbs-interop-test:
	@scripts/check_bbs_interop.sh

generate-test-keys: clean
	@mkdir -p -p test/bdd/fixtures/keys/tls
	@docker run -i --rm \
		-v $(abspath .):/opt/go/src/$(PROJECT_ROOT) \
		--entrypoint "/opt/go/src/$(PROJECT_ROOT)/scripts/generate_test_keys.sh" \
		frapsoft/openssl

.PHONY: generate-openapi-spec
generate-openapi-spec: clean
	@echo "Generating and validating controller API specifications using Open API"
	@mkdir -p build/rest/openapi/spec
	@SPEC_META=$(ARIES_AGENT_REST_PATH) SPEC_LOC=${OPENAPI_SPEC_PATH}  \
	DOCKER_IMAGE=$(OPENAPI_DOCKER_IMG) DOCKER_IMAGE_VERSION=$(OPENAPI_DOCKER_IMG_VERSION)  \
	scripts/generate-openapi-spec.sh

.PHONY: generate-openapi-demo-specs
generate-openapi-demo-specs: clean generate-openapi-spec agent-rest-docker sample-webhook-docker
	@echo "Generate demo agent rest controller API specifications using Open API"
	@SPEC_PATH=${OPENAPI_SPEC_PATH} OPENAPI_DEMO_PATH=test/bdd/fixtures/demo/openapi \
    	DOCKER_IMAGE=$(OPENAPI_DOCKER_IMG) DOCKER_IMAGE_VERSION=$(OPENAPI_DOCKER_IMG_VERSION)  \
    	scripts/generate-openapi-demo-specs.sh

.PHONY: run-openapi-demo
run-openapi-demo: generate-test-keys generate-openapi-demo-specs
	@echo "Starting demo agent rest containers ..."
	@DEMO_COMPOSE_PATH=test/bdd/fixtures/demo/openapi SIDETREE_COMPOSE_PATH=test/bdd/fixtures/sidetree-mock AGENT_REST_COMPOSE_PATH=test/bdd/fixtures/agent-rest  \
        scripts/run-openapi-demo.sh

.PHONY: stop-openapi-demo
stop-openapi-demo:
	@echo "Stopping demo agent rest containers ..."
	@DEMO_COMPOSE_PATH=test/bdd/fixtures/demo/openapi SIDETREE_COMPOSE_PATH=test/bdd/fixtures/sidetree-mock AGENT_REST_COMPOSE_PATH=test/bdd/fixtures/agent-rest  \
        DEMO_COMPOSE_OP=down scripts/run-openapi-demo.sh

.PHONY: agent-rest
agent-rest:
	@echo "Building aries-agent-rest"
	@mkdir -p ./build/bin
	@cd ${ARIES_AGENT_REST_PATH} && go build -o ../../build/bin/aries-agent-rest main.go

.PHONY: agent-rest-acapy-interop
agent-rest-acapy-interop:
	@echo "Building aries-agent-rest for aca-py interop"
	@mkdir -p ./build/bin
	@cd ${ARIES_AGENT_REST_PATH} && go build -o ../../build/bin/aries-agent-rest -tags ACAPyInterop main.go

.PHONY: agent-mobile
agent-mobile:
	@echo "Building aries-agent-mobile"
	@cd ${ARIES_AGENT_MOBILE_PATH} && $(MAKE) all

.PHONY: sidetree-cli
sidetree-cli:
	@echo "Building sidetree-cli"
	@mkdir -p ./build/bin
	@cd ${SIDETREE_CLI_PATH} && go build -o ../../../../build/bin/sidetree main.go

.PHONY: agent-rest-docker
agent-rest-docker:
	@echo "Building aries agent rest docker image"
	@docker build -f ./images/agent-rest/Dockerfile --no-cache -t $(DOCKER_OUTPUT_NS)/$(AGENT_REST_IMAGE_NAME):latest \
	--build-arg GO_VER=$(GO_VER) \
	--build-arg ALPINE_VER=$(ALPINE_VER) \
	--build-arg GO_TAGS=$(GO_TAGS) \
	--build-arg GOPROXY=$(GOPROXY) .

.PHONY: sample-webhook
sample-webhook:
	@echo "Building sample webhook server"
	@mkdir -p ./build/bin
	@go build -o ./build/bin/webhook-server test/bdd/webhook/main.go

.PHONY: sample-webhook-docker
sample-webhook-docker:
	@echo "Building sample webhook server docker image"
	@docker build -f ./images/mocks/webhook/Dockerfile --no-cache -t $(DOCKER_OUTPUT_NS)/$(WEBHOOK_IMAGE_NAME):latest \
	--build-arg GO_VER=$(GO_VER) \
	--build-arg ALPINE_VER=$(ALPINE_VER) \
	--build-arg GO_TAGS=$(GO_TAGS) \
	--build-arg GOPROXY=$(GOPROXY) .

comma:= ,
semicolon:= ;
mocks_dir =

define create_mock
  $(eval mocks_dir := $(subst pkg,$(GOMOCKS),$(1)))
  @echo Creating $(mocks_dir)
  @mkdir -p $(mocks_dir) && rm -rf $(mocks_dir)/*
  @$(MOCKGEN) -destination $(mocks_dir)/mocks.gen.go -self_package mocks -package mocks $(PROJECT_ROOT)/$(1) $(subst $(semicolon),$(comma),$(2))
endef

define create_spi_provider_mocks
  $(eval mocks_dir := $(GOMOCKS)/spi/storage)
  @echo Creating $(mocks_dir)
  @mkdir -p $(mocks_dir) && rm -rf $(mocks_dir)/*
  @$(MOCKGEN) -destination $(mocks_dir)/mocks.gen.go -self_package mocks -package mocks $(PROJECT_ROOT)/$(1) $(subst $(semicolon),$(comma),$(2))
endef

depend:
	@mkdir -p ./build/bin
	GOBIN=$(GOBIN_PATH) go install github.com/golang/mock/mockgen@v1.5.0
	GOBIN=$(GOBIN_PATH) go install github.com/agnivade/wasmbrowsertest@v0.7.0

.PHONY: mocks
mocks: depend clean-mocks
	$(call create_mock,pkg/framework/aries/api/vdr,Registry)
	$(call create_mock,pkg/kms,Provider;KeyManager)
	$(call create_mock,pkg/didcomm/protocol/issuecredential,Provider)
	$(call create_mock,pkg/didcomm/protocol/middleware/issuecredential,Provider;Metadata)
	$(call create_mock,pkg/didcomm/protocol/middleware/presentproof,Provider;Metadata)
	$(call create_mock,pkg/client/outofband,Provider;OobService)
	$(call create_mock,pkg/client/outofbandv2,Provider;OobService)
	$(call create_mock,pkg/didcomm/protocol/presentproof,Provider)
	$(call create_mock,pkg/client/introduce,Provider;ProtocolService)
	$(call create_mock,pkg/client/issuecredential,Provider;ProtocolService)
	$(call create_mock,pkg/client/presentproof,Provider;ProtocolService)
	$(call create_mock,pkg/didcomm/protocol/introduce,Provider)
	$(call create_mock,pkg/didcomm/common/service,DIDComm;Event;Messenger;MessengerHandler)
	$(call create_mock,pkg/didcomm/dispatcher,Outbound)
	$(call create_mock,pkg/didcomm/messenger,Provider)
	$(call create_mock,pkg/store/verifiable,Store)
	$(call create_mock,pkg/store/did,ConnectionStore)
	$(call create_mock,pkg/controller/command/presentproof,Provider)
	$(call create_mock,pkg/controller/command/issuecredential,Provider)
	$(call create_mock,pkg/controller/webnotifier,Notifier)
	$(call create_spi_provider_mocks,spi/storage,Provider;Store)

.PHONY: clean-mocks
clean-mocks:
	@if [ -d $(GOMOCKS) ]; then rm -r $(GOMOCKS); echo "Folder $(GOMOCKS) was removed!"; fi

.PHONY: clean
clean: clean-fixtures clean-build clean-images

.PHONY: clean-images
clean-images: clean-fixtures
clean-images: IMAGES=$(shell docker image ls | grep aries-framework-go | awk '{print $$3}')
clean-images:
	@if [ ! -z "$(IMAGES)" ]; then \
		echo "Cleaning aries-framework-go docker images ..."; \
		docker rmi -f $(IMAGES); \
	fi;

.PHONY: clean-build
clean-build:
	@rm -f coverage.out
	@rm -Rf ./build
	@rm -Rf $(ARIES_AGENT_MOBILE_PATH)/build
	@rm -Rf ./test/bdd/db
	@rm -Rf ./test/bdd/*.log

.PHONY: clean-fixtures
clean-fixtures:
	@rm -Rf ./test/bdd/fixtures/keys/tls
	@rm -Rf ./test/bdd/fixtures/demo/openapi/specs
	@cd test/bdd/fixtures/demo/openapi && docker-compose down 2> /dev/null
	@cd test/bdd/fixtures/sidetree-mock && docker-compose down 2> /dev/null
	@cd test/bdd/fixtures/agent-rest && docker-compose down 2> /dev/null

.PHONY: tidy-modules
tidy-modules:
	@find . -type d \( -name build -prune \) -o -name go.mod -print | while read -r gomod_path; do \
		dir_path=$$(dirname "$$gomod_path"); \
		echo "Executing 'go mod tidy' in directory: $$dir_path"; \
		(cd "$$dir_path" && go mod tidy) || exit 1; \
	done