From: "Ludovic Courtès" <ludo@gnu.org>
To: guix-devel@gnu.org
Subject: [PATCH 6/6] gnu: Improve error reporting of the use-.*modules macros.
Date: Wed, 8 Nov 2017 14:09:21 +0100 [thread overview]
Message-ID: <20171108130921.25202-7-ludo@gnu.org> (raw)
In-Reply-To: <20171108130921.25202-1-ludo@gnu.org>
Suggested by Julien Lepiller and myglc2
at <https://lists.gnu.org/archive/html/guix-devel/2017-11/msg00106.html>.
* gnu.scm (%try-use-modules): New procedure.
(package-module-hint, service-module-hint): New procedures.
(try-use-modules): New macro.
(use-package-modules, use-service-modules, use-system-modules): Use it.
* tests/guix-system.sh: Test it.
---
gnu.scm | 100 ++++++++++++++++++++++++++++++++++++++++++++++++---
po/guix/POTFILES.in | 1 +
tests/guix-system.sh | 28 +++++++++++++++
3 files changed, 125 insertions(+), 4 deletions(-)
diff --git a/gnu.scm b/gnu.scm
index 913ce6160..35cd2a7f6 100644
--- a/gnu.scm
+++ b/gnu.scm
@@ -1,5 +1,5 @@
;;; GNU Guix --- Functional package management for GNU
-;;; Copyright © 2014, 2015, 2016 Ludovic Courtès <ludo@gnu.org>
+;;; Copyright © 2014, 2015, 2016, 2017 Ludovic Courtès <ludo@gnu.org>
;;; Copyright © 2015 Joshua S. Grant <jgrant@parenthetical.io>
;;; Copyright © 2017 Mathieu Othacehe <m.othacehe@gmail.com>
;;;
@@ -19,6 +19,14 @@
;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
(define-module (gnu)
+ #:use-module (guix i18n)
+ #:use-module (guix utils)
+ #:use-module (srfi srfi-34)
+ #:use-module (srfi srfi-35)
+ #:use-module (ice-9 match)
+ #:use-module (guix packages)
+ #:use-module (gnu packages)
+ #:use-module (gnu services)
#:export (use-package-modules
use-service-modules
use-system-modules))
@@ -52,13 +60,97 @@
(module-use! i (resolve-interface m))))
%public-modules)))
+(define (%try-use-modules modules location make-hint)
+ "Attempt to load all of MODULES. Report errors as coming from LOCATION, a
+<location> record, and use MAKE-HINT to produce a fix hint."
+ (define (location->string loc)
+ (match loc
+ (#f "")
+ (($ <location> file line column)
+ (format #f "~a:~a:~a: " file line column))))
+
+ (for-each (lambda (module)
+ (catch 'misc-error
+ (lambda ()
+ (process-use-modules `((,module))))
+ (lambda _
+ (raise
+ (apply
+ make-compound-condition
+ (condition
+ (&message
+ (message (format #f (G_ "module ~a not found")
+ module))))
+ (condition
+ (&error-location (location location)))
+ (or (and=> (make-hint module) list)
+ '()))))))
+ modules))
+
+(define (package-module-hint module)
+ (define last-name
+ (match module
+ ((_ ... last)
+ (symbol->string last))))
+
+ (match (find-packages-by-name last-name)
+ (()
+ (condition
+ (&fix-hint
+ (hint (G_ "\
+You may use @command{guix package --show=foo | grep location} to search
+for the location of package @code{foo}.
+If you get the line @code{location: gnu/packages/bar.scm:174:2},
+add @code{bar} to the @code{use-package-modules} form.")))))
+ ((package _ ...)
+ (condition
+ (&fix-hint
+ (hint (format #f (G_ "\
+Did you mean @code{(use-package-modules ~a)}?")
+ (basename (location-file (package-location package))
+ ".scm"))))))))
+
+(define (service-module-hint module)
+ (define last-name
+ (match module
+ ((_ ... last)
+ last)))
+
+ (match (lookup-service-types last-name)
+ (()
+ (condition
+ (&fix-hint
+ (hint (format #f (G_ "\
+You may use @command{guix system search ~a} to search for a service
+matching @code{~a}.
+If you get the line @code{location: gnu/services/foo.scm:188:2},
+add @code{foo} to the @code{use-service-modules} form.")
+ last-name last-name)))))
+ ((package _ ...)
+ (condition
+ (&fix-hint
+ (hint (format #f (G_ "\
+Did you mean @code{(use-service-modules ~a)}?")
+ (basename (location-file (service-type-location package))
+ ".scm"))))))))
+
+(define-syntax-rule (try-use-modules hint modules ...)
+ (eval-when (expand load eval)
+ (%try-use-modules '(modules ...)
+ (source-properties->location
+ (current-source-location))
+ hint)))
+
(define-syntax-rule (use-package-modules module ...)
- (use-modules (gnu packages module) ...))
+ (try-use-modules package-module-hint
+ (gnu packages module) ...))
(define-syntax-rule (use-service-modules module ...)
- (use-modules (gnu services module) ...))
+ (try-use-modules service-module-hint
+ (gnu services module) ...))
(define-syntax-rule (use-system-modules module ...)
- (use-modules (gnu system module) ...))
+ (try-use-modules (const #f) ;no hint
+ (gnu system module) ...))
;;; gnu.scm ends here
diff --git a/po/guix/POTFILES.in b/po/guix/POTFILES.in
index e3f767cc6..6510b99e8 100644
--- a/po/guix/POTFILES.in
+++ b/po/guix/POTFILES.in
@@ -1,5 +1,6 @@
# List of source files which contain translatable strings.
# This should be source files of the various tools, and not package modules.
+gnu.scm
gnu/packages.scm
gnu/services.scm
gnu/system.scm
diff --git a/tests/guix-system.sh b/tests/guix-system.sh
index 31ee63713..0cd0aa944 100644
--- a/tests/guix-system.sh
+++ b/tests/guix-system.sh
@@ -68,6 +68,34 @@ else
fi
+# Reporting of module not found errors.
+
+cat > "$tmpfile" <<EOF
+;; Line 1.
+(use-modules (gnu))
+ (use-service-modules openssh)
+EOF
+
+if guix system build "$tmpfile" -n 2> "$errorfile"
+then false
+else
+ grep "$tmpfile:3:2: .*module .*openssh.*not found" "$errorfile"
+ grep "Did you mean.*use-service-modules ssh" "$errorfile"
+fi
+
+cat > "$tmpfile" <<EOF
+;; Line 1.
+(use-modules (gnu))
+ (use-package-modules qemu)
+EOF
+
+if guix system build "$tmpfile" -n 2> "$errorfile"
+then false
+else
+ grep "$tmpfile:3:2: .*module .*qemu.*not found" "$errorfile"
+ grep "Did you mean.*use-package-modules virtualization" "$errorfile"
+fi
+
# Reporting of unbound variables.
cat > "$tmpfile" <<EOF
--
2.15.0
next prev parent reply other threads:[~2017-11-08 13:09 UTC|newest]
Thread overview: 50+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-11-06 20:12 The usability of Guix configurations myglc2
2017-11-06 22:16 ` bug#29072: " Leo Famulari
2017-11-06 22:16 ` Leo Famulari
2017-11-06 23:26 ` bug#29072: " myglc2
2017-11-06 23:26 ` myglc2
2017-11-07 1:56 ` myglc2
2017-11-07 11:05 ` julien lepiller
2017-11-07 12:52 ` Hartmut Goebel
2017-11-07 13:13 ` julien lepiller
2017-11-07 14:11 ` myglc2
2017-11-07 14:52 ` julien lepiller
2017-11-07 15:59 ` myglc2
2017-11-07 16:25 ` [PATCH] " julien lepiller
[not found] ` <867ev2t13i.fsf@gmail.com>
2017-11-07 21:27 ` Julien Lepiller
2017-11-07 22:56 ` myglc2
2017-11-07 22:47 ` Reporting module errors Ludovic Courtès
2017-11-08 1:26 ` myglc2
2017-11-08 10:52 ` Hartmut Goebel
2017-11-08 14:02 ` Ludovic Courtès
2017-11-08 13:09 ` [PATCH 0/6] Error reporting and hints for missing modules Ludovic Courtès
2017-11-08 13:09 ` [PATCH 1/6] ui: Introduce (guix i18n) Ludovic Courtès
2017-11-08 13:09 ` [PATCH 2/6] ui: Define and honor '&error-location' and '&fix-hint' conditions Ludovic Courtès
2017-11-08 13:09 ` [PATCH 3/6] services: 'fold-service-types' honors its seed Ludovic Courtès
2017-11-08 13:09 ` [PATCH 4/6] services: 'fold-service-types' includes (gnu services) Ludovic Courtès
2017-11-08 13:09 ` [PATCH 5/6] services: Add 'lookup-service-types' Ludovic Courtès
2017-11-08 13:09 ` Ludovic Courtès [this message]
2017-11-11 2:02 ` [PATCH 6/6] gnu: Improve error reporting of the use-.*modules macros Chris Marusich
2017-11-11 13:56 ` Ludovic Courtès
2017-11-11 17:00 ` Chris Marusich
2017-11-08 15:33 ` [PATCH 0/6] Error reporting and hints for missing modules julien lepiller
2017-11-08 17:42 ` myglc2
2017-11-08 19:07 ` myglc2
2017-11-08 21:42 ` Ludovic Courtès
2017-11-09 23:04 ` Ludovic Courtès
2017-11-10 14:47 ` myglc2
2017-11-10 23:01 ` Julien Lepiller
2017-11-11 22:00 ` Ludovic Courtès
2017-11-11 22:02 ` Ludovic Courtès
2017-11-14 1:12 ` myglc2
2017-11-30 10:44 ` Ludovic Courtès
2017-11-07 14:45 ` The usability of Guix configurations Hartmut Goebel
2017-11-07 1:56 ` bug#29072: " myglc2
2017-11-07 2:30 ` myglc2
2017-11-07 3:03 ` myglc2
2017-11-07 2:30 ` bug#29072: " myglc2
2017-11-07 2:59 ` myglc2
2017-11-07 20:54 ` myglc2
2017-11-07 10:23 ` bug#29072: " Ludovic Courtès
2017-11-07 10:23 ` Ludovic Courtès
2017-11-08 19:40 ` myglc2
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20171108130921.25202-7-ludo@gnu.org \
--to=ludo@gnu.org \
--cc=guix-devel@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/guix.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.