Makefile

# Apple Silicon M1/M2 CPUs require enablement of the
# `Use Rosetta for x86/amd64 emulation on Apple Silicon`
# in the `Features in Development` settings category on your Docker Desktop
# in order to use this Makefile to code generate the Go SDK.

.PHONY: all generate patch fetch

CURRENT_UID := $(shell id -u)
CURRENT_GID := $(shell id -g)

SPEC_URL:="https://api.swaggerhub.com/apis/equinix-api/fabric/4.12/swagger.yaml"
SPEC_FETCHED_FILE:=spec.fetched.yaml
SPEC_PATCHED_FILE:=spec.patched.yaml

# https://github.com/OpenAPITools/openapi-generator-cli
OPENAPI_CODEGEN_TAG=v6.4.0
OPENAPI_CODEGEN_IMAGE=openapitools/openapi-generator-cli:${OPENAPI_CODEGEN_TAG} # to use, change gen: to gen-openapitools

# https://github.com/swagger-api/swagger-codegen
SWAGGER_CODEGEN_IMAGE=swaggerapi/swagger-codegen-cli-v3:3.0.34

GIT_ORG=equinix-labs
GIT_REPO=fabric-go
PACKAGE_PREFIX=fabric
PACKAGE_MAJOR=v4
CRI=docker

DOCKER=${CRI} run --rm -u ${CURRENT_UID}:${CURRENT_GID} -v $(CURDIR):/local
DOCKER_SWAGGER=${DOCKER} ${SWAGGER_CODEGEN_IMAGE}
DOCKER_OPENAPI=${DOCKER} ${OPENAPI_CODEGEN_IMAGE}

IMAGE=${SWAGGER_CODEGEN_IMAGE}

GOLANGCI_LINT=golangci-lint


# Update the dependency on the gen job to switch between code generator methods.
# Options will switch between:
# Open API
# Swagger Codegen Docker
all: pull fetch patch generate stage

# Used for github workflows because the spec file is already present in the repo
generate: clean gen mod fmt docs move-other patch-post test

# Update the IMAGE variable above to either ${OPENAPI_CODEGEN_IMAGE} or ${SWAGGER_CODEGEN_IMAGE}
# depending on the job that you will be using to generate the Fabric Go SDK
pull:
	${CRI} pull ${IMAGE}

fetch:
	curl \
		-H 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/100.0.4896.127 Safari/537.36' \
		-o ${SPEC_FETCHED_FILE} ${SPEC_URL}

patch:
	# patch is idempotent, always starting with the fetched
	# fetched file to create the patched file.
	cp ${SPEC_FETCHED_FILE} ${SPEC_PATCHED_FILE}
	ARGS="-o ${SPEC_PATCHED_FILE} ${SPEC_FETCHED_FILE}"; \
	for diff in $(shell find patches/${SPEC_FETCHED_FILE} -name \*.patch | sort -n); do \
		patch --no-backup-if-mismatch -N -t $$ARGS $$diff; \
		ARGS=${SPEC_PATCHED_FILE}; \
	done

clean: clean-docs
	rm -rf ${PACKAGE_PREFIX}

gen: gen-swagger

gen-openapitools:
	${DOCKER_OPENAPI} generate -g go \
		--package-name ${PACKAGE_MAJOR} \
		--model-package types \
		--api-package models \
		--git-user-id ${GIT_ORG} \
		--git-repo-id ${GIT_REPO} \
		-o /local/${PACKAGE_PREFIX}/${PACKAGE_MAJOR} \
		-i /local/${SPEC_PATCHED_FILE}

gen-swagger:
	# see swaggerapi/swagger-codegen-cli-v3 config-help -l go
	# and swaggerapi/swagger-codegen-cli-v3 generate -help
	# bugs: https://github.com/swagger-api/swagger-codegen/issues?q=is%3Aopen+is%3Aissue+label%3A%22Client%3A+Go%22
	${DOCKER_SWAGGER} generate -l go \
		--additional-properties packageName=${PACKAGE_MAJOR} \
		--model-package types \
		--api-package models \
		--git-user-id ${GIT_ORG} \
		--git-repo-id ${GIT_REPO} \
		-t /local/templates/go \
		-o /local/${PACKAGE_PREFIX}/${PACKAGE_MAJOR} \
		-i /local/${SPEC_PATCHED_FILE}

mod:
	rm -f go.mod go.sum
	go mod init github.com/${GIT_ORG}/${GIT_REPO}
	go mod tidy

fmt:
	go run mvdan.cc/gofumpt@v0.3.1 -l -w $(PACKAGE_PREFIX)

patch-post:
	# patch is idempotent, always starting with the generated files
	for diff in $(shell find patches/post -name \*.patch | sort -n); do \
		patch --no-backup-if-mismatch -N -t -p1 -i $$diff; \
	done

clean-docs:
	rm -rf README.md docs

move-docs:
	mv ${PACKAGE_PREFIX}/${PACKAGE_MAJOR}/README.md .
	mv ${PACKAGE_PREFIX}/${PACKAGE_MAJOR}/docs .

docs: clean-docs move-docs

move-other:
	rm -rf api .travis.yml git_push.sh
	rm -f ${PACKAGE_PREFIX}/${PACKAGE_MAJOR}/.travis.yml
	mv ${PACKAGE_PREFIX}/${PACKAGE_MAJOR}/api .
	mv ${PACKAGE_PREFIX}/${PACKAGE_MAJOR}/git_push.sh .

test:
	go test -v ./...

stage:
	test -d .git && git add --intent-to-add README.md docs ${PACKAGE_PREFIX} go.mod go.sum

lint:
	@$(GOLANGCI_LINT) run -v --no-config --fast=false --fix --disable-all --enable goimports $(PACKAGE_PREFIX)