From 9748343868b01a386a992b6f9de273f579877420 Mon Sep 17 00:00:00 2001 From: Gabriel Arazas Date: Sat, 9 Mar 2024 10:39:35 +0800 Subject: [PATCH] docs: add tests README --- tests/README.adoc | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 tests/README.adoc diff --git a/tests/README.adoc b/tests/README.adoc new file mode 100644 index 00000000..d0eb76d9 --- /dev/null +++ b/tests/README.adoc @@ -0,0 +1,23 @@ += Tests +:toc: + + +Yes, tests! +We have tests for the major components of this NixOS configuration including the link:../lib[custom library], link:../modules/nixos[our custom NixOS modules], link:../modules/home-manager[custom home-manager modules], and so on. + +Each of the test suite follows how the upstream does their tests. +For example, our home-manager module tests just copies what the upstream is doing. + +You should be able to test them with the following command: + +[source, shell] +---- +# These commands assume you're in the project root. + +# This test is for home-manager module tests. +nix-shell --pure ./tests/modules/home-manager -A list + +# This is for the library. +nix eval -f ./tests lib +---- +