Makefile Rework (#253)

Author: Janmtbehrens

.github/workflows/continuous-integration.yml

@@ -72,9 +72,9 @@ jobs:
         DOCKER_BUILDKIT: 1
 
     - name: Build Tests
-      run: make build-test
+      run: make build-tests
 
     - name: Run tests with Makefile
       run: make run-tests
       env:
-        DOCKER_BUILDKIT: 1
+        DOCKER_BUILDKIT: 1

Dockerfile

@@ -1,6 +1,6 @@
 ARG CONTEXT=prod
 
-FROM golang:1.24.4-alpine as base
+FROM golang:1.24.4-alpine AS base
 
 ## Setup
 ARG CONTEXT
@@ -24,18 +24,21 @@ EXPOSE 9008
 ## Healthcheck
 HEALTHCHECK CMD ["/app/healthcheck"]
 
+## Command
+COPY ./dev/command.sh ./
+RUN chmod +x command.sh
+CMD ["./command.sh"]
+
 # Development Image
 
-FROM base as dev
+FROM base AS dev
 
 RUN ["go", "install", "github.com/githubnemo/CompileDaemon@latest"]
 
-## Command
-CMD CompileDaemon -log-prefix=false -build="go build ./cmd/server" -command="./server"
 
 # Testing Image
 
-FROM base as tests
+FROM base AS tests
 
 COPY dev/container-tests.sh ./dev/container-tests.sh
 
@@ -48,17 +51,16 @@ RUN apk add --no-cache \
 
 ## Command
 STOPSIGNAL SIGKILL
-CMD ["sleep", "inf"]
 
 # Production Image
 
-FROM base as builder
+FROM base AS builder
 
 RUN CGO_ENABLED=0 go build ./cmd/openslides && \
     CGO_ENABLED=0 go build ./cmd/server && \
     CGO_ENABLED=0 go build ./cmd/healthcheck
 
-FROM scratch as client
+FROM scratch AS client
 
 WORKDIR /
 ENV APP_CONTEXT=prod
@@ -67,7 +69,7 @@ COPY --from=builder /app/openslides .
 
 ENTRYPOINT ["/openslides"]
 
-FROM scratch as prod
+FROM scratch AS prod
 
 ## Setup
 ARG CONTEXT

Makefile

@@ -1,38 +1,59 @@
-SERVICE=manage
+override SERVICE=manage
+
+# Build images for different contexts
 
 build-prod:
-	docker build ./ --tag "openslides-$(SERVICE)" --build-arg CONTEXT="prod" --target "prod"
+	docker build ./ $(ARGS) --tag "openslides-$(SERVICE)" --build-arg CONTEXT="prod" --target "prod"
 
 build-dev:
-	docker build ./ --tag "openslides-$(SERVICE)-dev" --build-arg CONTEXT="dev" --target "dev"
+	docker build ./ $(ARGS) --tag "openslides-$(SERVICE)-dev" --build-arg CONTEXT="dev" --target "dev"
 
-build-test:
-	docker build ./ --tag "openslides-$(SERVICE)-tests" --build-arg CONTEXT="tests" --target "tests"
+build-tests:
+	docker build ./ $(ARGS) --tag "openslides-$(SERVICE)-tests" --build-arg CONTEXT="tests" --target "tests"
 
-all: openslides
+# Tests
 
 run-tests:
 	bash dev/run-tests.sh
 
-test:
+lint:
+	bash dev/run-lint.sh -l
+
+gofmt:
+	gofmt -l -s -w .
+
+########################## Deprecation List ##########################
+
+mkfile_path := $(abspath $(lastword $(MAKEFILE_LIST)))
+
+deprecation-warning:
+	@echo "\033[1;33m DEPRECATION WARNING: This make command is deprecated and will be removed soon! \033[0m"
+
+deprecation-warning-alternative: | deprecation-warning
+	@echo "\033[1;33m Please use the following command instead: $(ALTERNATIVE) \033[0m"
+
+run-dev run-dev-attach run-dev-attached run-dev-standalone run-bash run-dev-interactive stop-dev:
+	@make deprecation-warning-alternative ALTERNATIVE="dev and derivative maketargets are now only available in main repository. (use 'make dev-help' in main repository for more information)"
+
+all: | deprecation-warning openslides
+
+test: | deprecation-warning
 	# Attention: This steps should be the same as in .github/workflows/test.yml.
 	test -z "$(shell gofmt -l .)"
 	go vet ./...
 	go install golang.org/x/lint/golint@latest
 	golint -set_exit_status ./...
 	go test -timeout 10s -race ./...
 
-go-build:
+go-build: | deprecation-warning
 	go build ./cmd/openslides
 
-protoc:
+protoc: | deprecation-warning
 	protoc --go_out=. --go_opt=paths=source_relative \
 	--go-grpc_out=require_unimplemented_servers=false:. --go-grpc_opt=paths=source_relative \
 	proto/manage.proto
 
-mkfile_path := $(abspath $(lastword $(MAKEFILE_LIST)))
-
-openslides:
+openslides: | deprecation-warning
 	docker build . --target builder --tag openslides-manage-builder
 	docker run --interactive --tty --volume $(dir $(mkfile_path)):/build/ --rm openslides-manage-builder sh -c " \
 		if [ $(shell whoami) != root ]; then \

dev/command.sh

@@ -0,0 +1,5 @@
+#!/bin/sh
+# Timeout argument to be used in GitHub Workflows
+
+if [ "$APP_CONTEXT" = "dev" ]; then exec CompileDaemon -log-prefix=false -build="go build ./cmd/server" -command="./server"; fi
+if [ "$APP_CONTEXT" = "tests" ]; then sleep inf; fi

dev/container-tests.sh

@@ -8,8 +8,7 @@ trap 'kill $DOCKERD_PID' EXIT INT TERM ERR
 
 RETRY=0
 MAX=10
-until docker info >/dev/null 2>&1
-do
+until docker info >/dev/null 2>&1; do
   if [ "$RETRY" -ge "$MAX" ]
   then
     echo "Dockerd setup error"
@@ -30,4 +29,4 @@ go test -timeout 60s -race ./... || CATCH=1
 gofmt -l . || CATCH=1
 golint -set_exit_status ./... || CATCH=1
 
-exit $CATCH
+exit $CATCH

dev/run-lint.sh

@@ -0,0 +1,45 @@
+#!/bin/bash
+
+# Executes all linters. Should errors occur, CATCH will be set to 1, causing an erroneous exit code.
+
+echo "########################################################################"
+echo "###################### Run Linters #####################################"
+echo "########################################################################"
+
+# Parameters
+while getopts "ls" FLAG; do
+    case "${FLAG}" in
+    l) LOCAL=true ;;
+    s) SKIP_SETUP=true ;;
+    *) echo "Can't parse flag ${FLAG}" && break ;;
+    esac
+done
+
+# Setup
+CONTAINER_NAME="manage-tests"
+IMAGE_TAG=openslides-manage-tests
+DOCKER_EXEC="docker exec ${CONTAINER_NAME}"
+
+# Safe Exit
+trap 'if [ -z "$LOCAL" ] && [ -z "$SKIP_SETUP" ]; then docker stop $CONTAINER_NAME &> /dev/null && docker rm $CONTAINER_NAME &> /dev/null; fi' EXIT
+
+# Execution
+if [ -z "$LOCAL" ]
+then
+    # Setup
+    if [ -z "$SKIP_SETUP" ]
+    then
+        make build-tests >/dev/null 2>&1
+        docker run -d --name "${CONTAINER_NAME}" "${IMAGE_TAG}"
+    fi
+
+    # Container Mode
+    eval "$DOCKER_EXEC go vet ./..."
+    eval "$DOCKER_EXEC golint -set_exit_status ./..."
+    eval "$DOCKER_EXEC gofmt -l ."
+else
+    # Local Mode
+    go vet ./...
+    golint -set_exit_status ./...
+    gofmt -l -s -w .
+fi

dev/run-tests.sh

@@ -1,17 +1,33 @@
 #!/bin/bash
 
+set -e
+
 # Executes all tests. Should errors occur, CATCH will be set to 1, causing an erroneous exit code.
 
 echo "########################################################################"
 echo "###################### Run Tests and Linters ###########################"
 echo "########################################################################"
 
+# Parameters
+while getopts "s" FLAG; do
+    case "${FLAG}" in
+    s) SKIP_BUILD=true ;;
+    *) echo "Can't parse flag ${FLAG}" && break ;;
+    esac
+done
+
 # Setup
+CONTAINER_NAME="manage-tests"
 IMAGE_TAG=openslides-manage-tests
+LOCAL_PWD=$(dirname "$0")
 
 # Safe Exit
-trap 'docker stop $(docker ps -a -q --filter ancestor=${IMAGE_TAG})' EXIT
+trap 'docker stop "$CONTAINER_NAME" &> /dev/null && docker rm "$CONTAINER_NAME" &> /dev/null' EXIT
 
 # Execution
-make build-test
-docker run --privileged -t ${IMAGE_TAG} ./dev/container-tests.sh
+if [ -z "$SKIP_BUILD" ]; then make build-tests &> /dev/null; fi
+docker run -d --privileged --name "$CONTAINER_NAME" ${IMAGE_TAG}
+docker exec "$CONTAINER_NAME" ./dev/container-tests.sh
+
+# Linters
+bash "$LOCAL_PWD"/run-lint.sh -s