merge: #10092

10092: Move QA test utilities to their own module r=npepinpe a=npepinpe

## Description

This PR introduces a new module, `zeebe-qa-util`, under the `zeebe-qa` umbrella module. The module is located at `qa/util/pom.xml`. QA utilities from the `test-util` module were moved there as well. No real changes were done other than move things around. 

## Related issues

closes #10089 



Co-authored-by: Nicolas Pepin-Perreault <nicolas.pepin-perreault@camunda.com>

parent/pom.xml

@@ -247,6 +247,12 @@
         <version>${project.version}</version>
       </dependency>
 
+      <dependency>
+        <groupId>io.camunda</groupId>
+        <artifactId>zeebe-qa-util</artifactId>
+        <version>${project.version}</version>
+      </dependency>
+
       <dependency>
         <groupId>io.camunda</groupId>
         <artifactId>zeebe-util</artifactId>

qa/integration-tests/pom.xml

@@ -171,6 +171,12 @@
       <scope>test</scope>
     </dependency>
 
+    <dependency>
+      <groupId>io.camunda</groupId>
+      <artifactId>zeebe-qa-util</artifactId>
+      <scope>test</scope>
+    </dependency>
+
     <dependency>
       <groupId>io.prometheus</groupId>
       <artifactId>simpleclient</artifactId>

qa/integration-tests/src/test/java/io/camunda/zeebe/it/clustering/FixedPartitionDistributionIT.java

@@ -7,11 +7,11 @@
  */
 package io.camunda.zeebe.it.clustering;
 
-import io.camunda.zeebe.test.util.actuator.PartitionsActuatorClient;
-import io.camunda.zeebe.test.util.actuator.PartitionsActuatorClient.PartitionStatus;
+import io.camunda.zeebe.qa.util.actuator.PartitionsActuatorClient;
+import io.camunda.zeebe.qa.util.actuator.PartitionsActuatorClient.PartitionStatus;
+import io.camunda.zeebe.qa.util.testcontainers.ContainerLogsDumper;
+import io.camunda.zeebe.qa.util.testcontainers.ZeebeTestContainerDefaults;
 import io.camunda.zeebe.test.util.asserts.EitherAssert;
-import io.camunda.zeebe.test.util.testcontainers.ContainerLogsDumper;
-import io.camunda.zeebe.test.util.testcontainers.ZeebeTestContainerDefaults;
 import io.camunda.zeebe.util.Either;
 import io.zeebe.containers.ZeebeBrokerNode;
 import io.zeebe.containers.cluster.ZeebeCluster;

qa/integration-tests/src/test/java/io/camunda/zeebe/it/clustering/LongPollingIT.java

@@ -10,8 +10,8 @@
 import io.camunda.zeebe.client.api.response.ProcessInstanceResult;
 import io.camunda.zeebe.model.bpmn.Bpmn;
 import io.camunda.zeebe.model.bpmn.BpmnModelInstance;
-import io.camunda.zeebe.test.util.testcontainers.ContainerLogsDumper;
-import io.camunda.zeebe.test.util.testcontainers.ZeebeTestContainerDefaults;
+import io.camunda.zeebe.qa.util.testcontainers.ContainerLogsDumper;
+import io.camunda.zeebe.qa.util.testcontainers.ZeebeTestContainerDefaults;
 import io.zeebe.containers.cluster.ZeebeCluster;
 import java.time.Duration;
 import java.util.concurrent.CompletionStage;

qa/integration-tests/src/test/java/io/camunda/zeebe/it/clustering/network/AsymmetricNetworkPartitionIT.java

@@ -16,8 +16,8 @@
 import io.camunda.zeebe.client.api.response.BrokerInfo;
 import io.camunda.zeebe.client.api.response.PartitionInfo;
 import io.camunda.zeebe.client.api.response.Topology;
-import io.camunda.zeebe.test.util.testcontainers.ContainerLogsDumper;
-import io.camunda.zeebe.test.util.testcontainers.ZeebeTestContainerDefaults;
+import io.camunda.zeebe.qa.util.testcontainers.ContainerLogsDumper;
+import io.camunda.zeebe.qa.util.testcontainers.ZeebeTestContainerDefaults;
 import io.zeebe.containers.ZeebeBrokerNode;
 import io.zeebe.containers.ZeebeNode;
 import io.zeebe.containers.cluster.ZeebeCluster;

qa/integration-tests/src/test/java/io/camunda/zeebe/it/gateway/GatewayGrpcHealthIT.java

@@ -10,7 +10,7 @@
 import static org.assertj.core.api.Assertions.assertThat;
 
 import io.camunda.zeebe.gateway.protocol.GatewayGrpc;
-import io.camunda.zeebe.test.util.testcontainers.ZeebeTestContainerDefaults;
+import io.camunda.zeebe.qa.util.testcontainers.ZeebeTestContainerDefaults;
 import io.grpc.ManagedChannel;
 import io.grpc.health.v1.HealthCheckRequest;
 import io.grpc.health.v1.HealthCheckResponse;

qa/integration-tests/src/test/java/io/camunda/zeebe/it/gateway/GatewayHealthProbeIntegrationTest.java

@@ -9,7 +9,7 @@
 
 import static io.restassured.RestAssured.given;
 
-import io.camunda.zeebe.test.util.testcontainers.ZeebeTestContainerDefaults;
+import io.camunda.zeebe.qa.util.testcontainers.ZeebeTestContainerDefaults;
 import io.restassured.builder.RequestSpecBuilder;
 import io.restassured.filter.log.RequestLoggingFilter;
 import io.restassured.filter.log.ResponseLoggingFilter;

qa/integration-tests/src/test/java/io/camunda/zeebe/it/health/BrokerMonitoringEndpointTest.java

@@ -11,7 +11,7 @@
 import static org.awaitility.Awaitility.await;
 import static org.hamcrest.CoreMatchers.containsString;
 
-import io.camunda.zeebe.test.util.testcontainers.ZeebeTestContainerDefaults;
+import io.camunda.zeebe.qa.util.testcontainers.ZeebeTestContainerDefaults;
 import io.restassured.builder.RequestSpecBuilder;
 import io.restassured.filter.log.RequestLoggingFilter;
 import io.restassured.filter.log.ResponseLoggingFilter;

qa/integration-tests/src/test/java/io/camunda/zeebe/it/health/DiskSpaceRecoveryIT.java

@@ -12,9 +12,9 @@
 import static org.awaitility.Awaitility.await;
 
 import io.camunda.zeebe.client.ZeebeClient;
-import io.camunda.zeebe.test.util.actuator.PartitionsActuatorClient;
+import io.camunda.zeebe.qa.util.actuator.PartitionsActuatorClient;
+import io.camunda.zeebe.qa.util.testcontainers.ZeebeTestContainerDefaults;
 import io.camunda.zeebe.test.util.asserts.EitherAssert;
-import io.camunda.zeebe.test.util.testcontainers.ZeebeTestContainerDefaults;
 import io.zeebe.containers.ZeebeContainer;
 import io.zeebe.containers.ZeebeVolume;
 import io.zeebe.containers.engine.ContainerEngine;

qa/integration-tests/src/test/java/io/camunda/zeebe/it/management/ControlledActorClockEndpointIT.java

@@ -19,7 +19,7 @@
 import io.camunda.zeebe.process.test.assertions.BpmnAssert;
 import io.camunda.zeebe.protocol.record.Record;
 import io.camunda.zeebe.protocol.record.RecordAssert;
-import io.camunda.zeebe.test.util.testcontainers.ZeebeTestContainerDefaults;
+import io.camunda.zeebe.qa.util.testcontainers.ZeebeTestContainerDefaults;
 import io.zeebe.containers.ZeebeContainer;
 import io.zeebe.containers.engine.ContainerEngine;
 import java.io.IOException;

qa/integration-tests/src/test/java/io/camunda/zeebe/it/management/RebalancingEndpointIT.java

@@ -11,7 +11,7 @@
 
 import io.camunda.zeebe.client.ZeebeClient;
 import io.camunda.zeebe.client.api.response.PartitionInfo;
-import io.camunda.zeebe.test.util.testcontainers.ZeebeTestContainerDefaults;
+import io.camunda.zeebe.qa.util.testcontainers.ZeebeTestContainerDefaults;
 import io.zeebe.containers.cluster.ZeebeCluster;
 import java.io.IOException;
 import java.net.URI;

qa/integration-tests/src/test/java/io/camunda/zeebe/it/network/AdvertisedAddressTest.java

@@ -9,8 +9,8 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
+import io.camunda.zeebe.qa.util.testcontainers.ZeebeTestContainerDefaults;
 import io.camunda.zeebe.test.util.asserts.TopologyAssert;
-import io.camunda.zeebe.test.util.testcontainers.ZeebeTestContainerDefaults;
 import io.zeebe.containers.ZeebeBrokerNode;
 import io.zeebe.containers.ZeebeGatewayNode;
 import io.zeebe.containers.ZeebeNode;

qa/integration-tests/src/test/java/io/camunda/zeebe/it/network/Ipv6IntegrationTest.java

@@ -12,8 +12,8 @@
 import com.github.dockerjava.api.model.Network.Ipam;
 import com.github.dockerjava.api.model.Network.Ipam.Config;
 import io.camunda.zeebe.client.api.response.Topology;
+import io.camunda.zeebe.qa.util.testcontainers.ZeebeTestContainerDefaults;
 import io.camunda.zeebe.test.util.asserts.TopologyAssert;
-import io.camunda.zeebe.test.util.testcontainers.ZeebeTestContainerDefaults;
 import io.zeebe.containers.ZeebeBrokerNode;
 import io.zeebe.containers.ZeebeGatewayNode;
 import io.zeebe.containers.ZeebePort;

qa/integration-tests/src/test/java/io/camunda/zeebe/it/network/SecureClusteredMessagingIT.java

@@ -9,10 +9,10 @@
 
 import io.atomix.utils.net.Address;
 import io.camunda.zeebe.client.api.response.Topology;
+import io.camunda.zeebe.qa.util.testcontainers.ContainerLogsDumper;
+import io.camunda.zeebe.qa.util.testcontainers.ZeebeTestContainerDefaults;
 import io.camunda.zeebe.test.util.asserts.SslAssert;
 import io.camunda.zeebe.test.util.asserts.TopologyAssert;
-import io.camunda.zeebe.test.util.testcontainers.ContainerLogsDumper;
-import io.camunda.zeebe.test.util.testcontainers.ZeebeTestContainerDefaults;
 import io.netty.handler.ssl.util.SelfSignedCertificate;
 import io.zeebe.containers.ZeebeNode;
 import io.zeebe.containers.cluster.ZeebeCluster;

qa/integration-tests/src/test/java/io/camunda/zeebe/it/queryapi/QueryApiIT.java

@@ -20,9 +20,9 @@
 import io.camunda.zeebe.it.queryapi.util.TestAuthorizationServerInterceptor;
 import io.camunda.zeebe.model.bpmn.Bpmn;
 import io.camunda.zeebe.model.bpmn.BpmnModelInstance;
+import io.camunda.zeebe.qa.util.testcontainers.ContainerLogsDumper;
+import io.camunda.zeebe.qa.util.testcontainers.ZeebeTestContainerDefaults;
 import io.camunda.zeebe.test.util.grpc.CloseAwareListener;
-import io.camunda.zeebe.test.util.testcontainers.ContainerLogsDumper;
-import io.camunda.zeebe.test.util.testcontainers.ZeebeTestContainerDefaults;
 import io.grpc.StatusRuntimeException;
 import io.zeebe.containers.ZeebeContainer;
 import java.io.File;

qa/integration-tests/src/test/java/io/camunda/zeebe/it/startup/RootlessImageTest.java

@@ -12,8 +12,8 @@
 import io.camunda.zeebe.client.ZeebeClient;
 import io.camunda.zeebe.client.api.response.ProcessInstanceResult;
 import io.camunda.zeebe.model.bpmn.Bpmn;
-import io.camunda.zeebe.test.util.testcontainers.ContainerLogsDumper;
-import io.camunda.zeebe.test.util.testcontainers.ZeebeTestContainerDefaults;
+import io.camunda.zeebe.qa.util.testcontainers.ContainerLogsDumper;
+import io.camunda.zeebe.qa.util.testcontainers.ZeebeTestContainerDefaults;
 import io.zeebe.containers.ZeebeBrokerContainer;
 import io.zeebe.containers.ZeebeGatewayContainer;
 import java.util.Map;

qa/pom.xml

@@ -18,6 +18,7 @@
   <modules>
     <module>integration-tests</module>
     <module>update-tests</module>
+    <module>util</module>
   </modules>
 
   <build>

qa/update-tests/pom.xml

@@ -28,6 +28,12 @@
       <scope>test</scope>
     </dependency>
 
+    <dependency>
+      <groupId>io.camunda</groupId>
+      <artifactId>zeebe-qa-util</artifactId>
+      <scope>test</scope>
+    </dependency>
+
     <dependency>
       <groupId>org.slf4j</groupId>
       <artifactId>slf4j-api</artifactId>

qa/update-tests/src/test/java/io/camunda/zeebe/test/ContainerState.java

@@ -8,9 +8,9 @@
 package io.camunda.zeebe.test;
 
 import io.camunda.zeebe.client.ZeebeClient;
-import io.camunda.zeebe.test.util.actuator.PartitionsActuatorClient;
-import io.camunda.zeebe.test.util.testcontainers.RemoteDebugger;
-import io.camunda.zeebe.test.util.testcontainers.ZeebeTestContainerDefaults;
+import io.camunda.zeebe.qa.util.actuator.PartitionsActuatorClient;
+import io.camunda.zeebe.qa.util.testcontainers.RemoteDebugger;
+import io.camunda.zeebe.qa.util.testcontainers.ZeebeTestContainerDefaults;
 import io.camunda.zeebe.util.VersionUtil;
 import io.zeebe.containers.ZeebeContainer;
 import io.zeebe.containers.ZeebeGatewayContainer;

qa/update-tests/src/test/java/io/camunda/zeebe/test/ContainerStateAssert.java

@@ -10,7 +10,7 @@
 import static io.camunda.zeebe.test.UpdateTestCaseProvider.PROCESS_ID;
 import static org.awaitility.Awaitility.await;
 
-import io.camunda.zeebe.test.util.actuator.PartitionsActuatorClient.PartitionStatus;
+import io.camunda.zeebe.qa.util.actuator.PartitionsActuatorClient.PartitionStatus;
 import io.camunda.zeebe.util.Either;
 import java.time.Duration;
 import java.util.Map;

qa/update-tests/src/test/java/io/camunda/zeebe/test/RollingUpdateTest.java

@@ -14,11 +14,11 @@
 import io.camunda.zeebe.client.api.worker.JobHandler;
 import io.camunda.zeebe.model.bpmn.Bpmn;
 import io.camunda.zeebe.model.bpmn.BpmnModelInstance;
-import io.camunda.zeebe.test.util.actuator.PartitionsActuatorClient;
-import io.camunda.zeebe.test.util.actuator.PartitionsActuatorClient.PartitionStatus;
+import io.camunda.zeebe.qa.util.actuator.PartitionsActuatorClient;
+import io.camunda.zeebe.qa.util.actuator.PartitionsActuatorClient.PartitionStatus;
+import io.camunda.zeebe.qa.util.testcontainers.ZeebeTestContainerDefaults;
 import io.camunda.zeebe.test.util.asserts.EitherAssert;
 import io.camunda.zeebe.test.util.asserts.TopologyAssert;
-import io.camunda.zeebe.test.util.testcontainers.ZeebeTestContainerDefaults;
 import io.camunda.zeebe.util.Either;
 import io.camunda.zeebe.util.VersionUtil;
 import io.zeebe.containers.ZeebeBrokerNode;

qa/util/pom.xml

@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+
+  <modelVersion>4.0.0</modelVersion>
+
+  <parent>
+    <groupId>io.camunda</groupId>
+    <artifactId>zeebe-qa</artifactId>
+    <version>8.1.0-SNAPSHOT</version>
+    <relativePath>../pom.xml</relativePath>
+  </parent>
+
+  <artifactId>zeebe-qa-util</artifactId>
+  <packaging>jar</packaging>
+
+  <name>Zeebe QA Utilities</name>
+
+  <dependencies>
+    <dependency>
+      <groupId>org.testcontainers</groupId>
+      <artifactId>testcontainers</artifactId>
+    </dependency>
+
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-api</artifactId>
+    </dependency>
+
+    <dependency>
+      <groupId>io.camunda</groupId>
+      <artifactId>zeebe-util</artifactId>
+    </dependency>
+
+    <dependency>
+      <groupId>org.slf4j</groupId>
+      <artifactId>slf4j-api</artifactId>
+    </dependency>
+
+    <dependency>
+      <groupId>com.fasterxml.jackson.core</groupId>
+      <artifactId>jackson-annotations</artifactId>
+    </dependency>
+
+    <dependency>
+      <groupId>com.fasterxml.jackson.core</groupId>
+      <artifactId>jackson-databind</artifactId>
+    </dependency>
+
+    <dependency>
+      <groupId>com.fasterxml.jackson.core</groupId>
+      <artifactId>jackson-core</artifactId>
+    </dependency>
+  </dependencies>
+</project>

test-util/src/main/java/io/camunda/zeebe/test/util/actuator/PartitionsActuatorClient.java → qa/util/src/main/java/io/camunda/zeebe/qa/util/actuator/PartitionsActuatorClient.java

@@ -5,7 +5,7 @@
  * Licensed under the Zeebe Community License 1.1. You may not use this file
  * except in compliance with the Zeebe Community License 1.1.
  */
-package io.camunda.zeebe.test.util.actuator;
+package io.camunda.zeebe.qa.util.actuator;
 
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.core.type.TypeReference;

test-util/src/main/java/io/camunda/zeebe/test/util/testcontainers/ContainerLogsDumper.java → qa/util/src/main/java/io/camunda/zeebe/qa/util/testcontainers/ContainerLogsDumper.java

@@ -5,7 +5,7 @@
  * Licensed under the Zeebe Community License 1.1. You may not use this file
  * except in compliance with the Zeebe Community License 1.1.
  */
-package io.camunda.zeebe.test.util.testcontainers;
+package io.camunda.zeebe.qa.util.testcontainers;
 
 import java.util.Map;
 import java.util.function.Supplier;
@@ -32,7 +32,7 @@ public ContainerLogsDumper(final Supplier<Map<?, ? extends Container<?>>> contai
 
   public ContainerLogsDumper(
       final Supplier<Map<?, ? extends Container<?>>> containers, final Logger logger) {
-    this.containersSupplier = containers;
+    containersSupplier = containers;
     this.logger = logger;
   }
 

test-util/src/main/java/io/camunda/zeebe/test/util/testcontainers/RemoteDebugger.java → qa/util/src/main/java/io/camunda/zeebe/qa/util/testcontainers/RemoteDebugger.java

@@ -5,7 +5,7 @@
  * Licensed under the Zeebe Community License 1.1. You may not use this file
  * except in compliance with the Zeebe Community License 1.1.
  */
-package io.camunda.zeebe.test.util.testcontainers;
+package io.camunda.zeebe.qa.util.testcontainers;
 
 import java.time.Duration;
 import org.testcontainers.containers.GenericContainer;

test-util/src/main/java/io/camunda/zeebe/test/util/testcontainers/ZeebeTestContainerDefaults.java → qa/util/src/main/java/io/camunda/zeebe/qa/util/testcontainers/ZeebeTestContainerDefaults.java

@@ -5,7 +5,7 @@
  * Licensed under the Zeebe Community License 1.1. You may not use this file
  * except in compliance with the Zeebe Community License 1.1.
  */
-package io.camunda.zeebe.test.util.testcontainers;
+package io.camunda.zeebe.qa.util.testcontainers;
 
 import java.util.Optional;
 import org.testcontainers.utility.DockerImageName;

test-util/pom.xml

@@ -66,11 +66,6 @@
       <artifactId>jackson-databind</artifactId>
     </dependency>
 
-    <dependency>
-      <groupId>com.fasterxml.jackson.core</groupId>
-      <artifactId>jackson-annotations</artifactId>
-    </dependency>
-
     <dependency>
       <groupId>org.msgpack</groupId>
       <artifactId>jackson-dataformat-msgpack</artifactId>
@@ -86,16 +81,6 @@
       <artifactId>junit</artifactId>
     </dependency>
 
-    <dependency>
-      <groupId>org.junit.jupiter</groupId>
-      <artifactId>junit-jupiter-api</artifactId>
-    </dependency>
-
-    <dependency>
-      <groupId>org.testcontainers</groupId>
-      <artifactId>testcontainers</artifactId>
-    </dependency>
-
     <dependency>
       <groupId>org.assertj</groupId>
       <artifactId>assertj-core</artifactId>
@@ -145,6 +130,12 @@
       <scope>compile</scope>
     </dependency>
 
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-api</artifactId>
+      <scope>test</scope>
+    </dependency>
+
     <dependency>
       <groupId>org.junit.jupiter</groupId>
       <artifactId>junit-jupiter-params</artifactId>