[patch] fixed synchronous logs addition plus added tests for assertions

src/common/command-names.ts

@@ -6,6 +6,20 @@ export const COMMAND_REQUEST = 'request';
 export type CommandLog = {
   attributes?: { name?: string; commandLogId?: string; consoleProps?: () => any; message?: string; error?: any };
 };
+
+export type CyLog = {
+  name?: string;
+  commandLogId?: string;
+  consoleProps?: () => any;
+  message?: string;
+  chainerId?: string;
+  error?: any;
+  err?: any;
+  end?: boolean;
+  ended?: boolean;
+  state?: string;
+};
+
 export type CommandT = {
   state?: string;
   // eslint-disable-next-line @typescript-eslint/no-explicit-any

src/setup/cypress-events.ts

@@ -12,6 +12,7 @@ import {
   filterCommandLog,
   ignoreAllCommands,
   isGherkin,
+  CyLog,
   stepMessage,
   stringify,
   withTry,
@@ -22,6 +23,7 @@ const UNCAUGHT_EXCEPTION_NAME = 'uncaught exception';
 const UNCAUGHT_EXCEPTION_STATUS = 'broken' as Status;
 const failedStatus = 'failed' as Status;
 const passedStatus = 'passed' as Status;
+const brokenStatus = 'broken' as Status;
 
 type OneRequestConsoleProp = {
   'Request Body': unknown;
@@ -255,14 +257,38 @@ export const handleCyLogEvents = (
     gherkinLog.current = undefined;
   });
 
-  Cypress.on('log:added', log => {
+  Cypress.on('log:added', (log: CyLog) => {
     if (!allureLogCyCommands()) {
       return;
     }
 
     withTry('report log:added', () => {
-      const cmdMessage = stepMessage(log.name, log.message === 'null' ? '' : log.message);
-      const logName = log.name;
+      const logName = log.name ?? 'no-log-name';
+      const logMessage = log.message;
+      const chainerId = log.chainerId;
+      const end = log.end || log.ended;
+      const logState = log.state;
+
+      const cmdMessage = stepMessage(logName, logMessage === 'null' ? '' : logMessage);
+
+      // console.log(log);
+
+      if (!chainerId && end) {
+        // synchronous log without commands
+        Cypress.Allure.startStep(cmdMessage);
+
+        let status = passedStatus;
+
+        if (logName === 'WARNING') {
+          status = brokenStatus;
+        }
+
+        if (logState === 'failed') {
+          status = failedStatus;
+        }
+
+        Cypress.Allure.endStep(status);
+      }
 
       if (isGherkin(logName)) {
         if (gherkinLog.current) {
@@ -327,6 +353,10 @@ export const handleCyLogEvents = (
           details = { message: err?.message, trace: err?.stack };
         }
 
+        if (logName === 'WARNING') {
+          state = brokenStatus;
+        }
+
         Cypress.Allure.endStep(state, details);
       });
   };

src/setup/process-tags.ts

@@ -17,9 +17,8 @@ export const processTagsOnTestStart = (test: Mocha.Test) => {
         const [urlOrId, name] = t.info ?? [];
 
         if (!urlOrId) {
-          Cypress.log({ message: `WARN: tag @${tagNoAt} tag should have id: @${tagNoAt}("idOrUrl")` }).error(
-            new Error(),
-          );
+          const message = `tag @${tagNoAt} tag should have id: @${tagNoAt}("idOrUrl")`;
+          Cypress.log({ name: 'WARNING', message }).error(new Error());
           break;
         }
         Cypress.Allure[tagNoAt](urlOrId, name);
@@ -31,9 +30,8 @@ export const processTagsOnTestStart = (test: Mocha.Test) => {
         const [urlOrId, name, type] = t.info ?? [];
 
         if (!urlOrId) {
-          Cypress.log({ message: `WARN: Tag @${tagNoAt} should have id or url: @${tagNoAt}("idOrUrl")` }).error(
-            new Error(),
-          );
+          const message = `tag @${tagNoAt} should have id or url: @${tagNoAt}("idOrUrl")`;
+          Cypress.log({ name: 'WARNING', message }).error(new Error());
 
           break;
         }
@@ -72,9 +70,8 @@ export const processTagsOnTestStart = (test: Mocha.Test) => {
         const [singleValue] = t.info ?? [];
 
         if (!singleValue) {
-          Cypress.log({ message: `WARN: tag @${tagNoAt} tag should have value: @${tagNoAt}("value")` }).error(
-            new Error(),
-          );
+          const message = `tag @${tagNoAt} tag should have value: @${tagNoAt}("value")`;
+          Cypress.log({ name: 'WARNING', message }).error(new Error());
           break;
         }
         Cypress.Allure[tagNoAt](singleValue as Severity);
@@ -86,9 +83,8 @@ export const processTagsOnTestStart = (test: Mocha.Test) => {
         const [name, value] = t.info ?? [];
 
         if (!name) {
-          Cypress.log({
-            message: `WARN: tag @${tagNoAt} tag should have name and/or value: @${tagNoAt}("myLabel","value")`,
-          }).error(new Error());
+          const message = `tag @${tagNoAt} tag should have name and/or value: @${tagNoAt}("myLabel","value")`;
+          Cypress.log({ name: 'WARNING', message }).error(new Error());
           break;
         }
         Cypress.Allure.label(name, value);

tests/cy-helper/utils.ts

@@ -298,12 +298,22 @@ export const fullStepAttachment = (
 export const fullStepMap = (
   res: AllureTest,
   mapStep?: (m: StepResult) => any,
+  filterStep?: (m: StepResult) => boolean,
 ) => {
   const skipItems = ['generatereport', 'coverage'];
 
-  return mapSteps(res.steps as StepResult[], mapStep, z =>
-    skipItems.every(y => z.name?.toLowerCase().indexOf(y) === -1),
-  );
+  return mapSteps(res.steps as StepResult[], mapStep, z => {
+    const includesNoSkippedSteps = skipItems.every(
+      y => z.name?.toLowerCase().indexOf(y) === -1,
+    );
+    const isFiltered = filterStep?.(z);
+
+    if (isFiltered === undefined) {
+      return includesNoSkippedSteps;
+    }
+
+    return includesNoSkippedSteps && isFiltered;
+  });
 };
 
 // eslint-disable-next-line jest/no-export
@@ -458,17 +468,23 @@ export const createResTest2 = (
         attempt(retries);
       });
     };
+    const video = parseBoolean(envConfig?.video ?? `${true}`);
+    // todo fix video
+    console.log(`video:${video}`);
 
     return cy
       .run({
-        spec,
+        spec: spec as string,
         specPattern: 'integration/e2e/**/*.(cy|test|spec).ts',
         port,
         browser: 'chrome',
-        trashAssetsBeforeRuns: true,
         env,
         quiet: `${process.env.QUIET}` === 'true',
-        video: parseBoolean(envConfig?.video ?? `${true}`),
+        video,
+        // config: {
+        //   ...config,
+        //   trashAssetsBeforeRuns: true,
+        // },
       })
       .catch(e => {
         err = e as Error;
@@ -582,17 +598,17 @@ export const covergeAfterAll = [
     start: 1323475200000,
     status: 'passed',
     steps: [
-      // {
-      //   attachments: [],
-      //   name: 'Coverage: Generating report [@cypress/code-coverage]',
-      //   parameters: [],
-      //   stage: 'finished',
-      //   start: 1323475200000,
-      //   status: 'passed',
-      //   statusDetails: {},
-      //   steps: [],
-      //   stop: 1323475200011,
-      // },
+      {
+        attachments: [],
+        name: 'Coverage: Generating report [@cypress/code-coverage]',
+        parameters: [],
+        stage: 'finished',
+        start: 1323475200000,
+        status: 'passed',
+        statusDetails: {},
+        steps: [],
+        stop: 1323475200011,
+      },
     ],
     stop: 1323475200010,
   },
@@ -607,17 +623,17 @@ export const covergeBeforeAll = [
     start: 1323475200000,
     status: 'passed',
     steps: [
-      // {
-      //   attachments: [],
-      //   name: 'Coverage: Reset [@cypress/code-coverage]',
-      //   parameters: [],
-      //   stage: 'finished',
-      //   start: 1323475200000,
-      //   status: 'passed',
-      //   statusDetails: {},
-      //   steps: [],
-      //   stop: 1323475200011,
-      // },
+      {
+        attachments: [],
+        name: 'Coverage: Reset [@cypress/code-coverage]',
+        parameters: [],
+        stage: 'finished',
+        start: 1323475200000,
+        status: 'passed',
+        statusDetails: {},
+        steps: [],
+        stop: 1323475200011,
+      },
     ],
     stop: 1323475200010,
   },
@@ -657,6 +673,7 @@ export type TestData = {
       testName: string;
       index?: number;
       mapStep?: (m: StepResult) => any;
+      filterStep?: (m: StepResult) => boolean;
       expected: any[];
     }[];
 
@@ -813,10 +830,14 @@ export const generateChecksTests = (res: Result, testsForRun: TestData[]) => {
           it(`steps for test ${testItem.testName} ${testItem.index ?? ''}`, () => {
             const tests = getTest(resFixed, testItem.testName);
 
-            const obj = fullStepMap(tests[testItem.index ?? 0]!, m => ({
-              name: m.name,
-              ...(testItem.mapStep?.(m) ?? {}),
-            }));
+            const obj = fullStepMap(
+              tests[testItem.index ?? 0]!,
+              m => ({
+                name: m.name,
+                ...(testItem.mapStep?.(m) ?? {}),
+              }),
+              testItem.filterStep,
+            );
 
             wrapError(() => expect(obj).toEqual(testItem.expected));
           });

tests/test-folder/mocha-events/assertions/assertions.test.ts

@@ -0,0 +1,18 @@
+import {
+  createResTest2,
+  generateChecksTests,
+  selectTestsToRun,
+} from '@test-utils';
+import { basename } from 'path';
+
+describe(`suite: ${basename(__dirname)}`, () => {
+  const testsForOneCyRun = selectTestsToRun(__dirname);
+
+  const res = createResTest2(
+    testsForOneCyRun.map(x => x.spec),
+    // video false to speedup
+    { allureAddVideoOnPass: 'false', video: 'false' /* DEBUG: 'true'*/ },
+  );
+
+  generateChecksTests(res, testsForOneCyRun);
+});

tests/test-folder/mocha-events/assertions/data-assertions-one-failed-for-command.ts

@@ -0,0 +1,87 @@
+import { TestData } from '@test-utils';
+import { basename } from 'path';
+import { visitHtmlCode } from './visit-html';
+
+const rootSuite = `${basename(__filename)}`;
+
+const data: TestData = {
+  name: rootSuite,
+  rootSuite,
+  fileName: __filename,
+  spec: `
+describe('${rootSuite}', { defaultCommandTimeout: 300 },() => {
+  ${visitHtmlCode}
+
+  it('test 1', () => {
+    cy.get('[data-test-id="item"]').should('contain', 'NonExistent');
+  });
+});
+    `,
+
+  expect: {
+    testsNames: [`${rootSuite} test 1`],
+
+    testStatuses: [
+      {
+        testName: 'test 1',
+        index: 0,
+        status: 'failed',
+        statusDetails: {
+          message: [
+            "Timed out retrying after 300ms: expected '[ <div>, 4 more... ]' to contain 'NonExistent'",
+          ],
+        },
+      },
+    ],
+
+    testAttachments: [
+      {
+        expectMessage: 'should have no attachments',
+        testName: 'test 1',
+        index: 0,
+        attachments: [
+          {
+            name: 'data-assertions-one-failed-for-command.ts -- test 1 (failed).png',
+            source: 'source.png',
+            type: 'image/png',
+          },
+        ],
+      },
+    ],
+
+    testSteps: [
+      {
+        testName: 'test 1',
+        index: 0,
+        mapStep: m => ({
+          status: m.status,
+          attachments: m.attachments,
+          statusDetails: m.statusDetails,
+        }),
+        filterStep: m =>
+          ['before each', 'after each'].every(
+            x => m.name && m.name.indexOf(x) === -1,
+          ),
+        expected: [
+          {
+            attachments: [],
+            name: 'get: [data-test-id="item"]',
+            status: 'failed',
+            statusDetails: {},
+            steps: [
+              {
+                attachments: [],
+                name: 'assert: expected **[ <div>, 4 more... ]** to contain **NonExistent**',
+                status: 'failed',
+                statusDetails: {},
+                steps: [],
+              },
+            ],
+          },
+        ],
+      },
+    ],
+  },
+};
+
+export default data;