feat: adds Pinecone module

.github/workflows/ci.yml

@@ -94,7 +94,7 @@ jobs:
       matrix:
         go-version: [1.22.x, 1.x]
         platform: [ubuntu-latest]
-        module: [artemis, azurite, cassandra, chroma, clickhouse, cockroachdb, compose, consul, couchbase, databend, dolt, dynamodb, elasticsearch, etcd, gcloud, grafana-lgtm, inbucket, influxdb, k3s, k6, kafka, localstack, mariadb, meilisearch, milvus, minio, mockserver, mongodb, mssql, mysql, nats, neo4j, ollama, openfga, openldap, opensearch, postgres, pulsar, qdrant, rabbitmq, redis, redpanda, registry, surrealdb, valkey, vault, vearch, weaviate, yugabytedb]
+        module: [artemis, azurite, cassandra, chroma, clickhouse, cockroachdb, compose, consul, couchbase, databend, dolt, dynamodb, elasticsearch, etcd, gcloud, grafana-lgtm, inbucket, influxdb, k3s, k6, kafka, localstack, mariadb, meilisearch, milvus, minio, mockserver, mongodb, mssql, mysql, nats, neo4j, ollama, openfga, openldap, opensearch, pinecone, postgres, pulsar, qdrant, rabbitmq, redis, redpanda, registry, surrealdb, valkey, vault, vearch, weaviate, yugabytedb]
     uses: ./.github/workflows/ci-test-go.yml
     with:
       go-version: ${{ matrix.go-version }}

.vscode/.testcontainers-go.code-workspace

@@ -157,6 +157,10 @@
             "name": "module / opensearch",
             "path": "../modules/opensearch"
         },
+        {
+            "name": "module / pinecone",
+            "path": "../modules/pinecone"
+        },
         {
             "name": "module / postgres",
             "path": "../modules/postgres"

docs/modules/pinecone.md

@@ -0,0 +1,66 @@
+# Pinecone
+
+Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
+
+## Introduction
+
+The Testcontainers module for Pinecone.
+
+## Adding this module to your project dependencies
+
+Please run the following command to add the Pinecone module to your Go dependencies:
+
+```
+go get github.com/testcontainers/testcontainers-go/modules/pinecone
+```
+
+## Usage example
+
+<!--codeinclude-->
+[Creating a Pinecone container](../../modules/pinecone/examples_test.go) inside_block:ExampleRun
+<!--/codeinclude-->
+
+## Module Reference
+
+### Run function
+
+- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
+
+!!!info
+    The `RunContainer(ctx, opts...)` function is deprecated and will be removed in the next major release of _Testcontainers for Go_.
+
+The Pinecone module exposes one entrypoint function to create the Pinecone container, and this function receives three parameters:
+
+```golang
+func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*PineconeContainer, error)
+```
+
+- `context.Context`, the Go context.
+- `string`, the Docker image to use.
+- `testcontainers.ContainerCustomizer`, a variadic argument for passing options.
+
+### Container Options
+
+When starting the Pinecone container, you can pass options in a variadic way to configure it.
+
+#### Image
+
+If you need to set a different Pinecone Docker image, you can set a valid Docker image as the second argument in the `Run` function.
+E.g. `Run(context.Background(), "ghcr.io/pinecone-io/pinecone-local:latest")`.
+
+{% include "../features/common_functional_options.md" %}
+
+### Container Methods
+
+The Pinecone container exposes the following methods:
+
+#### HttpEndpoint
+
+- Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>
+
+The `HttpEndpoint` method returns the location where the Pinecone container is listening.
+It returns a string with the format `http://<host>:<port>`.
+
+<!--codeinclude-->
+[Connecting using HTTP](../../modules/pinecone/examples_test.go) inside_block:httpConnection
+<!--/codeinclude-->

mkdocs.yml

@@ -103,6 +103,7 @@ nav:
         - modules/openfga.md
         - modules/openldap.md
         - modules/opensearch.md
+        - modules/pinecone.md
         - modules/postgres.md
         - modules/pulsar.md
         - modules/qdrant.md

modules/pinecone/Makefile

@@ -0,0 +1,5 @@
+include ../../commons-test.mk
+
+.PHONY: test
+test:
+	$(MAKE) test-pinecone

modules/pinecone/examples_test.go

@@ -0,0 +1,74 @@
+package pinecone_test
+
+import (
+	"context"
+	"fmt"
+	"log"
+
+	"github.com/pinecone-io/go-pinecone/v2/pinecone"
+
+	"github.com/testcontainers/testcontainers-go"
+	tcpinecone "github.com/testcontainers/testcontainers-go/modules/pinecone"
+)
+
+func ExampleRun() {
+	ctx := context.Background()
+
+	pineconeContainer, err := tcpinecone.Run(ctx, "ghcr.io/pinecone-io/pinecone-local:v0.7.0")
+	defer func() {
+		if err := testcontainers.TerminateContainer(pineconeContainer); err != nil {
+			log.Printf("failed to terminate container: %s", err)
+		}
+	}()
+	if err != nil {
+		log.Printf("failed to start container: %s", err)
+		return
+	}
+	// }
+
+	state, err := pineconeContainer.State(ctx)
+	if err != nil {
+		log.Printf("failed to get container state: %s", err)
+		return
+	}
+
+	fmt.Println(state.Running)
+
+	// httpConnection {
+	host, err := pineconeContainer.HttpEndpoint()
+	if err != nil {
+		log.Printf("failed to get container state: %s", err)
+		return
+	}
+	// }
+
+	pc, err := pinecone.NewClient(pinecone.NewClientParams{
+		ApiKey: "testcontainers-go", // API key is required, else use headers
+		Host:   host,
+	})
+	if err != nil {
+		log.Printf("failed to create pinecone client: %s", err)
+		return
+	}
+
+	indexName := "my-serverless-index"
+
+	idx, err := pc.CreateServerlessIndex(ctx, &pinecone.CreateServerlessIndexRequest{
+		Name:      indexName,
+		Dimension: 3,
+		Metric:    pinecone.Cosine,
+		Cloud:     pinecone.Aws,
+		Region:    "us-east-1",
+		Tags:      &pinecone.IndexTags{"environment": "development"},
+	})
+	if err != nil {
+		log.Printf("failed to create serverless index: %s", err)
+		return
+	}
+
+	fmt.Println(idx.Name)
+
+	// Output:
+	// true
+	// my-serverless-index
+}

modules/pinecone/go.mod

@@ -0,0 +1,69 @@
+module github.com/testcontainers/testcontainers-go/modules/pinecone
+
+go 1.22
+
+require (
+	github.com/pinecone-io/go-pinecone/v2 v2.2.0
+	github.com/stretchr/testify v1.9.0
+	github.com/testcontainers/testcontainers-go v0.35.0
+)
+
+require (
+	dario.cat/mergo v1.0.0 // indirect
+	github.com/Azure/go-ansiterm v0.0.0-20210617225240-d185dfc1b5a1 // indirect
+	github.com/Microsoft/go-winio v0.6.2 // indirect
+	github.com/apapsch/go-jsonmerge/v2 v2.0.0 // indirect
+	github.com/cenkalti/backoff/v4 v4.2.1 // indirect
+	github.com/containerd/containerd v1.7.18 // indirect
+	github.com/containerd/log v0.1.0 // indirect
+	github.com/containerd/platforms v0.2.1 // indirect
+	github.com/cpuguy83/dockercfg v0.3.2 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/distribution/reference v0.6.0 // indirect
+	github.com/docker/docker v27.1.1+incompatible // indirect
+	github.com/docker/go-connections v0.5.0 // indirect
+	github.com/docker/go-units v0.5.0 // indirect
+	github.com/felixge/httpsnoop v1.0.4 // indirect
+	github.com/go-logr/logr v1.4.1 // indirect
+	github.com/go-logr/stdr v1.2.2 // indirect
+	github.com/go-ole/go-ole v1.2.6 // indirect
+	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/google/uuid v1.6.0 // indirect
+	github.com/klauspost/compress v1.17.4 // indirect
+	github.com/kr/text v0.2.0 // indirect
+	github.com/lufia/plan9stats v0.0.0-20211012122336-39d0f177ccd0 // indirect
+	github.com/magiconair/properties v1.8.7 // indirect
+	github.com/moby/docker-image-spec v1.3.1 // indirect
+	github.com/moby/patternmatcher v0.6.0 // indirect
+	github.com/moby/sys/sequential v0.5.0 // indirect
+	github.com/moby/sys/user v0.1.0 // indirect
+	github.com/moby/term v0.5.0 // indirect
+	github.com/morikuni/aec v1.0.0 // indirect
+	github.com/oapi-codegen/runtime v1.1.1 // indirect
+	github.com/opencontainers/go-digest v1.0.0 // indirect
+	github.com/opencontainers/image-spec v1.1.0 // indirect
+	github.com/pkg/errors v0.9.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/power-devops/perfstat v0.0.0-20210106213030-5aafc221ea8c // indirect
+	github.com/shirou/gopsutil/v3 v3.23.12 // indirect
+	github.com/shoenig/go-m1cpu v0.1.6 // indirect
+	github.com/sirupsen/logrus v1.9.3 // indirect
+	github.com/tklauser/go-sysconf v0.3.12 // indirect
+	github.com/tklauser/numcpus v0.6.1 // indirect
+	github.com/yusufpapurcu/wmi v1.2.3 // indirect
+	go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.49.0 // indirect
+	go.opentelemetry.io/otel v1.24.0 // indirect
+	go.opentelemetry.io/otel/metric v1.24.0 // indirect
+	go.opentelemetry.io/otel/trace v1.24.0 // indirect
+	golang.org/x/crypto v0.31.0 // indirect
+	golang.org/x/net v0.25.0 // indirect
+	golang.org/x/sys v0.28.0 // indirect
+	golang.org/x/text v0.21.0 // indirect
+	google.golang.org/genproto/googleapis/api v0.0.0-20240528184218-531527333157 // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20240528184218-531527333157 // indirect
+	google.golang.org/grpc v1.65.0 // indirect
+	google.golang.org/protobuf v1.34.1 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)
+
+replace github.com/testcontainers/testcontainers-go => ../..