# 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

module_dir="t-guix-lint-$$"
mkdir "$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 dummy 2>&1`
if [ `grep_warning "$out"` -ne 3 ]
then false; else true; fi

out=`guix lint -c synopsis dummy 2>&1`
if [ `grep_warning "$out"` -ne 2 ]
then false; else true; fi

out=`guix lint -c description dummy 2>&1`
if [ `grep_warning "$out"` -ne 1 ]
then false; else true; fi

out=`guix lint -c description,synopsis dummy 2>&1`
if [ `grep_warning "$out"` -ne 3 ]
then false; else true; fi

if guix lint -c synopsis,invalid-checker dummy 2>&1 | \
   grep -q 'invalid-checker: invalid checker'
then true; else false; fi
div><div class='content'><table class='list nowrap'><tr class='nohover'><th class='left'>Age</th><th class='left'>Commit message (<a href='/guix/log/.mailmap?id=d5576551302f3238a6790d5a30c1d085b802a9ce&amp;showmsg=1'>Expand</a>)</th><th class='left'>Author</th></tr>
<tr><td><span title='2024-01-07 19:07:18 +0100'>2024-01-07</span></td><td><a href='/guix/commit/.mailmap?id=7b58443bc5506a56ea78aaf44006ce6209ee6cc8'>Update mailmap.</a><span class='msg-avail'>...</span></td><td>Tomas Volf</td></tr>
<tr><td><span title='2023-08-16 22:22:06 +0200'>2023-08-16</span></td><td><a href='/guix/commit/.mailmap?id=fce924708c31c09a1b438ae7e8b83d39c492be9a'>Update email addresses for Juliana Sims.</a><span class='msg-avail'>...</span></td><td>Juliana Sims</td></tr>
<tr><td><span title='2022-01-11 14:48:00 -0500'>2022-01-11</span></td><td><a href='/guix/commit/.mailmap?id=7f779286df7e8636d901f4734501902cc934a72f'>Update mailmap.</a><span class='msg-avail'>...</span></td><td>Leo Famulari</td></tr>
<tr><td><span title='2021-11-06 16:03:43 +0100'>2021-11-06</span></td><td><a href='/guix/commit/.mailmap?id=567c4f4495fd1681bc6bd1ca3e9d1a87e120ac61'>Update mailmap and copyright assignments for Liliana Marie Prikler.</a><span class='msg-avail'>...</span></td><td>Liliana Marie Prikler</td></tr>
<tr><td><span title='2021-09-06 12:15:57 +0200'>2021-09-06</span></td><td><a href='/guix/commit/.mailmap?id=7158f8e4e9f81dbe004789018dcf06a5fe87d602'>Update mailmap.</a><span class='msg-avail'>...</span></td><td>Liliana Marie Prikler</td></tr>
<tr><td><span title='2021-09-04 12:25:17 +0200'>2021-09-04</span></td><td><a href='/guix/commit/.mailmap?id=1fd0bf60ea261fac426052386029ead0ac68cad1'>Update mailmap.</a><span class='msg-avail'>...</span></td><td>Marius Bakke</td></tr>
<tr><td><span title='2021-07-27 12:34:56 -0400'>2021-07-27</span></td><td><a href='/guix/commit/.mailmap?id=c0e6e8d25e3750a35bebc80469ee86e7826bd769'>Update mailmap.</a><span class='msg-avail'>...</span></td><td>Leo Famulari</td></tr>
<tr><td><span title='2021-07-08 09:48:22 +0200'>2021-07-08</span></td><td><a href='/guix/commit/.mailmap?id=0a04c25482c4d848a6a29711fccf5682319e26aa'>mailmap: Update entries for Matthew James Kraai.</a><span class='msg-avail'>...</span></td><td>Matthew James Kraai</td></tr>
<tr><td><span title='2021-06-23 22:29:23 -0500'>2021-06-23</span></td><td><a href='/guix/commit/.mailmap?id=6d388103a4ed8f14f1ac6ac7a2ff22c5fa6b8cd4'>gnu: Add Sollya.</a><span class='msg-avail'>...</span></td><td>Eric Bavier</td></tr>
<tr><td><span title='2021-04-21 18:02:27 -0400'>2021-04-21</span></td><td><a href='/guix/commit/.mailmap?id=449844474da86b5f10a4c5e4f1744e1e3a716d6e'>Update email address for Kei.</a><span class='msg-avail'>...</span></td><td>Kei Kebreau</td></tr>
<tr><td><span title='2020-05-15 09:08:46 +0200'>2020-05-15</span></td><td><a href='/guix/commit/.mailmap?id=dff31d41d945bf4b25ad3014dac32561bfbb33a0'>mailmap: Update for self.</a><span class='msg-avail'>...</span></td><td>Mathieu Othacehe</td></tr>
<tr><td><span title='2020-05-13 09:30:26 +0300'>2020-05-13</span></td><td><a href='/guix/commit/.mailmap?id=3c986a7dc268756c097212de958f046b29b76c1b'>mailmap: Update entries for Nikita.</a><span class='msg-avail'>...</span></td><td>nikita</td></tr>
<tr><td><span title='2020-03-28 16:30:07 -0400'>2020-03-28</span></td><td><a href='/guix/commit/.mailmap?id=c2cf286c62933d2806ae17b8287520820bf87c7e'>Update email address and Savannah handle for Amin Bandali.</a><span class='msg-avail'>...</span></td><td>Amin Bandali</td></tr>
<tr><td><span title='2020-02-09 23:16:45 +0100'>2020-02-09</span></td><td><a href='/guix/commit/.mailmap?id=e81344428726f3dae5d2a2e7bb296f46fcde6cc5'>Update e-mail address for Jakob L. Kreuze.</a><span class='msg-avail'>...</span></td><td>Tobias Geerinckx-Rice</td></tr>
<tr><td><span title='2020-01-17 18:30:33 +0100'>2020-01-17</span></td><td><a href='/guix/commit/.mailmap?id=a3143063aeeecb5c02f75a6e1ddc0cc295e0e4f8'>Update email address for Amin Bandali.</a><span class='msg-avail'>...</span></td><td>Amin Bandali</td></tr>
<tr><td><span title='2019-12-19 11:35:23 -0600'>2019-12-19</span></td><td><a href='/guix/commit/.mailmap?id=4b3ff36228da17db980c98fe9e1669be613a5402'>Update email for Brett Gilio.</a><span class='msg-avail'>...</span></td><td>Brett Gilio</td></tr>
<tr><td><span title='2019-12-18 22:57:44 -0600'>2019-12-18</span></td><td><a href='/guix/commit/.mailmap?id=a7cdf124c0b28be6c4e750161c1341753eede7b8'>gnu: leocad: Update to 19.07.1.</a><span class='msg-avail'>...</span></td><td>Eric Bavier</td></tr>