[patch] fix for describe.only and describe.skip (#89)

Author: mmisty

CHANGELOG.md

@@ -1,10 +1,16 @@
 ## Change Log
+### 0.16.1
+- [patch] fixes for isse #88 - fixed describe.only and describe.skip
+
 ### 0.16.0
 - [minor] setting to attach screenshots to a steps by options to cy.screeshot command
+
 ### 0.15.3
 - [patch] fix moving test attachments during execution for test
+
 ### 0.15.2 
 - [patch] minor packages updates
+
 ### 0.15.1
 - [patch] fix of corner case with custom commands in #75
 

integration/e2e/skip/skip-suite.cy.ts

@@ -0,0 +1,13 @@
+describe.skip('skipped', () => {
+  beforeEach(() => {
+    cy.log('before each for skipped');
+  });
+
+  it('test', function () {
+    cy.log('skipped');
+  });
+
+  afterEach(() => {
+    cy.log('after each for skipped');
+  });
+});

package-lock.json

@@ -118,7 +118,7 @@
     "webpack": "^5.89.0"
   },
   "dependencies": {
-    "@mmisty/cypress-tags": "^1.0.14",
+    "@mmisty/cypress-tags": "^1.0.15",
     "allure-js-commons": "^2.9.2",
     "allure-js-parser": "^0.0.7",
     "debug": "^4.3.4",

package.json

@@ -3,6 +3,8 @@ import { parseInlineTags } from '@mmisty/cypress-tags/utils/tags';
 
 export const addGherkin = () => {
   const originalDesc = describe;
+  const originalDescSkip = describe.skip;
+  const originalDescOnly = describe.only;
 
   const getTags = (test: any): { tag: string; info: string }[] => {
     // this is tags support for @badeball/cypress-cucumber-preprocessor
@@ -18,15 +20,22 @@ export const addGherkin = () => {
 
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore
-  (global as any).describe = function (...args) {
+  const parseTags = original =>
     // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore
-    const suite: Suite = originalDesc(...args);
+    function (...args) {
+      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+      // @ts-ignore
+      const suite: Suite = original(...args);
 
-    suite.eachTest((test: any) => {
-      test.tags = getTags(test);
-    });
+      suite.eachTest((test: any) => {
+        test.tags = getTags(test);
+      });
 
-    return suite;
-  };
+      return suite;
+    };
+
+  (global as any).describe = parseTags(originalDesc);
+  (global as any).describe.skip = parseTags(originalDescSkip);
+  (global as any).describe.only = parseTags(originalDescOnly);
 };

src/setup/setup-gherkin.ts

@@ -0,0 +1,49 @@
+import { createResTest2, fixResult } from '../../../cy-helper/utils';
+import { parseAllure } from 'allure-js-parser';
+
+describe('several tests run by describe.only', () => {
+  const res = createResTest2(
+    [
+      `
+describe.only('hello suite', () => {
+  it('hello test 1', () => {
+    cy.log('message');
+  });
+  
+  it('hello test 2', () => {
+    cy.log('message');
+  });
+  
+  it('hello test 3', () => {
+    cy.log('message');
+  });
+  
+  it('hello test 4', () => {
+    cy.log('message');
+  });
+});
+`,
+    ],
+    { allureAddVideoOnPass: 'true' },
+  );
+
+  describe('check results', () => {
+    let resFixed;
+
+    beforeAll(() => {
+      const results = parseAllure(res.watch);
+      resFixed = fixResult(results);
+    });
+
+    it('check tests count', async () => {
+      expect(resFixed.length).toEqual(4);
+    });
+
+    it('check results', async () => {
+      expect((res.result.res as any)?.totalSkipped).toEqual(0);
+      expect((res.result.res as any)?.totalPending).toEqual(0);
+      expect((res.result.res as any)?.totalPassed).toEqual(4);
+      expect((res.result.res as any)?.totalFailed).toEqual(0);
+    });
+  });
+});

tests/test-folder/mocha-events/only/only-describe.test.ts

@@ -0,0 +1,49 @@
+import { createResTest2, fixResult } from '../../../cy-helper/utils';
+import { parseAllure } from 'allure-js-parser';
+
+describe('several tests skipped by describe.skip', () => {
+  const res = createResTest2(
+    [
+      `
+describe.skip('hello suite', () => {
+  it('hello test 1', () => {
+    cy.log('message');
+  });
+  
+  it('hello test 2', () => {
+    cy.log('message');
+  });
+  
+  it('hello test 3', () => {
+    cy.log('message');
+  });
+  
+  it('hello test 4', () => {
+    cy.log('message');
+  });
+});
+`,
+    ],
+    { allureAddVideoOnPass: 'true' },
+  );
+
+  describe('check results', () => {
+    let resFixed;
+
+    beforeAll(() => {
+      const results = parseAllure(res.watch);
+      resFixed = fixResult(results);
+    });
+
+    it('check tests count', async () => {
+      expect(resFixed.length).toEqual(4);
+    });
+
+    it('check results', async () => {
+      expect((res.result.res as any)?.totalFailed).toEqual(0);
+      expect((res.result.res as any)?.totalPassed).toEqual(0);
+      expect((res.result.res as any)?.totalSkipped).toEqual(0);
+      expect((res.result.res as any)?.totalPending).toEqual(4);
+    });
+  });
+});