/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: Breezy landing bot
  • Author(s): Colin Watson
  • Date: 2020-11-16 21:47:08 UTC
  • mfrom: (7521.1.1 remove-lp-workaround)
  • Revision ID: breezy.the.bot@gmail.com-20201116214708-jos209mgxi41oy15
Remove breezy.git workaround for bazaar.launchpad.net.

Merged from https://code.launchpad.net/~cjwatson/brz/remove-lp-workaround/+merge/393710

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/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
16
16
 
17
17
"""Tests for the core Hooks logic."""
18
18
 
19
 
from bzrlib import (
 
19
from .. import (
20
20
    branch,
21
21
    errors,
22
22
    hooks as _mod_hooks,
23
23
    pyutils,
24
24
    tests,
25
25
    )
26
 
from bzrlib.hooks import (
 
26
from ..hooks import (
27
27
    HookPoint,
28
28
    Hooks,
 
29
    UnknownHook,
29
30
    install_lazy_named_hook,
30
31
    known_hooks,
31
32
    known_hooks_key_to_object,
32
33
    )
33
 
from bzrlib.symbol_versioning import (
34
 
    deprecated_in,
35
 
    )
 
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))
36
47
 
37
48
 
38
49
class TestHooks(tests.TestCase):
41
52
        """docs() should return something reasonable about the Hooks."""
42
53
        class MyHooks(Hooks):
43
54
            pass
44
 
        hooks = MyHooks("bzrlib.tests.test_hooks", "some_hooks")
 
55
        hooks = MyHooks("breezy.tests.test_hooks", "some_hooks")
45
56
        hooks['legacy'] = []
46
57
        hooks.add_hook('post_tip_change',
47
 
            "Invoked after the tip of a branch changes. Called with "
48
 
            "a ChangeBranchTipParams object.", (1, 4))
 
58
                       "Invoked after the tip of a branch changes. Called with "
 
59
                       "a ChangeBranchTipParams object.", (1, 4))
49
60
        hooks.add_hook('pre_tip_change',
50
 
            "Invoked before the tip of a branch changes. Called with "
51
 
            "a ChangeBranchTipParams object. Hooks should raise "
52
 
            "TipChangeRejected to signal that a tip change is not permitted.",
53
 
            (1, 6), None)
 
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)
54
65
        self.assertEqualDiff(
55
66
            "MyHooks\n"
56
67
            "-------\n"
78
89
            "signal that a tip change is not permitted.\n", hooks.docs())
79
90
 
80
91
    def test_install_named_hook_raises_unknown_hook(self):
81
 
        hooks = Hooks("bzrlib.tests.test_hooks", "some_hooks")
82
 
        self.assertRaises(errors.UnknownHook, hooks.install_named_hook, 'silly',
 
92
        hooks = Hooks("breezy.tests.test_hooks", "some_hooks")
 
93
        self.assertRaises(UnknownHook, hooks.install_named_hook, 'silly',
83
94
                          None, "")
84
95
 
85
96
    def test_install_named_hook_appends_known_hook(self):
86
 
        hooks = Hooks("bzrlib.tests.test_hooks", "some_hooks")
 
97
        hooks = Hooks("breezy.tests.test_hooks", "some_hooks")
87
98
        hooks['set_rh'] = []
88
99
        hooks.install_named_hook('set_rh', None, "demo")
89
100
        self.assertEqual(hooks['set_rh'], [None])
90
101
 
91
102
    def test_install_named_hook_and_retrieve_name(self):
92
 
        hooks = Hooks("bzrlib.tests.test_hooks", "somehooks")
 
103
        hooks = Hooks("breezy.tests.test_hooks", "somehooks")
93
104
        hooks['set_rh'] = []
94
105
        hooks.install_named_hook('set_rh', None, "demo")
95
106
        self.assertEqual("demo", hooks.get_hook_name(None))
96
107
 
97
108
    def test_uninstall_named_hook(self):
98
 
        hooks = Hooks("bzrlib.tests.test_hooks", "some_hooks")
 
109
        hooks = Hooks("breezy.tests.test_hooks", "some_hooks")
99
110
        hooks.add_hook('set_rh', "Set revision history", (2, 0))
100
111
        hooks.install_named_hook('set_rh', None, "demo")
101
112
        self.assertEqual(1, len(hooks["set_rh"]))
104
115
 
105
116
    def test_uninstall_multiple_named_hooks(self):
106
117
        # Multiple callbacks with the same label all get removed
107
 
        hooks = Hooks("bzrlib.tests.test_hooks", "some_hooks")
 
118
        hooks = Hooks("breezy.tests.test_hooks", "some_hooks")
108
119
        hooks.add_hook('set_rh', "Set revision history", (2, 0))
109
120
        hooks.install_named_hook('set_rh', 1, "demo")
110
121
        hooks.install_named_hook('set_rh', 2, "demo")
114
125
        self.assertEqual(1, len(hooks["set_rh"]))
115
126
 
116
127
    def test_uninstall_named_hook_unknown_callable(self):
117
 
        hooks = Hooks("bzrlib.tests.test_hooks", "some_hooks")
 
128
        hooks = Hooks("breezy.tests.test_hooks", "some_hooks")
118
129
        hooks.add_hook('set_rh', "Set revision hsitory", (2, 0))
119
130
        self.assertRaises(KeyError, hooks.uninstall_named_hook, "set_rh",
120
 
            "demo")
 
131
                          "demo")
121
132
 
122
133
    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', "")
 
134
        hooks = Hooks("breezy.tests.test_hooks", "some_hooks")
 
135
        self.assertRaises(UnknownHook, hooks.uninstall_named_hook, 'silly', "")
126
136
 
127
137
    def test_uninstall_named_hook_old_style(self):
128
 
        hooks = Hooks("bzrlib.tests.test_hooks", "some_hooks")
 
138
        hooks = Hooks("breezy.tests.test_hooks", "some_hooks")
129
139
        hooks["set_rh"] = []
130
140
        hooks.install_named_hook('set_rh', None, "demo")
131
141
        self.assertRaises(errors.UnsupportedOperation,
132
 
            hooks.uninstall_named_hook, "set_rh", "demo")
 
142
                          hooks.uninstall_named_hook, "set_rh", "demo")
133
143
 
134
 
    hooks = Hooks("bzrlib.tests.test_hooks", "TestHooks.hooks")
 
144
    hooks = Hooks("breezy.tests.test_hooks", "TestHooks.hooks")
135
145
 
136
146
    def test_install_lazy_named_hook(self):
137
147
        # When the hook points are not yet registered the hook is
138
 
        # added to the _lazy_hooks dictionary in bzrlib.hooks.
 
148
        # added to the _lazy_hooks dictionary in breezy.hooks.
139
149
        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")
 
150
 
 
151
        def set_rh(): return None
 
152
        install_lazy_named_hook('breezy.tests.test_hooks',
 
153
                                'TestHooks.hooks', 'set_rh', set_rh, "demo")
143
154
        set_rh_lazy_hooks = _mod_hooks._lazy_hooks[
144
 
            ('bzrlib.tests.test_hooks', 'TestHooks.hooks', 'set_rh')]
145
 
        self.assertEquals(1, len(set_rh_lazy_hooks))
146
 
        self.assertEquals(set_rh, set_rh_lazy_hooks[0][0].get_obj())
147
 
        self.assertEquals("demo", set_rh_lazy_hooks[0][1])
 
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])
148
159
        self.assertEqual(list(TestHooks.hooks['set_rh']), [set_rh])
149
160
 
150
 
    set_rh = lambda: None
 
161
    def set_rh(): return None
151
162
 
152
163
    def test_install_named_hook_lazy(self):
153
 
        hooks = Hooks("bzrlib.tests.hooks", "some_hooks")
 
164
        hooks = Hooks("breezy.tests.hooks", "some_hooks")
154
165
        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")
 
166
        hooks.install_named_hook_lazy('set_rh', 'breezy.tests.test_hooks',
 
167
                                      'TestHooks.set_rh', "demo")
157
168
        self.assertEqual(list(hooks['set_rh']), [TestHooks.set_rh])
158
169
 
159
170
    def test_install_named_hook_lazy_old(self):
160
171
        # An exception is raised if a lazy hook is raised for
161
172
        # an old style hook point.
162
 
        hooks = Hooks("bzrlib.tests.hooks", "some_hooks")
 
173
        hooks = Hooks("breezy.tests.hooks", "some_hooks")
163
174
        hooks['set_rh'] = []
164
175
        self.assertRaises(errors.UnsupportedOperation,
165
 
            hooks.install_named_hook_lazy,
166
 
            'set_rh', 'bzrlib.tests.test_hooks', 'TestHooks.set_rh',
167
 
            "demo")
 
176
                          hooks.install_named_hook_lazy,
 
177
                          'set_rh', 'breezy.tests.test_hooks', 'TestHooks.set_rh',
 
178
                          "demo")
168
179
 
169
180
    def test_valid_lazy_hooks(self):
170
181
        # Make sure that all the registered lazy hooks are referring to existing
171
182
        # hook points which allow lazy registration.
172
 
        for key, callbacks in _mod_hooks._lazy_hooks.iteritems():
 
183
        for key, callbacks in _mod_hooks._lazy_hooks.items():
173
184
            (module_name, member_name, hook_name) = key
174
185
            obj = pyutils.get_named_object(module_name, member_name)
175
 
            self.assertEquals(obj._module, module_name)
176
 
            self.assertEquals(obj._member_name, member_name)
 
186
            self.assertEqual(obj._module, module_name)
 
187
            self.assertEqual(obj._member_name, member_name)
177
188
            self.assertTrue(hook_name in obj)
178
189
            self.assertIs(callbacks, obj[hook_name]._callbacks)
179
190
 
182
193
 
183
194
    def test___init__(self):
184
195
        doc = ("Invoked after changing the tip of a branch object. Called with"
185
 
            "a bzrlib.branch.PostChangeBranchTipParams object")
 
196
               "a breezy.branch.PostChangeBranchTipParams object")
186
197
        hook = HookPoint("post_tip_change", doc, (0, 15), None)
187
198
        self.assertEqual(doc, hook.__doc__)
188
199
        self.assertEqual("post_tip_change", hook.name)
192
203
 
193
204
    def test_docs(self):
194
205
        doc = ("Invoked after changing the tip of a branch object. Called with"
195
 
            " a bzrlib.branch.PostChangeBranchTipParams object")
 
206
               " a breezy.branch.PostChangeBranchTipParams object")
196
207
        hook = HookPoint("post_tip_change", doc, (0, 15), None)
197
208
        self.assertEqual("post_tip_change\n"
198
 
            "~~~~~~~~~~~~~~~\n"
199
 
            "\n"
200
 
            "Introduced in: 0.15\n"
201
 
            "\n"
202
 
            "Invoked after changing the tip of a branch object. Called with a\n"
203
 
            "bzrlib.branch.PostChangeBranchTipParams object\n", hook.docs())
 
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())
204
215
 
205
216
    def test_hook(self):
206
217
        hook = HookPoint("foo", "no docs", None, None)
 
218
 
207
219
        def callback():
208
220
            pass
209
221
        hook.hook(callback, "my callback")
215
227
    def test_lazy_hook(self):
216
228
        hook = HookPoint("foo", "no docs", None, None)
217
229
        hook.hook_lazy(
218
 
            "bzrlib.tests.test_hooks", "TestHook.lazy_callback",
 
230
            "breezy.tests.test_hooks", "TestHook.lazy_callback",
219
231
            "my callback")
220
232
        self.assertEqual([TestHook.lazy_callback], list(hook))
221
233
 
222
234
    def test_uninstall(self):
223
235
        hook = HookPoint("foo", "no docs", None, None)
224
236
        hook.hook_lazy(
225
 
            "bzrlib.tests.test_hooks", "TestHook.lazy_callback",
 
237
            "breezy.tests.test_hooks", "TestHook.lazy_callback",
226
238
            "my callback")
227
239
        self.assertEqual([TestHook.lazy_callback], list(hook))
228
240
        hook.uninstall("my callback")
235
247
    def test___repr(self):
236
248
        # The repr should list all the callbacks, with names.
237
249
        hook = HookPoint("foo", "no docs", None, None)
 
250
 
238
251
        def callback():
239
252
            pass
240
253
        hook.hook(callback, "my callback")
254
267
        # isolation and prevent tests failing spuriously.
255
268
        for key, factory in known_hooks.items():
256
269
            self.assertTrue(callable(factory),
257
 
                "The factory(%r) for %r is not callable" % (factory, key))
 
270
                            "The factory(%r) for %r is not callable" % (factory, key))
258
271
            obj = known_hooks_key_to_object(key)
259
272
            self.assertIsInstance(obj, Hooks)
260
273
            new_hooks = factory()
264
277
 
265
278
    def test_known_hooks_key_to_object(self):
266
279
        self.assertIs(branch.Branch.hooks,
267
 
            known_hooks_key_to_object(('bzrlib.branch', 'Branch.hooks')))
 
280
                      known_hooks_key_to_object(('breezy.branch', 'Branch.hooks')))
268
281
 
269
282
    def test_known_hooks_key_to_parent_and_attribute(self):
270
283
        self.assertEqual((branch.Branch, 'hooks'),
271
 
            known_hooks.key_to_parent_and_attribute(
272
 
            ('bzrlib.branch', 'Branch.hooks')))
 
284
                         known_hooks.key_to_parent_and_attribute(
 
285
            ('breezy.branch', 'Branch.hooks')))
273
286
        self.assertEqual((branch, 'Branch'),
274
 
            known_hooks.key_to_parent_and_attribute(
275
 
            ('bzrlib.branch', 'Branch')))
 
287
                         known_hooks.key_to_parent_and_attribute(
 
288
            ('breezy.branch', 'Branch')))