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

[Sergio Schvezov]

Support config

This branch ends up being more complicated than necessary because I chose the config hook to be python based and setuptools rewrites the shebang. (We probably need to do the reverse in our plugin).

[lp:~sergiusens/snapcraft/config]

158. By Björn Tillenius on 2015-09-14

Add support for setuptools based python projects. by bjornt approved by sergiusens,ted

159. By Sergio Schvezov on 2015-09-14

Filesets based filtering for stage and snap by sergiusens approved by sergiusens,mvo

160. By Sergio Schvezov on 2015-09-14

snapcraft init with templated values by sergiusens approved by mvo

161. By Sergio Schvezov on 2015-09-14

regex for binary and service names by sergiusens approved by mvo

[Sergio Schvezov (sergiusens)]

hmm, my config.py is missing :/

[lp:~sergiusens/snapcraft/config]

162. By Sergio Schvezov on 2015-09-14

docs refresh by sergiusens approved by chipaca

163. By Sergio Schvezov on 2015-09-14

Collision logic updates with an introduction of _BUILTIN_OPTIONS so all parts have a certain set of options by default even if not declared. by sergiusens approved by mvo

164. By Daniel Holbach on 2015-09-15

fix crash when stage_packages is defined in the yaml for the plugin, but empty (getattr does not use [] as default return value in that case) by dholbach approved by sergiusens

165. By Daniel Holbach on 2015-09-15

Fix small typo. by dholbach approved by sergiusens

[John Lenton (chipaca)]

LGTM. Minor nit.

review: Approve

[Sergio Schvezov (sergiusens)]

I fixed the nit

review: Approve

[lp:~sergiusens/snapcraft/config]

166. By Sergio Schvezov on 2015-09-15

Support config by sergiusens approved by sergiusens,chipaca

=== added file 'examples/webcam-webui/config.py'
--- examples/webcam-webui/config.py	1970-01-01 00:00:00 +0000
+++ examples/webcam-webui/config.py	2015-09-15 20:53:59 +0000
@@ -0,0 +1,57 @@
+#!/usr/bin/env python3
+
+import os
+import os.path
+import sys
+import yaml
+
+_CONFIG = 'configuration'
+
+_DEFAULT_INTERVAL = 10
+
+
+def main():
+    config_file = os.path.join(os.environ['SNAP_APP_DATA_PATH'], _CONFIG)
+
+    config_yaml = yaml.load(sys.stdin)
+    if config_yaml:
+        set_config(config_file, config_yaml)
+
+    yaml.dump(get_config(config_file), stream=sys.stdout, default_flow_style=False)
+
+
+def set_config(config_file, config_yaml={}):
+    with open(config_file, 'w') as f:
+        yaml.dump(_config(config_yaml), stream=f, default_flow_style=False)
+
+    return config_yaml
+
+
+def get_config(config_file):
+    try:
+        with open(config_file) as f:
+            return yaml.load(f)
+    except FileNotFoundError:
+        return _config()
+
+
+def _config(config_yaml={}):
+    try:
+        interval_value = config_yaml['config'][os.environ['SNAP_NAME']]['interval']
+        if not isinstance(interval_value, int):
+            config_yaml['config'][os.environ['SNAP_NAME']]['interval'] = _DEFAULT_INTERVAL
+    except KeyError:
+        interval = {
+            'config': {
+                os.environ['SNAP_NAME']: {
+                    'interval': _DEFAULT_INTERVAL
+                }
+            }
+        }
+        config_yaml.update(interval)
+
+    return config_yaml
+
+
+if __name__ == '__main__':
+    main()

=== added file 'examples/webcam-webui/setup.py'
--- examples/webcam-webui/setup.py	1970-01-01 00:00:00 +0000
+++ examples/webcam-webui/setup.py	2015-09-15 20:53:59 +0000
@@ -0,0 +1,16 @@
+#!/usr/bin/env python3
+
+from setuptools import setup
+
+setup(
+    name='config',
+    description='config for webcam-webui',
+    author='Sergio Schvezov <[e-mail]>',
+    license='GPLv3',
+    install_requires=[
+        'pyyaml',
+    ],
+    scripts=[
+        'config.py',
+    ],
+)

=== modified file 'examples/webcam-webui/snapcraft.yaml'
--- examples/webcam-webui/snapcraft.yaml	2015-09-11 14:20:10 +0000
+++ examples/webcam-webui/snapcraft.yaml	2015-09-15 20:53:59 +0000
@@ -7,6 +7,7 @@
 services:
   - name: webcam-webui
     start: bin/webcam-webui
+config: python3 usr/bin/config.py
 
 parts:
   cam:
@@ -21,11 +22,20 @@
         - usr/lib
       go-server:
         - bin/golang-*
+      ignore:
+        - -lib/x86_64-linux-gnu/libexpat*
+        - -usr/lib/x86_64-linux-gnu/libexpat*
+        - -usr/share/doc
+    stage:
+      - $ignore
     snap:
+      - $ignore
       - $fswebcam
       - $go-server
   glue:
     type: copy
     files:
       webcam-webui: bin/webcam-webui
-
+  config:
+    type: python3-project
+    source: .

=== modified file 'examples/webcam-webui/webcam-webui'
--- examples/webcam-webui/webcam-webui	2015-09-11 14:20:10 +0000
+++ examples/webcam-webui/webcam-webui	2015-09-15 20:53:59 +0000
@@ -3,9 +3,15 @@
 
 cd "$SNAP_APP_DATA_PATH"
 
+[ -f configuration ] && interval=$(sed -n 's/.*interval: `\([0-9.]\+\).*/\1/p' configuration)
+
+[ -z "$interval" ] && interval=10
+
+echo "Snapping every $interval seconds"
+
 golang-static-http &
 
 while :; do
     fswebcam shot.jpeg
-    sleep 10
+    sleep $interval
 done

=== modified file 'integration-tests/data/assemble/binary1.after'
--- integration-tests/data/assemble/binary1.after	2015-08-05 15:39:18 +0000
+++ integration-tests/data/assemble/binary1.after	2015-09-15 20:53:59 +0000
@@ -1,4 +1,5 @@
 #!/bin/sh
 export PATH="$SNAP_APP_PATH/bin:$SNAP_APP_PATH/usr/bin:$PATH"
 export LD_LIBRARY_PATH="$SNAP_APP_PATH/lib:$SNAP_APP_PATH/usr/lib:$SNAP_APP_PATH/lib/@MULTIARCH@:$SNAP_APP_PATH/usr/lib/@MULTIARCH@:$LD_LIBRARY_PATH"
+
 exec "$SNAP_APP_PATH/binary1" $*

=== modified file 'schema/snapcraft.yaml'
--- schema/snapcraft.yaml	2015-09-14 19:22:59 +0000
+++ schema/snapcraft.yaml	2015-09-15 20:53:59 +0000
@@ -38,6 +38,9 @@
     uniqueItems: true
     items:
       - type: string
+  config:
+    type: string
+    description: path to a configure hook to expose configuration for the package
   services:
     type: array
     items:

=== modified file 'snapcraft/meta.py'
--- snapcraft/meta.py	2015-08-27 21:33:56 +0000
+++ snapcraft/meta.py	2015-09-15 20:53:59 +0000
@@ -57,6 +57,9 @@
     _write_package_yaml(meta_dir, config_data, arches)
     _write_readme_md(meta_dir, config_data)
 
+    if 'config' in config_data:
+        _setup_config_hook(meta_dir, config_data['config'])
+
     return meta_dir
 
 
@@ -76,6 +79,18 @@
         f.write(readme_md)
 
 
+def _setup_config_hook(meta_dir, config):
+    hooks_dir = os.path.join(meta_dir, 'hooks')
+
+    os.makedirs(hooks_dir)
+
+    execparts = shlex.split(config)
+    args = execparts[1:] if len(execparts) > 1 else []
+
+    config_hook_path = os.path.join(hooks_dir, 'config')
+    _write_wrap_exe(execparts[0], config_hook_path, args=args, cwd='$SNAP_APP_PATH')
+
+
 def _copy_icon(meta_dir, icon_path):
     new_icon_path = os.path.join(meta_dir, os.path.basename(icon_path))
     shutil.copyfile(icon_path, new_icon_path)
@@ -122,6 +137,23 @@
         return ' '.join([shlex.quote(x) for x in newparts])
 
 
+def _write_wrap_exe(wrapexec, wrappath, args=[], cwd=None):
+    args = ' '.join(args) + ' $*' if args else '$*'
+    cwd = 'cd {}'.format(cwd) if cwd else ''
+
+    snap_dir = common.get_snapdir()
+    assembled_env = common.assemble_env().replace(snap_dir, '$SNAP_APP_PATH')
+    script = ('#!/bin/sh\n' +
+              '{}\n'.format(assembled_env) +
+              '{}\n'.format(cwd) +
+              'exec "{}" {}\n'.format(wrapexec, args))
+
+    with open(wrappath, 'w+') as f:
+        f.write(script)
+
+    os.chmod(wrappath, 0o755)
+
+
 def _wrap_exe(relexepath):
     snap_dir = common.get_snapdir()
     exepath = os.path.join(snap_dir, relexepath)
@@ -149,15 +181,7 @@
             else:
                 logger.warning('Warning: unable to find "{}" in the path'.format(relexepath))
 
-    assembled_env = common.assemble_env().replace(snap_dir, '$SNAP_APP_PATH')
-    script = ('#!/bin/sh\n' +
-              '{}\n'.format(assembled_env) +
-              'exec "{}" $*\n'.format(wrapexec))
-
-    with open(wrappath, 'w+') as f:
-        f.write(script)
-
-    os.chmod(wrappath, 0o755)
+    _write_wrap_exe(wrapexec, wrappath)
 
     return os.path.relpath(wrappath, snap_dir)
 

=== modified file 'snapcraft/sources.py'
--- snapcraft/sources.py	2015-09-01 10:09:30 +0000
+++ snapcraft/sources.py	2015-09-15 20:53:59 +0000
@@ -177,7 +177,9 @@
 
     def provision(self, dst):
         path = os.path.abspath(self.source)
-        if os.path.isdir(dst):
+        if os.path.islink(dst):
+            os.remove(dst)
+        elif os.path.isdir(dst):
             os.rmdir(dst)
         else:
             os.remove(dst)

=== modified file 'snapcraft/tests/test_meta.py'
--- snapcraft/tests/test_meta.py	2015-08-27 21:33:56 +0000
+++ snapcraft/tests/test_meta.py	2015-09-15 20:53:59 +0000
@@ -17,7 +17,6 @@
 import os
 from unittest.mock import (
     call,
-    mock_open,
     patch,
 )
 
@@ -45,7 +44,6 @@
         }
 
     def test_plain_no_binaries_or_services(self):
-
         y = meta._compose_package_yaml(self.config_data, ['armhf', 'amd64'])
 
         expected = {
@@ -59,7 +57,6 @@
         self.assertEqual(y, expected)
 
     def test_plain_no_binaries_or_services_or_arches(self):
-
         y = meta._compose_package_yaml(self.config_data, None)
 
         expected = {
@@ -186,6 +183,15 @@
         self.mock_copyfile = patcher_copyfile.start()
         self.addCleanup(patcher_copyfile.stop)
 
+        patcher_move = patch('shutil.move')
+        self.mock_move = patcher_move.start()
+        self.addCleanup(patcher_move.stop)
+
+        patcher_exists = patch('os.path.exists')
+        self.mock_exists = patcher_exists.start()
+        self.mock_exists.return_value = True
+        self.addCleanup(patcher_exists.stop)
+
         self.config_data = {
             'name': 'my-package',
             'version': '1.0',
@@ -193,62 +199,103 @@
             'description': 'my description',
             'summary': 'my summary',
             'icon': 'my-icon.png',
+            'config': 'bin/config'
         }
 
-    def test_create_meta(self):
-        mock_the_open = mock_open()
-
-        with patch('snapcraft.meta.open', mock_the_open, create=True):
-            meta.create(self.config_data, ['amd64'])
-
-        meta_dir = os.path.join(os.path.abspath(os.curdir), 'snap', 'meta')
-
-        self.mock_makedirs.assert_called_once_with(meta_dir, exist_ok=True)
-
-        mock_the_open.assert_has_calls([
-            call(os.path.join(meta_dir, 'package.yaml'), 'w'),
+        self.meta_dir = os.path.join(os.path.abspath(os.curdir), 'snap', 'meta')
+
+        self.expected_open_calls = [
+            call(os.path.join(self.meta_dir, 'package.yaml'), 'w'),
             call().__enter__(),
-            call().write('architectures'),
-            call().write(':'),
-            call().write('\n'),
-            call().write('-'),
-            call().write(' '),
-            call().write('amd64'),
-            call().write('\n'),
-            call().write('icon'),
-            call().write(':'),
-            call().write(' '),
-            call().write('meta/my-icon.png'),
-            call().write('\n'),
-            call().write('name'),
-            call().write(':'),
-            call().write(' '),
-            call().write('my-package'),
-            call().write('\n'),
-            call().write('vendor'),
-            call().write(':'),
-            call().write(' '),
-            call().write('Sergio'),
-            call().write(' '),
-            call().write('Schvezov'),
-            call().write(' '),
-            call().write('<[e-mail]>'),
-            call().write('\n'),
-            call().write('version'),
-            call().write(':'),
-            call().write(" '"),
-            call().write('1.0'),
-            call().write("'"),
-            call().write('\n'),
-            call().flush(),
-            call().flush(),
+            call().__enter__().write('architectures'),
+            call().__enter__().write(':'),
+            call().__enter__().write('\n'),
+            call().__enter__().write('-'),
+            call().__enter__().write(' '),
+            call().__enter__().write('amd64'),
+            call().__enter__().write('\n'),
+            call().__enter__().write('icon'),
+            call().__enter__().write(':'),
+            call().__enter__().write(' '),
+            call().__enter__().write('meta/my-icon.png'),
+            call().__enter__().write('\n'),
+            call().__enter__().write('name'),
+            call().__enter__().write(':'),
+            call().__enter__().write(' '),
+            call().__enter__().write('my-package'),
+            call().__enter__().write('\n'),
+            call().__enter__().write('vendor'),
+            call().__enter__().write(':'),
+            call().__enter__().write(' '),
+            call().__enter__().write('Sergio'),
+            call().__enter__().write(' '),
+            call().__enter__().write('Schvezov'),
+            call().__enter__().write(' '),
+            call().__enter__().write('<[e-mail]>'),
+            call().__enter__().write('\n'),
+            call().__enter__().write('version'),
+            call().__enter__().write(':'),
+            call().__enter__().write(" '"),
+            call().__enter__().write('1.0'),
+            call().__enter__().write("'"),
+            call().__enter__().write('\n'),
+            call().__enter__().flush(),
+            call().__enter__().flush(),
             call().__exit__(None, None, None),
-            call(os.path.join(meta_dir, 'readme.md'), 'w'),
+            call(os.path.join(self.meta_dir, 'readme.md'), 'w'),
             call().__enter__(),
-            call().write('my summary\nmy description\n'),
+            call().__enter__().write('my summary\nmy description\n'),
             call().__exit__(None, None, None),
         ]
-        )
+
+        self.hooks_dir = os.path.join(self.meta_dir, 'hooks')
+
+    @patch('snapcraft.meta._write_wrap_exe')
+    @patch('snapcraft.meta.open', create=True)
+    def test_create_meta(self, mock_the_open, mock_wrap_exe):
+        meta.create(self.config_data, ['amd64'])
+
+        self.mock_makedirs.assert_has_calls([
+            call(self.meta_dir, exist_ok=True),
+            call(self.hooks_dir),
+        ])
+
+        mock_the_open.assert_has_calls(self.expected_open_calls)
+        mock_wrap_exe.assert_called_once_with(
+            'bin/config',
+            os.path.join(os.path.abspath(os.curdir), 'snap', 'meta', 'hooks', 'config'),
+            args=[],
+            cwd='$SNAP_APP_PATH',
+        )
+
+    @patch('snapcraft.meta._write_wrap_exe')
+    @patch('snapcraft.meta.open', create=True)
+    def test_create_meta_with_vararg_config(self, mock_the_open, mock_wrap_exe):
+        self.config_data['config'] = 'python3 my.py --config'
+
+        meta.create(self.config_data, ['amd64'])
+
+        self.mock_makedirs.assert_has_calls([
+            call(self.meta_dir, exist_ok=True),
+            call(self.hooks_dir),
+        ])
+
+        mock_the_open.assert_has_calls(self.expected_open_calls)
+        mock_wrap_exe.assert_called_once_with(
+            'python3',
+            os.path.join(os.path.abspath(os.curdir), 'snap', 'meta', 'hooks', 'config'),
+            args=['my.py', '--config'],
+            cwd='$SNAP_APP_PATH',
+        )
+
+    @patch('snapcraft.meta.open', create=True)
+    def test_create_meta_without_config(self, mock_the_open):
+        del self.config_data['config']
+
+        meta.create(self.config_data, ['amd64'])
+
+        self.mock_makedirs.assert_called_once_with(self.meta_dir, exist_ok=True)
+        mock_the_open.assert_has_calls(self.expected_open_calls)
 
 
 # TODO this needs more tests.
@@ -262,7 +309,7 @@
         wrapper_path = os.path.join(snapdir, relative_wrapper_path)
 
         expected = ('#!/bin/sh\n'
-                    '\n'
+                    '\n\n'
                     'exec "$SNAP_APP_PATH/test_relexepath" $*\n')
         with open(wrapper_path) as wrapper_file:
             wrapper_contents = wrapper_file.read()