15a6d433ff
* guix/scripts/lint.scm (starts-with-abbreviation?): New procedure.
(check-synopsis-style)[check-start-with-package-name]: Use it.
* tests/lint.scm ("synopsis: start with abbreviation"): New test.
244 lines
8.9 KiB
Scheme
244 lines
8.9 KiB
Scheme
;;; GNU Guix --- Functional package management for GNU
|
||
;;; Copyright © 2012, 2013 Cyril Roelandt <tipecaml@gmail.com>
|
||
;;; Copyright © 2014 Eric Bavier <bavier@member.fsf.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/>.
|
||
|
||
|
||
(define-module (test-packages)
|
||
#:use-module (guix build download)
|
||
#:use-module (guix build-system gnu)
|
||
#:use-module (guix packages)
|
||
#:use-module (guix scripts lint)
|
||
#:use-module (guix ui)
|
||
#:use-module (gnu packages)
|
||
#:use-module (gnu packages pkg-config)
|
||
#:use-module (srfi srfi-64))
|
||
|
||
;; Test the linter.
|
||
|
||
|
||
(test-begin "lint")
|
||
|
||
(define-syntax-rule (dummy-package name* extra-fields ...)
|
||
(package extra-fields ... (name name*) (version "0") (source #f)
|
||
(build-system gnu-build-system)
|
||
(synopsis #f) (description #f)
|
||
(home-page #f) (license #f) ))
|
||
|
||
(define (call-with-warnings thunk)
|
||
(let ((port (open-output-string)))
|
||
(parameterize ((guix-warning-port port))
|
||
(thunk))
|
||
(get-output-string port)))
|
||
|
||
(test-assert "description: not empty"
|
||
(->bool
|
||
(string-contains (call-with-warnings
|
||
(lambda ()
|
||
(let ((pkg (dummy-package "x"
|
||
(description ""))))
|
||
(check-description-style pkg))))
|
||
"description should not be empty")))
|
||
|
||
(test-assert "description: does not start with an upper-case letter"
|
||
(->bool
|
||
(string-contains (call-with-warnings
|
||
(lambda ()
|
||
(let ((pkg (dummy-package "x"
|
||
(description "bad description."))))
|
||
(check-description-style pkg))))
|
||
"description should start with an upper-case letter")))
|
||
|
||
(test-assert "description: may start with a digit"
|
||
(string-null?
|
||
(call-with-warnings
|
||
(lambda ()
|
||
(let ((pkg (dummy-package "x"
|
||
(description "2-component library."))))
|
||
(check-description-style pkg))))))
|
||
|
||
(test-assert "description: may start with lower-case package name"
|
||
(string-null?
|
||
(call-with-warnings
|
||
(lambda ()
|
||
(let ((pkg (dummy-package "x"
|
||
(description "x is a dummy package."))))
|
||
(check-description-style pkg))))))
|
||
|
||
(test-assert "description: two spaces after end of sentence"
|
||
(->bool
|
||
(string-contains (call-with-warnings
|
||
(lambda ()
|
||
(let ((pkg (dummy-package "x"
|
||
(description "Bad. Quite bad."))))
|
||
(check-description-style pkg))))
|
||
"sentences in description should be followed by two spaces")))
|
||
|
||
(test-assert "description: end-of-sentence detection with abbreviations"
|
||
(string-null?
|
||
(call-with-warnings
|
||
(lambda ()
|
||
(let ((pkg (dummy-package "x"
|
||
(description
|
||
"E.g. Foo, i.e. Bar resp. Baz (a.k.a. DVD)."))))
|
||
(check-description-style pkg))))))
|
||
|
||
(test-assert "synopsis: not empty"
|
||
(->bool
|
||
(string-contains (call-with-warnings
|
||
(lambda ()
|
||
(let ((pkg (dummy-package "x"
|
||
(synopsis ""))))
|
||
(check-synopsis-style pkg))))
|
||
"synopsis should not be empty")))
|
||
|
||
(test-assert "synopsis: does not start with an upper-case letter"
|
||
(->bool
|
||
(string-contains (call-with-warnings
|
||
(lambda ()
|
||
(let ((pkg (dummy-package "x"
|
||
(synopsis "bad synopsis."))))
|
||
(check-synopsis-style pkg))))
|
||
"synopsis should start with an upper-case letter")))
|
||
|
||
(test-assert "synopsis: may start with a digit"
|
||
(string-null?
|
||
(call-with-warnings
|
||
(lambda ()
|
||
(let ((pkg (dummy-package "x"
|
||
(synopsis "5-dimensional frobnicator"))))
|
||
(check-synopsis-style pkg))))))
|
||
|
||
(test-assert "synopsis: ends with a period"
|
||
(->bool
|
||
(string-contains (call-with-warnings
|
||
(lambda ()
|
||
(let ((pkg (dummy-package "x"
|
||
(synopsis "Bad synopsis."))))
|
||
(check-synopsis-style pkg))))
|
||
"no period allowed at the end of the synopsis")))
|
||
|
||
(test-assert "synopsis: ends with 'etc.'"
|
||
(string-null? (call-with-warnings
|
||
(lambda ()
|
||
(let ((pkg (dummy-package "x"
|
||
(synopsis "Foo, bar, etc."))))
|
||
(check-synopsis-style pkg))))))
|
||
|
||
(test-assert "synopsis: starts with 'A'"
|
||
(->bool
|
||
(string-contains (call-with-warnings
|
||
(lambda ()
|
||
(let ((pkg (dummy-package "x"
|
||
(synopsis "A bad synopŝis"))))
|
||
(check-synopsis-style pkg))))
|
||
"no article allowed at the beginning of the synopsis")))
|
||
|
||
(test-assert "synopsis: starts with 'An'"
|
||
(->bool
|
||
(string-contains (call-with-warnings
|
||
(lambda ()
|
||
(let ((pkg (dummy-package "x"
|
||
(synopsis "An awful synopsis"))))
|
||
(check-synopsis-style pkg))))
|
||
"no article allowed at the beginning of the synopsis")))
|
||
|
||
(test-assert "synopsis: starts with 'a'"
|
||
(->bool
|
||
(string-contains (call-with-warnings
|
||
(lambda ()
|
||
(let ((pkg (dummy-package "x"
|
||
(synopsis "a bad synopsis"))))
|
||
(check-synopsis-style pkg))))
|
||
"no article allowed at the beginning of the synopsis")))
|
||
|
||
(test-assert "synopsis: starts with 'an'"
|
||
(->bool
|
||
(string-contains (call-with-warnings
|
||
(lambda ()
|
||
(let ((pkg (dummy-package "x"
|
||
(synopsis "an awful synopsis"))))
|
||
(check-synopsis-style pkg))))
|
||
"no article allowed at the beginning of the synopsis")))
|
||
|
||
(test-assert "synopsis: too long"
|
||
(->bool
|
||
(string-contains (call-with-warnings
|
||
(lambda ()
|
||
(let ((pkg (dummy-package "x"
|
||
(synopsis (make-string 80 #\x)))))
|
||
(check-synopsis-style pkg))))
|
||
"synopsis should be less than 80 characters long")))
|
||
|
||
(test-assert "synopsis: start with package name"
|
||
(->bool
|
||
(string-contains (call-with-warnings
|
||
(lambda ()
|
||
(let ((pkg (dummy-package "x"
|
||
(name "foo")
|
||
(synopsis "foo, a nice package"))))
|
||
(check-synopsis-style pkg))))
|
||
"synopsis should not start with the package name")))
|
||
|
||
(test-assert "synopsis: start with package name prefix"
|
||
(string-null?
|
||
(call-with-warnings
|
||
(lambda ()
|
||
(let ((pkg (dummy-package "arb"
|
||
(synopsis "Arbitrary precision"))))
|
||
(check-synopsis-style pkg))))))
|
||
|
||
(test-assert "synopsis: start with abbreviation"
|
||
(string-null?
|
||
(call-with-warnings
|
||
(lambda ()
|
||
(let ((pkg (dummy-package "uucp"
|
||
;; Same problem with "APL interpreter", etc.
|
||
(synopsis "UUCP implementation")
|
||
(description "Imagine this is Taylor UUCP."))))
|
||
(check-synopsis-style pkg))))))
|
||
|
||
(test-assert "inputs: pkg-config is probably a native input"
|
||
(->bool
|
||
(string-contains
|
||
(call-with-warnings
|
||
(lambda ()
|
||
(let ((pkg (dummy-package "x"
|
||
(inputs `(("pkg-config" ,pkg-config))))))
|
||
(check-inputs-should-be-native pkg))))
|
||
"pkg-config should probably be a native input")))
|
||
|
||
(test-assert "patches: file names"
|
||
(->bool
|
||
(string-contains
|
||
(call-with-warnings
|
||
(lambda ()
|
||
(let ((pkg (dummy-package "x"
|
||
(source
|
||
(origin
|
||
(method url-fetch)
|
||
(uri "someurl")
|
||
(sha256 "somesha")
|
||
(patches (list "/path/to/y.patch")))))))
|
||
(check-patches pkg))))
|
||
"file names of patches should start with the package name")))
|
||
|
||
(test-end "lint")
|
||
|
||
|
||
(exit (= (test-runner-fail-count (test-runner-current)) 0))
|