commit 29352751cff3bec9ce073bd5331a3d78ab31c17d · pyrox.dev/nixpkgs

+64

doc/builders/testers.chapter.md

···

       35
       35
        
       };

     

       36
       36
        
       ```

     

       37
       37
        
       

     

       38
       38
       +
       ## `testBuildFailure` {#tester-testBuildFailure}

     

       39
       39
       +
       

     

       40
       40
       +
       Make sure that a build does not succeed. This is useful for testing testers.

     

       41
       41
       +
       

     

       42
       42
       +
       This returns a derivation with an override on the builder, with the following effects:

     

       43
       43
       +
       

     

       44
       44
       +
        - Fail the build when the original builder succeeds

     

       45
       45
       +
        - Move `$out` to `$out/result`, if it exists (assuming `out` is the default output)

     

       46
       46
       +
        - Save the build log to `$out/testBuildFailure.log` (same)

     

       47
       47
       +
       

     

       48
       48
       +
       Example:

     

       49
       49
       +
       

     

       50
       50
       +
       ```nix

     

       51
       51
       +
       runCommand "example" {

     

       52
       52
       +
         failed = testers.testBuildFailure (runCommand "fail" {} ''

     

       53
       53
       +
           echo ok-ish >$out

     

       54
       54
       +
           echo failing though

     

       55
       55
       +
           exit 3

     

       56
       56
       +
         '');

     

       57
       57
       +
       } ''

     

       58
       58
       +
         grep -F 'ok-ish' $failed/result

     

       59
       59
       +
         grep -F 'failing though' $failed/testBuildFailure.log

     

       60
       60
       +
         [[ 3 = $(cat $failed/testBuildFailure.exit) ]]

     

       61
       61
       +
         touch $out

     

       62
       62
       +
       '';

     

       63
       63
       +
       ```

     

       64
       64
       +
       

     

       65
       65
       +
       While `testBuildFailure` is designed to keep changes to the original builder's 

     

       66
       66
       +
       environment to a minimum, some small changes are inevitable.

     

       67
       67
       +
       

     

       68
       68
       +
        - The file `$TMPDIR/testBuildFailure.log` is present. It should not be deleted.

     

       69
       69
       +
        - `stdout` and `stderr` are a pipe instead of a tty. This could be improved.

     

       70
       70
       +
        - One or two extra processes are present in the sandbox during the original

     

       71
       71
       +
          builder's execution.

     

       72
       72
       +
        - The derivation and output hashes are different, but not unusual.

     

       73
       73
       +
        - The derivation includes a dependency on `buildPackages.bash` and

     

       74
       74
       +
          `expect-failure.sh`, which is built to include a transitive dependency on

     

       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
       +
       

     

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

     

       39
       103
        
       

     

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

+53 -1

pkgs/build-support/testers/default.nix

···

       1
       1
       -
       { pkgs, lib, callPackage, runCommand, stdenv }:

     

       1
       1
       +
       { pkgs, buildPackages, lib, callPackage, runCommand, stdenv, substituteAll, }:

     

       2
       2
        
       # Documentation is in doc/builders/testers.chapter.md

     

       3
       3
        
       {

     

       4
       4
       +
         # See https://nixos.org/manual/nixpkgs/unstable/#tester-testBuildFailure

     

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

     

       6
       6
       +
         testBuildFailure = drv: drv.overrideAttrs (orig: {

     

       7
       7
       +
           builder = buildPackages.bash;

     

       8
       8
       +
           args = [

     

       9
       9
       +
             (substituteAll { coreutils = buildPackages.coreutils; src = ./expect-failure.sh; })

     

       10
       10
       +
             orig.realBuilder or stdenv.shell

     

       11
       11
       +
           ] ++ orig.args or ["-e" (orig.builder or ../../stdenv/generic/default-builder.sh)];

     

       12
       12
       +
         });

     

       13
       13
       +
       

     

       14
       14
       +
         # See https://nixos.org/manual/nixpkgs/unstable/#tester-testEqualDerivation

     

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

     

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

     

       5
       17
        
       

     

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

     

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

     

       20
       20
       +
         testEqualContents = {

     

       21
       21
       +
           assertion,

     

       22
       22
       +
           actual,

     

       23
       23
       +
           expected,

     

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

     

       25
       25
       +
           inherit assertion actual expected;

     

       26
       26
       +
         } ''

     

       27
       27
       +
           echo "Checking:"

     

       28
       28
       +
           echo "$assertion"

     

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

     

       30
       30
       +
           then

     

       31
       31
       +
             echo

     

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

     

       33
       33
       +
             echo

     

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

     

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

     

       36
       36
       +
             exit 1

     

       37
       37
       +
           else

     

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

     

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

     

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

     

       41
       41
       +
             then

     

       42
       42
       +
               echo

     

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

     

       44
       44
       +
               echo

     

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

     

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

     

       47
       47
       +
               exit 1

     

       48
       48
       +
             else

     

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

     

       50
       50
       +
               echo 'OK'

     

       51
       51
       +
               touch $out

     

       52
       52
       +
             fi

     

       53
       53
       +
           fi

     

       54
       54
       +
         '';

     

       55
       55
       +
       

     

       56
       56
       +
         # See https://nixos.org/manual/nixpkgs/unstable/#tester-testVersion

     

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

     

       6
       58
        
         testVersion =

     

       7
       59
        
           { package,

     

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

+62

pkgs/build-support/testers/expect-failure.sh

···

       1
       1
       +
       # Run a builder, flip exit code, save log and fix outputs

     

       2
       2
       +
       #

     

       3
       3
       +
       # Sub-goals:

     

       4
       4
       +
       # - Delegate to another original builder passed via args

     

       5
       5
       +
       # - Save the build log to output for further checks

     

       6
       6
       +
       # - Make the derivation succeed if the original builder fails

     

       7
       7
       +
       # - Make the derivation fail if the original builder returns exit code 0

     

       8
       8
       +
       #

     

       9
       9
       +
       # Requirements:

     

       10
       10
       +
       # This runs before, without and after stdenv. Do not modify the environment;

     

       11
       11
       +
       # especially not before invoking the original builder. For example, use

     

       12
       12
       +
       # "@" substitutions instead of PATH.

     

       13
       13
       +
       # Do not export any variables.

     

       14
       14
       +
       

     

       15
       15
       +
       # Stricter bash

     

       16
       16
       +
       set -eu

     

       17
       17
       +
       

     

       18
       18
       +
       # ------------------------

     

       19
       19
       +
       # Run the original builder

     

       20
       20
       +
       

     

       21
       21
       +
       echo "testBuildFailure: Expecting non-zero exit from builder and args: ${*@Q}"

     

       22
       22
       +
       

     

       23
       23
       +
       ("$@" 2>&1) | @coreutils@/bin/tee $TMPDIR/testBuildFailure.log \

     

       24
       24
       +
         | while read ln; do

     

       25
       25
       +
           echo "original builder: $ln"

     

       26
       26
       +
         done

     

       27
       27
       +
       

     

       28
       28
       +
       r=${PIPESTATUS[0]}

     

       29
       29
       +
       if [[ $r = 0 ]]; then

     

       30
       30
       +
         echo "testBuildFailure: The builder did not fail, but a failure was expected!"

     

       31
       31
       +
         exit 1

     

       32
       32
       +
       fi

     

       33
       33
       +
       echo "testBuildFailure: Original builder produced exit code: $r"

     

       34
       34
       +
       

     

       35
       35
       +
       # -----------------------------------------

     

       36
       36
       +
       # Write the build log to the default output

     

       37
       37
       +
       

     

       38
       38
       +
       outs=( $outputs )

     

       39
       39
       +
       defOut=${outs[0]}

     

       40
       40
       +
       defOutPath=${!defOut}

     

       41
       41
       +
       

     

       42
       42
       +
       if [[ ! -d $defOutPath ]]; then

     

       43
       43
       +
         if [[ -e $defOutPath ]]; then

     

       44
       44
       +
           @coreutils@/bin/mv $defOutPath $TMPDIR/out-node

     

       45
       45
       +
           @coreutils@/bin/mkdir $defOutPath

     

       46
       46
       +
           @coreutils@/bin/mv $TMPDIR/out-node $defOutPath/result

     

       47
       47
       +
         fi

     

       48
       48
       +
       fi

     

       49
       49
       +
       

     

       50
       50
       +
       @coreutils@/bin/mkdir -p $defOutPath

     

       51
       51
       +
       @coreutils@/bin/mv $TMPDIR/testBuildFailure.log $defOutPath/testBuildFailure.log

     

       52
       52
       +
       echo $r >$defOutPath/testBuildFailure.exit

     

       53
       53
       +
       

     

       54
       54
       +
       # ------------------------------------------------------

     

       55
       55
       +
       # Put empty directories in place for any missing outputs

     

       56
       56
       +
       

     

       57
       57
       +
       for outputName in ${outputs:-out}; do

     

       58
       58
       +
         outputPath="${!outputName}"

     

       59
       59
       +
         if [[ ! -e "${outputPath}" ]]; then

     

       60
       60
       +
           @coreutils@/bin/mkdir "${outputPath}";

     

       61
       61
       +
         fi

     

       62
       62
       +
       done

+164 -1

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

···

       1
       1
       -
       { testers, lib, pkgs, ... }:

     

       1
       1
       +
       { testers, lib, pkgs, hello, runCommand, ... }:

     

       2
       2
        
       let

     

       3
       3
        
         pkgs-with-overlay = pkgs.extend(final: prev: {

     

       4
       4
        
           proof-of-overlay-hello = prev.hello;

     
···

       24
       24
        
             machine.succeed("hello | figlet >/dev/console")

     

       25
       25
        
           '';

     

       26
       26
        
         });

     

       27
       27
       +
       

     

       28
       28
       +
         testBuildFailure = lib.recurseIntoAttrs {

     

       29
       29
       +
           happy = runCommand "testBuildFailure-happy" {

     

       30
       30
       +
             failed = testers.testBuildFailure (runCommand "fail" {} ''

     

       31
       31
       +
               echo ok-ish >$out

     

       32
       32
       +
               echo failing though

     

       33
       33
       +
               echo also stderr 1>&2

     

       34
       34
       +
               exit 3

     

       35
       35
       +
             '');

     

       36
       36
       +
           } ''

     

       37
       37
       +
             grep -F 'failing though' $failed/testBuildFailure.log

     

       38
       38
       +
             grep -F 'also stderr' $failed/testBuildFailure.log

     

       39
       39
       +
             grep -F 'ok-ish' $failed/result

     

       40
       40
       +
             [[ 3 = $(cat $failed/testBuildFailure.exit) ]]

     

       41
       41
       +
             touch $out

     

       42
       42
       +
           '';

     

       43
       43
       +
       

     

       44
       44
       +
           helloDoesNotFail = runCommand "testBuildFailure-helloDoesNotFail" {

     

       45
       45
       +
             failed = testers.testBuildFailure (testers.testBuildFailure hello);

     

       46
       46
       +
       

     

       47
       47
       +
             # Add hello itself as a prerequisite, so we don't try to run this test if

     

       48
       48
       +
             # there's an actual failure in hello.

     

       49
       49
       +
             inherit hello;

     

       50
       50
       +
           } ''

     

       51
       51
       +
             echo "Checking $failed/testBuildFailure.log"

     

       52
       52
       +
             grep -F 'testBuildFailure: The builder did not fail, but a failure was expected' $failed/testBuildFailure.log

     

       53
       53
       +
             [[ 1 = $(cat $failed/testBuildFailure.exit) ]]

     

       54
       54
       +
             touch $out

     

       55
       55
       +
           '';

     

       56
       56
       +
       

     

       57
       57
       +
           multiOutput = runCommand "testBuildFailure-multiOutput" {

     

       58
       58
       +
             failed = testers.testBuildFailure (runCommand "fail" {

     

       59
       59
       +
               # dev will be the default output

     

       60
       60
       +
               outputs = ["dev" "doc" "out"];

     

       61
       61
       +
             } ''

     

       62
       62
       +
               echo i am failing

     

       63
       63
       +
               exit 1

     

       64
       64
       +
             '');

     

       65
       65
       +
           } ''

     

       66
       66
       +
             grep -F 'i am failing' $failed/testBuildFailure.log >/dev/null

     

       67
       67
       +
             [[ 1 = $(cat $failed/testBuildFailure.exit) ]]

     

       68
       68
       +
       

     

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

     

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

     

       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
       +
         };

     

       27
       190
        
       }