summaryrefslogtreecommitdiff
path: root/pkgs/build-support/testers/testEqualArrayOrMap/tests.nix
blob: 5a382ded713854a5ef6e7f7306a1f0a9dcc4d4f9 (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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
# NOTE: We must use `pkgs.runCommand` instead of `testers.runCommand` for negative tests -- those wrapped with
# `testers.testBuildFailure`. This is due to the fact that `testers.testBuildFailure` modifies the derivation such that
# it produces an output containing the exit code, logs, and other things. Since `testers.runCommand` expects the empty
# derivation, it produces a hash mismatch.
{ lib, testers }:
let
  inherit (lib.attrsets) recurseIntoAttrs;
  inherit (testers) testBuildFailure' testEqualArrayOrMap;
  concatValuesArrayToActualArray = ''
    nixLog "appending all values in valuesArray to actualArray"
    for value in "''${valuesArray[@]}"; do
      actualArray+=( "$value" )
    done
  '';
  concatValuesMapToActualMap = ''
    nixLog "adding all values in valuesMap to actualMap"
    for key in "''${!valuesMap[@]}"; do
      actualMap["$key"]="''${valuesMap["$key"]}"
    done
  '';
in
recurseIntoAttrs {
  # NOTE: This particular test is used in the docs:
  # See https://nixos.org/manual/nixpkgs/unstable/#tester-testEqualArrayOrMap
  # or doc/build-helpers/testers.chapter.md
  docs-test-function-add-cowbell = testEqualArrayOrMap {
    name = "test-function-add-cowbell";
    valuesArray = [
      "cowbell"
      "cowbell"
    ];
    expectedArray = [
      "cowbell"
      "cowbell"
      "cowbell"
    ];
    script = ''
      addCowbell() {
        local -rn arrayNameRef="$1"
        arrayNameRef+=( "cowbell" )
      }

      nixLog "appending all values in valuesArray to actualArray"
      for value in "''${valuesArray[@]}"; do
        actualArray+=( "$value" )
      done

      nixLog "applying addCowbell"
      addCowbell actualArray
    '';
  };
  array-append = testEqualArrayOrMap {
    name = "testEqualArrayOrMap-array-append";
    valuesArray = [
      "apple"
      "bee"
      "cat"
    ];
    expectedArray = [
      "apple"
      "bee"
      "cat"
      "dog"
    ];
    script = ''
      ${concatValuesArrayToActualArray}
      actualArray+=( "dog" )
    '';
  };
  array-prepend = testEqualArrayOrMap {
    name = "testEqualArrayOrMap-array-prepend";
    valuesArray = [
      "apple"
      "bee"
      "cat"
    ];
    expectedArray = [
      "dog"
      "apple"
      "bee"
      "cat"
    ];
    script = ''
      actualArray+=( "dog" )
      ${concatValuesArrayToActualArray}
    '';
  };
  array-empty = testEqualArrayOrMap {
    name = "testEqualArrayOrMap-array-empty";
    valuesArray = [
      "apple"
      "bee"
      "cat"
    ];
    expectedArray = [ ];
    script = ''
      # doing nothing
    '';
  };
  array-missing-value = testBuildFailure' {
    drv = testEqualArrayOrMap {
      name = "testEqualArrayOrMap-array-missing-value";
      valuesArray = [ "apple" ];
      expectedArray = [ ];
      script = concatValuesArrayToActualArray;
    };
    expectedBuilderLogEntries = [
      "ERROR: assertEqualArray: arrays differ in length: expectedArray has length 0 but actualArray has length 1"
      "ERROR: assertEqualArray: arrays differ at index 0: expectedArray has no such index but actualArray has value 'apple'"
    ];
  };
  map-insert = testEqualArrayOrMap {
    name = "testEqualArrayOrMap-map-insert";
    valuesMap = {
      apple = "0";
      bee = "1";
      cat = "2";
    };
    expectedMap = {
      apple = "0";
      bee = "1";
      cat = "2";
      dog = "3";
    };
    script = ''
      ${concatValuesMapToActualMap}
      actualMap["dog"]="3"
    '';
  };
  map-remove = testEqualArrayOrMap {
    name = "testEqualArrayOrMap-map-remove";
    valuesMap = {
      apple = "0";
      bee = "1";
      cat = "2";
      dog = "3";
    };
    expectedMap = {
      apple = "0";
      cat = "2";
      dog = "3";
    };
    script = ''
      ${concatValuesMapToActualMap}
      unset 'actualMap[bee]'
    '';
  };
  map-missing-key = testBuildFailure' {
    drv = testEqualArrayOrMap {
      name = "testEqualArrayOrMap-map-missing-key";
      valuesMap = {
        bee = "1";
        cat = "2";
        dog = "3";
      };
      expectedMap = {
        apple = "0";
        bee = "1";
        cat = "2";
        dog = "3";
      };
      script = concatValuesMapToActualMap;
    };
    expectedBuilderLogEntries = [
      "ERROR: assertEqualMap: maps differ in length: expectedMap has length 4 but actualMap has length 3"
      "ERROR: assertEqualMap: maps differ at key 'apple': expectedMap has value '0' but actualMap has no such key"
    ];
  };
  map-missing-key-with-empty = testBuildFailure' {
    drv = testEqualArrayOrMap {
      name = "testEqualArrayOrMap-map-missing-key-with-empty";
      valuesArray = [ ];
      expectedMap.apple = 1;
      script = "";
    };
    expectedBuilderLogEntries = [
      "ERROR: assertEqualMap: maps differ in length: expectedMap has length 1 but actualMap has length 0"
      "ERROR: assertEqualMap: maps differ at key 'apple': expectedMap has value '1' but actualMap has no such key"
    ];
  };
  map-extra-key = testBuildFailure' {
    drv = testEqualArrayOrMap {
      name = "testEqualArrayOrMap-map-extra-key";
      valuesMap = {
        apple = "0";
        bee = "1";
        cat = "2";
        dog = "3";
      };
      expectedMap = {
        apple = "0";
        bee = "1";
        dog = "3";
      };
      script = concatValuesMapToActualMap;
    };
    expectedBuilderLogEntries = [
      "ERROR: assertEqualMap: maps differ in length: expectedMap has length 3 but actualMap has length 4"
      "ERROR: assertEqualMap: maps differ at key 'cat': expectedMap has no such key but actualMap has value '2'"
    ];
  };
}