Merge pull request #273 from camunda-community-hub/np-tc-cloud

Run all tests against TC Cloud

.github/workflows/ci.yml

@@ -13,8 +13,57 @@ on:
       - 'revapi.json'
   workflow_dispatch: { }
 jobs:
-  build:
-    name: Build & Verify
+  check:
+    name: Linting & Analysis
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up JDK 8
+        uses: actions/setup-java@v3
+        with:
+          java-version: '8'
+          distribution: 'temurin'
+          cache: 'maven'
+      - name: Check
+        id: check
+        run: mvn -B -DskipTests verify
+  cloud:
+    env:
+      TC_CLOUD_TOKEN: ${{ secrets.TC_CLOUD_TOKEN }}
+      TC_CLOUD_CONCURRENCY: 4
+    name: Test (Cloud)
+    runs-on: ubuntu-latest
+    steps:
+      - name: Prepare Testcontainers Cloud agent
+        if: env.TC_CLOUD_TOKEN != ''
+        run: |
+          curl -L -o agent https://app.testcontainers.cloud/download/testcontainers-cloud-agent_linux_x86-64
+          chmod +x agent
+          ./agent &
+          ./agent wait
+      - uses: actions/checkout@v3
+      - name: Set up JDK 8
+        uses: actions/setup-java@v3
+        with:
+          java-version: '8'
+          distribution: 'temurin'
+          cache: 'maven'
+      - name: Build
+        id: build
+        run: mvn -B -DskipTests -DskipChecks install
+      - name: Test
+        id: test
+        timeout-minutes: 20
+        run: >
+          mvn -B -Pparallel-tests -DforkCount=2C -DskipChecks test
+      - name: Archive Test Results
+        uses: actions/upload-artifact@v3
+        with:
+          name: test-results
+          path: target/surefire-reports/
+          retention-days: 7
+  local:
+    name: Test (Local)
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
@@ -26,15 +75,14 @@ jobs:
           cache: 'maven'
       - name: Build
         id: build
-        run: mvn -B -DskipTests clean verify
+        run: mvn -B -DskipTests -DskipChecks install
       - name: Test
         id: test
         timeout-minutes: 20
         run: >
-          mvn -B test
-      - name: Archive Test Results on Failure
+          mvn -B -DskipChecks -Plocal-test test
+      - name: Archive Test Results
         uses: actions/upload-artifact@v3
-        if: failure()
         with:
           name: test-results
           path: target/surefire-reports/

pom.xml

@@ -557,7 +557,7 @@
     <profile>
       <id>parallel-tests</id>
       <properties>
-        <forkCount>0.5C</forkCount>
+        <forkCount>1C</forkCount>
       </properties>
       <build>
         <plugins>
@@ -567,6 +567,33 @@
             <configuration>
               <forkCount>${forkCount}</forkCount>
               <reuseForks>true</reuseForks>
+              <properties>
+                <configurationParameters>junit.jupiter.execution.parallel.enabled = true
+                  junit.jupiter.execution.parallel.mode.default = concurrent
+                  junit.jupiter.execution.parallel.config.strategy = fixed
+                  junit.jupiter.execution.parallel.config.fixed.parallelism = 2</configurationParameters>
+              </properties>
+            </configuration>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+
+    <!--
+      this profile will run all tests annotated with @SmokeTest. the profile is mainly used to
+      ensure that we can run basic tests on Windows, macOS, and Linux, thereby ensuring minimal
+      multi-platform support for development.
+      -->
+    <profile>
+      <id>local-test</id>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-surefire-plugin</artifactId>
+            <configuration>
+              <failIfNoTests>false</failIfNoTests>
+              <groups>local-test</groups>
             </configuration>
           </plugin>
         </plugins>

src/test/java/io/zeebe/containers/ZeebeBrokerNodeTest.java

@@ -23,7 +23,8 @@
 import io.camunda.zeebe.client.api.response.ProcessInstanceEvent;
 import io.camunda.zeebe.model.bpmn.Bpmn;
 import io.camunda.zeebe.model.bpmn.BpmnModelInstance;
-import io.zeebe.containers.util.TestUtils;
+import io.zeebe.containers.util.TestSupport;
+import io.zeebe.containers.util.TestcontainersSupport.DisabledIfTestcontainersCloud;
 import io.zeebe.containers.util.TopologyAssert;
 import java.io.IOException;
 import java.net.HttpURLConnection;
@@ -46,7 +47,8 @@
 import org.junit.jupiter.params.provider.MethodSource;
 import org.testcontainers.containers.GenericContainer;
 
-class ZeebeBrokerNodeTest {
+final class ZeebeBrokerNodeTest {
+  @SuppressWarnings("unused")
   @Timeout(value = 5, unit = TimeUnit.MINUTES)
   @ParameterizedTest(name = "{0} should be ready on start")
   @MethodSource("nodeProvider")
@@ -98,6 +100,7 @@ void shouldExposeAllPortsButGateway(
   @ParameterizedTest(name = "{0}")
   @MethodSource("reuseDataTestCases")
   @EnabledOnOs(LINUX)
+  @DisabledIfTestcontainersCloud
   void shouldReuseHostDataOnRestart(
       @SuppressWarnings("unused") final String testName,
       final BrokerNodeProvider brokerNodeProvider,
@@ -112,7 +115,7 @@ void shouldReuseHostDataOnRestart(
     broker.start();
     gateway.start();
 
-    try (final ZeebeClient client = ZeebeClientFactory.newZeebeClient(gateway)) {
+    try (final ZeebeClient client = TestSupport.newZeebeClient(gateway)) {
       // deploy a new process, which we can use on restart to assert that the data was correctly
       // reused
       final DeploymentEvent deployment = deploySampleProcess(client);
@@ -140,7 +143,7 @@ private static ZeebeBrokerNode<?> provideBrokerWithHostData(
     // temporary directory at the end. Note that this is only necessary when not running the tests
     // as root
     final ZeebeHostData data = new ZeebeHostData(dataDir.toAbsolutePath().toString());
-    final String runAsUser = TestUtils.getRunAsUser();
+    final String runAsUser = TestSupport.getRunAsUser();
     broker
         .withZeebeData(data)
         .self()
@@ -156,7 +159,11 @@ private ProcessInstanceEvent createSampleProcessInstance(final ZeebeClient clien
   private DeploymentEvent deploySampleProcess(final ZeebeClient client) {
     final BpmnModelInstance sampleProcess =
         Bpmn.createExecutableProcess("process").startEvent().endEvent().done();
-    return client.newDeployCommand().addProcessModel(sampleProcess, "process.bpmn").send().join();
+    return client
+        .newDeployResourceCommand()
+        .addProcessModel(sampleProcess, "process.bpmn")
+        .send()
+        .join();
   }
 
   private void awaitUntilTopologyIsComplete(final ZeebeClient client) {

src/test/java/io/zeebe/containers/ZeebeContainerTest.java

@@ -17,6 +17,7 @@
 
 import io.camunda.zeebe.client.ZeebeClient;
 import io.camunda.zeebe.client.api.response.Topology;
+import io.zeebe.containers.util.TestSupport;
 import java.util.concurrent.TimeUnit;
 import org.assertj.core.api.Assertions;
 import org.junit.jupiter.api.Test;
@@ -25,7 +26,7 @@
 import org.testcontainers.junit.jupiter.Testcontainers;
 
 @Testcontainers
-class ZeebeContainerTest {
+final class ZeebeContainerTest {
   @Container private final ZeebeContainer zeebeContainer = new ZeebeContainer();
 
   @Test
@@ -35,7 +36,7 @@ void shouldStartWithEmbeddedGatewayByDefault() {
     final Topology topology;
 
     // when
-    try (final ZeebeClient client = ZeebeClientFactory.newZeebeClient(zeebeContainer)) {
+    try (final ZeebeClient client = TestSupport.newZeebeClient(zeebeContainer)) {
       topology = client.newTopologyRequest().send().join(5, TimeUnit.SECONDS);
     }
 

src/test/java/io/zeebe/containers/ZeebeGatewayContainerTest.java

@@ -18,30 +18,43 @@
 import io.camunda.zeebe.client.ZeebeClient;
 import io.camunda.zeebe.client.api.response.BrokerInfo;
 import io.camunda.zeebe.client.api.response.Topology;
+import io.zeebe.containers.util.TestSupport;
 import java.util.List;
 import java.util.concurrent.TimeUnit;
 import org.assertj.core.api.Assertions;
+import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Test;
+import org.testcontainers.containers.Network;
 import org.testcontainers.junit.jupiter.Container;
 import org.testcontainers.junit.jupiter.Testcontainers;
 
 @Testcontainers
-class ZeebeGatewayContainerTest {
-  @Container private final ZeebeBrokerContainer brokerContainer = new ZeebeBrokerContainer();
+final class ZeebeGatewayContainerTest {
+  private final Network network = Network.newNetwork();
+
+  @Container
+  private final ZeebeBrokerContainer brokerContainer =
+      new ZeebeBrokerContainer().withNetwork(network);
 
   @Container
   private final ZeebeGatewayContainer gatewayContainer =
       new ZeebeGatewayContainer()
+          .withNetwork(network)
           .withEnv(
               "ZEEBE_GATEWAY_CLUSTER_CONTACTPOINT", brokerContainer.getInternalClusterAddress());
 
+  @AfterEach
+  void afterEach() {
+    network.close();
+  }
+
   @Test
   void shouldConnectToBroker() {
     // given
     final Topology topology;
 
     // when
-    try (final ZeebeClient client = ZeebeClientFactory.newZeebeClient(gatewayContainer)) {
+    try (final ZeebeClient client = TestSupport.newZeebeClient(gatewayContainer)) {
       topology = client.newTopologyRequest().send().join(5, TimeUnit.SECONDS);
     }
 

src/test/java/io/zeebe/containers/ZeebeHostDataTest.java

@@ -16,24 +16,29 @@
 package io.zeebe.containers;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.condition.OS.LINUX;
 
 import com.github.dockerjava.api.DockerClient;
 import com.github.dockerjava.api.command.InspectContainerResponse;
 import com.github.dockerjava.api.command.InspectContainerResponse.Mount;
 import com.github.dockerjava.api.model.Volume;
-import io.zeebe.containers.util.TestUtils;
+import io.zeebe.containers.util.TestSupport;
+import io.zeebe.containers.util.TestcontainersSupport.DisabledIfTestcontainersCloud;
 import java.nio.file.Path;
 import java.util.Objects;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.condition.EnabledOnOs;
 import org.junit.jupiter.api.io.TempDir;
 import org.testcontainers.DockerClientFactory;
 
+@EnabledOnOs(LINUX)
+@DisabledIfTestcontainersCloud
 final class ZeebeHostDataTest {
   @Test
   void shouldAttachToZeebeContainer(final @TempDir Path dataDir) {
     // given
     final DockerClient client = DockerClientFactory.lazyClient();
-    final String runAsUser = TestUtils.getRunAsUser();
+    final String runAsUser = TestSupport.getRunAsUser();
 
     // when
     final InspectContainerResponse response;

src/test/java/io/zeebe/containers/archive/ContainerArchiveBuilderTest.java

@@ -25,12 +25,9 @@
 import java.nio.file.Path;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.io.TempDir;
-import org.junit.jupiter.api.parallel.Execution;
-import org.junit.jupiter.api.parallel.ExecutionMode;
 import org.testcontainers.containers.SocatContainer;
 import org.testcontainers.utility.MountableFile;
 
-@Execution(ExecutionMode.CONCURRENT)
 final class ContainerArchiveBuilderTest {
 
   @Test

src/test/java/io/zeebe/containers/archive/ContainerArchiveTest.java

@@ -29,11 +29,8 @@
 import org.apache.commons.compress.compressors.gzip.GzipCompressorInputStream;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.io.TempDir;
-import org.junit.jupiter.api.parallel.Execution;
-import org.junit.jupiter.api.parallel.ExecutionMode;
 import org.testcontainers.utility.MountableFile;
 
-@Execution(ExecutionMode.CONCURRENT)
 final class ContainerArchiveTest {
 
   @Test

src/test/java/io/zeebe/containers/cluster/ZeebeClusterTest.java

@@ -21,16 +21,18 @@
 import io.camunda.zeebe.client.api.response.Topology;
 import io.zeebe.containers.ZeebeGatewayNode;
 import io.zeebe.containers.util.TopologyAssert;
-import java.util.Optional;
+import org.agrona.CloseHelper;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Test;
+import org.testcontainers.containers.Network;
 
 final class ZeebeClusterTest {
+  private final Network network = Network.newNetwork();
   private ZeebeCluster cluster;
 
   @AfterEach
   void afterEach() {
-    Optional.ofNullable(cluster).ifPresent(ZeebeCluster::stop);
+    CloseHelper.quietCloseAll(cluster, network);
   }
 
   @Test
@@ -42,6 +44,7 @@ void shouldStartSingleNodeCluster() {
             .withReplicationFactor(1)
             .withPartitionsCount(1)
             .withBrokersCount(1)
+            .withNetwork(network)
             .build();
 
     // when
@@ -71,6 +74,7 @@ void shouldStartClusterWithEmbeddedGateways() {
             .withReplicationFactor(2)
             .withPartitionsCount(2)
             .withBrokersCount(2)
+            .withNetwork(network)
             .build();
 
     // when
@@ -108,6 +112,7 @@ void shouldStartClusterWithStandaloneGateway() {
             .withPartitionsCount(1)
             .withBrokersCount(1)
             .withGatewaysCount(1)
+            .withNetwork(network)
             .build();
 
     // when
@@ -139,6 +144,7 @@ void shouldStartClusterWithMixedGateways() {
             .withPartitionsCount(1)
             .withBrokersCount(1)
             .withGatewaysCount(1)
+            .withNetwork(network)
             .build();
 
     // when