Merge lp:~stub/charm-helpers/hook-magic into lp:charm-helpers

[Stuart Bishop]

If an explicit hook name is not provided, register the function with both the function name and the function name with underscores replaced with hyphens. This allows the following to work as you would expect:

@hooks.hook()
def upgrade_charm():
    pass

I can only see this magic causing hassles in pathalogical situations (eg. two relations with names only differing by hypen or underscore choice), but is easily worked around by using an explicit hook name.

[James Page (james-page)]

Hi Stuart

Looks good - aside from one minor lint issue:

tests/core/test_hookenv.py:712:9: E301 expected 1 blank line, found 0

However its more work for you to update that and resubmit than me just to fix it on merge.

+1

review: Approve

=== modified file 'charmhelpers/core/hookenv.py'
--- charmhelpers/core/hookenv.py	2013-06-20 08:32:11 +0000
+++ charmhelpers/core/hookenv.py	2013-06-28 17:13:28 +0000
@@ -331,5 +331,8 @@
                 self.register(hook_name, decorated)
             else:
                 self.register(decorated.__name__, decorated)
+                if '_' in decorated.__name__:
+                    self.register(
+                        decorated.__name__.replace('_', '-'), decorated)
             return decorated
         return wrapper

=== modified file 'tests/core/test_hookenv.py'
--- tests/core/test_hookenv.py	2013-06-20 08:53:31 +0000
+++ tests/core/test_hookenv.py	2013-06-28 17:13:28 +0000
@@ -697,3 +697,18 @@
         self.assertRaises(hookenv.UnregisteredHookError, hooks.execute,
                           ['brew'])
         self.assertEqual(execs, [True])
+
+    def test_magic_underscores(self):
+        # Juju hook names use hypens as separators. Python functions use
+        # underscores. If explicit names have not been provided, hooks
+        # are registered with both the function name and the function
+        # name with underscores replaced with hypens for convenience.
+        execs = []
+        hooks = hookenv.Hooks()
+        @hooks.hook()
+        def call_me_maybe():
+            execs.append(True)
+
+        hooks.execute(['call-me-maybe'])
+        hooks.execute(['call_me_maybe'])
+        self.assertEqual(execs, [True, True])