Better YAML errors and test coverage

Author: kaibolay

src/appdistribution/yaml_helper.spec.ts

@@ -1,5 +1,5 @@
-import { TestCase } from "./types";
 import * as jsYaml from "js-yaml";
+import { TestCase } from "./types";
 import { fromYaml, toYaml } from "./yaml_helper";
 import { expect } from "chai";
 
@@ -23,7 +23,8 @@ const TEST_CASES: TestCase[] = [
   },
   {
     displayName: "minimal-case",
-    aiInstructions: { steps: [{ goal: "test-goal" }] },
+    name: "projects/12345/apps/1:12345:android:beef/testCases/minimal-id",
+    aiInstructions: { steps: [{ goal: "win" }] },
   },
 ];
 
@@ -34,31 +35,58 @@ const YAML_STRING = `- displayName: test-display-name
     - goal: test-goal
       hint: test-hint
       successCriteria: test-success-criteria
+- displayName: minimal-case
+  id: minimal-id
+  steps:
+    - goal: win
 `;
 
-const YAML_DATA = {
-  displayName: "test-display-name",
-  id: "test-case-id",
-  prerequisiteTestCaseId: "prerequisite-test-case-id",
-  steps: [
-    {
-      goal: "test-goal",
-      hint: "test-hint",
-      successCriteria: "test-success-criteria",
-    },
-  ],
-};
+const YAML_DATA = [
+  {
+    displayName: "test-display-name",
+    id: "test-case-id",
+    prerequisiteTestCaseId: "prerequisite-test-case-id",
+    steps: [
+      {
+        goal: "test-goal",
+        hint: "test-hint",
+        successCriteria: "test-success-criteria",
+      },
+    ],
+  },
+  {
+    displayName: "minimal-case",
+    id: "minimal-id",
+    steps: [{ goal: "win" }],
+  },
+];
 
 describe("YamlHelper", () => {
   it("converts TestCase[] to YAML string", () => {
-    const yamlString = toYaml([TEST_CASE]);
+    const yamlString = toYaml(TEST_CASES);
+    expect(jsYaml.safeLoad(yamlString)).to.eql(YAML_DATA);
     expect(yamlString).to.eq(YAML_STRING); // brittle ¯\_(ツ)_/¯
-    expect(jsYaml.safeLoad(yamlString)).to.eql([YAML_DATA]);
   });
 
   it("converts YAML string to TestCase[]", () => {
     const testCases = fromYaml(APP_NAME, YAML_STRING);
-    expect(testCases).to.eql([TEST_CASE]);
+    expect(testCases).to.eql(TEST_CASES);
+  });
+
+  it("converts YAML without ID", () => {
+    const testCases = fromYaml(
+      APP_NAME,
+      `- displayName: minimal-case
+  steps:
+    - goal: win
+`,
+    );
+    expect(testCases).to.eql([
+      {
+        displayName: "minimal-case",
+        aiInstructions: { steps: [{ goal: "win" }] },
+      },
+    ]);
   });
 
   it("throws error if displayName is missing", () => {

src/appdistribution/yaml_helper.ts

@@ -1,6 +1,6 @@
-import { TestCase } from "./types";
 import * as jsYaml from "js-yaml";
 import { FirebaseError } from "../error";
+import { TestCase } from "./types";
 
 declare interface YamlStep {
   goal?: string;
@@ -63,6 +63,9 @@ function checkAllowedKeys(allowedKeys: Set<string>, o: object) {
 }
 
 function fromYamlTestCases(appName: string, yamlTestCases: YamlTestCase[]): TestCase[] {
+  if (!Array.isArray(yamlTestCases)) {
+    throw new FirebaseError("YAML file must contain a list of test cases.");
+  }
   return yamlTestCases.map((yamlTestCase) => {
     checkAllowedKeys(ALLOWED_YAML_TEST_CASE_KEYS, yamlTestCase);
     return {