summaryrefslogtreecommitdiffstats
path: root/testing/web-platform/tests/webvtt/parsing/file-parsing/README.md
blob: 4cff0af95209d9744311e497aad2dd76c4f4dd95 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# Tests for http://w3c.github.io/webvtt/#file-parsing

Tests that expect an 'error' event (due to invalid signature) are:

```bash
./signature-invalid.html
./support/*.vtt
```

Other tests are generated from source files with a custom format. The source files are:

```bash
./support/*.test
```

## .test Format

* The first line is the title of the test.
* Subsequent lines until a blank line contain HTML metadata.
* Subsequent lines until a `===` line contains JS assertions.
* Finally the WebVTT file. Special characters can be escaped using python3 escape sequences: `\x00`, `\r`.

## Building Tests

Requirements: Python 3.2 or newer

```bash
$ python3 tools/build.py
```

## Spec Coverage Report

There is also a python implementation of the WebVTT file parser algorithm and a
script to create a test coverage report of this implementation, under `tools/`.

Requirements:
* Python 3.2 or newer
* [Coverage.py](https://pypi.python.org/pypi/coverage)

Installing Coverage.py using [pip](https://pypi.python.org/pypi/pip).

```bash
$ pip3 install coverage
```

Generating the report:

```bash
$ python3 spec_report.py
```

Will output `report.html`.