feat: allow cli to connect to a couchbase auditstore

Author: bercianor

cli/flamingock-cli/CLI-README.md

@@ -115,6 +115,19 @@ flamingock:
       # secret-key: "your-secret"          # Optional, uses AWS credential chain
 ```
 
+### Couchbase Example
+```yaml
+flamingock:
+  service-identifier: "flamingock-cli"
+  audit:
+    couchbase:
+      endpoint: "http://localhost:8000"
+      username: "your-username"
+      password: "your-password"
+      bucket-name: "test"
+      table: "flamingockAuditLog"           # Optional, defaults to "flamingockAuditLog"
+```
+
 ### Configuration File Resolution
 1. Command line argument: `--config /path/to/file.yml`
 2. Default: `flamingock.yml` in current directory
@@ -144,6 +157,7 @@ client.markAsRolledBack(changeId);
 ### Database Support
 - **MongoDB**: Uses MongoDB Sync driver (not Spring Data)
 - **DynamoDB**: Uses AWS SDK v2
+- **Couchbase**: Uses Couchbase driver v3.7.3
 - **Auto-detection**: Based on YAML configuration structure
 - **Validation**: Connection testing during client creation
 
@@ -179,12 +193,12 @@ Uses SLF4J with simple implementation for clean, professional output.
 ## Build System Integration
 
 ### Gradle Tasks
-| Task | Description |
-|------|-------------|
-| `:cli:flamingock-cli:build` | Full build with distribution |
-| `:cli:flamingock-cli:uberJar` | Create self-contained JAR only |
+| Task                                       | Description                      |
+|--------------------------------------------|----------------------------------|
+| `:cli:flamingock-cli:build`                | Full build with distribution     |
+| `:cli:flamingock-cli:uberJar`              | Create self-contained JAR only   |
 | `:cli:flamingock-cli:generateDistribution` | Generate executable scripts only |
-| `:cli:flamingock-cli:clean` | Remove all CLI artifacts |
+| `:cli:flamingock-cli:clean`                | Remove all CLI artifacts         |
 
 ### Automatic Distribution
 The build process automatically:

cli/flamingock-cli/build.gradle.kts

@@ -23,6 +23,7 @@ dependencies {
     // Database clients (community edition)
     implementation("org.mongodb:mongodb-driver-sync:4.9.1")
     implementation("software.amazon.awssdk:dynamodb:2.20.0")
+    implementation ("com.couchbase.client:java-client:3.7.3")
 
     // SLF4J API - needed for interface compatibility (provided by flamingock-core)
     // implementation("org.slf4j:slf4j-api:1.7.36") // Already provided by core dependencies
@@ -36,6 +37,7 @@ dependencies {
     testImplementation("org.assertj:assertj-core:3.24.2")
     testImplementation("org.testcontainers:junit-jupiter:1.19.3")
     testImplementation("org.testcontainers:mongodb:1.19.3")
+    testImplementation("org.testcontainers:couchbase:1.21.3")
     testImplementation("com.github.stefanbirkner:system-lambda:1.2.1")
 
 }

cli/flamingock-cli/src/dist/flamingock-sample.yml

@@ -7,13 +7,22 @@ flamingock:
     mongodb:
       connection-string: "mongodb://localhost:27017"
       database: "test"
-      collection: "flamingockAuditLog"  # Optional, defaults to "flamingockAuditLog"
+      collection: "flamingockAuditLog"          # Optional, defaults to "flamingockAuditLog"
 
-  # DynamoDB Configuration (uncomment and modify to use)
-  # audit:
-  #   dynamodb:
-  #     region: "us-east-1"
-  #     table: "flamingockAuditLog"      # Optional, defaults to "flamingockAuditLog"
-  #     # endpoint: "http://localhost:8000"  # Optional for local DynamoDB
-  #     # access-key: "your-access-key"      # Optional if using IAM roles
-  #     # secret-key: "your-secret-key"      # Optional if using IAM roles
+    # DynamoDB Configuration (uncomment and modify to use)
+    # audit:
+    #   dynamodb:
+    #     region: "us-east-1"
+    #     table: "flamingockAuditLog"           # Optional, defaults to "flamingockAuditLog"
+    #     # endpoint: "http://localhost:8000"   # Optional for local DynamoDB
+    #     # access-key: "your-access-key"       # Optional if using IAM roles
+    #     # secret-key: "your-secret-key"       # Optional if using IAM roles
+
+    # Couchbase Configuration (uncomment and modify to use)
+    # audit:
+    #   couchbase:
+    #     endpoint: "http://localhost:8000"
+    #     username: "your-username"
+    #     password: "your-password"
+    #     bucket-name: "test"
+    #     table: "flamingockAuditLog"           # Optional, defaults to "flamingockAuditLog"

cli/flamingock-cli/src/main/java/io/flamingock/cli/config/ConfigLoader.java

@@ -41,7 +41,7 @@ public static FlamingockConfig loadConfig(String configFilePath) throws IOExcept
     @SuppressWarnings("unchecked")
     private static FlamingockConfig parseConfig(Map<String, Object> yamlData) {
         FlamingockConfig config = new FlamingockConfig();
-        
+
         Map<String, Object> flamingockData = (Map<String, Object>) yamlData.get("flamingock");
         if (flamingockData == null) {
             throw new IllegalArgumentException("Missing 'flamingock' section in configuration file");
@@ -56,7 +56,7 @@ private static FlamingockConfig parseConfig(Map<String, Object> yamlData) {
         Map<String, Object> auditData = (Map<String, Object>) flamingockData.get("audit");
         if (auditData != null) {
             DatabaseConfig databaseConfig = new DatabaseConfig();
-            
+
             // Parse MongoDB config
             Map<String, Object> mongoData = (Map<String, Object>) auditData.get("mongodb");
             if (mongoData != null) {
@@ -71,7 +71,7 @@ private static FlamingockConfig parseConfig(Map<String, Object> yamlData) {
                 }
                 databaseConfig.setMongodb(mongoConfig);
             }
-            
+
             // Parse DynamoDB config
             Map<String, Object> dynamoData = (Map<String, Object>) auditData.get("dynamodb");
             if (dynamoData != null) {
@@ -85,7 +85,21 @@ private static FlamingockConfig parseConfig(Map<String, Object> yamlData) {
                 }
                 databaseConfig.setDynamodb(dynamoConfig);
             }
-            
+
+            // Parse Couchbase config
+            Map<String, Object> couchbaseData = (Map<String, Object>) auditData.get("couchbase");
+            if (couchbaseData != null) {
+                DatabaseConfig.CouchbaseConfig couchbaseConfig = new DatabaseConfig.CouchbaseConfig();
+                couchbaseConfig.setBucketName((String) couchbaseData.get("bucket-name"));
+                couchbaseConfig.setEndpoint((String) couchbaseData.get("endpoint"));
+                couchbaseConfig.setUsername((String) couchbaseData.get("username"));
+                couchbaseConfig.setPassword((String) couchbaseData.get("password"));
+                if (couchbaseData.get("properties") != null) {
+                    couchbaseConfig.setProperties((Map<String, String>) couchbaseData.get("properties"));
+                }
+                databaseConfig.setCouchbase(couchbaseConfig);
+            }
+
             config.setAudit(databaseConfig);
         }
 
@@ -96,24 +110,27 @@ public static DatabaseType detectDatabaseType(FlamingockConfig config) {
         if (config.getAudit() == null) {
             throw new IllegalArgumentException("No audit configuration found");
         }
-        
+
         boolean hasMongoDB = config.getAudit().getMongodb() != null;
         boolean hasDynamoDB = config.getAudit().getDynamodb() != null;
-        
-        if (hasMongoDB && hasDynamoDB) {
+        boolean hasCouchbase = config.getAudit().getCouchbase() != null;
+
+        if (hasMongoDB && hasDynamoDB) { // TODO: Check if more than one DB is configured
             throw new IllegalArgumentException("Multiple database configurations found. Please configure only one database type.");
         }
-        
+
         if (hasMongoDB) {
             return DatabaseType.MONGODB;
         } else if (hasDynamoDB) {
             return DatabaseType.DYNAMODB;
+        } else if (hasCouchbase) {
+            return DatabaseType.COUCHBASE;
         } else {
-            throw new IllegalArgumentException("No supported database configuration found. Please configure MongoDB or DynamoDB.");
+            throw new IllegalArgumentException("No supported database configuration found. Please configure MongoDB, DynamoDB or Couchbase.");
         }
     }
 
     public enum DatabaseType {
-        MONGODB, DYNAMODB
+        MONGODB, DYNAMODB, COUCHBASE
     }
-}
+}

cli/flamingock-cli/src/main/java/io/flamingock/cli/config/DatabaseConfig.java

@@ -20,6 +20,7 @@
 public class DatabaseConfig {
     private MongoDBConfig mongodb;
     private DynamoDBConfig dynamodb;
+    private CouchbaseConfig couchbase;
 
     public MongoDBConfig getMongodb() {
         return mongodb;
@@ -37,6 +38,14 @@ public void setDynamodb(DynamoDBConfig dynamodb) {
         this.dynamodb = dynamodb;
     }
 
+    public CouchbaseConfig getCouchbase() {
+        return couchbase;
+    }
+
+    public void setCouchbase(CouchbaseConfig couchbase) {
+        this.couchbase = couchbase;
+    }
+
     public static class MongoDBConfig {
         private String connectionString;
         private String database;
@@ -141,4 +150,52 @@ public void setProperties(Map<String, String> properties) {
             this.properties = properties;
         }
     }
-}
+
+    public static class CouchbaseConfig {
+        private String bucketName;
+        private String endpoint;
+        private String username;
+        private String password;
+        private Map<String, String> properties;
+
+        public String getBucketName() {
+            return bucketName;
+        }
+
+        public void setBucketName(String bucketName) {
+            this.bucketName = bucketName;
+        }
+
+        public String getEndpoint() {
+            return endpoint;
+        }
+
+        public void setEndpoint(String endpoint) {
+            this.endpoint = endpoint;
+        }
+
+        public String getUsername() {
+            return username;
+        }
+
+        public void setUsername(String username) {
+            this.username = username;
+        }
+
+        public String getPassword() {
+            return password;
+        }
+
+        public void setPassword(String password) {
+            this.password = password;
+        }
+
+        public Map<String, String> getProperties() {
+            return properties;
+        }
+
+        public void setProperties(Map<String, String> properties) {
+            this.properties = properties;
+        }
+    }
+}

cli/flamingock-cli/src/main/java/io/flamingock/cli/factory/CouchbaseClusterFactory.java

@@ -0,0 +1,55 @@
+/*
+ * Copyright 2025 Flamingock (https://www.flamingock.io)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.flamingock.cli.factory;
+
+import com.couchbase.client.java.Cluster;
+import io.flamingock.cli.config.DatabaseConfig;
+
+public class CouchbaseClusterFactory {
+
+    public static Cluster createCouchbaseCluster(DatabaseConfig.CouchbaseConfig config) {
+        if (config == null) {
+            throw new IllegalArgumentException("Couchbase configuration is required");
+        }
+
+        if (config.getBucketName() == null) {
+            throw new IllegalArgumentException("Bucket name is required");
+        }
+
+        if (config.getEndpoint() == null) {
+            throw new IllegalArgumentException("Couchbase endpoint is required");
+        }
+
+        if (config.getUsername() == null) {
+            throw new IllegalArgumentException("Couchbase username is required");
+        }
+
+        if (config.getPassword() == null) {
+            throw new IllegalArgumentException("Couchbase password is required");
+        }
+
+        try {
+            Cluster couchbaseCluster = Cluster.connect(config.getEndpoint(), config.getUsername(), config.getPassword());
+
+            // Test the connection by listing collections in bucket
+            couchbaseCluster.bucket(config.getBucketName()).collections();
+
+            return couchbaseCluster;
+        } catch (Exception e) {
+            throw new RuntimeException("Failed to create Couchbase cluster: " + e.getMessage(), e);
+        }
+    }
+}

cli/flamingock-cli/src/main/java/io/flamingock/cli/service/AuditService.java

@@ -15,13 +15,15 @@
  */
 package io.flamingock.cli.service;
 
+import com.couchbase.client.java.Cluster;
 import com.mongodb.client.MongoClient;
-import com.mongodb.client.MongoDatabase;
 import io.flamingock.cli.config.ConfigLoader;
 import io.flamingock.cli.config.DatabaseConfig;
 import io.flamingock.cli.config.FlamingockConfig;
+import io.flamingock.cli.factory.CouchbaseClusterFactory;
 import io.flamingock.cli.factory.DynamoDBClientFactory;
 import io.flamingock.cli.factory.MongoClientFactory;
+import io.flamingock.community.couchbase.driver.CouchbaseAuditStore;
 import io.flamingock.community.dynamodb.driver.DynamoDBAuditStore;
 import io.flamingock.community.mongodb.sync.driver.MongoDBSyncAuditStore;
 import io.flamingock.internal.common.core.audit.AuditEntry;
@@ -138,6 +140,8 @@ private AuditStore<?> createAuditStore(Context context) {
                 return createMongoAuditStore(context);
             case DYNAMODB:
                 return createDynamoAuditStore(context);
+            case COUCHBASE:
+                return createCouchbaseAuditStore(context);
             default:
                 throw new IllegalStateException("Unsupported database type: " + databaseType);
         }
@@ -160,4 +164,13 @@ private AuditStore<?> createDynamoAuditStore(Context context) {
 
         return new DynamoDBAuditStore(dynamoClient);
     }
+
+    private AuditStore<?> createCouchbaseAuditStore(Context context) {
+        DatabaseConfig.CouchbaseConfig couchbaseConfig = config.getAudit().getCouchbase();
+
+        // Create Couchbase cluster
+        Cluster couchbaseCluster = CouchbaseClusterFactory.createCouchbaseCluster(couchbaseConfig);
+
+        return new CouchbaseAuditStore(couchbaseCluster, couchbaseConfig.getBucketName());
+    }
 }