/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_plugins.py

Merge from mbp.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_plugins.py
17
17
 
18
18
"""Tests for plugins"""
19
19
 
20
 
 
21
 
 
22
 
# **************************************************
23
 
# NOT RUN YET
24
 
# **************************************************
25
 
 
26
 
 
27
 
 
28
 
 
29
 
 
30
 
 
31
 
 
32
 
 
33
 
from bzrlib.selftest import TestCaseInTempDir
34
 
 
 
20
# XXX: There are no plugin tests at the moment because the plugin module
 
21
# affects the global state of the process.  See bzrlib/plugins.py for more
 
22
# comments.
 
23
 
 
24
import os
 
25
 
 
26
import bzrlib.plugin
 
27
import bzrlib.plugins
 
28
from bzrlib.tests import TestCaseInTempDir
35
29
 
36
30
class PluginTest(TestCaseInTempDir):
37
31
    """Create an external plugin and test loading."""
38
 
    def test_plugin_loading(self):
39
 
        import os
40
 
        
41
 
        orig_help = self.backtick('bzr help commands') # No plugins yet
42
 
        os.mkdir('plugin_test')
43
 
        f = open(os.path.join('plugin_test', 'myplug.py'), 'wt')
44
 
        f.write(PLUGIN_TEXT)
45
 
        f.close()
46
 
 
47
 
        newhelp = backtick('bzr help commands')
48
 
        assert newhelp.startswith('You have been overridden\n')
49
 
        # We added a line, but the rest should work
50
 
        assert newhelp[25:] == help
51
 
 
52
 
        assert backtick('bzr commit -m test') == "I'm sorry dave, you can't do that\n"
53
 
 
54
 
        shutil.rmtree('plugin_test')
55
 
 
56
 
 
57
 
 
58
 
 
59
 
#         PLUGIN_TEXT = \
60
 
#         """import bzrlib, bzrlib.commands
61
 
#         class cmd_myplug(bzrlib.commands.Command):
62
 
#             '''Just a simple test plugin.'''
63
 
#             aliases = ['mplg']
64
 
#             def run(self):
65
 
#                 print 'Hello from my plugin'
66
 
#         """
67
 
#         f.close()
 
32
#    def test_plugin_loading(self):
 
33
#        orig_help = self.run_bzr_captured('bzr help commands')[0]
 
34
#        os.mkdir('plugin_test')
 
35
#        f = open(os.path.join('plugin_test', 'myplug.py'), 'wt')
 
36
#        f.write(PLUGIN_TEXT)
 
37
#        f.close()
 
38
#        newhelp = self.run_bzr_captured('bzr help commands')[0]
 
39
#        assert newhelp.startswith('You have been overridden\n')
 
40
#        # We added a line, but the rest should work
 
41
#        assert newhelp[25:] == help
 
42
#
 
43
#        assert backtick('bzr commit -m test') == "I'm sorry dave, you can't do that\n"
 
44
#
 
45
#        shutil.rmtree('plugin_test')
 
46
#
68
47
 
69
48
#         os.environ['BZRPLUGINPATH'] = os.path.abspath('plugin_test')
70
49
#         help = backtick('bzr help commands')
89
68
#             bzrlib.commands.cmd_help.run(self, *args, **kwargs)
90
69
 
91
70
#         """
 
71
 
 
72
PLUGIN_TEXT = """\
 
73
import bzrlib.commands
 
74
class cmd_myplug(bzrlib.commands.Command):
 
75
    '''Just a simple test plugin.'''
 
76
    aliases = ['mplg']
 
77
    def run(self):
 
78
        print 'Hello from my plugin'
 
79
"""
 
80
 
 
81
# TODO: Write a test for plugin decoration of commands.
 
82
 
 
83
class TestOneNamedPluginOnly(TestCaseInTempDir):
 
84
 
 
85
    activeattributes = {}
 
86
 
 
87
    def test_plugins_with_the_same_name_are_not_loaded(self):
 
88
        # This test tests that having two plugins in different
 
89
        # directories does not result in both being loaded.
 
90
        # get a file name we can use which is also a valid attribute
 
91
        # for accessing in activeattributes. - we cannot give import parameters.
 
92
        tempattribute = "0"
 
93
        self.failIf(tempattribute in self.activeattributes)
 
94
        # set a place for the plugins to record their loading, and at the same
 
95
        # time validate that the location the plugins should record to is
 
96
        # valid and correct.
 
97
        bzrlib.tests.test_plugins.TestOneNamedPluginOnly.activeattributes \
 
98
            [tempattribute] = []
 
99
        self.failUnless(tempattribute in self.activeattributes)
 
100
        # create two plugin directories
 
101
        os.mkdir('first')
 
102
        os.mkdir('second')
 
103
        # write a plugin that will record when its loaded in the 
 
104
        # tempattribute list.
 
105
        template = ("from bzrlib.tests.test_plugins import TestOneNamedPluginOnly\n"
 
106
                    "TestOneNamedPluginOnly.activeattributes[%r].append('%s')\n")
 
107
        print >> file(os.path.join('first', 'plugin.py'), 'w'), template % (tempattribute, 'first')
 
108
        print >> file(os.path.join('second', 'plugin.py'), 'w'), template % (tempattribute, 'second')
 
109
        try:
 
110
            bzrlib.plugin.load_from_dirs(['first', 'second'])
 
111
            self.assertEqual(['first'], self.activeattributes[tempattribute])
 
112
        finally:
 
113
            # remove the plugin 'plugin'
 
114
            del self.activeattributes[tempattribute]
 
115
            if getattr(bzrlib.plugins, 'plugin', None):
 
116
                del bzrlib.plugins.plugin
 
117
        self.failIf(getattr(bzrlib.plugins, 'plugin', None))
 
118
 
 
119
 
 
120
class TestAllPlugins(TestCaseInTempDir):
 
121
 
 
122
    def test_plugin_appears_in_all_plugins(self):
 
123
        # This test tests a new plugin appears in bzrlib.plugin.all_plugins().
 
124
        # check the plugin is not loaded already
 
125
        self.failIf(getattr(bzrlib.plugins, 'plugin', None))
 
126
        # write a plugin that _cannot_ fail to load.
 
127
        print >> file('plugin.py', 'w'), ""
 
128
        try:
 
129
            bzrlib.plugin.load_from_dirs(['.'])
 
130
            self.failUnless('plugin' in bzrlib.plugin.all_plugins())
 
131
            self.failUnless(getattr(bzrlib.plugins, 'plugin', None))
 
132
            self.assertEqual(bzrlib.plugin.all_plugins()['plugin'],
 
133
                             bzrlib.plugins.plugin)
 
134
        finally:
 
135
            # remove the plugin 'plugin'
 
136
            if getattr(bzrlib.plugins, 'plugin', None):
 
137
                del bzrlib.plugins.plugin
 
138
        self.failIf(getattr(bzrlib.plugins, 'plugin', None))