summaryrefslogtreecommitdiff
path: root/tests/README.md
diff options
context:
space:
mode:
authorLaurenz <laurmaedje@gmail.com>2021-03-19 17:57:31 +0100
committerLaurenz <laurmaedje@gmail.com>2021-03-19 17:57:31 +0100
commit264a7dedd42e27cd9e604037640cf0594b2ec46b (patch)
treed26feea399d54bb86bd44878f40293983bf5251d /tests/README.md
parentca3df70e2a5069832d7d2135967674c34a155442 (diff)
Scheduled maintenance 🔨
- New naming scheme - TextNode instead of NodeText - CallExpr instead of ExprCall - ... - Less glob imports - Removes Value::Args variant - Removes prelude - Renames Layouted to Fragment - Moves font into env - Moves shaping into layout - Moves frame into separate module
Diffstat (limited to 'tests/README.md')
-rw-r--r--tests/README.md26
1 files changed, 16 insertions, 10 deletions
diff --git a/tests/README.md b/tests/README.md
index fb755f1b..57d47fe2 100644
--- a/tests/README.md
+++ b/tests/README.md
@@ -3,29 +3,35 @@
## Directory structure
Top level directory structure:
- `typ`: Input files.
+- `res`: Resource files used by tests.
- `ref`: Reference images which the output is compared with to determine whether
a test passed or failed.
- `png`: PNG files produced by tests.
- `pdf`: PDF files produced by tests.
-- `res`: Resource files used by tests.
## Running the tests
+Running the integration tests (the tests in this directory).
```bash
-# Run all tests
-cargo test
-
-# Run unit tests
-cargo test --lib
-
-# Run integration tests (the tests in this directory)
cargo test --test typeset
+```
-# Run all tests whose names contain the word `filter`
+Running all tests whose names contain the word `filter`.
+```bash
cargo test --test typeset filter
```
+To make the integration tests go faster they don't generate PDFs by default.
+Pass the `--pdf` flag to generate those. Mind that PDFs are not tested
+automatically at the moment, so you should always check the output manually when
+making changes.
+```bash
+cargo test --test typeset -- --pdf
+```
+
## Creating new tests
-To keep things small, please optimize reference images before committing them:
+To keep things small, please optimize reference images before committing them.
+When you use the approve buttom from the Test Helper (see the `tools` folder)
+this happens automatically if you have `oxipng` installed.
```bash
# One image
oxipng -o max path/to/image.png