Merge lp:~joetalbott/utah/dashboard_integration_parser into lp:utah

[Joe Talbott]

This branch factors the result parser out into its own module so that we can package it separately and use it in the QA Dashboard.

I'm not sure how having two merge proposals based off of each other will work so this might supercede my dashboard_integration MP.

[lp:~joetalbott/utah/dashboard_integration_parser]

738. By Joe Talbott on 2012-11-14

Don't use relative import paths.

Noticed-By: Max Brustkern

[Joe Talbott (joetalbott)]

Updated to not use relative import paths.

review: Needs Resubmitting

[Max Brustkern (nuclearbob)]

Looks good. I'll merge it and get to the packaging later.

review: Approve

=== added file 'tests/test_parser.py'
--- tests/test_parser.py	1970-01-01 00:00:00 +0000
+++ tests/test_parser.py	2012-11-14 22:20:26 +0000
@@ -0,0 +1,42 @@
+import jsonschema
+import os
+import tempfile
+import unittest
+
+from utah.parser import UTAHParser
+
+MALFORMED_CONTENT = """
+---
+  bad:
+  good:
+"""
+
+class TestParser(unittest.TestCase):
+    def setUp(self):
+        self.logfile = '/tmp/utah.yaml'
+        self.fakelog = '/tmp/fakeutah.yaml'
+        self.assertTrue(os.path.exists(self.logfile))
+        self.assertFalse(os.path.exists(self.fakelog))
+        self.parser = UTAHParser()
+        self.tmpfile = tempfile.TemporaryFile()
+
+        self.tmpfile.write(MALFORMED_CONTENT)
+
+    def tearDown(self):
+        self.tmpfile.close()
+
+    def test_missing_file(self):
+        with self.assertRaises(IOError):
+            data = self.parser.parse(self.fakelog)
+
+    def test_malformed_file(self):
+        with self.assertRaises(jsonschema.ValidationError):
+            data = self.parser.parse(self.tmpfile)
+
+    def test_parser(self):
+        data = self.parser.parse(self.logfile)
+
+        print("data: {}".format(data))
+        self.assertIn('passes', data)
+        self.assertIn('errors', data)
+        self.assertIn('failures', data)

=== modified file 'utah/client/common.py'
--- utah/client/common.py	2012-11-07 18:00:47 +0000
+++ utah/client/common.py	2012-11-14 22:20:26 +0000
@@ -54,6 +54,8 @@
 CMD_TS_SETUP = 'testsuite_setup'
 CMD_TS_CLEANUP = 'testsuite_cleanup'
 
+DATE_FORMAT = "%Y-%m-%d %H:%M:%S"
+
 
 def do_nothing(_obj=None):
     """
@@ -114,7 +116,7 @@
 
         return make_result(command=command,
                            retcode=ERROR_TIMEOUT,
-                           start_time=str(start_time),
+                           start_time=start_time.strftime(DATE_FORMAT),
                            time_delta=str(time_delta),
                            cmd_type=cmd_type,
                            user=run_as,
@@ -126,7 +128,7 @@
                        retcode=p.returncode,
                        stdout=stdout,
                        stderr=stderr,
-                       start_time=str(start_time),
+                       start_time=start_time.strftime(DATE_FORMAT),
                        time_delta=str(time_delta),
                        cmd_type=cmd_type,
                        user=run_as,

=== added file 'utah/parser.py'
--- utah/parser.py	1970-01-01 00:00:00 +0000
+++ utah/parser.py	2012-11-14 22:20:26 +0000
@@ -0,0 +1,108 @@
+import os
+import jsonschema
+import yaml
+
+class UTAHParser(object):
+    """
+    UTAH Client result parser class.
+    """
+
+    COMMAND_SCHEMA = {
+        'type': 'object',
+        'properties': {
+            'cmd_type': {'type': 'string'},
+            'command': {'type': 'string'},
+            'returncode': {'type': 'integer'},
+            'start_time': {'type': 'string'},
+            'stderr': {'type': 'string'},
+            'stdout': {'type': 'string'},
+            'testcase': {'type': 'string'},
+            'testsuite': {'type': 'string'},
+            'time_delta': {'type': 'string'},
+            'user': {'type': 'string'},
+        },
+    }
+
+    CLIENT_OUTPUT_SCHEMA = {
+        'type': 'object',
+        'properties': {
+            'runlist': {
+                'type': 'string',
+                'required': True,
+                },
+            'commands': {
+                'type': 'array',
+                'items': {'type': COMMAND_SCHEMA},
+                'required': True,
+                },
+            'fetch_errors': {
+                'type': 'integer',
+                'required': True,
+                },
+            'errors': {
+                'type': 'integer',
+                'required': True,
+                },
+            'failures': {
+                'type': 'integer',
+                'required': True,
+                },
+            'passes': {
+                'type': 'integer',
+                'required': True,
+                },
+            'uname': {
+                'type': 'array',
+                'items': {'type': 'string'},
+                'required': True,
+                },
+            'media-info': {
+                'type': 'string',
+                'required': True,
+                },
+            'install_type': {
+                'type': 'string',
+                'required': True,
+                },
+        },
+    }
+
+    def parse(self, logdata):
+        """
+        Parse utah client results.
+
+        logdata should be either a filename or a handle to a file
+        object.
+
+        Returns the parsed yaml data.
+
+        """
+
+        if isinstance(logdata, str):
+            return self._parse_logfile(logdata)
+        else:
+            return self._parse_stream(logdata)
+
+    def _parse_stream(self, stream):
+        """ Parse client output from stream. """
+        data = yaml.load(stream)
+
+        jsonschema.validate(data, self.CLIENT_OUTPUT_SCHEMA)
+
+        return data
+
+    def _parse_logfile(self, logfile):
+        """ Parse client output log. """
+
+        data = None
+
+        with open(logfile, 'r') as fp:
+            data = self._parse_stream(fp)
+
+        return data
+
+if __name__ == "__main__":
+    parser = UTAHParser()
+    data = parser.parse("/tmp/utah.yaml")
+    print(data)
+

=== added file 'utah/publish.py'
--- utah/publish.py	1970-01-01 00:00:00 +0000
+++ utah/publish.py	2012-11-14 22:20:26 +0000
@@ -0,0 +1,136 @@
+import argparse
+import datetime
+import jsonschema
+import os
+import urllib
+import urllib2
+import yaml
+
+from utah.client import exceptions
+from utah.parser import UTAHParser
+
+
+COMMAND_SCHEMA = {
+    'type': 'object',
+    'properties': {
+        'cmd_type': {'type': 'string'},
+        'command': {'type': 'string'},
+        'returncode': {'type': 'integer'},
+        'start_time': {'type': 'string'},
+        'stderr': {'type': 'string'},
+        'stdout': {'type': 'string'},
+        'testcase': {'type': 'string'},
+        'testsuite': {'type': 'string'},
+        'time_delta': {'type': 'string'},
+        'user': {'type': 'string'},
+    },
+}
+
+CLIENT_OUTPUT_SCHEMA = {
+    'type': 'object',
+    'properties': {
+        'runlist': {
+            'type': 'string',
+            'required': True,
+            },
+        'commands': {
+            'type': 'array',
+            'items': {'type': COMMAND_SCHEMA},
+            'required': True,
+            },
+        'fetch_errors': {
+            'type': 'integer',
+            'required': True,
+            },
+        'errors': {
+            'type': 'integer',
+            'required': True,
+            },
+        'failures': {
+            'type': 'integer',
+            'required': True,
+            },
+        'passes': {
+            'type': 'integer',
+            'required': True,
+            },
+        'uname': {
+            'type': 'array',
+            'items': {'type': 'string'},
+            'required': True,
+            },
+        'media-info': {
+            'type': 'string',
+            'required': True,
+            },
+        'install_type': {
+            'type': 'string',
+            'required': True,
+            },
+    },
+}
+
+
+def _parse_logfile(logfile):
+    """ Parse client output log for publishing. """
+
+    utah_parser = UTAHParser()
+    return utah_parser.parse(logfile)
+
+
+def _publish_results(url, data=None):
+    """ Publish results to the QA Dashboard.  """
+
+    if data is None:
+        return "Not publishing null data"
+
+    try:
+        u = urllib2.urlopen(url, urllib.urlencode(data))
+
+        return u.read()
+    except urllib2.URLError as exception:
+        return "ERROR: bad url {}: {}".format(url, exception)
+
+
+def publish(logfile, url, token):
+    """ Publish result from logfile to url using token. """
+
+    data = {}
+
+    # Defaults
+    data['flavor'] = 'ubuntu'
+    data['skip_count'] = 0
+
+    log_data = _parse_logfile(logfile)
+
+    if log_data is None:
+        return "Failed to parse logfile: {}".format(logfile)
+
+    data['token'] = token
+    data['fail_count'] = log_data['failures']
+    data['pass_count'] = log_data['passes']
+    data['error_count'] = log_data['errors']
+    data['build_no'] = log_data['build_number']
+    data['build_name'] = "{}-{}-{}_{}".format(
+        log_data['release'], log_data['install_type'],
+        log_data['arch'], log_data['name'])
+    data['ran_at'] = log_data['ran_at']
+
+    return _publish_results(url, data)
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(
+            description='utah results publisher'
+    )
+    parser.add_argument('logfile', metavar='LOGFILE', type=str,
+                        help="utah client results log")
+    parser.add_argument('url', metavar='URL', type=str,
+                        help="QA Dashboard API URL")
+    parser.add_argument('token', metavar='API_TOKEN', type=str,
+                        help="QA Dashboard API token")
+
+    args = parser.parse_args()
+
+    print publish(args.logfile,
+                  url=args.url,
+                  token=args.token)