feat(gloud) add ability to set cmd flags

Author: digital88

packages/modules/gcloud/src/datastore-emulator-container.test.ts

@@ -25,6 +25,14 @@ describe("DatastoreEmulatorContainer", { timeout: 240_000 }, () => {
 
   // }
 
+  it("should have default host-port flag and database-mode flag", async (ctx) => {
+    const datastoreEmulatorContainer = new DatastoreEmulatorContainer();
+
+    const flags = datastoreEmulatorContainer.expandFlags();
+
+    expect(flags.trim()).toEqual("--host-port=0.0.0.0:8080 --database-mode=datastore-mode");
+  });
+
   async function checkDatastore(datastoreEmulatorContainer: StartedDatastoreEmulatorContainer) {
     expect(datastoreEmulatorContainer).toBeDefined();
     const testProjectId = "test-project";

packages/modules/gcloud/src/datastore-emulator-container.ts

@@ -1,14 +1,17 @@
-import { AbstractStartedContainer, GenericContainer, StartedTestContainer, Wait } from "testcontainers";
+import { AbstractStartedContainer, StartedTestContainer, Wait } from "testcontainers";
+import { GenericGCloudEmulatorContainer } from "./generic-emulator-container";
 
 const EMULATOR_PORT = 8080;
-const CMD = `gcloud beta emulators firestore start --host-port 0.0.0.0:${EMULATOR_PORT} --database-mode=datastore-mode`;
+const CMD = `gcloud beta emulators firestore start`;
 const DEFAULT_IMAGE = "gcr.io/google.com/cloudsdktool/cloud-sdk";
 
-export class DatastoreEmulatorContainer extends GenericContainer {
+export class DatastoreEmulatorContainer extends GenericGCloudEmulatorContainer {
   constructor(image = DEFAULT_IMAGE) {
     super(image);
     this.withExposedPorts(EMULATOR_PORT)
-      .withCommand(["/bin/sh", "-c", CMD])
+      .withFlag("host-port", `0.0.0.0:${EMULATOR_PORT}`)
+      .withFlag("database-mode", `datastore-mode`)
+      .withCommand(["/bin/sh", "-c", `${CMD} ${this.expandFlags()}`])
       .withWaitStrategy(Wait.forLogMessage(RegExp(".*running.*"), 1))
       .withStartupTimeout(120_000);
   }

packages/modules/gcloud/src/firestore-emulator-container.test.ts

@@ -2,7 +2,8 @@ import * as admin from "firebase-admin";
 import { FirestoreEmulatorContainer, StartedFirestoreEmulatorContainer } from "./firestore-emulator-container";
 
 describe("FirestoreEmulatorContainer", { timeout: 240_000 }, () => {
-  afterEach(async () => {
+  afterEach(async (ctx) => {
+    if (ctx.task.name === "should have default host-port flag") return;
     await admin.app().delete();
   });
 
@@ -29,6 +30,14 @@ describe("FirestoreEmulatorContainer", { timeout: 240_000 }, () => {
 
   // }
 
+  it("should have default host-port flag", async (ctx) => {
+    const firestoreEmulatorContainer = new FirestoreEmulatorContainer();
+
+    const flags = firestoreEmulatorContainer.expandFlags();
+
+    expect(flags.trim()).toEqual("--host-port=0.0.0.0:8080");
+  });
+
   async function checkFirestore(firestoreEmulatorContainer: StartedFirestoreEmulatorContainer) {
     expect(firestoreEmulatorContainer).toBeDefined();
     const testProjectId = "test-project";

packages/modules/gcloud/src/firestore-emulator-container.ts

@@ -1,14 +1,16 @@
-import { AbstractStartedContainer, GenericContainer, StartedTestContainer, Wait } from "testcontainers";
+import { AbstractStartedContainer, StartedTestContainer, Wait } from "testcontainers";
+import { GenericGCloudEmulatorContainer } from "./generic-emulator-container";
 
 const EMULATOR_PORT = 8080;
-const CMD = `gcloud beta emulators firestore start --host-port 0.0.0.0:${EMULATOR_PORT}`;
+const CMD = `gcloud beta emulators firestore start`;
 const DEFAULT_IMAGE = "gcr.io/google.com/cloudsdktool/cloud-sdk";
 
-export class FirestoreEmulatorContainer extends GenericContainer {
+export class FirestoreEmulatorContainer extends GenericGCloudEmulatorContainer {
   constructor(image = DEFAULT_IMAGE) {
     super(image);
     this.withExposedPorts(EMULATOR_PORT)
-      .withCommand(["/bin/sh", "-c", CMD])
+      .withFlag("host-port", `0.0.0.0:${EMULATOR_PORT}`)
+      .withCommand(["/bin/sh", "-c", `${CMD} ${this.expandFlags()}`])
       .withWaitStrategy(Wait.forLogMessage(RegExp(".*running.*"), 1))
       .withStartupTimeout(120_000);
   }

packages/modules/gcloud/src/generic-emulator-container.test.ts

@@ -0,0 +1,26 @@
+
+import { GenericGCloudEmulatorContainer } from "./generic-emulator-container";
+
+const IMAGE = "gcr.io/google.com/cloudsdktool/cloud-sdk"
+
+describe("GenericGCloudEmulatorContainer", { timeout: 240_000 }, () => {
+    it("should have all flags added", async () => {
+        const genericGCloudEmulatorContainer = new GenericGCloudEmulatorContainer(IMAGE)
+            .withFlag("database-mode", "firestore-native");
+
+        const flags = genericGCloudEmulatorContainer.expandFlags();
+
+        expect(flags.trim()).toEqual("--database-mode=firestore-native");
+    });
+
+    it("should overwrite flag if added more than once", async () => {
+        const genericGCloudEmulatorContainer = new GenericGCloudEmulatorContainer(IMAGE)
+            .withFlag("database-mode", "firestore-native")
+            .withFlag("database-mode", "datastore-mode")
+            .withFlag("database-mode", "datastore-mode");
+
+        const flags = genericGCloudEmulatorContainer.expandFlags();
+
+        expect(flags.trim()).toEqual("--database-mode=datastore-mode");
+    });
+});

packages/modules/gcloud/src/generic-emulator-container.ts

@@ -0,0 +1,39 @@
+import { GenericContainer } from "testcontainers";
+
+export class GenericGCloudEmulatorContainer extends GenericContainer {
+    private flags: { name: string, value: string }[] = []
+
+    constructor(image: string) {
+        super(image);
+    }
+
+    /**
+     * Adds flag name and value as argument to emulator start command.
+     * Adding same flag name twice replaces existing flag value.
+     * Provided flag name may optionally contain -- prefix.
+     */
+    public withFlag(name: string, value: string): this {
+        if (!name) throw new Error("Flag name must be set.")
+        // replace flag if it already exists
+        const idx = this.flags.findIndex(f => f.name == this.trimFlagName(name))
+        if (idx >= 0)
+            this.flags = [...this.flags.slice(0, idx), ...this.flags.slice(idx + 1)]
+        this.flags.push({ name, value });
+        return this
+    }
+
+    private trimFlagName(name: string): string {
+        return name?.startsWith('--') ? name.slice(2) : name
+    }
+
+    private flagToString(f: { name: string, value: string }): string {
+        return `--${this.trimFlagName(f.name)}=${f.value}`
+    }
+
+    /**
+     * @return all flags provided to run this emulator instance, concatenated to string.
+     */
+    public expandFlags(): string {
+        return `${this.flags.reduce((p, c) => p + ' ' + this.flagToString(c), '')}`
+    }
+}

packages/modules/gcloud/src/pubsub-emulator-container.test.ts

@@ -10,6 +10,14 @@ describe("PubSubEmulatorContainer", { timeout: 240_000 }, () => {
     await pubsubEmulatorContainer.stop();
   });
 
+  it("should have default host-port flag", async () => {
+    const pubsubEmulatorContainer = new PubSubEmulatorContainer();
+
+    const flags = pubsubEmulatorContainer.expandFlags();
+
+    expect(flags.trim()).toEqual("--host-port=0.0.0.0:8085");
+  });
+
   async function checkPubSub(pubsubEmulatorContainer: StartedPubSubEmulatorContainer) {
     expect(pubsubEmulatorContainer).toBeDefined();
 

packages/modules/gcloud/src/pubsub-emulator-container.ts

@@ -1,31 +1,34 @@
 import type { StartedTestContainer } from "testcontainers";
-import { AbstractStartedContainer, GenericContainer, Wait } from "testcontainers";
+import { AbstractStartedContainer, Wait } from "testcontainers";
+import { GenericGCloudEmulatorContainer } from "./generic-emulator-container";
 
 const EMULATOR_PORT = 8085;
-const CMD = "gcloud beta emulators pubsub start --host-port 0.0.0.0:8085";
+const CMD = "gcloud beta emulators pubsub start";
 const DEFAULT_IMAGE = "gcr.io/google.com/cloudsdktool/google-cloud-cli";
 
-export class PubSubEmulatorContainer extends GenericContainer {
+export class PubSubEmulatorContainer extends GenericGCloudEmulatorContainer {
   private _projectId?: string;
 
   constructor(image = DEFAULT_IMAGE) {
     super(image);
 
     this.withExposedPorts(EMULATOR_PORT)
+      .withFlag("host-port", `0.0.0.0:${EMULATOR_PORT}`)
       .withWaitStrategy(Wait.forLogMessage(/Server started/g, 1))
       .withStartupTimeout(120_000);
   }
 
-  public withProjectId(projectId: string): PubSubEmulatorContainer {
+  public withProjectId(projectId: string): this {
     this._projectId = projectId;
     return this;
   }
 
   public override async start(): Promise<StartedPubSubEmulatorContainer> {
     // Determine the valid command-line prompt when starting the Pub/Sub emulator
     const selectedProjectId = this._projectId ?? "test-project";
-    const commandLine = `${CMD} --project=${selectedProjectId}`;
-    this.withCommand(["/bin/sh", "-c", commandLine]);
+    this
+      .withFlag("project", selectedProjectId)
+      .withCommand(["/bin/sh", "-c", `${CMD} ${this.expandFlags()}`]);
 
     return new StartedPubSubEmulatorContainer(await super.start(), selectedProjectId);
   }