feat: added firebase 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, firebase, 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]
     uses: ./.github/workflows/ci-test-go.yml
     with:
       go-version: ${{ matrix.go-version }}

.vscode/.testcontainers-go.code-workspace

@@ -69,6 +69,10 @@
             "name": "module / etcd",
             "path": "../modules/etcd"
         },
+        {
+            "name": "module / firebase",
+            "path": "../modules/firebase"
+        },
         {
             "name": "module / gcloud",
             "path": "../modules/gcloud"
@@ -214,4 +218,4 @@
             "path": "../modulegen"
         }
     ]
-}
+}

docs/modules/firebase.md

@@ -0,0 +1,55 @@
+# Firebase
+
+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 Firebase.
+
+## Adding this module to your project dependencies
+
+Please run the following command to add the Firebase module to your Go dependencies:
+
+```
+go get github.com/testcontainers/testcontainers-go/modules/firebase
+```
+
+## Usage example
+
+<!--codeinclude-->
+[Creating a Firebase container](../../modules/firebase/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 Firebase module exposes one entrypoint function to create the Firebase container, and this function receives three parameters:
+
+```golang
+func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*FirebaseContainer, 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 Firebase container, you can pass options in a variadic way to configure it.
+
+#### Image
+
+If you need to set a different Firebase Docker image, you can set a valid Docker image as the second argument in the `Run` function.
+E.g. `Run(context.Background(), "ghcr.io/u-health/docker-firebase-emulator:13.29.2")`.
+
+{% include "../features/common_functional_options.md" %}
+
+### Container Methods
+
+The Firebase container exposes the following methods:

mkdocs.yml

@@ -81,6 +81,7 @@ nav:
         - modules/dynamodb.md
         - modules/elasticsearch.md
         - modules/etcd.md
+        - modules/firebase.md
         - modules/gcloud.md
         - modules/grafana-lgtm.md
         - modules/inbucket.md

modules/firebase/Makefile

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

modules/firebase/config.go

@@ -0,0 +1,87 @@
+package firebase
+
+// Based on https://github.com/firebase/firebase-tools/blob/master/src/firebaseConfig.ts
+
+type emulatorsConfig struct {
+	SingleProjectMode bool `json:"singleProjectMode,omitempty"`
+
+	Auth struct {
+		Host string `json:"host,omitempty"`
+		Port uint16 `json:"port,omitempty"`
+	} `json:"auth,omitempty"`
+
+	Database struct {
+		Host string `json:"host,omitempty"`
+		Port uint16 `json:"port,omitempty"`
+	} `json:"database,omitempty"`
+
+	Firestore struct {
+		Host          string `json:"host,omitempty"`
+		Port          uint16 `json:"port,omitempty"`
+		WebsocketPort uint16 `json:"websocketPort,omitempty"`
+	} `json:"firestore,omitempty"`
+
+	Functions struct {
+		Host string `json:"host,omitempty"`
+		Port uint16 `json:"port,omitempty"`
+	} `json:"functions,omitempty"`
+
+	Hosting struct {
+		Host string `json:"host,omitempty"`
+		Port uint16 `json:"port,omitempty"`
+	} `json:"hosting,omitempty"`
+
+	AppHosting struct {
+		Host          string `json:"host,omitempty"`
+		Port          uint16 `json:"port,omitempty"`
+		StartCommand  string `json:"startCommand,omitempty"`
+		RootDirectory string `json:"rootDirectory,omitempty"`
+	} `json:"apphosting,omitempty"`
+
+	PubSub struct {
+		Host string `json:"host,omitempty"`
+		Port uint16 `json:"port,omitempty"`
+	} `json:"pubsub,omitempty"`
+
+	Storage struct {
+		Host string `json:"host,omitempty"`
+		Port uint16 `json:"port,omitempty"`
+	} `json:"storage,omitempty"`
+
+	Logging struct {
+		Host string `json:"host,omitempty"`
+		Port uint16 `json:"port,omitempty"`
+	} `json:"logging,omitempty"`
+
+	Hub struct {
+		Host string `json:"host,omitempty"`
+		Port uint16 `json:"port,omitempty"`
+	} `json:"hub,omitempty"`
+
+	UI struct {
+		Enabled bool   `json:"enabled,omitempty"`
+		Host    string `json:"host,omitempty"`
+		Port    uint16 `json:"port,omitempty"`
+	} `json:"ui,omitempty"`
+
+	EventArc struct {
+		Host string `json:"host,omitempty"`
+		Port uint16 `json:"port,omitempty"`
+	} `json:"eventarc,omitempty"`
+
+	DataConnect struct {
+		Host         string `json:"host,omitempty"`
+		Port         uint16 `json:"port,omitempty"`
+		PostgresHost string `json:"postgresHost,omitempty"`
+		PostgresPort uint16 `json:"postgresPort,omitempty"`
+		DataDir      string `json:"dataDir,omitempty"`
+	} `json:"dataconnect,omitempty"`
+
+	Tasks struct {
+		Host string `json:"host,omitempty"`
+		Port uint16 `json:"port,omitempty"`
+	} `json:"tasks,omitempty"`
+}
+type partialFirebaseConfig struct {
+	Emulators emulatorsConfig `json:"emulators,omitempty"`
+}

modules/firebase/examples_test.go

@@ -0,0 +1,40 @@
+package firebase_test
+
+import (
+	"context"
+	"fmt"
+	"log"
+	"path/filepath"
+
+	"github.com/testcontainers/testcontainers-go"
+	"github.com/testcontainers/testcontainers-go/modules/firebase"
+)
+
+func ExampleRun() {
+	ctx := context.Background()
+
+	firebaseContainer, err := firebase.Run(ctx, "ghcr.io/u-health/docker-firebase-emulator:13.29.2",
+		firebase.WithRoot(filepath.Join(".", "firebase")),
+		firebase.WithCache(),
+	)
+	defer func() {
+		if err := testcontainers.TerminateContainer(firebaseContainer); err != nil {
+			log.Printf("failed to terminate container: %s", err)
+		}
+	}()
+	if err != nil {
+		log.Printf("failed to start container: %s", err)
+		return
+	}
+
+	state, err := firebaseContainer.State(ctx)
+	if err != nil {
+		log.Printf("failed to get container state: %s", err)
+		return
+	}
+
+	fmt.Println(state.Running)
+
+	// Output:
+	// true
+}

modules/firebase/failure/.firebaserc

@@ -0,0 +1,5 @@
+{
+  "projects": {
+    "default": "test"
+  }
+}

modules/firebase/failure/firebase.json

@@ -0,0 +1,39 @@
+{
+  "emulators": {
+    "ui": {
+      "//": "UI will only partially work in the container. Because ports get mangled, some of the features will be broken. A solution is to run UI externally and provide the mangled ports as inputs.",
+      "enabled": true,
+      "port": 4000,
+      "host": "0.0.0.0"
+    },
+    "hub": {
+      "port": 4400,
+      "host": "0.0.0.0"
+    },
+    "logging": {
+      "port": 4600,
+      "host": "0.0.0.0"
+    },
+    "firestore": {
+      "port": 8080,
+      "host": "0.0.0.0",
+      "websocketPort": 8081
+    },
+    "auth": {
+      "port": 9099,
+      "host": "0.0.0.0"
+    },
+    "storage": {
+      "port": 9199,
+      "host": "0.0.0.0"
+    },
+    "singleProjectMode": true
+  },
+  "firestore": {
+    "rules": "firestore.rules",
+    "indexes": "firestore.indexes.json"
+  },
+  "storage": {
+    "rules": "storage.rules"
+  }
+}

modules/firebase/failure/firestore.indexes.json

@@ -0,0 +1,4 @@
+{
+  "indexes": [],
+  "fieldOverrides": []
+}

modules/firebase/failure/firestore.rules

@@ -0,0 +1,9 @@
+rules_version = '2';
+service cloud.firestore {
+    match /databases/{database}/documents {
+        match /{document=**} {
+            allow read, write: if false;
+        }
+    }
+}
+

modules/firebase/failure/storage.rules

@@ -0,0 +1,8 @@
+rules_version = '2';
+service firebase.storage {
+    match /b/{bucket}/o {
+        match /{allPaths=**} {
+            allow read, write: if true;
+        }
+    }
+}