/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: Jelmer Vernooij
  • Date: 2020-03-22 01:35:14 UTC
  • mfrom: (7490.7.6 work)
  • mto: This revision was merged to the branch mainline in revision 7499.
  • Revision ID: jelmer@jelmer.uk-20200322013514-7vw1ntwho04rcuj3
merge lp:brz/3.1.

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
    UnknownHook,
 
30
    install_lazy_named_hook,
 
31
    known_hooks,
 
32
    known_hooks_key_to_object,
 
33
    )
 
34
 
 
35
 
 
36
class TestErrors(tests.TestCase):
 
37
 
 
38
    def test_unknown_hook(self):
 
39
        error = UnknownHook("branch", "foo")
 
40
        self.assertEqualDiff("The branch hook 'foo' is unknown in this version"
 
41
                             " of breezy.",
 
42
                             str(error))
 
43
        error = UnknownHook("tree", "bar")
 
44
        self.assertEqualDiff("The tree hook 'bar' is unknown in this version"
 
45
                             " of breezy.",
 
46
                             str(error))
 
47
 
 
48
 
 
49
class TestHooks(tests.TestCase):
 
50
 
 
51
    def test_docs(self):
 
52
        """docs() should return something reasonable about the Hooks."""
 
53
        class MyHooks(Hooks):
 
54
            pass
 
55
        hooks = MyHooks("breezy.tests.test_hooks", "some_hooks")
 
56
        hooks['legacy'] = []
 
57
        hooks.add_hook('post_tip_change',
 
58
                       "Invoked after the tip of a branch changes. Called with "
 
59
                       "a ChangeBranchTipParams object.", (1, 4))
 
60
        hooks.add_hook('pre_tip_change',
 
61
                       "Invoked before the tip of a branch changes. Called with "
 
62
                       "a ChangeBranchTipParams object. Hooks should raise "
 
63
                       "TipChangeRejected to signal that a tip change is not permitted.",
 
64
                       (1, 6), None)
 
65
        self.assertEqualDiff(
 
66
            "MyHooks\n"
 
67
            "-------\n"
 
68
            "\n"
 
69
            "legacy\n"
 
70
            "~~~~~~\n"
 
71
            "\n"
 
72
            "An old-style hook. For documentation see the __init__ method of 'MyHooks'\n"
 
73
            "\n"
 
74
            "post_tip_change\n"
 
75
            "~~~~~~~~~~~~~~~\n"
 
76
            "\n"
 
77
            "Introduced in: 1.4\n"
 
78
            "\n"
 
79
            "Invoked after the tip of a branch changes. Called with a\n"
 
80
            "ChangeBranchTipParams object.\n"
 
81
            "\n"
 
82
            "pre_tip_change\n"
 
83
            "~~~~~~~~~~~~~~\n"
 
84
            "\n"
 
85
            "Introduced in: 1.6\n"
 
86
            "\n"
 
87
            "Invoked before the tip of a branch changes. Called with a\n"
 
88
            "ChangeBranchTipParams object. Hooks should raise TipChangeRejected to\n"
 
89
            "signal that a tip change is not permitted.\n", hooks.docs())
 
90
 
 
91
    def test_install_named_hook_raises_unknown_hook(self):
 
92
        hooks = Hooks("breezy.tests.test_hooks", "some_hooks")
 
93
        self.assertRaises(UnknownHook, hooks.install_named_hook, 'silly',
 
94
                          None, "")
 
95
 
 
96
    def test_install_named_hook_appends_known_hook(self):
 
97
        hooks = Hooks("breezy.tests.test_hooks", "some_hooks")
 
98
        hooks['set_rh'] = []
 
99
        hooks.install_named_hook('set_rh', None, "demo")
 
100
        self.assertEqual(hooks['set_rh'], [None])
 
101
 
 
102
    def test_install_named_hook_and_retrieve_name(self):
 
103
        hooks = Hooks("breezy.tests.test_hooks", "somehooks")
 
104
        hooks['set_rh'] = []
 
105
        hooks.install_named_hook('set_rh', None, "demo")
 
106
        self.assertEqual("demo", hooks.get_hook_name(None))
 
107
 
 
108
    def test_uninstall_named_hook(self):
 
109
        hooks = Hooks("breezy.tests.test_hooks", "some_hooks")
 
110
        hooks.add_hook('set_rh', "Set revision history", (2, 0))
 
111
        hooks.install_named_hook('set_rh', None, "demo")
 
112
        self.assertEqual(1, len(hooks["set_rh"]))
 
113
        hooks.uninstall_named_hook("set_rh", "demo")
 
114
        self.assertEqual(0, len(hooks["set_rh"]))
 
115
 
 
116
    def test_uninstall_multiple_named_hooks(self):
 
117
        # Multiple callbacks with the same label all get removed
 
118
        hooks = Hooks("breezy.tests.test_hooks", "some_hooks")
 
119
        hooks.add_hook('set_rh', "Set revision history", (2, 0))
 
120
        hooks.install_named_hook('set_rh', 1, "demo")
 
121
        hooks.install_named_hook('set_rh', 2, "demo")
 
122
        hooks.install_named_hook('set_rh', 3, "othername")
 
123
        self.assertEqual(3, len(hooks["set_rh"]))
 
124
        hooks.uninstall_named_hook("set_rh", "demo")
 
125
        self.assertEqual(1, len(hooks["set_rh"]))
 
126
 
 
127
    def test_uninstall_named_hook_unknown_callable(self):
 
128
        hooks = Hooks("breezy.tests.test_hooks", "some_hooks")
 
129
        hooks.add_hook('set_rh', "Set revision hsitory", (2, 0))
 
130
        self.assertRaises(KeyError, hooks.uninstall_named_hook, "set_rh",
 
131
                          "demo")
 
132
 
 
133
    def test_uninstall_named_hook_raises_unknown_hook(self):
 
134
        hooks = Hooks("breezy.tests.test_hooks", "some_hooks")
 
135
        self.assertRaises(UnknownHook, hooks.uninstall_named_hook, 'silly', "")
 
136
 
 
137
    def test_uninstall_named_hook_old_style(self):
 
138
        hooks = Hooks("breezy.tests.test_hooks", "some_hooks")
 
139
        hooks["set_rh"] = []
 
140
        hooks.install_named_hook('set_rh', None, "demo")
 
141
        self.assertRaises(errors.UnsupportedOperation,
 
142
                          hooks.uninstall_named_hook, "set_rh", "demo")
 
143
 
 
144
    hooks = Hooks("breezy.tests.test_hooks", "TestHooks.hooks")
 
145
 
 
146
    def test_install_lazy_named_hook(self):
 
147
        # When the hook points are not yet registered the hook is
 
148
        # added to the _lazy_hooks dictionary in breezy.hooks.
 
149
        self.hooks.add_hook('set_rh', "doc", (0, 15))
 
150
 
 
151
        def set_rh(): return None
 
152
        install_lazy_named_hook('breezy.tests.test_hooks',
 
153
                                'TestHooks.hooks', 'set_rh', set_rh, "demo")
 
154
        set_rh_lazy_hooks = _mod_hooks._lazy_hooks[
 
155
            ('breezy.tests.test_hooks', 'TestHooks.hooks', 'set_rh')]
 
156
        self.assertEqual(1, len(set_rh_lazy_hooks))
 
157
        self.assertEqual(set_rh, set_rh_lazy_hooks[0][0].get_obj())
 
158
        self.assertEqual("demo", set_rh_lazy_hooks[0][1])
 
159
        self.assertEqual(list(TestHooks.hooks['set_rh']), [set_rh])
 
160
 
 
161
    def set_rh(): return None
 
162
 
 
163
    def test_install_named_hook_lazy(self):
 
164
        hooks = Hooks("breezy.tests.hooks", "some_hooks")
 
165
        hooks['set_rh'] = HookPoint("set_rh", "doc", (0, 15), None)
 
166
        hooks.install_named_hook_lazy('set_rh', 'breezy.tests.test_hooks',
 
167
                                      'TestHooks.set_rh', "demo")
 
168
        self.assertEqual(list(hooks['set_rh']), [TestHooks.set_rh])
 
169
 
 
170
    def test_install_named_hook_lazy_old(self):
 
171
        # An exception is raised if a lazy hook is raised for
 
172
        # an old style hook point.
 
173
        hooks = Hooks("breezy.tests.hooks", "some_hooks")
 
174
        hooks['set_rh'] = []
 
175
        self.assertRaises(errors.UnsupportedOperation,
 
176
                          hooks.install_named_hook_lazy,
 
177
                          'set_rh', 'breezy.tests.test_hooks', 'TestHooks.set_rh',
 
178
                          "demo")
 
179
 
 
180
    def test_valid_lazy_hooks(self):
 
181
        # Make sure that all the registered lazy hooks are referring to existing
 
182
        # hook points which allow lazy registration.
 
183
        for key, callbacks in _mod_hooks._lazy_hooks.items():
 
184
            (module_name, member_name, hook_name) = key
 
185
            obj = pyutils.get_named_object(module_name, member_name)
 
186
            self.assertEqual(obj._module, module_name)
 
187
            self.assertEqual(obj._member_name, member_name)
 
188
            self.assertTrue(hook_name in obj)
 
189
            self.assertIs(callbacks, obj[hook_name]._callbacks)
 
190
 
 
191
 
 
192
class TestHook(tests.TestCase):
 
193
 
 
194
    def test___init__(self):
 
195
        doc = ("Invoked after changing the tip of a branch object. Called with"
 
196
               "a breezy.branch.PostChangeBranchTipParams object")
 
197
        hook = HookPoint("post_tip_change", doc, (0, 15), None)
 
198
        self.assertEqual(doc, hook.__doc__)
 
199
        self.assertEqual("post_tip_change", hook.name)
 
200
        self.assertEqual((0, 15), hook.introduced)
 
201
        self.assertEqual(None, hook.deprecated)
 
202
        self.assertEqual([], list(hook))
 
203
 
 
204
    def test_docs(self):
 
205
        doc = ("Invoked after changing the tip of a branch object. Called with"
 
206
               " a breezy.branch.PostChangeBranchTipParams object")
 
207
        hook = HookPoint("post_tip_change", doc, (0, 15), None)
 
208
        self.assertEqual("post_tip_change\n"
 
209
                         "~~~~~~~~~~~~~~~\n"
 
210
                         "\n"
 
211
                         "Introduced in: 0.15\n"
 
212
                         "\n"
 
213
                         "Invoked after changing the tip of a branch object. Called with a\n"
 
214
                         "breezy.branch.PostChangeBranchTipParams object\n", hook.docs())
 
215
 
 
216
    def test_hook(self):
 
217
        hook = HookPoint("foo", "no docs", None, None)
 
218
 
 
219
        def callback():
 
220
            pass
 
221
        hook.hook(callback, "my callback")
 
222
        self.assertEqual([callback], list(hook))
 
223
 
 
224
    def lazy_callback():
 
225
        pass
 
226
 
 
227
    def test_lazy_hook(self):
 
228
        hook = HookPoint("foo", "no docs", None, None)
 
229
        hook.hook_lazy(
 
230
            "breezy.tests.test_hooks", "TestHook.lazy_callback",
 
231
            "my callback")
 
232
        self.assertEqual([TestHook.lazy_callback], list(hook))
 
233
 
 
234
    def test_uninstall(self):
 
235
        hook = HookPoint("foo", "no docs", None, None)
 
236
        hook.hook_lazy(
 
237
            "breezy.tests.test_hooks", "TestHook.lazy_callback",
 
238
            "my callback")
 
239
        self.assertEqual([TestHook.lazy_callback], list(hook))
 
240
        hook.uninstall("my callback")
 
241
        self.assertEqual([], list(hook))
 
242
 
 
243
    def test_uninstall_unknown(self):
 
244
        hook = HookPoint("foo", "no docs", None, None)
 
245
        self.assertRaises(KeyError, hook.uninstall, "my callback")
 
246
 
 
247
    def test___repr(self):
 
248
        # The repr should list all the callbacks, with names.
 
249
        hook = HookPoint("foo", "no docs", None, None)
 
250
 
 
251
        def callback():
 
252
            pass
 
253
        hook.hook(callback, "my callback")
 
254
        callback_repr = repr(callback)
 
255
        self.assertEqual(
 
256
            '<HookPoint(foo), callbacks=[%s(my callback)]>' %
 
257
            callback_repr, repr(hook))
 
258
 
 
259
 
 
260
class TestHookRegistry(tests.TestCase):
 
261
 
 
262
    def test_items_are_reasonable_keys(self):
 
263
        # All the items in the known_hooks registry need to map from
 
264
        # (module_name, member_name) tuples to the callable used to get an
 
265
        # empty Hooks for that attribute. This is used to support the test
 
266
        # suite which needs to generate empty hooks (and HookPoints) to ensure
 
267
        # isolation and prevent tests failing spuriously.
 
268
        for key, factory in known_hooks.items():
 
269
            self.assertTrue(callable(factory),
 
270
                            "The factory(%r) for %r is not callable" % (factory, key))
 
271
            obj = known_hooks_key_to_object(key)
 
272
            self.assertIsInstance(obj, Hooks)
 
273
            new_hooks = factory()
 
274
            self.assertIsInstance(obj, Hooks)
 
275
            self.assertEqual(type(obj), type(new_hooks))
 
276
            self.assertEqual("No hook name", new_hooks.get_hook_name(None))
 
277
 
 
278
    def test_known_hooks_key_to_object(self):
 
279
        self.assertIs(branch.Branch.hooks,
 
280
                      known_hooks_key_to_object(('breezy.branch', 'Branch.hooks')))
 
281
 
 
282
    def test_known_hooks_key_to_parent_and_attribute(self):
 
283
        self.assertEqual((branch.Branch, 'hooks'),
 
284
                         known_hooks.key_to_parent_and_attribute(
 
285
            ('breezy.branch', 'Branch.hooks')))
 
286
        self.assertEqual((branch, 'Branch'),
 
287
                         known_hooks.key_to_parent_and_attribute(
 
288
            ('breezy.branch', 'Branch')))