axeman/pub-solar-os
1
0
Fork 0
forked from pub-solar/os
Code Issues Pull requests Packages Projects Releases Wiki Activity
pub-solar-os/doc/tests.md
Pacman99 fe3a624930 docs: general updates
2021-06-05 10:10:05 -07:00

1.7 KiB
Raw Blame History

Testing

Testing is always an important aspect of any software development project, and NixOS offers some incredibly powerful tools to write tests for your configuration, and, optionally, run them in CI.

Unit Tests

Unit tests can be created from regular derivations, and they can do almost anything you can imagine. By convention, it is best to test your packages during their check phase. All packages and their tests will be built during CI.

Integration Tests

All your profiles defined in suites will be tested in a NixOS VM.

You can write integration tests for one or more NixOS VMs that can, optionally, be networked together, and yes, it's as awesome as it sounds!

Be sure to use the mkTest function from digga, digga.lib.pkgs-lib.mkTest which wraps the official testing-python function to ensure that the system is setup exactly as it is for a bare DevOS system. There are already great resources for learning how to use these tests effectively, including the official docs, a fantastic blog post, and the examples in nixpkgs.