chore: convert couchbase test into testable example

docs/modules/couchbase.md

@@ -17,7 +17,7 @@ go get github.com/testcontainers/testcontainers-go/modules/couchbase
 ## Usage example
 
 <!--codeinclude-->
-[Start Couchbase](../../modules/couchbase/couchbase_test.go) inside_block:withBucket
+[Creating a Couchbase container](../../modules/couchbase/examples_test.go) inside_block:runCouchbaseContainer
 <!--/codeinclude-->
 
 ## Module Reference
@@ -49,6 +49,11 @@ Once the container is started, it will perform the following operations, **in th
 
 ### Container Ports
 
+Here you can find the list with the default ports used by the Couchbase container. The Management ports (`MGMT_PORT` and `MGMT_SSL_PORT`) and the Service ports for `kv`, `query` and `search` are exposed by default.
+
+!!!tip
+	You can export the service ports for Analytics and Eventing by using the `WithServiceAnalytics` and `WithServiceEventing` optional functions.
+
 <!--codeinclude-->
 [Container Ports](../../modules/couchbase/couchbase.go) inside_block:containerPorts
 <!--/codeinclude-->
@@ -68,6 +73,12 @@ By default, the container will use the following Docker image:
 [Default Docker image](../../modules/couchbase/couchbase.go) inside_block:defaultImage
 <!--/codeinclude-->
 
+You can find the Docker images that are currently tested in this module, for the Enterprise and Community editions, in the following list:
+
+<!--codeinclude-->
+[Docker images](../../modules/couchbase/couchbase_test.go) inside_block:dockerImages
+<!--/codeinclude-->
+
 #### Wait Strategies
 
 If you need to set a different wait strategy for Couchbase, you can use `testcontainers.WithWaitStrategy` with a valid wait strategy
@@ -94,12 +105,12 @@ If you need to change the default credentials for the admin user, you can use `W
 When the password has less than 6 characters, the container won't be created and the `RunContainer` function will throw an error.
 
 !!!info
-	The default username is `Administrator` and the default password is `password`.
+	In the case this optional function is not called, the default username is `Administrator` and the default password is `password`.
 
 #### Buckets
 
-When creating a new Couchbase container, you can create one or more buckets. The module provides with a `WithBuckets` function that accepts an array of buckets to be created.
-To create a new bucket, the module exposes a `NewBucket` function, where you can pass the bucket name.
+When creating a new Couchbase container, you can create one or more buckets. The module exposes a `WithBuckets` optional function that accepts an slice of buckets to be created.
+To create a new bucket, the module also exposes a `NewBucket` function, where you can pass the bucket name.
 
 It's possible to customize a newly created bucket, using the following options:
 
@@ -131,33 +142,17 @@ By default, the container will start with the following services: `kv`, `n1ql`,
 	When running the Enterprise Edition of Couchbase Server, the module provides two functions to enable or disable services:
 	`WithServiceAnalytics` and `WithServiceEventing`. Else, it will throw an error and the container won't be created.
 
-<!--codeinclude-->
-[Docker images](../../modules/couchbase/couchbase_test.go) inside_block:dockerImages
-<!--/codeinclude-->
-
 ### Container Methods
 
 #### ConnectionString
 
 The `ConnectionString` method returns the connection string to connect to the Couchbase container instance. 
 It returns a string with the format `couchbase://<host>:<port>`.
 
-<!--codeinclude-->
-[Connect to Couchbase](../../modules/couchbase/couchbase_test.go) inside_block:connectToCluster
-<!--/codeinclude-->
-
 #### Username
 
 The `Username` method returns the username of the Couchbase administrator. 
 
-<!--codeinclude-->
-[Connect to Couchbase using Credentials](../../modules/couchbase/couchbase_test.go) inside_block:getCredentials
-<!--/codeinclude-->
-
 #### Password
 
 The `Password` method returns the password of the Couchbase administrator.
-
-<!--codeinclude-->
-[Connect to Couchbase using Credentials](../../modules/couchbase/couchbase_test.go) inside_block:getCredentials
-<!--/codeinclude-->

modules/couchbase/couchbase.go

@@ -18,8 +18,8 @@ import (
 	"github.com/testcontainers/testcontainers-go/wait"
 )
 
-// containerPorts {
 const (
+	// containerPorts {
 	MGMT_PORT     = "8091"
 	MGMT_SSL_PORT = "18091"
 
@@ -40,8 +40,12 @@ const (
 
 	KV_PORT     = "11210"
 	KV_SSL_PORT = "11207"
+	// }
 )
 
+// defaultImage {
+const defaultImage = "couchbase:6.5.1"
+
 // }
 
 // initialServices is the list of services that are enabled by default
@@ -65,9 +69,7 @@ func RunContainer(ctx context.Context, opts ...testcontainers.ContainerCustomize
 	}
 
 	req := testcontainers.ContainerRequest{
-		// defaultImage {
-		Image: "couchbase:6.5.1",
-		// }
+		Image:        defaultImage,
 		ExposedPorts: []string{MGMT_PORT + "/tcp", MGMT_SSL_PORT + "/tcp"},
 	}
 

modules/couchbase/couchbase_test.go

@@ -11,39 +11,13 @@ import (
 	tccouchbase "github.com/testcontainers/testcontainers-go/modules/couchbase"
 )
 
-// dockerImages {
 const (
+	// dockerImages {
 	enterpriseEdition = "couchbase:enterprise-7.1.3"
 	communityEdition  = "couchbase:community-7.1.1"
+	// }
 )
 
-// }
-
-// Deprecated
-func TestStartContainer(t *testing.T) {
-	ctx := context.Background()
-
-	bucketName := "testBucket"
-	container, err := tccouchbase.StartContainer(ctx, tccouchbase.WithImageName(communityEdition), tccouchbase.WithBucket(tccouchbase.NewBucket(bucketName)))
-	if err != nil {
-		t.Fatal(err)
-	}
-
-	// Clean up the container after the test is complete
-	t.Cleanup(func() {
-		if err := container.Terminate(ctx); err != nil {
-			t.Fatalf("failed to terminate container: %s", err)
-		}
-	})
-
-	cluster, err := connectCluster(ctx, container)
-	if err != nil {
-		t.Fatalf("could not connect couchbase: %s", err)
-	}
-
-	testBucketUsage(t, cluster.Bucket(bucketName))
-}
-
 func TestCouchbaseWithCommunityContainer(t *testing.T) {
 	ctx := context.Background()
 
@@ -187,19 +161,14 @@ func testBucketUsage(t *testing.T, bucket *gocb.Bucket) {
 	}
 }
 
-// connectToCluster {
 func connectCluster(ctx context.Context, container *tccouchbase.CouchbaseContainer) (*gocb.Cluster, error) {
 	connectionString, err := container.ConnectionString(ctx)
 	if err != nil {
 		return nil, err
 	}
 
-	// getCredentials {
 	return gocb.Connect(connectionString, gocb.ClusterOptions{
 		Username: container.Username(),
 		Password: container.Password(),
 	})
-	// }
 }
-
-// }

modules/couchbase/examples_test.go

@@ -0,0 +1,71 @@
+package couchbase_test
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/couchbase/gocb/v2"
+	"github.com/testcontainers/testcontainers-go"
+	"github.com/testcontainers/testcontainers-go/modules/couchbase"
+)
+
+func ExampleRunContainer() {
+	// runCouchbaseContainer {
+	ctx := context.Background()
+
+	bucketName := "testBucket"
+	bucket := couchbase.NewBucket(bucketName)
+
+	bucket = bucket.WithQuota(100).
+		WithReplicas(0).
+		WithFlushEnabled(false).
+		WithPrimaryIndex(true)
+
+	couchbaseContainer, err := couchbase.RunContainer(ctx,
+		testcontainers.WithImage("couchbase:community-7.1.1"),
+		couchbase.WithAdminCredentials("testcontainers", "testcontainers.IS.cool!"),
+		couchbase.WithBuckets(bucket),
+	)
+	if err != nil {
+		panic(err)
+	}
+	defer func() {
+		if err := couchbaseContainer.Terminate(ctx); err != nil {
+			panic(err)
+		}
+	}()
+	// }
+
+	state, err := couchbaseContainer.State(ctx)
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(state.Running)
+
+	connectionString, err := couchbaseContainer.ConnectionString(ctx)
+	if err != nil {
+		panic(err)
+	}
+
+	cluster, err := gocb.Connect(connectionString, gocb.ClusterOptions{
+		Username: couchbaseContainer.Username(),
+		Password: couchbaseContainer.Password(),
+	})
+	if err != nil {
+		panic(err)
+	}
+
+	buckets, err := cluster.Buckets().GetAllBuckets(nil)
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(len(buckets))
+	fmt.Println(buckets[bucketName].Name)
+
+	// Output:
+	// true
+	// 1
+	// testBucket
+}