@alwaysmeticulous/cli 2.17.0 → 2.18.0

package/dist/parallel-tests/run-all-tests.d.ts

@@ -1,14 +1,14 @@
 import { ReplayExecutionOptions } from "@alwaysmeticulous/common";
 import { TestRunStatus } from "../api/test-run.api";
 import { ScreenshotAssertionsEnabledOptions } from "../command-utils/common-types";
-import { TestCaseResult } from "../config/config.types";
+import { DetailedTestCaseResult, TestCaseResult } from "../config/config.types";
 import { TestRunProgress } from "./run-all-tests.types";
 export interface Options {
     testsFile: string | null;
     executionOptions: ReplayExecutionOptions;
     screenshottingOptions: ScreenshotAssertionsEnabledOptions;
     apiToken: string | null;
-    commitSha: string | null;
+    commitSha: string;
     /**
      * The base commit to compare test results against for test cases that don't have a baseReplayId specified.
      */
@@ -22,8 +22,13 @@ export interface Options {
      */
     parallelTasks: number | null;
     deflake: boolean;
-    useCache: boolean;
     githubSummary: boolean;
+    /**
+     * If provided it will incorportate the cachedTestRunResults in any calls to store
+     * test run results in the BE, but won't include the cachedTestRunResults in the returned
+     * RunAllTestsResult.
+     */
+    cachedTestRunResults?: TestCaseResult[];
     onTestRunCreated?: (testRun: TestRun & {
         status: "Running";
     }) => void;
@@ -35,7 +40,7 @@ export interface RunAllTestsResult {
     testRun: TestRun & {
         status: "Success" | "Failure";
     };
-    testCaseResults: TestCaseResult[];
+    testCaseResults: DetailedTestCaseResult[];
 }
 export interface TestRun {
     id: string;
@@ -43,4 +48,8 @@ export interface TestRun {
     status: TestRunStatus;
     progress: TestRunProgress;
 }
-export declare const runAllTests: ({ testsFile, apiToken, commitSha: commitSha_, baseCommitSha, appUrl, useAssetsSnapshottedInBaseSimulation, executionOptions, screenshottingOptions, parallelTasks, deflake, useCache, githubSummary, onTestRunCreated, onTestFinished, }: Options) => Promise<RunAllTestsResult>;
+/**
+ * Runs all the test cases in the provided file.
+ * @returns The results of the tests that were executed (note that this does not include results from any cachedTestRunResults passed in)
+ */
+export declare const runAllTests: ({ testsFile, apiToken, commitSha, baseCommitSha, appUrl, useAssetsSnapshottedInBaseSimulation, executionOptions, screenshottingOptions, parallelTasks, deflake, cachedTestRunResults: cachedTestRunResults_, githubSummary, onTestRunCreated, onTestFinished: onTestFinished_, }: Options) => Promise<RunAllTestsResult>;

package/dist/parallel-tests/run-all-tests.js

@@ -12,27 +12,31 @@ const config_1 = require("../config/config");
 const deflake_tests_handler_1 = require("../deflake-tests/deflake-tests.handler");
 const replay_assets_1 = require("../local-data/replay-assets");
 const parallel_tests_handler_1 = require("../parallel-tests/parallel-tests.handler");
-const commit_sha_utils_1 = require("../utils/commit-sha.utils");
 const config_utils_1 = require("../utils/config.utils");
 const github_summary_utils_1 = require("../utils/github-summary.utils");
 const run_all_tests_utils_1 = require("../utils/run-all-tests.utils");
 const version_utils_1 = require("../utils/version.utils");
-const runAllTests = async ({ testsFile, apiToken, commitSha: commitSha_, baseCommitSha, appUrl, useAssetsSnapshottedInBaseSimulation, executionOptions, screenshottingOptions, parallelTasks, deflake, useCache, githubSummary, onTestRunCreated, onTestFinished, }) => {
+/**
+ * Runs all the test cases in the provided file.
+ * @returns The results of the tests that were executed (note that this does not include results from any cachedTestRunResults passed in)
+ */
+const runAllTests = async ({ testsFile, apiToken, commitSha, baseCommitSha, appUrl, useAssetsSnapshottedInBaseSimulation, executionOptions, screenshottingOptions, parallelTasks, deflake, cachedTestRunResults: cachedTestRunResults_, githubSummary, onTestRunCreated, onTestFinished: onTestFinished_, }) => {
     if (appUrl != null && useAssetsSnapshottedInBaseSimulation) {
         throw new Error("Arguments useAssetsSnapshottedInBaseSimulation and appUrl are mutually exclusive");
     }
     const logger = loglevel_1.default.getLogger(common_1.METICULOUS_LOGGER_NAME);
     const client = (0, client_1.createClient)({ apiToken });
+    const cachedTestRunResults = cachedTestRunResults_ !== null && cachedTestRunResults_ !== void 0 ? cachedTestRunResults_ : [];
     const config = await (0, config_1.readConfig)(testsFile || undefined);
-    const testCases = config.testCases || [];
-    if (!testCases.length) {
+    const allTestCases = config.testCases || [];
+    if (!allTestCases.length) {
         throw new Error("Error! No test case defined");
     }
-    const commitSha = (await (0, commit_sha_utils_1.getCommitSha)(commitSha_)) || "unknown";
+    // Only run the uncached test cases
+    const testCases = allTestCases.filter(({ sessionId, baseReplayId, title }) => !cachedTestRunResults.find((cached) => cached.sessionId === sessionId &&
+        cached.baseReplayId === baseReplayId &&
+        cached.title === title));
     const meticulousSha = await (0, version_utils_1.getMeticulousVersion)();
-    const cachedTestRunResults = useCache
-        ? await (0, test_run_api_1.getCachedTestRunResults)({ client, commitSha })
-        : [];
     const replayEventsDependencies = await (0, replay_assets_1.loadReplayEventsDependencies)();
     const testRun = await (0, test_run_api_1.createTestRun)({
         client,
@@ -47,19 +51,57 @@ const runAllTests = async ({ testsFile, apiToken, commitSha: commitSha_, baseCom
         status: "Running",
         progress: {
             failedTestCases: 0,
-            passedTestCases: 0,
+            passedTestCases: cachedTestRunResults.length,
             runningTestCases: testCases.length,
         },
     });
     logger.info("");
     logger.info(`Test run URL: ${testRunUrl}`);
     logger.info("");
+    const testsToRun = await (0, run_all_tests_utils_1.getTestsToRun)({
+        testCases,
+        client,
+        baseCommitSha: baseCommitSha !== null && baseCommitSha !== void 0 ? baseCommitSha : null,
+    });
+    const storeTestRunResults = async (status, resultsSoFar) => {
+        const resultsToSendToBE = [
+            ...cachedTestRunResults,
+            ...resultsSoFar.map(
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            ({ screenshotDiffResults, ...result }) => result),
+        ];
+        try {
+            await (0, test_run_api_1.putTestRunResults)({
+                client,
+                testRunId: testRun.id,
+                status,
+                resultData: {
+                    results: resultsToSendToBE,
+                },
+            });
+        }
+        catch (error) {
+            logger.error(`Error while pushing partial results: ${error}`);
+        }
+    };
+    const onTestFinished = async (progress, resultsSoFar) => {
+        onTestFinished_ === null || onTestFinished_ === void 0 ? void 0 : onTestFinished_({
+            id: testRun.id,
+            url: testRunUrl,
+            status: "Running",
+            progress: {
+                ...progress,
+                passedTestCases: progress.passedTestCases + cachedTestRunResults.length,
+            },
+        });
+        await storeTestRunResults("Running", resultsSoFar);
+    };
     const getResults = async () => {
         if (parallelTasks == null || parallelTasks > 1) {
             const results = await (0, parallel_tests_handler_1.runAllTestsInParallel)({
                 config,
-                client,
                 testRun,
+                testsToRun,
                 executionOptions,
                 screenshottingOptions,
                 apiToken,
@@ -68,29 +110,14 @@ const runAllTests = async ({ testsFile, apiToken, commitSha: commitSha_, baseCom
                 useAssetsSnapshottedInBaseSimulation,
                 parallelTasks,
                 deflake,
-                cachedTestRunResults,
                 replayEventsDependencies,
-                baseCommitSha,
-                onTestFinished: (progress) => {
-                    onTestFinished === null || onTestFinished === void 0 ? void 0 : onTestFinished({
-                        id: testRun.id,
-                        url: testRunUrl,
-                        status: "Running",
-                        progress,
-                    });
-                },
+                onTestFinished,
             });
             return results;
         }
-        const results = [...cachedTestRunResults];
-        const testsToRun = await (0, run_all_tests_utils_1.getTestsToRun)({
-            testCases,
-            cachedTestRunResults,
-            client,
-            baseCommitSha: baseCommitSha !== null && baseCommitSha !== void 0 ? baseCommitSha : null,
-        });
+        const results = [];
         const progress = {
-            runningTestCases: testRun.length,
+            runningTestCases: testsToRun.length,
             failedTestCases: 0,
             passedTestCases: 0,
         };
@@ -115,30 +142,14 @@ const runAllTests = async ({ testsFile, apiToken, commitSha: commitSha_, baseCom
             progress.failedTestCases += result.result === "fail" ? 1 : 0;
             progress.passedTestCases += result.result === "pass" ? 1 : 0;
             --progress.runningTestCases;
-            onTestFinished === null || onTestFinished === void 0 ? void 0 : onTestFinished({
-                id: testRun.id,
-                url: testRunUrl,
-                status: "Running",
-                progress,
-            });
-            await (0, test_run_api_1.putTestRunResults)({
-                client,
-                testRunId: testRun.id,
-                status: "Running",
-                resultData: { results },
-            });
+            await onTestFinished(progress, results);
         }
         return (0, run_all_tests_utils_1.sortResults)({ results, testCases });
     };
     const results = await getResults();
     const runAllFailure = results.find(({ result }) => result === "fail");
     const overallStatus = runAllFailure ? "Failure" : "Success";
-    await (0, test_run_api_1.putTestRunResults)({
-        client,
-        testRunId: testRun.id,
-        status: overallStatus,
-        resultData: { results },
-    });
+    await storeTestRunResults(overallStatus, results);
     logger.info("");
     logger.info("Results");
     logger.info("=======");