fix: another pass at comments

Author: xytis

modules/firebase/config.go

@@ -2,7 +2,7 @@ package firebase
 
 // Based on https://github.com/firebase/firebase-tools/blob/master/src/firebaseConfig.ts
 
-type EmulatorsConfig struct {
+type emulatorsConfig struct {
 	SingleProjectMode bool `json:"singleProjectMode,omitempty"`
 
 	Auth struct {
@@ -82,6 +82,6 @@ type EmulatorsConfig struct {
 		Port int    `json:"port,omitempty"`
 	} `json:"tasks,omitempty"`
 }
-type FirebaseConfig struct {
-	Emulators EmulatorsConfig `json:"emulators,omitempty"`
+type partialFirebaseConfig struct {
+	Emulators emulatorsConfig `json:"emulators,omitempty"`
 }

modules/firebase/examples_test.go

@@ -26,7 +26,6 @@ func ExampleRun() {
 		log.Printf("failed to start container: %s", err)
 		return
 	}
-	// }
 
 	state, err := firebaseContainer.State(ctx)
 	if err != nil {

modules/firebase/firebase.go

@@ -67,7 +67,7 @@ func WithCache() testcontainers.CustomizeRequestOption {
 	}
 }
 
-func gatherPorts(config FirebaseConfig) ([]string, error) {
+func gatherPorts(config partialFirebaseConfig) ([]string, error) {
 	var ports []string
 
 	v := reflect.ValueOf(config.Emulators)
@@ -128,7 +128,7 @@ func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustom
 		return file.ContainerFilePath == rootFilePath
 	})
 	if rootPathIdx == -1 {
-		return nil, fmt.Errorf("firebase emulator is unable to boot without configuration root (obtained via 'firebase init')")
+		return nil, fmt.Errorf("firebase root not provided (WithRoot is required)")
 	}
 	// Parse expected emulators from the root:
 	userRoot := req.ContainerRequest.Files[rootPathIdx].HostFilePath
@@ -141,13 +141,13 @@ func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustom
 	if err != nil {
 		return nil, fmt.Errorf("read firebase.json: %w", err)
 	}
-	var parsed FirebaseConfig
+	var parsed partialFirebaseConfig
 	if err := json.Unmarshal(bytes, &parsed); err != nil {
 		return nil, fmt.Errorf("parse firebase.json: %w", err)
 	}
 	expectedExposedPorts, err := gatherPorts(parsed)
 	if err != nil {
-		return nil, fmt.Errorf("issues with emulator config block: %w", err)
+		return nil, fmt.Errorf("invalid config: %w", err)
 	}
 	req.ExposedPorts = expectedExposedPorts
 

modules/firebase/firebase_test.go

@@ -2,13 +2,11 @@ package firebase_test
 
 import (
 	"context"
-	"os"
 	"path/filepath"
 	"testing"
 	"time"
 
 	"cloud.google.com/go/firestore"
-	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
 	"github.com/testcontainers/testcontainers-go"
@@ -25,27 +23,30 @@ func TestFirebase(t *testing.T) {
 	testcontainers.CleanupContainer(t, ctr)
 	require.NoError(t, err)
 
-	// perform assertions
+	// perform requireions
 	// Ports are linked to the example config in firebase/firebase.json
 
 	firestoreUrl, err := ctr.ConnectionString(ctx, "8080/tcp")
-	assert.NoError(t, err)
-	assert.NotEmpty(t, firestoreUrl)
-	_ = os.Setenv("FIRESTORE_EMULATOR_HOST", firestoreUrl)
+	require.NoError(t, err)
+	require.NotEmpty(t, firestoreUrl)
+
+	t.Setenv("FIRESTORE_EMULATOR_HOST", firestoreUrl)
 	c, err := firestore.NewClient(ctx, firestore.DetectProjectID)
 	require.NoError(t, err)
 	defer c.Close()
-	w, err := c.Collection("example").Doc("one").Set(ctx, map[string]interface{}{
+
+	w, err := c.Collection("example").Doc("one").Set(ctx, map[string]any{
 		"foo": "bar",
 	})
-	require.NotNil(t, w)
 	require.NoError(t, err)
+	require.NotNil(t, w)
+
 	snap, err := c.Collection("example").Doc("one").Get(ctx)
 	require.NoError(t, err)
 	var out map[string]string
 	err = snap.DataTo(&out)
 	require.NoError(t, err)
-	assert.Equal(t, "bar", out["foo"])
+	require.Equal(t, "bar", out["foo"])
 }
 
 func TestFirebaseBadDirectory(t *testing.T) {
@@ -57,7 +58,7 @@ func TestFirebaseBadDirectory(t *testing.T) {
 	)
 	// In this case, the file gets copied over at /srv/failure (instead of /srv/firebase)
 	// and this stops working.
-	// What would be a solution here? Previously I just added an assertion that the root must
+	// What would be a solution here? Previously I just added an requireion that the root must
 	// end in "/firebase"... I could do the same.
 	testcontainers.CleanupContainer(t, ctr)
 	require.NoError(t, err)
@@ -69,6 +70,5 @@ func TestFirebaseRequiresRoot(t *testing.T) {
 
 	ctr, err := firebase.Run(ctx, "ghcr.io/u-health/docker-firebase-emulator:13.29.2")
 	testcontainers.CleanupContainer(t, ctr)
-	require.Error(t, err)
 	require.ErrorContains(t, err, "unable to boot without configuration root")
 }