···

       
118
       
118
       
 
       


     

       
119
       
119
       
 
       
## `shellcheck` {#tester-shellcheck}

     

       
120
       
120
       
 
       


     

       
121
       
121
       
-
       
Runs files through `shellcheck`, a static analysis tool for shell scripts.

     

       
121
       
121
       
+
       
Run files through `shellcheck`, a static analysis tool for shell scripts, failing if there are any issues.

     

       
122
       
122
       
 
       


     

       
123
       
123
       
 
       
:::{.example #ex-shellcheck}

     

       
124
       
124
       
 
       
# Run `testers.shellcheck`

     
···

       
127
       
127
       
 
       


     

       
128
       
128
       
 
       
```nix

     

       
129
       
129
       
 
       
testers.shellcheck {

     

       
130
       
130
       
-
       
  name = "shellcheck";

     

       
130
       
130
       
+
       
  name = "script";

     

       
131
       
131
       
 
       
  src = ./script.sh;

     

       
132
       
132
       
 
       
}

     

       
133
       
133
       
 
       
```

     
···

       
139
       
139
       
 
       
  inherit (lib) fileset;

     

       
140
       
140
       
 
       
in

     

       
141
       
141
       
 
       
testers.shellcheck {

     

       
142
       
142
       
-
       
  name = "shellcheck";

     

       
142
       
142
       
+
       
  name = "nixbsd-activate";

     

       
143
       
143
       
 
       
  src = fileset.toSource {

     

       
144
       
144
       
 
       
    root = ./.;

     

       
145
       
145
       
 
       
    fileset = fileset.unions [

     
···

       
154
       
154
       
 
       


     

       
155
       
155
       
 
       
### Inputs {#tester-shellcheck-inputs}

     

       
156
       
156
       
 
       


     

       
157
       
157
       
-
       
[`src` (path or string)]{#tester-shellcheck-param-src}

     

       
157
       
157
       
+
       
`name` (string, optional)

     

       
158
       
158
       
+
       
: The name of the test.

     

       
159
       
159
       
+
       
  `name` will be required at a future point because it massively improves traceability of test failures, but is kept optional for now to avoid breaking existing usages.

     

       
160
       
160
       
+
       
  Defaults to `run-shellcheck`.

     

       
161
       
161
       
+
       
  The name of the derivation produced by the tester is `shellcheck-${name}` when `name` is supplied.

     

       
158
       
162
       
 
       


     

       
163
       
163
       
+
       
`src` (path-like)

     

       
159
       
164
       
 
       
: The path to the shell script(s) to check.

     

       
160
       
165
       
 
       
  This can be a single file or a directory containing shell files.

     

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

     

       
162
       
167
       
 
       


     

       
163
       
168
       
 
       
### Return value {#tester-shellcheck-return}

     

       
164
       
169
       
 
       


     

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

     

       
170
       
170
       
+
       
A derivation that runs `shellcheck` on the given script(s), producing an empty output if no issues are found.

     

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

     

       
167
       
172
       
 
       


     

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

     

···

       
1533
       
1533
       
 
       
  "tester-shellcheck-inputs": [

     

       
1534
       
1534
       
 
       
    "index.html#tester-shellcheck-inputs"

     

       
1535
       
1535
       
 
       
  ],

     

       
1536
       
1536
       
-
       
  "tester-shellcheck-param-src": [

     

       
1537
       
1537
       
-
       
    "index.html#tester-shellcheck-param-src"

     

       
1538
       
1538
       
-
       
  ],

     

       
1539
       
1536
       
 
       
  "tester-shellcheck-return": [

     

       
1540
       
1537
       
 
       
    "index.html#tester-shellcheck-return"

     

       
1541
       
1538
       
 
       
  ],

     

···

       
11
       
11
       
 
       
- The hand written `perlPackages.SearchXapian` bindings have been dropped in favor of the (mostly compatible)

     

       
12
       
12
       
 
       
  `perlPackages.Xapian`.

     

       
13
       
13
       
 
       


     

       
14
       
14
       
+
       
- [testers.shellcheck](https://nixos.org/manual/nixpkgs/unstable/#tester-shellcheck) now warns when `name` is not provided.

     

       
15
       
15
       
+
       
  The `name` argument will become mandatory in a future release.

     

       
16
       
16
       
+
       


     

       
14
       
17
       
 
       
- The `nixLog*` family of functions made available through the standard environment have been rewritten to prefix messages with both the debug level and the function name of the caller.

     

       
15
       
18
       
 
       
  The `nixLog` function, which logs unconditionally, was also re-introduced and modified to prefix messages with the function name of the caller.

     

       
16
       
19
       
 
       
  For more information, [see this PR](https://github.com/NixOS/nixpkgs/pull/370742).

     

···

       
1
       
1
       
 
       
# Dependencies (callPackage)

     

       
2
       
2
       
 
       
{

     

       
3
       
3
       
 
       
  lib,

     

       
4
       
4
       
-
       
  stdenv,

     

       
5
       
5
       
-
       
  runCommand,

     

       
4
       
4
       
+
       
  stdenvNoCC,

     

       
6
       
5
       
 
       
  shellcheck,

     

       
7
       
6
       
 
       
}:

     

       
8
       
7
       
 
       


     

       
9
       
8
       
 
       
# testers.shellcheck function

     

       
10
       
9
       
 
       
# Docs: doc/build-helpers/testers.chapter.md

     

       
11
       
10
       
 
       
# Tests: ./tests.nix

     

       
12
       
12
       
-
       
{ src }:

     

       
13
       
13
       
-
       
let

     

       
14
       
14
       
-
       
  inherit (lib) pathType isPath;

     

       
15
       
15
       
-
       
in

     

       
16
       
16
       
-
       
stdenv.mkDerivation {

     

       
17
       
17
       
-
       
  name = "run-shellcheck";

     

       
18
       
18
       
-
       
  src =

     

       
19
       
19
       
-
       
    if

     

       
20
       
20
       
-
       
      isPath src && pathType src == "regular" # note that for strings this would have been IFD, which we prefer to avoid

     

       
21
       
21
       
-
       
    then

     

       
22
       
22
       
-
       
      runCommand "testers-shellcheck-src" { } ''

     

       
23
       
23
       
-
       
        mkdir $out

     

       
24
       
24
       
-
       
        cp ${src} $out

     

       
25
       
25
       
-
       
      ''

     

       
11
       
11
       
+
       
{

     

       
12
       
12
       
+
       
  name ? null,

     

       
13
       
13
       
+
       
  src,

     

       
14
       
14
       
+
       
}:

     

       
15
       
15
       
+
       
stdenvNoCC.mkDerivation {

     

       
16
       
16
       
+
       
  __structuredAttrs = true;

     

       
17
       
17
       
+
       
  strictDeps = true;

     

       
18
       
18
       
+
       
  name =

     

       
19
       
19
       
+
       
    if name == null then

     

       
20
       
20
       
+
       
      lib.warn "testers.shellcheck: name will be required in a future release, defaulting to run-shellcheck" "run-shellcheck"

     

       
26
       
21
       
 
       
    else

     

       
27
       
27
       
-
       
      src;

     

       
22
       
22
       
+
       
      "shellcheck-${name}";

     

       
23
       
23
       
+
       
  inherit src;

     

       
24
       
24
       
+
       
  dontUnpack = true; # Unpack phase tries to extract an archive, which we don't want to do with source trees

     

       
28
       
25
       
 
       
  nativeBuildInputs = [ shellcheck ];

     

       
29
       
26
       
 
       
  doCheck = true;

     

       
30
       
27
       
 
       
  dontConfigure = true;

     

       
31
       
28
       
 
       
  dontBuild = true;

     

       
32
       
29
       
 
       
  checkPhase = ''

     

       
33
       
33
       
-
       
    find . -type f -print0 \

     

       
34
       
34
       
-
       
      | xargs -0 shellcheck

     

       
30
       
30
       
+
       
    find "$src" -type f -print0 | xargs -0 shellcheck

     

       
35
       
31
       
 
       
  '';

     

       
36
       
32
       
 
       
  installPhase = ''

     

       
37
       
37
       
-
       
    touch $out

     

       
33
       
33
       
+
       
    touch "$out"

     

       
38
       
34
       
 
       
  '';

     

       
39
       
35
       
 
       
}

     

···

       
13
       
13
       
 
       
      {

     

       
14
       
14
       
 
       
        failure = testers.testBuildFailure (

     

       
15
       
15
       
 
       
          testers.shellcheck {

     

       
16
       
16
       
+
       
            name = "shellcheck-example-dir";

     

       
16
       
17
       
 
       
            src = ./src;

     

       
17
       
18
       
 
       
          }

     

       
18
       
19
       
 
       
        );

     
···

       
29
       
30
       
 
       
      {

     

       
30
       
31
       
 
       
        failure = testers.testBuildFailure (

     

       
31
       
32
       
 
       
          testers.shellcheck {

     

       
33
       
33
       
+
       
            name = "shellcheck-example-file";

     

       
32
       
34
       
 
       
            src = ./src/example.sh;

     

       
33
       
35
       
 
       
          }

     

       
34
       
36
       
 
       
        );