TEST: Only run management API tests on single-node clusters

Motivation
----------
Management API tests are sensitive to eventual consistency
issues in multi-node clusters.

Modifications
-------------
Add a `ManagementApi` annotation that says the test requires
exactly one node, and has JUnit tag (group) "ManagementApi".

Apply the annotation to all management API integration tests.

Modify the GHA integration test workflow:

* Make the cluster size a matrix parameter ("nodes").

* Add a matrix entry that uses a single-node cluster
and runs only the `ManagementApi` tests.

Rejected Alternatives
---------------------
We _could_ bend over backwards to ensure each
management operation propagates to all nodes
before making the next request. However, that
approach is counterproductive because it still
masks the underlying issue with the Management API,
and has the additional disadvantage that it's
harder to disable all those workarounds than it
is to simply run the tests against a multi-node
cluster.

Change-Id: I4130252a1ed8ca7630345523415182d1e28e4c1d
Reviewed-on: https://review.couchbase.org/c/couchbase-jvm-clients/+/230066
Reviewed-by: Graham Pople <[email protected]>
Tested-by: Build Bot <[email protected]>

Author: dnault

.github/workflows/integration-test.yml

@@ -21,22 +21,33 @@ jobs:
       matrix:
         include:
           - server: '7.6.5'
+            nodes: 3
             java-distribution: 'temurin'
             java-version: '21'
 
           - server: 'community-7.6.2'
+            nodes: 3
             java-distribution: 'temurin'
             java-version: '17'
 
+          - server: '7.6.5'
+            nodes: 1 # Management API tests require single node
+            mvn-test-args: -Dgroups=ManagementApi
+            java-distribution: 'temurin'
+            java-version: '21'
+
 #          - server: '7.2.7'
+#            nodes: 3
 #            java-distribution: 'temurin'
 #            java-version: '8'
 #
 #          - server: 'community-7.2.2'
+#            nodes: 3
 #            java-distribution: 'corretto'
 #            java-version: '8'
 #
 #          - server: '6.6.6'
+#            nodes: 3
 #            java-distribution: 'oracle'
 #            java-version: '17'
 
@@ -76,7 +87,7 @@ jobs:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           def: |
             nodes:
-              - count: 3
+              - count: ${{ matrix.nodes }}
                 version: ${{ matrix.server }}
                 services: ${{ env.COUCHBASE_SERVICES }}
             docker:
@@ -104,7 +115,7 @@ jobs:
         timeout-minutes: 40
         run: |
           TEST_JAVA_HOME=$JAVA_HOME_${{ matrix.java-version }}_X64
-          ./mvnw --batch-mode -Dmaven.test.failure.ignore=true -Dmaven.javadoc.skip=true verify -Djvm=${TEST_JAVA_HOME}/bin/java
+          ./mvnw --batch-mode -Dmaven.test.failure.ignore=true -Dmaven.javadoc.skip=true verify -Djvm=${TEST_JAVA_HOME}/bin/java ${{ matrix.mvn-test-args }}
 
       - name: Remove artifacts from Maven repo so they're not cached
         run: rm -rfv ~/.m2/repository/com/couchbase/client/

java-client/src/integrationTest/java/com/couchbase/client/java/manager/analytics/AnalyticsIndexManagerIntegrationTest.java

@@ -37,6 +37,7 @@
 import com.couchbase.client.java.util.JavaIntegrationTest;
 import com.couchbase.client.test.Flaky;
 import com.couchbase.client.test.IgnoreWhen;
+import com.couchbase.client.test.ManagementApiTest;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Assumptions;
@@ -85,6 +86,7 @@
   missesCapabilities = ANALYTICS,
   isProtostellar = true
 )
+@ManagementApiTest
 class AnalyticsIndexManagerIntegrationTest extends JavaIntegrationTest {
 
   private static final String dataset = "myDataset";

java-client/src/integrationTest/java/com/couchbase/client/java/manager/bucket/BucketManagerIntegrationTest.java

@@ -16,7 +16,6 @@
 
 package com.couchbase.client.java.manager.bucket;
 
-import com.couchbase.client.core.env.IoConfig;
 import com.couchbase.client.core.error.BucketExistsException;
 import com.couchbase.client.core.error.BucketNotFlushableException;
 import com.couchbase.client.core.error.BucketNotFoundException;
@@ -32,6 +31,7 @@
 import com.couchbase.client.test.Capabilities;
 import com.couchbase.client.test.ClusterType;
 import com.couchbase.client.test.IgnoreWhen;
+import com.couchbase.client.test.ManagementApiTest;
 import com.couchbase.client.test.Util;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.AfterEach;
@@ -61,6 +61,7 @@
  * Verifies the functionality of the bucket manager.
  */
 @IgnoreWhen(clusterTypes = { ClusterType.MOCKED, ClusterType.CAPELLA })
+@ManagementApiTest
 @Execution(ExecutionMode.CONCURRENT)
 class BucketManagerIntegrationTest extends JavaIntegrationTest {
 

java-client/src/integrationTest/java/com/couchbase/client/java/manager/collection/CollectionManagerIntegrationTest.java

@@ -27,6 +27,7 @@
 import com.couchbase.client.java.util.JavaIntegrationTest;
 import com.couchbase.client.test.Capabilities;
 import com.couchbase.client.test.IgnoreWhen;
+import com.couchbase.client.test.ManagementApiTest;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
@@ -44,6 +45,7 @@
 import static org.junit.jupiter.api.Assertions.assertThrows;
 
 @IgnoreWhen(missesCapabilities = Capabilities.COLLECTIONS)
+@ManagementApiTest
 class CollectionManagerIntegrationTest extends JavaIntegrationTest {
 
   private static Cluster cluster;

java-client/src/integrationTest/java/com/couchbase/client/java/manager/eventing/EventingFunctionManagerIntegrationTest.java

@@ -32,6 +32,7 @@
 import com.couchbase.client.test.Capabilities;
 import com.couchbase.client.test.ClusterType;
 import com.couchbase.client.test.IgnoreWhen;
+import com.couchbase.client.test.ManagementApiTest;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
@@ -51,6 +52,7 @@
         missesCapabilities = {Capabilities.COLLECTIONS, Capabilities.EVENTING},
         clusterVersionIsBelow = "7.1.2",
         isProtostellar = true) // MB-52649
+@ManagementApiTest
 public class EventingFunctionManagerIntegrationTest extends JavaIntegrationTest {
   private static Logger LOGGER = LoggerFactory.getLogger(EventingFunctionManagerIntegrationTest.class);
 

java-client/src/integrationTest/java/com/couchbase/client/java/manager/query/QueryCollectionsIndexManagerIntegrationTest.java

@@ -25,6 +25,7 @@
 import com.couchbase.client.java.Cluster;
 import com.couchbase.client.java.util.JavaIntegrationTest;
 import com.couchbase.client.test.IgnoreWhen;
+import com.couchbase.client.test.ManagementApiTest;
 import com.couchbase.client.test.Util;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.BeforeAll;
@@ -69,6 +70,7 @@
   missesCapabilities = { QUERY, COLLECTIONS, CLUSTER_LEVEL_QUERY },
   clusterVersionIsBelow = REQUIRE_MB_50132
 )
+@ManagementApiTest
 public class QueryCollectionsIndexManagerIntegrationTest extends JavaIntegrationTest {
 
   // time to allow for watch operations that are expected to succeed eventually

java-client/src/integrationTest/java/com/couchbase/client/java/manager/query/QueryIndexManagerIntegrationTest.java

@@ -24,6 +24,7 @@
 import com.couchbase.client.java.Cluster;
 import com.couchbase.client.java.util.JavaIntegrationTest;
 import com.couchbase.client.test.IgnoreWhen;
+import com.couchbase.client.test.ManagementApiTest;
 import com.couchbase.client.test.Util;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.BeforeAll;
@@ -65,6 +66,7 @@
   clusterVersionIsBelow = REQUIRE_MB_50132,
   isProtostellar = true
 )
+@ManagementApiTest
 public class QueryIndexManagerIntegrationTest extends JavaIntegrationTest {
   // Disabling against 5.5 as there appear to be several query bugs (SCBC-246, SCBC-251).  Hardcoding 5.5.6 as that's
   // the current 5.5-release and it's unlikely to change.

java-client/src/integrationTest/java/com/couchbase/client/java/manager/raw/RawManagerIntegrationTest.java

@@ -24,6 +24,7 @@
 import com.couchbase.client.java.Cluster;
 import com.couchbase.client.java.util.JavaIntegrationTest;
 import com.couchbase.client.test.IgnoreWhen;
+import com.couchbase.client.test.ManagementApiTest;
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.BeforeAll;
@@ -40,6 +41,7 @@
 
 @IgnoreWhen(clusterTypes = MOCKED,
   isProtostellar = true)
+@ManagementApiTest
 class RawManagerIntegrationTest extends JavaIntegrationTest {
 
   private static Cluster cluster;

java-client/src/integrationTest/java/com/couchbase/client/java/manager/search/SearchIndexManagerIntegrationTest.java

@@ -25,6 +25,7 @@
 import com.couchbase.client.java.util.JavaIntegrationTest;
 import com.couchbase.client.test.Capabilities;
 import com.couchbase.client.test.IgnoreWhen;
+import com.couchbase.client.test.ManagementApiTest;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
@@ -45,6 +46,7 @@
   clusterVersionIsBelow = ConsistencyUtil.CLUSTER_VERSION_MB_50101,
   isProtostellar = true
 )
+@ManagementApiTest
 class SearchIndexManagerIntegrationTest extends JavaIntegrationTest {
 
   private static final Logger LOGGER = LoggerFactory.getLogger(SearchIndexManagerIntegrationTest.class);

java-client/src/integrationTest/java/com/couchbase/client/java/manager/user/GroupManagerIntegrationTest.java

@@ -23,6 +23,7 @@
 import com.couchbase.client.test.Capabilities;
 import com.couchbase.client.test.ClusterType;
 import com.couchbase.client.test.IgnoreWhen;
+import com.couchbase.client.test.ManagementApiTest;
 import com.couchbase.client.test.Util;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.AfterEach;
@@ -54,6 +55,7 @@
   missesCapabilities = {Capabilities.USER_GROUPS, Capabilities.ENTERPRISE_EDITION},
   isProtostellar = true
 )
+@ManagementApiTest
 class GroupManagerIntegrationTest extends JavaIntegrationTest {
   private static final Logger LOGGER = LoggerFactory.getLogger(GroupManagerIntegrationTest.class);