commit cb26667f94d3d1163ba0e0e1b9cf9881290a7731 · pyrox.dev/nixpkgs

+58

doc/build-helpers/testers.chapter.md

···

       165
       165
        
       A derivation that runs `shellcheck` on the given script(s).

     

       166
       166
        
       The build will fail if `shellcheck` finds any issues.

     

       167
       167
        
       

     

       168
       168
       +
       ## `shfmt` {#tester-shfmt}

     

       169
       169
       +
       

     

       170
       170
       +
       Run files through `shfmt`, a shell script formatter, failing if any files are reformatted.

     

       171
       171
       +
       

     

       172
       172
       +
       :::{.example #ex-shfmt}

     

       173
       173
       +
       # Run `testers.shfmt`

     

       174
       174
       +
       

     

       175
       175
       +
       A single script

     

       176
       176
       +
       

     

       177
       177
       +
       ```nix

     

       178
       178
       +
       testers.shfmt {

     

       179
       179
       +
         name = "script";

     

       180
       180
       +
         src = ./script.sh;

     

       181
       181
       +
       }

     

       182
       182
       +
       ```

     

       183
       183
       +
       

     

       184
       184
       +
       Multiple files

     

       185
       185
       +
       

     

       186
       186
       +
       ```nix

     

       187
       187
       +
       let

     

       188
       188
       +
         inherit (lib) fileset;

     

       189
       189
       +
       in

     

       190
       190
       +
       testers.shfmt {

     

       191
       191
       +
         name = "nixbsd";

     

       192
       192
       +
         src = fileset.toSource {

     

       193
       193
       +
           root = ./.;

     

       194
       194
       +
           fileset = fileset.unions [

     

       195
       195
       +
             ./lib.sh

     

       196
       196
       +
             ./nixbsd-activate

     

       197
       197
       +
           ];

     

       198
       198
       +
         };

     

       199
       199
       +
       }

     

       200
       200
       +
       ```

     

       201
       201
       +
       

     

       202
       202
       +
       :::

     

       203
       203
       +
       

     

       204
       204
       +
       ### Inputs {#tester-shfmt-inputs}

     

       205
       205
       +
       

     

       206
       206
       +
       `name` (string)

     

       207
       207
       +
       : The name of the test.

     

       208
       208
       +
         `name` is required because it massively improves traceability of test failures.

     

       209
       209
       +
         The name of the derivation produced by the tester is `shfmt-${name}`.

     

       210
       210
       +
       

     

       211
       211
       +
       `src` (path-like)

     

       212
       212
       +
       : The path to the shell script(s) to check.

     

       213
       213
       +
         This can be a single file or a directory containing shell files.

     

       214
       214
       +
         All files in `src` will be checked, so you may want to provide `fileset`-based source instead of a whole directory.

     

       215
       215
       +
       

     

       216
       216
       +
       `indent` (integer, optional)

     

       217
       217
       +
       : The number of spaces to use for indentation.

     

       218
       218
       +
         Defaults to `2`.

     

       219
       219
       +
         A value of `0` indents with tabs.

     

       220
       220
       +
       

     

       221
       221
       +
       ### Return value {#tester-shfmt-return}

     

       222
       222
       +
       

     

       223
       223
       +
       A derivation that runs `shfmt` on the given script(s), producing an empty output upon success.

     

       224
       224
       +
       The build will fail if `shfmt` reformats anything.

     

       225
       225
       +
       

     

       168
       226
        
       ## `testVersion` {#tester-testVersion}

     

       169
       227
        
       

     

       170
       228
        
       Checks that the output from running a command contains the specified version string in it as a whole word.

+12

doc/redirects.json

···

       8
       8
        
         "ex-build-helpers-extendMkDerivation": [

     

       9
       9
        
           "index.html#ex-build-helpers-extendMkDerivation"

     

       10
       10
        
         ],

     

       11
       11
       +
         "ex-shfmt": [

     

       12
       12
       +
           "index.html#ex-shfmt"

     

       13
       13
       +
         ],

     

       11
       14
        
         "ex-testBuildFailurePrime-doc-example": [

     

       12
       15
        
           "index.html#ex-testBuildFailurePrime-doc-example"

     

       13
       16
        
         ],

     
···

       337
       340
        
         ],

     

       338
       341
        
         "footnote-stdenv-find-inputs-location.__back.0": [

     

       339
       342
        
           "index.html#footnote-stdenv-find-inputs-location.__back.0"

     

       343
       343
       +
         ],

     

       344
       344
       +
         "tester-shfmt": [

     

       345
       345
       +
           "index.html#tester-shfmt"

     

       346
       346
       +
         ],

     

       347
       347
       +
         "tester-shfmt-inputs": [

     

       348
       348
       +
           "index.html#tester-shfmt-inputs"

     

       349
       349
       +
         ],

     

       350
       350
       +
         "tester-shfmt-return": [

     

       351
       351
       +
           "index.html#tester-shfmt-return"

     

       340
       352
        
         ],

     

       341
       353
        
         "tester-testBuildFailurePrime": [

     

       342
       354
        
           "index.html#tester-testBuildFailurePrime"

+2

pkgs/build-support/testers/default.nix

···

       194
       194
        
         testMetaPkgConfig = callPackage ./testMetaPkgConfig/tester.nix { };

     

       195
       195
        
       

     

       196
       196
        
         shellcheck = callPackage ./shellcheck/tester.nix { };

     

       197
       197
       +
       

     

       198
       198
       +
         shfmt = callPackage ./shfmt { };

     

       197
       199
        
       }

+29

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

···

       1
       1
       +
       {

     

       2
       2
       +
         lib,

     

       3
       3
       +
         shfmt,

     

       4
       4
       +
         stdenvNoCC,

     

       5
       5
       +
       }:

     

       6
       6
       +
       # See https://nixos.org/manual/nixpkgs/unstable/#tester-shfmt

     

       7
       7
       +
       # or doc/build-helpers/testers.chapter.md

     

       8
       8
       +
       {

     

       9
       9
       +
         name,

     

       10
       10
       +
         src,

     

       11
       11
       +
         indent ? 2,

     

       12
       12
       +
       }:

     

       13
       13
       +
       stdenvNoCC.mkDerivation (finalAttrs: {

     

       14
       14
       +
         __structuredAttrs = true;

     

       15
       15
       +
         strictDeps = true;

     

       16
       16
       +
         inherit src indent;

     

       17
       17
       +
         name = "shfmt-${name}";

     

       18
       18
       +
         dontUnpack = true; # Unpack phase tries to extract archive

     

       19
       19
       +
         nativeBuildInputs = [ shfmt ];

     

       20
       20
       +
         doCheck = true;

     

       21
       21
       +
         dontConfigure = true;

     

       22
       22
       +
         dontBuild = true;

     

       23
       23
       +
         checkPhase = ''

     

       24
       24
       +
           shfmt --diff --indent $indent --simplify "$src"

     

       25
       25
       +
         '';

     

       26
       26
       +
         installPhase = ''

     

       27
       27
       +
           touch "$out"

     

       28
       28
       +
         '';

     

       29
       29
       +
       })

+3

pkgs/build-support/testers/shfmt/src/indent2.sh

···

       1
       1
       +
       hello() {

     

       2
       2
       +
         echo "hello"

     

       3
       3
       +
       }

+43

pkgs/build-support/testers/shfmt/tests.nix

···

       1
       1
       +
       { lib, testers }:

     

       2
       2
       +
       lib.recurseIntoAttrs {

     

       3
       3
       +
         # Positive tests

     

       4
       4
       +
         indent2 = testers.shfmt {

     

       5
       5
       +
           name = "indent2";

     

       6
       6
       +
           indent = 2;

     

       7
       7
       +
           src = ./src/indent2.sh;

     

       8
       8
       +
         };

     

       9
       9
       +
         indent2Bin = testers.shfmt {

     

       10
       10
       +
           name = "indent2Bin";

     

       11
       11
       +
           indent = 2;

     

       12
       12
       +
           src = ./src;

     

       13
       13
       +
         };

     

       14
       14
       +
         # Negative tests

     

       15
       15
       +
         indent2With0 = testers.testBuildFailure' {

     

       16
       16
       +
           drv = testers.shfmt {

     

       17
       17
       +
             name = "indent2";

     

       18
       18
       +
             indent = 0;

     

       19
       19
       +
             src = ./src/indent2.sh;

     

       20
       20
       +
           };

     

       21
       21
       +
         };

     

       22
       22
       +
         indent2BinWith0 = testers.testBuildFailure' {

     

       23
       23
       +
           drv = testers.shfmt {

     

       24
       24
       +
             name = "indent2Bin";

     

       25
       25
       +
             indent = 0;

     

       26
       26
       +
             src = ./src;

     

       27
       27
       +
           };

     

       28
       28
       +
         };

     

       29
       29
       +
         indent2With4 = testers.testBuildFailure' {

     

       30
       30
       +
           drv = testers.shfmt {

     

       31
       31
       +
             name = "indent2";

     

       32
       32
       +
             indent = 4;

     

       33
       33
       +
             src = ./src/indent2.sh;

     

       34
       34
       +
           };

     

       35
       35
       +
         };

     

       36
       36
       +
         indent2BinWith4 = testers.testBuildFailure' {

     

       37
       37
       +
           drv = testers.shfmt {

     

       38
       38
       +
             name = "indent2Bin";

     

       39
       39
       +
             indent = 4;

     

       40
       40
       +
             src = ./src;

     

       41
       41
       +
           };

     

       42
       42
       +
         };

     

       43
       43
       +
       }

+2

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

···

       39
       39
        
       

     

       40
       40
        
         shellcheck = pkgs.callPackage ../shellcheck/tests.nix { };

     

       41
       41
        
       

     

       42
       42
       +
         shfmt = pkgs.callPackages ../shfmt/tests.nix { };

     

       43
       43
       +
       

     

       42
       44
        
         runCommand = lib.recurseIntoAttrs {

     

       43
       45
        
           bork = pkgs.python3Packages.bork.tests.pytest-network;

     

       44
       46