@empiricalrun/test-gen 0.17.6 → 0.18.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @empiricalrun/test-gen
 
+## 0.18.0
+
+### Minor Changes
+
+- 4390c31: fix: filter video based on test name
+
 ## 0.17.6
 
 ### Patch Changes

package/dist/bin/index.js

@@ -29,6 +29,7 @@ async function runAgent(sourceFile, testGenConfig) {
         await (0, run_1.generateTestsUsingBrowsingAgent)(specPath);
         await (0, reporter_1.reportTestGenVideos)({
             projectRepoName: testGenConfig.options.metadata.projectRepoName,
+            testName: testCase.name,
         });
     }
     else {

package/dist/reporter/index.d.ts

@@ -10,8 +10,9 @@ export declare function getReporter(): Reporter | undefined;
  * }
  * @returns Promise<void> returns void
  */
-export declare function reportTestGenVideos({ projectRepoName, }: {
+export declare function reportTestGenVideos({ projectRepoName, testName, }: {
     projectRepoName: string;
+    testName: string;
 }): Promise<void>;
 export declare function setReporterConfig(config: any): void;
 //# sourceMappingURL=index.d.ts.map

package/dist/reporter/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/reporter/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAA4B,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAW5E,wBAAgB,WAAW,IAAI,QAAQ,GAAG,SAAS,CAUlD;AAED;;;;;;;;;GASG;AACH,wBAAsB,mBAAmB,CAAC,EACxC,eAAe,GAChB,EAAE;IACD,eAAe,EAAE,MAAM,CAAC;CACzB,iBA4BA;AAED,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,GAAG,GAAG,IAAI,CAGnD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/reporter/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAA4B,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAW5E,wBAAgB,WAAW,IAAI,QAAQ,GAAG,SAAS,CAUlD;AAED;;;;;;;;;GASG;AACH,wBAAsB,mBAAmB,CAAC,EACxC,eAAe,EACf,QAAQ,GACT,EAAE;IACD,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;CAClB,iBA6BA;AAED,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,GAAG,GAAG,IAAI,CAGnD"}

package/dist/reporter/index.js

@@ -28,7 +28,7 @@ exports.getReporter = getReporter;
  * }
  * @returns Promise<void> returns void
  */
-async function reportTestGenVideos({ projectRepoName, }) {
+async function reportTestGenVideos({ projectRepoName, testName, }) {
     const logger = new logger_1.CustomLogger();
     try {
         if (!(0, uploader_1.checkIfResultsUploadAllowed)()) {
@@ -36,6 +36,7 @@ async function reportTestGenVideos({ projectRepoName, }) {
         }
         const { videoUrls } = await (0, uploader_1.uploadTestResultsUsingPrjtRepo)({
             projectRepoName,
+            testName,
         });
         const reporter = getReporter();
         const reporterMessage = `
@@ -44,7 +45,7 @@ async function reportTestGenVideos({ projectRepoName, }) {
   
   ${videoUrls
             .map((url) => `
-  <video src="${url}" autoplay="true" muted="true" controls loop playsinline></video>`)
+  <video src="${url}" autoplay="true" muted="true" controls playsinline></video>`)
             .join("\n")}
     `;
         await reporter?.report(new reporter_1.ProcessLogMessageBuilder({ message: reporterMessage }));

package/dist/uploader/index.d.ts

@@ -1,11 +1,16 @@
 /**
- * function to upload test results to r2 using the project repo name
- * this only uploads json summary of test results
- * @param { projectName: string } projectRepoName - name of the project repo
- * @returns urls of videos and summary json
+ * Function to upload test results to R2 using the project repo name and test name.
+ * This function uploads both the JSON summary of test results and associated video files.
+ * @param {Object} params - The parameters for the function.
+ * @param {string} params.projectRepoName - Name of the project repository.
+ * @param {string} params.testName - Name of the testcase which called this test-gen.
+ * @returns {Promise<Object>} An object containing arrays of video URLs and the summary JSON URL.
+ * @returns {string[]} returns.videoUrls - URLs of the uploaded video files.
+ * @returns {string} returns.summaryUrl - URL of the uploaded summary JSON file.
  */
-export declare function uploadTestResultsUsingPrjtRepo({ projectRepoName, }: {
+export declare function uploadTestResultsUsingPrjtRepo({ projectRepoName, testName, }: {
     projectRepoName: string;
+    testName: string;
 }): Promise<{
     videoUrls: string[];
     summaryUrl: string;

package/dist/uploader/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/uploader/index.ts"],"names":[],"mappings":"AAiBA;;;;;GAKG;AACH,wBAAsB,8BAA8B,CAAC,EACnD,eAAe,GAChB,EAAE;IACD,eAAe,EAAE,MAAM,CAAC;CACzB,GAAG,OAAO,CAAC;IACV,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC,CAyBD;AAED,wBAAgB,2BAA2B,uBAQ1C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/uploader/index.ts"],"names":[],"mappings":"AAmBA;;;;;;;;;GASG;AACH,wBAAsB,8BAA8B,CAAC,EACnD,eAAe,EACf,QAAQ,GACT,EAAE;IACD,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;CAClB,GAAG,OAAO,CAAC;IACV,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC,CAgDD;AAED,wBAAgB,2BAA2B,uBAQ1C"}

package/dist/uploader/index.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.checkIfResultsUploadAllowed = exports.uploadTestResultsUsingPrjtRepo = void 0;
+const reporter_1 = require("@empiricalrun/reporter");
 const path_1 = __importDefault(require("path"));
 const r2_1 = require("./r2");
 // json summary of test results
@@ -15,12 +16,16 @@ function getFullUploadPath(filePath, uploadDir) {
     return `${UPLOAD_DOMAIN}/${uploadDir}${relativeFilePath}`;
 }
 /**
- * function to upload test results to r2 using the project repo name
- * this only uploads json summary of test results
- * @param { projectName: string } projectRepoName - name of the project repo
- * @returns urls of videos and summary json
+ * Function to upload test results to R2 using the project repo name and test name.
+ * This function uploads both the JSON summary of test results and associated video files.
+ * @param {Object} params - The parameters for the function.
+ * @param {string} params.projectRepoName - Name of the project repository.
+ * @param {string} params.testName - Name of the testcase which called this test-gen.
+ * @returns {Promise<Object>} An object containing arrays of video URLs and the summary JSON URL.
+ * @returns {string[]} returns.videoUrls - URLs of the uploaded video files.
+ * @returns {string} returns.summaryUrl - URL of the uploaded summary JSON file.
  */
-async function uploadTestResultsUsingPrjtRepo({ projectRepoName, }) {
+async function uploadTestResultsUsingPrjtRepo({ projectRepoName, testName, }) {
     const uploadUniqueId = crypto.randomUUID();
     // project repo name is the github repo name
     // the folder names in r2 are the github repo name without the `-tests` suffix
@@ -30,12 +35,29 @@ async function uploadTestResultsUsingPrjtRepo({ projectRepoName, }) {
         destinationDir: uploadDir,
         uploadBucket: UPLOAD_BUCKET,
     });
-    const fileNames = Object.keys(files);
-    // TODO: parse the json summary and then detect video attachments
+    const fileNames = Object.keys(files); // fileNames are absolute paths of the input files
+    const defaultLocation = path_1.default.join(process.cwd(), "test-results", "summary.json");
+    const results = (0, reporter_1.parseJsonReport)(defaultLocation);
+    const flatTestsList = (0, reporter_1.getFlattenedTestList)(results.suites);
+    const testVideos = [];
+    for (const test of flatTestsList) {
+        if (test.title === testName) {
+            if (test.tests[0]) {
+                if (test.tests[0].results[0]) {
+                    // results array is basically made by retries
+                    for (const attachments of test.tests[0].results[0].attachments) {
+                        if (attachments.path) {
+                            testVideos.push(attachments.path);
+                        }
+                    }
+                }
+            }
+        }
+    }
     // current assumption
     // - test gen will only run on a single spec file
-    // - the video files will be of format <spec-file-name>.webm
-    const videoFiles = fileNames.filter((fileName) => fileName.endsWith(".webm"));
+    // - the video files are of the format - <some-directory>/video.webm
+    const videoFiles = fileNames.filter((fileName) => fileName.endsWith(".webm") && testVideos.includes(fileName));
     return {
         videoUrls: videoFiles.map((fileName) => getFullUploadPath(fileName, uploadDir)),
         summaryUrl: getFullUploadPath("/test-results/summary.json", uploadDir),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empiricalrun/test-gen",
-  "version": "0.17.6",
+  "version": "0.18.0",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -18,6 +18,7 @@
     "@actions/core": "^1.10.1",
     "@aws-sdk/client-s3": "^3.614.0",
     "@aws-sdk/s3-request-presigner": "^3.614.0",
+    "@playwright/test": "^1.44.1",
     "@types/sanitize-html": "^2.11.0",
     "commander": "^12.1.0",
     "detect-port": "^1.6.1",