feat: optimize Docker setup for E2E testing with dynamic base image support

Author: dexyk

.semaphore/semaphore.yml

@@ -5,6 +5,15 @@ agent:
     type: f1-standard-2
     os_image: ubuntu2404
 
+global_job_config:
+  secrets:
+    - name: semreg-semaphoredev-credentials
+  prologue:
+    commands:
+      - echo $SEMAPHORE_REGISTRY_PASSWORD | docker login --username "$SEMAPHORE_REGISTRY_USERNAME" --password-stdin $SEMAPHORE_REGISTRY_HOST || echo "Semaphore Registry login failed, but continuing the build process." && true
+      - export REGISTRY_HOST=$SEMAPHORE_REGISTRY_HOST
+      - export E2E_BASE_IMAGE="$SEMAPHORE_REGISTRY_HOST/agent-e2e-base"
+
 execution_time_limit:
   minutes: 10
 
@@ -80,8 +89,20 @@ blocks:
           commands:
             - test-results publish junit-report.xml
 
-  - name: "Docker Executor E2E"
+  - name: "E2E Base Image"
     dependencies: []
+    task:
+      prologue:
+        commands:
+          - checkout
+      jobs:
+        - name: Build and push
+          commands:
+            - docker build -f Dockerfile.test.base -t "$E2E_BASE_IMAGE" .
+            - docker push "$E2E_BASE_IMAGE"
+
+  - name: "Docker Executor E2E"
+    dependencies: ["E2E Base Image"]
     task:
       secrets:
         - name: aws-ecr-agent-e2e-secret
@@ -98,6 +119,7 @@ blocks:
         commands:
           - sem-version go 1.24.11
           - checkout
+          - docker pull "$E2E_BASE_IMAGE"
           - go version
           - go get
           - go build
@@ -155,7 +177,7 @@ blocks:
                 - compose_v1
 
   - name: "Hosted E2E tests"
-    dependencies: []
+    dependencies: ["E2E Base Image"]
     task:
       env_vars:
         - name: GO111MODULE
@@ -165,6 +187,7 @@ blocks:
         commands:
           - sem-version go 1.24.11
           - checkout
+          - docker pull "$E2E_BASE_IMAGE"
           - go version
           - go get
           - go build
@@ -190,7 +213,7 @@ blocks:
                 - job_logs_as_artifact_trimmed
 
   - name: "Self hosted E2E"
-    dependencies: []
+    dependencies: ["E2E Base Image"]
     task:
       env_vars:
         - name: GO111MODULE
@@ -202,6 +225,7 @@ blocks:
         commands:
           - sem-version go 1.24.11
           - checkout
+          - docker pull "$E2E_BASE_IMAGE"
           - go version
           - go get
           - go build
@@ -225,7 +249,7 @@ blocks:
                 - docker_compose_fail_on_missing_host_files
 
   - name: "Kubernetes Executor E2E"
-    dependencies: []
+    dependencies: ["E2E Base Image"]
     task:
       secrets:
         - name: aws-ecr-agent-e2e-secret
@@ -246,6 +270,7 @@ blocks:
           - /tmp/minikube-linux-amd64 config set WantUpdateNotification false
           - /tmp/minikube-linux-amd64 start --driver=docker
           - checkout
+          - docker pull "$E2E_BASE_IMAGE"
           - mkdir /tmp/agent
           # The docker container uses root, and not semaphore
           - grep -rl "/home/semaphore" ~/.kube | xargs sed -i 's/home\/semaphore/root/g'

Dockerfile.test

@@ -1,30 +1,5 @@
-FROM python:3
-
-RUN apt-get update && \
-  apt-get install curl -y && \
-  curl -sSL https://get.docker.com/ | sh && \
-  apt-get install -y ssh docker-compose-plugin && \
-  # Install standalone docker-compose for backward compatibility
-  curl -L "https://github.com/docker/compose/releases/latest/download/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose && \
-  chmod +x /usr/local/bin/docker-compose && \
-  # pin pyyaml to 5.3.1 until https://github.com/yaml/pyyaml/issues/724 is fixed
-  pip install pyyaml==5.3.1 && \
-  pip install awscli
-
-# By default, sshd runs on port 22, we need it to run on port 2222
-RUN sed -i 's/#Port 22/Port 2222/g' /etc/ssh/sshd_config
-
-# kubectl is required to be present in the container running the agent
-RUN curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl" && \
-  install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl
-
-# Semaphore toolbox should also be available
-RUN curl -sL https://github.com/semaphoreci/toolbox/releases/latest/download/self-hosted-linux.tar -o toolbox.tar && \
-  tar -xf toolbox.tar && \
-  mv toolbox /root/.toolbox && \
-  /root/.toolbox/install-toolbox && \
-  echo 'source ~/.toolbox/toolbox' >> /root/.bash_profile && \
-  rm toolbox.tar
+ARG BASE_IMAGE=python:3
+FROM ${BASE_IMAGE}
 
 ADD server.key /app/server.key
 ADD server.crt /app/server.crt

Dockerfile.test.base

@@ -0,0 +1,29 @@
+FROM python:3
+
+RUN apt-get update && \
+  apt-get install curl -y && \
+  curl -sSL https://get.docker.com/ | sh && \
+  apt-get install -y ssh docker-compose-plugin && \
+  # Install standalone docker-compose for backward compatibility
+  curl -L "https://github.com/docker/compose/releases/latest/download/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose && \
+  chmod +x /usr/local/bin/docker-compose && \
+  # pin pyyaml to 5.3.1 until https://github.com/yaml/pyyaml/issues/724 is fixed
+  pip install pyyaml==5.3.1 && \
+  pip install awscli
+
+# By default, sshd runs on port 22, we need it to run on port 2222
+RUN sed -i 's/#Port 22/Port 2222/g' /etc/ssh/sshd_config
+
+# kubectl is required to be present in the container running the agent
+RUN curl -LO "https://dl.k8s.io/release/$(curl -L -s https://dl.k8s.io/release/stable.txt)/bin/linux/amd64/kubectl" && \
+  install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl
+
+# Semaphore toolbox should also be available
+RUN curl -sL https://github.com/semaphoreci/toolbox/releases/latest/download/self-hosted-linux.tar -o toolbox.tar && \
+  tar -xf toolbox.tar && \
+  mv toolbox /root/.toolbox && \
+  /root/.toolbox/install-toolbox && \
+  echo 'source ~/.toolbox/toolbox' >> /root/.bash_profile && \
+  rm toolbox.tar
+
+WORKDIR /app

test/e2e_support/api_mode.rb

@@ -10,7 +10,12 @@ class ApiMode
   def boot_up_agent
     system "docker stop $(docker ps -q)"
     system "docker rm $(docker ps -qa)"
-    system "docker build -t agent -f Dockerfile.test ."
+    base_image = ENV["E2E_BASE_IMAGE"]
+    build_cmd = "docker build -t agent -f Dockerfile.test ."
+    if base_image && !base_image.empty?
+      build_cmd = "docker build --build-arg BASE_IMAGE=#{base_image} -t agent -f Dockerfile.test ."
+    end
+    system build_cmd
     system "docker run --privileged --device /dev/ptmx --network=host -v /tmp/agent-temp-directory/:/tmp/agent-temp-directory -v /var/run/docker.sock:/var/run/docker.sock --name agent -tdi agent bash -c \"service ssh restart && export SEMAPHORE_AGENT_LOG_LEVEL=debug SEMAPHORE_AGENT_LOGS_COMPRESSION_SIZE=1048576 && nohup ./agent serve --port 30000 --auth-token-secret 'TzRVcspTmxhM9fUkdi1T/0kVXNETCi8UdZ8dLM8va4E' & sleep infinity\""
 
     pingable = nil

test/e2e_support/docker-compose-listen.yml

@@ -5,6 +5,8 @@ services:
     build:
       context: ../..
       dockerfile: Dockerfile.test
+      args:
+        BASE_IMAGE: ${E2E_BASE_IMAGE:-python:3}
     command: 'bash -c "service ssh restart && SEMAPHORE_AGENT_LOG_LEVEL=DEBUG ./agent start --config-file /tmp/agent/config.yaml"'
     devices:
       - /dev/ptmx