# 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")"

# Likewise, when there's a warning, 'package-field-location' used to crash
# because it can't find "t-xyz/foo.scm".  See <https://bugs.gnu.org/46390>.
(cd "$module_dir"/.. ; guix lint -c synopsis -L "$(basename "$module_dir")" dummy@42) 2>&1 > "$module_dir/out"
grep_warning "`cat "$module_dir/out"`"
</td><td>Vinicius Monego</td></tr>
<tr><td><span title='2023-04-24 19:49:04 +0200'>2023-04-24</span></td><td><a href='/guix/commit/gnu/packages/graph.scm?id=09d2976c86f2cb1841ebe0685164912bfedfeeb5'>gnu: python-plotly-2.4.1: Patch for Python 3.10 changes.</a><span class='msg-avail'>...</span></td><td>Ricardo Wurmus</td></tr>
<tr><td><span title='2023-03-16 00:10:59 +0100'>2023-03-16</span></td><td><a href='/guix/commit/gnu/packages/graph.scm?id=1c0056876ccabf5ad30007e7163ae94b8152e20c'>gnu: python-plotly: Fix version detection.</a><span class='msg-avail'>...</span></td><td>Sharlatan Hellseher</td></tr>
<tr><td><span title='2023-03-13 20:33:48 +0000'>2023-03-13</span></td><td><a href='/guix/commit/gnu/packages/graph.scm?id=f04a52313783b25b2764b0d18886b0b9478a218a'>gnu: python-graph-tool: Update to 2.46.</a><span class='msg-avail'>...</span></td><td>Ale Abdo</td></tr>
<tr><td><span title='2023-02-19 01:00:01 +0100'>2023-02-19</span></td><td><a href='/guix/commit/gnu/packages/graph.scm?id=1e6ddceb8318d413745ca1c9d91fde01b1e0364b'>gnu: Use HTTPS package home pages wherever possible.</a><span class='msg-avail'>...</span></td><td>Tobias Geerinckx-Rice</td></tr>
<tr><td><span title='2023-02-10 19:36:36 +0100'>2023-02-10</span></td><td><a href='/guix/commit/gnu/packages/graph.scm?id=cf981657a1d4c6ba64bf7e9a015d2be239ca85c2'>gnu: Add python-vtraag-louvain.</a><span class='msg-avail'>...</span></td><td>Ricardo Wurmus</td></tr>
<tr><td><span title='2023-01-27 14:08:56 -0500'>2023-01-27</span></td><td><a href='/guix/commit/gnu/packages/graph.scm?id=608f0c9f27c3597b2a82a4bec6c5a704b5222eb2'>gnu: Remove python-louvain-0.7.</a><span class='msg-avail'>...</span></td><td>Maxim Cournoyer</td></tr>
<tr><td><span title='2023-01-27 14:08:55 -0500'>2023-01-27</span></td><td><a href='/guix/commit/gnu/packages/graph.scm?id=68e4ec9ccfcb0c7bb76408ffedf9cfdbbc341c37'>gnu: python-leidenalg: Update to 0.9.1.</a><span class='msg-avail'>...</span></td><td>Maxim Cournoyer</td></tr>
<tr><td><span title='2023-01-27 14:08:55 -0500'>2023-01-27</span></td><td><a href='/guix/commit/gnu/packages/graph.scm?id=c539be939bcc22b13aaa0ac8da97dca613b9c79d'>gnu: python-igraph: Update to 0.10.4-0.b6ebd8e.</a><span class='msg-avail'>...</span></td><td>Maxim Cournoyer</td></tr>
<tr><td><span title='2023-01-27 14:08:55 -0500'>2023-01-27</span></td><td><a href='/guix/commit/gnu/packages/graph.scm?id=0b1fae08d0b005380ff6c97c88abf5e6889f43f6'>gnu: rw: Update to 0.9 and apply a patch to build with igraph &gt;= 0.10.</a><span class='msg-avail'>...</span></td><td>Maxim Cournoyer</td></tr>
<tr><td><span title='2023-01-27 14:08:55 -0500'>2023-01-27</span></td><td><a href='/guix/commit/gnu/packages/graph.scm?id=a8754d3160e1ef129e71f0e3a7edfa94c3649018'>gnu: igraph: Update to 0.10.4.</a><span class='msg-avail'>...</span></td><td>Maxim Cournoyer</td></tr>
<tr><td><span title='2023-01-07 21:04:26 +0100'>2023-01-07</span></td><td><a href='/guix/commit/gnu/packages/graph.scm?id=edbacab9953144a3aa204f9f0eee1584ef321a8f'>gnu: Use old setuptools in packages that relies on use_2to3 conversion.</a><span class='msg-avail'>...</span></td><td>Marius Bakke</td></tr>