Add functional test for Annex I reporting (#4669)

Dash-Industry-Forum · Jan 22, 2025 · 674660b · 674660b
1 parent 8c873c5
commit 674660b
Show file tree

Hide file tree

Showing 4 changed files with 74 additions and 2 deletions.
diff --git a/test/functional/adapter/DashJsAdapter.js b/test/functional/adapter/DashJsAdapter.js
@@ -572,7 +572,7 @@ class DashJsAdapter {
         })
     }
 
-    async waitForMediaSegmentDownload(timeoutValue) {
+    async waitForMediaSegmentDownload(timeoutValue, mediaType = 'all') {
         return new Promise((resolve) => {
             let timeout = null;
 
@@ -586,7 +586,7 @@ class DashJsAdapter {
                 _onComplete({});
             }
             const _onEvent = (e) => {
-                if (e.request.type === 'MediaSegment') {
+                if (e.request.type === 'MediaSegment' && (e.request.mediaType === mediaType || mediaType === 'all')) {
                     _onComplete(e);
                 }
             }

diff --git a/test/functional/config/test-configurations/streams/smoke.json b/test/functional/config/test-configurations/streams/smoke.json
@@ -167,6 +167,20 @@
         }
       }
     },
+    {
+      "name": "livesim2 Annex I",
+      "type": "live",
+      "url": "https://livesim.dashif.org/livesim2/annexI_dashjs=rocks/testpic_6s/Manifest.mpd?dashjs=rocks",
+      "includedTestfiles": [
+        "feature-support/annex-i"
+      ],
+      "testdata": {
+        "annexI": {
+          "mediaTypes": ["video"],
+          "expectedQueryString": "?dashjs=rocks"
+        }
+      }
+    },
     {
       "name": "DASH-IF Live Sim - Segment Template without manifest updates",
       "type": "live",

diff --git a/test/functional/src/Constants.js b/test/functional/src/Constants.js
@@ -163,6 +163,7 @@ TESTCASES.DRM.KEEP_MEDIA_KEY_SESSIONS = TESTCASES.CATEGORIES.DRM + 'keep-media-k
 TESTCASES.FEATURE_SUPPORT.EMSG_TRIGGERED = TESTCASES.CATEGORIES.FEATURE_SUPPORT + 'emsg-triggered';
 TESTCASES.FEATURE_SUPPORT.MPD_PATCHING = TESTCASES.CATEGORIES.FEATURE_SUPPORT + 'mpd-patching';
 TESTCASES.FEATURE_SUPPORT.CMCD = TESTCASES.CATEGORIES.FEATURE_SUPPORT + 'cmcd';
+TESTCASES.FEATURE_SUPPORT.ANNEX_I = TESTCASES.CATEGORIES.FEATURE_SUPPORT + 'annex-i';
 
 TESTCASES.LIVE.CATCHUP = TESTCASES.CATEGORIES.LIVE + 'latency-catchup';
 TESTCASES.LIVE.DELAY = TESTCASES.CATEGORIES.LIVE + 'live-delay';

diff --git a/test/functional/test/feature-support/annex-i.js b/test/functional/test/feature-support/annex-i.js
@@ -0,0 +1,57 @@
+import Constants from '../../src/Constants.js';
+import Utils from '../../src/Utils.js';
+
+import {
+    checkIsPlaying,
+    checkIsProgressing,
+    checkNoCriticalErrors,
+    initializeDashJsAdapter
+} from '../common/common.js';
+import {expect} from 'chai';
+
+const TESTCASE = Constants.TESTCASES.FEATURE_SUPPORT.ANNEX_I;
+
+Utils.getTestvectorsForTestcase(TESTCASE).forEach((item) => {
+    const mpd = item.url;
+
+    describe(`${TESTCASE} - ${item.name} - ${mpd}`, () => {
+        let playerAdapter;
+
+        before(() => {
+            if (!item.testdata || !item.testdata.annexI || !item.testdata.annexI.mediaTypes || item.testdata.annexI.mediaTypes.length === 0 || !item.testdata.annexI.expectedQueryString) {
+                this.skip();
+            }
+            playerAdapter = initializeDashJsAdapter(item, mpd);
+        })
+
+        after(() => {
+            playerAdapter.destroy();
+        })
+
+        it(`Checking playing state`, async () => {
+            await checkIsPlaying(playerAdapter, true);
+        })
+
+        it(`Checking progressing state`, async () => {
+            await checkIsProgressing(playerAdapter);
+        });
+
+
+        it(`Expect requests to have Annex I query parameters`, async () => {
+            for (const mediaType of item.testdata.annexI.mediaTypes) {
+                const eventPayload = await playerAdapter.waitForMediaSegmentDownload(Constants.TEST_TIMEOUT_THRESHOLDS.EVENT_WAITING_TIME, mediaType)
+                expect(eventPayload.request).to.not.be.undefined;
+                expect(eventPayload.request.url).to.not.be.undefined;
+                const requestUrl = eventPayload.request.url;
+                const url = new URL(requestUrl);
+                const queryParameterString = url.search;
+                expect(queryParameterString).to.be.equal(item.testdata.annexI.expectedQueryString);
+            }
+        })
+
+        it(`Expect no critical errors to be thrown`, () => {
+            checkNoCriticalErrors(playerAdapter);
+        })
+
+    })
+})