# Copyright (C) 2010, 2011 Canonical Ltd # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 2 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA """Tests for how many modules are loaded in executing various commands.""" import os from testtools import content from .. import ( plugins as _mod_plugins, trace, ) from ..controldir import ControlDir from ..bzr.smart import medium from ..transport import remote from . import ( TestCaseWithTransport, ) old_format_modules = [ 'breezy.bzr.knitrepo', 'breezy.bzr.knitpack_repo', 'breezy.plugins.weave_fmt.branch', 'breezy.plugins.weave_fmt.bzrdir', 'breezy.plugins.weave_fmt.repository', 'breezy.plugins.weave_fmt.workingtree', 'breezy.bzr.weave', 'breezy.bzr.weavefile', 'breezy.bzr.xml4', 'breezy.bzr.xml5', 'breezy.bzr.xml6', 'breezy.bzr.xml7', ] class ImportTariffTestCase(TestCaseWithTransport): """Check how many modules are loaded for some representative scenarios. See the Testing Guide in the developer documentation for more explanation. We must respect the setup used by the selftest command regarding plugins. This allows the user to control which plugins are in effect while running these tests and respect the import policies defined here. When failures are encountered for a given plugin, they can generally be addressed by using lazy import or lazy hook registration. """ def setUp(self): self.preserved_env_vars = {} for name in ('BRZ_PLUGIN_PATH', 'BRZ_DISABLE_PLUGINS', 'BRZ_PLUGINS_AT' ): self.preserved_env_vars[name] = os.environ.get(name) super(ImportTariffTestCase, self).setUp() def start_bzr_subprocess_with_import_check(self, args, stderr_file=None): """Run a bzr process and capture the imports. This is fairly expensive because we start a subprocess, so we aim to cover representative rather than exhaustive cases. """ # We use PYTHON_VERBOSE rather than --profile-imports because in # experimentation the profile-imports output seems to not always show # the modules you'd expect; this can be debugged but python -v seems # more likely to always show everything. And we use the environment # variable rather than 'python -v' in the hope it will work even if # bzr is frozen and python is not explicitly specified. -- mbp 20100208 env_changes = dict(PYTHONVERBOSE='1', **self.preserved_env_vars) trace.mutter('Setting env for bzr subprocess: %r', env_changes) kwargs = dict(env_changes=env_changes, allow_plugins=False) if stderr_file: # We don't want to update the whole call chain so we insert stderr # *iff* we need to kwargs['stderr'] = stderr_file return self.start_bzr_subprocess(args, **kwargs) def check_forbidden_modules(self, err, forbidden_imports): """Check for forbidden modules in stderr. :param err: Standard error :param forbidden_imports: List of forbidden modules """ err = err.decode('utf-8') self.addDetail('subprocess_stderr', content.text_content(err)) bad_modules = [] for module_name in forbidden_imports: if err.find("\nimport '%s' " % module_name) != -1: bad_modules.append(module_name) if bad_modules: self.fail("command loaded forbidden modules %r" % (bad_modules,)) def finish_bzr_subprocess_with_import_check(self, process, args, forbidden_imports): """Finish subprocess and check specific modules have not been imported. :param forbidden_imports: List of fully-qualified Python module names that should not be loaded while running this command. """ (out, err) = self.finish_bzr_subprocess(process, universal_newlines=False, process_args=args) self.check_forbidden_modules(err, forbidden_imports) return out, err def run_command_check_imports(self, args, forbidden_imports): """Run bzr ARGS in a subprocess and check its imports. This is fairly expensive because we start a subprocess, so we aim to cover representative rather than exhaustive cases. :param forbidden_imports: List of fully-qualified Python module names that should not be loaded while running this command. """ process = self.start_bzr_subprocess_with_import_check(args) self.finish_bzr_subprocess_with_import_check(process, args, forbidden_imports) class TestImportTariffs(ImportTariffTestCase): """Basic import tariff tests for some common bzr commands""" def test_import_tariffs_working(self): # check some guaranteed-true and false imports to be sure we're # measuring correctly self.make_branch_and_tree('.') self.run_command_check_imports(['st'], ['nonexistentmodulename', 'anothernonexistentmodule']) self.assertRaises(AssertionError, self.run_command_check_imports, ['st'], ['breezy.tree']) def test_simple_local_bzr(self): # 'st' in a default format working tree shouldn't need many modules self.make_branch_and_tree('.', format='bzr') forbidden_modules = [ 'breezy.annotate', 'breezy.atomicfile', 'breezy.bugtracker', 'breezy.bundle.commands', 'breezy.cmd_version_info', 'breezy.externalcommand', 'breezy.filters', 'breezy.hashcache', # foreign branch plugins import the foreign_vcs_registry from # breezy.foreign so it can't be blacklisted 'breezy.gpg', 'breezy.info', 'breezy.bzr.knit', 'breezy.merge3', 'breezy.merge_directive', 'breezy.msgeditor', 'breezy.bzr.remote', 'breezy.rules', 'breezy.sign_my_commits', 'breezy.bzr.smart', 'breezy.bzr.smart.client', 'breezy.bzr.smart.medium', 'breezy.bzr.smart.server', 'breezy.transform', 'breezy.version_info_formats.format_rio', 'breezy.bzr.xml_serializer', 'breezy.bzr.xml8', 'getpass', 'kerberos', 'shutil', 'ssl', 'socket', 'smtplib', 'tarfile', 'termios', 'tty', ] + old_format_modules self.run_command_check_imports(['st'], forbidden_modules) # TODO: similar test for repository-only operations, checking we avoid # loading wt-specific stuff # # See https://bugs.launchpad.net/bzr/+bug/553017 def test_simple_local_git(self): # 'st' in a default format working tree shouldn't need many modules self.make_branch_and_tree('.', format='git') from dulwich import __version__ as dulwich_version if dulwich_version >= (0, 20, 4): forbidden = ['shutil', 'tempfile', 'ssl'] elif PY3: forbidden = ['ssl'] else: forbidden = [] self.run_command_check_imports(['st'], [ 'breezy.annotate', 'breezy.bugtracker', 'breezy.bundle.commands', 'breezy.cmd_version_info', 'breezy.externalcommand', 'breezy.filters', 'breezy.hashcache', # foreign branch plugins import the foreign_vcs_registry from # breezy.foreign so it can't be blacklisted 'breezy.gpg', 'breezy.info', 'breezy.bzr.knit', 'breezy.merge', 'breezy.merge3', 'breezy.merge_directive', 'breezy.msgeditor', 'breezy.bzr.remote', 'breezy.rules', 'breezy.sign_my_commits', 'breezy.bzr.smart', 'breezy.bzr.smart.client', 'breezy.bzr.smart.medium', 'breezy.bzr.smart.server', 'breezy.transform', 'breezy.version_info_formats.format_rio', 'breezy.bzr.xml_serializer', 'breezy.bzr.xml8', 'breezy.bzr.inventory', 'breezy.bzr.bzrdir', 'breezy.git.remote', 'breezy.git.commit', 'getpass', 'kerberos', 'smtplib', 'tarfile', 'termios', 'tty', ] + old_format_modules + forbidden) def test_help_commands(self): # See https://bugs.launchpad.net/bzr/+bug/663773 self.run_command_check_imports(['help', 'commands'], [ 'testtools', ]) def test_simple_serve(self): # 'serve' in a default format working tree shouldn't need many modules tree = self.make_branch_and_tree('.') # Capture the bzr serve process' stderr in a file to avoid deadlocks # while the smart client interacts with it. stderr_file = open('bzr-serve.stderr', 'w') process = self.start_bzr_subprocess_with_import_check(['serve', '--inet', '-d', tree.basedir], stderr_file=stderr_file) url = 'bzr://localhost/' self.permit_url(url) client_medium = medium.SmartSimplePipesClientMedium( process.stdout, process.stdin, url) transport = remote.RemoteTransport(url, medium=client_medium) branch = ControlDir.open_from_transport(transport).open_branch() process.stdin.close() # Hide stdin from the subprocess module, so it won't fail to close it. process.stdin = None (out, err) = self.finish_bzr_subprocess(process, universal_newlines=False) stderr_file.close() with open('bzr-serve.stderr', 'rb') as stderr_file: err = stderr_file.read() self.check_forbidden_modules(err, ['breezy.annotate', 'breezy.atomicfile', 'breezy.bugtracker', 'breezy.bundle.commands', 'breezy.cmd_version_info', 'breezy.bzr.dirstate', 'breezy.bzr._dirstate_helpers_py', 'breezy.bzr._dirstate_helpers_pyx', 'breezy.externalcommand', 'breezy.filters', 'breezy.hashcache', # foreign branch plugins import the foreign_vcs_registry from # breezy.foreign so it can't be blacklisted 'breezy.gpg', 'breezy.info', 'breezy.bzr.knit', 'breezy.merge3', 'breezy.merge_directive', 'breezy.msgeditor', 'breezy.bzr.remote', 'breezy.rules', 'breezy.sign_my_commits', 'breezy.bzr.smart.client', 'breezy.transform', 'breezy.version_info_formats.format_rio', 'breezy.bzr.workingtree_4', 'breezy.bzr.xml_serializer', 'breezy.bzr.xml8', 'getpass', 'kerberos', 'smtplib', 'tarfile', 'tempfile', 'termios', 'tty', ] + old_format_modules)