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

docs: Improve list view on testing

Browse Source
This commit is contained in:
a-kenji
2025-10-08 14:29:01 +02:00
parent 9b60b4a989
commit 016fe3d114
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -107,11 +107,13 @@ nix run .#checks.x86_64-linux.service-dummy-test
#### Common issues #### Common issues
If `update-vars` fails, you may need to ensure that: If `update-vars` fails, you may need to ensure that:
- **`clan.directory` is set correctly**: It should point to the directory where you want vars to be generated (typically `clan.directory = ./.;` in your test definition) - **`clan.directory` is set correctly**: It should point to the directory where you want vars to be generated (typically `clan.directory = ./.;` in your test definition)
- **Your test defines machines**: Machines must be defined in `clan.inventory.machines` or through the inventory system - **Your test defines machines**: Machines must be defined in `clan.inventory.machines` or through the inventory system
- **Machine definitions are complete**: Each machine should have the necessary service configuration that defines the vars generators - **Machine definitions are complete**: Each machine should have the necessary service configuration that defines the vars generators
**If vars are not found during test execution:** **If vars are not found during test execution:**
- Verify that `clan.directory` points to the same location where you ran `update-vars` - Verify that `clan.directory` points to the same location where you ran `update-vars`
- Check that the `vars/` and `sops/` directories exist in that location - Check that the `vars/` and `sops/` directories exist in that location
- Ensure the generated files match the machines and generators defined in your test - Ensure the generated files match the machines and generators defined in your test