chore: add back allure (#2247)

.github/actions/prune-vm/action.yml

@@ -0,0 +1,27 @@
+# Inspired by https://github.com/AdityaGarg8/remove-unwanted-software
+# to free up disk space. Currently removes Dotnet, Android and Haskell.
+name: Remove unwanted software
+description: Default GitHub runners come with a lot of unnecessary software
+runs:
+  using: "composite"
+  steps:
+    - name: Disk space report before modification
+      shell: bash
+      run: |
+        echo "==> Available space before cleanup"
+        echo
+        df -h
+    - name: Maximize build disk space
+      shell: bash
+      run: |
+          set -euo pipefail
+          sudo rm -rf /usr/share/dotnet
+          sudo rm -rf /usr/local/lib/android
+          sudo rm -rf /opt/ghc 
+          sudo rm -rf /usr/local/.ghcup
+    - name: Disk space report after modification
+      shell: bash
+      run: |
+          echo "==> Available space after cleanup"
+          echo
+          df -h

.github/workflows/ci.yml

@@ -124,6 +124,7 @@ jobs:
     with:
       nim_wakunode_image: ${{ inputs.nim_wakunode_image || 'wakuorg/nwaku:v0.31.0' }}
       test_type: node
+      allure_reports: true
 
   node_optional:
     uses: ./.github/workflows/test-node.yml

.github/workflows/test-node.yml

@@ -18,18 +18,24 @@ on:
         required: false
         type: string
         default: ''
+      allure_reports:
+        required: false
+        type: boolean
+        default: false
 
 env:
   NODE_JS: "20"
   # Ensure test type conditions remain consistent.
   WAKU_SERVICE_NODE_PARAMS: ${{ (inputs.test_type == 'go-waku-master') && '--min-relay-peers-to-publish=0' || '' }}
   DEBUG: ${{ inputs.debug }}
+  GITHUB_TOKEN: ${{ secrets.DEPLOY_TEST_REPORTS_PAT }}
 
 jobs:
   node:
     runs-on: ubuntu-latest
     env:
       WAKUNODE_IMAGE: ${{ inputs.nim_wakunode_image }}
+      ALLURE_REPORTS: ${{ inputs.allure_reports }}
     permissions:
       contents: read
       actions: read
@@ -39,6 +45,9 @@ jobs:
         with: 
           repository: waku-org/js-waku
 
+      - name: Remove unwanted software
+        uses: ./.github/actions/prune-vm
+
       - uses: actions/setup-node@v3
         with:
           node-version: ${{ env.NODE_JS }}
@@ -47,16 +56,42 @@ jobs:
 
       - run: npm run build:esm
 
-      - run: ${{ (inputs.test_type == 'node-optional') && 'npm run test:optional --workspace=@waku/tests' || 'npm run test:node' }}
+      - name: Run tests
+        timeout-minutes: 30
+        run: ${{ (inputs.test_type == 'node-optional') && 'npm run test:optional --workspace=@waku/tests' || 'npm run test:node' }}
+
+      - name: Merge allure reports
+        if: always() && env.ALLURE_REPORTS == 'true'
+        run: node ci/mergeAllureResults.cjs 
+
+      - name: Get allure history
+        if: always() && env.ALLURE_REPORTS == 'true'
+        uses: actions/checkout@v3
+        continue-on-error: true
+        with:
+          repository: waku-org/allure-jswaku
+          ref: gh-pages
+          path: gh-pages
+          token: ${{ env.GITHUB_TOKEN }}
 
-      - name: Test Report
-        uses: dorny/test-reporter@v1
-        if: success() || failure()
+      - name: Setup allure report
+        if: always() && env.ALLURE_REPORTS == 'true'
+        uses: simple-elf/allure-report-action@master
+        id: allure-report
         with:
-          name: Test Report - ${{ inputs.test_type }}
-          path: 'packages/tests/reports/mocha-*.json'
-          reporter: mocha-json
-          fail-on-error: true
+          allure_results: allure-results
+          gh_pages: gh-pages
+          allure_history: allure-history
+          keep_reports: 30
+
+      - name: Deploy report to Github Pages
+        if: always() && env.ALLURE_REPORTS == 'true'
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          personal_token: ${{ env.GITHUB_TOKEN }}
+          external_repository: waku-org/allure-jswaku
+          publish_branch: gh-pages
+          publish_dir: allure-history
 
       - name: Upload debug logs on failure
         uses: actions/upload-artifact@v4
@@ -83,3 +118,11 @@ jobs:
         with:
           name: ${{ inputs.test_type }}-logs
           path: packages/tests/log/
+
+      - name: Create test summary
+        if: always() && env.ALLURE_REPORTS == 'true'
+        run: |
+          echo "## Run Information" >> $GITHUB_STEP_SUMMARY
+          echo "- **NWAKU**: ${{ env.WAKUNODE_IMAGE }}" >> $GITHUB_STEP_SUMMARY
+          echo "## Test Results" >> $GITHUB_STEP_SUMMARY
+          echo "Allure report will be available at: https://waku-org.github.io/allure-jswaku/${{ github.run_number }}" >> $GITHUB_STEP_SUMMARY

ci/mergeAllureResults.cjs

@@ -0,0 +1,19 @@
+const fs = require("fs-extra");
+const glob = require("glob");
+
+const ROOT_ALLURE_RESULTS = "./allure-results"; // Target directory in the root
+
+fs.ensureDirSync(ROOT_ALLURE_RESULTS);
+
+const directories = glob.sync("packages/**/allure-results");
+
+directories.forEach((dir) => {
+  const files = fs.readdirSync(dir);
+  files.forEach((file) => {
+    const sourcePath = `${dir}/${file}`;
+    const targetPath = `${ROOT_ALLURE_RESULTS}/${file}`;
+    fs.copyFileSync(sourcePath, targetPath);
+  });
+});
+
+console.log("All allure-results directories merged successfully!");

packages/core/.mocha.reporters.json

@@ -0,0 +1,6 @@
+{
+    "reporterEnabled": "spec, allure-mocha",
+    "allureMochaReporter": {
+      "outputDir": "allure-results"
+    }
+  }

packages/core/.mocharc.cjs

@@ -15,13 +15,13 @@ if (process.env.CI) {
   console.log("Running tests in parallel");
   config.parallel = true;
   config.jobs = 6;
-  console.log("Using JSON reporter for test results");
-  config.reporter = 'json';
+  console.log("Activating allure reporting");
+  config.reporter = 'mocha-multi-reporters';
   config.reporterOptions = {
-    output: 'reports/mocha-results.json'
+    configFile: '.mocha.reporters.json'
   };
 } else {
   console.log("Running tests serially. To enable parallel execution update mocha config");
 }
 
-module.exports = config;
+module.exports = config;

packages/discovery/.mocha.reporters.json

@@ -0,0 +1,6 @@
+{
+    "reporterEnabled": "spec, allure-mocha",
+    "allureMochaReporter": {
+      "outputDir": "allure-results"
+    }
+  }

packages/discovery/.mocharc.cjs

@@ -15,10 +15,10 @@ if (process.env.CI) {
   console.log("Running tests in parallel");
   config.parallel = true;
   config.jobs = 6;
-  console.log("Using JSON reporter for test results");
-  config.reporter = 'json';
+  console.log("Activating allure reporting");
+  config.reporter = 'mocha-multi-reporters';
   config.reporterOptions = {
-    output: 'reports/mocha-results.json'
+    configFile: '.mocha.reporters.json'
   };
 } else {
   console.log("Running tests serially. To enable parallel execution update mocha config");

packages/enr/.mocha.reporters.json

@@ -0,0 +1,6 @@
+{
+    "reporterEnabled": "spec, allure-mocha",
+    "allureMochaReporter": {
+      "outputDir": "allure-results"
+    }
+  }

packages/enr/.mocharc.cjs

@@ -15,13 +15,12 @@ if (process.env.CI) {
   console.log("Running tests in parallel");
   config.parallel = true;
   config.jobs = 6;
-  console.log("Using JSON reporter for test results");
-  config.reporter = 'json';
+  console.log("Activating allure reporting");
+  config.reporter = 'mocha-multi-reporters';
   config.reporterOptions = {
-    output: 'reports/mocha-results.json'
+    configFile: '.mocha.reporters.json'
   };
 } else {
   console.log("Running tests serially. To enable parallel execution update mocha config");
 }
-
 module.exports = config;

packages/message-encryption/.mocha.reporters.json

@@ -0,0 +1,6 @@
+{
+    "reporterEnabled": "spec, allure-mocha",
+    "allureMochaReporter": {
+      "outputDir": "allure-results"
+    }
+  }

packages/message-encryption/.mocharc.cjs

@@ -15,13 +15,12 @@ if (process.env.CI) {
   console.log("Running tests in parallel");
   config.parallel = true;
   config.jobs = 6;
-  console.log("Using JSON reporter for test results");
-  config.reporter = 'json';
+  console.log("Activating allure reporting");
+  config.reporter = 'mocha-multi-reporters';
   config.reporterOptions = {
-    output: 'reports/mocha-results.json'
+    configFile: '.mocha.reporters.json'
   };
 } else {
   console.log("Running tests serially. To enable parallel execution update mocha config");
 }
-
 module.exports = config;

packages/message-hash/.mocha.reporters.json

@@ -0,0 +1,6 @@
+{
+    "reporterEnabled": "spec, allure-mocha",
+    "allureMochaReporter": {
+      "outputDir": "allure-results"
+    }
+  }

packages/message-hash/.mocharc.cjs

@@ -15,13 +15,12 @@ if (process.env.CI) {
   console.log("Running tests in parallel");
   config.parallel = true;
   config.jobs = 6;
-  console.log("Using JSON reporter for test results");
-  config.reporter = 'json';
+  console.log("Activating allure reporting");
+  config.reporter = 'mocha-multi-reporters';
   config.reporterOptions = {
-    output: 'reports/mocha-results.json'
+    configFile: '.mocha.reporters.json'
   };
 } else {
   console.log("Running tests serially. To enable parallel execution update mocha config");
 }
-
 module.exports = config;