Merge lp:~james-w/linaro-image-tools/hwpack-create-config into lp:linaro-image-tools/11.11

[James Westby]

Hi,

Here is a small branch to add the skeleton of the hwpack module with tests, and the start of
a hwpack.config for reading the configuration files specifying what to put in a hwpack.

You can read the description of the format at https://wiki.linaro.org/Platform/UserPlatforms/Specs/10.11/HardwarePacks#hwpack-create

Thanks,

James

[lp:~james-w/linaro-image-tools/hwpack-create-config]

46. By James Westby on 2010-08-27

Add a testsuite function to run the tests.

47. By James Westby on 2010-08-27

Add a .testr.conf for the project.

48. By James Westby on 2010-08-27

Use a method to avoid hardcoding StringIO everywhere.

49. By James Westby on 2010-08-27

Use a helper assertion to reduce code duplication.

[Alexander Sack (asac)]

looks like a good start. merged.

review: Approve

[Michael Hudson-Doyle (mwhudson)]

I know this is late, but:

1) I would have appreciated some documentation on what the various properties on the Config option meant.

2) I'm sure there's a place for a _get_main_option helper -- origin, main and support at least are very similar.

Cheers,
mwh

=== added file '.bzrignore'
--- .bzrignore	1970-01-01 00:00:00 +0000
+++ .bzrignore	2010-08-27 20:28:42 +0000
@@ -0,0 +1,1 @@
+.testrepository
 
=== added file '.testr.conf'
--- .testr.conf	1970-01-01 00:00:00 +0000
+++ .testr.conf	2010-08-27 20:28:42 +0000
@@ -0,0 +1,3 @@
+[DEFAULT]
+test_command=python -m subunit.run $IDLIST
+test_id_list_default=hwpack.tests.test_suite
 
=== added directory 'hwpack'
=== added file 'hwpack/__init__.py'
=== added file 'hwpack/config.py'
--- hwpack/config.py	1970-01-01 00:00:00 +0000
+++ hwpack/config.py	2010-08-27 20:28:42 +0000
@@ -0,0 +1,167 @@
+import ConfigParser
+import re
+
+class HwpackConfigError(Exception):
+    pass
+
+
+class Config(object):
+    """Encapsulation of a hwpack-create configuration."""
+
+    MAIN_SECTION = "hwpack"
+    NAME_KEY = "name"
+    NAME_REGEX = "[a-z0-9][a-z0-9+0.]+"
+    INCLUDE_DEBS_KEY = "include-debs"
+    SUPPORT_KEY = "support"
+    SOURCES_ENTRY_KEY = "sources-entry"
+    PACKAGES_KEY = "packages"
+    PACKAGE_REGEX = NAME_REGEX
+    ORIGIN_KEY = "origin"
+    MAINTAINER_KEY = "maintainer"
+
+    def __init__(self, fp):
+        """Create a Config.
+
+        :param fp: a file-like object containing the configuration.
+        """
+        self.parser = ConfigParser.RawConfigParser()
+        self.parser.readfp(fp)
+
+    def validate(self):
+        """Check that this configuration follows the schema.
+
+        :raises HwpackConfigError: if it does not.
+        """
+        if not self.parser.has_section(self.MAIN_SECTION):
+            raise HwpackConfigError("No [%s] section" % self.MAIN_SECTION)
+        self._validate_name()
+        self._validate_include_debs()
+        self._validate_support()
+        self._validate_sections()
+
+    @property
+    def name(self):
+        return self.parser.get(self.MAIN_SECTION, self.NAME_KEY)
+
+    @property
+    def include_debs(self):
+        try:
+            if not self.parser.get(
+                self.MAIN_SECTION, self.INCLUDE_DEBS_KEY):
+                return True
+            return self.parser.getboolean(
+                self.MAIN_SECTION, self.INCLUDE_DEBS_KEY)
+        except ConfigParser.NoOptionError:
+            return True
+
+    @property
+    def origin(self):
+        try:
+            origin = self.parser.get(self.MAIN_SECTION, self.ORIGIN_KEY)
+            if not origin:
+                return None
+            return origin
+        except ConfigParser.NoOptionError:
+            return None
+
+    @property
+    def maintainer(self):
+        try:
+            maintainer = self.parser.get(
+                self.MAIN_SECTION, self.MAINTAINER_KEY)
+            if not maintainer:
+                return None
+            return maintainer
+        except ConfigParser.NoOptionError:
+            return None
+
+    @property
+    def support(self):
+        try:
+            support = self.parser.get(self.MAIN_SECTION, self.SUPPORT_KEY)
+            if not support:
+                return None
+            return support
+        except ConfigParser.NoOptionError:
+            return None
+
+    def _validate_name(self):
+        try:
+            name = self.name
+            if not name:
+                raise HwpackConfigError("Empty value for name")
+            if re.match(self.NAME_REGEX, name) is None:
+                raise HwpackConfigError("Invalid name: %s" % name)
+        except ConfigParser.NoOptionError:
+            raise HwpackConfigError(
+                "No name in the [%s] section" % self.MAIN_SECTION)
+
+    def _validate_include_debs(self):
+        try:
+            self.include_debs
+        except ValueError:
+            raise HwpackConfigError(
+                "Invalid value for include-debs: %s"
+                % self.parser.get("hwpack", "include-debs"))
+
+    def _validate_support(self):
+        support = self.support
+        if support not in (None, "supported", "unsupported"):
+            raise HwpackConfigError(
+                "Invalid value for support: %s" % support)
+
+    def _validate_section_sources_entry(self, section_name):
+        try:
+            sources_entry = self.parser.get(
+                section_name, self.SOURCES_ENTRY_KEY)
+            if not sources_entry:
+                raise HwpackConfigError(
+                    "The %s in the [%s] section is missing the URI"
+                    % (self.SOURCES_ENTRY_KEY, section_name))
+            if len(sources_entry.split(" ", 1)) < 2:
+                raise HwpackConfigError(
+                    "The %s in the [%s] section is missing the distribution"
+                    % (self.SOURCES_ENTRY_KEY, section_name))
+            if sources_entry.startswith("deb"):
+                raise HwpackConfigError(
+                    "The %s in the [%s] section shouldn't start with 'deb'"
+                    % (self.SOURCES_ENTRY_KEY, section_name))
+        except ConfigParser.NoOptionError:
+            raise HwpackConfigError(
+                "No %s in the [%s] section"
+                % (self.SOURCES_ENTRY_KEY, section_name))
+
+    def _validate_section_packages(self, section_name):
+        try:
+            packages = self.parser.get(section_name, self.PACKAGES_KEY)
+            if not packages:
+                raise HwpackConfigError(
+                    "The %s in the [%s] section is empty"
+                    % (self.PACKAGES_KEY, section_name))
+            for package in packages.split(" "):
+                if not package:
+                    continue
+                if re.match(self.PACKAGE_REGEX, package) is None:
+                    raise HwpackConfigError(
+                        "Invalid value in %s in the [%s] section: %s"
+                        % (self.PACKAGES_KEY, section_name, package))
+        except ConfigParser.NoOptionError:
+            raise HwpackConfigError(
+                "No %s in the [%s] section"
+                % (self.PACKAGES_KEY, section_name))
+
+    def _validate_section(self, section_name):
+        self._validate_section_sources_entry(section_name)
+        self._validate_section_packages(section_name)
+
+    def _validate_sections(self):
+        sections = self.parser.sections()
+        found = False
+        for section_name in sections:
+            if section_name == self.MAIN_SECTION:
+                continue
+            self._validate_section(section_name)
+            found = True
+        if not found:
+            raise HwpackConfigError(
+                "No sections other than [%s]" % self.MAIN_SECTION)
 
=== added directory 'hwpack/tests'
=== added file 'hwpack/tests/__init__.py'
--- hwpack/tests/__init__.py	1970-01-01 00:00:00 +0000
+++ hwpack/tests/__init__.py	2010-08-27 20:28:42 +0000
@@ -0,0 +1,8 @@
+import unittest
+
+def test_suite():
+    module_names = ['hwpack.tests.test_config',
+                   ]
+    loader = unittest.TestLoader()
+    suite = loader.loadTestsFromNames(module_names)
+    return suite
 
=== added file 'hwpack/tests/test_config.py'
--- hwpack/tests/test_config.py	1970-01-01 00:00:00 +0000
+++ hwpack/tests/test_config.py	2010-08-27 20:28:42 +0000
@@ -0,0 +1,196 @@
+from StringIO import StringIO
+
+from testtools import TestCase
+
+from hwpack.config import Config, HwpackConfigError
+
+
+class ConfigTests(TestCase):
+
+    def test_create(self):
+        config = Config(StringIO())
+
+    def get_config(self, contents):
+        return Config(StringIO(contents))
+
+    def assertConfigError(self, contents, f, *args, **kwargs):
+        e = self.assertRaises(HwpackConfigError, f, *args, **kwargs)
+        self.assertEqual(contents, str(e))
+
+    def assertValidationError(self, contents, config):
+        self.assertConfigError(contents, config.validate)
+
+    def test_validate_no_hwpack_section(self):
+        config = self.get_config("")
+        self.assertValidationError("No [hwpack] section", config)
+
+    def test_validate_no_name(self):
+        config = self.get_config("[hwpack]\n")
+        self.assertValidationError("No name in the [hwpack] section", config)
+
+    def test_validate_empty_name(self):
+        config = self.get_config("[hwpack]\nname =  \n")
+        self.assertValidationError("Empty value for name", config)
+
+    def test_validate_invalid_name(self):
+        config = self.get_config("[hwpack]\nname = ~~\n")
+        self.assertValidationError("Invalid name: ~~", config)
+
+    def test_validate_invalid_include_debs(self):
+        config = self.get_config(
+                "[hwpack]\nname = ahwpack\n"
+                "include-debs = if you don't mind\n")
+        self.assertValidationError(
+            "Invalid value for include-debs: if you don't mind", config)
+
+    def test_validate_invalid_supported(self):
+        config = self.get_config(
+                "[hwpack]\nname = ahwpack\nsupport = if you pay us\n")
+        self.assertValidationError(
+            "Invalid value for support: if you pay us", config)
+
+    def test_validate_no_other_sections(self):
+        config = self.get_config("[hwpack]\nname = ahwpack\n")
+        self.assertValidationError(
+            "No sections other than [hwpack]", config)
+
+    def test_validate_other_section_no_sources_entry(self):
+        config = self.get_config(
+                "[hwpack]\nname = ahwpack\n\n[ubuntu]\n")
+        self.assertValidationError(
+            "No sources-entry in the [ubuntu] section", config)
+
+    def test_validate_other_section_empty_sources_entry(self):
+        config = self.get_config(
+                "[hwpack]\nname = ahwpack\n\n"
+                "[ubuntu]\nsources-entry =  \n")
+        self.assertValidationError(
+            "The sources-entry in the [ubuntu] section is missing the URI",
+            config)
+
+    def test_validate_other_section_only_uri_in_sources_entry(self):
+        config = self.get_config(
+                "[hwpack]\nname = ahwpack\n\n"
+                "[ubuntu]\nsources-entry =  foo\n")
+        self.assertValidationError(
+            "The sources-entry in the [ubuntu] section is missing the "
+            "distribution", config)
+
+    def test_validate_other_section_sources_entry_starting_with_deb(self):
+        config = self.get_config(
+                "[hwpack]\nname = ahwpack\n\n"
+                "[ubuntu]\nsources-entry =  deb http://example.org/ "
+                "foo main\n")
+        self.assertValidationError(
+            "The sources-entry in the [ubuntu] section shouldn't start "
+            "with 'deb'", config)
+
+    def test_validate_other_section_sources_entry_starting_with_deb_src(self):
+        config = self.get_config(
+                "[hwpack]\nname = ahwpack\n\n"
+                "[ubuntu]\nsources-entry =  deb-src http://example.org/ "
+                "foo main\n")
+        self.assertValidationError(
+            "The sources-entry in the [ubuntu] section shouldn't start "
+            "with 'deb'", config)
+
+    def test_validate_other_section_no_packages(self):
+        config = self.get_config(
+                "[hwpack]\nname = ahwpack\n\n"
+                "[ubuntu]\nsources-entry = foo bar\n")
+        self.assertValidationError(
+            "No packages in the [ubuntu] section", config)
+
+    def test_validate_other_section_empty_packages(self):
+        config = self.get_config(
+                "[hwpack]\nname = ahwpack\n\n"
+                "[ubuntu]\nsources-entry = foo bar\npackages = \n")
+        self.assertValidationError(
+            "The packages in the [ubuntu] section is empty",
+            config)
+
+    def test_validate_other_section_invalid_package_name(self):
+        config = self.get_config(
+                "[hwpack]\nname = ahwpack\n\n"
+                "[ubuntu]\nsources-entry = foo bar\n"
+                "packages = foo  ~~ bar\n")
+        self.assertValidationError(
+            "Invalid value in packages in the [ubuntu] section: ~~",
+            config)
+
+    def test_validate_valid_config(self):
+        config = self.get_config(
+                "[hwpack]\nname = ahwpack\n\n"
+                "[ubuntu]\nsources-entry = foo bar\n"
+                "packages = foo  bar\n")
+        self.assertEqual(None, config.validate())
+
+    def test_name(self):
+        config = self.get_config("[hwpack]\nname = ahwpack\n")
+        self.assertEqual("ahwpack", config.name)
+
+    def test_include_debs(self):
+        config = self.get_config(
+            "[hwpack]\nname = ahwpack\ninclude-debs = false\n")
+        self.assertEqual(False, config.include_debs)
+
+    def test_include_debs_defaults_true(self):
+        config = self.get_config(
+            "[hwpack]\nname = ahwpack\n")
+        self.assertEqual(True, config.include_debs)
+
+    def test_include_debs_defaults_true_on_empty(self):
+        config = self.get_config(
+            "[hwpack]\nname = ahwpack\ninclude-debs = \n")
+        self.assertEqual(True, config.include_debs)
+
+    def test_origin(self):
+        config = self.get_config(
+            "[hwpack]\nname = ahwpack\norigin = linaro\n")
+        self.assertEqual("linaro", config.origin)
+
+    def test_origin_default_None(self):
+        config = self.get_config(
+            "[hwpack]\nname = ahwpack\n")
+        self.assertEqual(None, config.origin)
+
+    def test_origin_None_on_empty(self):
+        config = self.get_config(
+            "[hwpack]\nname = ahwpack\norigin =  \n")
+        self.assertEqual(None, config.origin)
+
+    def test_maintainer(self):
+        maintainer = "Linaro Developers <[e-mail]>"
+        config = self.get_config(
+            "[hwpack]\nname = ahwpack\nmaintainer = %s\n" % maintainer)
+        self.assertEqual(maintainer, config.maintainer)
+
+    def test_maintainer_default_None(self):
+        config = self.get_config(
+            "[hwpack]\nname = ahwpack\n")
+        self.assertEqual(None, config.maintainer)
+
+    def test_maintainer_None_on_empty(self):
+        config = self.get_config(
+            "[hwpack]\nname = ahwpack\nmaintainer =  \n")
+        self.assertEqual(None, config.maintainer)
+
+    def test_support_supported(self):
+        config = self.get_config(
+            "[hwpack]\nname = ahwpack\nsupport = supported\n")
+        self.assertEqual("supported", config.support)
+
+    def test_support_unsupported(self):
+        config = self.get_config(
+            "[hwpack]\nname = ahwpack\nsupport = unsupported\n")
+        self.assertEqual("unsupported", config.support)
+
+    def test_support_default_None(self):
+        config = self.get_config(
+            "[hwpack]\nname = ahwpack\n")
+        self.assertEqual(None, config.support)
+
+    def test_support_None_on_empty(self):
+        config = self.get_config(
+            "[hwpack]\nname = ahwpack\nsupport =  \n")
+        self.assertEqual(None, config.support)