/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/tests/test_hooks.py

  • Committer: Martin
  • Date: 2017-06-10 01:57:00 UTC
  • mto: This revision was merged to the branch mainline in revision 6679.
  • Revision ID: gzlist@googlemail.com-20170610015700-o3xeuyaqry2obiay
Go back to native str for urls and many other py3 changes

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/tests/test_hooks.py
 
1
# Copyright (C) 2007-2012, 2016 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""Tests for the core Hooks logic."""
 
18
 
 
19
from .. import (
 
20
    branch,
 
21
    errors,
 
22
    hooks as _mod_hooks,
 
23
    pyutils,
 
24
    tests,
 
25
    )
 
26
from ..hooks import (
 
27
    HookPoint,
 
28
    Hooks,
 
29
    install_lazy_named_hook,
 
30
    known_hooks,
 
31
    known_hooks_key_to_object,
 
32
    )
 
33
 
 
34
 
 
35
class TestHooks(tests.TestCase):
 
36
 
 
37
    def test_docs(self):
 
38
        """docs() should return something reasonable about the Hooks."""
 
39
        class MyHooks(Hooks):
 
40
            pass
 
41
        hooks = MyHooks("breezy.tests.test_hooks", "some_hooks")
 
42
        hooks['legacy'] = []
 
43
        hooks.add_hook('post_tip_change',
 
44
            "Invoked after the tip of a branch changes. Called with "
 
45
            "a ChangeBranchTipParams object.", (1, 4))
 
46
        hooks.add_hook('pre_tip_change',
 
47
            "Invoked before the tip of a branch changes. Called with "
 
48
            "a ChangeBranchTipParams object. Hooks should raise "
 
49
            "TipChangeRejected to signal that a tip change is not permitted.",
 
50
            (1, 6), None)
 
51
        self.assertEqualDiff(
 
52
            "MyHooks\n"
 
53
            "-------\n"
 
54
            "\n"
 
55
            "legacy\n"
 
56
            "~~~~~~\n"
 
57
            "\n"
 
58
            "An old-style hook. For documentation see the __init__ method of 'MyHooks'\n"
 
59
            "\n"
 
60
            "post_tip_change\n"
 
61
            "~~~~~~~~~~~~~~~\n"
 
62
            "\n"
 
63
            "Introduced in: 1.4\n"
 
64
            "\n"
 
65
            "Invoked after the tip of a branch changes. Called with a\n"
 
66
            "ChangeBranchTipParams object.\n"
 
67
            "\n"
 
68
            "pre_tip_change\n"
 
69
            "~~~~~~~~~~~~~~\n"
 
70
            "\n"
 
71
            "Introduced in: 1.6\n"
 
72
            "\n"
 
73
            "Invoked before the tip of a branch changes. Called with a\n"
 
74
            "ChangeBranchTipParams object. Hooks should raise TipChangeRejected to\n"
 
75
            "signal that a tip change is not permitted.\n", hooks.docs())
 
76
 
 
77
    def test_install_named_hook_raises_unknown_hook(self):
 
78
        hooks = Hooks("breezy.tests.test_hooks", "some_hooks")
 
79
        self.assertRaises(errors.UnknownHook, hooks.install_named_hook, 'silly',
 
80
                          None, "")
 
81
 
 
82
    def test_install_named_hook_appends_known_hook(self):
 
83
        hooks = Hooks("breezy.tests.test_hooks", "some_hooks")
 
84
        hooks['set_rh'] = []
 
85
        hooks.install_named_hook('set_rh', None, "demo")
 
86
        self.assertEqual(hooks['set_rh'], [None])
 
87
 
 
88
    def test_install_named_hook_and_retrieve_name(self):
 
89
        hooks = Hooks("breezy.tests.test_hooks", "somehooks")
 
90
        hooks['set_rh'] = []
 
91
        hooks.install_named_hook('set_rh', None, "demo")
 
92
        self.assertEqual("demo", hooks.get_hook_name(None))
 
93
 
 
94
    def test_uninstall_named_hook(self):
 
95
        hooks = Hooks("breezy.tests.test_hooks", "some_hooks")
 
96
        hooks.add_hook('set_rh', "Set revision history", (2, 0))
 
97
        hooks.install_named_hook('set_rh', None, "demo")
 
98
        self.assertEqual(1, len(hooks["set_rh"]))
 
99
        hooks.uninstall_named_hook("set_rh", "demo")
 
100
        self.assertEqual(0, len(hooks["set_rh"]))
 
101
 
 
102
    def test_uninstall_multiple_named_hooks(self):
 
103
        # Multiple callbacks with the same label all get removed
 
104
        hooks = Hooks("breezy.tests.test_hooks", "some_hooks")
 
105
        hooks.add_hook('set_rh', "Set revision history", (2, 0))
 
106
        hooks.install_named_hook('set_rh', 1, "demo")
 
107
        hooks.install_named_hook('set_rh', 2, "demo")
 
108
        hooks.install_named_hook('set_rh', 3, "othername")
 
109
        self.assertEqual(3, len(hooks["set_rh"]))
 
110
        hooks.uninstall_named_hook("set_rh", "demo")
 
111
        self.assertEqual(1, len(hooks["set_rh"]))
 
112
 
 
113
    def test_uninstall_named_hook_unknown_callable(self):
 
114
        hooks = Hooks("breezy.tests.test_hooks", "some_hooks")
 
115
        hooks.add_hook('set_rh', "Set revision hsitory", (2, 0))
 
116
        self.assertRaises(KeyError, hooks.uninstall_named_hook, "set_rh",
 
117
            "demo")
 
118
 
 
119
    def test_uninstall_named_hook_raises_unknown_hook(self):
 
120
        hooks = Hooks("breezy.tests.test_hooks", "some_hooks")
 
121
        self.assertRaises(errors.UnknownHook, hooks.uninstall_named_hook,
 
122
            'silly', "")
 
123
 
 
124
    def test_uninstall_named_hook_old_style(self):
 
125
        hooks = Hooks("breezy.tests.test_hooks", "some_hooks")
 
126
        hooks["set_rh"] = []
 
127
        hooks.install_named_hook('set_rh', None, "demo")
 
128
        self.assertRaises(errors.UnsupportedOperation,
 
129
            hooks.uninstall_named_hook, "set_rh", "demo")
 
130
 
 
131
    hooks = Hooks("breezy.tests.test_hooks", "TestHooks.hooks")
 
132
 
 
133
    def test_install_lazy_named_hook(self):
 
134
        # When the hook points are not yet registered the hook is
 
135
        # added to the _lazy_hooks dictionary in breezy.hooks.
 
136
        self.hooks.add_hook('set_rh', "doc", (0, 15))
 
137
        set_rh = lambda: None
 
138
        install_lazy_named_hook('breezy.tests.test_hooks',
 
139
            'TestHooks.hooks', 'set_rh', set_rh, "demo")
 
140
        set_rh_lazy_hooks = _mod_hooks._lazy_hooks[
 
141
            ('breezy.tests.test_hooks', 'TestHooks.hooks', 'set_rh')]
 
142
        self.assertEqual(1, len(set_rh_lazy_hooks))
 
143
        self.assertEqual(set_rh, set_rh_lazy_hooks[0][0].get_obj())
 
144
        self.assertEqual("demo", set_rh_lazy_hooks[0][1])
 
145
        self.assertEqual(list(TestHooks.hooks['set_rh']), [set_rh])
 
146
 
 
147
    set_rh = lambda: None
 
148
 
 
149
    def test_install_named_hook_lazy(self):
 
150
        hooks = Hooks("breezy.tests.hooks", "some_hooks")
 
151
        hooks['set_rh'] = HookPoint("set_rh", "doc", (0, 15), None)
 
152
        hooks.install_named_hook_lazy('set_rh', 'breezy.tests.test_hooks',
 
153
            'TestHooks.set_rh', "demo")
 
154
        self.assertEqual(list(hooks['set_rh']), [TestHooks.set_rh])
 
155
 
 
156
    def test_install_named_hook_lazy_old(self):
 
157
        # An exception is raised if a lazy hook is raised for
 
158
        # an old style hook point.
 
159
        hooks = Hooks("breezy.tests.hooks", "some_hooks")
 
160
        hooks['set_rh'] = []
 
161
        self.assertRaises(errors.UnsupportedOperation,
 
162
            hooks.install_named_hook_lazy,
 
163
            'set_rh', 'breezy.tests.test_hooks', 'TestHooks.set_rh',
 
164
            "demo")
 
165
 
 
166
    def test_valid_lazy_hooks(self):
 
167
        # Make sure that all the registered lazy hooks are referring to existing
 
168
        # hook points which allow lazy registration.
 
169
        for key, callbacks in _mod_hooks._lazy_hooks.iteritems():
 
170
            (module_name, member_name, hook_name) = key
 
171
            obj = pyutils.get_named_object(module_name, member_name)
 
172
            self.assertEqual(obj._module, module_name)
 
173
            self.assertEqual(obj._member_name, member_name)
 
174
            self.assertTrue(hook_name in obj)
 
175
            self.assertIs(callbacks, obj[hook_name]._callbacks)
 
176
 
 
177
 
 
178
class TestHook(tests.TestCase):
 
179
 
 
180
    def test___init__(self):
 
181
        doc = ("Invoked after changing the tip of a branch object. Called with"
 
182
            "a breezy.branch.PostChangeBranchTipParams object")
 
183
        hook = HookPoint("post_tip_change", doc, (0, 15), None)
 
184
        self.assertEqual(doc, hook.__doc__)
 
185
        self.assertEqual("post_tip_change", hook.name)
 
186
        self.assertEqual((0, 15), hook.introduced)
 
187
        self.assertEqual(None, hook.deprecated)
 
188
        self.assertEqual([], list(hook))
 
189
 
 
190
    def test_docs(self):
 
191
        doc = ("Invoked after changing the tip of a branch object. Called with"
 
192
            " a breezy.branch.PostChangeBranchTipParams object")
 
193
        hook = HookPoint("post_tip_change", doc, (0, 15), None)
 
194
        self.assertEqual("post_tip_change\n"
 
195
            "~~~~~~~~~~~~~~~\n"
 
196
            "\n"
 
197
            "Introduced in: 0.15\n"
 
198
            "\n"
 
199
            "Invoked after changing the tip of a branch object. Called with a\n"
 
200
            "breezy.branch.PostChangeBranchTipParams object\n", hook.docs())
 
201
 
 
202
    def test_hook(self):
 
203
        hook = HookPoint("foo", "no docs", None, None)
 
204
        def callback():
 
205
            pass
 
206
        hook.hook(callback, "my callback")
 
207
        self.assertEqual([callback], list(hook))
 
208
 
 
209
    def lazy_callback():
 
210
        pass
 
211
 
 
212
    def test_lazy_hook(self):
 
213
        hook = HookPoint("foo", "no docs", None, None)
 
214
        hook.hook_lazy(
 
215
            "breezy.tests.test_hooks", "TestHook.lazy_callback",
 
216
            "my callback")
 
217
        self.assertEqual([TestHook.lazy_callback], list(hook))
 
218
 
 
219
    def test_uninstall(self):
 
220
        hook = HookPoint("foo", "no docs", None, None)
 
221
        hook.hook_lazy(
 
222
            "breezy.tests.test_hooks", "TestHook.lazy_callback",
 
223
            "my callback")
 
224
        self.assertEqual([TestHook.lazy_callback], list(hook))
 
225
        hook.uninstall("my callback")
 
226
        self.assertEqual([], list(hook))
 
227
 
 
228
    def test_uninstall_unknown(self):
 
229
        hook = HookPoint("foo", "no docs", None, None)
 
230
        self.assertRaises(KeyError, hook.uninstall, "my callback")
 
231
 
 
232
    def test___repr(self):
 
233
        # The repr should list all the callbacks, with names.
 
234
        hook = HookPoint("foo", "no docs", None, None)
 
235
        def callback():
 
236
            pass
 
237
        hook.hook(callback, "my callback")
 
238
        callback_repr = repr(callback)
 
239
        self.assertEqual(
 
240
            '<HookPoint(foo), callbacks=[%s(my callback)]>' %
 
241
            callback_repr, repr(hook))
 
242
 
 
243
 
 
244
class TestHookRegistry(tests.TestCase):
 
245
 
 
246
    def test_items_are_reasonable_keys(self):
 
247
        # All the items in the known_hooks registry need to map from
 
248
        # (module_name, member_name) tuples to the callable used to get an
 
249
        # empty Hooks for that attribute. This is used to support the test
 
250
        # suite which needs to generate empty hooks (and HookPoints) to ensure
 
251
        # isolation and prevent tests failing spuriously.
 
252
        for key, factory in known_hooks.items():
 
253
            self.assertTrue(callable(factory),
 
254
                "The factory(%r) for %r is not callable" % (factory, key))
 
255
            obj = known_hooks_key_to_object(key)
 
256
            self.assertIsInstance(obj, Hooks)
 
257
            new_hooks = factory()
 
258
            self.assertIsInstance(obj, Hooks)
 
259
            self.assertEqual(type(obj), type(new_hooks))
 
260
            self.assertEqual("No hook name", new_hooks.get_hook_name(None))
 
261
 
 
262
    def test_known_hooks_key_to_object(self):
 
263
        self.assertIs(branch.Branch.hooks,
 
264
            known_hooks_key_to_object(('breezy.branch', 'Branch.hooks')))
 
265
 
 
266
    def test_known_hooks_key_to_parent_and_attribute(self):
 
267
        self.assertEqual((branch.Branch, 'hooks'),
 
268
            known_hooks.key_to_parent_and_attribute(
 
269
            ('breezy.branch', 'Branch.hooks')))
 
270
        self.assertEqual((branch, 'Branch'),
 
271
            known_hooks.key_to_parent_and_attribute(
 
272
            ('breezy.branch', 'Branch')))