[@typespec/spector] [@typespec/spec-coverage-sdk] - Handle Upload Sce…

…nario Manifest (#4920)

Earlier, in the `upload-scenario-manifest` script, I had handled the
multiple paths in a different way (one by one). After working with the
`cadl-ranch-dashboard`, the correct approach is to generate the manifest
file in the same way as coverage file. This PR performs this task.

Here is a snapshot of the modified manifest file:


![image](https://github.com/user-attachments/assets/cf752245-452a-424f-b1ed-86b2965103a0)

Please review and approve the PR. Thanks

.chronus/changes/RefactorManifest-2024-9-30-14-30-49.md

@@ -0,0 +1,8 @@
+---
+changeKind: internal
+packages:
+  - "@typespec/spec-coverage-sdk"
+  - "@typespec/spector"
+---
+
+Handle multiple scenarios in manifest creation

.gitignore

@@ -129,6 +129,7 @@ lib-cov
 coverage
 !packages/spector/src/coverage
 spec-coverage.json
+manifest.json
 
 # nyc test coverage
 .nyc_output

packages/spec-coverage-sdk/CHANGELOG.md

@@ -1 +1,10 @@
-# @typespec/spec-coverage-sdk
+# Change Log - @typespec/spec-coverage-sdk
+
+## 0.1.0-alpha.1
+
+- Enabled uploading modified manifest file with details of more than one scenario paths.
+
+## 0.1.0-alpha.0
+
+- Initial release of the `@typespec/spec-coverage-sdk` package.
+

packages/spec-coverage-sdk/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typespec/spec-coverage-sdk",
-  "version": "0.1.0-alpha.0",
+  "version": "0.1.0-alpha.1",
   "description": "Spec utility to manage the reported coverage",
   "main": "dist/index.js",
   "type": "module",

packages/spec-coverage-sdk/src/client.ts

@@ -43,7 +43,7 @@ export class SpecManifestOperations {
     this.#blob = this.#container.getBlockBlobClient("manifest.json");
   }
 
-  public async upload(manifest: ScenarioManifest): Promise<void> {
+  public async upload(manifest: ScenarioManifest | ScenarioManifest[]): Promise<void> {
     const content = JSON.stringify(manifest, null, 2);
     await this.#blob.upload(content, content.length, {
       blobHTTPHeaders: {

packages/spec-coverage-sdk/src/types.ts

@@ -2,7 +2,7 @@ export type ScenarioManifest = {
   commit: string;
   version: string;
   scenarios: ScenarioData[];
-  modes: string[];
+  setName: string;
 };
 
 export type ScenarioData = {

packages/spector/CHANGELOG.md

@@ -1 +1,13 @@
-# @typespec/spector
+# Change Log - @typespec/spector
+
+## 0.1.0-alpha.2
+
+- Fix the handling of multiple scenario paths in `manifest.json` file.
+
+## 0.1.0-alpha.1
+
+- Enabled handling of multiple scenario paths
+
+## 0.1.0-alpha.0
+
+- Initial release of the `@typespec/spector` package.

packages/spector/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typespec/spector",
-  "version": "0.1.0-alpha.1",
+  "version": "0.1.0-alpha.2",
   "description": "Typespec Core Tool to validate, run mock api, collect coverage.",
   "exports": {
     ".": {

packages/spector/src/actions/upload-scenario-manifest.ts

@@ -1,28 +1,37 @@
 import { AzureCliCredential } from "@azure/identity";
 import { SpecCoverageClient } from "@typespec/spec-coverage-sdk";
 import { writeFile } from "fs/promises";
+import { resolve } from "path";
 import pc from "picocolors";
 import { computeScenarioManifest } from "../coverage/scenario-manifest.js";
 import { logger } from "../logger.js";
 
 export interface UploadScenarioManifestConfig {
-  scenariosPath: string;
+  scenariosPaths: string[];
   storageAccountName: string;
+  setName: string;
 }
 
 export async function uploadScenarioManifest({
-  scenariosPath,
+  scenariosPaths,
   storageAccountName,
+  setName,
 }: UploadScenarioManifestConfig) {
-  const [manifest, diagnostics] = await computeScenarioManifest(scenariosPath);
-  if (manifest === undefined || diagnostics.length > 0) {
-    process.exit(-1);
+  const manifests = [];
+  for (const scenariosPath of scenariosPaths) {
+    const path = resolve(process.cwd(), scenariosPath);
+    logger.info(`Computing scenario manifest for ${path}`);
+    const [manifest, diagnostics] = await computeScenarioManifest(path, setName);
+    if (manifest === undefined || diagnostics.length > 0) {
+      process.exit(-1);
+    }
+    manifests.push(manifest);
   }
 
-  await writeFile("manifest.json", JSON.stringify(manifest, null, 2));
+  await writeFile("manifest.json", JSON.stringify(manifests, null, 2));
   const client = new SpecCoverageClient(storageAccountName, new AzureCliCredential());
   await client.createIfNotExists();
-  await client.manifest.upload(manifest);
+  await client.manifest.upload(manifests);
 
   logger.info(
     `${pc.green("✓")} Scenario manifest uploaded to ${storageAccountName} storage account.`,

packages/spector/src/cli/cli.ts

@@ -287,20 +287,23 @@ async function main() {
             array: true,
             demandOption: true,
           })
+          .option("setName", {
+            type: "string",
+            description: "Set used to generate the manifest.",
+            demandOption: true,
+          })
           .option("storageAccountName", {
             type: "string",
             description: "Name of the storage account",
           })
           .demandOption("storageAccountName");
       },
       async (args) => {
-        for (const scenariosPath of args.scenariosPaths) {
-          logger.info(`Uploading scenario manifest for scenarios at ${scenariosPath}`);
-          await uploadScenarioManifest({
-            scenariosPath: resolve(process.cwd(), scenariosPath),
-            storageAccountName: args.storageAccountName,
-          });
-        }
+        await uploadScenarioManifest({
+          scenariosPaths: args.scenariosPaths,
+          storageAccountName: args.storageAccountName,
+          setName: args.setName,
+        });
       },
     )
     .command(

packages/spector/src/coverage/scenario-manifest.ts

@@ -1,13 +1,14 @@
 import { loadScenarios } from "../scenarios-resolver.js";
 import { Diagnostic } from "../utils/diagnostic-reporter.js";
 import { getCommit, getPackageJson } from "../utils/misc-utils.js";
-import { ScenarioLocation, ScenarioManifest, GeneratorMode } from "@typespec/spec-coverage-sdk";
+import { ScenarioLocation, ScenarioManifest } from "@typespec/spec-coverage-sdk";
 import { getSourceLocation, normalizePath } from "@typespec/compiler";
 import { relative } from "path";
 import type { Scenario } from "../lib/decorators.js";
 
 export async function computeScenarioManifest(
   scenariosPath: string,
+  setName: string
 ): Promise<[ScenarioManifest | undefined, readonly Diagnostic[]]> {
   const [scenarios, diagnostics] = await loadScenarios(scenariosPath);
   if (diagnostics.length > 0) {
@@ -16,14 +17,15 @@ export async function computeScenarioManifest(
 
   const commit = getCommit(scenariosPath);
   const pkg = await getPackageJson(scenariosPath);
-  return [createScenarioManifest(scenariosPath, pkg?.version ?? "?", commit, scenarios), []];
+  return [createScenarioManifest(scenariosPath, pkg?.version ?? "?", commit, scenarios, setName), []];
 }
 
 export function createScenarioManifest(
   scenariosPath: string,
   version: string,
   commit: string,
   scenarios: Scenario[],
+  setName: string
 ): ScenarioManifest {
   const sortedScenarios = [...scenarios].sort((a, b) => a.name.localeCompare(b.name));
   return {
@@ -38,6 +40,6 @@ export function createScenarioManifest(
       };
       return { name, scenarioDoc, location };
     }),
-    modes: GeneratorMode,
+    setName
   };
 }