/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 brzlib/tests/test_hooks.py

  • Committer: Jelmer Vernooij
  • Date: 2017-05-21 12:41:27 UTC
  • mto: This revision was merged to the branch mainline in revision 6623.
  • Revision ID: jelmer@jelmer.uk-20170521124127-iv8etg0vwymyai6y
s/bzr/brz/ in apport config.

Show diffs side-by-side

added added

removed removed

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