feat(video): add audits recording litemode option

Author: j-mendez

.github/workflows/action.yml

@@ -18,3 +18,4 @@ jobs:
           TLD: true
           LIST: true
           UPGRADE: true
+          RECORD: /recordings

README.md

@@ -21,6 +21,7 @@ When running locally the action uses A11yWatch Lite.
     LIST: true
     FIX: false
     UPGRADE: false
+    RECORD: false
     COMPUTER_VISION_SUBSCRIPTION_KEY: ${{ secrets.COMPUTER_VISION_SUBSCRIPTION_KEY }}
     COMPUTER_VISION_ENDPOINT: ${{ secrets.COMPUTER_VISION_ENDPOINT }}
 ```
@@ -38,6 +39,7 @@ All inputs are **optional** except $WEBSITE_URL.
 | `SITEMAP`                          | Extend crawl with sitemap links (required SITE_WIDE=true).                                                                                                                                                               | true           |
 | `TLD`                              | Include all tld extensions (required SITE_WIDE=true).                                                                                                                                                                    | true           |
 | `LIST`                             | Report the results to github as a pass or fail list or detailed report.                                                                                                                                                  | false          |
+| `RECORD`                           | Record the audit as video to a directory.                                                                                                                                                                                 |                |
 | `FAIL_TOTAL_COUNT`                 | Determine whether to fail the CI if total issues warnings and errors exceed the counter. Takes precedence over the other FAIL inputs.                                                                                    | 0              |
 | `FAIL_ERRORS_COUNT`                | Determine whether to fail the CI if total issues with errors exceed the counter.                                                                                                                                         | 0              |
 | `FAIL_WARNINGS_COUNT`              | Determine whether to fail the CI if total issues with warnings exceed the counter.                                                                                                                                       | 0              |

action.yml

@@ -37,6 +37,10 @@ inputs:
     description: Include all TLD extensions.
     required: false
     default: false
+  RECORD:
+    description: Enable video recording audits to a directory location.
+    required: false
+    default: ""
   FAIL_TOTAL_COUNT:
     description: Use to fail the CI if the amount of issues of type errors and warnings is greater than the count.
     required: false
@@ -108,6 +112,15 @@ runs:
         restore-keys: |
           ${{ runner.os }}-yarn-
 
+    - name: Cache playwright binaries
+      if: ${{ inputs.EXTERNAL == 'false' }}
+      uses: actions/cache@v3
+      id: playwright-cache
+      with:
+        path: |
+          ~/.cache/ms-playwright
+        key: ${{ runner.os }}-playwright-${{ env.PLAYWRIGHT_VERSION }}
+
     - name: Cache cargo crates
       uses: actions/cache@v3
       id: cache-cargo
@@ -135,15 +148,15 @@ runs:
       uses: baptiste0928/cargo-install@v1
       with:
         crate: a11ywatch_cli
-        version: "0.10.4"
+        version: "0.10.7"
         features: "grpc"
 
     - name: A11yWatch CLI Install
       if: ${{ inputs.SLIM == 'false' }}
       uses: baptiste0928/cargo-install@v1
       with:
         crate: a11ywatch_cli
-        version: "0.10.4"
+        version: "0.10.7"
 
     - name: Configure CLI creds
       if: ${{ inputs.A11YWATCH_TOKEN }}
@@ -160,11 +173,32 @@ runs:
       shell: bash
       run: a11ywatch --set-cv-url ${{ inputs.COMPUTER_VISION_ENDPOINT }}
 
+    - name: Configure Recording
+      if: ${{ inputs.RECORD }}
+      shell: bash
+      run: a11ywatch --set-recording ${{ inputs.RECORD && inputs.RECORD != 'true' && inputs.RECORD || '/recordings' }}
+
+    - name: Configure Recording
+      if: ${{ inputs.RECORD }}
+      shell: bash
+      run: a11ywatch --set-recording ${{ inputs.RECORD }}
+
+    - uses: FedericoCarboni/setup-ffmpeg@v2
+      if: ${{ inputs.RECORD && inputs.RECORD != 'false' }}
+
     - name: Build A11yWatch Service
       if: ${{ inputs.EXTERNAL == 'false' }}
       shell: bash
       run: a11ywatch build --standalone --local ${{ inputs.UPGRADE == 'true' && '--upgrade' || '' }}
 
+    - run: npx playwright install --with-deps
+      if: ${{ inputs.EXTERNAL == 'false' && steps.playwright-cache.outputs.cache-hit != 'true' }}
+      shell: bash
+
+    - run: npx playwright install-deps
+      if: ${{ inputs.EXTERNAL == 'false' && steps.playwright-cache.outputs.cache-hit != 'true' }}
+      shell: bash
+
     - name: Start A11yWatch Service
       if: ${{ inputs.EXTERNAL == 'false' }}
       shell: bash
@@ -273,6 +307,12 @@ runs:
         message: "fix(accessibility): add recommendations from scan"
         committer_name: GitHub Actions
 
+    - uses: actions/upload-artifact@v3
+      if: ${{ inputs.RECORD && inputs.RECORD != 'false' && failure() || success() }}
+      with:
+        name: Recordings
+        path: ${{ inputs.RECORD && inputs.RECORD != 'false' && inputs.RECORD || '/recordings'  }}
+
     - name: Stop A11yWatch Service
       if: ${{ !inputs.EXTERNAL }}
       shell: bash