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

  • Committer: Richard Wilbur
  • Date: 2016-02-04 19:07:28 UTC
  • mto: This revision was merged to the branch mainline in revision 6618.
  • Revision ID: richard.wilbur@gmail.com-20160204190728-p0zvfii6zase0fw7
Update COPYING.txt from the original http://www.gnu.org/licenses/gpl-2.0.txt  (Only differences were in whitespace.)  Thanks to Petr Stodulka for pointing out the discrepancy.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_hooks.py
1
 
# Copyright (C) 2007-2012, 2016 Canonical Ltd
 
1
# Copyright (C) 2007-2010 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 .. import (
 
19
from bzrlib 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 bzrlib.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 bzrlib.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("bzrlib.tests.test_hooks", "some_hooks")
56
45
        hooks['legacy'] = []
57
46
        hooks.add_hook('post_tip_change',
58
47
            "Invoked after the tip of a branch changes. Called with "
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("bzrlib.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("bzrlib.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("bzrlib.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("bzrlib.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("bzrlib.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("bzrlib.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
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("bzrlib.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("bzrlib.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
132
            hooks.uninstall_named_hook, "set_rh", "demo")
143
133
 
144
 
    hooks = Hooks("breezy.tests.test_hooks", "TestHooks.hooks")
 
134
    hooks = Hooks("bzrlib.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 bzrlib.hooks.
149
139
        self.hooks.add_hook('set_rh', "doc", (0, 15))
150
140
        set_rh = lambda: None
151
 
        install_lazy_named_hook('breezy.tests.test_hooks',
 
141
        install_lazy_named_hook('bzrlib.tests.test_hooks',
152
142
            'TestHooks.hooks', 'set_rh', set_rh, "demo")
153
143
        set_rh_lazy_hooks = _mod_hooks._lazy_hooks[
154
 
            ('breezy.tests.test_hooks', 'TestHooks.hooks', 'set_rh')]
155
 
        self.assertEqual(1, len(set_rh_lazy_hooks))
156
 
        self.assertEqual(set_rh, set_rh_lazy_hooks[0][0].get_obj())
157
 
        self.assertEqual("demo", set_rh_lazy_hooks[0][1])
 
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])
158
148
        self.assertEqual(list(TestHooks.hooks['set_rh']), [set_rh])
159
149
 
160
150
    set_rh = lambda: None
161
151
 
162
152
    def test_install_named_hook_lazy(self):
163
 
        hooks = Hooks("breezy.tests.hooks", "some_hooks")
 
153
        hooks = Hooks("bzrlib.tests.hooks", "some_hooks")
164
154
        hooks['set_rh'] = HookPoint("set_rh", "doc", (0, 15), None)
165
 
        hooks.install_named_hook_lazy('set_rh', 'breezy.tests.test_hooks',
 
155
        hooks.install_named_hook_lazy('set_rh', 'bzrlib.tests.test_hooks',
166
156
            'TestHooks.set_rh', "demo")
167
157
        self.assertEqual(list(hooks['set_rh']), [TestHooks.set_rh])
168
158
 
169
159
    def test_install_named_hook_lazy_old(self):
170
160
        # An exception is raised if a lazy hook is raised for
171
161
        # an old style hook point.
172
 
        hooks = Hooks("breezy.tests.hooks", "some_hooks")
 
162
        hooks = Hooks("bzrlib.tests.hooks", "some_hooks")
173
163
        hooks['set_rh'] = []
174
164
        self.assertRaises(errors.UnsupportedOperation,
175
165
            hooks.install_named_hook_lazy,
176
 
            'set_rh', 'breezy.tests.test_hooks', 'TestHooks.set_rh',
 
166
            'set_rh', 'bzrlib.tests.test_hooks', 'TestHooks.set_rh',
177
167
            "demo")
178
168
 
179
169
    def test_valid_lazy_hooks(self):
180
170
        # Make sure that all the registered lazy hooks are referring to existing
181
171
        # hook points which allow lazy registration.
182
 
        for key, callbacks in _mod_hooks._lazy_hooks.items():
 
172
        for key, callbacks in _mod_hooks._lazy_hooks.iteritems():
183
173
            (module_name, member_name, hook_name) = key
184
174
            obj = pyutils.get_named_object(module_name, member_name)
185
 
            self.assertEqual(obj._module, module_name)
186
 
            self.assertEqual(obj._member_name, member_name)
 
175
            self.assertEquals(obj._module, module_name)
 
176
            self.assertEquals(obj._member_name, member_name)
187
177
            self.assertTrue(hook_name in obj)
188
178
            self.assertIs(callbacks, obj[hook_name]._callbacks)
189
179
 
192
182
 
193
183
    def test___init__(self):
194
184
        doc = ("Invoked after changing the tip of a branch object. Called with"
195
 
            "a breezy.branch.PostChangeBranchTipParams object")
 
185
            "a bzrlib.branch.PostChangeBranchTipParams object")
196
186
        hook = HookPoint("post_tip_change", doc, (0, 15), None)
197
187
        self.assertEqual(doc, hook.__doc__)
198
188
        self.assertEqual("post_tip_change", hook.name)
202
192
 
203
193
    def test_docs(self):
204
194
        doc = ("Invoked after changing the tip of a branch object. Called with"
205
 
            " a breezy.branch.PostChangeBranchTipParams object")
 
195
            " a bzrlib.branch.PostChangeBranchTipParams object")
206
196
        hook = HookPoint("post_tip_change", doc, (0, 15), None)
207
197
        self.assertEqual("post_tip_change\n"
208
198
            "~~~~~~~~~~~~~~~\n"
210
200
            "Introduced in: 0.15\n"
211
201
            "\n"
212
202
            "Invoked after changing the tip of a branch object. Called with a\n"
213
 
            "breezy.branch.PostChangeBranchTipParams object\n", hook.docs())
 
203
            "bzrlib.branch.PostChangeBranchTipParams object\n", hook.docs())
214
204
 
215
205
    def test_hook(self):
216
206
        hook = HookPoint("foo", "no docs", None, None)
225
215
    def test_lazy_hook(self):
226
216
        hook = HookPoint("foo", "no docs", None, None)
227
217
        hook.hook_lazy(
228
 
            "breezy.tests.test_hooks", "TestHook.lazy_callback",
 
218
            "bzrlib.tests.test_hooks", "TestHook.lazy_callback",
229
219
            "my callback")
230
220
        self.assertEqual([TestHook.lazy_callback], list(hook))
231
221
 
232
222
    def test_uninstall(self):
233
223
        hook = HookPoint("foo", "no docs", None, None)
234
224
        hook.hook_lazy(
235
 
            "breezy.tests.test_hooks", "TestHook.lazy_callback",
 
225
            "bzrlib.tests.test_hooks", "TestHook.lazy_callback",
236
226
            "my callback")
237
227
        self.assertEqual([TestHook.lazy_callback], list(hook))
238
228
        hook.uninstall("my callback")
274
264
 
275
265
    def test_known_hooks_key_to_object(self):
276
266
        self.assertIs(branch.Branch.hooks,
277
 
            known_hooks_key_to_object(('breezy.branch', 'Branch.hooks')))
 
267
            known_hooks_key_to_object(('bzrlib.branch', 'Branch.hooks')))
278
268
 
279
269
    def test_known_hooks_key_to_parent_and_attribute(self):
280
270
        self.assertEqual((branch.Branch, 'hooks'),
281
271
            known_hooks.key_to_parent_and_attribute(
282
 
            ('breezy.branch', 'Branch.hooks')))
 
272
            ('bzrlib.branch', 'Branch.hooks')))
283
273
        self.assertEqual((branch, 'Branch'),
284
274
            known_hooks.key_to_parent_and_attribute(
285
 
            ('breezy.branch', 'Branch')))
 
275
            ('bzrlib.branch', 'Branch')))