Docker Swarm Implementation

docs/docker/docker-compose-swarm.yml

@@ -0,0 +1,22 @@
+version: "3.7"
+services:
+  zalenium:
+    image: dosel/zalenium
+    deploy:
+      placement:
+        constraints:
+          - node.role == manager
+    ports:
+      - "4444:4444"
+    networks:
+      - zalenium
+    volumes:
+      - /var/run/docker.sock:/var/run/docker.sock
+      - /tmp/videos:/home/seluser/videos
+    environment:
+      - PULL_SELENIUM_IMAGE=true
+    command: ["start", "--swarmOverlayNetwork", "<stack-name>_zalenium", "--videoRecordingEnabled", "false"]
+networks:
+  zalenium:
+    driver: overlay
+    attachable: true

pom.xml

@@ -231,6 +231,11 @@
             <artifactId>httpmime</artifactId>
             <version>${httpmime.version}</version>
         </dependency>
+        <dependency>
+            <groupId>org.apache.commons</groupId>
+            <artifactId>commons-collections4</artifactId>
+            <version>4.3</version>
+        </dependency>
         <dependency>
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>

scripts/zalenium.sh

@@ -5,6 +5,7 @@ SELENIUM_IMAGE_NAME=${SELENIUM_IMAGE_NAME:-"elgalu/selenium"}
 MAX_TEST_SESSIONS=${MAX_TEST_SESSIONS:-1}
 DESIRED_CONTAINERS=${DESIRED_CONTAINERS:-2}
 MAX_DOCKER_SELENIUM_CONTAINERS=${MAX_DOCKER_SELENIUM_CONTAINERS:-10}
+SWARM_OVERLAY_NETWORK=${SWARM_OVERLAY_NETWORK:-""}
 ZALENIUM_ARTIFACT="$(pwd)/${project.build.finalName}.jar"
 SAUCE_LABS_ENABLED=${SAUCE_LABS_ENABLED:-false}
 BROWSER_STACK_ENABLED=${BROWSER_STACK_ENABLED:-false}
@@ -383,6 +384,7 @@ StartUp()
 
     export ZALENIUM_DESIRED_CONTAINERS=${DESIRED_CONTAINERS}
     export ZALENIUM_MAX_DOCKER_SELENIUM_CONTAINERS=${MAX_DOCKER_SELENIUM_CONTAINERS}
+    export ZALENIUM_SWARM_OVERLAY_NETWORK=${SWARM_OVERLAY_NETWORK}
     export ZALENIUM_VIDEO_RECORDING_ENABLED=${VIDEO_RECORDING_ENABLED}
     export ZALENIUM_TZ=${TZ}
     export ZALENIUM_SCREEN_WIDTH=${SCREEN_WIDTH}
@@ -635,6 +637,7 @@ StartUp()
         # Gathering the options used to start Zalenium, in order to learn about the used options
         ZALENIUM_START_COMMAND="zalenium.sh --desiredContainers $DESIRED_CONTAINERS
             --maxDockerSeleniumContainers $MAX_DOCKER_SELENIUM_CONTAINERS --maxTestSessions $MAX_TEST_SESSIONS
+            --swarmOverlayNetwork $SWARM_OVERLAY_NETWORK
             --sauceLabsEnabled $SAUCE_LABS_ENABLED --browserStackEnabled $BROWSER_STACK_ENABLED
             --testingBotEnabled $TESTINGBOT_ENABLED --cbtEnabled $CBT_ENABLED
             --videoRecordingEnabled $VIDEO_RECORDING_ENABLED
@@ -818,6 +821,7 @@ function usage()
     echo -e "\t start <options, see below>"
     echo -e "\t --desiredContainers -> Number of nodes/containers created on startup. Default is 2."
     echo -e "\t --maxDockerSeleniumContainers -> Max number of docker-selenium containers running at the same time. Default is 10."
+    echo -e "\t --swarmOverlayNetwork -> Netowrk used for the swarm."
     echo -e "\t --sauceLabsEnabled -> Determines if the Sauce Labs node is started. Defaults to 'false'."
     echo -e "\t --browserStackEnabled -> Determines if the Browser Stack node is started. Defaults to 'false'."
     echo -e "\t --testingBotEnabled -> Determines if the TestingBot node is started. Defaults to 'false'."
@@ -873,6 +877,9 @@ case ${SCRIPT_ACTION} in
                 --maxDockerSeleniumContainers)
                     MAX_DOCKER_SELENIUM_CONTAINERS=${VALUE}
                     ;;
+                --swarmOverlayNetwork)
+                    SWARM_OVERLAY_NETWORK=${VALUE}
+                    ;;
                 --sauceLabsEnabled)
                     SAUCE_LABS_ENABLED=${VALUE}
                     ;;

src/main/java/de/zalando/ep/zalenium/container/ContainerFactory.java

@@ -6,6 +6,8 @@
 import com.google.common.annotations.VisibleForTesting;
 
 import de.zalando.ep.zalenium.container.kubernetes.KubernetesContainerClient;
+import de.zalando.ep.zalenium.container.swarm.SwarmContainerClient;
+import de.zalando.ep.zalenium.container.swarm.SwarmUtilities;
 import de.zalando.ep.zalenium.util.Environment;
 import io.fabric8.kubernetes.client.DefaultKubernetesClient;
 
@@ -15,12 +17,16 @@ public class ContainerFactory {
 
     private static KubernetesContainerClient kubernetesContainerClient;
     private static Supplier<DockerContainerClient> dockerContainerClient = DockerContainerClient::new;
+    private static Supplier<SwarmContainerClient> swarmContainerClient = SwarmContainerClient::new;
 
     public static ContainerClient getContainerClient() {
 
         if (isKubernetes.get()) {
             return createKubernetesContainerClient();
         }
+        else if (SwarmUtilities.isSwarmActive()) {
+            return createSwarmContainerClient();
+        }
         else {
             return createDockerContainerClient();
         }
@@ -50,6 +56,12 @@ private static KubernetesContainerClient createKubernetesContainerClient() {
         return kubernetesContainerClient;
     }
 
+    private static SwarmContainerClient createSwarmContainerClient() {
+        SwarmContainerClient dockerClient = ContainerFactory.swarmContainerClient.get();
+        dockerClient.initialiseContainerEnvironment();
+        return dockerClient;
+    }
+
     @VisibleForTesting
     public static void setDockerContainerClient(Supplier<DockerContainerClient> dockerContainerClient) {
         ContainerFactory.dockerContainerClient = dockerContainerClient;