Completed migration to mocha for integration tests

Author: hensmi-amazon

.github/actions/setup-integration-test/README.md

@@ -5,14 +5,16 @@ When an integration test or a browser compatibility test runs on GitHub actions,
 To better perform these steps in a reusable manner we created this composite action. The composite action is called by other workflows to setup the host and then the workflows will run whatever test they are running.
 
 ## Steps Performed
+- Check if integration tests are needed based on changes
 - Pack the Chime JS SDK and install the tarball into demo
-- Create a job ID
+- Create a job ID for SauceLabs
 - Set the job ID as an ENV variable
 - Echo job ID
 - Configure AWS credentials
-- Setup Sauce Connect
-- Install KITE
+- Setup Sauce Connect (for SauceLabs testing)
+- Setup Chrome (for local testing)
 - Clean install
+- Add testsite host to /etc/hosts (Linux only)
 
 ## Sauce Rest URL
 Sauce rest url is the datacenter endpoint used by Sauce Connect Proxy action as a parameter. The default url is https://saucelabs.com/rest/v1 and it is applicable for US-West region. The default url will be overwritten by calling workflows. You can learn more at [Data Center Endpoints](https://docs.saucelabs.com/basics/data-center-endpoints/#headless-us-east-data-center).

.github/actions/setup-integration-test/action.yml

@@ -35,8 +35,44 @@ runs:
     - name: Check if integration tests are needed
       id: test_needed
       run: |
-        source ${GITHUB_WORKSPACE}/integration/js/script/need-integ-test
-        check_if_integ_tests_required
+        # Check if integration tests are required based on changed files
+        base_branch=$(head -n 1 ${GITHUB_WORKSPACE}/.base-branch 2>/dev/null || echo "main")
+        commits=$(git rev-list $base_branch.. 2>/dev/null || echo "")
+        echo 'Commits:' $commits
+
+        requires_integration_test=false
+        if [ -n "$commits" ]; then
+          for commit in $commits
+          do
+            commit_files=$(git diff-tree --no-commit-id --name-only -r ${commit})
+            echo 'Committed files are:' $commit_files
+            matches=false
+            for committed_file in $commit_files
+            do
+              while read -r stem
+              do
+                if [[ $stem =~ ^#.* ]]; then
+                  continue
+                elif [[ $stem = "" ]]; then
+                  continue
+                elif [[ $stem =~ ^!.* ]]; then
+                  stem_string="${stem:1}"
+                  if [[ $committed_file = $stem_string* ]]; then
+                    matches=false
+                  fi
+                elif [[ $committed_file = $stem* ]]; then
+                  matches=true
+                fi
+              done < "${GITHUB_WORKSPACE}/.integration-watchlist"
+              if [[ $matches = true ]]; then
+                requires_integration_test=true
+                break
+              fi
+            done
+          done
+        fi
+
+        echo 'Need integration test:' $requires_integration_test
         echo "integ_test_required=$requires_integration_test" >> $GITHUB_OUTPUT
         echo "Integration tests required: $requires_integration_test"
       shell: bash

.github/workflows/browser-compatibility-test.yml

@@ -43,4 +43,7 @@ jobs:
         run: npm run test -- --test-name AudioTest --host saucelabs --test-type browser-compatibility
       - name: Run Video Test
         working-directory: ./integration/mocha-tests
-        run: npm run test -- --test-name VideoTest --host saucelabs --test-type browser-compatibility
+        run: npm run test -- --test-name VideoTest --host saucelabs --test-type browser-compatibility
+      - name: Run Video Processing Test
+        working-directory: ./integration/mocha-tests
+        run: npm run test -- --test-name VideoProcessingTest --host saucelabs --test-type browser-compatibility

.github/workflows/continuous-integration.yml

@@ -67,3 +67,22 @@ jobs:
         if: steps.setup.outputs.integ_test_required == 'true'
         working-directory: ./integration/mocha-tests
         run: npm run test -- --test-name VideoTest --host local --test-type integration-test --headless true
+
+  video-processing-test:
+    name: Video Processing Test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Package
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Setup GitHub Actions Host
+        id: setup
+        uses: ./.github/actions/setup-integration-test
+        with:
+          aws-role-to-assume: ${{ secrets.AWS_ROLE_TO_ASSUME_SDK_DEV }}
+          aws-role-session-name: ${{ env.TEST_TYPE }}
+      - name: Run Video Processing Test
+        if: steps.setup.outputs.integ_test_required == 'true'
+        working-directory: ./integration/mocha-tests
+        run: npm run test -- --test-name VideoProcessingTest --host local --test-type integration-test --headless true

.github/workflows/prev-version-integration.yaml

@@ -56,8 +56,6 @@ jobs:
           accessKey: ${{ secrets.SAUCE_ACCESS_KEY }}
           noSSLBumpDomains: all
           tunnelIdentifier: ${{ steps.create-job-id.outputs.uuid }}
-      - name: Install Kite
-        run: integration/js/script/install-kite
       - name: Setup
         run: git checkout tags/v${{ steps.prev.outputs.prev_version }}
       - name: Pack the Chime SDK and install the tarball into the Demo
@@ -69,19 +67,9 @@ jobs:
           npm install ../../amazon-chime-sdk-js-${{ steps.prev.outputs.prev_version }}.tgz
       - name: Clean Install
         run: npm ci
-      - name: Run Audio Integration Test
-        run: npm run test:integration-audio
-      - name: Run Video Integ Test
-        run: npm run test:integration-video
-      - name: Run Content Share Integration Test Job One
-        run: npm run test:integration-content-share-test-suite-one
-      - name: Run Content Share Integration Test Job Two
-        run: npm run test:integration-content-share-test-suite-two
-      - name: Run Data Message Integration Test
-        run: npm run test:integration-data-message
-      - name: Run Meeting Readiness Checker Integration Test
-        run: npm run test:integration-meeting-readiness-checker
-      - name: Setup userArn
-        run: integration/js/script/test-setup
-      - name: Run Messaging Integration Test
-        run: npm run test:integration-messaging
+      - name: Run Audio Test
+        working-directory: ./integration/mocha-tests
+        run: npm run test -- --test-name AudioTest --host saucelabs --test-type browser-compatibility
+      - name: Run Video Test
+        working-directory: ./integration/mocha-tests
+        run: npm run test -- --test-name VideoTest --host saucelabs --test-type browser-compatibility

.github/workflows/release-backwards-compatiblity.yml

@@ -74,23 +74,11 @@ jobs:
           accessKey: ${{ secrets.SAUCE_ACCESS_KEY }}
           noSSLBumpDomains: all
           tunnelIdentifier: ${{ steps.create-job-id.outputs.uuid }}
-      - name: Install Kite
-        run: integration/js/script/install-kite
       - name: Clean Install
         run: npm ci
-      - name: Run Audio Integration Test
-        run: npm run test:integration-audio
-      - name: Run Video Integ Test
-        run: npm run test:integration-video
-      - name: Run Content Share Integration Test Job One
-        run: npm run test:integration-content-share-test-suite-one
-      - name: Run Content Share Integration Test Job Two
-        run: npm run test:integration-content-share-test-suite-two
-      - name: Run Data Message Integration Test
-        run: npm run test:integration-data-message
-      - name: Run Meeting Readiness Checker Integration Test
-        run: npm run test:integration-meeting-readiness-checker
-      - name: Setup userArn
-        run: integration/js/script/test-setup
-      - name: Run Messaging Integration Test
-        run: npm run test:integration-messaging
+      - name: Run Audio Test
+        working-directory: ./integration/mocha-tests
+        run: npm run test -- --test-name AudioTest --host saucelabs --test-type browser-compatibility
+      - name: Run Video Test
+        working-directory: ./integration/mocha-tests
+        run: npm run test -- --test-name VideoTest --host saucelabs --test-type browser-compatibility

.gitignore

@@ -17,10 +17,6 @@ demos/react/public/app.js
 dist
 doc
 integration-test-results/
-integration/js/logs/
-integration/js/node_modules
-integration/js/temp
-integration/kite-allure-reports
 integration/logs
 node_modules
 src/versioning/version.ts

.integration-watchlist

@@ -8,7 +8,6 @@ integration/
 !.eslintignore
 !src/versioning/Versioning.ts
 !README.md
-!integration/js/README.md
 !demos/browser/README.md
 !demos/device/README.md
 !guides/

CHANGELOG.md

@@ -19,6 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Updated to Typescript 5.x and node >= 20
 - Refactored Encoded Transform management into it's own component for better support of non-redundant audio transforms.
 - Add scalability mode fallback when SVC is enabled. Limit SVC for content share to AV1 temporal scalability only.
+- Completed migration to mocha tests
 
 ### Fixed
 

demos/browser/app/meetingV2/meetingV2.ts

@@ -39,6 +39,7 @@ import {
   EventAttributes,
   EventIngestionConfiguration,
   EventName,
+  EventObserver,
   EventReporter,
   isAudioTransformDevice,
   isDestroyable,
@@ -121,6 +122,7 @@ export let fatal: (e: Error) => void;
 declare global {
   interface Window {
     webkitAudioContext: typeof AudioContext
+    pendingEventObserver?: EventObserver
   }
 }
 
@@ -1890,11 +1892,16 @@ export class DemoMeetingApp
       configuration.keepLastFrameWhenPaused = true;
     }
 
+    const eventController = new DefaultEventController(configuration, this.meetingLogger, this.eventReporter);
+    if (window.pendingEventObserver) {
+      eventController.addObserver(window.pendingEventObserver);
+    }
+
     this.meetingSession = new DefaultMeetingSession(
         configuration,
         this.meetingLogger,
         this.deviceController,
-        new DefaultEventController(configuration, this.meetingLogger, this.eventReporter)
+        eventController
     );
 
     const enableAudioRedundancy = !((document.getElementById('disable-audio-redundancy') as HTMLInputElement).checked);