← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_hooks.py

  • Committer: Patch Queue Manager
  • Date: 2016-04-21 05:06:57 UTC
  • mfrom: (6603.4.1 bzr)
  • Revision ID: pqm@pqm.ubuntu.com-20160421050657-ygnzfybewvudf1j9
(richard-wilbur) Use initial_comment as commit_message for lp_propose.(Shawn
 Wang) (Shawn Wang)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_hooks.py
1
 
# Copyright (C) 2007-2010 Canonical Ltd
 
1
# Copyright (C) 2007-2012, 2016 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
19
19
from bzrlib import (
20
20
    branch,
21
21
    errors,
 
22
    hooks as _mod_hooks,
 
23
    pyutils,
22
24
    tests,
23
25
    )
24
26
from bzrlib.hooks import (
25
27
    HookPoint,
26
28
    Hooks,
 
29
    install_lazy_named_hook,
27
30
    known_hooks,
28
31
    known_hooks_key_to_object,
29
 
    known_hooks_key_to_parent_and_attribute,
 
32
    )
 
33
from bzrlib.symbol_versioning import (
 
34
    deprecated_in,
30
35
    )
31
36
 
32
37
 
33
38
class TestHooks(tests.TestCase):
34
39
 
35
 
    def test_create_hook_first(self):
36
 
        hooks = Hooks()
37
 
        doc = ("Invoked after changing the tip of a branch object. Called with"
38
 
            "a bzrlib.branch.PostChangeBranchTipParams object")
39
 
        hook = HookPoint("post_tip_change", doc, (0, 15), None)
40
 
        hooks.create_hook(hook)
41
 
        self.assertEqual(hook, hooks['post_tip_change'])
42
 
 
43
 
    def test_create_hook_name_collision_errors(self):
44
 
        hooks = Hooks()
45
 
        doc = ("Invoked after changing the tip of a branch object. Called with"
46
 
            "a bzrlib.branch.PostChangeBranchTipParams object")
47
 
        hook = HookPoint("post_tip_change", doc, (0, 15), None)
48
 
        hook2 = HookPoint("post_tip_change", None, None, None)
49
 
        hooks.create_hook(hook)
50
 
        self.assertRaises(errors.DuplicateKey, hooks.create_hook, hook2)
51
 
        self.assertEqual(hook, hooks['post_tip_change'])
52
 
 
53
40
    def test_docs(self):
54
41
        """docs() should return something reasonable about the Hooks."""
55
42
        class MyHooks(Hooks):
56
43
            pass
57
 
        hooks = MyHooks()
 
44
        hooks = MyHooks("bzrlib.tests.test_hooks", "some_hooks")
58
45
        hooks['legacy'] = []
59
 
        hook1 = HookPoint('post_tip_change',
 
46
        hooks.add_hook('post_tip_change',
60
47
            "Invoked after the tip of a branch changes. Called with "
61
 
            "a ChangeBranchTipParams object.", (1, 4), None)
62
 
        hook2 = HookPoint('pre_tip_change',
 
48
            "a ChangeBranchTipParams object.", (1, 4))
 
49
        hooks.add_hook('pre_tip_change',
63
50
            "Invoked before the tip of a branch changes. Called with "
64
51
            "a ChangeBranchTipParams object. Hooks should raise "
65
52
            "TipChangeRejected to signal that a tip change is not permitted.",
66
53
            (1, 6), None)
67
 
        hooks.create_hook(hook1)
68
 
        hooks.create_hook(hook2)
69
54
        self.assertEqualDiff(
70
55
            "MyHooks\n"
71
56
            "-------\n"
93
78
            "signal that a tip change is not permitted.\n", hooks.docs())
94
79
 
95
80
    def test_install_named_hook_raises_unknown_hook(self):
96
 
        hooks = Hooks()
 
81
        hooks = Hooks("bzrlib.tests.test_hooks", "some_hooks")
97
82
        self.assertRaises(errors.UnknownHook, hooks.install_named_hook, 'silly',
98
83
                          None, "")
99
84
 
100
85
    def test_install_named_hook_appends_known_hook(self):
101
 
        hooks = Hooks()
 
86
        hooks = Hooks("bzrlib.tests.test_hooks", "some_hooks")
102
87
        hooks['set_rh'] = []
103
88
        hooks.install_named_hook('set_rh', None, "demo")
104
89
        self.assertEqual(hooks['set_rh'], [None])
105
90
 
106
91
    def test_install_named_hook_and_retrieve_name(self):
107
 
        hooks = Hooks()
 
92
        hooks = Hooks("bzrlib.tests.test_hooks", "somehooks")
108
93
        hooks['set_rh'] = []
109
94
        hooks.install_named_hook('set_rh', None, "demo")
110
95
        self.assertEqual("demo", hooks.get_hook_name(None))
111
96
 
 
97
    def test_uninstall_named_hook(self):
 
98
        hooks = Hooks("bzrlib.tests.test_hooks", "some_hooks")
 
99
        hooks.add_hook('set_rh', "Set revision history", (2, 0))
 
100
        hooks.install_named_hook('set_rh', None, "demo")
 
101
        self.assertEqual(1, len(hooks["set_rh"]))
 
102
        hooks.uninstall_named_hook("set_rh", "demo")
 
103
        self.assertEqual(0, len(hooks["set_rh"]))
 
104
 
 
105
    def test_uninstall_multiple_named_hooks(self):
 
106
        # Multiple callbacks with the same label all get removed
 
107
        hooks = Hooks("bzrlib.tests.test_hooks", "some_hooks")
 
108
        hooks.add_hook('set_rh', "Set revision history", (2, 0))
 
109
        hooks.install_named_hook('set_rh', 1, "demo")
 
110
        hooks.install_named_hook('set_rh', 2, "demo")
 
111
        hooks.install_named_hook('set_rh', 3, "othername")
 
112
        self.assertEqual(3, len(hooks["set_rh"]))
 
113
        hooks.uninstall_named_hook("set_rh", "demo")
 
114
        self.assertEqual(1, len(hooks["set_rh"]))
 
115
 
 
116
    def test_uninstall_named_hook_unknown_callable(self):
 
117
        hooks = Hooks("bzrlib.tests.test_hooks", "some_hooks")
 
118
        hooks.add_hook('set_rh', "Set revision hsitory", (2, 0))
 
119
        self.assertRaises(KeyError, hooks.uninstall_named_hook, "set_rh",
 
120
            "demo")
 
121
 
 
122
    def test_uninstall_named_hook_raises_unknown_hook(self):
 
123
        hooks = Hooks("bzrlib.tests.test_hooks", "some_hooks")
 
124
        self.assertRaises(errors.UnknownHook, hooks.uninstall_named_hook,
 
125
            'silly', "")
 
126
 
 
127
    def test_uninstall_named_hook_old_style(self):
 
128
        hooks = Hooks("bzrlib.tests.test_hooks", "some_hooks")
 
129
        hooks["set_rh"] = []
 
130
        hooks.install_named_hook('set_rh', None, "demo")
 
131
        self.assertRaises(errors.UnsupportedOperation,
 
132
            hooks.uninstall_named_hook, "set_rh", "demo")
 
133
 
 
134
    hooks = Hooks("bzrlib.tests.test_hooks", "TestHooks.hooks")
 
135
 
 
136
    def test_install_lazy_named_hook(self):
 
137
        # When the hook points are not yet registered the hook is
 
138
        # added to the _lazy_hooks dictionary in bzrlib.hooks.
 
139
        self.hooks.add_hook('set_rh', "doc", (0, 15))
 
140
        set_rh = lambda: None
 
141
        install_lazy_named_hook('bzrlib.tests.test_hooks',
 
142
            'TestHooks.hooks', 'set_rh', set_rh, "demo")
 
143
        set_rh_lazy_hooks = _mod_hooks._lazy_hooks[
 
144
            ('bzrlib.tests.test_hooks', 'TestHooks.hooks', 'set_rh')]
 
145
        self.assertEqual(1, len(set_rh_lazy_hooks))
 
146
        self.assertEqual(set_rh, set_rh_lazy_hooks[0][0].get_obj())
 
147
        self.assertEqual("demo", set_rh_lazy_hooks[0][1])
 
148
        self.assertEqual(list(TestHooks.hooks['set_rh']), [set_rh])
 
149
 
 
150
    set_rh = lambda: None
 
151
 
 
152
    def test_install_named_hook_lazy(self):
 
153
        hooks = Hooks("bzrlib.tests.hooks", "some_hooks")
 
154
        hooks['set_rh'] = HookPoint("set_rh", "doc", (0, 15), None)
 
155
        hooks.install_named_hook_lazy('set_rh', 'bzrlib.tests.test_hooks',
 
156
            'TestHooks.set_rh', "demo")
 
157
        self.assertEqual(list(hooks['set_rh']), [TestHooks.set_rh])
 
158
 
 
159
    def test_install_named_hook_lazy_old(self):
 
160
        # An exception is raised if a lazy hook is raised for
 
161
        # an old style hook point.
 
162
        hooks = Hooks("bzrlib.tests.hooks", "some_hooks")
 
163
        hooks['set_rh'] = []
 
164
        self.assertRaises(errors.UnsupportedOperation,
 
165
            hooks.install_named_hook_lazy,
 
166
            'set_rh', 'bzrlib.tests.test_hooks', 'TestHooks.set_rh',
 
167
            "demo")
 
168
 
 
169
    def test_valid_lazy_hooks(self):
 
170
        # Make sure that all the registered lazy hooks are referring to existing
 
171
        # hook points which allow lazy registration.
 
172
        for key, callbacks in _mod_hooks._lazy_hooks.iteritems():
 
173
            (module_name, member_name, hook_name) = key
 
174
            obj = pyutils.get_named_object(module_name, member_name)
 
175
            self.assertEqual(obj._module, module_name)
 
176
            self.assertEqual(obj._member_name, member_name)
 
177
            self.assertTrue(hook_name in obj)
 
178
            self.assertIs(callbacks, obj[hook_name]._callbacks)
 
179
 
112
180
 
113
181
class TestHook(tests.TestCase):
114
182
 
141
209
        hook.hook(callback, "my callback")
142
210
        self.assertEqual([callback], list(hook))
143
211
 
 
212
    def lazy_callback():
 
213
        pass
 
214
 
 
215
    def test_lazy_hook(self):
 
216
        hook = HookPoint("foo", "no docs", None, None)
 
217
        hook.hook_lazy(
 
218
            "bzrlib.tests.test_hooks", "TestHook.lazy_callback",
 
219
            "my callback")
 
220
        self.assertEqual([TestHook.lazy_callback], list(hook))
 
221
 
 
222
    def test_uninstall(self):
 
223
        hook = HookPoint("foo", "no docs", None, None)
 
224
        hook.hook_lazy(
 
225
            "bzrlib.tests.test_hooks", "TestHook.lazy_callback",
 
226
            "my callback")
 
227
        self.assertEqual([TestHook.lazy_callback], list(hook))
 
228
        hook.uninstall("my callback")
 
229
        self.assertEqual([], list(hook))
 
230
 
 
231
    def test_uninstall_unknown(self):
 
232
        hook = HookPoint("foo", "no docs", None, None)
 
233
        self.assertRaises(KeyError, hook.uninstall, "my callback")
 
234
 
144
235
    def test___repr(self):
145
236
        # The repr should list all the callbacks, with names.
146
237
        hook = HookPoint("foo", "no docs", None, None)
177
268
 
178
269
    def test_known_hooks_key_to_parent_and_attribute(self):
179
270
        self.assertEqual((branch.Branch, 'hooks'),
180
 
            known_hooks_key_to_parent_and_attribute(
 
271
            known_hooks.key_to_parent_and_attribute(
181
272
            ('bzrlib.branch', 'Branch.hooks')))
182
273
        self.assertEqual((branch, 'Branch'),
183
 
            known_hooks_key_to_parent_and_attribute(
 
274
            known_hooks.key_to_parent_and_attribute(
184
275
            ('bzrlib.branch', 'Branch')))