Merge lp:~javier.collado/utah/bug1040015 into lp:utah

[Javier Collado]

Added customized error messages for each validation error. That means that when a file fails to validate, the output in the client will show the filename and the test suite/case name together with the information that is already part of the backtrace.

Some examples:
Master runlist failed to validate: '/home/javi/code/bzr/utah/bug1040015/utah/client/examples/master.run'
Detailed information: 'testsuites' is a required property

'utah_tests' test suite runlist invalid: 'utah_tests/tslist.run'
Detailed information: 'test' is a required property

'test_one' test case control file invalid: 'utah_tests/test_one/tc_control'
Detailed information: 'description' is a required property

[Max Brustkern (nuclearbob)]

This looks reasonable to me, but I think it wouldn't hurt to have Joe take a look since he wrote the YAML stuff to begin with.

[Joe Talbott (joetalbott)]

Looks okay to me.

review: Approve

=== modified file 'client.py'
--- client.py	2012-08-09 21:39:20 +0000
+++ client.py	2012-08-28 11:46:19 +0000
@@ -11,7 +11,7 @@
 from utah.client.result import Result, ResultYAML, ResultJSON
 
 from utah.client.common import DEFAULT_STATE_FILE
-from utah.client import exceptions
+from utah.client.exceptions import UTAHClientError
 
 
 def process_cmdline_argparse():
@@ -126,9 +126,7 @@
 
         returncode = runner.run()
 
-    except (exceptions.BadDir,
-            exceptions.MissingFile,
-            exceptions.YAMLParsingError) as e:
+    except UTAHClientError as e:
         errno = getattr(e, 'errno', 1)
         exit(errno, e)
 

=== modified file 'utah/client/exceptions.py'
--- utah/client/exceptions.py	2012-08-02 18:36:14 +0000
+++ utah/client/exceptions.py	2012-08-28 11:46:19 +0000
@@ -1,20 +1,42 @@
-#!/usr/bin/python
-
-
-class BadDir(Exception):
-    pass
-
-
-class MissingFile(Exception):
-    pass
-
-
-class BadMasterRunlist(Exception):
-    pass
-
-
-class YAMLParsingError(Exception):
+"""
+UTAH client exceptions
+"""
+
+
+class UTAHClientError(Exception):
+    """
+    Base class of all exceptions in the client
+    """
+
+
+class BadDir(UTAHClientError):
+    """
+    Raised when some test directory isn't found
+    or and error happens when trying to change to it
+    """
+
+
+class MissingFile(UTAHClientError):
+    """
+    Raised when yaml file with metadata about tests
+    cannot be found
+    """
+
+
+class BadMasterRunlist(UTAHClientError):
+    """
+    Raised when master runlist isn't in the expected format
+    """
+
+
+class YAMLParsingError(UTAHClientError):
     """
     Used to provided the filename and the location
     in which the parsing error happened when calling yaml.load
     """
+
+
+class ValidationError(UTAHClientError):
+    """
+    Used to provide additional information when schema validation fails
+    """

=== modified file 'utah/client/runner.py'
--- utah/client/runner.py	2012-08-21 21:34:06 +0000
+++ utah/client/runner.py	2012-08-28 11:46:19 +0000
@@ -3,8 +3,8 @@
 from result import Result
 from testsuite import TestSuite
 from state_agent import StateAgentYAML
-
 import exceptions
+
 import os
 import shutil
 import stat
@@ -343,7 +343,13 @@
             raise exceptions.MissingFile(runlist)
 
         data = parse_yaml_file(local_filename)
-        jsonschema.validate(data, self.MASTER_RUNLIST_SCHEMA)
+        try:
+            jsonschema.validate(data, self.MASTER_RUNLIST_SCHEMA)
+        except jsonschema.ValidationError as exception:
+            raise exceptions.ValidationError(
+                    'Master runlist failed to validate: {!r}\n'
+                    'Detailed information: {}'
+                    .format(local_filename, exception))
 
         if 'timeout' in data:
             self.timeout = int(data['timeout'])

=== modified file 'utah/client/testcase.py'
--- utah/client/testcase.py	2012-08-08 13:11:52 +0000
+++ utah/client/testcase.py	2012-08-28 11:46:19 +0000
@@ -1,11 +1,12 @@
 """
 Testcase specific code.
 """
+import jsonschema
 
 from common import run_cmd, parse_control_file
 from common import do_nothing
 from common import CMD_TC_BUILD, CMD_TC_SETUP, CMD_TC_TEST, CMD_TC_CLEANUP
-from exceptions import MissingFile
+from exceptions import MissingFile, ValidationError
 
 
 class TestCase(object):
@@ -75,8 +76,14 @@
         import os
         if _control_data is None:
             if os.path.exists(self.filename):
-                control_data = parse_control_file(self.filename,
-                                                  self.CONTROL_SCHEMA)
+                try:
+                    control_data = parse_control_file(self.filename,
+                                                      self.CONTROL_SCHEMA)
+                except jsonschema.ValidationError as exception:
+                    raise ValidationError(
+                            '{!r} test case control file invalid: {!r}\n'
+                            'Detailed information: {}'
+                            .format(self.name, self.filename, exception))
             else:
                 raise MissingFile(self.filename)
         else:

=== modified file 'utah/client/testsuite.py'
--- utah/client/testsuite.py	2012-08-16 21:41:30 +0000
+++ utah/client/testsuite.py	2012-08-28 11:46:19 +0000
@@ -11,8 +11,7 @@
 from .common import CMD_TS_BUILD, CMD_TS_SETUP, CMD_TS_CLEANUP
 from .common import do_nothing
 from .testcase import TestCase
-from .exceptions import MissingFile
-
+from .exceptions import MissingFile, ValidationError
 
 
 def parse_runlist_file(runlist_file):
@@ -109,8 +108,14 @@
         if _control_data is not None:
             control_data = _control_data
         elif self.control_file is not None:
-            control_data = parse_control_file(self.control_file,
-                                              self.CONTROL_SCHEMA)
+            try:
+                control_data = parse_control_file(self.control_file,
+                                                  self.CONTROL_SCHEMA)
+            except jsonschema.ValidationError as exception:
+                raise ValidationError(
+                        '{!r} test suite control file invalid: {!r}\n'
+                        'Detailed information: {}'
+                        .format(self.name, self.control_file, exception))
 
         if control_data is not None:
             # already initialized
@@ -122,7 +127,13 @@
         if _runlist_data is not None:
             runlist_data = _runlist_data
         elif os.path.exists(self.runlist_file):
-            runlist_data = parse_runlist_file(self.runlist_file)
+            try:
+                runlist_data = parse_runlist_file(self.runlist_file)
+            except jsonschema.ValidationError as exception:
+                raise ValidationError(
+                        '{!r} test suite runlist invalid: {!r}\n'
+                        'Detailed information: {}'
+                        .format(self.name, self.runlist_file, exception))
         else:
             raise MissingFile('File not found: {}'.format(self.runlist_file))