sync with main

.dockerignore

@@ -0,0 +1,7 @@
+.github
+bin
+config.local.yml
+kube
+README.md
+LICENSE
+Makefile

.github/workflows/build-docs.yml

@@ -2,28 +2,24 @@ name: Build docs
 
 on:
   pull_request:
-    branches: [ "main" ]
+    branches: ["main"]
     paths:
       - "routers/**"
-      - '.github/workflows/build-docs.yml'
+      - ".github/workflows/build-docs.yml"
 
 jobs:
   build-docs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+      - uses: actions/checkout@v3
 
-    - name: Build docs
-      run: |       
-        cd scripts
-        source ./path-cmd.sh
-
-        chmod +x ./generate-docs.sh
-        ./generate-docs.sh
-
-        chmod +x ./convert-to-v3-docs.sh
-        ./convert-to-v3-docs.sh
-
-        cd ..
-
+      - name: Build docs
+        run: |
+          cd scripts
+          source ./path-cmd.sh
+
+          chmod +x ./generate-docs.sh
+          ./generate-docs.sh
+
+          cd ..

.github/workflows/generate-build-branch.yml

@@ -23,9 +23,7 @@ jobs:
         chmod +x ./generate-types.sh
         ./generate-types.sh
         chmod +x ./generate-docs.sh
-        ./generate-docs.sh        
-        chmod +x ./convert-to-v3-docs.sh
-        ./convert-to-v3-docs.sh
+        ./generate-docs.sh 
         cd ..
 
         echo "Cloning build branch"
@@ -57,4 +55,4 @@ jobs:
           git push
         else
           echo "No changes to commit"
-        fi
+        fi

.gitignore

@@ -39,4 +39,12 @@ cache/
 
 
 # KubeConfig dir
-kube/
+kube/
+
+# binary
+bin
+go-deploy
+go-deploy.exe
+
+# export package-lock.json
+export/package-lock.json

Dockerfile

@@ -1,18 +1,23 @@
 ############################
 # STEP 1 build executable binary
 ############################
-FROM golang:alpine AS builder
+FROM --platform=$BUILDPLATFORM golang:alpine AS builder
 # Install git.
 RUN apk update && apk add --no-cache git=~2
 
 # Set up working directory
 WORKDIR /app
-COPY . .
+# Copy go.mod and go.sum separately so we only invalidate the downloading layers if we need to
+COPY go.mod go.sum ./
 
 # Fetch dependencies and build the binary
 ENV GO111MODULE=on
-RUN go get -d -v
-RUN CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -o main .
+RUN go mod download
+
+# Copy the rest of the project to ensure code changes doesnt trigger re-download of all deps
+COPY . .
+
+RUN CGO_ENABLED=0 GOOS=$TARGETOS GOARCH=$TARGETARCH go build -a -installsuffix cgo -o main .
 
 
 ############################
@@ -33,8 +38,8 @@ COPY --from=builder /app/index index
 COPY --from=builder /app/docs docs
 
 # Set environment variables and expose necessary port
-ENV PORT 8080
-ENV GIN_MODE release
+ENV PORT=8080
+ENV GIN_MODE=release
 EXPOSE 8080
 
 # Run the Go Gin binary

Makefile

@@ -0,0 +1,74 @@
+# Variables
+BINARY_NAME=go-deploy
+BUILD_DIR=bin
+MAIN_FILE=main.go
+BUILDTIMESTAMP=$(shell date -u +%Y%m%d%H%M%S)
+EXT=$(if $(filter windows,$(GOOS)),.exe,)
+
+# Targets
+.PHONY: all clean build run clean docs release test acc e2e lint
+
+all: build
+
+build:
+	@echo "Building the application..."
+	@mkdir -p $(BUILD_DIR)
+	@CGO_ENABLED=0 go build -o $(BUILD_DIR)/$(BINARY_NAME)$(EXT) .
+	@echo "Build complete."
+
+run: build
+	@echo "Running the application..."
+	@./$(BUILD_DIR)/$(BINARY_NAME)$(EXT)
+
+clean:
+	@echo "Cleaning up..."
+	@rm -rf $(BUILD_DIR)
+	@echo "Clean complete."
+
+docs:
+	@cd scripts && ./generate-docs.sh && ./generate-types.sh
+
+release: docs
+	@echo "Building the application..."
+	@mkdir -p $(BUILD_DIR)
+	@CGO_ENABLED=0 go build -mod=readonly -ldflags "-w -s" -o $(BUILD_DIR)/$(BINARY_NAME)$(EXT) .
+	@echo "Build complete."
+
+test: clean build
+	@go test ./test/acc/...
+	@echo "Starting go-deploy in test mode..."
+	@./$(BUILD_DIR)/$(BINARY_NAME)$(EXT) --mode=test & echo $$! > go_deploy.pid
+	@echo "Waiting for API to become ready..."
+	@until curl --output /dev/null --silent --head --fail http://localhost:8080/healthz; do \
+		echo "Waiting for API to start"; \
+		sleep 1; \
+	done
+	@echo "API is ready!"
+	@echo "Running e2e tests..."
+	@go test ./test/e2e/...
+	@if [ -f go_deploy.pid ]; then \
+		echo "Stopping go-deploy..."; \
+		kill $$(cat go_deploy.pid) && rm -f go_deploy.pid; \
+	fi
+
+acc: clean build
+	@go test ./test/acc/...
+
+e2e: clean build
+	@echo "Starting go-deploy in test mode..."
+	@./$(BUILD_DIR)/$(BINARY_NAME)$(EXT) --mode=test & echo $$! > go_deploy.pid
+	@echo "Waiting for API to become ready..."
+	@until curl --output /dev/null --silent --head --fail http://localhost:8080/healthz; do \
+		echo "Waiting for API to start"; \
+		sleep 1; \
+	done
+	@echo "API is ready!"
+	@echo "Running e2e tests..."
+	@go test ./test/e2e/...
+	@if [ -f go_deploy.pid ]; then \
+		echo "Stopping go-deploy..."; \
+		kill $$(cat go_deploy.pid) && rm -f go_deploy.pid; \
+	fi
+
+lint: 
+	@./scripts/check-lint.sh

README.md

@@ -24,35 +24,25 @@ You can install a local development environment by following the [local environm
 
 Remember to run the tests before creating a pull request.
 
-#### Acceptance Tests
 ```bash
-go test ./test/acc/...
-```
-#### End-to-End Tests
-```bash
-go build -o go-deploy .     # Build
-./go-deploy --mode=test     # Start
-
-# Wait for the API to return 200 on /healthz
-until $(curl --output /dev/null --silent --head --fail http://localhost:8080/healthz); do
-    echo "Waiting for API to start"
-    sleep 1
-done
-go test ./test/e2e/...          # Run e2e tests
+make test
+# or
+# make acc
+# make e2e
 ```
 
 ## 📚 Docs
 
 ### Codebase
 The code base is documented using godoc. You can view the documentation by running the documentation server locally.
 
-1. Install godoc `go install golang.org/x/tools/cmd/godoc`
+1. Install godoc `go install golang.org/x/tools/cmd/godoc@latest`
 2. Run godoc `godoc -http=:6060`
 3. Visit [http://localhost:6060/pkg/go-deploy/](http://localhost:6060/pkg/go-deploy/)
 
 
 ### API
-The API is documented using OpenAPI 3.0 specification and is available at [https://api.cloud.cbh.kth.se/deploy/v2/docs/index.html](https://api.cloud.cbh.kth.se/deploy/v2/docs/index.html).
+The API is documented using OpenAPI 3.1.0 specification and is available at [https://api.cloud.cbh.kth.se/deploy/v2/docs/index.html](https://api.cloud.cbh.kth.se/deploy/v2/docs/index.html).
 
 You can also run the API locally by [setting up the local environment](scripts/local/README.md) and visiting [http://localhost:8080/v2/docs/index.html](http://localhost:8080/v2/docs/index.html).
 

cached.Dockerfile

@@ -0,0 +1,53 @@
+############################
+# STEP 1 build executable binary
+############################
+FROM --platform=$BUILDPLATFORM golang:alpine AS builder
+# Install git.
+RUN apk update && apk add --no-cache git=~2
+
+# Set up working directory
+WORKDIR /app
+# Copy go.mod and go.sum separately so we only invalidate the downloading layers if we need to
+COPY go.mod go.sum ./
+
+# Fetch dependencies and build the binary
+ENV GO111MODULE=on
+RUN --mount=type=cache,target=/go/pkg/mod/ \
+    --mount=type=bind,source=go.sum,target=go.sum \
+    --mount=type=bind,source=go.mod,target=go.mod \
+    go mod download -x
+
+# Copy the rest of the project to ensure code changes doesnt trigger re-download of all deps
+COPY . .
+
+ENV GOCACHE=/root/.cache/go-build
+RUN --mount=type=cache,target=/go/pkg/mod/ \
+    --mount=type=cache,target="/root/.cache/go-build" \
+    CGO_ENABLED=0 GOOS=$TARGETOS GOARCH=$TARGETARCH go build -a -installsuffix cgo -o main .
+
+
+############################
+# STEP 2 build a small image
+############################
+FROM alpine:3
+
+# Set up the working directory
+WORKDIR /go
+
+# Copy the binary from the builder stage
+COPY --from=builder /app/main .
+
+# Copy the "index" folder
+COPY --from=builder /app/index index
+
+# Copy the "docs" folder
+COPY --from=builder /app/docs docs
+
+# Set environment variables and expose necessary port
+ENV PORT=8080
+ENV GIN_MODE=release
+EXPOSE 8080
+
+# Run the Go Gin binary
+ENTRYPOINT ["./main"]
+

cmd/flag.go

@@ -2,15 +2,15 @@ package cmd
 
 import (
 	"context"
-	"go-deploy/pkg/services/cleaner"
-	"go-deploy/pkg/services/confirm"
-	"go-deploy/pkg/services/job_execute"
-	"go-deploy/pkg/services/job_schedule"
-	"go-deploy/pkg/services/logger"
-	metricsWorker "go-deploy/pkg/services/metrics_update"
-	"go-deploy/pkg/services/status_update"
-	"go-deploy/pkg/services/synchronize"
-	"go-deploy/pkg/services/system_state_poll"
+	"github.com/kthcloud/go-deploy/pkg/services/cleaner"
+	"github.com/kthcloud/go-deploy/pkg/services/confirm"
+	"github.com/kthcloud/go-deploy/pkg/services/job_execute"
+	"github.com/kthcloud/go-deploy/pkg/services/job_schedule"
+	"github.com/kthcloud/go-deploy/pkg/services/logger"
+	metricsWorker "github.com/kthcloud/go-deploy/pkg/services/metrics_update"
+	"github.com/kthcloud/go-deploy/pkg/services/status_update"
+	"github.com/kthcloud/go-deploy/pkg/services/synchronize"
+	"github.com/kthcloud/go-deploy/pkg/services/system_state_poll"
 )
 
 // FlagDefinition represents a definition for a flag that is passed to the program's executable.

cmd/server.go

@@ -5,19 +5,20 @@ import (
 	"errors"
 	argFlag "flag"
 	"fmt"
-	"github.com/gin-gonic/gin"
-	"go-deploy/models/mode"
-	"go-deploy/pkg/config"
-	"go-deploy/pkg/db"
-	"go-deploy/pkg/db/migrate"
-	"go-deploy/pkg/db/resources/job_repo"
-	"go-deploy/pkg/intializer"
-	"go-deploy/pkg/log"
-	"go-deploy/pkg/metrics"
-	"go-deploy/routers"
 	"net/http"
 	"os"
 	"time"
+
+	"github.com/gin-gonic/gin"
+	"github.com/kthcloud/go-deploy/models/mode"
+	"github.com/kthcloud/go-deploy/pkg/config"
+	"github.com/kthcloud/go-deploy/pkg/db"
+	migrator "github.com/kthcloud/go-deploy/pkg/db/migrate"
+	"github.com/kthcloud/go-deploy/pkg/db/resources/job_repo"
+	"github.com/kthcloud/go-deploy/pkg/intializer"
+	"github.com/kthcloud/go-deploy/pkg/log"
+	"github.com/kthcloud/go-deploy/pkg/metrics"
+	"github.com/kthcloud/go-deploy/routers"
 )
 
 type Options struct {
@@ -128,10 +129,8 @@ func (app *App) Stop() {
 			log.Fatalln(fmt.Errorf("failed to shutdown server. details: %w", err))
 		}
 
-		select {
-		case <-ctx.Done():
-			log.Println("Saiting for http server to shutdown...")
-		}
+		<-ctx.Done()
+		log.Println("Saiting for http server to shutdown...")
 	}
 
 	shutdown()