commit e20a362908fa6d4393efb05390e7dd38a64237da · pyrox.dev/nixpkgs

+24

doc/builders/testers.chapter.md

···

       75
       75
        
          `buildPackages.coreutils` and possibly more. These are not added to `PATH`

     

       76
       76
        
          or any other environment variable, so they should be hard to observe.

     

       77
       77
        
       

     

       78
       78
       +
       ## `testEqualContents` {#tester-equalContents}

     

       79
       79
       +
       

     

       80
       80
       +
       Check that two paths have the same contents.

     

       81
       81
       +
       

     

       82
       82
       +
       Example:

     

       83
       83
       +
       

     

       84
       84
       +
       ```nix

     

       85
       85
       +
       testers.testEqualContents {

     

       86
       86
       +
         assertion = "sed -e performs replacement";

     

       87
       87
       +
         expected = writeText "expected" ''

     

       88
       88
       +
           foo baz baz

     

       89
       89
       +
         '';

     

       90
       90
       +
         actual = runCommand "actual" {

     

       91
       91
       +
           # not really necessary for a package that's in stdenv

     

       92
       92
       +
           nativeBuildInputs = [ gnused ];

     

       93
       93
       +
           base = writeText "base" ''

     

       94
       94
       +
             foo bar baz

     

       95
       95
       +
           '';

     

       96
       96
       +
         } ''

     

       97
       97
       +
           sed -e 's/bar/baz/g' $base >$out

     

       98
       98
       +
         '';

     

       99
       99
       +
       }

     

       100
       100
       +
       ```

     

       101
       101
       +
       

     

       78
       102
        
       ## `testEqualDerivation` {#tester-testEqualDerivation}

     

       79
       103
        
       

     

       80
       104
        
       Checks that two packages produce the exact same build instructions.

+38

pkgs/build-support/testers/default.nix

···

       13
       13
        
       

     

       14
       14
        
         testEqualDerivation = callPackage ./test-equal-derivation.nix { };

     

       15
       15
        
       

     

       16
       16
       +
         # See https://nixos.org/manual/nixpkgs/unstable/#tester-testEqualContents

     

       17
       17
       +
         # or doc/builders/testers.chapter.md

     

       18
       18
       +
         testEqualContents = {

     

       19
       19
       +
           assertion,

     

       20
       20
       +
           actual,

     

       21
       21
       +
           expected,

     

       22
       22
       +
         }: runCommand "equal-contents-${lib.strings.toLower assertion}" {

     

       23
       23
       +
           inherit assertion actual expected;

     

       24
       24
       +
         } ''

     

       25
       25
       +
           echo "Checking:"

     

       26
       26
       +
           echo "$assertion"

     

       27
       27
       +
           if ! diff -U5 -r "$actual" "$expected" --color=always

     

       28
       28
       +
           then

     

       29
       29
       +
             echo

     

       30
       30
       +
             echo 'Contents must be equal, but were not!'

     

       31
       31
       +
             echo

     

       32
       32
       +
             echo "+: expected,   at $expected"

     

       33
       33
       +
             echo "-: unexpected, at $actual"

     

       34
       34
       +
             exit 1

     

       35
       35
       +
           else

     

       36
       36
       +
             find "$expected" -type f -executable > expected-executables | sort

     

       37
       37
       +
             find "$actual" -type f -executable > actual-executables | sort

     

       38
       38
       +
             if ! diff -U0 actual-executables expected-executables --color=always

     

       39
       39
       +
             then

     

       40
       40
       +
               echo

     

       41
       41
       +
               echo "Contents must be equal, but some files' executable bits don't match"

     

       42
       42
       +
               echo

     

       43
       43
       +
               echo "+: make this file executable in the actual contents"

     

       44
       44
       +
               echo "-: make this file non-executable in the actual contents"

     

       45
       45
       +
               exit 1

     

       46
       46
       +
             else

     

       47
       47
       +
               echo "expected $expected and actual $actual match."

     

       48
       48
       +
               echo 'OK'

     

       49
       49
       +
               touch $out

     

       50
       50
       +
             fi

     

       51
       51
       +
           fi

     

       52
       52
       +
         '';

     

       53
       53
       +
       

     

       16
       54
        
         testVersion =

     

       17
       55
        
           { package,

     

       18
       56
        
             command ? "${package.meta.mainProgram or package.pname or package.name} --version",

+115 -1

pkgs/build-support/testers/test/default.nix

···

       68
       68
        
       

     

       69
       69
        
             # Checking our note that dev is the default output

     

       70
       70
        
             echo $failed/_ | grep -- '-dev/_' >/dev/null

     

       71
       71
       -
       

     

       71
       71
       +
             echo 'All good.'

     

       72
       72
        
             touch $out

     

       73
       73
        
           '';

     

       74
       74
        
         };

     

       75
       75
        
       

     

       76
       76
       +
         testEqualContents = lib.recurseIntoAttrs {

     

       77
       77
       +
           happy = testers.testEqualContents {

     

       78
       78
       +
             assertion = "The same directory contents at different paths are recognized as equal";

     

       79
       79
       +
             expected = runCommand "expected" {} ''

     

       80
       80
       +
               mkdir -p $out/c

     

       81
       81
       +
               echo a >$out/a

     

       82
       82
       +
               echo b >$out/b

     

       83
       83
       +
               echo d >$out/c/d

     

       84
       84
       +
             '';

     

       85
       85
       +
             actual = runCommand "actual" {} ''

     

       86
       86
       +
               mkdir -p $out/c

     

       87
       87
       +
               echo a >$out/a

     

       88
       88
       +
               echo b >$out/b

     

       89
       89
       +
               echo d >$out/c/d

     

       90
       90
       +
             '';

     

       91
       91
       +
           };

     

       92
       92
       +
       

     

       93
       93
       +
           unequalExe =

     

       94
       94
       +
             runCommand "testEqualContents-unequalExe" {

     

       95
       95
       +
               log = testers.testBuildFailure (testers.testEqualContents {

     

       96
       96
       +
                 assertion = "The same directory contents at different paths are recognized as equal";

     

       97
       97
       +
                 expected = runCommand "expected" {} ''

     

       98
       98
       +
                   mkdir -p $out/c

     

       99
       99
       +
                   echo a >$out/a

     

       100
       100
       +
                   chmod a+x $out/a

     

       101
       101
       +
                   echo b >$out/b

     

       102
       102
       +
                   echo d >$out/c/d

     

       103
       103
       +
                 '';

     

       104
       104
       +
                 actual = runCommand "actual" {} ''

     

       105
       105
       +
                   mkdir -p $out/c

     

       106
       106
       +
                   echo a >$out/a

     

       107
       107
       +
                   echo b >$out/b

     

       108
       108
       +
                   chmod a+x $out/b

     

       109
       109
       +
                   echo d >$out/c/d

     

       110
       110
       +
                 '';

     

       111
       111
       +
               });

     

       112
       112
       +
             } ''

     

       113
       113
       +
               (

     

       114
       114
       +
                 set -x

     

       115
       115
       +
                 grep -F -- "executable bits don't match" $log/testBuildFailure.log

     

       116
       116
       +
                 grep -E -- '+.*-actual/a' $log/testBuildFailure.log

     

       117
       117
       +
                 grep -E -- '-.*-actual/b' $log/testBuildFailure.log

     

       118
       118
       +
                 grep -F -- "--- actual-executables" $log/testBuildFailure.log

     

       119
       119
       +
                 grep -F -- "+++ expected-executables" $log/testBuildFailure.log

     

       120
       120
       +
               ) || {

     

       121
       121
       +
                 echo "Test failed: could not find pattern in build log $log"

     

       122
       122
       +
                 exit 1

     

       123
       123
       +
               }

     

       124
       124
       +
               echo 'All good.'

     

       125
       125
       +
               touch $out

     

       126
       126
       +
             '';

     

       127
       127
       +
       

     

       128
       128
       +
           fileDiff =

     

       129
       129
       +
             runCommand "testEqualContents-fileDiff" {

     

       130
       130
       +
               log = testers.testBuildFailure (testers.testEqualContents {

     

       131
       131
       +
                 assertion = "The same directory contents at different paths are recognized as equal";

     

       132
       132
       +
                 expected = runCommand "expected" {} ''

     

       133
       133
       +
                   mkdir -p $out/c

     

       134
       134
       +
                   echo a >$out/a

     

       135
       135
       +
                   echo b >$out/b

     

       136
       136
       +
                   echo d >$out/c/d

     

       137
       137
       +
                 '';

     

       138
       138
       +
                 actual = runCommand "actual" {} ''

     

       139
       139
       +
                   mkdir -p $out/c

     

       140
       140
       +
                   echo a >$out/a

     

       141
       141
       +
                   echo B >$out/b

     

       142
       142
       +
                   echo d >$out/c/d

     

       143
       143
       +
                 '';

     

       144
       144
       +
               });

     

       145
       145
       +
             } ''

     

       146
       146
       +
               (

     

       147
       147
       +
                 set -x

     

       148
       148
       +
                 grep -F -- "Contents must be equal but were not" $log/testBuildFailure.log

     

       149
       149
       +
                 grep -E -- '+++ .*-actual/b' $log/testBuildFailure.log

     

       150
       150
       +
                 grep -E -- '--- .*-actual/b' $log/testBuildFailure.log

     

       151
       151
       +
                 grep -F -- "-B" $log/testBuildFailure.log

     

       152
       152
       +
                 grep -F -- "+b" $log/testBuildFailure.log

     

       153
       153
       +
               ) || {

     

       154
       154
       +
                 echo "Test failed: could not find pattern in build log $log"

     

       155
       155
       +
                 exit 1

     

       156
       156
       +
               }

     

       157
       157
       +
               echo 'All good.'

     

       158
       158
       +
               touch $out

     

       159
       159
       +
             '';

     

       160
       160
       +
       

     

       161
       161
       +
           fileMissing =

     

       162
       162
       +
             runCommand "testEqualContents-fileMissing" {

     

       163
       163
       +
               log = testers.testBuildFailure (testers.testEqualContents {

     

       164
       164
       +
                 assertion = "The same directory contents at different paths are recognized as equal";

     

       165
       165
       +
                 expected = runCommand "expected" {} ''

     

       166
       166
       +
                   mkdir -p $out/c

     

       167
       167
       +
                   echo a >$out/a

     

       168
       168
       +
                   echo b >$out/b

     

       169
       169
       +
                   echo d >$out/c/d

     

       170
       170
       +
                 '';

     

       171
       171
       +
                 actual = runCommand "actual" {} ''

     

       172
       172
       +
                   mkdir -p $out/c

     

       173
       173
       +
                   echo a >$out/a

     

       174
       174
       +
                   echo d >$out/c/d

     

       175
       175
       +
                 '';

     

       176
       176
       +
               });

     

       177
       177
       +
             } ''

     

       178
       178
       +
               (

     

       179
       179
       +
                 set -x

     

       180
       180
       +
                 grep -F -- "Contents must be equal but were not" $log/testBuildFailure.log

     

       181
       181
       +
                 grep -E -- 'Only in .*-expected: b' $log/testBuildFailure.log

     

       182
       182
       +
               ) || {

     

       183
       183
       +
                 echo "Test failed: could not find pattern in build log $log"

     

       184
       184
       +
                 exit 1

     

       185
       185
       +
               }

     

       186
       186
       +
               echo 'All good.'

     

       187
       187
       +
               touch $out

     

       188
       188
       +
             '';

     

       189
       189
       +
         };

     

       76
       190
        
       }