Add test for options parser util

lfkellogg · lfkellogg · commit bbea92caf8b5 · 2024-01-31T10:39:38.000-05:00
diff --git a/src/appdistribution/options-parser-util.ts b/src/appdistribution/options-parser-util.ts
@@ -114,7 +114,7 @@ function parseTestDevice(testDeviceString: string): TestDevice {
         break;
       default:
         throw new FirebaseError(
-          `Unrecognized key in test devices. Can only contain ${Array.from(allowedKeys).join(",")}`,
+          `Unrecognized key in test devices. Can only contain ${Array.from(allowedKeys).join(", ")}`,
         );
     }
   }
@@ -127,12 +127,16 @@ function parseTestDevice(testDeviceString: string): TestDevice {
   return { model, version, locale, orientation };
 }
 
+/**
+ * Takes option values for username and password related options and returns a LoginCredential
+ * object that can be passed to the API.
+ */
 export function getLoginCredential(
   username?: string,
   password?: string,
   usernameResourceName?: string,
   passwordResourceName?: string,
-) {
+): LoginCredential | undefined {
   if (isPresenceMismatched(usernameResourceName, passwordResourceName)) {
     throw new FirebaseError(
       "Username and password resource names for automated tests need to be specified together.",
diff --git a/src/test/appdistro/options-parser-util.spec.ts b/src/test/appdistro/options-parser-util.spec.ts
@@ -0,0 +1,134 @@
+import { expect } from "chai";
+import { getLoginCredential, getTestDevices } from "../../appdistribution/options-parser-util";
+import { FirebaseError } from "../../error";
+
+describe.only("options-parser-util", () => {
+  describe("getTestDevices", () => {
+    it("parses a test device", () => {
+      const optionValue = "model=modelname,version=123,orientation=landscape,locale=en_US";
+
+      const result = getTestDevices(optionValue, "");
+
+      expect(result).to.deep.equal([{
+        model: "modelname",
+        version: "123",
+        orientation: "landscape",
+        locale: "en_US",
+      }]);
+    });
+
+    it("parses multiple semicolon-separated test devices", () => {
+      const optionValue =
+        "model=modelname,version=123,orientation=landscape,locale=en_US;model=modelname2,version=456,orientation=portrait,locale=es";
+
+      const result = getTestDevices(optionValue, "");
+
+      expect(result).to.deep.equal([
+        {
+          model: "modelname",
+          version: "123",
+          orientation: "landscape",
+          locale: "en_US",
+        },
+        {
+          model: "modelname2",
+          version: "456",
+          orientation: "portrait",
+          locale: "es",
+        }
+      ]);
+    });
+
+    it("parses multiple newline-separated test devices", () => {
+      const optionValue =
+        "model=modelname,version=123,orientation=landscape,locale=en_US\nmodel=modelname2,version=456,orientation=portrait,locale=es";
+
+      const result = getTestDevices(optionValue, "");
+
+      expect(result).to.deep.equal([
+        {
+          model: "modelname",
+          version: "123",
+          orientation: "landscape",
+          locale: "en_US",
+        },
+        {
+          model: "modelname2",
+          version: "456",
+          orientation: "portrait",
+          locale: "es",
+        }
+      ]);
+    });
+
+    it("throws an error with correct format when missing a field", () => {
+      const optionValue = "model=modelname,version=123,locale=en_US";
+
+      expect(() => getTestDevices(optionValue, "")).to.throw(
+        FirebaseError,
+        "model=<model-id>,version=<os-version-id>,locale=<locale>,orientation=<orientation>",
+      );
+    });
+
+    it("throws an error with expected fields when field is unexpected", () => {
+      const optionValue = "model=modelname,version=123,orientation=landscape,locale=en_US,notafield=blah";
+
+      expect(() => getTestDevices(optionValue, "")).to.throw(
+        FirebaseError,
+        "model, version, orientation, locale",
+      );
+    });
+  });
+
+  describe("getLoginCredential", () => {
+    it("returns credential for username and password", () => {
+      const result = getLoginCredential("user", "123");
+
+      expect(result).to.deep.equal({
+        username: "user",
+        password: "123",
+        fieldHints: undefined,
+      });
+    });
+
+    it("returns undefined when no options provided", () => {
+      const result = getLoginCredential();
+
+      expect(result).to.be.undefined
+    });
+
+    it("returns credential for username, password, and resource names", () => {
+      const result = getLoginCredential("user", "123", "username_resource_id", "password_resource_id");
+
+      expect(result).to.deep.equal({
+        username: "user",
+        password: "123",
+        fieldHints: {
+          usernameResourceName: "username_resource_id",
+          passwordResourceName: "password_resource_id",
+        },
+      });
+    });
+
+    it("throws error when username and password not provided together", () => {
+      expect(() => getLoginCredential("user", undefined)).to.throw(
+        FirebaseError,
+        "Username and password for automated tests need to be specified together"
+      );
+    });
+
+    it("throws error when username but not password resources not provided together", () => {
+      expect(() => getLoginCredential("user", "123", undefined, "password_resource_id")).to.throw(
+        FirebaseError,
+        "Username and password resource names for automated tests need to be specified together"
+      );
+    });
+
+    it("throws error when resource names provided without username and password", () => {
+      expect(() => getLoginCredential(undefined, undefined, "username_resource_id", "password_resource_id")).to.throw(
+        FirebaseError,
+        "Must specify username and password"
+      );
+    });
+  });
+});
