Skip container tests if docker is not available

tomaswolf · tomaswolf · commit e472eb6e437b · 2025-08-23T21:21:16.000+02:00
Skip all container tests if no docker engine is running. Remove
disabling the tests on Windows: also run these tests on Windows
if a docker engine is available. (The CI Windows runners don't have
docker.)
diff --git a/sshd-common/src/test/java/org/apache/sshd/util/test/ContainerTestCase.java b/sshd-common/src/test/java/org/apache/sshd/util/test/ContainerTestCase.java
diff --git a/sshd-core/pom.xml b/sshd-core/pom.xml
@@ -286,26 +286,5 @@
                 </plugins>
             </build>
         </profile>
-        <!-- this profile changes the maven-surefire-plugin plugin to skip tests with @Category(ContainerTestCase.class) -->
-        <!-- it's activated on Windows, the GitHub actions Windows VMs do not have any Linux Docker support -->
-        <profile>
-            <id>no-containers-for-windows</id>
-            <activation>
-                <os>
-                    <family>windows</family>
-                </os>
-            </activation>
-            <build>
-                <plugins>
-                    <plugin>
-                        <groupId>org.apache.maven.plugins</groupId>
-                        <artifactId>maven-surefire-plugin</artifactId>
-                        <configuration>
-                            <excludedGroups>ContainerTestCase</excludedGroups>
-                        </configuration>
-                    </plugin>
-                </plugins>
-            </build>
-        </profile>
     </profiles>
 </project>
diff --git a/sshd-core/src/test/java/org/apache/sshd/client/auth/pubkey/HostBoundPubKeyAuthTest.java b/sshd-core/src/test/java/org/apache/sshd/client/auth/pubkey/HostBoundPubKeyAuthTest.java
@@ -28,7 +28,6 @@
 import org.apache.sshd.common.keyprovider.FileKeyPairProvider;
 import org.apache.sshd.util.test.BaseTestSupport;
 import org.apache.sshd.util.test.CommonTestSupportUtils;
-import org.junit.jupiter.api.Tag;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.MethodSource;
 import org.slf4j.Logger;
@@ -41,8 +40,7 @@
 import org.testcontainers.junit.jupiter.Testcontainers;
 import org.testcontainers.utility.MountableFile;
 
-@Tag("ContainerTestCase")
-@Testcontainers
+@Testcontainers(disabledWithoutDocker = true)
 public class HostBoundPubKeyAuthTest extends BaseTestSupport {
 
     private static final Logger LOG = LoggerFactory.getLogger(HostBoundPubKeyAuthTest.class);
diff --git a/sshd-core/src/test/java/org/apache/sshd/client/opensshcerts/ClientOpenSSHCertificatesTest.java b/sshd-core/src/test/java/org/apache/sshd/client/opensshcerts/ClientOpenSSHCertificatesTest.java
@@ -43,7 +43,6 @@
 import org.apache.sshd.util.test.CommonTestSupportUtils;
 import org.bouncycastle.jce.provider.BouncyCastleProvider;
 import org.junit.jupiter.api.BeforeAll;
-import org.junit.jupiter.api.Tag;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.MethodSource;
 import org.testcontainers.containers.GenericContainer;
@@ -52,8 +51,7 @@
 import org.testcontainers.junit.jupiter.Testcontainers;
 import org.testcontainers.utility.MountableFile;
 
-@Tag("ContainerTestCase")
-@Testcontainers
+@Testcontainers(disabledWithoutDocker = true)
 public class ClientOpenSSHCertificatesTest extends BaseTestSupport {
 
     /**
diff --git a/sshd-core/src/test/java/org/apache/sshd/common/cipher/OpenSshCipherTest.java b/sshd-core/src/test/java/org/apache/sshd/common/cipher/OpenSshCipherTest.java
@@ -33,7 +33,6 @@
 import org.bouncycastle.jce.provider.BouncyCastleProvider;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
-import org.junit.jupiter.api.Tag;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.MethodSource;
 import org.slf4j.Logger;
@@ -46,15 +45,12 @@
 import org.testcontainers.junit.jupiter.Testcontainers;
 import org.testcontainers.utility.MountableFile;
 
-import static org.junit.jupiter.api.Assertions.assertTrue;
-
 /**
  * Test ciphers against OpenSSH. Force resetting ciphers every time to verify that they are res-initialized correctly.
  *
  * @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
  */
-@Tag("ContainerTestCase")
-@Testcontainers
+@Testcontainers(disabledWithoutDocker = true)
 public class OpenSshCipherTest extends BaseTestSupport {
 
     private static final Logger LOG = LoggerFactory.getLogger(OpenSshCipherTest.class);
diff --git a/sshd-core/src/test/java/org/apache/sshd/common/forward/PortForwardingWithOpenSshTest.java b/sshd-core/src/test/java/org/apache/sshd/common/forward/PortForwardingWithOpenSshTest.java
@@ -43,22 +43,18 @@
 import org.apache.sshd.util.test.CoreTestSupportUtils;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
-import org.junit.jupiter.api.Tag;
 import org.junit.jupiter.api.io.TempDir;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.MethodSource;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.testcontainers.Testcontainers;
 import org.testcontainers.containers.GenericContainer;
 import org.testcontainers.containers.output.Slf4jLogConsumer;
 import org.testcontainers.containers.wait.strategy.Wait;
 import org.testcontainers.images.builder.ImageFromDockerfile;
+import org.testcontainers.junit.jupiter.Testcontainers;
 import org.testcontainers.utility.MountableFile;
 
-import static org.junit.jupiter.api.Assertions.assertFalse;
-import static org.junit.jupiter.api.Assertions.assertTrue;
-
 /**
  * Test setup: run a gRPC server on localhost; run an Apache MINA sshd server on localhost. Run an OpenSSH client in a
  * container, set up to remote forward a port on the SSH server to the gRPC server. Then connect to the gRPC server via
@@ -79,7 +75,7 @@
  * @see <a href="https://issues.apache.org/jira/browse/SSHD-1055">SSHD-1055</a>
  * @see <a href="https://issues.apache.org/jira/browse/SSHD-1269">SSHD-1269</a>
  */
-@Tag("ContainerTestCase")
+@Testcontainers(disabledWithoutDocker = true)
 public class PortForwardingWithOpenSshTest extends BaseTestSupport {
 
     private static final Logger LOG = LoggerFactory.getLogger(PortForwardingWithOpenSshTest.class);
@@ -201,7 +197,7 @@ public void forwardingWithConnectionClose(String portToForward) throws Exception
                 .waitingFor(Wait.forLogMessage(".*forwarding_success.*\n", 1))
                 .withLogConsumer(new Slf4jLogConsumer(LOG));
         try {
-            Testcontainers.exposeHostPorts(sshPort, gRpcPort);
+            org.testcontainers.Testcontainers.exposeHostPorts(sshPort, gRpcPort);
             sshdContainer.start();
             forwardingSetup.await();
             assertTrue(forwardedPort > 0, "Server should listen on port");
diff --git a/sshd-core/src/test/java/org/apache/sshd/common/kex/OpenSshMlKemTest.java b/sshd-core/src/test/java/org/apache/sshd/common/kex/OpenSshMlKemTest.java
@@ -31,7 +31,6 @@
 import org.bouncycastle.jce.provider.BouncyCastleProvider;
 import org.junit.jupiter.api.Assumptions;
 import org.junit.jupiter.api.BeforeAll;
-import org.junit.jupiter.api.Tag;
 import org.junit.jupiter.api.Test;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -48,8 +47,7 @@
  *
  * @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
  */
-@Tag("ContainerTestCase")
-@Testcontainers
+@Testcontainers(disabledWithoutDocker = true)
 class OpenSshMlKemTest extends BaseTestSupport {
 
     private static final Logger LOG = LoggerFactory.getLogger(OpenSshMlKemTest.class);
diff --git a/sshd-core/src/test/java/org/apache/sshd/common/kex/extension/StrictKexInteroperabilityTest.java b/sshd-core/src/test/java/org/apache/sshd/common/kex/extension/StrictKexInteroperabilityTest.java
@@ -36,7 +36,6 @@
 import org.apache.sshd.util.test.CommonTestSupportUtils;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
-import org.junit.jupiter.api.Tag;
 import org.junit.jupiter.api.Test;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -45,10 +44,9 @@
 import org.testcontainers.containers.wait.strategy.Wait;
 import org.testcontainers.images.builder.ImageFromDockerfile;
 import org.testcontainers.images.builder.dockerfile.DockerfileBuilder;
+import org.testcontainers.junit.jupiter.Testcontainers;
 import org.testcontainers.utility.MountableFile;
 
-import static org.junit.jupiter.api.Assertions.assertTrue;
-
 /**
  * Tests to ensure that an Apache MINA sshd client can talk to OpenSSH servers with or without "strict KEX". This
  * implicitly tests the message sequence number handling; if sequence numbers get out of sync or are reset wrongly,
@@ -57,7 +55,7 @@
  * @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
  * @see    <A HREF="https://github.com/apache/mina-sshd/issues/445">Terrapin Mitigation: &quot;strict-kex&quot;</A>
  */
-@Tag("ContainerTestCase")
+@Testcontainers(disabledWithoutDocker = true)
 public class StrictKexInteroperabilityTest extends BaseTestSupport {
 
     private static final Logger LOG = LoggerFactory.getLogger(StrictKexInteroperabilityTest.class);
diff --git a/sshd-scp/pom.xml b/sshd-scp/pom.xml
@@ -211,26 +211,5 @@
             </build>
         </profile>
 
-        <!-- this profile changes the maven-surefire-plugin plugin to skip tests with @Category(ContainerTestCase.class) -->
-        <!-- it's activated on Windows, the GitHub actions Windows VMs do not have any Linux Docker support -->
-        <profile>
-            <id>no-containers-for-windows</id>
-            <activation>
-                <os>
-                    <family>windows</family>
-                </os>
-            </activation>
-            <build>
-                <plugins>
-                    <plugin>
-                        <groupId>org.apache.maven.plugins</groupId>
-                        <artifactId>maven-surefire-plugin</artifactId>
-                        <configuration>
-                            <excludedGroups>ContainerTestCase</excludedGroups>
-                        </configuration>
-                    </plugin>
-                </plugins>
-            </build>
-        </profile>
     </profiles>
 </project>
diff --git a/sshd-scp/src/test/java/org/apache/sshd/scp/client/ScpCharsetTest.java b/sshd-scp/src/test/java/org/apache/sshd/scp/client/ScpCharsetTest.java
@@ -31,7 +31,6 @@
 import org.apache.sshd.scp.common.ScpException;
 import org.apache.sshd.util.test.BaseTestSupport;
 import org.apache.sshd.util.test.CommonTestSupportUtils;
-import org.junit.jupiter.api.Tag;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.io.TempDir;
 import org.slf4j.Logger;
@@ -44,18 +43,14 @@
 import org.testcontainers.junit.jupiter.Testcontainers;
 import org.testcontainers.utility.MountableFile;
 
-import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertFalse;
-
 /**
  * Tests transferring a file named "äöü.txt" via SCP from a container that uses ISO-8859-15 as locale. The UTF-8 and
  * IOS-8859-15 encodings of these characters are different, so the file should not be found when the command is sent as
  * UTF-8, but should be found when sent as ISO-8859-1.
  *
  * @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>
  */
-@Tag("ContainerTestCase")
-@Testcontainers
+@Testcontainers(disabledWithoutDocker = true)
 public class ScpCharsetTest extends BaseTestSupport {
 
     private static final Logger LOG = LoggerFactory.getLogger(ScpCharsetTest.class);
diff --git a/sshd-sftp/src/test/java/org/apache/sshd/sftp/client/extensions/SftpExtensionsTest.java b/sshd-sftp/src/test/java/org/apache/sshd/sftp/client/extensions/SftpExtensionsTest.java
@@ -29,6 +29,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.NavigableMap;
+import java.util.Objects;
 import java.util.TreeMap;
 import java.util.stream.Collectors;
 
@@ -50,10 +51,6 @@
 import org.junit.jupiter.api.MethodOrderer.MethodName;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.TestMethodOrder;
-import org.testcontainers.shaded.com.google.common.base.Objects;
-
-import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertTrue;
 
 @TestMethodOrder(MethodName.class)
 public class SftpExtensionsTest extends AbstractSftpClientTestSupport {
@@ -118,7 +115,7 @@ public NavigableMap<String, Object> resolveReportedFileAttributes(
                         SftpSubsystemProxy subsystem,
                         Path file, int flags, NavigableMap<String, Object> attrs, LinkOption... options)
                         throws IOException {
-                    if (Objects.equal(file, localFile)) {
+                    if (Objects.equals(file, localFile)) {
                         @SuppressWarnings("unchecked")
                         Map<String, Object> extra = (Map<String, Object>) attrs.get(IoUtils.EXTENDED_VIEW_ATTR);
                         if (MapEntryUtils.isEmpty(extra)) {
