github.com/codeready-toolchain/api@v0.0.0-20240507023248-73662d6db2c5/make/generate.mk

# current groupname and version of the operators'API
API_GROUPNAME=toolchain
API_FULL_GROUPNAME=toolchain.dev.openshift.com
API_VERSION:=v1alpha1

# how to dispatch the CRD files per repository (space-separated lists)
# !!! IMPORTANT !!! - when there is a new CRD added or an existing one removed or renamed, don't forget to change it also here: https://github.com/codeready-toolchain/toolchain-cicd/blob/master/scripts/add-cluster.sh#L52-L73
HOST_CLUSTER_CRDS:=masteruserrecords nstemplatetiers usersignups bannedusers notifications spaces spacebindings socialevents tiertemplates toolchainstatuses toolchainclusters toolchainconfigs usertiers proxyplugins spacerequests spacebindingrequests spaceprovisionerconfigs
MEMBER_CLUSTER_CRDS:=useraccounts nstemplatesets memberstatuses idlers toolchainclusters memberoperatorconfigs spacerequests workspaces spacebindingrequests

PATH_TO_CRD_BASES=config/crd/bases

PROJECT_DIR := $(shell pwd)
# openapi-gen requires the GOPATH env var be set and the codebase be present within it.
# Let's not require $GOPATH be set up in the user's environment and the checkout be
# placed in it.
# Instead, fake it locally.
FAKE_GOPATH=$(PROJECT_DIR)/.fake-gopath
# The root of all codeready-toolchain repos in the GOPATH
CRT_IN_GOPATH=$(FAKE_GOPATH)/src/github.com/codeready-toolchain
# This gives the GOPATH as understood by the go compiler even if the env var is not explicitly set.
# We use this to find the packages that are already downloaded locally to save on the network traffic
# when persuading openapi-gen that our codebase is checked out under the GOPATH.
LOCAL_GOPATH=`$(GO) env GOPATH`

.PHONY: generate
## Generate deepcopy, openapi and CRD files after the API was modified
generate: generate-deepcopy-and-crds generate-openapi dispatch-crds copy-reg-service-template
	
.PHONY: generate-deepcopy-and-crds
generate-deepcopy-and-crds: remove-config controller-gen
	@echo "Re-generating the deepcopy go file & the Toolchain CRD files... "
	$(Q)$(CONTROLLER_GEN) crd \
	object paths="./..." output:crd:artifacts:config=$(PATH_TO_CRD_BASES)
	
.PHONY: generate-openapi
generate-openapi: openapi-gen
	@echo "re-generating the openapi go file..."
	@## First, let's clean up anything that might have been left around...
	@rm -Rf $(FAKE_GOPATH)
	mkdir -p $(FAKE_GOPATH)
	@mkdir -p $(CRT_IN_GOPATH)
	@## link the packages from the local GOPATH to not have to download them again
	@if [ -d $(LOCAL_GOPATH)/pkg ]; then cd $(FAKE_GOPATH) && ln -s $(LOCAL_GOPATH)/pkg; fi
	@## link our codebase to the appropriate place in the fake GOPATH
	@cd $(CRT_IN_GOPATH) && ln -s ../../../.. api
	@## run openapi-gen from within the fake GOPATH (otherwise the package paths would be relative
	@## and function names would be different)
	GOPATH=$(FAKE_GOPATH) \
	&& cd $(CRT_IN_GOPATH)/api \
	&& $(OPENAPI_GEN) --input-dirs ./api/$(API_VERSION)/ \
	--output-package github.com/codeready-toolchain/api/api/$(API_VERSION) \
	--output-file-base zz_generated.openapi \
	--go-header-file=make/go-header.txt
	@## clean up the mess
	rm -Rf $(FAKE_GOPATH)

# make sure that that the `host-operator` and `member-operator` repositories exist locally 
# and that they don't have any pending changes (except for the CRD files). 
# The reasonning here is that when a change is made in the `api` repository, the resulting changes 
# in the `host-operator` and `member-operator` repositories can be pushed at the same time on GitHub, 
# without having to wait for some other feature or fix to be completed.
# TODO: we could even go further and checkout new branches from `master` in the 'host-operator'
# and 'member-operator` repositories and give them the name of the current branch in this repo.
# The developer would have 3 branches with the same name and could then push to GitHub at the 
# same time...
host_repo_status := $(shell cd ../host-operator && git status -s | grep -v ${PATH_TO_CRD_BASES})
member_repo_status := $(shell cd ../member-operator && git status -s | grep -v ${PATH_TO_CRD_BASES})

PHONY: prepare-host-operator
prepare-host-operator: ../host-operator
ifdef host_repo_status
	@echo "The local '../host-operator' repository has pending changes. Please stash them or commit them, first."
	@exit 1
endif
ifneq ($(wildcard ../host-operator/${PATH_TO_CRD_BASES}/*.yaml),)
	@-find ../host-operator/${PATH_TO_CRD_BASES} -type f | grep -v "cr\.yaml" | xargs rm || true
else
	@-mkdir -p ../host-operator/${PATH_TO_CRD_BASES}
endif

PHONY: prepare-member-operator
prepare-member-operator: ../member-operator
ifdef member_repo_status
	@echo "The local '../member-operator' repository has pending changes. Please stash them or commit them, first."
	@exit 1
endif
ifneq ($(wildcard ../member-operator/${PATH_TO_CRD_BASES}/*.yaml),)
	@-find ../member-operator/${PATH_TO_CRD_BASES} -type f | grep -v "cr\.yaml" | xargs rm || true
else
	@-mkdir -p ../member-operator/${PATH_TO_CRD_BASES}
endif

.PHONY: dispatch-crds
dispatch-crds: prepare-host-operator prepare-member-operator
	@echo "Dispatching CRD files in the 'host-operator' and 'member-operator' repositories..."
    # Dispatching CRD files to operator repositories
	@for crd in $(HOST_CLUSTER_CRDS) ; do \
		cp ${PATH_TO_CRD_BASES}/$(API_FULL_GROUPNAME)_$${crd}.yaml ../host-operator/${PATH_TO_CRD_BASES}/$(API_FULL_GROUPNAME)_$${crd}.yaml ; \
	done
	@for crd in $(MEMBER_CLUSTER_CRDS) ; do \
		cp ${PATH_TO_CRD_BASES}/$(API_FULL_GROUPNAME)_$${crd}.yaml ../member-operator/${PATH_TO_CRD_BASES}/$(API_FULL_GROUPNAME)_$${crd}.yaml ; \
	done
	# Now let's remove the CRDs from config/crd/bases directory
	@for crd in $(HOST_CLUSTER_CRDS) $(MEMBER_CLUSTER_CRDS) ; do \
		rm ${PATH_TO_CRD_BASES}/$(API_FULL_GROUPNAME)_$${crd}.yaml 2>/dev/null || true; \
	done
	@if [[ "$$(ls -A ${PATH_TO_CRD_BASES}/*yaml || true)" ]]; then \
	    echo "ERROR: some CRD files were not dispatched: $$(ls -A ${PATH_TO_CRD_BASES}/*yaml)"; \
	    echo "Please update this Makefile accordingly."; \
	    exit 1; \
	fi
	@echo "Dispatch successfuly finished \o/"

.PHONY: copy-reg-service-template
copy-reg-service-template:
	cp ../registration-service/deploy/registration-service.yaml ../host-operator/deploy/registration-service/registration-service.yaml


CONTROLLER_GEN = $(PROJECT_DIR)/bin/controller-gen
controller-gen: ## Download controller-gen locally if necessary.
	GOBIN=$(PROJECT_DIR)/bin $(GO) install sigs.k8s.io/controller-tools/cmd/controller-gen

OPENAPI_GEN = $(PROJECT_DIR)/bin/openapi-gen
openapi-gen: ## Download openapi-gen locally if necessary.
	GOBIN=$(PROJECT_DIR)/bin $(GO) install k8s.io/kube-openapi/cmd/openapi-gen