This repository contains tests for the DPCTF Test Runner. To deploy the test runner with the tests in this repository, please follow the instructions in the DPCTF Deploy project.
To generate tests use the generate-tests.py script as follows
$ ./generate-tests.py <CSV-file> <destination-dir> [<mpd-root-dir>]
CSV-file: CSV file to generate tests from.
destination-dir: Directory to put generated tests into.
mpd-root-dir (optional): The root directory of relative local mpd paths.
Every row represents a generated test.
"<template-id>","<video-test-vector-url>","<audio-test-vector>","<group>"
template-id: What template to use.
video-test-vector-url: URL to the video test content.
audio-test-vector-url: URL to the audio test content.
group: Name to group the generated test by. A directory per group is created.
You can refer to the tests.csv for examples.
| id | file | specification |
|---|---|---|
| sequential-track-playback | sequential-track-playback.html | 8.2 |
| random-access-to-fragment | random-access-to-fragment.html | 8.3 |
| random-access-to-time | random-access-to-time.html | 8.4 |
| switching-set-playback | switching-set-playback.html | 8.5 |
| regular-playback-of-chunked-content | regular-playback-of-chunked-content.html | 8.6 |
| regular-playback-of-chunked-content-non-aligned-append | regular-playback-of-chunked-content-non-aligned-append.html | 8.7 |
| playback-over-wave-baseline-splice-constraints | playback-over-wave-baseline-splice-constraints.html | 8.8 |
| out-of-order-loading | out-of-order-loading.html | 8.9 |
| overlapping-fragments | overlapping-fragments.html | 8.10 |
| fullscreen-playback-of-switching-sets | fullscreen-playback-of-switching-sets.html | 8.11 |
| playback-of-encrypted-content | playback-of-encrypted-content.html | 8.12 |
| restricted-splicing-of-encrypted-content | restricted-splicing-of-encrypted-content.html | 8.13 |
| sequential-playback-of-encrypted-and-non-encrypted-baseline-content | sequential-playback-of-encrypted-and-non-encrypted-baseline-content.html | 8.14 |
| regular-playback-of-a-cmaf-presentation | regular-playback-of-a-cmaf-presentation.html | 9.2 |
| random-access-of-a-wave-presentation | random-access-of-a-wave-presentation.html | 9.3 |
| splicing-of-wave-program-with-baseline-constraints | splicing-of-wave-program-with-baseline-constraints.html | 9.4 |
Specification numbers refer to section numbers in the DPCTF specification.
Various parameters are used to configure the tests by specifying them in the test-config.json. A list of available parameters can be found here.
As mentioned in the beginning of this README, in order to run tests in an automated way, please follow the instructions in the DPCTF Deploy project.
If you need to run dedicated tests e.g. for debugging purposes without the need to deploy the entire test runner, you can use the tests hosted in the gh-pages branch. These tests are accessible via https://cta-wave.github.io/dpctf-tests/generated/path/to/test.html. path/to/test.html needs to be replaced with the path of the test you want to run within the generated test folder. Examples:
- The URL for avc_15_30_60-2021-09-09-online/sequential-track-playback__t1.html test is https://cta-wave.github.io/dpctf-tests/generated/avc_15_30_60-2021-09-09-online/sequential-track-playback__t1.html
- The URL for ac4-2021-09-29-online/sequential-track-playback__at1.html test is https://cta-wave.github.io/dpctf-tests/generated/ac4-2021-09-29-online/sequential-track-playback__at1.html
To create new tests proceed as follows:
- Create the HTML5 test template file (includes HTML+JS) similar to sequential-track-playback.html. The template file includes placeholders for parameters like URL to audio and/or video MPDs. These will be replaced with the actual URLs in the generate script later. Example is sequential-track-playback.html#L54-L55.
- Create an entry (or multiple entries) in a 'new' CSV file with URLs to audio and/or video MPDs. If your MPD includes audio and video AdaptationSets, you can use the same URL for both. The URL field can be the path to MPD in the content folder of the docker container or can be URL pointing to the content available online. The online content can be used during development or debugging purposes but should not be used in production to avoid higher latency while downloading the content during.
- Run
generate-tests.py my-new-file.csvscript which generates the tests in the generated folder only for entries in the new CSV file. - If you are developer of new tests, usually you need a simple way to debug a single dedicated new developed test without the need to setup of whole docker which includes the test-runner. The only thing you need to do as developer of new tests in this phase is to serve the generated files via http/https and debug the test in browser.
- Once the new tests are implemented and tested, you can add the entries to the CSV file tests.csv, generate the tests, push to git (in a feature branch) and test everything together using dpctf-deploy. Please make sure when you create the docker image to use the new feature branch of dpctf-tests and not the main branch.