yadunut/clan-core
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs/testing: Improve testing documentation

Browse Source
This commit is contained in:
a-kenji
2025-06-18 11:12:30 +02:00
parent 69b7b61cc7
commit 688aad716d
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/site/guides/contributing/testing.md
View File

@@ -104,7 +104,7 @@ Limitations:
### Where to find examples for NixOS container tests ### Where to find examples for NixOS container tests
Existing nixos container tests in clan-core can be found by using ripgrep: Existing NixOS container tests in clan-core can be found by using `ripgrep`:
```shellSession ```shellSession
rg self.clanLib.test.containerTest rg self.clanLib.test.containerTest
@@ -131,7 +131,7 @@ Due to superior efficiency,
### Finding examples of python tests ### Finding examples of python tests
Existing python tests in clan-core can be found by using ripgrep: Existing python tests in clan-core can be found by using `ripgrep`:
```shellSession ```shellSession
rg "import pytest" rg "import pytest"
``` ```
@@ -196,17 +196,17 @@ Nix eval tests are good for testing any nix logic, including
- nix functions - nix functions
- nix libraries - nix libraries
- modules for the nixos module system - modules for the NixOS module system
When not to use When not to use
- tests that require building nix derivations (except some very cheap ones) - tests that require building nix derivations (except some very cheap ones)
- tests that require running programs written in other languages - tests that require running programs written in other languages
- tests that require building or running nixos machines - tests that require building or running NixOS machines
### Finding examples of nix eval tests ### Finding examples of nix eval tests
Existing nix eval tests can be found via this ripgrep command: Existing nix eval tests can be found via this `ripgrep` command:
```shellSession ```shellSession
rg "nix-unit --eval-store" rg "nix-unit --eval-store"
@@ -284,11 +284,11 @@ Add `lib.trace` or `lib.traceVal` statements in order to print some variables du
#### Nix repl #### Nix repl
Use `nix repl` to evaluate to inspec the test. Use `nix repl` to evaluate and inspect the test.
Each test consists opf an `expr` (expression) and an `expected` field. `nix-unit` simply checks if `expr == expected` and prints the diff if that's not the case. Each test consists of an `expr` (expression) and an `expected` field. `nix-unit` simply checks if `expr == expected` and prints the diff if that's not the case.
`nix repl` can be used to inspect `expr` manually, or any other variables that you choose to expose. `nix repl` can be used to inspect an `expr` manually, or any other variables that you choose to expose.
Example: Example: