Merge lp:~kissiel/checkbox/ignore-manifest into lp:checkbox

[Maciej Kisielewski]

This MR removes manifest.json from versioning and makes build me always generate one.

As an added bonus we are asserted that the version spelled in manifest will always match the one reported by python core code (as it originates from it).

To test it, just run normal build of checkbox-converged (README.rst)

913b4af checkbox-converged: add function that generates manifest
44b5725 checkbox-converged: use generate_manifest
9dd8dde checkbox-converged: remove version comparison
39b5d5c checkbox-converged: remove manifest.json and add it to ignored
5f7c1ad checkbox-converged: fix pep-8 issues in build-me

[Sylvain Pineau (sylvain-pineau)]

The build process works, +1 for this new feature

review: Approve

=== modified file 'checkbox-touch/.gitignore'
--- checkbox-touch/.gitignore	2015-04-19 19:39:28 +0000
+++ checkbox-touch/.gitignore	2016-05-26 22:46:01 +0000
@@ -8,3 +8,4 @@
 providers/
 # Ignore auto-generated desktop file
 checkbox-touch.desktop
+manifest.json

=== modified file 'checkbox-touch/build-me'
--- checkbox-touch/build-me	2016-05-24 12:01:35 +0000
+++ checkbox-touch/build-me	2016-05-26 22:46:01 +0000
@@ -12,15 +12,14 @@
 import textwrap
 import tempfile
 
-from confinement.generate import generate_confinement
-sys.path.append('./py')
-from py.embedded_providers import EmbeddedProvider1PlugInCollection
-from py.checkbox_touch import CheckboxTouchApplication
-
 from utils import get_package_from_url_and_extract
 from utils import prepare_uris
 from utils import rsync_tree
 
+from confinement.generate import generate_confinement
+sys.path.append('./py')
+
+
 # DEFAULT_PROVIDERS is a list of providers directory names as listed in
 # ../providers. NOTE: those are directory names, not provider names as reported
 # by manage.py info
@@ -55,6 +54,7 @@
 
 
 def get_confined_jobs(path):
+    from py.embedded_providers import EmbeddedProvider1PlugInCollection
     collection = EmbeddedProvider1PlugInCollection(path)
     # this should be run within provider's directory, so there should be
     # only one provider loaded
@@ -82,18 +82,6 @@
                 "{} not found!\nHave you run get-libs?".format(path))
 
 
-def check_versions_match(manifest):
-    """Check if version coded in python matches one from manifest.json."""
-    res = CheckboxTouchApplication().get_version_pair()
-    version_from_py = res['result']['application_version']
-
-    if manifest['version'] != version_from_py:
-        raise Exception(
-            ("Version mismatch! Version from checkbox_touch.py: {}, "
-             "version from manifest.json: {}").format(
-                    version_from_py, manifest['version']))
-
-
 def get_revision_string(path='.'):
     # Try getting revno from bazaar vcs
     try:
@@ -190,17 +178,8 @@
     extract_dependencies()
     copy_provider_libs()
 
-    current_manifest = json.loads(open('manifest.json', 'rt').read())
-    check_versions_match(current_manifest)
-    hooks = {
-        'checkbox-touch': current_manifest['hooks']['checkbox-touch']
-    }
-    for hook in build_confinement(current_manifest['version']):
-        hooks.update(hook)
-    new_manifest = current_manifest.copy()
-    new_manifest['hooks'] = hooks
-    with open('manifest.json', 'wt') as f:
-        f.write(json.dumps(new_manifest, sort_keys=True, indent=4))
+    generate_manifest()
+
     build_i18n()
 
     generate_desktop_file(lang=args.forced_lang)
@@ -274,6 +253,7 @@
                   "provider '{}'.".format(provider_dir))
             raise e
 
+
 def extract_dependencies():
     print("Extracting dependencies")
     for provider_dir in os.listdir('providers'):
@@ -308,6 +288,7 @@
                 if os.path.exists(lib_path):
                     rsync_tree(lib_path, 'lib', preserve_symlinks=1)
 
+
 def copy_provider_libs():
     print("Copy over provider-supplied libs")
     for provider_dir in os.listdir('providers'):
@@ -317,7 +298,8 @@
 
 
 def generate_desktop_file(lang=None):
-    exec_line = "qmlscene --settings=settings.json {import_options} $@ checkbox-touch.qml"
+    exec_line = ("qmlscene --settings=settings.json "
+                 "{import_options} $@ checkbox-touch.qml")
     if lang:
         exec_line = 'bash -c "LANGUAGE={} {}"'.format(lang, exec_line)
     template = textwrap.dedent("""
@@ -341,6 +323,36 @@
         f.write(template.format(import_options=" ".join(import_opts)))
 
 
+def generate_manifest():
+    from py.checkbox_touch import CheckboxTouchApplication
+    res = CheckboxTouchApplication().get_version_pair()
+    version = res['result']['application_version']
+    hooks = {
+        'checkbox-touch': {
+            'apparmor': 'checkbox-touch.json',
+            'desktop': 'checkbox-touch.desktop'
+        }
+    }
+    for hook in build_confinement(version):
+        hooks.update(hook)
+    manifest = {
+        'architecture': 'armhf',
+        'description': 'System testing utility for Ubuntu',
+        'framework': 'ubuntu-sdk-14.10',
+        'hooks': hooks,
+        'maintainer': 'Checkbox Developers <[e-mail]>',
+        'name': 'com.ubuntu.checkbox',
+        'title': 'Checkbox',
+        'version': version,
+        'x-source': {
+            'vcs-bzr': 'lp:checkbox',
+            'vcs-bzr-revno': version
+        }
+    }
+    with open('manifest.json', 'wt') as f:
+        f.write(json.dumps(manifest, sort_keys=True, indent=4))
+
+
 def build_click():
     print('Building click package')
     base_path = os.path.normpath(os.path.join(os.getcwd(), '..'))

=== removed file 'checkbox-touch/manifest.json'
--- checkbox-touch/manifest.json	2016-04-29 02:50:45 +0000
+++ checkbox-touch/manifest.json	1970-01-01 00:00:00 +0000
@@ -1,19 +0,0 @@
-{
-    "architecture": "armhf",
-    "description": "System testing utility for Ubuntu",
-    "framework": "ubuntu-sdk-14.10",
-    "hooks": {
-        "checkbox-touch": {
-            "apparmor": "checkbox-touch.json",
-            "desktop": "checkbox-touch.desktop"
-        }
-    },
-    "maintainer": "Zygmunt Krynicki <[e-mail]>",
-    "name": "com.ubuntu.checkbox",
-    "title": "Checkbox",
-    "version": "1.3.dev",
-    "x-source": {
-        "vcs-bzr": "lp:checkbox",
-        "vcs-bzr-revno": "checkbox-touch-v1.3.dev0"
-    }
-}
\ No newline at end of file