[minor] Allure TestOps: move passed results to watch folder right away (#48)

Author: mmisty

integration/e2e/watch.cy.ts

@@ -0,0 +1,30 @@
+describe('should move passed test right away @watch', () => {
+  describe('more suite', () => {
+    before(() => {
+      cy.allure().step('some setup');
+    });
+
+    for (let i = 0; i < 10; i++) {
+      it(`test ${i}`, () => {
+        cy.allure().step('hello');
+        cy.allure().startStep('with attach');
+        cy.allure().attachment('out', `test number ${i}`, 'text/plain');
+        cy.allure().endStep();
+
+        cy.allure().startStep('with attach other');
+        cy.allure().attachment('out2', `test number ${i} - attach 2`, 'text/plain');
+        cy.allure().endStep();
+
+        cy.allure().startStep('may fail');
+        cy.wait(1000);
+
+        if (i % 5 === 0) {
+          cy.wrap(null).then(() => {
+            throw new Error('on purpose');
+          });
+        }
+        cy.allure().endStep();
+      });
+    }
+  });
+});

package-lock.json

@@ -88,7 +88,7 @@
     "@typescript-eslint/eslint-plugin": "^5.44.0",
     "@typescript-eslint/parser": "^5.44.0",
     "allure-commandline": "^2.24.0",
-    "cypress": "^13.3.0",
+    "cypress": "^13.3.3",
     "cypress-redirect-browser-log": "^1.1.2",
     "eslint": "^8.46.0",
     "eslint-config-prettier": "^8.5.0",

package.json

@@ -3,6 +3,7 @@ import {
   AllureRuntime,
   AllureStep,
   AllureTest,
+  Attachment,
   ExecutableItem,
   ExecutableItemWrapper,
   FixtureResult,
@@ -732,7 +733,7 @@ export class AllureReporter {
     }
   }
 
-  endTest(arg: AllureTaskArgs<'testEnded'>) {
+  endTest(arg: AllureTaskArgs<'testEnded'>): { test: string; attachments: any[] } | undefined {
     const { result, details } = arg;
     const storedStatus = this.testStatusStored;
     const storedDetails = this.testDetailsStored;
@@ -751,7 +752,7 @@ export class AllureReporter {
     this.endAllSteps({ status: result, details });
 
     if (!this.currentTest) {
-      return;
+      return undefined;
     }
     // filter steps here
     this.filterSteps(this.currentTest.wrappedItem);
@@ -768,8 +769,20 @@ export class AllureReporter {
 
     this.applyGroupLabels();
     const uid = this.currentTest.uuid;
-    this.currentTest.endTest();
 
+    const getAllAttach = (res: Attachment[], item: ExecutableItem) => {
+      if (!this.currentTest) {
+        return [];
+      }
+      item.steps.forEach(step => {
+        res.push(...getAllAttach(res, step));
+      });
+
+      return [...res, ...item.attachments];
+    };
+    const resAtt: Attachment[] = [...this.currentTest.wrappedItem.attachments];
+    const attachments = getAllAttach(resAtt, this.currentTest.wrappedItem);
+    this.currentTest.endTest();
     this.tests.pop();
     this.descriptionHtml = [];
     this.testStatusStored = undefined;
@@ -788,6 +801,8 @@ export class AllureReporter {
       }
     };
     waitResultWritten(this.allureResults, `${this.allureResults}/${uid}-result.json`);
+
+    return { test: `${this.allureResults}/${uid}-result.json`, attachments };
   }
 
   startStep(arg: AllureTaskArgs<'stepStarted'>) {

src/plugins/allure-reporter-plugin.ts

@@ -4,7 +4,7 @@ import { AllureTaskArgs, AllureTasks, Status } from './allure-types';
 import { appendFileSync, copyFile, existsSync, mkdirSync, readFileSync, rm, rmSync, writeFileSync } from 'fs';
 import { delay, packageLog } from '../common';
 import glob from 'fast-glob';
-import { basename, dirname } from 'path';
+import path, { basename, dirname } from 'path';
 
 const debug = Debug('cypress-allure:proxy');
 
@@ -24,6 +24,66 @@ export type ReporterOptions = {
   isTest: boolean;
 };
 
+const copyFileToWatch = async (
+  input: { test: string; attachments: { name: string; type: string; source: string }[] },
+  allureResultsWatch: string,
+) => {
+  const { test: allureResultFile, attachments } = input;
+  const allureResults = path.dirname(allureResultFile);
+
+  if (allureResults === allureResultsWatch) {
+    log(`afterSpec allureResultsWatch the same as allureResults ${allureResults}, will not copy`);
+
+    return;
+  }
+
+  if (!existsSync(allureResultsWatch)) {
+    const mkdirSyncWithTry = (dir: string) => {
+      for (let i = 0; i < 5; i++) {
+        try {
+          mkdirSync(dir);
+
+          return;
+        } catch (err) {
+          // ignore
+        }
+      }
+    };
+    mkdirSyncWithTry(allureResultsWatch);
+  }
+  log(`allureResults: ${allureResults}`);
+  log(`allureResultsWatch: ${allureResultsWatch}`);
+  log(`attachments: ${JSON.stringify(attachments)}`);
+
+  attachments.forEach(attach => {
+    const attachTo = `${allureResultsWatch}/${attach.source}`;
+    const attachFrom = `${allureResults}/${attach.source}`;
+
+    log(`attachTo ${attachTo}`);
+    log(`attachFrom ${attachFrom}`);
+
+    copyFile(attachFrom, attachTo, err => {
+      if (err) {
+        log(err);
+      }
+      rm(attachFrom, () => {
+        // ignore
+      });
+    });
+  });
+
+  const to = `${allureResultsWatch}/${basename(allureResultFile)}`;
+  log(`copy file ${allureResultFile} to ${to}`);
+  copyFile(allureResultFile, to, err => {
+    if (err) {
+      log(err);
+    }
+    rm(allureResultFile, () => {
+      // ignore
+    });
+  });
+};
+
 const copyResultsToWatchFolder = async (allureResults: string, allureResultsWatch: string) => {
   if (allureResults === allureResultsWatch) {
     log(`afterSpec allureResultsWatch the same as allureResults ${allureResults}, will not copy`);
@@ -240,7 +300,14 @@ export const allureTasks = (opts: ReporterOptions): AllureTasks => {
 
     testEnded: async (arg: AllureTaskArgs<'testEnded'>) => {
       log(`testEnded ${JSON.stringify(arg)}`);
-      allureReporter.endTest(arg);
+      const res = allureReporter.endTest(arg);
+
+      if (res && !opts.allureAddVideoOnPass && arg.result === 'passed') {
+        // move to watch
+
+        log('testEnded: will move result to watch folder');
+        await copyFileToWatch(res, allureResultsWatch);
+      }
       log('testEnded');
     },