GH-54: improve error message for package test failures

Fixes GH-54
zeek · Sep 20, 2019 · 4ae385c · 4ae385c
1 parent fe41f41
commit 4ae385c
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 11 deletions.
diff --git a/CHANGES b/CHANGES
@@ -1,4 +1,10 @@
 
+2.0.5-2 | 2019-09-20 13:03:11 -0700
+
+  * GH-54: improve error message for package test failures (Jon Siwek, Corelight)
+
+  * Improve debug logging for test_command (Jon Siwek, Corelight)
+
 2.0.5 | 2019-09-18 16:16:21 -0700
 
   * Release 2.0.5.

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-2.0.5
+2.0.5-2
diff --git a/doc/man/zkg.1 b/doc/man/zkg.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "ZKG" "1" "Sep 18, 2019" "2.0.5" "Zeek Package Manager"
+.TH "ZKG" "1" "Sep 20, 2019" "2.0.5-2" "Zeek Package Manager"
 .SH NAME
 zkg \- Zeek Package Manager
 .

diff --git a/zeekpkg/__init__.py b/zeekpkg/__init__.py
@@ -9,7 +9,7 @@
 
 import logging
 
-__version__ = "2.0.5"
+__version__ = "2.0.5-2"
 __all__ = ['manager', 'package', 'source']
 
 LOG = logging.getLogger(__name__)

diff --git a/zkg b/zkg
@@ -389,11 +389,13 @@ def cmd_test(manager, args, config, configfile):
             print(str.format('{}: all tests passed', name))
         else:
             all_passed = False
+            clone_dir = os.path.join(os.path.join(test_dir, "clones"),
+                                     info.package.name)
             print_error(str.format('error: package "{}" tests failed, inspect'
                                    ' contents of {} for details, especially'
                                    ' any "zkg.test_command.{{stderr,stdout}}"'
-                                   ' files.',
-                                   name, test_dir))
+                                   ' files within {}',
+                                   name, test_dir, clone_dir))
 
     if not all_passed:
         sys.exit(1)
@@ -515,9 +517,13 @@ def cmd_install(manager, args, config, configfile):
                 error_msg = str.format(
                     'failed to run tests for {}: {}', name, error)
             elif not passed:
-                error_msg = str.format(
-                    '{} tests failed, inspect contents of {} for details',
-                    name, test_dir)
+                clone_dir = os.path.join(os.path.join(test_dir, "clones"),
+                                         info.package.name)
+                error_msg = str.format('"{}" tests failed, inspect contents of'
+                                       ' {} for details, especially any'
+                                       ' "zkg.test_command.{{stderr,stdout}}"'
+                                       ' files within {}',
+                                       name, test_dir, clone_dir)
 
             if error_msg:
                 print_error('error: {}'.format(error_msg))
@@ -1148,9 +1154,14 @@ def cmd_upgrade(manager, args, config, configfile):
                 error_msg = str.format(
                     'failed to run tests for {}: {}', name, error)
             elif not passed:
-                error_msg = str.format(
-                    '{} tests failed, inspect contents of {} for details',
-                    name, test_dir)
+                clone_dir = os.path.join(os.path.join(test_dir, "clones"),
+                                         info.package.name)
+                error_msg = str.format('"{}" tests failed, inspect contents of'
+                                       ' {} for details, especially any'
+                                       ' "zkg.test_command.{{stderr,stdout}}"'
+                                       ' files within {}',
+                                       name, test_dir, clone_dir)
+
 
             if error_msg:
                 print_error('error: {}'.format(error_msg))