Merge remote-tracking branch 'origin/main'

Author: kimdre

.github/workflows/test.yaml

@@ -33,8 +33,8 @@ jobs:
           version: latest
           args: --timeout=5m
 
-  test:
-    name: Acceptance Tests
+  test_compose:
+    name: Test Docker Compose
     runs-on: ubuntu-latest
     timeout-minutes: 10
     services:
@@ -56,7 +56,40 @@ jobs:
           WEBHOOK_SECRET: test_Secret1
           GIT_ACCESS_TOKEN: ${{ secrets.GIT_ACCESS_TOKEN }}
           HTTP_PROXY: http://localhost:3128
+          SOPS_AGE_KEY: ${{ secrets.SOPS_AGE_KEY }}
       - name: Upload coverage reports to Codecov
         uses: codecov/codecov-action@18283e04ce6e62d37312384ff67231eb8fd56d24 # v5.4.3
         with:
-          token: ${{ secrets.CODECOV_TOKEN }}
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: coverage.out
+
+  test_swarm:
+    name: Tests Docker Swarm Mode
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    services:
+      squid-proxy:
+        image: ubuntu/squid:latest@sha256:98f98aaa024e4a58433450f8adde48ef5748f1ae05133b2367d64317cc881a3a
+        ports:
+          - 3128:3128
+
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: actions/setup-go@d35c59abb061a4a6fb18e82ac0862c26744d6ab5 # v5.5.0
+        with:
+          go-version-file: 'go.mod'
+          cache: true
+      - run: go mod download
+      - run: docker swarm init
+      - run: go test -p 1 -v -coverprofile=coverage-swarm.out -covermode=atomic ./... -timeout 5m
+        timeout-minutes: 5
+        env:
+          WEBHOOK_SECRET: test_Secret1
+          GIT_ACCESS_TOKEN: ${{ secrets.GIT_ACCESS_TOKEN }}
+          HTTP_PROXY: http://localhost:3128
+          SOPS_AGE_KEY: ${{ secrets.SOPS_AGE_KEY }}
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@18283e04ce6e62d37312384ff67231eb8fd56d24 # v5.4.3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: coverage-swarm.out

cmd/doco-cd/http_handler.go

@@ -214,11 +214,16 @@ func HandleEvent(ctx context.Context, jobLog *slog.Logger, w http.ResponseWriter
 			return
 		}
 
+		filterLabel := api.ProjectLabel
+		if docker.SwarmModeEnabled {
+			filterLabel = docker.StackNamespaceLabel
+		}
+
 		if deployConfig.Destroy {
 			subJobLog.Debug("destroying stack")
 
 			// Check if doco-cd manages the project before destroying the stack
-			containers, err := docker.GetLabeledContainers(ctx, dockerClient, api.ProjectLabel, deployConfig.Name)
+			containers, err := docker.GetLabeledContainers(ctx, dockerClient, filterLabel, deployConfig.Name)
 			if err != nil {
 				onError(repoName, w, subJobLog.With(logger.ErrAttr(err)), "failed to retrieve containers", err.Error(), jobID, http.StatusInternalServerError)
 
@@ -269,6 +274,17 @@ func HandleEvent(ctx context.Context, jobLog *slog.Logger, w http.ResponseWriter
 				return
 			}
 
+			if docker.SwarmModeEnabled && deployConfig.DestroyOpts.RemoveVolumes {
+				err = docker.RemoveLabeledVolumes(ctx, dockerClient, deployConfig.Name, filterLabel)
+				if err != nil {
+					onError(repoName, w, subJobLog.With(logger.ErrAttr(err)), "failed to remove volumes", err.Error(), jobID, http.StatusInternalServerError)
+
+					return
+				}
+
+				subJobLog.Debug("failed to remove volumes", slog.String("stack", deployConfig.Name))
+			}
+
 			if deployConfig.DestroyOpts.RemoveRepoDir {
 				// Remove the repository directory after destroying the stack
 				subJobLog.Debug("removing deployment directory", slog.String("path", externalRepoPath))
@@ -307,7 +323,7 @@ func HandleEvent(ctx context.Context, jobLog *slog.Logger, w http.ResponseWriter
 			}
 		} else {
 			// Skip deployment if another project with the same name already exists
-			containers, err := docker.GetLabeledContainers(ctx, dockerClient, api.ProjectLabel, deployConfig.Name)
+			containers, err := docker.GetLabeledContainers(ctx, dockerClient, filterLabel, deployConfig.Name)
 			if err != nil {
 				onError(repoName, w, subJobLog.With(logger.ErrAttr(err)), "failed to retrieve containers", err.Error(), jobID, http.StatusInternalServerError)
 
@@ -368,8 +384,8 @@ func HandleEvent(ctx context.Context, jobLog *slog.Logger, w http.ResponseWriter
 					slog.String("deployed_commit", deployedCommit))
 			}
 
-			err = docker.DeployStack(subJobLog, internalRepoPath, externalRepoPath, &ctx, &dockerCli, &payload,
-				deployConfig, changedFiles, latestCommit, Version, false)
+			err = docker.DeployStack(subJobLog, internalRepoPath, externalRepoPath, &ctx, &dockerCli, dockerClient,
+				&payload, deployConfig, changedFiles, latestCommit, Version, false)
 			if err != nil {
 				onError(repoName, w, subJobLog.With(logger.ErrAttr(err)), "deployment failed", err.Error(), jobID, http.StatusInternalServerError)
 

cmd/doco-cd/http_handler_test.go

@@ -11,7 +11,11 @@ import (
 	"os"
 	"path"
 	"regexp"
+	"strconv"
 	"testing"
+	"time"
+
+	"github.com/docker/docker/api/types/swarm"
 
 	"github.com/docker/compose/v2/pkg/api"
 	"github.com/docker/compose/v2/pkg/compose"
@@ -25,7 +29,8 @@ import (
 )
 
 const (
-	githubPayloadFile = "testdata/github_payload.json"
+	githubPayloadFile          = "testdata/github_payload.json"
+	githubPayloadFileSwarmMode = "testdata/github_payload_swarm_mode.json"
 )
 
 // Make http call to HealthCheckHandler.
@@ -82,9 +87,19 @@ func TestHandlerData_WebhookHandler(t *testing.T) {
 	expectedStatusCode := http.StatusCreated
 	tmpDir := t.TempDir()
 
-	repoDir := path.Join(tmpDir, getRepoName("https://github.com/kimdre/doco-cd.git"))
+	payloadFile := githubPayloadFile
+	cloneUrl := "https://github.com/kimdre/doco-cd.git"
+	indexPath := path.Join("test", "index.html")
+
+	if docker.SwarmModeEnabled {
+		payloadFile = githubPayloadFileSwarmMode
+		cloneUrl = "https://github.com/kimdre/doco-cd_tests.git"
+		indexPath = path.Join("html", "index.html")
+	}
 
-	payload, err := os.ReadFile(githubPayloadFile)
+	indexPath = path.Join(tmpDir, getRepoName(cloneUrl), indexPath)
+
+	payload, err := os.ReadFile(payloadFile)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -192,22 +207,74 @@ func TestHandlerData_WebhookHandler(t *testing.T) {
 		}
 	})
 
-	testContainer, err := dockerCli.Client().ContainerInspect(ctx, testContainerID)
-	if err != nil {
-		t.Fatal(err)
-	}
+	testContainerPort := ""
+
+	if docker.SwarmModeEnabled {
+		t.Log("Testing in Swarm mode, using service inspect")
+
+		svc, _, err := dockerCli.Client().ServiceInspectWithRaw(ctx, "test-deploy_test", swarm.ServiceInspectOptions{
+			InsertDefaults: true,
+		})
+		if err != nil {
+			t.Fatalf("Failed to inspect test container: %v", err)
+		}
+
+		if len(svc.Endpoint.Ports) == 0 {
+			t.Fatal("Test container has no published ports")
+		}
+
+		testContainerPort = strconv.FormatUint(uint64(svc.Endpoint.Ports[0].PublishedPort), 10)
+
+		defer func() {
+			err = dockerCli.Client().ServiceRemove(ctx, "test-deploy_test")
+			if err != nil {
+				t.Fatalf("Failed to remove test container service: %v", err)
+			}
+		}()
+	} else {
+		testContainer, err := dockerCli.Client().ContainerInspect(ctx, testContainerID)
+		if err != nil {
+			t.Fatal(err)
+		}
+
+		if testContainer.State.Running != true {
+			t.Errorf("Test container is not running: %v", testContainer.State)
+		}
+
+		// Check if test container returns the expected response on its published port
+		networkPort := testContainer.NetworkSettings.Ports["80/tcp"]
 
-	if testContainer.State.Running != true {
-		t.Errorf("Test container is not running: %v", testContainer.State)
+		testContainerPort = networkPort[0].HostPort
 	}
 
-	// Check if test container returns the expected response on its published port
-	testContainerPort := testContainer.NetworkSettings.Ports["80/tcp"][0].HostPort
-	testURL := "http://localhost:" + testContainerPort
+	testURL := "http://127.0.0.1:" + testContainerPort
+	t.Logf("Test URL: %s", testURL)
 
-	resp, err := http.Get(testURL) // #nosec G107
-	if err != nil {
-		t.Fatalf("Failed to make GET request to test container: %v", err)
+	httpClient := &http.Client{Timeout: 3 * time.Second}
+
+	resp := &http.Response{}
+	for i := 0; i < 10; i++ {
+		resp, err = httpClient.Get(testURL) // #nosec G107
+		if err != nil {
+			t.Logf("Failed to make GET request to test container (attempt %d): %v", i+1, err)
+			time.Sleep(3 * time.Second) // Wait before retrying
+
+			continue
+		}
+
+		if resp.StatusCode == http.StatusOK {
+			t.Logf("Successfully connected to test container on attempt %d", i+1)
+			break
+		}
+
+		t.Logf("Test container returned status code %d on attempt %d", resp.StatusCode, i+1)
+
+		err = resp.Body.Close()
+		if err != nil {
+			t.Fatal(err)
+		}
+
+		time.Sleep(3 * time.Second) // Wait before retrying
 	}
 
 	t.Cleanup(
@@ -229,9 +296,7 @@ func TestHandlerData_WebhookHandler(t *testing.T) {
 
 	bodyString := string(bodyBytes)
 
-	indexFile := path.Join(repoDir, "test", "index.html")
-
-	fileContent, err := os.ReadFile(indexFile) // #nosec G304
+	fileContent, err := os.ReadFile(indexPath) // #nosec G304
 	if err != nil {
 		t.Fatalf("Failed to read index.html file: %v", err)
 	}

cmd/doco-cd/main.go

@@ -186,17 +186,31 @@ func main() {
 		}
 	}(dockerCli.Client())
 
-	log.Debug("docker client created")
-
-	dockerClient, _ := client.NewClientWithOpts(
+	dockerClient, err := client.NewClientWithOpts(
 		client.FromEnv,
 		client.WithAPIVersionNegotiation(),
 	)
+	if err != nil {
+		log.Critical("failed to create docker client", logger.ErrAttr(err))
+
+		return
+	}
+
+	if c.DockerSwarmFeatures {
+		// Check if docker host is running in swarm mode
+		docker.SwarmModeEnabled, err = docker.CheckDaemonIsSwarmManager(context.Background(), dockerCli)
+		if err != nil {
+			log.Critical("failed to check if docker host is running in swarm mode", logger.ErrAttr(err))
+
+			return
+		}
+	}
 
 	log.Debug("negotiated docker versions to use",
 		slog.Group("versions",
 			slog.String("docker_client", dockerClient.ClientVersion()),
 			slog.String("docker_api", dockerCli.CurrentVersion()),
+			slog.Bool("swarm_mode", docker.SwarmModeEnabled),
 		))
 
 	// Get container id of this application
@@ -268,50 +282,6 @@ func main() {
 		}
 	}
 
-	log.Debug("retrieving containers that are managed by doco-cd")
-
-	containers, err := docker.GetLabeledContainers(context.TODO(), dockerClient, docker.DocoCDLabels.Metadata.Manager, config.AppName)
-	if err != nil {
-		log.Error("failed to retrieve doco-cd containers", logger.ErrAttr(err))
-	}
-
-	if len(containers) == 0 {
-		log.Debug("no containers found that are managed by doco-cd", slog.Int("count", len(containers)))
-	} else {
-		log.Debug("retrieved containers successfully", slog.Int("count", len(containers)))
-	}
-
-	for _, cont := range containers {
-		log.Debug("inspecting container", slog.Group("container",
-			slog.String("id", cont.ID),
-			slog.String("name", cont.Names[0]),
-		))
-
-		dir := cont.Labels[docker.DocoCDLabels.Deployment.WorkingDir]
-		if len(dir) == 0 {
-			log.Error(fmt.Sprintf("failed to retrieve container %v working directory", cont.ID))
-
-			continue
-		}
-
-		wg.Add(1)
-
-		go func() {
-			defer wg.Done()
-			// docker.OnCrash(
-			//
-			//	dockerCli.Client(),
-			//	cont.ID,
-			//	func() {
-			//		log.Info("cleaning up", slog.String("path", dir))
-			//		_ = os.RemoveAll(dir)
-			//	},
-			//	func(err error) { log.Error("failed to clean up path: "+dir, logger.ErrAttr(err)) },
-			//
-			// )
-		}()
-	}
-
 	go func() {
 		log.Info("serving prometheus metrics", slog.Int("http_port", int(c.MetricsPort)), slog.String("path", prometheus.MetricsPath))