summaryrefslogtreecommitdiffstats
path: root/pkgs/stdenv/generic/check-meta-test.nix
blob: 336c6bd5a78e09ca95084347417cfaf9e3c7a542 (plain)
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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
# Execute with
#   nix-build -A nixosTests.nixpkgs-config-allow-unfree-packages-and-predicate --show-trace
#
# This test exercises the interaction between:
#
#   - nixos/modules/misc/nixpkgs.nix  (config merging, esp. allowUnfreePackages)
#   - pkgs/stdenv/generic/check-meta.nix (allowUnfreePredicate logic)
#
# It checks how:
#
#   * config.allowUnfreePackages
#   * config.allowUnfreePredicate
#
# interact to determine whether unfree packages are allowed.
{
  lib,
  pkgs,
}:

let
  inherit (lib)
    assertMsg
    generators
    licenses
    nameValuePair
    recurseIntoAttrs
    replaceString
    ;

  mkPkg = name: license: {
    pname = name;
    version = "1.0";
    meta.license = license;
  };

  assertValidity =
    {
      nixpkgsConfig,
      pkg,
      expected ? true,
    }:
    let
      testPkgs = import ../../.. {
        system = pkgs.stdenv.hostPlatform.system;
        config = nixpkgsConfig;
      };
      checkMeta = testPkgs.callPackage ./check-meta.nix { };
      tryEval = expression: builtins.tryEval (builtins.deepSeq expression expression);
      actual = tryEval (
        checkMeta.assertValidity pkgs.stdenv.hostPlatform {
          meta = pkg.meta;
          attrs = pkg;
        }
      );
      toPretty = generators.toPretty { };
    in
    assertMsg (actual.success == expected) ''
      Expected validity of package '${lib.getName pkg}' with unfree license
      '${licenses.toSPDX pkg.meta.license}' to be ${toPretty expected}, but got
      ${toPretty actual}
      with config:
      ${toPretty nixpkgsConfig}
    '';

  runAssertions = assertions: lib.deepSeq assertions "";

  mkTests = mkUnfreePkg: {
    allowOnlyFreePackagesByDefault = assertValidity {
      nixpkgsConfig = { };
      pkg = mkUnfreePkg "forbidden";
      expected = false;
    };

    allowAllUnfreePackages = assertValidity {
      nixpkgsConfig = {
        allowUnfree = true;
      };
      pkg = mkUnfreePkg "allowed";
    };

    allowUnfreePackagesWithPredicate =
      let
        nixpkgsConfig = {
          allowUnfreePredicate = pkg: lib.getName pkg == "allowed-by-predicate";
        };
      in
      [
        (assertValidity {
          inherit nixpkgsConfig;
          pkg = mkUnfreePkg "allowed-by-predicate";
        })
        (assertValidity {
          inherit nixpkgsConfig;
          pkg = mkUnfreePkg "allowed-by-nothing";
          expected = false;
        })
      ];

    allowUnfreeWithPackages = runAssertions [
      (assertValidity {
        nixpkgsConfig = {
          allowUnfreePackages = [ "unfree" ];
        };
        pkg = mkUnfreePkg "unfree";
        expected = true;
      })
    ];

    allowUnfreePackagesOrPredicate =
      let
        nixpkgsConfig = {
          allowUnfreePackages = [ "allowed-by-packages" ];
          allowUnfreePredicate = pkg: lib.getName pkg == "allowed-by-predicate";
        };
      in
      runAssertions [
        (assertValidity {
          inherit nixpkgsConfig;
          pkg = mkUnfreePkg "allowed-by-packages";
        })
        (assertValidity {
          inherit nixpkgsConfig;
          pkg = mkUnfreePkg "allowed-by-predicate";
        })
        (assertValidity {
          inherit nixpkgsConfig;
          pkg = mkUnfreePkg "forbidden";
          expected = false;
        })
      ];
  };

  unfreeLicenses = [
    licenses.unfree
    (licenses.AND [
      licenses.free
      licenses.unfree
    ])
  ];
in

recurseIntoAttrs (
  builtins.listToAttrs (
    map (
      license:
      nameValuePair (replaceString " " "-" (licenses.toSPDX license)) (
        recurseIntoAttrs (mkTests (name: mkPkg name license))
      )
    ) unfreeLicenses
  )
)