Add A11y and Allure Report

Author: rkazakov

.env.default

@@ -2,5 +2,6 @@ BASE_URL=https://www.bear.plus
 HEADLESS=false
 ACCESSIBILITY=false
 DEVICE_SCALE_FACTOR=2
+OUTPUT_PATH=output
 RECORD_HAR=false
 HAR_PATH=output/har/requests.har

.github/workflows/e2e-test-automation.yml

@@ -2,6 +2,11 @@ name: E2E Test Automation
 
 on: [ push ]
 
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
 jobs:
   chrome:
     timeout-minutes: 30
@@ -23,13 +28,13 @@ jobs:
         env:
           BASE_URL: ${{ vars.BASE_URL }}
           HEADLESS: ${{ vars.HEADLESS }}
-          OUTPUT_PATH: output-chrome
+          OUTPUT_PATH: ${{ vars.OUTPUT_PATH }}
 
       - uses: actions/upload-artifact@v3
         if: always()
         with:
           name: chrome-artifacts
-          path: output-chrome
+          path: ${{ vars.OUTPUT_PATH }}
           retention-days: 30
 
   firefox:
@@ -52,7 +57,7 @@ jobs:
         env:
           BASE_URL: ${{ vars.BASE_URL }}
           HEADLESS: ${{ vars.HEADLESS }}
-          OUTPUT_PATH: output-firefox
+          OUTPUT_PATH: ${{ vars.OUTPUT_PATH }}
           # Workaround to fix GitHub Actions issue:
           # Running Nightly as root in a regular user's session is not supported.
           # See https://github.com/microsoft/playwright/issues/6500
@@ -62,7 +67,7 @@ jobs:
         if: always()
         with:
           name: firefox-artifacts
-          path: output-firefox
+          path: ${{ vars.OUTPUT_PATH }}
           retention-days: 30
 
   safari:
@@ -85,11 +90,70 @@ jobs:
         env:
           BASE_URL: ${{ vars.BASE_URL }}
           HEADLESS: ${{ vars.HEADLESS }}
-          OUTPUT_PATH: output-safari
+          OUTPUT_PATH: ${{ vars.OUTPUT_PATH }}
 
       - uses: actions/upload-artifact@v3
         if: always()
         with:
           name: safari-artifacts
-          path: output-safari
-          retention-days: 30
+          path: ${{ vars.OUTPUT_PATH }}
+          retention-days: 30
+
+  report:
+    timeout-minutes: 30
+    runs-on: ubuntu-latest
+    container:
+      image: mcr.microsoft.com/playwright:v1.38.1-jammy
+    environment:
+      url: ${{ steps.deployment.outputs.page_url }}
+      name: 'github-pages'
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 'latest'
+      - uses: actions/setup-java@v3
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run Chrome scenarios
+        run: npm run test:chrome
+        env:
+          BASE_URL: ${{ vars.BASE_URL }}
+          HEADLESS: ${{ vars.HEADLESS }}
+          OUTPUT_PATH: ${{ vars.OUTPUT_PATH }}
+
+      - uses: actions/upload-artifact@v3
+        if: always()
+        with:
+          name: report-artifacts
+          path: ${{ vars.OUTPUT_PATH }}
+          retention-days: 30
+
+      - name: Generate Allure report
+        if: always()
+        run: npm run report:generate
+
+      - name: Patch Allure report
+        if: always()
+        run: npm run report:patch
+
+      - name: Setup GitHub Pages
+        if: always()
+        uses: actions/configure-pages@v3
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        if: always()
+        with:
+          path: ${{ vars.OUTPUT_PATH }}/allure-report
+
+      - name: Deploy to GitHub Pages
+        if: always()
+        id: deployment
+        uses: actions/deploy-pages@v2

README.md

@@ -6,17 +6,18 @@ Modern E2E Test Automation suite that supports cross-browser testing, parallel e
 ## Tech stack
 - [CodeceptJS](https://codecept.io)
 - [Playwright](https://playwright.dev)
-- [Axe](https://www.deque.com/axe)
+- [Deque Axe](https://www.deque.com/axe)
 - [Typescript](https://www.typescriptlang.org)
 
 ## Features
 - ✅ Cross-browser testing (Chrome, Firefox, Safari)
 - ✅ Headless and headful modes
 - ✅ Parallel execution
-- ✅ Accessibility testing with Axe
 - ✅ Screenshot and video recording
 - ✅ Playwright tracing
 - ✅ HTTP Archive (HAR) files generation and replay
+- ✅ Accessibility testing with Axe
+- ✅ Reporting with Allure Report
 
 ## Installation
 
@@ -48,6 +49,8 @@ ACCESSIBILITY=false
 # keep 1 for most monitors
 # set to 2 for MacBook Pro screen to avoid flickering
 DEVICE_SCALE_FACTOR=1
+# Reports, traces, screenshots, videos output path
+OUTPUT_PATH=output
 # Generate HTTP Archive (HAR) file from test scenario
 RECORD_HAR=false
 # HAR file path
@@ -59,11 +62,6 @@ HAR_PATH=output/har/requests.har
 npm run test:all
 ```
 
-### Run all test scenarios in parallel
-```sh
-npm run test:parallel
-```
-
 ### Run a specific browser
 ```sh
 npm run test:chrome
@@ -75,3 +73,7 @@ npm run test:safari
 ```sh
 npx codeceptjs run tests/bear-plus.spec.ts --steps
 ```
+
+## Pipeline
+
+[![Pipeline](https://github.com/bear-plus/codeceptjs-playwright-typescript-boilerplate/actions/workflows/e2e-test-automation.yml/badge.svg)](https://github.com/bear-plus/codeceptjs-playwright-typescript-boilerplate/actions/workflows/e2e-test-automation.yml)

codecept.conf.ts

@@ -19,14 +19,17 @@ export const config: CodeceptJS.MainConfig = {
       emulate: {
         deviceScaleFactor: process.env.DEVICE_SCALE_FACTOR ? parseInt(process.env.DEVICE_SCALE_FACTOR) : 1,
         recordHar: process.env.RECORD_HAR === 'true' ? {
-          path: './output/har/requests.har',
+          path: `${process.env.OUTPUT_PATH}/har/requests.har`,
           mode: 'full',
         } : undefined,
       },
       waitForTimeout: 45_000,
       waitForNavigation: 'load',
       keepVideoForPassedTests: false,
-      keepTraceForPassedTests: false,
+      keepTraceForPassedTests: true,
+    },
+    A11yHelper: {
+      require: 'codeceptjs-a11y-helper',
     },
   },
   include: {
@@ -52,5 +55,10 @@ export const config: CodeceptJS.MainConfig = {
     stepByStepReport: {
       enabled: true
     },
+    allure: {
+      enabled: true,
+      require: 'allure-codeceptjs',
+      outputDir: `${process.env.OUTPUT_PATH}/allure`,
+    },
   }
 }