Add export/import of app distribution test cases as YAML.

Author: kaibolay

package.json

@@ -26,6 +26,7 @@
     "mocha": "nyc --reporter=html mocha 'src/**/*.spec.{ts,js}'",
     "prepare": "npm run clean && npm run build:publish",
     "test": "npm run lint:quiet && npm run test:compile && npm run mocha",
+    "test:appdistribution": "npm run lint:quiet && npm run test:compile && nyc mocha 'src/appdistribution/*.spec.{ts,js}'",
     "test:apptesting": "npm run lint:quiet && npm run test:compile && nyc mocha 'src/apptesting/*.spec.{ts,js}'",
     "test:client-integration": "bash ./scripts/client-integration-tests/run.sh",
     "test:compile": "tsc --project tsconfig.compile.json",

src/appdistribution/client.spec.ts

@@ -7,7 +7,7 @@ import * as sinon from "sinon";
 import * as tmp from "tmp";
 
 import { AppDistributionClient } from "./client";
-import { BatchRemoveTestersResponse, Group, TestDevice } from "./types";
+import { BatchRemoveTestersResponse, Group, TestCase, TestDevice } from "./types";
 import { appDistributionOrigin } from "../api";
 import { Distribution } from "./distribution";
 import { FirebaseError } from "../error";
@@ -501,4 +501,91 @@ describe("distribution", () => {
       expect(nock.isDone()).to.be.true;
     });
   });
+
+  describe("listTestCases", () => {
+    it("should throw error if request fails", async () => {
+      nock(appDistributionOrigin())
+        .get(`/v1alpha/${appName}/testCases`)
+        .reply(400, { error: { status: "FAILED_PRECONDITION" } });
+      await expect(appDistributionClient.listTestCases(appName)).to.be.rejectedWith(
+        FirebaseError,
+        "Client failed to list test cases",
+      );
+      expect(nock.isDone()).to.be.true;
+    });
+
+    it("should resolve with array of test cases when request succeeds", async () => {
+      const testCases: TestCase[] = [
+        {
+          name: `$appName/testCases/tc_1`,
+          displayName: "Test Case 1",
+          aiInstructions: {
+            steps: [
+              {
+                goal: "Win at all costs",
+              },
+            ],
+          },
+        },
+        {
+          name: `$appName/testCases/tc_2`,
+          displayName: "Test Case 2",
+          aiInstructions: { steps: [] },
+        },
+      ];
+
+      nock(appDistributionOrigin()).get(`/v1alpha/${appName}/testCases`).reply(200, {
+        testCases: testCases,
+      });
+      await expect(appDistributionClient.listTestCases(appName)).to.eventually.deep.eq(testCases);
+      expect(nock.isDone()).to.be.true;
+    });
+  });
+
+  describe("createTestCase", () => {
+    const mockTestCase = { displayName: "Case", aiInstructions: { steps: [] } };
+
+    it("should throw error if request fails", async () => {
+      nock(appDistributionOrigin())
+        .post(`/v1alpha/${appName}/testCases`)
+        .reply(400, { error: { status: "FAILED_PRECONDITION" } });
+      await expect(appDistributionClient.createTestCase(appName, mockTestCase)).to.be.rejectedWith(
+        FirebaseError,
+        "Failed to create test case",
+      );
+      expect(nock.isDone()).to.be.true;
+    });
+
+    it("should resolve with TestCase when request succeeds", async () => {
+      nock(appDistributionOrigin()).post(`/v1alpha/${appName}/testCases`).reply(200, mockTestCase);
+      await expect(
+        appDistributionClient.createTestCase(appName, mockTestCase),
+      ).to.be.eventually.deep.eq(mockTestCase);
+      expect(nock.isDone()).to.be.true;
+    });
+  });
+
+  describe("batchUpsertTestCases", () => {
+    const mockTestCase = { displayName: "Case", aiInstructions: { steps: [] } };
+
+    it("should throw error if request fails", async () => {
+      nock(appDistributionOrigin())
+        .post(`/v1alpha/${appName}/testCases:batchUpdate`)
+        .reply(400, { error: { status: "FAILED_PRECONDITION" } });
+      await expect(
+        appDistributionClient.batchUpsertTestCases(appName, [mockTestCase]),
+      ).to.be.rejectedWith(FirebaseError, "Failed to upsert test cases");
+      expect(nock.isDone()).to.be.true;
+    });
+
+    it("should resolve with TestCase when request succeeds", async () => {
+      nock(appDistributionOrigin())
+        .post(`/v1alpha/${appName}/testCases:batchUpdate`)
+        .reply(200, { testCases: [mockTestCase] });
+      await expect(
+        appDistributionClient.batchUpsertTestCases(appName, [mockTestCase]),
+      ).to.be.eventually.deep.eq([mockTestCase]);
+      expect(nock.isDone()).to.be.true;
+    });
+  });
 });

src/appdistribution/client.ts

@@ -12,10 +12,14 @@ import {
   BatchRemoveTestersResponse,
   Group,
   ListGroupsResponse,
+  ListTestCasesResponse,
   ListTestersResponse,
   LoginCredential,
   mapDeviceToExecution,
   ReleaseTest,
+  TestCase,
+  BatchUpdateTestCasesRequest,
+  BatchUpdateTestCasesResponse,
   TestDevice,
   Tester,
   UploadReleaseResponse,
@@ -295,4 +299,58 @@ export class AppDistributionClient {
     const response = await this.appDistroV1AlphaClient.get<ReleaseTest>(releaseTestName);
     return response.body;
   }
+
+  async listTestCases(appName: string): Promise<TestCase[]> {
+    const testCases: TestCase[] = [];
+    const client = this.appDistroV1AlphaClient;
+
+    let pageToken: string | undefined;
+    do {
+      const queryParams: Record<string, string> = pageToken ? { pageToken } : {};
+      try {
+        const apiResponse = await client.get<ListTestCasesResponse>(`${appName}/testCases`, {
+          queryParams,
+        });
+        testCases.push(...(apiResponse.body.testCases ?? []));
+        pageToken = apiResponse.body.nextPageToken;
+      } catch (err) {
+        throw new FirebaseError(`Client failed to list test cases ${err}`);
+      }
+    } while (pageToken);
+    return testCases;
+  }
+
+  async createTestCase(appName: string, testCase: TestCase): Promise<TestCase> {
+    try {
+      const response = await this.appDistroV1AlphaClient.request<TestCase, TestCase>({
+        method: "POST",
+        path: `${appName}/testCases`,
+        body: testCase,
+      });
+      return response.body;
+    } catch (err: unknown) {
+      throw new FirebaseError(`Failed to create test case ${getErrMsg(err)}`);
+    }
+  }
+
+  async batchUpsertTestCases(appName: string, testCases: TestCase[]): Promise<TestCase[]> {
+    try {
+      const response = await this.appDistroV1AlphaClient.request<
+        BatchUpdateTestCasesRequest,
+        BatchUpdateTestCasesResponse
+      >({
+        method: "POST",
+        path: `${appName}/testCases:batchUpdate`,
+        body: {
+          requests: testCases.map((tc) => ({
+            testCase: tc,
+            allowMissing: true,
+          })),
+        },
+      });
+      return response.body.testCases;
+    } catch (err: unknown) {
+      throw new FirebaseError(`Failed to upsert test cases ${getErrMsg(err)}`);
+    }
+  }
 }

src/appdistribution/types.ts

@@ -128,3 +128,38 @@ export interface ReleaseTest {
   loginCredential?: LoginCredential;
   testCase?: string;
 }
+
+export interface AiStep {
+  goal: string;
+  hint?: string;
+  successCriteria?: string;
+}
+
+export interface AiInstructions {
+  steps: AiStep[];
+}
+
+export interface TestCase {
+  name?: string;
+  displayName: string;
+  prerequisiteTestCase?: string;
+  aiInstructions: AiInstructions;
+}
+
+export interface ListTestCasesResponse {
+  testCases: TestCase[];
+  nextPageToken?: string;
+}
+
+export interface UpdateTestCaseRequest {
+  testCase: TestCase;
+  allowMissing?: boolean;
+}
+
+export interface BatchUpdateTestCasesRequest {
+  requests: UpdateTestCaseRequest[];
+}
+
+export interface BatchUpdateTestCasesResponse {
+  testCases: TestCase[];
+}

src/appdistribution/yaml_helper.spec.ts

@@ -0,0 +1,119 @@
+import { TestCase } from "./types";
+import * as jsYaml from "js-yaml";
+import { fromYaml, toYaml } from "./yaml_helper";
+import { expect } from "chai";
+
+const APP_NAME = "projects/12345/apps/1:12345:android:beef";
+
+const TEST_CASE: TestCase = {
+  displayName: "test-display-name",
+  name: "projects/12345/apps/1:12345:android:beef/testCases/test-case-id",
+  prerequisiteTestCase:
+    "projects/12345/apps/1:12345:android:beef/testCases/prerequisite-test-case-id",
+  aiInstructions: {
+    steps: [
+      {
+        goal: "test-goal",
+        hint: "test-hint",
+        successCriteria: "test-success-criteria",
+      },
+    ],
+  },
+};
+
+const YAML_STRING = `- 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",
+    },
+  ],
+};
+
+describe("YamlHelper", () => {
+  it("converts TestCase[] to YAML string", () => {
+    const yamlString = toYaml([TEST_CASE]);
+    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]);
+  });
+
+  it("throws error if displayName is missing", () => {
+    expect(() =>
+      fromYaml(
+        APP_NAME,
+        `- steps:
+  - goal: test-goal
+    hint: test-hint
+    successCriteria: test-success-criteria
+`,
+      ),
+    ).to.throw(/"displayName" is required/);
+  });
+
+  it("throws error if steps is missing", () => {
+    expect(() => fromYaml(APP_NAME, `- displayName: test-display-name`)).to.throw(
+      /"steps" is required/,
+    );
+  });
+
+  it("throws error if goal is missing", () => {
+    expect(() =>
+      fromYaml(
+        APP_NAME,
+        `- displayName: test-display-name
+  steps:
+    - hint: test-hint
+      successCriteria: test-success-criteria
+`,
+      ),
+    ).to.throw(/"goal" is required/);
+  });
+
+  it("throws error if additional property is present in test case", () => {
+    expect(() =>
+      fromYaml(
+        APP_NAME,
+        `- displayName: test-display-name
+  extraTestCaseProperty: property
+  steps:
+    - goal: test-goal
+`,
+      ),
+    ).to.throw(/unexpected property "extraTestCaseProperty"/);
+  });
+
+  it("throws error if additional property is present in step", () => {
+    expect(() =>
+      fromYaml(
+        APP_NAME,
+        `- displayName: test-display-name
+  steps:
+    - goal: test-goal
+      extraStepProperty: property
+`,
+      ),
+    ).to.throw(/unexpected property "extraStepProperty"/);
+  });
+
+  it("throws error if YAML is invalid", () => {
+    expect(() => fromYaml(APP_NAME, "this is not YAML")).to.throw();
+  });
+});