# GNU Guix --- Functional package management for GNU
# Copyright © 2013, 2015, 2017 Ludovic Courtès <ludo@gnu.org>
#
# This file is part of GNU Guix.
#
# GNU Guix is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or (at
# your option) any later version.
#
# GNU Guix is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.

#
# Test the `guix gc' command-line utility.
#

guix gc --version

trap "rm -f guix-gc-root" EXIT
rm -f guix-gc-root

# Below we are using 'drv' and 'out' to contain store file names.  If 'drv'
# and 'out' are environment variables, 'list-runtime-roots' will "see" them
# and thus prevent $drv and $out from being garbage-collected.  Using 'unset'
# allows us to make sure these are truly local shell variables and not
# environments variables.
unset drv
unset out

# For some operations, passing extra arguments is an error.
for option in "" "-C 500M" "--verify" "--optimize"
do
    if guix gc $option whatever; then false; else true; fi
done

# This should fail.
if guix gc --verify=foo; then false; else true; fi

# Check the references of a .drv.
drv="`guix build guile-bootstrap -d`"
out="`guix build guile-bootstrap`"
test -f "$drv" && test -d "$out"

guix gc --references "$drv" | grep -e -bash
guix gc --references "$out"
guix gc --references "$out/bin/guile"

if guix gc --references /dev/null;
then false; else true; fi

# Add then reclaim a .drv file.
drv="`guix build idutils -d`"
test -f "$drv"

guix gc --list-dead | grep "$drv"
guix gc --delete "$drv"
! test -f "$drv"

# Add a .drv, register it as a root.
drv="`guix build --root=guix-gc-root lsh -d`"
test -f "$drv" && test -L guix-gc-root

guix gc --list-live | grep "$drv"
if guix gc --delete "$drv";
then false; else true; fi

rm guix-gc-root
guix gc --list-dead | grep "$drv"
guix gc --delete "$drv"
! test -f "$drv"

# Try a random collection.
guix gc -C 1KiB

# Check trivial error cases.
if guix gc --delete /dev/null;
then false; else true; fi

# Bug #19757
out="`guix build guile-bootstrap`"
test -d "$out"

guix gc --delete "$out"

! test -d "$out"

out="`guix build guile-bootstrap`"
test -d "$out"

guix gc --delete "$out/"

! test -d "$out"

out="`guix build guile-bootstrap`"
test -d "$out"

guix gc --delete "$out/bin/guile"
'2021-02-02 00:28:49 -0500'>2021-02-02</span></td><td><a href='/guix/commit/build-aux/test-driver.scm?id=5e652e94a9203e0cfa27e93a89878439b7900001'>build: Add a --show-duration option to the SCM test-driver.</a><span class='msg-avail'>...<span class='msg-tooltip'>* build-aux/test-driver.scm (script-version): Update.
(show-help): Document it.
(%options): Add the 'show-duration' option.
(test-runner-gnu): Pass as a new argument.
[test-cases-start-time]: New inner variable.
[test-on-test-begin-gnu]: New hook, used to record the start time.
[test-on-test-end-gnu]: Conditionally print elapsed time.  Record it as the
optional metadata in the test result file (.trs).
* doc/guix.texi (Running the Test Suite): Document it.
</span></span></td><td>Maxim Cournoyer</td></tr>
<tr><td><span title='2021-01-31 22:28:46 -0500'>2021-01-31</span></td><td><a href='/guix/commit/build-aux/test-driver.scm?id=26a66d0feaab7626c4053071d5557394931fe14b'>build: test-driver.scm: Allow running as a standalone script.</a><span class='msg-avail'>...<span class='msg-tooltip'>* build-aux/test-driver.scm: Add an exec-based shebang and set the script
executable bit.
(main): Insert a newline after the version string is printed with --version.
</span></span></td><td>Maxim Cournoyer</td></tr>
<tr><td><span title='2021-01-31 22:28:46 -0500'>2021-01-31</span></td><td><a href='/guix/commit/build-aux/test-driver.scm?id=93a628c4e4f4a7f6665190f3c52a417daebaf28a'>build: test-driver.scm: Add a new '--errors-only' option.</a><span class='msg-avail'>...<span class='msg-tooltip'>* build-aux/test-driver.scm (show-help): Add the help text for the
new '--errors-only' option.
(%options): Add the errors-only option.
(test-runner-gnu): Add the errors-only? parameter and update doc.  Move the
logging of the test data after the test has completed, so a choice can be made
whether to keep it or discard it based on the value of the test result.
(main): Pass the errors-only? option to the driver.
* doc/guix.texi (Running the Test Suite): Document the new option.
</span></span></td><td>Maxim Cournoyer</td></tr>
<tr><td><span title='2021-01-31 22:28:37 -0500'>2021-01-31</span></td><td><a href='/guix/commit/build-aux/test-driver.scm?id=a1ea2acb376c8a74f41ce0e683680417207b365a'>build: test-driver.scm: Add test cases filtering options.</a><span class='msg-avail'>...<span class='msg-tooltip'>* build-aux/test-driver.scm (show-help): Add help text for the new --select
and --exclude options.
(%options): Add the new select and exclude options.
(test-runner-gnu): Pass them to the test runner.  Update doc.
(test-match-name*, test-match-name*/negated, %test-match-all): New variables.
(main): Compute the test specifier based on the values of the new options and
apply it to the current test runner when running the test file.
* doc/guix.texi (Running the Test Suite): Document the new options.
</span></span></td><td>Maxim Cournoyer</td></tr>
<tr><td><span title='2021-01-31 22:23:41 -0500'>2021-01-31</span></td><td><a href='/guix/commit/build-aux/test-driver.scm?id=346210b1b2130112dd5f894c1d40afb37c1c51a5'>build: test-driver.scm: Enable colored test results by default.</a><span class='msg-avail'>...<span class='msg-tooltip'>The Automake parallel test harness does its own smart detection of the
terminal color capability and always provides the --color-tests argument to
the driver.  This change defaults the --color-tests argument to true when the
test driver is run on its own (not via Automake).

* build-aux/test-driver.scm (main): Set the default value of the --color-tests
argument to true when it's not explicitly provided.
</span></span></td><td>Maxim Cournoyer</td></tr>
<tr><td><span title='2021-01-31 22:23:41 -0500'>2021-01-31</span></td><td><a href='/guix/commit/build-aux/test-driver.scm?id=13f299b2c98cce0ede3a8a37dd11832fdb3827bb'>build: test-driver.scm: Make output redirection optional.</a><span class='msg-avail'>...<span class='msg-tooltip'>This makes it easier (and less surprising) for users to experiment with the
custom Scheme test driver directly.  The behavior is unchanged from Automake's
point of view.

* build-aux/test-driver.scm (main): Make the --log-file and --trs-file
arguments optional and update doc.  Only open, redirect and close a port to a log file when
the --log-file option is provided.  Only open and close a port to a trs file
when the --trs-file option is provided.
(test-runner-gnu): Set OUT-PORT parameter default value to the current output
port.  Set the TRS-PORT parameter default value to a void port.  Update doc.
</span></span></td><td>Maxim Cournoyer</td></tr>