Couchbase: Update to latest version, add flushEnabled flag (#4041)

Co-authored-by: Richard North <[email protected]>

Author: Gerschtli

docs/modules/databases/couchbase.md

@@ -18,16 +18,11 @@ Running Couchbase as a stand-in in a test:
     [Container definition](../../../modules/couchbase/src/test/java/org/testcontainers/couchbase/CouchbaseContainerTest.java) inside_block:container_definition
     <!--/codeinclude-->
 
-3. create an environment & cluster:
+3. create an cluster:
     <!--codeinclude-->
     [Cluster creation](../../../modules/couchbase/src/test/java/org/testcontainers/couchbase/CouchbaseContainerTest.java) inside_block:cluster_creation
     <!--/codeinclude-->
 
-4. authenticate:
-    <!--codeinclude-->
-    [Authentication](../../../modules/couchbase/src/test/java/org/testcontainers/couchbase/CouchbaseContainerTest.java) inside_block:auth
-    <!--/codeinclude-->
-
 ## Adding this module to your project dependencies
 
 Add the following dependency to your `pom.xml`/`build.gradle` file:

modules/couchbase/AUTHORS

@@ -1 +1,2 @@
 Tayeb Chlyah <[email protected]>
+Tobias Happ <[email protected]>

modules/couchbase/build.gradle

@@ -3,5 +3,6 @@ description = "Testcontainers :: Couchbase"
 dependencies {
     api project(':testcontainers')
 
-    testImplementation 'com.couchbase.client:java-client:2.7.15'
+    testImplementation 'com.couchbase.client:java-client:3.1.6'
+    testImplementation 'org.awaitility:awaitility:3.0.0'
 }

modules/couchbase/src/main/java/org/testcontainers/couchbase/BucketDefinition.java

@@ -22,13 +22,25 @@
 public class BucketDefinition {
 
     private final String name;
+    private boolean flushEnabled = false;
     private boolean queryPrimaryIndex = true;
     private int quota = 100;
 
     public BucketDefinition(final String name) {
         this.name = name;
     }
 
+    /**
+     * Enables flush for this bucket (disabled by default).
+     *
+     * @param flushEnabled if true, the bucket can be flushed.
+     * @return this {@link BucketDefinition} for chaining purposes.
+     */
+    public BucketDefinition withFlushEnabled(final boolean flushEnabled) {
+        this.flushEnabled = flushEnabled;
+        return this;
+    }
+
     /**
      * Sets a custom bucket quota (100MB by default).
      *
@@ -58,6 +70,10 @@ public String getName() {
         return name;
     }
 
+    public boolean hasFlushEnabled() {
+        return flushEnabled;
+    }
+
     public boolean hasPrimaryIndex() {
         return queryPrimaryIndex;
     }

modules/couchbase/src/main/java/org/testcontainers/couchbase/CouchbaseContainer.java

@@ -368,6 +368,7 @@ private void createBuckets() {
             @Cleanup Response response = doHttpRequest(MGMT_PORT, "/pools/default/buckets", "POST", new FormBody.Builder()
                 .add("name", bucket.getName())
                 .add("ramQuotaMB", Integer.toString(bucket.getQuota()))
+                .add("flushEnabled", bucket.hasFlushEnabled() ? "1" : "0")
                 .build(), true);
 
             checkSuccessfulResponse(response, "Could not create bucket " + bucket.getName());

modules/couchbase/src/test/java/org/testcontainers/couchbase/CouchbaseContainerTest.java

@@ -18,16 +18,17 @@
 
 import com.couchbase.client.java.Bucket;
 import com.couchbase.client.java.Cluster;
-import com.couchbase.client.java.CouchbaseCluster;
-import com.couchbase.client.java.document.JsonDocument;
-import com.couchbase.client.java.document.json.JsonObject;
-import com.couchbase.client.java.env.CouchbaseEnvironment;
-import com.couchbase.client.java.env.DefaultCouchbaseEnvironment;
+import com.couchbase.client.java.Collection;
+import com.couchbase.client.java.json.JsonObject;
 import org.junit.Test;
 import org.testcontainers.utility.DockerImageName;
 
-import static org.junit.Assert.assertNotNull;
-import static org.junit.Assert.assertTrue;
+import java.time.Duration;
+import java.util.function.Consumer;
+
+import static org.awaitility.Awaitility.await;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
 
 public class CouchbaseContainerTest {
 
@@ -45,37 +46,60 @@ public void testBasicContainerUsage() {
                 .withBucket(bucketDefinition)
             // }
         ) {
-            container.start();
-
-            // cluster_creation {
-            CouchbaseEnvironment environment = DefaultCouchbaseEnvironment
-                .builder()
-                .bootstrapCarrierDirectPort(container.getBootstrapCarrierDirectPort())
-                .bootstrapHttpDirectPort(container.getBootstrapHttpDirectPort())
-                .build();
-
-            Cluster cluster = CouchbaseCluster.create(
-                environment,
-                container.getHost()
-            );
-            // }
+            setUpClient(container, cluster -> {
+                Bucket bucket = cluster.bucket(bucketDefinition.getName());
+                bucket.waitUntilReady(Duration.ofSeconds(10L));
+
+                Collection collection = bucket.defaultCollection();
+
+                collection.upsert("foo", JsonObject.create().put("key", "value"));
+
+                JsonObject fooObject = collection.get("foo").contentAsObject();
+
+                assertEquals("value", fooObject.getString("key"));
+            });
+        }
+    }
+
+    @Test
+    public void testBucketIsFlushableIfEnabled() {
+        BucketDefinition bucketDefinition = new BucketDefinition("mybucket")
+            .withFlushEnabled(true);
 
-            try {
-                // auth {
-                cluster.authenticate(container.getUsername(), container.getPassword());
-                // }
+        try (
+            CouchbaseContainer container = new CouchbaseContainer(COUCHBASE_IMAGE)
+                .withBucket(bucketDefinition)
+        ) {
+            setUpClient(container, cluster -> {
+                Bucket bucket = cluster.bucket(bucketDefinition.getName());
+                bucket.waitUntilReady(Duration.ofSeconds(10L));
+
+                Collection collection = bucket.defaultCollection();
 
-                Bucket bucket = cluster.openBucket(bucketDefinition.getName());
+                collection.upsert("foo", JsonObject.create().put("key", "value"));
 
-                bucket.upsert(JsonDocument.create("foo", JsonObject.empty()));
+                cluster.buckets().flushBucket(bucketDefinition.getName());
 
-                assertTrue(bucket.exists("foo"));
-                assertNotNull(cluster.clusterManager().getBucket(bucketDefinition.getName()));
-            } finally {
-                cluster.disconnect();
-                environment.shutdown();
-            }
+                await().untilAsserted(() -> assertFalse(collection.exists("foo").exists()));
+            });
         }
     }
 
+    private void setUpClient(CouchbaseContainer container, Consumer<Cluster> consumer) {
+        container.start();
+
+        // cluster_creation {
+        Cluster cluster = Cluster.connect(
+            container.getConnectionString(),
+            container.getUsername(),
+            container.getPassword()
+        );
+        // }
+
+        try {
+            consumer.accept(cluster);
+        } finally {
+            cluster.disconnect();
+        }
+    }
 }