Skip to content

Commit

Permalink
Add tests documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
deeplow committed Jul 10, 2023
1 parent 3d6407f commit 00e40ab
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions docs/developer/TESTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Dangerzone Testing

Dangerzone has some automated testing under `tests/`.

The following assumes that you have already setup the development environment.

## Run tests

Unit / integration tests are run with:

```bash
poetry run make test
```

## Run large tests

We also have a larger set of tests that can take a day or more to run, where we evaluate the completeness of Dangerzone conversions.

```bash
poetry run make large-test
```

### Test report generation

There are two kinds of reports produced: junit report, test analysis report.

The Junit report is stored under `tests/test_docs_large/results/junit/` and it is composed of the JUnit XML file describing the pytest run.

The second kind of report is used to analyze the errors generated during the conversion. It can only be done after test training. It is obtained by running:

```bash
cd tests/docs_test_large
make report
```

### Updating large tests

The goal of these tests is to compare the current code revision with a past one and make sure there are no regressions

0 comments on commit 00e40ab

Please sign in to comment.