History

Pacman99 3c8d22a528 flake/tests: improve multi arch support for flake checks		2021-03-19 12:23:23 -07:00
..
testPathsToImportedAttrs	treewide cleanups and refactoring for initial tests (#157 )	2021-03-14 07:10:51 +00:00
0004-nixos-testing-Add-support-for-specialArgs.patch	treewide cleanups and refactoring for initial tests (#157 )	2021-03-14 07:10:51 +00:00
default.nix	flake/tests: improve multi arch support for flake checks	2021-03-19 12:23:23 -07:00
lib.nix	lib: add rgxToString function	2021-03-14 21:40:49 -06:00
README.md	treewide cleanups and refactoring for initial tests (#157 )	2021-03-14 07:10:51 +00:00

README.md

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.

Lib Tests

You can easily write tests for your own library functions in the tests/lib.nix file and they will be run on every nix flake check or during a CI run.

Unit Tests

Unit tests are 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

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, in the tests/default.nix 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.