nix-config/tests/lib.nix

test: { pkgs, self }:
let
  inherit (pkgs) lib;
  nixos-lib = import (pkgs.path + "/nixos/lib") { };
in
(nixos-lib.runTest {
  hostPkgs = pkgs;
  defaults.documentation.enable = lib.mkDefault false;
  node.specialArgs = {
    inherit self;
    nix-config = self;
  };
  imports = [ test ];
}).config.result
meta: Begin writing tests in Nix Now that I've figured out how to dynamically import modules and use those modules as outputs, the next step is to ensure that these modules work as intended when being used by end users. NixOS offers a built-in testing solution that enables us to conveniently spin up virtual machines with a given configuration, then verify their correctness through python scripting. The lib.nix file in particular is based on Jörg Thalheim's very useful blog post that explains how to use the built-in testing functionality with Nix flakes, which isn't covered in official documentation. See: https://blog.thalheim.io/2023/01/08/how-to-use-nixos-testing-framework-with-flakes/ 2024-04-02 11:15:15 +02:00			`test: { pkgs, self }:`
			`let`
			`inherit (pkgs) lib;`
			`nixos-lib = import (pkgs.path + "/nixos/lib") { };`
			`in`
			`(nixos-lib.runTest {`
			`hostPkgs = pkgs;`
			`defaults.documentation.enable = lib.mkDefault false;`
			`node.specialArgs = {`
			`inherit self;`
feat: Pass nix-config as self to avoid infinite recursion This change makes it possible to use this nix-config in all the different ways imaginable (containers, bare metal, tests, and as a separate flake input) without running into infinite recursion issues with self. It does this by using a trick similar to JavaScript in which `var self = this;`, thus enabling the usage of "this" (or self, in Nix's case) where it wouldn't otherwise be possible. Note that this only works if the input for this repository is named nix-config. This makes it impractical to combine with multiple configurations that employ the same strategy. 2024-04-05 16:09:51 +02:00			`nix-config = self;`
meta: Begin writing tests in Nix Now that I've figured out how to dynamically import modules and use those modules as outputs, the next step is to ensure that these modules work as intended when being used by end users. NixOS offers a built-in testing solution that enables us to conveniently spin up virtual machines with a given configuration, then verify their correctness through python scripting. The lib.nix file in particular is based on Jörg Thalheim's very useful blog post that explains how to use the built-in testing functionality with Nix flakes, which isn't covered in official documentation. See: https://blog.thalheim.io/2023/01/08/how-to-use-nixos-testing-framework-with-flakes/ 2024-04-02 11:15:15 +02:00			`};`
			`imports = [ test ];`
			`}).config.result`