Makefile

# ====================================================================================
# Setup Project
# If you are building the provider locally for the first time and you see macro errors related to the makefile, run `make submodules`
PROJECT_NAME := crossplane-provider-ionoscloud
PROJECT_REPO := github.com/ionos-cloud/$(PROJECT_NAME)

PLATFORMS ?= linux_amd64 linux_arm64
-include build/makelib/common.mk

# Setup Output
-include build/makelib/output.mk

# Setup Golang
NPROCS ?= 1
GO_TEST_PARALLEL := $(shell echo $$(( $(NPROCS) / 2 )))
GO_STATIC_PACKAGES = $(GO_PROJECT)/cmd/provider
GO_LDFLAGS += -X $(GO_PROJECT)/internal/version.Version=$(VERSION)
GO_SUBDIRS += cmd internal apis
GO111MODULE = on
-include build/makelib/golang.mk

# Setup Kubernetes tools
-include build/makelib/k8s_tools.mk

# Setup Images
DOCKER_REGISTRY ?= crossplane
REGISTRY ?= ghcr.io
ORG_NAME ?= ionos-cloud
VERSION ?= latest
PROVIDER_IMAGE = $(REGISTRY)/$(ORG_NAME)/$(PROJECT_NAME)
PACKAGE_PROVIDER_IMAGE = $(PROVIDER_IMAGE):$(VERSION)
IMAGE_PATH = $(REGISTRY)/$(ORG_NAME)/$(PROVIDER_NAME)
PKG_PATH = $(REGISTRY)/$(ORG_NAME)/$(PKG_NAME)
IMAGES = $(PROJECT_NAME)
PLATFORMS = linux_amd64

CROSSPLANE_NAMESPACE = crossplane-system
CROSSPLANE_VERSION ?= 1.20.1
KIND_CLUSTER_NAME = $(PROJECT_NAME)-dev
# use a custom DeploymentRuntimeConfig file for e2e tests and local deployment
DRC_FILE = $(ROOT_DIR)/cluster/local/debug-config.yaml
-include build/makelib/imagelight.mk
-include build/makelib/local.xpkg.mk

# Setup XPKG

XPKG_REG_ORGS ?= $(REGISTRY)/$(ORG_NAME)
XPKG_REG_ORGS_NO_PROMOTE ?= $(REGISTRY)/$(ORG_NAME)
XPKGS = $(PROJECT_NAME)
-include build/makelib/xpkg.mk

# Setup documentation
DOCS_OUT?=$(shell pwd)/docs/api

.PHONY: docs.update
docs.update:
	@DOCS_OUT=${DOCS_OUT} go run tools/doc/main.go

.PHONY: docker.list
docker.list:
	@docker image list

.PHONY: docker.tag
docker.tag:
	@docker tag $(PROVIDER_IMAGE) $(PROVIDER_IMAGE):$(VERSION)

.PHONY: docker.push
docker.push:
	@docker push $(PROVIDER_IMAGE):$(VERSION)

fallthrough: submodules
	@echo Initial setup complete. Running make again . . .
	@make

crds.clean:
	@$(INFO) cleaning generated CRDs
	@find package/crds -name *.yaml -exec sed -i.sed -e '1,2d' {} \; || $(FAIL)
	@find package/crds -name *.yaml.sed -delete || $(FAIL)
	@$(OK) cleaned generated CRDs

generate: crds.clean

# integration tests
e2e.run: test-integration

# Run integration tests.
test-integration: $(YQ) cluster-clean cluster local.xpkg.deploy.provider.$(PROJECT_NAME)
	@$(INFO) running integration tests using kind $(KIND_VERSION)
	@$(ROOT_DIR)/cluster/local/integration_tests.sh VERSION=$(VERSION) KIND_CLUSTER_NAME=$(KIND_CLUSTER_NAME) CROSSPLANE_NAMESPACE=$(CROSSPLANE_NAMESPACE) || $(FAIL)
	@$(OK) integration tests passed

# Run sss e2e tests. To run these tests, you need IONOS_TOKEN defined as an env variable
sss_e2e:
	@$(INFO) running statefulserverset e2e tests
	@go test -v -timeout 60m -tags=sss_e2e ./internal/controller/compute/statefulserverset/... || $(FAIL)
	@$(OK) statefulserverset e2e tests passed

# Run mock tests sequentially (each suite binds :8080 for metrics)
mock-tests:
	@$(INFO) running mock tests
	@$(INFO) running datacenter mock tests
	@go test -v -timeout 10m -tags=datacenter_mock ./internal/controller/compute/datacenter/... || $(FAIL)
	@$(OK) datacenter mock tests passed
	@$(INFO) running firewallrule mock tests
	@go test -v -timeout 10m -tags=firewallrule_mock ./internal/controller/compute/firewallrule/... || $(FAIL)
	@$(OK) firewallrule mock tests passed
	@$(INFO) running ipblock mock tests
	@go test -v -timeout 10m -tags=ipblock_mock ./internal/controller/compute/ipblock/... || $(FAIL)
	@$(OK) ipblock mock tests passed
	@$(INFO) running lan mock tests
	@go test -v -timeout 10m -tags=lan_mock ./internal/controller/compute/lan/... || $(FAIL)
	@$(OK) lan mock tests passed
	@$(INFO) running nic mock tests
	@go test -v -timeout 10m -tags=nic_mock ./internal/controller/compute/nic/... || $(FAIL)
	@$(OK) nic mock tests passed
	@$(INFO) running server mock tests
	@go test -v -timeout 10m -tags=server_mock ./internal/controller/compute/server/... || $(FAIL)
	@$(OK) server mock tests passed
	@$(INFO) running volume mock tests
	@go test -v -timeout 10m -tags=volume_mock ./internal/controller/compute/volume/... || $(FAIL)
	@$(OK) volume mock tests passed
	@$(OK) all mock tests passed

# Update the submodules, such as the common build scripts.
submodules:
	@git submodule sync
	@git submodule update --init --recursive

# NOTE(hasheddan): the build submodule currently overrides XDG_CACHE_HOME in
# order to force the Helm 3 to use the .work/helm directory. This causes Go on
# Linux machines to use that directory as the build cache as well. We should
# adjust this behavior in the build submodule because it is also causing Linux
# users to duplicate their build cache, but for now we just make it easier to
# identify its location in CI so that we cache between builds.
go.cachedir:
	@go env GOCACHE

build.init: $(CROSSPLANE_CLI)

# This is for running out-of-cluster locally, and is for convenience. Running
# this make target will print out the command which was used. For more control,
# try running the binary directly with different arguments.
run: go.build
	@$(INFO) Running Crossplane locally out-of-cluster . . .
	@# To see other arguments that can be provided, run the command with --help instead
	$(GO_OUT_DIR)/provider --debug

cluster: $(KIND) $(KUBECTL) $(HELM)
	@$(INFO) Creating kind cluster
	@$(KIND) create cluster --name=$(KIND_CLUSTER_NAME)
	@$(KUBECTL) cluster-info --context kind-$(KIND_CLUSTER_NAME)
	@$(INFO) Installing Crossplane Chart
	@$(HELM) repo add crossplane-stable https://charts.crossplane.io/stable
	@$(HELM) install crossplane --namespace $(CROSSPLANE_NAMESPACE) crossplane-stable/crossplane --create-namespace --version $(CROSSPLANE_VERSION)
	@$(KUBECTL) config set-context kind-$(KIND_CLUSTER_NAME) --namespace=$(CROSSPLANE_NAMESPACE)

dev: cluster
	@$(INFO) Installing Provider IONOS Cloud CRDs
	@$(KUBECTL) apply -R -f package/crds
	@$(INFO) Starting Provider IONOS Cloud controllers
	@$(GO) run cmd/provider/main.go --debug

cluster-clean: $(KIND) $(KUBECTL)
	@$(INFO) Deleting kind cluster
	@$(KIND) delete cluster --name=$(KIND_CLUSTER_NAME)

dev-clean: cluster-clean

.PHONY: submodules fallthrough test-integration mock-tests run crds.clean cluster dev dev-clean cluster-clean

# ====================================================================================
# Special Targets

# Install gomplate
GOMPLATE_VERSION := 3.10.0
GOMPLATE := $(TOOLS_HOST_DIR)/gomplate-$(GOMPLATE_VERSION)

$(GOMPLATE):
	@$(INFO) installing gomplate $(SAFEHOSTPLATFORM)
	@mkdir -p $(TOOLS_HOST_DIR)
	@curl -fsSLo $(GOMPLATE) https://github.com/hairyhenderson/gomplate/releases/download/v$(GOMPLATE_VERSION)/gomplate_$(SAFEHOSTPLATFORM) || $(FAIL)
	@chmod +x $(GOMPLATE)
	@$(OK) installing gomplate $(SAFEHOSTPLATFORM)

export GOMPLATE

# This target prepares repo for your provider by replacing all "template"
# occurrences with your provider name.
# This target can only be run once, if you want to rerun for some reason,
# consider stashing/resetting your git state.
# Arguments:
#   provider: Camel case name of your provider, e.g. GitHub, PlanetScale
provider.prepare:
	@[ "${provider}" ] || ( echo "argument \"provider\" is not set"; exit 1 )
	@PROVIDER=$(provider) ./hack/helpers/prepare.sh

# This target adds a new api type and its controller.
# You would still need to register new api in "apis/<provider>.go" and
# controller in "internal/controller/<provider>.go".
# Arguments:
#   provider: Camel case name of your provider, e.g. GitHub, PlanetScale
#   group: API group for the type you want to add.
#   kind: Kind of the type you want to add
#	apiversion: API version of the type you want to add. Optional and defaults to "v1alpha1"
provider.addtype: $(GOMPLATE)
	@[ "${provider}" ] || ( echo "argument \"provider\" is not set"; exit 1 )
	@[ "${group}" ] || ( echo "argument \"group\" is not set"; exit 1 )
	@[ "${kind}" ] || ( echo "argument \"kind\" is not set"; exit 1 )
	@PROVIDER=$(provider) GROUP=$(group) KIND=$(kind) APIVERSION=$(apiversion) PROJECT_REPO=$(PROJECT_REPO) ./hack/helpers/addtype.sh

define CROSSPLANE_MAKE_HELP
Crossplane Targets:
    submodules            Update the submodules, such as the common build scripts.
    run                   Run crossplane locally, out-of-cluster. Useful for development.

endef
# The reason CROSSPLANE_MAKE_HELP is used instead of CROSSPLANE_HELP is because the crossplane
# binary will try to use CROSSPLANE_HELP if it is set, and this is for something different.
export CROSSPLANE_MAKE_HELP

crossplane.help:
	@echo "$$CROSSPLANE_MAKE_HELP"

help-special: crossplane.help

.PHONY: crossplane.help help-special