Add Makefile

Makefile

@@ -0,0 +1,104 @@
+PROJECT_NAME := "poseidon"
+PKG := "gitlab.hpi.de/codeocean/codemoon/$(PROJECT_NAME)"
+UNIT_TESTS = $(shell go list ./... | grep -v /e2e_tests)
+
+DOCKER_E2E_CONTAINER_NAME := "$(PROJECT_NAME)-e2e-tests"
+DOCKER_TAG := "poseidon:latest"
+DOCKER_OPTS := -v $(shell pwd)/configuration.yaml:/configuration.yaml
+
+default: help
+
+.PHONY: all
+all: build
+
+.PHONY: bootstrap
+bootstrap: deps lint-deps git-hooks ## Install all dependencies
+
+.PHONY: deps
+deps: ## Get the dependencies
+	@go get -v -d ./...
+	@go install github.com/vektra/mockery/v2@latest
+
+.PHONY: git-hooks
+git-dir = $(shell git rev-parse --git-dir)
+git-hooks: $(git-dir)/hooks/pre-commit ## Install the git-hooks
+$(git-dir)/hooks/%: git_hooks/%
+	cp $^ $@
+	chmod 755 $@
+
+.PHONY: build
+build: deps ## Build the binary
+	@go build -v $(PKG)
+
+.PHONY: clean
+clean: ## Remove previous build
+	@rm -f $(PROJECT_NAME)
+
+.PHONY: docker
+docker:
+	@CGO_ENABLED=0 make build
+	@docker build -t $(DOCKER_TAG) .
+
+.PHONY: lint-deps
+lint-deps: ## Install linter dependencies
+	@go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
+
+.PHONY: golangci-lint
+golangci-lint: ## Lint the source code using golangci-lint
+	@golangci-lint run ./... --timeout=3m
+
+.PHONY: lint
+lint: golangci-lint ## Lint the source code using all linters
+
+.PHONY: mock
+snaked_name=$(shell sed -e "s/\([A-Z]\)/_\L\1/g" -e "s/^_//" <<< "$(name)")
+mock: deps ## Create/Update a mock. Example: make mock name=apiQuerier pkg=./nomad
+	@mockery \
+      --name=$(name) \
+      --output=$(pkg) \
+      --structname=$(name)Mock \
+      --filename=$(snaked_name)_mock.go \
+      --inpackage \
+      --srcpkg=$(pkg)
+
+.PHONY: test
+test: deps ## Run unit tests
+	@go test -short $(UNIT_TESTS)
+
+.PHONY: race
+race: deps ## Run data race detector
+	@go test -race -short $(UNIT_TESTS)
+
+.PHONY: coverage
+coverage: deps ## Generate code coverage report
+	@go test $(UNIT_TESTS) -v -coverprofile coverage.cov
+	# exclude mock files from coverage
+	@cat coverage.cov | grep -v _mock.go > coverage_cleaned.cov || true
+	@go tool cover -func=coverage_cleaned.cov
+
+.PHONY: coverhtml
+coverhtml: coverage ## Generate HTML coverage report
+	@go tool cover -html=coverage_cleaned.cov -o coverage_unit.html
+
+.PHONY: e2e-test
+e2e-test: ## Run e2e tests
+	@go test ./e2e_tests -v
+
+.PHONY: e2e-docker
+e2e-docker: docker ## Run e2e tests against the Docker container
+	docker run --rm -p 127.0.0.1:7200:7200 \
+       --name $(DOCKER_E2E_CONTAINER_NAME) \
+       -e POSEIDON_SERVER_ADDRESS=0.0.0.0 \
+       $(DOCKER_OPTS) \
+       $(DOCKER_TAG) &
+	@timeout 30s bash -c "until curl -s -o /dev/null http://127.0.0.1:7200/; do sleep 0.1; done"
+	@make e2e-test || EXIT=$$?; docker stop $(DOCKER_E2E_CONTAINER_NAME); exit $$EXIT
+
+.PHONY: help
+HELP_FORMAT="    \033[36m%-25s\033[0m %s\n"
+help: ## Display this help screen
+	@echo "Valid targets:"
+	@grep -E '^[^ ]+:.*?## .*$$' $(MAKEFILE_LIST) | \
+		sort | \
+		awk 'BEGIN {FS = ":.*?## "}; \
+			{printf $(HELP_FORMAT), $$1, $$2}'