Chart improvements and makefile optimizations.

Author: elliotcourant

Chart.yaml

@@ -15,7 +15,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.0.0
+version: "2021.9.0"
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

Makefile

@@ -7,7 +7,12 @@ BUILD_TIME=$(shell date -u +"%Y-%m-%dT%H:%M:%SZ")
 RELEASE_REVISION=$(shell git rev-parse HEAD)
 MONETR_CLI_PACKAGE = github.com/monetr/rest-api/pkg/cmd
 COVERAGE_TXT = $(PWD)/coverage.txt
-LICENSE=$(LOCAL_BIN)/golicense
+
+ifndef ENVIRONMENT
+ENVIRONMENT = Staging
+endif
+
+ENV_LOWER = $(shell echo $(ENVIRONMENT) | tr A-Z a-z)
 
 PATH+=\b:$(GOPATH)/bin:$(LOCAL_BIN):$(NODE_MODULES_BIN)
 
@@ -33,18 +38,26 @@ define warningMsg
 	@echo "\033[1;33m[$@] $(1)\033[0m"
 endef
 
+GO_SRC_DIR=$(PWD)/pkg
+ALL_GO_FILES=$(wildcard $(GO_SRC_DIR)/**/*.go)
+APP_GO_FILES=$(filter-out $(GO_SRC_DIR)/**/*_test.go, $(ALL_GO_FILES))
+TEST_GO_FILES=$(wildcard $(GO_SRC_DIR)/**/*_test.go)
+
+GO_DEPS=go.mod go.sum
 
-default: build test
+include $(PWD)/scripts/*.mk
 
-dependencies: go.mod go.sum
+default: build
+
+dependencies: $(GO_DEPS)
 	$(call infoMsg,Installing dependencies for monetrs rest-api)
 	go get ./...
 
-build: dependencies $(wildcard $(PWD)/pkg/**/*.go)
+build: dependencies $(APP_GO_FILES)
 	$(call infoMsg,Building rest-api binary)
 	go build -o $(LOCAL_BIN)/monetr $(MONETR_CLI_PACKAGE)
 
-test:
+test: dependencies $(ALL_GO_FILES)
 	$(call infoMsg,Running go tests for monetr rest-api)
 ifndef CI
 	go run $(MONETR_CLI_PACKAGE) database migrate -d $(POSTGRES_DB) -U $(POSTGRES_USER) -H $(POSTGRES_HOST)
@@ -53,57 +66,55 @@ endif
 	go tool cover -func=$(COVERAGE_TXT)
 
 clean:
-	echo $$PATH
-	rm -rf $(LOCAL_BIN) || true
-	rm -rf $(COVERAGE_TXT) || true
-	rm -rf $(NODE_MODULES_DIR) || true
-	rm -rf $(VENDOR_DIR) || true
-	rm -rf $(LOCAL_TMP) || true
-
-.PHONY: docs
-docs:
-	swag init -d pkg/controller -g controller.go --parseDependency --parseDepth 5 --parseInternal
+	-rm -rf $(LOCAL_BIN)
+	-rm -rf $(COVERAGE_TXT)
+	-rm -rf $(NODE_MODULES_DIR)
+	-rm -rf $(VENDOR_DIR)
+	-rm -rf $(LOCAL_TMP)
+
+docs: $(SWAG) $(APP_GO_FILES)
+	$(SWAG) init -d $(GO_SRC_DIR)/controller -g controller.go \
+		--parseDependency \
+		--parseDepth 5 \
+		--parseInternal \
+		--output $(PWD)/docs
 
 docs-local: docs
 	redoc-cli serve $(PWD)/docs/swagger.yaml
 
-docker:
+docker: Dockerfile $(APP_GO_FILES)
 	docker build \
 		--build-arg REVISION=$(RELEASE_REVISION) \
 		--build-arg BUILD_TIME=$(BUILD_TIME) \
-		-t harder-rest-api -f Dockerfile .
+		-t monetr-rest-api -f Dockerfile .
 
 docker-work-web-ui:
 	docker build -t workwebui -f Dockerfile.work .
 
-$(LOCAL_BIN):
-	mkdir $(LOCAL_BIN)
-
-$(LOCAL_TMP):
-	mkdir $(LOCAL_TMP)
-
-$(LICENSE):
-	@if [ ! -f "$(LICENSE)" ]; then make install-$(LICENSE); fi
-
-LICENSE_REPO=https://github.com/mitchellh/golicense.git
-LICENSE_TMP=$(LOCAL_TMP)/golicense
-install-$(LICENSE): $(LOCAL_BIN) $(LOCAL_TMP)
-	$(call infoMsg,Installing golicense to $(LICENSE))
-	rm -rf $(LICENSE_TMP) || true
-	git clone $(LICENSE_REPO) $(LICENSE_TMP)
-	cd $(LICENSE_TMP) && go build -o $(LICENSE) .
-	rm -rf $(LICENSE_TMP) || true
-
-.PHONY: license
 ifdef GITHUB_TOKEN
 license: $(LICENSE) build
 	$(call infoMsg,Checking dependencies for open source licenses)
-	- $(LICENSE) $(PWD)/licenses.hcl $(LOCAL_BIN)/monetr
+	-$(LICENSE) $(PWD)/licenses.hcl $(LOCAL_BIN)/monetr
 else
+.PHONY: license
 license:
 	$(call warningMsg,GITHUB_TOKEN is required to check licenses)
 endif
 
+generate: OUTPUT_DIR = $(PWD)/generated/$(ENV_LOWER)
+generate: IMAGE_TAG=$(shell git rev-parse HEAD)
+generate: VALUES_FILE=$(PWD)/values.$(ENV_LOWER).yaml
+generate: $(HELM) $(SPLIT_YAML)
+	$(call infoMsg,Generating Kubernetes yaml using Helm output to:  $(OUTPUT_DIR))
+	$(call infoMsg,Environment:                                      $(ENVIRONMENT))
+	$(call infoMsg,Using values file:                                $(VALUES_FILE))
+	$(HELM) template rest-api ./ \
+		--dry-run \
+		--set image.tag="$(IMAGE_TAG)" \
+		--set podAnnotations."monetr\.dev/date"="$(shell date)" \
+		--set podAnnotations."monetr\.dev/sha"="$(IMAGE_TAG)" \
+		--values=values.$(ENV_LOWER).yaml | $(SPLIT_YAML) --outdir $(OUTPUT_DIR) -
+
 ifdef GITLAB_CI
 include Makefile.gitlab-ci
 include Makefile.deploy

Makefile.deploy

@@ -1,68 +1,7 @@
-LOCAL_TMP = $(PWD)/tmp
-LOCAL_BIN = $(PWD)/bin
-PATH:=$(PATH):$(LOCAL_BIN)
-HELM_VERSION = 3.5.4
-ARCH = amd64
-OS = $(shell uname -s | tr A-Z a-z)
-
-ifndef ENVIRONMENT
-ENVIRONMENT = Staging
-endif
-
-ENV_LOWER = $(shell echo $(ENVIRONMENT) | tr A-Z a-z)
-
 default-deploy:
 	echo "Please run a specific target."
 
-clean-deploy:
-	rm -rf $(LOCAL_BIN) || true
-	rm -rf $(LOCAL_TMP) || true
-
-SPLIT_YAML = kubernetes-split-yaml
-HELM = helm
-dependencies-maybe:
-	which $(SPLIT_YAML) || make dependencies-split-yaml
-	which $(HELM) || make dependencies-helm
-	rm -rf $(LOCAL_TMP) || true
-
-directories-maybe:
-	mkdir -p $(LOCAL_TMP)
-	mkdir -p $(LOCAL_BIN)
-
-SPLIT_YAML_REPO = https://github.com/mogensen/kubernetes-split-yaml.git
-dependencies-split-yaml: directories-maybe
-	$(eval SPLIT_YAML_DIR := "$(LOCAL_TMP)/$(SPLIT_YAML)")
-	rm -rfd $(SPLIT_YAML_DIR) || true
-	git clone $(SPLIT_YAML_REPO) $(SPLIT_YAML_DIR)
-	cd $(SPLIT_YAML_DIR) && go build ./...
-	cp $(SPLIT_YAML_DIR)/$(SPLIT_YAML) $(LOCAL_BIN)/$(SPLIT_YAML)
-	rm -rfd $(SPLIT_YAML_DIR)
-
-HELM_DIR = $(LOCAL_TMP)/$(HELM)
-HELM_TAR = $(HELM_DIR)/$(HELM).tar.gz
-HELM_URL = "https://get.helm.sh/helm-v$(HELM_VERSION)-$(OS)-$(ARCH).tar.gz"
-HELM_BIN_DIR = $(OS)-$(ARCH)
-dependencies-helm: directories-maybe
-	rm -rf $(HELM_DIR) || true
-	mkdir -p $(HELM_DIR)
-	curl -SsL $(HELM_URL) --output $(HELM_TAR)
-	tar -xzf $(HELM_TAR) -C $(HELM_DIR)
-	cp $(HELM_DIR)/$(HELM_BIN_DIR)/$(HELM) $(LOCAL_BIN)/$(HELM)
-	rm -rf $(HELM_DIR)
-
-ENVIRONMENT_DIR = $(PWD)/generated/$(ENV_LOWER)
-IMAGE_TAG = $(shell git rev-parse HEAD)
-generate: dependencies-maybe
-	$(eval REPO_SHA = $(shell git rev-parse HEAD))
-	$(eval REPO_NAME = $(shell git config --get remote.origin.url))
-	helm template rest-api ./ \
-		--dry-run \
-		--set image.tag="$(IMAGE_TAG)" \
-		--set podAnnotations."monetr\.dev/date"="$(shell date)" \
-		--set podAnnotations."monetr\.dev/sha"="$(REPO_SHA)" \
-		--values=values.$(ENV_LOWER).yaml | kubernetes-split-yaml \
-		--outdir $(ENVIRONMENT_DIR) -
-
+ENVIRONMENT_DIR=$(PWD)/generated/$(ENV_LOWER)
 NAMESPACE = monetr-$(ENV_LOWER)
 dry:
 	kubectl apply -f $(ENVIRONMENT_DIR) -n $(NAMESPACE) --dry-run=server

Makefile.local

@@ -5,14 +5,10 @@ ARCH = amd64
 OS = $(shell uname -s | tr A-Z a-z)
 
 # Tools used to run the application locally
-HELM=helm
-HOSTESS=$(LOCAL_BIN)/hostess
 JQ=$(LOCAL_BIN)/jq
 KUBECTL=minikube kubectl --
-SPLIT_YAML=kubernetes-split-yaml
 YQ=$(LOCAL_BIN)/yq
 VAULT=vault
-MKCERT=mkcert
 PGO=$(LOCAL_BIN)/pgo
 
 # This is the domain that is used for local development. You can change it to anything you want here and run init-mini
@@ -50,7 +46,7 @@ clean-mini: stop-mini clean-certificates
 	rm -rf $(LOCAL_TMP) || true
 	rm -rf $(LOCAL_BIN) || true
 
-init-mini: info local-dependencies-maybe
+init-mini: info
 	$(call infoMsg,Setting stuff up)
 	$(MAKE) setup-certificates
 	(minikube status | grep "minikube start") && $(MAKE) start-minikube
@@ -108,7 +104,7 @@ clean-certificates:
 
 NGINX_DEPLOYMENT=ingress-nginx-controller
 TLS_SECRET_NAME=monetr-tls
-setup-certificates: $(LOCAL_DIR)
+setup-certificates: $(LOCAL_DIR) $(MKCERT)
 	mkdir -p $(LOCAL_CERTS)
 	$(MKCERT) -install
 	$(MKCERT) -key-file $(KEY_PATH) -cert-file $(CERT_PATH) $(LOCAL_DOMAIN) *.$(LOCAL_DOMAIN)
@@ -186,32 +182,13 @@ pg-tls-values: $(YQ)
 	$(YQ) e '.api.customEnv[0].valueFrom.secretKeyRef.key = "password"' -i $(VALUES)
 	$(YQ) e '.api.customEnv[0].valueFrom.secretKeyRef.name = "postgres-postgres-secret"' -i $(VALUES)
 
-local-dependencies-maybe:
-	$(call infoMsg,Getting any dependencies needed to run everything locally)
-	which minikube || $(MAKE) dependencies-minikube
-	which $(HELM) || $(MAKE) dependencies-helm
-	which $(SPLIT_YAML) || $(MAKE) dependencies-split-yaml
-	which $(MKCERT) || $(MAKE) dependencies-mkcert
-
 MINIKUBE_VERSION=latest
 dependencies-minikube:
 	rm -rf $(PWD)/minikube-$(OS)-$(ARCH) || true
 	curl -LO https://storage.googleapis.com/minikube/releases/$(MINIKUBE_VERSION)/minikube-$(OS)-$(ARCH)
 	sudo install minikube-$(OS)-$(ARCH) $(LOCAL_BIN)/minikube
 	rm -rf $(PWD)/minikube-$(OS)-$(ARCH)
 
-HOSTESS_REPO=https://github.com/cbednarski/hostess
-$(HOSTESS):
-	@if [ ! -f "$(HOSTESS)" ]; then make install-$(HOSTESS); fi
-
-HOSTESS_DIR=$(LOCAL_TMP)/hostess
-install-$(HOSTESS): $(LOCAL_BIN) $(LOCAL_TMP)
-	$(call infoMsg,Installing hostess to $(HOSTESS))
-	rm -rf $(HOSTESS_DIR) || true
-	git clone $(HOSTESS_REPO) $(HOSTESS_DIR)
-	cd $(HOSTESS_DIR) && go build -o $(HOSTESS) .
-	rm -rf $(HOSTESS_DIR)
-
 ifeq ($(OS),darwin)
 JQ_OS=osx
 else
@@ -246,17 +223,6 @@ install-$(YQ): $(LOCAL_BIN) $(LOCAL_TMP)
 	mv $(YQ_DIR)/yq_$(OS)_$(ARCH) $(YQ)
 	rm -rf $(YQ_DIR) || true
 
-
-MKCERT_REPO=https://github.com/FiloSottile/mkcert
-MKCERT_DIR=$(LOCAL_TMP)/$(MKCERT)
-dependencies-mkcert: $(LOCAL_TMP) $(LOCAL_BIN)
-	$(call infoMsg,Installing $(MKCERT) to $(LOCAL_BIN)/$(MKCERT))
-	rm -rf $(MKCERT_DIR) || true
-	git clone https://github.com/FiloSottile/mkcert $(MKCERT_DIR)
-	cd $(MKCERT_DIR) && go build -ldflags "-X main.Version=$$(git describe --tags)"
-	cp $(MKCERT_DIR)/$(MKCERT) $(LOCAL_BIN)/$(MKCERT)
-	rm -rf $(MKCERT_DIR) || true
-
 update-coredns:
 	$(call infoMsg,Updating CoreDNS config)
 	$(KUBECTL) apply -f $(PWD)/minikube/coredns-config.yaml --namespace=kube-system
@@ -334,8 +300,6 @@ shell:
 		--rm -ti --image=$(SHELL_IMAGE) \
 	 	-n $(MINIKUBE_NAMESPACE) --
 
-values-file: local-dependencies-maybe $(VALUES)
-
 $(LOCAL_REST_API_DEPLOY):
 	mkdir -p $(LOCAL_REST_API_DEPLOY)
 
@@ -356,7 +320,7 @@ build-rest-api-mini: wait-for-docker $(YQ)
 		docker push $(BASE_IMAGE_NAME):latest
 	$(YQ) e '.image.tag = "$(GO_HASH)"' -i $(VALUES)
 
-deploy-mini-application: $(VALUES) $(LOCAL_REST_API_DEPLOY) build-rest-api-mini $(YQ)
+deploy-mini-application: $(HELM) $(VALUES) $(LOCAL_REST_API_DEPLOY) build-rest-api-mini $(YQ)
 	$(eval CONFIG_HASH = $(shell md5 -q $(VALUES)))
 	CONFIG_HASH=$(CONFIG_HASH) $(YQ) e '.podAnnotations.configHash = strenv(CONFIG_HASH)' -i $(VALUES)
 	$(HELM) template $(REST_API_IMAGE_NAME) $(PWD) \

pkg/controller/controller.go

@@ -113,12 +113,12 @@ func NewController(
 
 // @contact.name Support
 // @contact.url http://github.com/monetr/rest-api
-
 // @license.name Business Source License 1.1
 // @license.url https://github.com/monetr/rest-api/blob/main/LICENSE
-
 // @host api.monetr.app
 
+
+
 // @tag.name Funding Schedules
 // @tag.description Funding Schedules are created by the user to tell us when money should be taken from their account to fund their goals and expenses.