~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_commands.py

  • Committer: Martin Pool
  • Date: 2007-04-04 06:17:31 UTC
  • mto: This revision was merged to the branch mainline in revision 2397.
  • Revision ID: mbp@sourcefrog.net-20070404061731-tt2xrzllqhbodn83
Contents of TODO file moved into bug tracker

Show diffs side-by-side

added added

removed removed

Lines of Context:
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
from cStringIO import StringIO
18
18
import errno
19
 
import sys
20
19
 
21
20
from bzrlib import (
22
 
    builtins,
23
21
    commands,
24
22
    config,
25
23
    errors,
26
 
    option,
27
 
    tests,
28
24
    )
29
25
from bzrlib.commands import display_command
30
 
from bzrlib.tests import TestSkipped
31
 
 
32
 
 
33
 
class TestCommands(tests.TestCase):
 
26
from bzrlib.tests import TestCase, TestSkipped
 
27
 
 
28
 
 
29
class TestCommands(TestCase):
34
30
 
35
31
    def test_display_command(self):
36
32
        """EPIPE message is selectively suppressed"""
61
57
        self.assertRaises(errors.BzrCommandError,
62
58
                          commands.run_bzr, ['log', u'--option\xb5'])
63
59
 
64
 
    @staticmethod
65
 
    def get_command(options):
66
 
        class cmd_foo(commands.Command):
67
 
            'Bar'
68
 
 
69
 
            takes_options = options
70
 
 
71
 
        return cmd_foo()
72
 
 
73
 
    def test_help_hidden(self):
74
 
        c = self.get_command([option.Option('foo', hidden=True)])
75
 
        self.assertNotContainsRe(c.get_help_text(), '--foo')
76
 
 
77
 
    def test_help_not_hidden(self):
78
 
        c = self.get_command([option.Option('foo', hidden=False)])
79
 
        self.assertContainsRe(c.get_help_text(), '--foo')
80
 
 
81
 
 
82
 
class TestGetAlias(tests.TestCase):
 
60
 
 
61
class TestGetAlias(TestCase):
83
62
 
84
63
    def _get_config(self, config_text):
85
64
        my_config = config.GlobalConfig()
114
93
            u"iam=whoami 'Erik B\u00e5gfors <erik@bagfors.nu>'\n")
115
94
        self.assertEqual([u'whoami', u'Erik B\u00e5gfors <erik@bagfors.nu>'],
116
95
                          commands.get_alias("iam", config=my_config))
117
 
 
118
 
 
119
 
class TestSeeAlso(tests.TestCase):
120
 
    """Tests for the see also functional of Command."""
121
 
 
122
 
    def test_default_subclass_no_see_also(self):
123
 
        class ACommand(commands.Command):
124
 
            """A sample command."""
125
 
        command = ACommand()
126
 
        self.assertEqual([], command.get_see_also())
127
 
 
128
 
    def test__see_also(self):
129
 
        """When _see_also is defined, it sets the result of get_see_also()."""
130
 
        class ACommand(commands.Command):
131
 
            _see_also = ['bar', 'foo']
132
 
        command = ACommand()
133
 
        self.assertEqual(['bar', 'foo'], command.get_see_also())
134
 
 
135
 
    def test_deduplication(self):
136
 
        """Duplicates in _see_also are stripped out."""
137
 
        class ACommand(commands.Command):
138
 
            _see_also = ['foo', 'foo']
139
 
        command = ACommand()
140
 
        self.assertEqual(['foo'], command.get_see_also())
141
 
 
142
 
    def test_sorted(self):
143
 
        """_see_also is sorted by get_see_also."""
144
 
        class ACommand(commands.Command):
145
 
            _see_also = ['foo', 'bar']
146
 
        command = ACommand()
147
 
        self.assertEqual(['bar', 'foo'], command.get_see_also())
148
 
 
149
 
    def test_additional_terms(self):
150
 
        """Additional terms can be supplied and are deduped and sorted."""
151
 
        class ACommand(commands.Command):
152
 
            _see_also = ['foo', 'bar']
153
 
        command = ACommand()
154
 
        self.assertEqual(['bar', 'foo', 'gam'],
155
 
            command.get_see_also(['gam', 'bar', 'gam']))
156
 
 
157
 
 
158
 
class TestRegisterLazy(tests.TestCase):
159
 
 
160
 
    def setUp(self):
161
 
        tests.TestCase.setUp(self)
162
 
        import bzrlib.tests.fake_command
163
 
        del sys.modules['bzrlib.tests.fake_command']
164
 
        global lazy_command_imported
165
 
        lazy_command_imported = False
166
 
 
167
 
    @staticmethod
168
 
    def remove_fake():
169
 
        commands.plugin_cmds.remove('fake')
170
 
 
171
 
    def assertIsFakeCommand(self, cmd_obj):
172
 
        from bzrlib.tests.fake_command import cmd_fake
173
 
        self.assertIsInstance(cmd_obj, cmd_fake)
174
 
 
175
 
    def test_register_lazy(self):
176
 
        """Ensure lazy registration works"""
177
 
        commands.plugin_cmds.register_lazy('cmd_fake', [],
178
 
                                           'bzrlib.tests.fake_command')
179
 
        self.addCleanup(self.remove_fake)
180
 
        self.assertFalse(lazy_command_imported)
181
 
        fake_instance = commands.get_cmd_object('fake')
182
 
        self.assertTrue(lazy_command_imported)
183
 
        self.assertIsFakeCommand(fake_instance)
184
 
 
185
 
    def test_get_unrelated_does_not_import(self):
186
 
        commands.plugin_cmds.register_lazy('cmd_fake', [],
187
 
                                           'bzrlib.tests.fake_command')
188
 
        self.addCleanup(self.remove_fake)
189
 
        commands.get_cmd_object('status')
190
 
        self.assertFalse(lazy_command_imported)
191
 
 
192
 
    def test_aliases(self):
193
 
        commands.plugin_cmds.register_lazy('cmd_fake', ['fake_alias'],
194
 
                                           'bzrlib.tests.fake_command')
195
 
        self.addCleanup(self.remove_fake)
196
 
        fake_instance = commands.get_cmd_object('fake_alias')
197
 
        self.assertIsFakeCommand(fake_instance)
198
 
 
199
 
 
200
 
class TestExtendCommandHook(tests.TestCase):
201
 
 
202
 
    def test_fires_on_get_cmd_object(self):
203
 
        # The extend_command(cmd) hook fires when commands are delivered to the
204
 
        # ui, not simply at registration (because lazy registered plugin
205
 
        # commands are registered).
206
 
        # when they are simply created.
207
 
        hook_calls = []
208
 
        commands.Command.hooks.install_named_hook(
209
 
            "extend_command", hook_calls.append, None)
210
 
        # create a command, should not fire
211
 
        class ACommand(commands.Command):
212
 
            """A sample command."""
213
 
        cmd = ACommand()
214
 
        self.assertEqual([], hook_calls)
215
 
        # -- as a builtin
216
 
        # register the command class, should not fire
217
 
        try:
218
 
            builtins.cmd_test_extend_command_hook = ACommand
219
 
            self.assertEqual([], hook_calls)
220
 
            # and ask for the object, should fire
221
 
            cmd = commands.get_cmd_object('test-extend-command-hook')
222
 
            # For resilience - to ensure all code paths hit it - we
223
 
            # fire on everything returned in the 'cmd_dict', which is currently
224
 
            # all known commands, so assert that cmd is in hook_calls
225
 
            self.assertSubset([cmd], hook_calls)
226
 
            del hook_calls[:]
227
 
        finally:
228
 
            del builtins.cmd_test_extend_command_hook
229
 
        # -- as a plugin lazy registration
230
 
        try:
231
 
            # register the command class, should not fire
232
 
            commands.plugin_cmds.register_lazy('cmd_fake', [],
233
 
                                               'bzrlib.tests.fake_command')
234
 
            self.assertEqual([], hook_calls)
235
 
            # and ask for the object, should fire
236
 
            cmd = commands.get_cmd_object('fake')
237
 
            self.assertEqual([cmd], hook_calls)
238
 
        finally:
239
 
            commands.plugin_cmds.remove('fake')