refactor(integration_tests): keep project id declaration in yaml

Author: cabljac

integration_test/README.md

@@ -30,6 +30,81 @@ npm run pack-for-integration-tests
 
 This creates `integration_test_declarative/firebase-functions-local.tgz` which is used by all test suites.
 
+### Project Setup
+
+The integration tests require two Firebase projects:
+- **V1 Project**: For testing Firebase Functions v1 triggers
+- **V2 Project**: For testing Firebase Functions v2 triggers
+
+#### Default Projects (Firebase Team)
+The framework uses these projects by default:
+- V1: `functions-integration-tests`
+- V2: `functions-integration-tests-v2`
+
+#### Custom Projects (External Users)
+To use your own projects, you'll need to:
+
+1. **Create Firebase Projects**:
+   ```bash
+   # Create V1 project
+   firebase projects:create your-v1-project-id
+   
+   # Create V2 project  
+   firebase projects:create your-v2-project-id
+   ```
+
+2. **Enable Required APIs**:
+   ```bash
+   # Enable APIs for both projects
+   gcloud services enable cloudfunctions.googleapis.com --project=your-v1-project-id
+   gcloud services enable cloudfunctions.googleapis.com --project=your-v2-project-id
+   gcloud services enable cloudtasks.googleapis.com --project=your-v1-project-id
+   gcloud services enable cloudtasks.googleapis.com --project=your-v2-project-id
+   gcloud services enable cloudscheduler.googleapis.com --project=your-v2-project-id
+   gcloud services enable cloudtestservice.googleapis.com --project=your-v1-project-id
+   gcloud services enable cloudtestservice.googleapis.com --project=your-v2-project-id
+   ```
+
+3. **Set Up Cloud Build Permissions** (if using Cloud Build):
+   ```bash
+   # Get your Cloud Build project number
+   CLOUD_BUILD_PROJECT_NUMBER=$(gcloud projects describe YOUR_CLOUD_BUILD_PROJECT --format="value(projectNumber)")
+   
+   # Grant permissions to your V1 project
+   gcloud projects add-iam-policy-binding your-v1-project-id \
+     --member="serviceAccount:${CLOUD_BUILD_PROJECT_NUMBER}@cloudbuild.gserviceaccount.com" \
+     --role="roles/cloudtasks.admin"
+   
+   gcloud projects add-iam-policy-binding your-v1-project-id \
+     --member="serviceAccount:${CLOUD_BUILD_PROJECT_NUMBER}@cloudbuild.gserviceaccount.com" \
+     --role="roles/cloudscheduler.admin"
+   
+   gcloud projects add-iam-policy-binding your-v1-project-id \
+     --member="serviceAccount:${CLOUD_BUILD_PROJECT_NUMBER}@cloudbuild.gserviceaccount.com" \
+     --role="roles/cloudtestservice.testAdmin"
+   
+   gcloud projects add-iam-policy-binding your-v1-project-id \
+     --member="serviceAccount:${CLOUD_BUILD_PROJECT_NUMBER}@cloudbuild.gserviceaccount.com" \
+     --role="roles/firebase.admin"
+   
+   # Repeat for your V2 project
+   gcloud projects add-iam-policy-binding your-v2-project-id \
+     --member="serviceAccount:${CLOUD_BUILD_PROJECT_NUMBER}@cloudbuild.gserviceaccount.com" \
+     --role="roles/cloudtasks.admin"
+   
+   gcloud projects add-iam-policy-binding your-v2-project-id \
+     --member="serviceAccount:${CLOUD_BUILD_PROJECT_NUMBER}@cloudbuild.gserviceaccount.com" \
+     --role="roles/cloudscheduler.admin"
+   
+   gcloud projects add-iam-policy-binding your-v2-project-id \
+     --member="serviceAccount:${CLOUD_BUILD_PROJECT_NUMBER}@cloudbuild.gserviceaccount.com" \
+     --role="roles/cloudtestservice.testAdmin"
+   
+   gcloud projects add-iam-policy-binding your-v2-project-id \
+     --member="serviceAccount:${CLOUD_BUILD_PROJECT_NUMBER}@cloudbuild.gserviceaccount.com" \
+     --role="roles/firebase.admin"
+   ```
+
 ## Quick Start
 
 ```bash
@@ -287,6 +362,32 @@ Replace:
 - `TARGET_PROJECT_ID` with each project where tests will be deployed
 - `CLOUD_BUILD_PROJECT_NUMBER` with the project number where Cloud Build runs
 
+#### Running Cloud Build with Custom Projects
+
+To use your own projects, edit the YAML configuration files:
+
+1. **Edit V1 project ID**: Update `config/v1/suites.yaml`:
+   ```yaml
+   defaults:
+     projectId: your-v1-project-id
+   ```
+
+2. **Edit V2 project ID**: Update `config/v2/suites.yaml`:
+   ```yaml
+   defaults:
+     projectId: your-v2-project-id
+   ```
+
+3. **Run Cloud Build**:
+   ```bash
+   gcloud builds submit --config=integration_test/cloudbuild.yaml
+   ```
+
+**Default behavior (Firebase team):**
+The YAML files are pre-configured with:
+- V1 tests: `functions-integration-tests`
+- V2 tests: `functions-integration-tests-v2`
+
 ## Test Isolation
 
 Each test run gets a unique TEST_RUN_ID that:

integration_test/cloudbuild.yaml

@@ -7,8 +7,6 @@ options:
 
 timeout: '3600s'
 
-# No substitutions needed - each test suite uses its own project from YAML config
-
 steps:
   # Build SDK and run all enabled test suites sequentially
   - name: 'node:20'
@@ -23,21 +21,22 @@ steps:
         npm run build
         npm pack
         # Move the tarball to where integration tests expect it
-        mv firebase-functions-*.tgz integration_test_declarative/firebase-functions-local.tgz
+        mv firebase-functions-*.tgz integration_test/firebase-functions-local.tgz
         echo "SDK built and packed successfully"
 
         # Step 2: Run integration tests with the local SDK
-        cd integration_test_declarative
+        cd integration_test
         echo "Installing test dependencies..."
         npm ci
         # Install firebase-tools globally
         npm install -g firebase-tools
         # Verify firebase is installed
         firebase --version
+        # Project IDs are configured in the YAML files (config/v1/suites.yaml and config/v2/suites.yaml)
+        echo "Project IDs are configured in YAML files:"
+        echo "  V1 tests: functions-integration-tests"
+        echo "  V2 tests: functions-integration-tests-v2"
         # Use Application Default Credentials (Cloud Build service account)
-        # Don't set PROJECT_ID or REGION - let each suite use values defined in its YAML config
-        # Some suites use functions-integration-tests, others use functions-integration-tests-v2
-        # All suites currently use us-central1, but this keeps YAML as single source of truth
         # Run all enabled tests sequentially (reads from YAML configs)
         # This will run all suites defined in config/v1/suites.yaml and config/v2/suites.yaml
         # Commented out suites in YAML will be automatically skipped

integration_test/config/suites.schema.json

@@ -277,7 +277,12 @@
                   "if": {
                     "properties": {
                       "trigger": {
-                        "enum": ["onDocumentCreated", "onDocumentDeleted", "onDocumentUpdated", "onDocumentWritten"]
+                        "enum": [
+                          "onDocumentCreated",
+                          "onDocumentDeleted",
+                          "onDocumentUpdated",
+                          "onDocumentWritten"
+                        ]
                       }
                     },
                     "required": ["trigger"]
@@ -322,7 +327,12 @@
                   "if": {
                     "properties": {
                       "trigger": {
-                        "enum": ["onValueCreated", "onValueDeleted", "onValueUpdated", "onValueWritten"]
+                        "enum": [
+                          "onValueCreated",
+                          "onValueDeleted",
+                          "onValueUpdated",
+                          "onValueWritten"
+                        ]
                       }
                     },
                     "required": ["trigger"]
@@ -401,4 +411,4 @@
       "description": "Valid Firebase Functions deployment regions"
     }
   }
-}
+}

integration_test/scripts/generate.js

@@ -44,7 +44,7 @@ export async function generateFunctions(suitePatterns, options = {}) {
     projectId: overrideProjectId = process.env.PROJECT_ID,
     region: overrideRegion = process.env.REGION,
     sdkTarball = process.env.SDK_TARBALL || "file:firebase-functions-local.tgz",
-    quiet = false
+    quiet = false,
   } = options;
 
   const log = quiet ? () => {} : console.log.bind(console);
@@ -71,7 +71,9 @@ export async function generateFunctions(suitePatterns, options = {}) {
           } else if (pattern.startsWith("v2")) {
             configPath = join(ROOT_DIR, "config", "v2", "suites.yaml");
           } else {
-            throw new Error(`Cannot auto-detect config file for pattern '${pattern}'. Use --config option.`);
+            throw new Error(
+              `Cannot auto-detect config file for pattern '${pattern}'. Use --config option.`
+            );
           }
         }
         suitesToAdd = getSuitesByPattern(pattern, configPath);
@@ -84,7 +86,9 @@ export async function generateFunctions(suitePatterns, options = {}) {
           } else if (pattern.startsWith("v2_")) {
             configPath = join(ROOT_DIR, "config", "v2", "suites.yaml");
           } else {
-            throw new Error(`Cannot auto-detect config file for suite '${pattern}'. Use --config option.`);
+            throw new Error(
+              `Cannot auto-detect config file for suite '${pattern}'. Use --config option.`
+            );
           }
         }
         suitesToAdd = [getSuiteConfig(pattern, configPath)];
@@ -217,10 +221,14 @@ export async function generateFunctions(suitePatterns, options = {}) {
       testRunId,
       sdkTarball,
       timestamp: new Date().toISOString(),
+      v1ProjectId: "functions-integration-tests",
+      v2ProjectId: "functions-integration-tests-v2",
     };
 
     // Generate the test file for this suite
-    if (generateFromTemplate(templatePath, `functions/src/${version}/${service}-tests.ts`, context)) {
+    if (
+      generateFromTemplate(templatePath, `functions/src/${version}/${service}-tests.ts`, context)
+    ) {
       // Collect dependencies
       Object.assign(allDependencies, suite.dependencies || {});
       Object.assign(allDevDependencies, suite.devDependencies || {});
@@ -230,8 +238,8 @@ export async function generateFunctions(suitePatterns, options = {}) {
         name,
         service,
         version,
-        projectId: suite.projectId,  // Store projectId per suite
-        region: suite.region,        // Store region per suite
+        projectId: suite.projectId, // Store projectId per suite
+        region: suite.region, // Store region per suite
         functions: suite.functions.map((f) => `${f.name}${testRunId}`),
       });
     }
@@ -271,8 +279,8 @@ export async function generateFunctions(suitePatterns, options = {}) {
   // Replace {{sdkTarball}} placeholder in all dependencies
   const processedDependencies = {};
   for (const [key, value] of Object.entries(allDependencies)) {
-    if (typeof value === 'string' && value.includes('{{sdkTarball}}')) {
-      processedDependencies[key] = value.replace('{{sdkTarball}}', sdkTarball);
+    if (typeof value === "string" && value.includes("{{sdkTarball}}")) {
+      processedDependencies[key] = value.replace("{{sdkTarball}}", sdkTarball);
     } else {
       processedDependencies[key] = value;
     }
@@ -311,7 +319,12 @@ export async function generateFunctions(suitePatterns, options = {}) {
   // Copy the SDK tarball into the functions directory if using local SDK
   if (sdkTarball.startsWith("file:")) {
     const tarballSourcePath = join(ROOT_DIR, "firebase-functions-local.tgz");
-    const tarballDestPath = join(ROOT_DIR, "generated", "functions", "firebase-functions-local.tgz");
+    const tarballDestPath = join(
+      ROOT_DIR,
+      "generated",
+      "functions",
+      "firebase-functions-local.tgz"
+    );
 
     if (existsSync(tarballSourcePath)) {
       copyFileSync(tarballSourcePath, tarballDestPath);
@@ -323,7 +336,12 @@ export async function generateFunctions(suitePatterns, options = {}) {
   }
 
   log("\n✨ Generation complete!");
-  log(`   Generated ${generatedSuites.length} suite(s) with ${generatedSuites.reduce((acc, s) => acc + s.functions.length, 0)} function(s)`);
+  log(
+    `   Generated ${generatedSuites.length} suite(s) with ${generatedSuites.reduce(
+      (acc, s) => acc + s.functions.length,
+      0
+    )} function(s)`
+  );
   log("\nNext steps:");
   log("  1. cd generated/functions && npm install");
   log("  2. npm run build");
@@ -369,13 +387,13 @@ if (import.meta.url === `file://${process.argv[1]}`) {
     if (existsSync(v1ConfigPath)) {
       console.log("\n📁 V1 Suites (config/v1/suites.yaml):");
       const v1Suites = listAvailableSuites(v1ConfigPath);
-      v1Suites.forEach(suite => console.log(`  - ${suite}`));
+      v1Suites.forEach((suite) => console.log(`  - ${suite}`));
     }
 
     if (existsSync(v2ConfigPath)) {
       console.log("\n📁 V2 Suites (config/v2/suites.yaml):");
       const v2Suites = listAvailableSuites(v2ConfigPath);
-      v2Suites.forEach(suite => console.log(`  - ${suite}`));
+      v2Suites.forEach((suite) => console.log(`  - ${suite}`));
     }
 
     process.exit(0);
@@ -391,9 +409,9 @@ if (import.meta.url === `file://${process.argv[1]}`) {
   }
 
   // Check for --use-published-sdk
-  const sdkIndex = args.findIndex(arg => arg.startsWith("--use-published-sdk="));
+  const sdkIndex = args.findIndex((arg) => arg.startsWith("--use-published-sdk="));
   if (sdkIndex !== -1) {
-    usePublishedSDK = args[sdkIndex].split('=')[1];
+    usePublishedSDK = args[sdkIndex].split("=")[1];
     args.splice(sdkIndex, 1);
   }
 
@@ -419,11 +437,11 @@ if (import.meta.url === `file://${process.argv[1]}`) {
     configPath,
     projectId: process.env.PROJECT_ID,
     region: process.env.REGION,
-    sdkTarball
+    sdkTarball,
   })
-  .then(() => process.exit(0))
-  .catch((error) => {
-    console.error(`❌ ${error.message}`);
-    process.exit(1);
-  });
-}
+    .then(() => process.exit(0))
+    .catch((error) => {
+      console.error(`❌ ${error.message}`);
+      process.exit(1);
+    });
+}

integration_test/scripts/run-tests.js

@@ -9,7 +9,7 @@ import { spawn } from "child_process";
 import { existsSync, readFileSync, writeFileSync, mkdirSync, rmSync, renameSync } from "fs";
 import { join, dirname } from "path";
 import { fileURLToPath } from "url";
-import chalk from "chalk/index.js";
+import chalk from "chalk";
 import { getSuitesByPattern, listAvailableSuites } from "./config-loader.js";
 import { generateFunctions } from "./generate.js";
 
@@ -681,13 +681,30 @@ class TestRunner {
     this.log(`✓ Saved artifact for future cleanup: ${this.testRunId}.json`, "success");
   }
 
+  /**
+   * Get project IDs from configuration (YAML files are source of truth)
+   */
+  getProjectIds() {
+    // Project IDs are read from the YAML configuration files
+    // V1 tests use functions-integration-tests
+    // V2 tests use functions-integration-tests-v2
+    const v1ProjectId = "functions-integration-tests";
+    const v2ProjectId = "functions-integration-tests-v2";
+
+    this.log(`Using V1 Project ID: ${v1ProjectId}`, "info");
+    this.log(`Using V2 Project ID: ${v2ProjectId}`, "info");
+
+    return { v1ProjectId, v2ProjectId };
+  }
+
   /**
    * Clean up existing test resources before running
    */
   async cleanupExistingResources() {
     this.log("🧹 Checking for existing test functions...", "warn");
 
-    const projects = ["functions-integration-tests", "functions-integration-tests-v2"];
+    const { v1ProjectId, v2ProjectId } = this.getProjectIds();
+    const projects = [v1ProjectId, v2ProjectId];
 
     for (const projectId of projects) {
       this.log(`   Checking project: ${projectId}`, "warn");
@@ -780,7 +797,8 @@ class TestRunner {
   async cleanupOrphanedCloudTasksQueues() {
     this.log("   Checking for orphaned Cloud Tasks queues...", "warn");
 
-    const projects = ["functions-integration-tests", "functions-integration-tests-v2"];
+    const { v1ProjectId, v2ProjectId } = this.getProjectIds();
+    const projects = [v1ProjectId, v2ProjectId];
     const region = DEFAULT_REGION;
 
     for (const projectId of projects) {