← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/selftest/plugins.py

  • Committer: Aaron Bentley
  • Date: 2005-09-19 02:52:24 UTC
  • mto: (1185.1.29)
  • mto: This revision was merged to the branch mainline in revision 1390.
  • Revision ID: aaron.bentley@utoronto.ca-20050919025224-1cc3c70640086e09
TODO re tests

Show diffs side-by-side

added added

removed removed

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