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

[Javier Collado]

This branch fixes the parsing of the gigabytes option and adds a few test cases
to verify this.

Besides this, the `utah.parser` module and the `utah-parser` package are
removed since they aren't used anymore. The `utah.parser` module is now used to
have there the parser for the utah server script since that makes unit testing
easier.

[Andy Doan (doanac)]

review: Approve

=== modified file 'debian/changelog'
--- debian/changelog	2013-05-09 23:36:07 +0000
+++ debian/changelog	2013-05-10 16:56:25 +0000
@@ -8,6 +8,8 @@
   * Apply retry strategy to install UTAH client package (LP: #1175732)
   * Added phoenix manpage (LP: #1067704)
   * Apply all overrides in tslist.run to the test cases (LP: #1178238)
+  * Set disksizes default directly instead of via argparse (LP:
+    #1178367)
 
  -- Javier Collado <[e-mail]>  Tue, 07 May 2013 16:06:48 +0200
 
 
=== modified file 'debian/control'
--- debian/control	2013-05-08 14:45:47 +0000
+++ debian/control	2013-05-10 16:56:25 +0000
@@ -23,8 +23,7 @@
 
 Package: utah-all
 Architecture: all
-Depends: ${misc:Depends}, ${python:Depends}, utah-bamboofeeder, utah-cobbler,
-         utah-parser
+Depends: ${misc:Depends}, ${python:Depends}, utah-bamboofeeder, utah-cobbler
 Description: Ubuntu Test Automation Harness Complete Package
  Automation framework for testing in Ubuntu, all sections
 
@@ -59,10 +58,3 @@
 Depends: ${misc:Depends}, ${python:Depends}
 Description: Ubuntu Test Automation Harness Common Files
  Automation framework for testing in Ubuntu, common files
-
-Package: utah-parser
-Architecture: all
-Depends: ${misc:Depends}, ${python:Depends},
-         python-jsonschema (>= 1.3~), python-yaml, utah-common
-Description: Ubuntu Test Automation Harness Parser
- Automation framework for testing in Ubuntu, result parser
 
=== modified file 'debian/rules'
--- debian/rules	2013-05-08 13:28:00 +0000
+++ debian/rules	2013-05-10 16:56:25 +0000
@@ -34,18 +34,14 @@
 
 override_dh_auto_install:
 	# utah and utah-client both live in the utah directory
-	# utah-parser lives in that tree as well
 	# utah should only install the provisioning subdirectory, and utah-client should install everything else
-	# except parser.py, which is now its own package
-	# and __init__.py, which is now in the common package
+	# except __init__.py, which is now in the common package
 	# The baremetal subdirectory in the provisioning directory is now 3 packages
 	# If we just use dh_auto_install, all packages will get everything
 	# We start by building the whole thing
 	set -e && for pyvers in $(PYVERS); do python$$pyvers setup.py install --install-layout=deb --root=$(CURDIR); done
 	# Next, we move the built provisioning directory aside for later use
 	mv build/*/utah/provisioning .
-	# Same with parser.py
-	mv build/*/utah/parser.py .
 	# And __init__.py
 	mv build/*/utah/__init__.py .
 	# Now we install into the utah-client directory, since provisioning is removed, using --skip-build to not rebuild it
@@ -58,10 +54,6 @@
 	mv build/*/utah/provisioning/baremetal .
 	# Now we install just the provisioning directory, again using --skip-build into the utah package tree
 	set -e && for pyvers in $(PYVERS); do python$$pyvers setup.py install --skip-build --install-layout=deb --root=$(CURDIR)/debian/utah; done
-	# And now we put back the parser and install that
-	rm -r build/*/utah/*
-	mv parser.py build/*/utah
-	set -e && for pyvers in $(PYVERS); do python$$pyvers setup.py install --skip-build --install-layout=deb --root=$(CURDIR)/debian/utah-parser; done
 	# And now we put back the init file and install that
 	rm -r build/*/utah/*
 	mv __init__.py build/*/utah
 
=== modified file 'examples/run_utah_tests.py'
--- examples/run_utah_tests.py	2013-05-01 23:57:13 +0000
+++ examples/run_utah_tests.py	2013-05-10 16:56:25 +0000
@@ -17,8 +17,6 @@
 
 """Provision a machine a run a test."""
 
-
-import argparse
 import logging
 import os
 import sys
@@ -31,16 +29,15 @@
 from utah.cleanup import cleanup
 from utah.exceptions import UTAHException
 from utah.group import check_user_group, print_group_error_message
+from utah.parser import get_parser, parse_args  # NOQA
 from utah.provisioning.ssh import ProvisionedMachine
 from utah.provisioning.vm import TinySQLiteInventory
 from utah.run import (
     configure_logging,
-    master_runlist_argument,
     run_tests,
     ReturnCodes,
 )
 from utah.timeout import timeout, UTAHTimeout
-from utah.url import url_argument
 
 
 MISSING = []
@@ -59,108 +56,6 @@
     MISSING.append('baremetal')
 
 
-def get_parser():
-    parser = argparse.ArgumentParser(
-        description=('Provision a machine '
-                     'and run one or more UTAH runlists there.\n\n'
-                     'The appropriate run_*.py script will be called, '
-                     'depending on the parameters passed.'),
-        epilog=("For example:\n"
-                "Provision a VM using a precise server image "
-                "with i386 architecture and run the given runlist\n"
-                "\t%(prog)s -s precise -t server -a i386 \\\n"
-                "\t\t/usr/share/utah/client/examples/master.run"),
-        formatter_class=argparse.RawDescriptionHelpFormatter)
-    parser.add_argument('-m', '--machinetype', metavar='MACHINETYPE',
-                        choices=('physical', 'virtual'),
-                        default=config.machinetype,
-                        help='Type of machine to provision (%(choices)s) '
-                             '(Default is %(default)s)')
-    parser.add_argument('-v', '--variant',
-                        default=config.variant,
-                        help='Variant of architecture, i.e., armel, armhf')
-    parser.add_argument('--skip-provisioning', action='store_true',
-                        help='Reuse a system that is already provisioned '
-                             '(name argument must be passed)')
-    parser.add_argument('runlist', metavar='runlist',
-                        type=master_runlist_argument,
-                        help='URLs of runlist files to run')
-    parser.add_argument('-s', '--series', metavar='SERIES',
-                        choices=config.serieschoices,
-                        default=config.series,
-                        help='Series to use for installation (%(choices)s) '
-                             '(Default is %(default)s)')
-    parser.add_argument('-t', '--type', metavar='TYPE',
-                        choices=('desktop', 'server', 'mini', 'alternate'),
-                        default=config.installtype,
-                        help='Install type to use for installation '
-                             '(%(choices)s) (Default is %(default)s)')
-    parser.add_argument('-a', '--arch', metavar='ARCH',
-                        choices=('i386', 'amd64', 'arm'),
-                        default=config.arch,
-                        help='Architecture to use for installation '
-                             '(%(choices)s) (Default is %(default)s)')
-    parser.add_argument('-n', '--no-destroy', action='store_true',
-                        help='Preserve VM after tests have run')
-    parser.add_argument('-d', '--debug', action='store_true',
-                        help='Enable debug logging')
-    parser.add_argument('-j', '--json', action='store_true',
-                        help='Enable json logging (default is YAML)')
-    parser.add_argument('-f', '--files', action='append',
-                        help='File or directory to copy from test system ')
-    parser.add_argument('-o', '--outdir',
-                        help=('Directory to store locally copied files '
-                              '(Default is {}/machine-name)'
-                              .format(config.logpath)))
-    parser.add_argument('--dumplogs', action='store_true',
-                        help='Write client output logs to standard out')
-    parser.add_argument('--outputpreseed', action='store_true',
-                        help='Copy preseed to logs directory and list as '
-                        'log file in output')
-    parser.add_argument('-i', '--image', type=url_argument,
-                        default=config.image,
-                        help='Image/ISO file to use for installation')
-    parser.add_argument('-p', '--preseed', type=url_argument,
-                        default=config.preseed,
-                        help='Preseed file to use for installation')
-    parser.add_argument('-b', '--boot',
-                        default=config.boot,
-                        help='Boot arguments for initial installation')
-    parser.add_argument('--rewrite',
-                        choices=('all', 'minimal', 'casperonly', 'none'),
-                        default=config.rewrite,
-                        help='Set level of automatic configuration rewriting '
-                             '(Default is %(default)s)')
-    parser.add_argument('-k', '--kernel', type=url_argument,
-                        default=config.kernel,
-                        help='Kernel file to use for installation')
-    parser.add_argument('-r', '--initrd', type=url_argument,
-                        default=config.initrd,
-                        help='InitRD file to use for installation')
-    parser.add_argument('--name',
-                        default=config.name,
-                        help='Name of machine to provision')
-    parser.add_argument('-e', '--emulator',
-                        default=config.emulator,
-                        help='Emulator to use (kvm and qemu are supported, '
-                             'kvm will be favored if available)')
-    parser.add_argument('-x', '--xml', type=url_argument,
-                        default=config.xml,
-                        help='XML VM definition file '
-                             '(Default is %(default)s)')
-    parser.add_argument('-g', '--gigabytes', action='append',
-                        default=config.disksizes,
-                        help='Size in gigabytes of virtual disk, '
-                             'specify more than once for multiple disks '
-                             '(Default is %(default)s)')
-    parser.add_argument('--diskbus', metavar='DISKBUS',
-                        choices=('virtio', 'sata', 'ide'),
-                        default=config.diskbus,
-                        help='Disk bus to use for customvm installation '
-                             '(%(choices)s) (Default is %(default)s)')
-    return parser
-
-
 def _get_machine(args):
     if args.skip_provisioning:
         # TBD: Inventory should be used to verify machine
@@ -210,8 +105,7 @@
 
 
 def run_utah_tests(args=None):
-    if args is None:
-        args = get_parser().parse_args()
+    args = parse_args()
 
     if not check_user_group():
         print_group_error_message(__file__)
 
=== added file 'tests/test_parser.py'
--- tests/test_parser.py	1970-01-01 00:00:00 +0000
+++ tests/test_parser.py	2013-05-10 16:56:25 +0000
@@ -0,0 +1,72 @@
+# Ubuntu Testing Automation Harness
+# Copyright 2013 Canonical Ltd.
+
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Unit tests for the utah.parser module."""
+
+import unittest
+
+from mock import patch, DEFAULT
+
+from utah import config
+from utah.parser import parse_args
+
+
+class TestParser(unittest.TestCase):
+
+    """Tests that command line parsing works as expected."""
+
+    def parse_args_wrapper(self, argv):
+        """A wrapper to ensure that runlist argument passes validation.
+
+        :param argv: Command line arguments to be tested
+        :type argv: list
+        :returns: Parse arguments
+        :rtype: `argparse.Namespace`
+
+        """
+        with patch.multiple('utah.run',
+                            url_argument=DEFAULT,
+                            parse_yaml_file=DEFAULT) as patches:
+            patches['url_argument'].return_value = '<local_runlist_file>'
+            patches['parse_yaml_file'].return_value = {
+                'testsuites': [
+                    {'name': 'test_suite_name',
+                     'fetch_method': 'dev',
+                     'fetch_location': '<fetch_location>',
+                     },
+                ]
+            }
+            return parse_args(argv)
+
+    def test_gigabytes_default(self):
+        """Verify that gigabytes is set to default value if not passed."""
+        args = self.parse_args_wrapper(['<runlist_file>'])
+        self.assertEqual(args.gigabytes, config.disksizes)
+
+    def test_gigabytes_one_argument(self):
+        """Verify that gigabytes is set to the argument passed."""
+        gigabytes = '3'
+        args = self.parse_args_wrapper(['--gigabytes', gigabytes,
+                                        '<runlist_file>'])
+        self.assertEqual(args.gigabytes, [gigabytes])
+
+    def test_gigabytes_multiple_arguments(self):
+        """Verify that gigabytes is set to the arguments passed."""
+        gigabytes = ['3', '5', '7']
+        args = self.parse_args_wrapper(['--gigabytes', gigabytes[0],
+                                        '--gigabytes', gigabytes[1],
+                                        '--gigabytes', gigabytes[2],
+                                        '<runlist_file>'])
+        self.assertEqual(args.gigabytes, gigabytes)
 
=== added file 'utah/parser.py'
--- utah/parser.py	1970-01-01 00:00:00 +0000
+++ utah/parser.py	2013-05-10 16:56:25 +0000
@@ -0,0 +1,149 @@
+# Ubuntu Testing Automation Harness
+# Copyright 2012 Canonical Ltd.
+
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Command line parser for the utah server script."""
+
+import argparse
+import sys
+
+from utah import config
+from utah.run import master_runlist_argument
+from utah.url import url_argument
+
+
+def parse_args(argv=None):
+    """Parse command line arguments.
+
+    :param argv: Command line arguments to be parsed
+    :type argv: list
+    :returns: Parse arguments
+    :rtype: `argparse.Namespace`
+
+    """
+
+    if argv is None:
+        argv = sys.argv[1:]
+
+    args = get_parser().parse_args(argv)
+    if args.gigabytes is None:
+        args.gigabytes = config.disksizes
+    return args
+
+
+def get_parser():
+    """Get command line parser.
+
+    :returns: Parser object
+    :rtype: `argparse.ArgumentParser`
+
+    """
+    parser = argparse.ArgumentParser(
+        description=('Provision a machine '
+                     'and run one or more UTAH runlists there.\n\n'
+                     'The appropriate run_*.py script will be called, '
+                     'depending on the parameters passed.'),
+        epilog=("For example:\n"
+                "Provision a VM using a precise server image "
+                "with i386 architecture and run the given runlist\n"
+                "\t%(prog)s -s precise -t server -a i386 \\\n"
+                "\t\t/usr/share/utah/client/examples/master.run"),
+        formatter_class=argparse.RawDescriptionHelpFormatter)
+    parser.add_argument('-m', '--machinetype', metavar='MACHINETYPE',
+                        choices=('physical', 'virtual'),
+                        default=config.machinetype,
+                        help='Type of machine to provision (%(choices)s) '
+                             '(Default is %(default)s)')
+    parser.add_argument('-v', '--variant',
+                        default=config.variant,
+                        help='Variant of architecture, i.e., armel, armhf')
+    parser.add_argument('--skip-provisioning', action='store_true',
+                        help='Reuse a system that is already provisioned '
+                             '(name argument must be passed)')
+    parser.add_argument('runlist', metavar='runlist',
+                        type=master_runlist_argument,
+                        help='URLs of runlist files to run')
+    parser.add_argument('-s', '--series', metavar='SERIES',
+                        choices=config.serieschoices,
+                        default=config.series,
+                        help='Series to use for installation (%(choices)s) '
+                             '(Default is %(default)s)')
+    parser.add_argument('-t', '--type', metavar='TYPE',
+                        choices=('desktop', 'server', 'mini', 'alternate'),
+                        default=config.installtype,
+                        help='Install type to use for installation '
+                             '(%(choices)s) (Default is %(default)s)')
+    parser.add_argument('-a', '--arch', metavar='ARCH',
+                        choices=('i386', 'amd64', 'arm'),
+                        default=config.arch,
+                        help='Architecture to use for installation '
+                             '(%(choices)s) (Default is %(default)s)')
+    parser.add_argument('-n', '--no-destroy', action='store_true',
+                        help='Preserve VM after tests have run')
+    parser.add_argument('-d', '--debug', action='store_true',
+                        help='Enable debug logging')
+    parser.add_argument('-j', '--json', action='store_true',
+                        help='Enable json logging (default is YAML)')
+    parser.add_argument('-f', '--files', action='append',
+                        help='File or directory to copy from test system ')
+    parser.add_argument('-o', '--outdir',
+                        help=('Directory to store locally copied files '
+                              '(Default is {}/machine-name)'
+                              .format(config.logpath)))
+    parser.add_argument('--dumplogs', action='store_true',
+                        help='Write client output logs to standard out')
+    parser.add_argument('--outputpreseed', action='store_true',
+                        help='Copy preseed to logs directory and list as '
+                        'log file in output')
+    parser.add_argument('-i', '--image', type=url_argument,
+                        default=config.image,
+                        help='Image/ISO file to use for installation')
+    parser.add_argument('-p', '--preseed', type=url_argument,
+                        default=config.preseed,
+                        help='Preseed file to use for installation')
+    parser.add_argument('-b', '--boot',
+                        default=config.boot,
+                        help='Boot arguments for initial installation')
+    parser.add_argument('--rewrite',
+                        choices=('all', 'minimal', 'casperonly', 'none'),
+                        default=config.rewrite,
+                        help='Set level of automatic configuration rewriting '
+                             '(Default is %(default)s)')
+    parser.add_argument('-k', '--kernel', type=url_argument,
+                        default=config.kernel,
+                        help='Kernel file to use for installation')
+    parser.add_argument('-r', '--initrd', type=url_argument,
+                        default=config.initrd,
+                        help='InitRD file to use for installation')
+    parser.add_argument('--name',
+                        default=config.name,
+                        help='Name of machine to provision')
+    parser.add_argument('-e', '--emulator',
+                        default=config.emulator,
+                        help='Emulator to use (kvm and qemu are supported, '
+                             'kvm will be favored if available)')
+    parser.add_argument('-x', '--xml', type=url_argument,
+                        default=config.xml,
+                        help='XML VM definition file '
+                             '(Default is %(default)s)')
+    parser.add_argument('-g', '--gigabytes', action='append',
+                        help='Size in gigabytes of virtual disk, '
+                             'specify more than once for multiple disks '
+                             '(Default is {})'.format(config.disksizes))
+    parser.add_argument('--diskbus', metavar='DISKBUS',
+                        choices=('virtio', 'sata', 'ide'),
+                        default=config.diskbus,
+                        help='Disk bus to use for customvm installation '
+                             '(%(choices)s) (Default is %(default)s)')
+    return parser
 
=== removed file 'utah/parser.py'
--- utah/parser.py	2013-04-03 21:17:26 +0000
+++ utah/parser.py	1970-01-01 00:00:00 +0000
@@ -1,222 +0,0 @@
-# Ubuntu Testing Automation Harness
-# Copyright 2012 Canonical Ltd.
-
-# This program is free software: you can redistribute it and/or modify it
-# under the terms of the GNU General Public License version 3, as published
-# by the Free Software Foundation.
-
-# This program is distributed in the hope that it will be useful, but
-# WITHOUT ANY WARRANTY; without even the implied warranties of
-# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
-# PURPOSE.  See the GNU General Public License for more details.
-
-# You should have received a copy of the GNU General Public License along
-# with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-"""UTAH Client log parser."""
-
-
-import argparse
-import jsonschema
-import logging
-import urllib2
-import yaml
-
-
-class ParserError(Exception):
-
-    """Module level parse error exception."""
-
-    pass
-
-
-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,
-            },
-            'ran_at': {
-                '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,
-            },
-            'arch': {
-                'type': 'string',
-                'required': True,
-            },
-            'release': {
-                'type': 'string',
-                'required': True,
-            },
-            'build_number': {
-                'type': 'string',
-                'required': True,
-            },
-        },
-    }
-
-    def parse(self, logdata, as_string=False):
-        """Parse utah client results.
-
-        :param logdata:
-            should be either a filename or a handle to a file object.
-
-        :returns: the parsed yaml data or None.
-
-        :raises: ParserError on exceptions.
-
-        """
-
-        if as_string:
-            return self._parse_string(logdata)
-        elif isinstance(logdata, str):
-            return self._parse_logfile(logdata)
-        else:
-            return self._parse_stream(logdata)
-
-    def _parse_stream(self, stream):
-        """Parse client output from stream.
-
-        :returns: validated decoded YAML data.
-
-        :raises: ParseError
-
-        """
-        try:
-            data = yaml.load(stream)
-        except yaml.YAMLError as e:
-            logging.error(e)
-            raise ParserError(e.message)
-
-        # Allow empty yaml files
-        if data is None:
-            return data
-
-        try:
-            jsonschema.validate(data, self.CLIENT_OUTPUT_SCHEMA)
-        except jsonschema.ValidationError as e:
-            logging.error(e)
-            raise ParserError(e.message)
-
-        return data
-
-    def _parse_logfile(self, logfile):
-        """Parse client output log.
-
-        :returns: validated decoded YAML data.
-
-        :raises: ParseError
-
-        """
-        data = None
-
-        if logfile.startswith('http'):
-            try:
-                fp = urllib2.urlopen(logfile)
-            except IOError as err:
-                raise ParserError(
-                    'IOError when downloading {}: {}'
-                    .format(logfile, err))
-            except urllib2.ContentTooShortError as err:
-                raise ParserError(
-                    'Error when downloading {} (probably interrupted): {}'
-                    .format(logfile, err))
-            data = self._parse_stream(fp)
-        else:
-            with open(logfile, 'r') as fp:
-                data = self._parse_stream(fp)
-
-        return data
-
-    def _parse_string(self, log_data):
-        """Parse client data from a string.
-
-        :returns: validated decoded YAML data.
-
-        :raises: ParseError
-
-        """
-        try:
-            data = yaml.load(log_data)
-
-            # Allow empty yaml files
-            if data is None:
-                return data
-        except yaml.YAMLError as e:
-            logging.error(e)
-            raise ParserError(e.message)
-
-        try:
-            jsonschema.validate(data, self.CLIENT_OUTPUT_SCHEMA)
-        except jsonschema.ValidationError as e:
-            logging.error(e)
-            raise ParserError(e.message)
-
-        return data
-
-
-if __name__ == "__main__":
-    arg_parser = argparse.ArgumentParser(description='phoenix bootstrapper')
-    arg_parser.add_argument('logfile', metavar='LOGFILE', type=str,
-                            help='log file to parse')
-
-    args = arg_parser.parse_args()
-
-    parser = UTAHParser()
-    data = parser.parse(args.logfile)
-    print(data)