From d11b7d04c529a939aa0231740589d795ec9534d7 Mon Sep 17 00:00:00 2001 From: boukeversteegh Date: Sun, 24 May 2020 19:58:35 +0200 Subject: [PATCH] Document XFAIL tests --- betterproto/tests/README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/betterproto/tests/README.md b/betterproto/tests/README.md index ea15758..de2e2d2 100644 --- a/betterproto/tests/README.md +++ b/betterproto/tests/README.md @@ -73,3 +73,18 @@ The following tests are automatically executed for all cases: - `betterproto/tests/output_reference` — *reference implementation classes* - `pipenv run test` +## Intentionally Failing tests + +The standard test suite includes tests that fail by intention. These tests document known bugs and missing features that are intended to be corrented in the future. + +When running `pytest`, they show up as `x` or `X` in the test results. + +``` +betterproto/tests/test_inputs.py ..x...x..x...x.X........xx........x.....x.......x.xx....x...................... [ 84%] +``` + +- `.` — PASSED +- `x` — XFAIL: expected failure +- `X` — XPASS: expected failure, but still passed + +Test cases marked for expected failure are declared in [inputs/xfail.py](inputs.xfail.py) \ No newline at end of file