From 062d99f70fe5eed0fbc81182565b51360495e465 Mon Sep 17 00:00:00 2001 From: Laurenz Date: Sun, 7 Feb 2021 13:27:03 +0100 Subject: [PATCH] =?UTF-8?q?Document=20how=20to=20run=20tests=20?= =?UTF-8?q?=F0=9F=93=9D?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- tests/README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/tests/README.md b/tests/README.md index efca6dd6c..5334c2718 100644 --- a/tests/README.md +++ b/tests/README.md @@ -1,5 +1,26 @@ # Tests +## Running the tests +```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 a filter word +cargo test --test typeset call +``` + +For experimenting it's often useful to have a test file you can quickly run. For that purpose you can have a file named `playground.typ` right in this directory (the file is ignored by git). The playground test will be executed whenever no other test matches the filter, so you can run it with (since no real test's name contains an underscore): +```bash +cargo test --test typeset _ +``` + +## Directory structure Top level directory structure: - `full`: Tests of full documents. - `lang`: Tests for specific language features. @@ -13,7 +34,7 @@ Directory structure for each category: - `png`: PNG files produced by tests. - `pdf`: PDF files produced by tests. -To keep things small, please optimize the reference images: +To keep things small, please optimize reference images before committing them: ```bash # One image oxipng -o max path/to/image.png