[minor] setting for screenshots (#84)

Author: mmisty

.github/workflows/build.yml

@@ -99,7 +99,7 @@ jobs:
           fi
           
           echo "publishing alpha, for other commit message should contain [minor], [major] or [patch]/[fix]"
-          npm run publish:alpha
-          git push --tags    
+          npm run publish:alpha || publish:alpha:init || true
+          git push --tags || true
 
 

CHANGELOG.md

@@ -1,6 +1,10 @@
 ## Change Log
+### 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
 

README.pack.md

@@ -37,6 +37,8 @@ Example report is here - [Allure Report example](https://mmisty.github.io/cypres
 5. [Examples](#examples)
 5. [Allure TestOps](#allure-testops)
 5. [Troubleshooting](#troubleshooting)
+6. See also:
+   - [adding screenshots](docs/screenshots.md)
 6. [Credits](#credits)
 6. [Change log](#change-log)
 6. [Support](#support)

docs/screenshots.md

@@ -0,0 +1,13 @@
+## Screenshots
+
+By default, adapter adds all screenshots to a test.
+
+There is possibility to attach screenshots made by 
+`cy.screenshot` command to a step.
+
+To attach to a step use 
+setting to screenshot command
+
+```typescript
+cy.screenshot({ allureAttachToStep: true });
+```

integration/e2e/attachments/screenshots-no-name.cy.ts

@@ -0,0 +1,48 @@
+import { visitHtml } from '../../common/helper';
+
+Cypress.env('allureSkipCommands', 'screenshot');
+describe('screenshot', () => {
+  describe('screenshot - no name @screen', () => {
+    beforeEach(() => {
+      visitHtml();
+    });
+
+    it('test 1 - should have 1 step screenshot', () => {
+      cy.allure().startStep('step 1');
+      cy.screenshot({ allureAttachToStep: true });
+      cy.allure().endStep();
+    });
+
+    it('test 1.1 - should have 1 step screenshot for element', () => {
+      cy.allure().startStep('step 1');
+      cy.get('div').first().screenshot({ allureAttachToStep: true });
+      cy.allure().endStep();
+    });
+
+    it('test 2 - should have 1 step screenshot and one test screenshot', () => {
+      cy.allure().startStep('step 1');
+      cy.screenshot({ allureAttachToStep: true });
+      cy.screenshot();
+      cy.allure().endStep();
+    });
+
+    it('test 2.1 - should have 1 step screenshot and one test screenshot for element', () => {
+      cy.allure().startStep('step 1');
+      cy.get('div').first().screenshot({ allureAttachToStep: true });
+      cy.get('div').eq(1).screenshot();
+      cy.allure().endStep();
+    });
+
+    it('test 3 - should have 1 test screenshot', () => {
+      cy.allure().startStep('step 1');
+      cy.screenshot();
+      cy.allure().endStep();
+    });
+
+    it('test 3.1 - should have 1 test screenshot for element', () => {
+      cy.allure().startStep('step 1');
+      cy.get('div').first().screenshot();
+      cy.allure().endStep();
+    });
+  });
+});

integration/e2e/attachments/screenshots-with-name.cy.ts

@@ -0,0 +1,48 @@
+import { visitHtml } from '../../common/helper';
+
+Cypress.env('allureSkipCommands', 'screenshot');
+describe('screenshot', () => {
+  describe('screenshot with name @screen', () => {
+    beforeEach(() => {
+      visitHtml();
+    });
+
+    it('test 1 - should have 1 step screenshot', () => {
+      cy.allure().startStep('step 1');
+      cy.screenshot('my-step', { allureAttachToStep: true });
+      cy.allure().endStep();
+    });
+
+    it('test 1.1 - should have 1 step screenshot for element', () => {
+      cy.allure().startStep('step 1');
+      cy.get('div').first().screenshot('my-element', { allureAttachToStep: true });
+      cy.allure().endStep();
+    });
+
+    it('test 2 - should have 1 step screenshot and one test screenshot', () => {
+      cy.allure().startStep('step 1');
+      cy.screenshot('my-step', { allureAttachToStep: true });
+      cy.screenshot('my-test');
+      cy.allure().endStep();
+    });
+
+    it('test 2.1 - should have 1 step screenshot and one test screenshot for element', () => {
+      cy.allure().startStep('step 1');
+      cy.get('div').first().screenshot('my-step', { allureAttachToStep: true });
+      cy.get('div').eq(1).screenshot('my-test');
+      cy.allure().endStep();
+    });
+
+    it('test 3 - should have 1 test screenshot', () => {
+      cy.allure().startStep('step 1');
+      cy.screenshot('my-test');
+      cy.allure().endStep();
+    });
+
+    it('test 3.1 - should have 1 test screenshot for element', () => {
+      cy.allure().startStep('step 1');
+      cy.get('div').first().screenshot('my-test');
+      cy.allure().endStep();
+    });
+  });
+});

package.json

@@ -55,7 +55,8 @@
     "prepublish": "npm run lint",
     "prepublishOnly": "{ echo \"Run script 'npm run publish:pack', 'npm run publish:minor', etc from package.json\n\"; exit 1; }",
     "publishPack": "npm run pack && cd lib && npm publish --tag $TAG",
-    "publish:alpha": "export TAG=alpha && export ver=$(semver $(npm show . version --tag alpha) --increment -i prerelease  --preid 'alpha') && npm run publishPack && npm run postpublish",
+    "publish:alpha": "export TAG=alpha && export ver=$(semver $(npm show . version --tag alpha || npm show . version) --increment -i prerelease  --preid 'alpha') && npm run publishPack && npm run postpublish",
+    "publish:alpha:init": "export TAG=alpha && export ver=$(semver $(npm show . version) --increment -i prerelease  --preid 'alpha') && npm run publishPack && npm run postpublish",
     "publish:patch": "export TAG=latest && export ver=$(semver $(npm show . version) --increment -i patch) && npm run publishPack && npm run postpublish",
     "publish:minor": "export TAG=latest && export ver=$(semver $(npm show . version) --increment -i minor) && npm run publishPack && npm run postpublish",
     "publish:major": "export TAG=latest && export ver=$(semver $(npm show . version) --increment -i major) && npm run publishPack && npm run postpublish",

src/commands/index.ts

@@ -86,6 +86,23 @@ export const registerCommands = () => {
     return cmd?.get('prev')?.attributes?.subject;
   };
 
+  // first arg may be JQuery
+  Cypress.Commands.overwrite('screenshot', function (originalFn, ...args) {
+    const setSettingAttachToStep = (res: boolean) => {
+      (window as unknown as { allureAttachToStep: boolean }).allureAttachToStep = res;
+    };
+
+    const getAllureAttachToStep = (obj: unknown) => {
+      return obj && typeof obj === 'object' && (obj as any).allureAttachToStep;
+    };
+
+    const toStep = args.some(t => getAllureAttachToStep(t));
+
+    setSettingAttachToStep(toStep);
+
+    return originalFn(...args);
+  });
+
   // not changing the subject
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   Cypress.Commands.add('doSyncCommand', function (syncFn: (subj: any) => any) {

src/cypress/types.ts

@@ -1,5 +1,12 @@
 // eslint-disable-next-line @typescript-eslint/no-unused-vars,@typescript-eslint/no-namespace
 declare namespace Cypress {
+  interface ScreenshotOptions {
+    /**
+     * Add screenshot to a step when true, otherwise to a test
+     */
+    allureAttachToStep: boolean;
+  }
+
   export type Status = 'passed' | 'failed' | 'skipped' | 'broken' | 'unknown';
   export type CommandT = {
     state?: string;

src/plugins/allure-reporter-plugin.ts

@@ -109,7 +109,7 @@ const copyFileToWatch = async (
  * Get all attachments for test to move them to watch folder
  * @param item test item
  */
-const getAllAttachments = (item: ExecutableItem) => {
+const getAllAttachments = (item: ExecutableItem): Attachment[] => {
   const attachmentsResult: Attachment[] = [];
 
   const inner = (steps: ExecutableItem[], accumulatedRes: Attachment[]): Attachment[] => {
@@ -866,12 +866,14 @@ export class AllureReporter {
         console.error(`${packageLog} Result file doesn't exist: ${file}`);
       }
     };
-    waitResultWritten(this.allureResults, `${this.allureResults}/${uid}-result.json`);
+    const testFile = `${this.allureResults}/${uid}-result.json`;
+
+    waitResultWritten(this.allureResults, testFile);
 
     // move to watch
 
     log('testEnded: will move result to watch folder');
-    await copyFileToWatch({ test: `${this.allureResults}/${uid}-result.json`, attachments }, this.allureResultsWatch);
+    await copyFileToWatch({ test: testFile, attachments }, this.allureResultsWatch);
   }
 
   startStep(arg: AllureTaskArgs<'stepStarted'>) {

src/setup/cypress-events.ts

@@ -466,12 +466,6 @@ export const handleCyLogEvents = (
   Cypress.Allure.on('cmd:started', (command: CommandT) => {
     const { name, isLog, message: cmdMessage, args } = commandParams(command);
 
-    if (name === 'screenshot') {
-      // add screenshot to report
-      const screenName = command.attributes?.args[0] ?? 'anyName';
-      emit({ task: 'screenshotOne', arg: { forStep: true, name: screenName } });
-    }
-
     if (!isLogCommand(isLog, name) || !allureLogCyCommands()) {
       return;
     }

src/setup/screenshots.ts

@@ -15,9 +15,15 @@ export const registerScreenshotHandler = () => {
     const [{ path }] = args;
 
     if (path) {
-      // todo setting
-      debug(`Attaching: ${path}`);
-      Cypress.Allure.testFileAttachment(basename(path), path, getContentType(path));
+      const win = window as unknown as { allureAttachToStep: boolean };
+
+      if (win.allureAttachToStep) {
+        debug(`Attaching to step: ${path}`);
+        Cypress.Allure.fileAttachment(basename(path), path, getContentType(path));
+      } else {
+        debug(`Attaching to test: ${path}`);
+        Cypress.Allure.testFileAttachment(basename(path), path, getContentType(path));
+      }
     } else {
       debug(`No path: ${JSON.stringify(args)}`);
     }

tests/cy-helper/utils.ts

@@ -38,6 +38,11 @@ export const fixResult = (results: AllureTest[]): AllureTest[] => {
       ...s,
       start: date,
       stop: date + 11,
+      attachments: s.attachments.map(t => ({
+        ...t,
+        name: t.name.replace(/\d{5,}/g, 'number'),
+        source: `source${path.extname(t.source)}`,
+      })),
       steps: replaceSteps(s.steps),
     }));
   };