fix: rewrote the module based on comments

Author: xytis

docs/modules/firebase.md

@@ -17,18 +17,26 @@ go get github.com/testcontainers/testcontainers-go/modules/firebase
 ## Usage example
 
 <!--codeinclude-->
-[Creating a Firebase container](../../modules/firebase/examples_test.go) inside_block:runFirebaseContainer
+[Creating a Firebase container](../../modules/firebase/examples_test.go) inside_block:ExampleRun
 <!--/codeinclude-->
 
-## Module reference
+## Module Reference
 
-The Firebase module exposes one entrypoint function to create the Firebase container, and this function receives two parameters:
+### 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 RunContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*FirebaseContainer, error)
+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
@@ -37,8 +45,8 @@ When starting the Firebase container, you can pass options in a variadic way to
 
 #### Image
 
-If you need to set a different Firebase Docker image, you can use `testcontainers.WithImage` with a valid Docker image
-for Firebase. E.g. `testcontainers.WithImage("ghcr.io/thoughtgears/docker-firebase-emulator:13.6.0")`.
+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" %}
 

modules/firebase/anchor_test.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 int    `json:"port,omitempty"`
+	} `json:"auth,omitempty"`
+
+	Database struct {
+		Host string `json:"host,omitempty"`
+		Port int    `json:"port,omitempty"`
+	} `json:"database,omitempty"`
+
+	Firestore struct {
+		Host          string `json:"host,omitempty"`
+		Port          int    `json:"port,omitempty"`
+		WebsocketPort int    `json:"websocketPort,omitempty"`
+	} `json:"firestore,omitempty"`
+
+	Functions struct {
+		Host string `json:"host,omitempty"`
+		Port int    `json:"port,omitempty"`
+	} `json:"functions,omitempty"`
+
+	Hosting struct {
+		Host string `json:"host,omitempty"`
+		Port int    `json:"port,omitempty"`
+	} `json:"hosting,omitempty"`
+
+	AppHosting struct {
+		Host          string `json:"host,omitempty"`
+		Port          int    `json:"port,omitempty"`
+		StartCommand  string `json:"startCommand,omitempty"`
+		RootDirectory string `json:"rootDirectory,omitempty"`
+	} `json:"apphosting,omitempty"`
+
+	PubSub struct {
+		Host string `json:"host,omitempty"`
+		Port int    `json:"port,omitempty"`
+	} `json:"pubsub,omitempty"`
+
+	Storage struct {
+		Host string `json:"host,omitempty"`
+		Port int    `json:"port,omitempty"`
+	} `json:"storage,omitempty"`
+
+	Logging struct {
+		Host string `json:"host,omitempty"`
+		Port int    `json:"port,omitempty"`
+	} `json:"logging,omitempty"`
+
+	Hub struct {
+		Host string `json:"host,omitempty"`
+		Port int    `json:"port,omitempty"`
+	} `json:"hub,omitempty"`
+
+	UI struct {
+		Enabled bool   `json:"enabled,omitempty"`
+		Host    string `json:"host,omitempty"`
+		Port    int    `json:"port,omitempty"`
+	} `json:"ui,omitempty"`
+
+	EventArc struct {
+		Host string `json:"host,omitempty"`
+		Port int    `json:"port,omitempty"`
+	} `json:"eventarc,omitempty"`
+
+	DataConnect struct {
+		Host         string `json:"host,omitempty"`
+		Port         int    `json:"port,omitempty"`
+		PostgresHost string `json:"postgresHost,omitempty"`
+		PostgresPort int    `json:"postgresPort,omitempty"`
+		DataDir      string `json:"dataDir,omitempty"`
+	} `json:"dataconnect,omitempty"`
+
+	Tasks struct {
+		Host string `json:"host,omitempty"`
+		Port int    `json:"port,omitempty"`
+	} `json:"tasks,omitempty"`
+}
+type FirebaseConfig struct {
+	Emulators EmulatorsConfig `json:"emulators,omitempty"`
+}

modules/firebase/config.go

@@ -6,32 +6,32 @@ import (
 	"log"
 	"path/filepath"
 
+	"github.com/testcontainers/testcontainers-go"
 	"github.com/testcontainers/testcontainers-go/modules/firebase"
 )
 
-func ExampleRunContainer() {
-	// runFirebaseContainer {
+func ExampleRun() {
 	ctx := context.Background()
 
-	firebaseContainer, err := firebase.RunContainer(
-		ctx,
-		firebase.WithRoot(filepath.Join(BasePath(), "firebase")),
+	firebaseContainer, err := firebase.Run(ctx, "ghcr.io/u-health/docker-firebase-emulator:13.29.2",
+		firebase.WithRoot(filepath.Join(".", "firebase")),
+		firebase.WithCache(),
 	)
-	if err != nil {
-		log.Fatalf("failed to start container: %s", err)
-	}
-
-	// Clean up the container
 	defer func() {
-		if err := firebaseContainer.Terminate(ctx); err != nil {
-			log.Fatalf("failed to terminate container: %s", err) // nolint:gocritic
+		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.Fatalf("failed to get container state: %s", err) // nolint:gocritic
+		log.Printf("failed to get container state: %s", err)
+		return
 	}
 
 	fmt.Println(state.Running)

modules/firebase/examples_test.go

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

modules/firebase/failure/.firebaserc

@@ -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/firebase.json

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

modules/firebase/failure/firestore.indexes.json

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

modules/firebase/failure/firestore.rules

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