Merge lp:~tvansteenburgh/charm-tools/no-symlinks into lp:charm-tools/1.3

[Tim Van Steenburgh]

Removes option to created symlinked hooks when creating a new charm, since symlinks don't work on Windows.

Run all tests with `make check`. Test manually with:

. bin/activate
charm create foo /tmp

[Marco Ceppi (marcoceppi)]

review: Needs Fixing

[Marco Ceppi (marcoceppi)]

review: Abstain

[Marco Ceppi (marcoceppi)]

LGTM

review: Approve

Unmerged revisions

339. By Tim Van Steenburgh on 2014-09-04

Remove option to symlink hooks when creating charm

338. By Tim Van Steenburgh on 2014-08-28

Fix charm-proof email validation

formataddr() will put quotes around a name component that
contains special chars. We need to remove those to accurately
compare against the original maintainer string.

Also fixes tests that were broken due to new files in
charmhelpers.core

=== modified file 'charmtools/charms.py'
--- charmtools/charms.py	2014-06-17 15:44:04 +0000
+++ charmtools/charms.py	2014-09-04 17:14:02 +0000
@@ -453,7 +453,7 @@
     for maintainer in maintainers:
         (name, address) = email.utils.parseaddr(maintainer)
         formatted = email.utils.formataddr((name, address))
-        if formatted != maintainer:
+        if formatted.replace('"', '') != maintainer:
             linter.warn(
                 'Maintainer format should be "Name <Email>", '
                 'not "%s"' % formatted)

=== modified file 'charmtools/generators/template.py'
--- charmtools/generators/template.py	2014-07-29 18:15:41 +0000
+++ charmtools/generators/template.py	2014-09-04 17:14:02 +0000
@@ -46,6 +46,14 @@
         """Return default configuration for this template, loaded from a
         config.yaml file.
 
+        This is a sample config.yaml that configures one user prompt::
+
+            prompts:
+              symlink:
+                prompt: Symlink all hooks to one python source file? [yN]
+                default: n
+                type: boolean
+
         """
         path = self.config_path()
         if os.path.exists(path):

=== removed file 'charmtools/templates/python/config.yaml'
--- charmtools/templates/python/config.yaml	2014-05-27 21:23:41 +0000
+++ charmtools/templates/python/config.yaml	1970-01-01 00:00:00 +0000
@@ -1,5 +0,0 @@
-prompts:
-  symlink:
-    prompt: Symlink all hooks to one python source file? [yN]
-    default: n
-    type: boolean

=== removed directory 'charmtools/templates/python/files/hooks_symlinked'
=== removed file 'charmtools/templates/python/files/hooks_symlinked/hooks.py'
--- charmtools/templates/python/files/hooks_symlinked/hooks.py	2014-05-27 21:23:41 +0000
+++ charmtools/templates/python/files/hooks_symlinked/hooks.py	1970-01-01 00:00:00 +0000
@@ -1,54 +0,0 @@
-#!/usr/bin/python
-
-import os
-import sys
-
-sys.path.insert(0, os.path.join(os.environ['CHARM_DIR'], 'lib'))
-
-from charmhelpers.core import (
-    hookenv,
-    host,
-)
-
-hooks = hookenv.Hooks()
-log = hookenv.log
-
-SERVICE = '$metadata.package'
-
-
[e-mail]('install')
-def install():
-    log('Installing $metadata.package')
-
-
[e-mail]('config-changed')
-def config_changed():
-    config = hookenv.config()
-
-    for key in config:
-        if config.changed(key):
-            log("config['{}'] changed from {} to {}".format(
-                key, config.previous(key), config[key]))
-
-    config.save()
-    start()
-
-
[e-mail]('upgrade-charm')
-def upgrade_charm():
-    log('Upgrading $metadata.package')
-
-
[e-mail]('start')
-def start():
-    host.service_restart(SERVICE) or host.service_start(SERVICE)
-
-
[e-mail]('stop')
-def stop():
-    host.service_stop(SERVICE)
-
-
-if __name__ == "__main__":
-    # execute a hook based on the name the program is called by
-    hooks.execute(sys.argv)

=== modified file 'charmtools/templates/python/template.py'
--- charmtools/templates/python/template.py	2014-07-29 18:15:41 +0000
+++ charmtools/templates/python/template.py	2014-09-04 17:14:02 +0000
@@ -46,7 +46,6 @@
 
                 self._template_file(config, path.join(root, outfile))
 
-        self._cleanup_hooks(config, output_dir)
         self._install_charmhelpers(output_dir)
 
     def _copy_files(self, output_dir):
@@ -72,21 +71,6 @@
         os.rename(o.name, outfile)
         os.unlink(backupname)
 
-    def _cleanup_hooks(self, config, output_dir):
-        rmdir = 'hooks' if config['symlink'] else 'hooks_symlinked'
-        shutil.rmtree(os.path.join(output_dir, rmdir))
-
-        if config['symlink']:
-            os.rename(
-                os.path.join(output_dir, 'hooks_symlinked'),
-                os.path.join(output_dir, 'hooks')
-            )
-            # Symlinks must be relative so that they are copied properly
-            # when output_dir is moved to it's final location.
-            for link in ['config-changed', 'install', 'start', 'stop',
-                         'upgrade-charm']:
-                os.symlink('hooks.py', os.path.join(output_dir, 'hooks', link))
-
     def _install_charmhelpers(self, output_dir):
         helpers_dest = os.path.join(output_dir, 'lib', 'charmhelpers')
         if not os.path.exists(helpers_dest):

=== modified file 'tests/test_charm_proof.py'
--- tests/test_charm_proof.py	2014-06-17 15:44:04 +0000
+++ tests/test_charm_proof.py	2014-09-04 17:14:02 +0000
@@ -420,7 +420,10 @@
         """Maintainers field happy path."""
         linter = Mock()
         charm = {
-            'maintainers': ['Tester <[e-mail]>'],
+            'maintainers': [
+                'Tester <[e-mail]>',
+                'Tester Joe H. <[e-mail]>',
+            ]
         }
         validate_maintainer(charm, linter)
         self.assertFalse(linter.err.called)

=== modified file 'tests_functional/create/test_python_create.py'
--- tests_functional/create/test_python_create.py	2014-06-20 19:46:59 +0000
+++ tests_functional/create/test_python_create.py	2014-09-04 17:14:02 +0000
@@ -45,46 +45,22 @@
     def tearDown(self):
         shutil.rmtree(self.tempdir)
 
-    def _expected_files(self, symlinked=False):
+    def _expected_files(self):
         static_files = list(flatten(pkg_resources.resource_filename(
             'charmtools', 'templates/python/files')))
-        static_files = [f for f in static_files
-                        if not f.startswith('hooks_symlinked/')]
-        if symlinked:
-            static_files.append('hooks/hooks.py')
         dynamic_files = [
             'lib/charmhelpers/__init__.py',
             'lib/charmhelpers/core/__init__.py',
             'lib/charmhelpers/core/fstab.py',
             'lib/charmhelpers/core/hookenv.py',
             'lib/charmhelpers/core/host.py',
+            'lib/charmhelpers/core/services/__init__.py',
+            'lib/charmhelpers/core/services/base.py',
+            'lib/charmhelpers/core/services/helpers.py',
+            'lib/charmhelpers/core/templating.py',
         ]
         return sorted(static_files + dynamic_files)
 
-    @patch('__builtin__.raw_input')
-    @patch('charmtools.create.setup_parser')
-    def test_interactive(self, setup_parser, raw_input_):
-        """Functional test of a full 'charm create' run."""
-        class args(object):
-            charmname = 'testcharm'
-            charmhome = self.tempdir
-            template = 'python'
-            accept_defaults = False
-            verbose = False
-
-        setup_parser.return_value.parse_args.return_value = args
-        raw_input_.side_effect = ['Y']
-
-        main()
-
-        outputdir = join(self.tempdir, args.charmname)
-        actual_files = sorted(flatten(outputdir))
-        expected_files = self._expected_files(symlinked=True)
-        metadata = yaml.load(open(join(outputdir, 'metadata.yaml'), 'r'))
-
-        self.assertEqual(expected_files, actual_files)
-        self.assertEqual(metadata['name'], args.charmname)
-
     @patch('charmtools.create.setup_parser')
     def test_defaults(self, setup_parser):
         """Functional test of a full 'charm create' run."""