gcloud WIP

cristianrgreco · cristianrgreco · commit c3900f8aaaf9 · 2025-07-25T14:26:08.000+01:00
diff --git a/docs/modules/arangodb.md b/docs/modules/arangodb.md
@@ -14,9 +14,7 @@ This example uses the following libraries:
 
         npm install arangojs
 
----
-
-Choose an image from [Docker Hub](https://hub.docker.com/_/arangodb) and substitute `IMAGE`.
+Choose an image from the [container registry](https://hub.docker.com/_/arangodb) and substitute `IMAGE`.
 
 ### Execute a query
 
diff --git a/docs/modules/azurite.md b/docs/modules/azurite.md
@@ -22,9 +22,7 @@ These examples use the following libraries:
 
         npm install @azure/storage-queue
 
----
-
-Choose an image from [Docker Hub](https://hub.docker.com/r/microsoft/azure-storage-azurite) and substitute `IMAGE`.
+Choose an image from the [container registry](https://hub.docker.com/r/microsoft/azure-storage-azurite) and substitute `IMAGE`.
 
 ### Upload/download a blob
 
diff --git a/docs/modules/cassandra.md b/docs/modules/cassandra.md
@@ -14,9 +14,7 @@ These examples use the following libraries:
 
         npm install cassandra-driver
 
----
-
-Choose an image from [Docker Hub](https://hub.docker.com/_/cassandra) and substitute `IMAGE`.
+Choose an image from the [container registry](https://hub.docker.com/_/cassandra) and substitute `IMAGE`.
  
 ### Execute a query
 
diff --git a/docs/modules/chromadb.md b/docs/modules/chromadb.md
@@ -18,9 +18,7 @@ These examples use the following libraries:
 
         npm install ollama
 
----
-
-Choose an image from [Docker Hub](https://hub.docker.com/r/chromadb/chroma) and substitute `IMAGE`.
+Choose an image from the [container registry](https://hub.docker.com/r/chromadb/chroma) and substitute `IMAGE`.
 
 ### Execute a query
 
diff --git a/docs/modules/clickhouse.md b/docs/modules/clickhouse.md
@@ -14,9 +14,7 @@ These examples use the following libraries:
 
         npm install @clickhouse/client
 
----
-
-Choose an image from [Docker Hub](https://hub.docker.com/r/clickhouse/clickhouse-server) and substitute `IMAGE`.
+Choose an image from the [container registry](https://hub.docker.com/r/clickhouse/clickhouse-server) and substitute `IMAGE`.
 
 ### Execute a query
 
diff --git a/docs/modules/cockroachdb.md b/docs/modules/cockroachdb.md
@@ -18,9 +18,7 @@ These examples use the following libraries:
 
         npm install @types/pg
 
----
-
-Choose an image from [Docker Hub](https://hub.docker.com/r/cockroachdb/cockroach) and substitute `IMAGE`.
+Choose an image from the [container registry](https://hub.docker.com/r/cockroachdb/cockroach) and substitute `IMAGE`.
 
 ### Execute a query
  
diff --git a/docs/modules/cosmosdb.md b/docs/modules/cosmosdb.md
@@ -23,8 +23,6 @@ These examples use the following libraries:
 
         npm install @azure/cosmos
 
----
-
 Choose an image from [Microsoft Artifact Registry](https://mcr.microsoft.com/) and substitute `IMAGE`. For example, `mcr.microsoft.com/cosmosdb/linux/azure-cosmos-emulator:vnext-preview`.
 
 ### Execute a query
diff --git a/docs/modules/couchbase.md b/docs/modules/couchbase.md
@@ -14,9 +14,7 @@ These examples use the following libraries:
 
         npm install couchbase
 
----
-
-Choose an image from [Docker Hub](https://hub.docker.com/r/couchbase/server) and substitute `IMAGE`.
+Choose an image from the [container registry](https://hub.docker.com/r/couchbase/server) and substitute `IMAGE`.
 
 ### Execute a query
 
diff --git a/docs/modules/elasticsearch.md b/docs/modules/elasticsearch.md
@@ -14,9 +14,7 @@ These examples use the following libraries:
 
         npm install @elastic/elasticsearch
 
----
-
-Choose an image from [Docker Hub](https://hub.docker.com/_/elasticsearch) and substitute `IMAGE`.
+Choose an image from the [container registry](https://hub.docker.com/_/elasticsearch) and substitute `IMAGE`.
 
 ### Create an index
 
diff --git a/docs/modules/etcd.md b/docs/modules/etcd.md
@@ -14,9 +14,7 @@ These examples use the following libraries:
 
         npm install etcd3
 
----
-
-Choose an image from [Docker Hub](https://quay.io/repository/coreos/etcd?tab=info) and substitute `IMAGE`.
+Choose an image from the [container registry](https://quay.io/repository/coreos/etcd?tab=info) and substitute `IMAGE`.
 
 ### Read and write key-value pairs
 
diff --git a/docs/modules/gcloud.md b/docs/modules/gcloud.md
@@ -1,80 +1,131 @@
-# GCloud Module
-
-Testcontainers module for the Google Cloud Platform's [Cloud SDK](https://cloud.google.com/sdk/).
+# GCloud
 
 ## Install
 
 ```bash
 npm install @testcontainers/gcloud --save-dev
 ```
 
-The module supports multiple emulators. Use the following classes:
+## Examples
 
-Emulator | Class | Container Image
--|-|-
-Firestore (Native mode) | FirestoreEmulatorContainer | [gcr.io/google.com/cloudsdktool/google-cloud-cli:emulators](https://gcr.io/google.com/cloudsdktool/google-cloud-cli)
-Firestore (Datastore mode) | DatastoreEmulatorContainer | [gcr.io/google.com/cloudsdktool/google-cloud-cli:emulators](https://gcr.io/google.com/cloudsdktool/google-cloud-cli)
-Cloud PubSub | PubSubEmulatorContainer | [gcr.io/google.com/cloudsdktool/google-cloud-cli:emulators](https://gcr.io/google.com/cloudsdktool/google-cloud-cli)
-Cloud Storage | CloudStorageEmulatorContainer | [fsouza/fake-gcs-server:1.52.2](https://hub.docker.com/r/fsouza/fake-gcs-server)
-BigQuery | BigQueryEmulatorContainer | [ghcr.io/goccy/bigquery-emulator:0.6.6](https://ghcr.io/goccy/bigquery-emulator)
-Cloud Spanner | SpannerEmulatorContainer | [gcr.io/cloud-spanner-emulator/emulator:1.5.37](https://gcr.io/cloud-spanner-emulator/emulator:1.5.37)
+### Firestore
 
-## Examples
+These examples use the following libraries:
 
-### Firestore (Native mode)
+- [@google-cloud/firestore](https://www.npmjs.com/package/@google-cloud/firestore)
 
-<!--codeinclude-->
-[Starting a Firestore Emulator container with the default image](../../packages/modules/gcloud/src/firestore-emulator-container.test.ts) inside_block:firestore4
-<!--/codeinclude-->
+        npm install @google-cloud/firestore
+
+Choose an image from the [container registry](https://gcr.io/google.com/cloudsdktool/google-cloud-cli) and substitute `IMAGE`.
 
 <!--codeinclude-->
-[Starting a Firestore Emulator container with a custom emulator image](../../packages/modules/gcloud/src/firestore-emulator-container.test.ts) inside_block:firestore5
+[](../../packages/modules/gcloud/src/firestore-emulator-container.test.ts) inside_block:firestoreExample 
 <!--/codeinclude-->
 
-### Firestore (Datastore mode)
+---
+ 
+### Datastore
+
+These examples use the following libraries:
+
+- [@google-cloud/datastore](https://www.npmjs.com/package/@google-cloud/datastore)
+
+        npm install @google-cloud/datastore
+
+Choose an image from the [container registry](https://gcr.io/google.com/cloudsdktool/google-cloud-cli) and substitute `IMAGE`.
+
+#### With default image
 
 <!--codeinclude-->
-[Starting a Datastore Emulator container with the default image](../../packages/modules/gcloud/src/datastore-emulator-container.test.ts) inside_block:datastore4
+[](../../packages/modules/gcloud/src/datastore-emulator-container.test.ts) inside_block:datastore4
 <!--/codeinclude-->
 
+#### With custom image
+
 <!--codeinclude-->
-[Starting a Datastore Emulator container with a custom emulator image](../../packages/modules/gcloud/src/datastore-emulator-container.test.ts) inside_block:datastore5
+[](../../packages/modules/gcloud/src/datastore-emulator-container.test.ts) inside_block:datastore5
 <!--/codeinclude-->
 
+---
+
 ### Cloud PubSub
 
+These examples use the following libraries:
+
+- [@google-cloud/pubsub](https://www.npmjs.com/package/@google-cloud/pubsub)
+
+        npm install @google-cloud/pubsub
+
+Choose an image from the [container registry](https://gcr.io/google.com/cloudsdktool/google-cloud-cli) and substitute `IMAGE`.
+
+#### With default image
+
 <!--codeinclude-->
-[Starting a Cloud PubSub Emulator container with the default image](../../packages/modules/gcloud/src/pubsub-emulator-container.test.ts)
+[](../../packages/modules/gcloud/src/pubsub-emulator-container.test.ts)
 <!--/codeinclude-->
 
+---
+
 ### Cloud Storage
 
-The Cloud Storage container uses a fake Cloud Storage server by [Francisco Souza](https://github.com/fsouza).
+These examples use the following libraries:
 
-<!--codeinclude-->
-[Starting a Cloud Storage Emulator container with the default image](../../packages/modules/gcloud/src/cloudstorage-emulator-container.test.ts) inside_block:cloud-storage
-<!--/codeinclude-->
+- [@google-cloud/storage](https://www.npmjs.com/package/@google-cloud/storage)
 
-### BigQuery
+        npm install @google-cloud/storage
+
+Choose an image from the [container registry](https://hub.docker.com/r/fsouza/fake-gcs-server) and substitute `IMAGE`.
 
-The BigQuery emulator is by [Masaaki Goshima](https://github.com/goccy) and uses [go-zetasqlite](https://github.com/goccy/go-zetasqlite).
+#### With default image
 
 <!--codeinclude-->
-[Starting a BigQuery Emulator container with the default image](../../packages/modules/gcloud/src/bigquery-emulator-container.test.ts)
+[](../../packages/modules/gcloud/src/cloudstorage-emulator-container.test.ts) inside_block:cloud-storage
 <!--/codeinclude-->
 
+---
+
 ### Cloud Spanner
 
-The Cloud Spanner emulator container wraps Google's official emulator image.
+These examples use the following libraries:
+
+- [@google-cloud/datastore](https://www.npmjs.com/package/@google-cloud/datastore)
+
+        npm install @google-cloud/datastore
+
+Choose an image from the [container registry](https://gcr.io/cloud-spanner-emulator/emulator:1.5.37) and substitute `IMAGE`.
+
+#### Default
+
+<!--codeinclude-->
+[](../../packages/modules/gcloud/src/spanner-emulator-container.test.ts) inside_block:startupWithExplicitClient
+<!--/codeinclude-->
+
+#### With environment variable
 
 <!--codeinclude-->
-[Starting a Spanner Emulator container and exposing endpoints using explicitly configured client](../../packages/modules/gcloud/src/spanner-emulator-container.test.ts) inside_block:startupWithExplicitClient
+[](../../packages/modules/gcloud/src/spanner-emulator-container.test.ts) inside_block:startupWithEnvironmentVariable
 <!--/codeinclude-->
 
+#### Helper
+
 <!--codeinclude-->
-[Starting a Spanner Emulator container and exposing endpoints using projectId and SPANNER_EMULATOR_HOST](../../packages/modules/gcloud/src/spanner-emulator-container.test.ts) inside_block:startupWithEnvironmentVariable
+[](../../packages/modules/gcloud/src/spanner-emulator-helper.test.ts) inside_block:createAndDelete
 <!--/codeinclude-->
 
+---
+
+### BigQuery
+
+These examples use the following libraries:
+
+- [@google-cloud/bigquery](https://www.npmjs.com/package/@google-cloud/bigquery)
+
+        npm install @google-cloud/bigquery
+
+Choose an image from the [container registry](https://ghcr.io/goccy/bigquery-emulator) and substitute `IMAGE`.
+
+#### With default image
+
 <!--codeinclude-->
-[Creating and deleting instance and database via helper](../../packages/modules/gcloud/src/spanner-emulator-helper.test.ts) inside_block:createAndDelete
+[](../../packages/modules/gcloud/src/bigquery-emulator-container.test.ts)
 <!--/codeinclude-->
diff --git a/packages/modules/gcloud/src/bigquery-emulator-container.test.ts b/packages/modules/gcloud/src/bigquery-emulator-container.test.ts
@@ -15,7 +15,9 @@ describe("BigQueryEmulatorContainer", { timeout: 240_000 }, () => {
     expect(bigQueryEmulatorContainer).toBeDefined();
     const testDataset = "test-dataset";
     const testTable = "test-table";
-    const testSchema: TableSchema = { fields: [{ name: "message", type: "STRING" }] };
+    const testSchema: TableSchema = {
+      fields: [{ name: "message", type: "STRING" }],
+    };
     const config = {
       projectId: bigQueryEmulatorContainer.getProjectId(),
       apiEndpoint: bigQueryEmulatorContainer.getEmulatorEndpoint(),
diff --git a/packages/modules/gcloud/src/datastore-emulator-container.test.ts b/packages/modules/gcloud/src/datastore-emulator-container.test.ts
@@ -29,14 +29,20 @@ describe("DatastoreEmulatorContainer", { timeout: 240_000 }, () => {
     const testProjectId = "test-project";
     const testKind = "test-kind";
     const testId = "123";
-    const databaseConfig = { projectId: testProjectId, apiEndpoint: datastoreEmulatorContainer.getEmulatorEndpoint() };
+    const databaseConfig = {
+      projectId: testProjectId,
+      apiEndpoint: datastoreEmulatorContainer.getEmulatorEndpoint(),
+    };
     const datastore = new Datastore(databaseConfig);
 
     const key = datastore.key([testKind, testId]);
     const data = { message: "Hello, Datastore!" };
     await datastore.save({ key, data });
     const [entity] = await datastore.get(key);
 
-    expect(entity).toEqual({ message: "Hello, Datastore!", [Datastore.KEY]: key });
+    expect(entity).toEqual({
+      message: "Hello, Datastore!",
+      [Datastore.KEY]: key,
+    });
   }
 });
diff --git a/packages/modules/gcloud/src/firestore-emulator-container.test.ts b/packages/modules/gcloud/src/firestore-emulator-container.test.ts
@@ -1,46 +1,33 @@
 import admin from "firebase-admin";
 import { randomUuid } from "testcontainers";
 import { getImage } from "../../../testcontainers/src/utils/test-helper";
-import { FirestoreEmulatorContainer, StartedFirestoreEmulatorContainer } from "./firestore-emulator-container";
+import { FirestoreEmulatorContainer } from "./firestore-emulator-container";
 
 const IMAGE = getImage(__dirname);
 
 describe("FirestoreEmulatorContainer", { timeout: 240_000 }, () => {
-  // firestore4 {
-  it("should work using default version", async () => {
-    await using firestoreEmulatorContainer = await new FirestoreEmulatorContainer(IMAGE).start();
-
-    await checkFirestore(firestoreEmulatorContainer);
-  });
-  // }
-
-  // firestore5 {
-  it("should work using version 468.0.0", async () => {
-    await using firestoreEmulatorContainer = await new FirestoreEmulatorContainer(
-      "gcr.io/google.com/cloudsdktool/google-cloud-cli:468.0.0-emulators"
-    ).start();
-
-    await checkFirestore(firestoreEmulatorContainer);
-  });
-
-  // }
-
-  async function checkFirestore(firestoreEmulatorContainer: StartedFirestoreEmulatorContainer) {
-    expect(firestoreEmulatorContainer).toBeDefined();
-    const testProjectId = "test-project";
-    const testAppName = `test-app-${randomUuid()}`;
-    const testCollection = "test-collection";
-    const testDocument = "test-doc";
-    const firebaseConfig = { projectId: testProjectId };
-    const firestore = admin.initializeApp(firebaseConfig, testAppName).firestore();
-    firestore.settings({ host: firestoreEmulatorContainer.getEmulatorEndpoint(), ssl: false });
-
-    const docRef = firestore.collection(testCollection).doc(testDocument);
-    await docRef.set({ message: "Hello, Firestore!" });
-
-    const snapshot = await docRef.get();
-
-    expect(snapshot.exists).toBeTruthy();
-    expect(snapshot.data()).toEqual({ message: "Hello, Firestore!" });
-  }
+  it.each([IMAGE, "gcr.io/google.com/cloudsdktool/google-cloud-cli:468.0.0-emulators"])(
+    "should work with %s",
+    async (image) => {
+      // firestoreExample {
+      const collection = "test-collection";
+      const document = "test-doc";
+
+      await using firestoreEmulatorContainer = await new FirestoreEmulatorContainer(image).start();
+
+      const firestore = admin.initializeApp({ projectId: "test-project" }, `test-app-${randomUuid()}`).firestore();
+
+      firestore.settings({
+        host: firestoreEmulatorContainer.getEmulatorEndpoint(),
+        ssl: false,
+      });
+
+      const docRef = firestore.collection(collection).doc(document);
+      await docRef.set({ message: "Hello, Firestore!" });
+      const snapshot = await docRef.get();
+
+      expect(snapshot.data()).toEqual({ message: "Hello, Firestore!" });
+      // }
+    }
+  );
 });
