nixpkgs/nixos/modules/misc/documentation/test.nix


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

{ nixosLib, pkgsModule, runCommand }:

let
  sys = nixosLib.evalModules rec {
    modules = [
      pkgsModule
      ../documentation.nix
      ../version.nix

      ({ lib, someArg, ... }: {
        # Make sure imports from specialArgs are respected
        imports = [ someArg.myModule ];

        # TODO test this
        meta.doc = ./test-dummy.chapter.xml;
      })

      {
        _module.args = {
          baseModules = [
            ../documentation.nix
            ../version.nix
          ];
          extraModules = [ ];
          inherit modules;
        };
        documentation.nixos.includeAllModules = true;
      }
    ];
    specialArgs.someArg.myModule = { lib, ... }: {
      options.foobar = lib.mkOption {
        type = lib.types.str;
        description = "The foobar option was added via specialArgs";
        default = "qux";
      };
    };
  };

in
runCommand "documentation-check"
{
  inherit (sys.config.system.build.manual) optionsJSON;
} ''
  json="$optionsJSON/share/doc/nixos/options.json"
  echo checking $json

  grep 'The foobar option was added via specialArgs' <"$json" >/dev/null
  touch $out
''