/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: Robert Collins
  • Date: 2009-03-10 01:16:51 UTC
  • mto: This revision was merged to the branch mainline in revision 4104.
  • Revision ID: robertc@robertcollins.net-20090310011651-73eyp8l970t21ah8
Allow self documenting hooks.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_hooks.py
16
16
 
17
17
"""Tests for the core Hooks logic."""
18
18
 
 
19
from bzrlib import errors
19
20
from bzrlib.hooks import (
 
21
    Hook,
20
22
    Hooks,
21
23
    )
22
24
from bzrlib.errors import (
29
31
 
30
32
class TestHooks(TestCase):
31
33
 
 
34
    def test_create_hook_first(self):
 
35
        hooks = Hooks()
 
36
        doc = ("Invoked after changing the tip of a branch object. Called with"
 
37
            "a bzrlib.branch.PostChangeBranchTipParams object")
 
38
        hook = Hook("post_tip_change", doc, (0, 15), None)
 
39
        hooks.create_hook(hook)
 
40
        self.assertEqual(hook, hooks['post_tip_change'])
 
41
 
 
42
    def test_create_hook_name_collision_errors(self):
 
43
        hooks = Hooks()
 
44
        doc = ("Invoked after changing the tip of a branch object. Called with"
 
45
            "a bzrlib.branch.PostChangeBranchTipParams object")
 
46
        hook = Hook("post_tip_change", doc, (0, 15), None)
 
47
        hook2 = Hook("post_tip_change", None, None, None)
 
48
        hooks.create_hook(hook)
 
49
        self.assertRaises(errors.DuplicateKey, hooks.create_hook, hook2)
 
50
        self.assertEqual(hook, hooks['post_tip_change'])
 
51
 
 
52
    def test_docs(self):
 
53
        """docs() should return something reasonable about the Hooks."""
 
54
        hooks = Hooks()
 
55
        hooks['legacy'] = []
 
56
        hook1 = Hook('post_tip_change',
 
57
            "Invoked after the tip of a branch changes. Called with "
 
58
            "a ChangeBranchTipParams object.", (1, 4), None)
 
59
        hook2 = Hook('pre_tip_change',
 
60
            "Invoked before the tip of a branch changes. Called with "
 
61
            "a ChangeBranchTipParams object. Hooks should raise "
 
62
            "TipChangeRejected to signal that a tip change is not permitted.",
 
63
            (1, 6), None)
 
64
        hooks.create_hook(hook1)
 
65
        hooks.create_hook(hook2)
 
66
        self.assertEqual(
 
67
            "legacy\n"
 
68
            "------\n"
 
69
            "\n"
 
70
            "An old-style hook. For documentation see the __init__ method of 'Hooks'\n"
 
71
            "\n"
 
72
            "post_tip_change\n"
 
73
            "---------------\n"
 
74
            "\n"
 
75
            "Introduced in: 1.4\n"
 
76
            "Deprecated in: Not deprecated\n"
 
77
            "\n"
 
78
            "Invoked after the tip of a branch changes. Called with a\n"
 
79
            "ChangeBranchTipParams object.\n"
 
80
            "\n"
 
81
            "pre_tip_change\n"
 
82
            "--------------\n"
 
83
            "\n"
 
84
            "Introduced in: 1.6\n"
 
85
            "Deprecated in: Not deprecated\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
 
32
91
    def test_install_hook_raises_unknown_hook(self):
33
92
        """install_hook should raise UnknownHook if a hook is unknown."""
34
93
        hooks = Hooks()
72
131
        hooks['set_rh'] = []
73
132
        self.applyDeprecated(one_five, hooks.install_hook, 'set_rh', None)
74
133
        self.assertEqual("No hook name", hooks.get_hook_name(None))
 
134
 
 
135
 
 
136
class TestHook(TestCase):
 
137
 
 
138
    def test___init__(self):
 
139
        doc = ("Invoked after changing the tip of a branch object. Called with"
 
140
            "a bzrlib.branch.PostChangeBranchTipParams object")
 
141
        hook = Hook("post_tip_change", doc, (0, 15), None)
 
142
        self.assertEqual(doc, hook.__doc__)
 
143
        self.assertEqual("post_tip_change", hook.name)
 
144
        self.assertEqual((0, 15), hook.introduced)
 
145
        self.assertEqual(None, hook.deprecated)
 
146
        self.assertEqual([], list(hook))
 
147
 
 
148
    def test_docs(self):
 
149
        doc = ("Invoked after changing the tip of a branch object. Called with"
 
150
            " a bzrlib.branch.PostChangeBranchTipParams object")
 
151
        hook = Hook("post_tip_change", doc, (0, 15), None)
 
152
        self.assertEqual("post_tip_change\n"
 
153
            "---------------\n"
 
154
            "\n"
 
155
            "Introduced in: 0.15\n"
 
156
            "Deprecated in: Not deprecated\n"
 
157
            "\n"
 
158
            "Invoked after changing the tip of a branch object. Called with a\n"
 
159
            "bzrlib.branch.PostChangeBranchTipParams object\n", hook.docs())
 
160
 
 
161
    def test_hook(self):
 
162
        hook = Hook("foo", "no docs", None, None)
 
163
        def callback():
 
164
            pass
 
165
        hook.hook(callback, "my callback")
 
166
        self.assertEqual([callback], list(hook))
 
167
 
 
168
    def test___repr(self):
 
169
        # The repr should list all the callbacks, with names.
 
170
        hook = Hook("foo", "no docs", None, None)
 
171
        def callback():
 
172
            pass
 
173
        hook.hook(callback, "my callback")
 
174
        callback_repr = repr(callback)
 
175
        self.assertEqual(
 
176
            '<bzrlib.hooks.Hook(foo), callbacks=[%s(my callback)]>' %
 
177
            callback_repr, repr(hook))