Merge lp:~sergiusens/snapcraft/mapnames into lp:~snappy-dev/snapcraft/core

[Sergio Schvezov]

Using a map instead of list for binaries and services as defined by the spec

[Daniel Holbach (dholbach)]

Looks good.

review: Approve

[Michael Vogt (mvo)]

Looks good.

review: Approve

[Snappy Tarmac (snappydevtarmac)]

More than one proposal found for merge of https://code.launchpad.net/~sergiusens/snapcraft/config into https://code.launchpad.net/~snappy-dev/snapcraft/core, which is not Superseded.

[Snappy Tarmac (snappydevtarmac)]

More than one proposal found for merge of https://code.launchpad.net/~sergiusens/snapcraft/config into https://code.launchpad.net/~snappy-dev/snapcraft/core, which is not Superseded.

[Sergio Schvezov (sergiusens)]

I resubmitted to get rid of the tarmac issue

review: Approve

=== modified file 'examples/downloader-with-wiki-parts/snapcraft.yaml'
--- examples/downloader-with-wiki-parts/snapcraft.yaml	2015-09-15 15:20:24 +0000
+++ examples/downloader-with-wiki-parts/snapcraft.yaml	2015-09-21 11:41:30 +0000
@@ -5,7 +5,8 @@
 description: this is an example package
 icon: icon.png
 binaries:
-    - name: bin/test
+    test:
+        exec: bin/test
 
 parts:
     main:

=== modified file 'examples/godd/snapcraft.yaml'
--- examples/godd/snapcraft.yaml	2015-09-18 14:53:03 +0000
+++ examples/godd/snapcraft.yaml	2015-09-21 11:41:30 +0000
@@ -2,7 +2,8 @@
 version: 1.0
 vendor: Michael Vogt <[e-mail]>
 binaries:
-  - name: ./bin/godd
+  godd:
+    exec: ./bin/godd
 summary: Simple dd like tool
 description: written in go so it is self contained and really portable, you would need to use hw-assign to access devices.
 icon: icon.png

=== modified file 'examples/gopaste/snapcraft.yaml'
--- examples/gopaste/snapcraft.yaml	2015-09-08 21:06:47 +0000
+++ examples/gopaste/snapcraft.yaml	2015-09-21 11:41:30 +0000
@@ -2,7 +2,7 @@
 version: 1.0
 vendor: Michael Terry <[e-mail]>
 services:
-  - name: gopaste
+  gopaste:
     description: "gopaste"
     start: bin/gopasted
 summary: Simple pasting tool

=== modified file 'examples/java-hello-world/snapcraft.yaml'
--- examples/java-hello-world/snapcraft.yaml	2015-09-15 09:43:13 +0000
+++ examples/java-hello-world/snapcraft.yaml	2015-09-21 11:41:30 +0000
@@ -2,7 +2,7 @@
 version: 0
 vendor: Michael Terry <[e-mail]>
 binaries:
- - name: hello
+ hello:
    exec: bin/wrapper
 summary: A java example
 description: this is not much more than an example

=== modified file 'examples/libpipeline/snapcraft.yaml'
--- examples/libpipeline/snapcraft.yaml	2015-09-08 11:48:30 +0000
+++ examples/libpipeline/snapcraft.yaml	2015-09-21 11:41:30 +0000
@@ -2,7 +2,8 @@
 version: 1.0
 vendor: Mike Terry <[e-mail]>
 binaries:
-  - name: ./bin/pipelinetest
+  pipelinetest:
+    exec: ./bin/pipelinetest
 summary: Libpipeline example
 description: this is an example package of an autotools project built with snapcraft using
 icon: icon.png

=== modified file 'examples/py2-project/snapcraft.yaml'
--- examples/py2-project/snapcraft.yaml	2015-09-08 11:48:30 +0000
+++ examples/py2-project/snapcraft.yaml	2015-09-21 11:41:30 +0000
@@ -2,7 +2,8 @@
 version: 0
 vendor: Michael Vogt <[e-mail]>
 binaries:
- - name: ./bin/sha3sum
+  sha3sum:
+    exec: ./bin/sha3sum
 summary: A python sha3 implementation
 description: A python2 project using snapcraft
 icon: icon.png

=== modified file 'examples/py3-project/snapcraft.yaml'
--- examples/py3-project/snapcraft.yaml	2015-09-08 11:48:30 +0000
+++ examples/py3-project/snapcraft.yaml	2015-09-21 11:41:30 +0000
@@ -2,7 +2,8 @@
 version: 0
 vendor: Michael Vogt <[e-mail]>
 binaries:
- - name: bin/sha3sum
+  sha3sum:
+    exec: bin/sha3sum
 summary: A python sha3 implementation
 description: A python2 project using snapcraft
 icon: icon.png

=== modified file 'examples/qmldemo/snapcraft.yaml'
--- examples/qmldemo/snapcraft.yaml	2015-09-08 11:50:21 +0000
+++ examples/qmldemo/snapcraft.yaml	2015-09-21 11:41:30 +0000
@@ -4,7 +4,7 @@
 frameworks:
   - mir
 binaries:
-  - name: qmldemo
+  qmldemo:
     exec: qmlscene demo.qml --
     caps:
       - mir_client

=== modified file 'examples/tomcat-maven-webapp/snapcraft.yaml'
--- examples/tomcat-maven-webapp/snapcraft.yaml	2015-09-08 11:50:21 +0000
+++ examples/tomcat-maven-webapp/snapcraft.yaml	2015-09-21 11:41:30 +0000
@@ -4,7 +4,7 @@
 architectures:
  - amd64
 services:
- - name: tomcat
+ tomcat:
    start: bin/wrapper
    caps:
    - networking

=== modified file 'examples/webcam-webui/snapcraft.yaml'
--- examples/webcam-webui/snapcraft.yaml	2015-09-20 14:34:08 +0000
+++ examples/webcam-webui/snapcraft.yaml	2015-09-21 11:41:30 +0000
@@ -5,7 +5,7 @@
 description: Exposes your webcam over a web UI
 icon: icon.png
 services:
-  - name: webcam-webui
+  webcam-webui:
     start: bin/webcam-webui
 config: usr/bin/config.py
 

=== modified file 'integration-tests/data/assemble/snapcraft.yaml'
--- integration-tests/data/assemble/snapcraft.yaml	2015-09-01 19:04:49 +0000
+++ integration-tests/data/assemble/snapcraft.yaml	2015-09-21 11:41:30 +0000
@@ -5,12 +5,12 @@
 description: a longer description
 icon: icon.png
 binaries:
-  - exec: binary1
-    name: assemble-bin
-  - exec: subdir/binary2
-    name: binary2
+  assemble-bin:
+    exec: binary1
+  binary2:
+    exec: subdir/binary2
 services:
-  - name: assemble-service
+  assemble-service:
     start: service-start
     stop: service-stop with args
 

=== modified file 'schema/snapcraft.yaml'
--- schema/snapcraft.yaml	2015-09-16 19:31:05 +0000
+++ schema/snapcraft.yaml	2015-09-21 11:41:30 +0000
@@ -56,16 +56,14 @@
     type: string
     description: path to a configure hook to expose configuration for the package
   services:
-    type: array
-    items:
-      - type: object
+    type: object
+    additionalProperties: false
+    patternProperties:
+      "^[A-Za-z0-9:-]*$":
+        type: object
         required:
-          - name
           - start
         properties:
-          name:
-            type: string
-            pattern: "^[A-Za-z0-9/.:-]*$"
           start:
             type: string
             description: command executed to start the service
@@ -77,18 +75,17 @@
           security-override:
             $ref: "#definitions/security"
   binaries:
-    type: array
-    items:
-      - type: object
+    type: object
+    additionalProperties: false
+    patternProperties:
+      "^[A-Za-z0-9:-]*$":
+        type: object
         required:
-          - name
+          - exec
         properties:
-          name:
-            type: string
-            pattern: "^[A-Za-z0-9/.:-]*$"
           exec:
             type: string
-            description: command executed to start the service
+            description: command executed to run the binary
           security-policy:
             $ref: "#definitions/security"
           security-override:
@@ -96,6 +93,7 @@
   parts:
     type: object
     minProperties: 1
+    additionalProperties: false
     patternProperties:
       ^[a-z0-9][a-z0-9+-]*$:
         type: object
@@ -116,7 +114,6 @@
         # required:
         # - plugin
         # - source
-    addtionalProperties: false
 required:
   - name
   - version

=== modified file 'snapcraft/meta.py'
--- snapcraft/meta.py	2015-09-16 19:31:05 +0000
+++ snapcraft/meta.py	2015-09-21 11:41:30 +0000
@@ -130,16 +130,26 @@
         package_yaml['architectures'] = arches
 
     if 'binaries' in config_data:
-        package_yaml['binaries'] = _wrap_binaries(config_data['binaries'])
-        package_yaml['binaries'] = _copy_security_profiles(meta_dir, config_data['binaries'])
+        binaries = config_data['binaries']
+        binaries = _wrap_binaries(binaries)
+        package_yaml['binaries'] = _copy_security_profiles(meta_dir, _repack_names(binaries))
 
     if 'services' in config_data:
-        package_yaml['services'] = _wrap_services(config_data['services'])
-        package_yaml['services'] = _copy_security_profiles(meta_dir, config_data['services'])
+        services = config_data['services']
+        services = _wrap_services(services)
+        package_yaml['services'] = _copy_security_profiles(meta_dir, _repack_names(services))
 
     return package_yaml
 
 
+def _repack_names(names):
+    repack = []
+    for name in names:
+        names[name].update({'name': name})
+        repack.append(names[name])
+    return repack
+
+
 def _compose_readme(config_data):
     return '{config[summary]}\n{config[description]}\n'.format(config=config_data)
 
@@ -199,29 +209,25 @@
 
 
 def _wrap_binaries(binaries):
-    for binary in binaries:
-        execparts = shlex.split(binary.get('exec', binary['name']))
+    for name in binaries:
+        execparts = shlex.split(binaries[name]['exec'])
         execwrap = _wrap_exe(execparts[0])
-        if 'exec' in binary:
-            binary['exec'] = _replace_cmd(execparts, execwrap)
-        else:
-            binary['name'] = os.path.basename(binary['name'])
-            binary['exec'] = _replace_cmd(execparts, execwrap)
+        binaries[name]['exec'] = _replace_cmd(execparts, execwrap)
 
     return binaries
 
 
 def _wrap_services(services):
-    for binary in services:
-        startpath = binary.get('start')
+    for name in services:
+        startpath = services[name].get('start')
         if startpath:
             startparts = shlex.split(startpath)
             startwrap = _wrap_exe(startparts[0])
-            binary['start'] = _replace_cmd(startparts, startwrap)
-        stoppath = binary.get('stop')
+            services[name]['start'] = _replace_cmd(startparts, startwrap)
+        stoppath = services[name].get('stop')
         if stoppath:
             stopparts = shlex.split(stoppath)
             stopwrap = _wrap_exe(stopparts[0])
-            binary['stop'] = _replace_cmd(stopparts, stopwrap)
+            services[name]['stop'] = _replace_cmd(stopparts, stopwrap)
 
     return services

=== modified file 'snapcraft/tests/test_meta.py'
--- snapcraft/tests/test_meta.py	2015-09-16 19:31:05 +0000
+++ snapcraft/tests/test_meta.py	2015-09-21 11:41:30 +0000
@@ -69,79 +69,38 @@
         self.assertEqual(y, expected)
 
     def test_with_binaries(self):
-        self.config_data['binaries'] = [
-            {
-                'name': 'binary1',
-                'exec': 'binary1.sh go',
-            },
-            {
-                'name': 'binary2',
-            },
-        ]
+        self.config_data['binaries'] = {
+            'binary1': {'exec': 'binary1.sh go'},
+            'binary2': {'exec': 'binary2.sh'},
+        }
 
         y = meta._compose_package_yaml('meta', self.config_data, ['armhf', 'amd64'])
 
-        expected = {
-            'name': 'my-package',
-            'version': '1.0',
-            'vendor': 'Sergio Schvezov <[e-mail]>',
-            'icon': 'my-icon.png',
-            'architectures': ['armhf', 'amd64'],
-            'binaries': [
-                {
-                    'name': 'binary1',
-                    'exec': 'binary.wrapped go',
-                },
-                {
-                    'name': 'binary2',
-                    'exec': 'binary.wrapped',
-                },
-            ],
-        }
-
-        self.assertEqual(y, expected)
+        self.assertEqual(len(y['binaries']), 2)
+        for b in y['binaries']:
+            if b['name'] is 'binary1':
+                self.assertEqual(b['exec'], 'binary.wrapped go')
+            else:
+                self.assertEqual(b['exec'], 'binary.wrapped')
 
     def test_with_services(self):
-        self.config_data['services'] = [
-            {
-                'name': 'service1',
-                'start': 'binary1',
-            },
-            {
-                'name': 'service2',
+        self.config_data['services'] = {
+            'service1': {'start': 'binary1'},
+            'service2': {
                 'start': 'binary2 --start',
                 'stop': 'binary2 --stop',
             },
-            {
-                'name': 'service3',
-            },
-        ]
+        }
 
         y = meta._compose_package_yaml('meta', self.config_data, ['armhf', 'amd64'])
 
-        expected = {
-            'name': 'my-package',
-            'version': '1.0',
-            'vendor': 'Sergio Schvezov <[e-mail]>',
-            'icon': 'my-icon.png',
-            'architectures': ['armhf', 'amd64'],
-            'services': [
-                {
-                    'name': 'service1',
-                    'start': 'binary.wrapped',
-                },
-                {
-                    'name': 'service2',
-                    'start': 'binary.wrapped --start',
-                    'stop': 'binary.wrapped --stop',
-                },
-                {
-                    'name': 'service3',
-                }
-            ],
-        }
-
-        self.assertEqual(y, expected)
+        self.assertEqual(len(y['services']), 2)
+        for b in y['services']:
+            if b['name'] is 'service1':
+                self.assertEqual(b['start'], 'binary.wrapped')
+            else:
+                self.assertEqual(b['start'], 'binary.wrapped --start')
+                self.assertEqual(b['stop'], 'binary.wrapped --stop')
 
     def test_plain_no_binaries_or_services_with_optionals(self):
         self.config_data['frameworks'] = ['mir', ]
@@ -200,16 +159,15 @@
             'summary': 'my summary',
             'icon': 'my-icon.png',
             'config': 'bin/config',
-            'binaries': [
-                {
-                    'name': 'bash',
+            'binaries': {
+                'bash': {
                     'exec': 'bin/bash',
                     'security-policy': {
                         'apparmor': 'file.apparmor',
                         'seccomp': 'file.seccomp',
                     },
                 }
-            ]
+            }
         }
 
         self.meta_dir = os.path.join(os.path.abspath(os.curdir), 'snap', 'meta')

=== modified file 'snapcraft/tests/test_yaml.py'
--- snapcraft/tests/test_yaml.py	2015-09-15 14:45:57 +0000
+++ snapcraft/tests/test_yaml.py	2015-09-21 11:41:30 +0000
@@ -369,72 +369,61 @@
                 self.assertEqual(raised.exception.message, expected_message, msg=data)
 
     def test_valid_services(self):
-        self.data['services'] = [
-            {
-                'name': 'service1',
-                'start': 'binary1 start',
-            },
-            {
-                'name': 'service2',
+        self.data['services'] = {
+            'service1': {'start': 'binary1 start'},
+            'service2': {
                 'start': 'binary2',
                 'stop': 'binary2 --stop',
             },
-            {
-                'name': 'service3',
-            }
-        ]
+        }
 
         snapcraft.yaml._validate_snapcraft_yaml(self.data)
 
     def test_invalid_binary_names(self):
         invalid_names = {
-            '#': {'name': 'qwe#rty', 'exec': '1'},
-            '_': {'name': 'qwe_rty', 'exec': '1'},
-            'space': {'name': 'qwe rty', 'exec': '1'},
-            'spaces': {'name': 'qwe  rty', 'exec': '1'},
+            'qwe#rty': {'exec': '1'},
+            'qwe_rty': {'exec': '1'},
+            'que rty': {'exec': '1'},
+            'que  rty': {'exec': '1'},
         }
 
         for t in invalid_names:
             data = self.data.copy()
             with self.subTest(key=t):
-                data['binaries'] = [invalid_names[t]]
+                data['binaries'] = {t: invalid_names[t]}
 
                 with self.assertRaises(snapcraft.yaml.SnapcraftSchemaError) as raised:
                     snapcraft.yaml._validate_snapcraft_yaml(data)
 
-                expected_message = '\'{}\' does not match \'^[A-Za-z0-9/.:-]*$\''.format(invalid_names[t]['name'])
+                expected_message = 'Additional properties are not allowed (\'{}\' was unexpected)'.format(t)
                 self.assertEqual(raised.exception.message, expected_message, msg=data)
 
     def test_invalid_service_names(self):
         invalid_names = {
-            '#': {'name': 'qwe#rty', 'start': '1'},
-            '_': {'name': 'qwe_rty', 'start': '1'},
-            'space': {'name': 'qwe rty', 'start': '1'},
-            'spaces': {'name': 'qwe  rty', 'start': '1'},
+            'qwe#rty': {'start': '1'},
+            'qwe_rty': {'start': '1'},
+            'que_rty': {'start': '1'},
+            'quer  ty': {'start': '1'},
         }
 
         for t in invalid_names:
             data = self.data.copy()
             with self.subTest(key=t):
-                data['services'] = [invalid_names[t]]
+                data['services'] = {t: invalid_names[t]}
 
                 with self.assertRaises(snapcraft.yaml.SnapcraftSchemaError) as raised:
                     snapcraft.yaml._validate_snapcraft_yaml(data)
 
-                expected_message = '\'{}\' does not match \'^[A-Za-z0-9/.:-]*$\''.format(invalid_names[t]['name'])
+                expected_message = 'Additional properties are not allowed (\'{}\' was unexpected)'.format(t)
                 self.assertEqual(raised.exception.message, expected_message, msg=data)
 
     def test_services_required_properties(self):
-        self.data['services'] = [
-            {
-                'start': 'binary1 start',
-            }
-        ]
+        self.data['services'] = {'service1': {}}
 
         with self.assertRaises(snapcraft.yaml.SnapcraftSchemaError) as raised:
             snapcraft.yaml._validate_snapcraft_yaml(self.data)
 
-        expected_message = '\'name\' is a required property'
+        expected_message = '\'start\' is a required property'
         self.assertEqual(raised.exception.message, expected_message, msg=self.data)
 
     def test_schema_file_not_found(self):