Merge github.com:firebase/firebase-tools into zip_deploy_barebones

Author: falahat

CHANGELOG.md

@@ -1 +0,0 @@
-- Updated Pub/Sub emulator to version 0.8.29.

npm-shrinkwrap.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-tools",
-  "version": "15.10.0",
+  "version": "15.10.1",
   "description": "Command-Line Interface for Firebase",
   "main": "./lib/index.js",
   "mcpName": "io.github.firebase/firebase-mcp",

package.json

@@ -111,9 +111,26 @@ steps:
       - "REPOSITORY_ORG=${_REPOSITORY_ORG}"
       - "REPOSITORY_NAME=${_REPOSITORY_NAME}"
 
-  # Wait a bit of time for npm to catch up.
+  # Wait for package to be available on npm.
   - name: "gcr.io/$PROJECT_ID/package-builder"
-    args: ["sleep", "240"]
+    entrypoint: "bash"
+    args:
+      - "-c"
+      - |
+        echo "Waiting for firebase-tools@$(cat /workspace/version_number.txt) to be available on npm..."
+        timeout=300
+        elapsed=0
+        interval=15
+        until npm view "firebase-tools@$(cat /workspace/version_number.txt)" > /dev/null 2>&1; do
+          if [ $$elapsed -ge $$timeout ]; then
+            echo "Timeout waiting for package."
+            exit 1
+          fi
+          echo "Still waiting..."
+          sleep $$interval
+          elapsed=$$((elapsed + interval))
+        done
+        echo "Package firebase-tools@$(cat /workspace/version_number.txt) is now available on npm."
 
   # Set up the hub credentials for firepit-builder.
   - name: "gcr.io/$PROJECT_ID/firepit-builder"
@@ -134,7 +151,7 @@ steps:
       - "-c"
       - |
         if [ "${_VERSION}" != "preview" ]; then
-          GITHUB_TOKEN=$(cat ~/.config/hub) node /usr/src/app/pipeline.js --package=firebase-tools@latest --publish
+          GITHUB_TOKEN=$(cat ~/.config/hub) node /usr/src/app/pipeline.js --package=firebase-tools@$(cat /workspace/version_number.txt) --publish
           echo "Please review the draft release notes at https://github.com/${_REPOSITORY_ORG}/${_REPOSITORY_NAME}/releases. If it looks good, publish it"
         else
           echo "Skipping firepit build for preview version."

scripts/publish/cloudbuild.yaml

@@ -20,6 +20,7 @@ COPY package-lock.json /usr/local/node_packages/
 
 WORKDIR /usr/local/node_packages/
 RUN npm install && npm update
+RUN chmod -R 755 /usr/local/node_packages /usr/local/lib/node_modules
 ENV PATH="/usr/local/node_packages/node_modules/.bin:${PATH}"
 
 WORKDIR /

scripts/publish/firebase-docker-image/Dockerfile

@@ -68,6 +68,24 @@ describe("parseTestFiles", () => {
       ]);
     });
 
+    it("ignores non-yaml files", async () => {
+      writeFile(
+        "my_test.yaml",
+        stringify({
+          tests: [{ displayName: "my test", steps: [{ goal: "click a button" }] }],
+        }),
+      );
+      writeFile(
+        "my_test.txt",
+        stringify({
+          tests: [{ displayName: "should not be parsed", steps: [{ goal: "do nothing" }] }],
+        }),
+      );
+      const tests = await parseTestFiles(tempdir.name, "http://www.foo.com");
+      expect(tests.length).to.equal(1);
+      expect(tests[0].testCase.displayName).to.equal("my test");
+    });
+
     it("parses the sample test case file", async () => {
       writeFile("smoke_test.yaml", readTemplateSync("init/apptesting/smoke_test.yaml"));
       const tests = await parseTestFiles(tempdir.name, "http://www.foo.com");
@@ -181,27 +199,43 @@ describe("parseTestFiles", () => {
     }
 
     it("returns an empty list if no match", async () => {
-      writeFile("aaa", createBasicTest(["axx", "ayy", "azz"]));
-      writeFile("bbb", createBasicTest(["bxx", "byy", "bzz"]));
+      writeFile("aaa.yaml", createBasicTest(["axx", "ayy", "azz"]));
+      writeFile("bbb.yaml", createBasicTest(["bxx", "byy", "bzz"]));
       expect(await getTestCaseNames("yyy")).to.eql([]);
     });
 
     it("filters on filename", async () => {
-      writeFile("aaa", createBasicTest(["axx", "ayy", "azz"]));
-      writeFile("bbb", createBasicTest(["bxx", "byy", "bzz"]));
+      writeFile("aaa.yaml", createBasicTest(["axx", "ayy", "azz"]));
+      writeFile("bbb.yaml", createBasicTest(["bxx", "byy", "bzz"]));
       expect(await getTestCaseNames("aaa")).to.eql(["axx", "ayy", "azz"]);
     });
 
     it("filters on test case name", async () => {
-      writeFile("aaa", createBasicTest(["axx", "ayy", "azz"]));
-      writeFile("bbb", createBasicTest(["bxx", "byy", "bzz"]));
+      writeFile("aaa.yaml", createBasicTest(["axx", "ayy", "azz"]));
+      writeFile("bbb.yaml", createBasicTest(["bxx", "byy", "bzz"]));
       expect(await getTestCaseNames("", ".xx")).to.eql(["axx", "bxx"]);
     });
 
     it("filters on filename and test case name", async () => {
-      writeFile("aaa", createBasicTest(["axx", "ayy", "azz"]));
-      writeFile("bbb", createBasicTest(["bxx", "byy", "bzz"]));
-      expect(await getTestCaseNames("a$", "xx")).to.eql(["axx"]);
+      writeFile("aaa.yaml", createBasicTest(["axx", "ayy", "azz"]));
+      writeFile("bbb.yaml", createBasicTest(["bxx", "byy", "bzz"]));
+      expect(await getTestCaseNames("aaa\\.yaml$", "xx")).to.eql(["axx"]);
+    });
+
+    it("throws an error for invalid filename regex", async () => {
+      writeFile("aaa.yaml", createBasicTest(["axx", "ayy", "azz"]));
+      await expect(getTestCaseNames("*.txt")).to.be.rejectedWith(
+        FirebaseError,
+        "Invalid file pattern regex: *.txt",
+      );
+    });
+
+    it("throws an error for invalid test case name regex", async () => {
+      writeFile("aaa.yaml", createBasicTest(["axx", "ayy", "azz"]));
+      await expect(getTestCaseNames("", "*.txt")).to.be.rejectedWith(
+        FirebaseError,
+        "Invalid test name pattern regex: *.txt",
+      );
     });
   });
 

src/apptesting/parseTestFiles.spec.ts

@@ -35,8 +35,8 @@ export async function parseTestFiles(
       {} as Record<string, TestCaseInvocation>,
     );
 
-  const fileFilterFn = createFilter(filePattern);
-  const nameFilterFn = createFilter(namePattern);
+  const fileFilterFn = createFilter(filePattern, "file pattern");
+  const nameFilterFn = createFilter(namePattern, "test name pattern");
   const filteredInvocations = files
     .filter((file) => fileFilterFn(file.path))
     .flatMap((file) => file.invocations)
@@ -76,9 +76,17 @@ export async function parseTestFiles(
   });
 }
 
-function createFilter(pattern?: string) {
-  const regex = pattern ? new RegExp(pattern) : undefined;
-  return (s: string) => !regex || regex.test(s);
+function createFilter(pattern?: string, context?: string) {
+  try {
+    const regex = pattern ? new RegExp(pattern) : undefined;
+    return (s: string) => !regex || regex.test(s);
+  } catch (ex) {
+    if (ex instanceof SyntaxError) {
+      const errMsg = context ? `Invalid ${context} regex: ${pattern}` : `Invalid regex: ${pattern}`;
+      throw new FirebaseError(errMsg, { original: getError(ex) });
+    }
+    throw ex;
+  }
 }
 
 interface TestCaseFile {
@@ -92,25 +100,24 @@ async function parseTestFilesRecursive(params: {
 }): Promise<TestCaseFile[]> {
   const testDir = params.testDir;
   const targetUri = params.targetUri;
-  const items = listFiles(testDir);
+  const filenames = listFiles(testDir);
   const results = [];
-  for (const item of items) {
-    const path = join(testDir, item);
+  for (const filename of filenames) {
+    const path = join(testDir, filename);
     if (dirExistsSync(path)) {
       results.push(...(await parseTestFilesRecursive({ testDir: path, targetUri })));
-    } else if (fileExistsSync(path)) {
+    } else if (fileExistsSync(path) && (path.endsWith(".yaml") || path.endsWith(".yml"))) {
       try {
-        const file = await readFileFromDirectory(testDir, item);
-        logger.debug(`Read the file ${file.source}.`);
+        logger.debug(`Reading ${path}.`);
+        const file = await readFileFromDirectory(testDir, filename);
         const parsedFile = wrappedSafeLoad(file.source);
-        logger.debug(`Parsed the file.`);
         const tests = parsedFile.tests;
-        logger.debug(`There are ${tests.length} tests.`);
         const defaultConfig = parsedFile.defaultConfig;
         if (!tests || !tests.length) {
           logger.debug(`No tests found in ${path}. Ignoring.`);
           continue;
         }
+        logger.debug(`File contains ${pluralizeTests(tests.length)}.`);
         const invocations = [];
         for (const rawTestDef of tests) {
           const invocation = toTestCaseInvocation(rawTestDef, targetUri, defaultConfig);
@@ -129,6 +136,10 @@ async function parseTestFilesRecursive(params: {
   return results;
 }
 
+export function pluralizeTests(numTests: number) {
+  return `${numTests} test${numTests === 1 ? "" : "s"}`;
+}
+
 function toTestCaseInvocation(
   testDef: any,
   targetUri: any,

src/apptesting/parseTestFiles.ts

@@ -1,6 +1,6 @@
 import { requireAuth } from "../requireAuth";
 import { Command } from "../command";
-import { parseTestFiles } from "../apptesting/parseTestFiles";
+import { parseTestFiles, pluralizeTests } from "../apptesting/parseTestFiles";
 import * as ora from "ora";
 import { TestCaseInvocation } from "../apptesting/types";
 import { FirebaseError, getError } from "../error";
@@ -9,6 +9,8 @@ import { awaitTestResults, Distribution, upload } from "../appdistribution/distr
 import { AiInstructions, ReleaseTest, TestDevice, Release } from "../appdistribution/types";
 import { getAppName, parseTestDevices } from "../appdistribution/options-parser-util";
 import * as utils from "../utils";
+import { dirExistsSync } from "../fsutils";
+import * as path from "path";
 
 const defaultDevices = [
   {
@@ -33,24 +35,29 @@ export const command = new Command("apptesting:execute <release-binary-file>")
     "--test-name-pattern <pattern>",
     "Test name pattern. Only tests with names that match this pattern will be executed.",
   )
-  .option("--test-dir <test_dir>", "Directory where tests can be found.")
+  .option("--test-dir <test_dir>", "Directory where tests can be found. Defaults to './tests'.")
   .option(
     "--test-devices <string>",
-    "semicolon-separated list of devices to run automated tests on, in the format 'model=<model-id>,version=<os-version-id>,locale=<locale>,orientation=<orientation>'. Run 'gcloud firebase test android|ios models list' to see available devices. Note: This feature is in beta.",
+    "Semicolon-separated list of devices to run automated tests on, in the format 'model=<model-id>,version=<os-version-id>,locale=<locale>,orientation=<orientation>'. Run 'gcloud firebase test android|ios models list' to see available devices. Note: This feature is in beta.",
   )
   .option(
     "--test-devices-file <string>",
-    "path to file containing a list of semicolon- or newline-separated devices to run automated tests on, in the format 'model=<model-id>,version=<os-version-id>,locale=<locale>,orientation=<orientation>'. Run 'gcloud firebase test android|ios models list' to see available devices. Note: This feature is in beta.",
+    "Path to file containing a list of semicolon- or newline-separated devices to run automated tests on, in the format 'model=<model-id>,version=<os-version-id>,locale=<locale>,orientation=<orientation>'. Run 'gcloud firebase test android|ios models list' to see available devices. Note: This feature is in beta.",
   )
   .option(
     "--test-non-blocking",
-    "run automated tests without waiting for them to complete. Visit the Firebase console for the test results.",
+    "Run automated tests without waiting for them to complete. Visit the Firebase console for the test results.",
   )
   .before(requireAuth)
   .action(async (target: string, options: any) => {
     const appName = getAppName(options);
 
-    const testDir = options.testDir || "tests";
+    const testDir = path.resolve(options.testDir || "tests");
+    if (!dirExistsSync(testDir)) {
+      throw new FirebaseError(
+        `Tests directory not found: ${testDir}. Use the --test-dir flag to choose a different directory.`,
+      );
+    }
     const tests = await parseTestFiles(
       testDir,
       undefined,
@@ -60,8 +67,9 @@ export const command = new Command("apptesting:execute <release-binary-file>")
     const testDevices = parseTestDevices(options.testDevices, options.testDevicesFile);
 
     if (!tests.length) {
-      throw new FirebaseError("No tests found");
+      throw new FirebaseError(`No tests found under test directory ${testDir}`);
     }
+    utils.logBullet(`Found ${pluralizeTests(tests.length)} to run under test directory ${testDir}`);
 
     const invokeSpinner = ora("Requesting test execution");
     const client = new AppDistributionClient();
@@ -97,10 +105,6 @@ export const command = new Command("apptesting:execute <release-binary-file>")
     }
   });
 
-function pluralizeTests(numTests: number) {
-  return `${numTests} test${numTests === 1 ? "" : "s"}`;
-}
-
 async function invokeTests(
   client: AppDistributionClient,
   releaseName: string,

src/commands/apptesting.ts

@@ -43,6 +43,11 @@ export function load(client: CLIClient): CLIClient {
   client.appdistribution.testCases = {};
   client.appdistribution.testCases.export = loadCommand("appdistribution-testcases-export");
   client.appdistribution.testCases.import = loadCommand("appdistribution-testcases-import");
+  client.apptesting = {};
+  client.apptesting.execute = loadCommand("apptesting");
+  if (experiments.isEnabled("apptesting")) {
+    client.apptesting.wata = loadCommand("apptesting-wata");
+  }
   client.apps = {};
   client.apps.create = loadCommand("apps-create");
   client.apps.list = loadCommand("apps-list");
@@ -264,11 +269,6 @@ export function load(client: CLIClient): CLIClient {
   client.target.clear = loadCommand("target-clear");
   client.target.remove = loadCommand("target-remove");
   client.use = loadCommand("use");
-  client.apptesting = {};
-  client.apptesting.execute = loadCommand("apptesting");
-  if (experiments.isEnabled("apptesting")) {
-    client.apptesting.wata = loadCommand("apptesting-wata");
-  }
 
   const t1 = process.hrtime.bigint();
   const diffMS = (t1 - t0) / BigInt(1e6);

src/commands/index.ts

@@ -7,14 +7,17 @@ import { FirebaseError } from "../error";
 import { unzip } from "../unzip";
 import * as fs from "fs";
 
-export const command = new Command("studio:export <path>")
+export const command = new Command("studio:export [path]")
   .description(
     "Bootstrap Firebase Studio apps for migration to Antigravity. Run on the unzipped folder from the Firebase Studio download, or directly on the downloaded zip file.",
   )
   .option("--no-start-antigravity", "skip starting the Antigravity IDE after migration")
   .action(async (exportPath: string, options: Options) => {
     if (!exportPath) {
-      throw new FirebaseError("Must specify a path for migration.", { exit: 1 });
+      throw new FirebaseError(
+        "Must specify the path to the Firebase Studio downloaded zip file or the unzipped folder path.",
+        { exit: 1 },
+      );
     }
 
     let rootPath = path.resolve(exportPath);