nixos/nix
1
1
Fork 0
mirror of https://github.com/NixOS/nix.git synced 2025-11-27 12:41:00 +01:00
Code Activity

Document the JSON Schema testing a bit

Browse source
This commit is contained in:
John Ericson 2025-11-24 14:11:54 -05:00
parent 3bac0d7aa2
commit f198e9a0b3
1 changed files with 6 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

6
doc/manual/source/development/testing.md
View file

@ -137,6 +137,12 @@ $ _NIX_TEST_ACCEPT=1 meson test nix-store-tests -v
will regenerate the "golden master" expected result for the `libnixstore` characterisation tests. will regenerate the "golden master" expected result for the `libnixstore` characterisation tests.
The characterisation tests will mark themselves "skipped" since they regenerated the expected result instead of actually testing anything. The characterisation tests will mark themselves "skipped" since they regenerated the expected result instead of actually testing anything.
### JSON Schema testing
In `doc/manual/source/protocols/json/` we have a number of manual pages generated from [JSON Schema](https://json-schema.org/).
That JSON schema is tested against the JSON file test data used in [characterisation tests](#characterisation-testing-unit ) for JSON (de)serialization, in `src/json-schema-checks`.
Between the JSON (de)serialization testing, and this testing of the same data against the schema, we make sure that the manual, the implementation, and a machine-readable schema are are all in sync.
### Unit test support libraries ### Unit test support libraries
There are headers and code which are not just used to test the library in question, but also downstream libraries. There are headers and code which are not just used to test the library in question, but also downstream libraries.