nix/tests/functional/timeout.sh

#!/usr/bin/env bash

# Test the `--timeout' option.

source common.sh

# XXX: This shouldn’t be, but #4813 cause this test to fail
needLocalStore "see #4813"

messages=$(nix-build -Q timeout.nix -A infiniteLoop --timeout 2 2>&1) && status=0 || status=$?

if [ "$status" -ne 101 ]; then
    echo "error: 'nix-store' exited with '$status'; should have exited 101"

    # FIXME: https://github.com/NixOS/nix/issues/4813
    skipTest "Do not block CI until fixed"

    exit 1
fi

if echo "$messages" | grepQuietInvert "timed out"; then
    echo "error: build may have failed for reasons other than timeout; output:"
    echo "$messages" >&2
    exit 1
fi

if nix-build -Q timeout.nix -A infiniteLoop --max-build-log-size 100; then
    echo "build should have failed"
    exit 1
fi

if nix-build timeout.nix -A silent --max-silent-time 2; then
    echo "build should have failed"
    exit 1
fi

if nix-build timeout.nix -A closeLog; then
    echo "build should have failed"
    exit 1
fi

if nix build -f timeout.nix silent --max-silent-time 2; then
    echo "build should have failed"
    exit 1
fi
-												Ensure all functional scripts are (a) executable (b) have shebang

This is good for shebang, and also good for future build system
simplifications

											
										
										
											2024-05-28 16:43:04 +00:00
+								#!/usr/bin/env bash
-												Add support for the `build-timeout' and `--timeout' options.

											
										
										
											2011-06-30 15:19:13 +00:00
+								# Test the `--timeout' option.
 								source common.sh
-												Allow running all the tests with the daemon

When `NIX_DAEMON_PACKAGE` is set, make all the tests use the Nix daemon.
That way we can test every piece of Nix functionality both with and
without the daemon.

Tests for which using the daemon isn’t possible or doesn’t make sens can
selectively be disabled with `needLocalStore`

											
										
										
											2021-07-26 04:54:55 +00:00
+								# XXX: This shouldn’t be, but #4813 cause this test to fail
 								needLocalStore "see #4813"
-												timeout: test for error code

											
										
										
											2019-07-02 15:18:36 +00:00
-												Harden tests' bash

Use `set -u` and `set -o pipefail` to catch accidental mistakes and
failures more strongly.

 - `set -u` catches the use of undefined variables
 - `set -o pipefail` catches failures (like `set -e`) earlier in the
   pipeline.

This makes the tests a bit more robust. It is nice to read code not
worrying about these spurious success paths (via uncaught) errors
undermining the tests. Indeed, I caught some bugs doing this.

There are a few tests where we run a command that should fail, and then
search its output to make sure the failure message is one that we
expect. Before, since the `grep` was the last command in the pipeline
the exit code of those failing programs was silently ignored. Now with
`set -o pipefail` it won't be, and we have to do something so the
expected failure doesn't accidentally fail the test.

To do that we use `expect` and a new `expectStderr` to check for the
exact failing exit code. See the comments on each for why.

`grep -q` is replaced with `grepQuiet`, see the comments on that
function for why.

`grep -v` when we just want the exit code is replaced with `grepInverse,
see the comments on that function for why.

`grep -q -v` together is, surprise surprise, replaced with
`grepQuietInverse`, which is both combined.

Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>

											
										
										
											2021-12-09 15:26:46 +00:00
+								messages=$(nix-build -Q timeout.nix -A infiniteLoop --timeout 2 2>&1) && status=0 || status=$?
-												timeout: test for error code

											
										
										
											2019-07-02 15:18:36 +00:00
-												Fix a few shellcheck tests

Ref nixos/nix#10795

											
										
										
											2024-08-01 22:10:08 +00:00
+								if [ "$status" -ne 101 ]; then
-												timeout: test for error code

											
										
										
											2019-07-02 15:18:36 +00:00
+								    echo "error: 'nix-store' exited with '$status'; should have exited 101"
-												tests/functional/timeout.sh: Find missing test case

This reproduces an instance of
https://github.com/NixOS/nix/issues/4813

											
										
										
											2024-06-16 11:02:04 +00:00
 								    # FIXME: https://github.com/NixOS/nix/issues/4813
 								    skipTest "Do not block CI until fixed"
-												Add support for the `build-timeout' and `--timeout' options.

											
										
										
											2011-06-30 15:19:13 +00:00
+								    exit 1
 								fi
-												Harden tests' bash

Use `set -u` and `set -o pipefail` to catch accidental mistakes and
failures more strongly.

 - `set -u` catches the use of undefined variables
 - `set -o pipefail` catches failures (like `set -e`) earlier in the
   pipeline.

This makes the tests a bit more robust. It is nice to read code not
worrying about these spurious success paths (via uncaught) errors
undermining the tests. Indeed, I caught some bugs doing this.

There are a few tests where we run a command that should fail, and then
search its output to make sure the failure message is one that we
expect. Before, since the `grep` was the last command in the pipeline
the exit code of those failing programs was silently ignored. Now with
`set -o pipefail` it won't be, and we have to do something so the
expected failure doesn't accidentally fail the test.

To do that we use `expect` and a new `expectStderr` to check for the
exact failing exit code. See the comments on each for why.

`grep -q` is replaced with `grepQuiet`, see the comments on that
function for why.

`grep -v` when we just want the exit code is replaced with `grepInverse,
see the comments on that function for why.

`grep -q -v` together is, surprise surprise, replaced with
`grepQuietInverse`, which is both combined.

Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>

											
										
										
											2021-12-09 15:26:46 +00:00
+								if echo "$messages" | grepQuietInvert "timed out"; then
-												Adda test for build-max-log-size

											
										
										
											2013-09-02 10:44:30 +00:00
+								    echo "error: build may have failed for reasons other than timeout; output:"
-												Add support for the `build-timeout' and `--timeout' options.

											
										
										
											2011-06-30 15:19:13 +00:00
+								    echo "$messages" >&2
 								    exit 1
 								fi
-												Adda test for build-max-log-size

											
										
										
											2013-09-02 10:44:30 +00:00
-												Test: Replace --option with the corresponding flag

											
										
										
											2017-11-20 16:50:49 +00:00
+								if nix-build -Q timeout.nix -A infiniteLoop --max-build-log-size 100; then
-												Add a test for --max-silent-time

											
										
										
											2017-01-19 13:17:57 +00:00
+								    echo "build should have failed"
 								    exit 1
 								fi
 								if nix-build timeout.nix -A silent --max-silent-time 2; then
-												Adda test for build-max-log-size

											
										
										
											2013-09-02 10:44:30 +00:00
+								    echo "build should have failed"
 								    exit 1
 								fi
-												Kill builds when we get EOF on the log FD

This closes a long-time bug that allowed builds to hang Nix
indefinitely (regardless of timeouts) simply by doing

  exec > /dev/null 2>&1; while true; do true; done

Now, on EOF, we just send SIGKILL to the child to make sure it's
really gone.

											
										
										
											2017-01-19 15:58:39 +00:00
 								if nix-build timeout.nix -A closeLog; then
 								    echo "build should have failed"
 								    exit 1
 								fi
-												Process nix.conf options in "new" nix commands, add test.

Without this (minor) change, the options set using "--option"
or read from nix.conf were parsed but not used.

											
										
										
											2017-04-05 12:34:10 +00:00
-												Rename a few configuration options

In particular, drop the "build-" and "gc-" prefixes which are
pointless. So now you can say

  nix build --no-sandbox

instead of

  nix build --no-build-use-sandbox

											
										
										
											2017-08-31 12:28:25 +00:00
+								if nix build -f timeout.nix silent --max-silent-time 2; then
-												Process nix.conf options in "new" nix commands, add test.

Without this (minor) change, the options set using "--option"
or read from nix.conf were parsed but not used.

											
										
										
											2017-04-05 12:34:10 +00:00
+								    echo "build should have failed"
 								    exit 1
 								fi