# GNU Guix --- Functional package management for GNU
# Copyright © 2014 Cyril Roelandt <tipecaml@gmail.com>
#
# 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 lint' command-line utility.
#

guix lint --version

# Choose a module directory not below any %LOAD-PATH component.  This is
# necessary when testing '-L' with a relative file name.
module_dir="$(mktemp -d)"

mkdir -p "$module_dir"
trap "rm -rf $module_dir" EXIT


cat > "$module_dir/foo.scm"<<EOF
(define-module (foo)
  #:use-module (guix packages)
  #:use-module (gnu packages base))

(define-public dummy
  (package (inherit hello)
    (name "dummy")
    (version "42")
    (synopsis "dummy package")
    (description "dummy package. Only used for testing purposes.")))
EOF

GUIX_PACKAGE_PATH="$module_dir"
export GUIX_PACKAGE_PATH

grep_warning ()
{
    res=`echo "$1" | grep -E -c "(synopsis|description) should"`
    echo $res
}

# Three issues with the dummy package:
# 1) the synopsis starts with the package name;
# 2) the synopsis starts with a lower-case letter;
# 3) the description has a single space following the end-of-sentence period.

out=`guix lint -c synopsis,description dummy 2>&1`
test `grep_warning "$out"` -eq 3

out=`guix lint -c synopsis dummy 2>&1`
test `grep_warning "$out"` -eq 2

out=`guix lint -c description dummy 2>&1`
test `grep_warning "$out"` -eq 1

out=`guix lint -c description,synopsis dummy 2>&1`
test `grep_warning "$out"` -eq 3

guix lint -c synopsis,invalid-checker dummy 2>&1 | \
   grep -q 'invalid-checker: invalid checker'

# Make sure specifying multiple packages works.
guix lint -c inputs-should-be-native dummy dummy@42 dummy


# Use --load-path instead.
unset GUIX_PACKAGE_PATH

out=`guix lint -L $module_dir -c synopsis,description dummy 2>&1`
test `grep_warning "$out"` -eq 3

# Make sure specifying multiple packages works.
guix lint -L $module_dir -c inputs-should-be-native dummy dummy@42 dummy

# Test '-L' with a relative file name.  'guix lint' will see "t-xyz/foo.scm"
# (instead of "foo.scm") and will thus fail to find it in %LOAD-PATH.  Check
# that it does find it anyway.  See <https://bugs.gnu.org/42543>.
(cd "$module_dir"/.. ; guix lint -c formatting -L "$(basename "$module_dir")" dummy@42) 2>&1 > "$module_dir/out"
test -z "$(cat "$module_dir/out")"
9:20:23 +0200'>2020-06-05</span></td><td><a href='/guix/commit/tests/syscalls.scm?id=ea924134f819eef072ba7df9080d39de97fd73e6'>tests: syscall: Support file-systems without extended attributes.</a><span class='msg-avail'>...</span></td><td>Mathieu Othacehe</td></tr>
<tr><td><span title='2020-06-02 10:24:03 +0200'>2020-06-02</span></td><td><a href='/guix/commit/tests/syscalls.scm?id=cb21c14b0ae1f4c9fcad4927e3b2eb0c06d7b018'>tests: Allow passing on systems without support for swap devices.</a><span class='msg-avail'>...</span></td><td>Simon South</td></tr>
<tr><td><span title='2020-05-14 00:48:12 +0200'>2020-05-14</span></td><td><a href='/guix/commit/tests/syscalls.scm?id=df05842332be80ed7f53022402b95cf711163b41'>syscalls: Add 'getxattr'.</a><span class='msg-avail'>...</span></td><td>Jan (janneke) Nieuwenhuizen</td></tr>
<tr><td><span title='2020-02-11 12:33:35 +0100'>2020-02-11</span></td><td><a href='/guix/commit/tests/syscalls.scm?id=1deca767be1b84b96633e317f3fcdd5165f95df3'>syscalls: Re-enable 'pivot-root' test.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2019-10-05 22:05:02 +0200'>2019-10-05</span></td><td><a href='/guix/commit/tests/syscalls.scm?id=5e5f7167943b408ae55736a44908a82056c87780'>syscalls: Add 'add-to-entropy-count'.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2019-06-27 11:14:40 +0200'>2019-06-27</span></td><td><a href='/guix/commit/tests/syscalls.scm?id=4593f5a654b4e59c5025cc4f99914e24e82515a4'>syscalls: Add 'terminal-rows'.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2018-07-03 17:50:04 +0200'>2018-07-03</span></td><td><a href='/guix/commit/tests/syscalls.scm?id=25c7ff6a3ecbaa1e93b38d35c8cbff40b7f4edb8'>syscalls: Define AT_SYMLINK_NOFOLLOW et al.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2018-04-08 17:41:08 +0200'>2018-04-08</span></td><td><a href='/guix/commit/tests/syscalls.scm?id=6ef80eb0d94181eb5f755a11fca0d428252ce753'>tests: Skip 'pivot-root' test on Ubuntu's 4.4 kernels.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2017-11-25 18:12:33 +0100'>2017-11-25</span></td><td><a href='/guix/commit/tests/syscalls.scm?id=4aac8d059a2bec9f075ceea2a089ca029a71912c'>syscalls: Adjust utmpx test.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2017-07-12 16:15:30 +0200'>2017-07-12</span></td><td><a href='/guix/commit/tests/syscalls.scm?id=0bc6fe323d34aabc7f51fa80b8872a2c1770d32a'>syscalls: Add network-interface-running?</a><span class='msg-avail'>...</span></td><td>Danny Milosavljevic</td></tr>
<tr><td><span title='2017-06-16 17:08:22 +0200'>2017-06-16</span></td><td><a href='/guix/commit/tests/syscalls.scm?id=fa73c1937364872560c509f02b3d7648a5bed006'>syscalls: Add 'scandir*'.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2017-05-28 23:13:39 +0200'>2017-05-28</span></td><td><a href='/guix/commit/tests/syscalls.scm?id=aa401f9ba6410095370ce0c4e5a01c02203a2b9f'>syscalls: Add 'thread-name' and 'set-thread-name'.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>