Skip to content

Commit

Permalink
docs: how to run tests from a release
Browse files Browse the repository at this point in the history
Signed-off-by: Alban Crequy <alban@kinvolk.io>
  • Loading branch information
alban authored and Dongsu Park committed Aug 22, 2018
1 parent 25522e1 commit ea0a3b2
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion docs/runtime-compliance-testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,24 @@ In order to be tested for [compliance][], runtimes MUST support at least one of

* Version 1.0.1 of the [OCI Runtime Command Line Interface](command-line-interface.md).

## Running the runtime validation suite from source
## Running the runtime validation suite

The runtime validation suite uses [node-tap][], which is packaged for some distributions (for example, it is in [Debian's `node-tap` package][debian-node-tap]).
If your distribution does not package node-tap, you can install [npm][] (for example, from [Gentoo's `nodejs` package][gentoo-nodejs]) and use it:

```console
$ npm install tap
```
### From a release

Check if your release has pre-compiled tests on the [release page][releases] page.

```
$ tar xf runtime-tools-v0.6.0.tar.gz
$ RUNTIME=runc tap ./runtime-tools-v0.6.0/validation/*.t
```

### From source

Build the validation executables:

Expand Down Expand Up @@ -367,3 +377,4 @@ Result: PASS
[npm]: https://www.npmjs.com/
[prove]: http://search.cpan.org/~leont/Test-Harness-3.39/bin/prove
[tap-consumers]: https://testanything.org/consumers.html
[releases]: https://github.com/opencontainers/runtime-tools/releases

0 comments on commit ea0a3b2

Please sign in to comment.