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

[Javier Collado]

This branch adds a new exception to detect when a yaml file is empty.

This exception is caught when parsing the ts_control file, to allow empty files.

The case for the file not being there at all was already covered.

I think that the testsuite module needs some refactoring. In particular, I found confusing what's
the _control data variable used for and why None is used as default value when an empty dictionary
could be more appropriate since that would remove the need to handle special cases.

[Joe Talbott (joetalbott)]

Looks good to me.

review: Approve

=== modified file 'utah/client/common.py'
--- utah/client/common.py	2012-10-10 14:44:00 +0000
+++ utah/client/common.py	2012-10-10 17:25:23 +0000
@@ -15,7 +15,10 @@
 import yaml
 import jsonschema
 
-from utah.client.exceptions import YAMLParsingError
+from utah.client.exceptions import (
+        YAMLParsingError,
+        YAMLEmptyFile,
+        )
 
 
 PASS = 0
@@ -167,6 +170,8 @@
     try:
         with open(filename, 'r') as fp:
             data = yaml.load(fp)
+        if data is None:
+            raise YAMLEmptyFile('Empty YAML file: {}'.format(filename))
     except yaml.YAMLError as exception:
         if hasattr(exception, 'problem_mark'):
             mark = exception.problem_mark

=== modified file 'utah/client/exceptions.py'
--- utah/client/exceptions.py	2012-10-04 15:39:50 +0000
+++ utah/client/exceptions.py	2012-10-10 17:25:23 +0000
@@ -31,11 +31,18 @@
 
 class YAMLParsingError(UTAHClientError):
     """
-    Used to provided the filename and the location
+    Used to provide the filename and the location
     in which the parsing error happened when calling yaml.load
     """
 
 
+class YAMLEmptyFile(UTAHClientError):
+    """
+    Used to signal that a file that was supposed to contain yaml data
+    is actually empty
+    """
+
+
 class ValidationError(UTAHClientError):
     """
     Used to provide additional information when schema validation fails

=== modified file 'utah/client/runner.py'
--- utah/client/runner.py	2012-10-10 14:44:00 +0000
+++ utah/client/runner.py	2012-10-10 17:25:23 +0000
@@ -424,7 +424,11 @@
             # Fetch the testsuite. On resume don't remove the testsuite
             # directory.
             if not resume and os.path.exists(name):
-                shutil.rmtree(name)
+                # Using absolute name makes no difference
+                # except on failures where it's easier
+                # to find troubleshoot permission problems
+                absolute_name = os.path.abspath(name)
+                shutil.rmtree(absolute_name)
             if not os.path.exists(name):
                 os.mkdir(name)
 

=== modified file 'utah/client/testsuite.py'
--- utah/client/testsuite.py	2012-08-28 11:22:41 +0000
+++ utah/client/testsuite.py	2012-10-10 17:25:23 +0000
@@ -11,7 +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, ValidationError
+from .exceptions import MissingFile, ValidationError, YAMLEmptyFile
 
 
 def parse_runlist_file(runlist_file):
@@ -111,6 +111,10 @@
             try:
                 control_data = parse_control_file(self.control_file,
                                                   self.CONTROL_SCHEMA)
+            except YAMLEmptyFile:
+                # Skip schema validation for empty file
+                # Schema allows an empty dictionary, but not None
+                control_data = None
             except jsonschema.ValidationError as exception:
                 raise ValidationError(
                         '{!r} test suite control file invalid: {!r}\n'