~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_plugins.py

• browse files at revision 4011.6.1
• compare with another revision
• download diff
• download tarball
• view history from revision 4011.6.1

• reverse the comparison (4011.6.1 to 3763.8.1)
• stop comparing with revision 3763.8.1

Show diffs side-by-side

added

removed

bzrlib/tests/test_plugins.py

193

193

                del bzrlib.plugins.ts_plugin

194

194

        self.failIf(getattr(bzrlib.plugins, 'ts_plugin', None))

195

195

 

196

 

    def test_plugin_with_bad_name_does_not_load(self):

197

 

        # Create badly-named plugin

198

 

        file('bzr-bad plugin-name..py', 'w').close()

199

 

 

 

196

    def load_and_capture(self, name):

 

197

        """Load plugins from '.' capturing the output.

 

198

        

 

199

        :param name: The name of the plugin.

 

200

        :return: A string with the log from the plugin loading call.

 

201

        """

200

202

        # Capture output

201

203

        stream = StringIO()

202

 

        handler = logging.StreamHandler(stream)

203

 

        log = logging.getLogger('bzr')

204

 

        log.addHandler(handler)

205

 

 

206

 

        bzrlib.plugin.load_from_dir('.')

207

 

 

208

 

        # Stop capturing output

209

 

        handler.flush()

210

 

        handler.close()

211

 

        log.removeHandler(handler)

212

 

 

213

 

        self.assertContainsRe(stream.getvalue(),

 

204

        try:

 

205

            handler = logging.StreamHandler(stream)

 

206

            log = logging.getLogger('bzr')

 

207

            log.addHandler(handler)

 

208

            try:

 

209

                try:

 

210

                    bzrlib.plugin.load_from_path(['.'])

 

211

                finally:

 

212

                    if 'bzrlib.plugins.%s' % name in sys.modules:

 

213

                        del sys.modules['bzrlib.plugins.%s' % name]

 

214

                    if getattr(bzrlib.plugins, name, None):

 

215

                        delattr(bzrlib.plugins, name)

 

216

            finally:

 

217

                # Stop capturing output

 

218

                handler.flush()

 

219

                handler.close()

 

220

                log.removeHandler(handler)

 

221

            return stream.getvalue()

 

222

        finally:

 

223

            stream.close()

 

224

    

 

225

    def test_plugin_with_bad_api_version_reports(self):

 

226

        # This plugin asks for bzrlib api version 1.0.0, which is not supported

 

227

        # anymore.

 

228

        name = 'wants100.py'

 

229

        f = file(name, 'w')

 

230

        try:

 

231

            f.write("import bzrlib.api\n"

 

232

                "bzrlib.api.require_any_api(bzrlib, [(1, 0, 0)])\n")

 

233

        finally:

 

234

            f.close()

 

235

 

 

236

        log = self.load_and_capture(name)

 

237

        self.assertContainsRe(log,

 

238

            r"It requested API version")

 

239

 

 

240

    def test_plugin_with_bad_name_does_not_load(self):

 

241

        # The file name here invalid for a python module.

 

242

        name = 'bzr-bad plugin-name..py'

 

243

        file(name, 'w').close()

 

244

        log = self.load_and_capture(name)

 

245

        self.assertContainsRe(log,

214

246

            r"Unable to load 'bzr-bad plugin-name\.' in '\.' as a plugin "

215

247

            "because the file path isn't a valid module name; try renaming "

216

248

            "it to 'bad_plugin_name_'\.")

217

249

 

218

 

        stream.close()

219

 

 

220

250

 

221

251

class TestPlugins(TestCaseInTempDir):

222

252

 

323

353

        plugin = bzrlib.plugin.plugins()['plugin']

324

354

        self.assertEqual("unknown", plugin.__version__)

325

355

 

326

 

    def test___version__with_version_info(self):

 

356

    def test_str__version__with_version_info(self):

 

357

        self.setup_plugin("version_info = '1.2.3'")

 

358

        plugin = bzrlib.plugin.plugins()['plugin']

 

359

        self.assertEqual("1.2.3", plugin.__version__)

 

360

 

 

361

    def test_noniterable__version__with_version_info(self):

 

362

        self.setup_plugin("version_info = (1)")

 

363

        plugin = bzrlib.plugin.plugins()['plugin']

 

364

        self.assertEqual("1", plugin.__version__)

 

365

 

 

366

    def test_1__version__with_version_info(self):

 

367

        self.setup_plugin("version_info = (1,)")

 

368

        plugin = bzrlib.plugin.plugins()['plugin']

 

369

        self.assertEqual("1", plugin.__version__)

 

370

 

 

371

    def test_1_2__version__with_version_info(self):

 

372

        self.setup_plugin("version_info = (1, 2)")

 

373

        plugin = bzrlib.plugin.plugins()['plugin']

 

374

        self.assertEqual("1.2", plugin.__version__)

 

375

 

 

376

    def test_1_2_3__version__with_version_info(self):

 

377

        self.setup_plugin("version_info = (1, 2, 3)")

 

378

        plugin = bzrlib.plugin.plugins()['plugin']

 

379

        self.assertEqual("1.2.3", plugin.__version__)

 

380

 

 

381

    def test_candidate__version__with_version_info(self):

 

382

        self.setup_plugin("version_info = (1, 2, 3, 'candidate', 1)")

 

383

        plugin = bzrlib.plugin.plugins()['plugin']

 

384

        self.assertEqual("1.2.3rc1", plugin.__version__)

 

385

 

 

386

    def test_dev__version__with_version_info(self):

 

387

        self.setup_plugin("version_info = (1, 2, 3, 'dev', 0)")

 

388

        plugin = bzrlib.plugin.plugins()['plugin']

 

389

        self.assertEqual("1.2.3dev", plugin.__version__)

 

390

 

 

391

    def test_dev_fallback__version__with_version_info(self):

327

392

        self.setup_plugin("version_info = (1, 2, 3, 'dev', 4)")

328

393

        plugin = bzrlib.plugin.plugins()['plugin']

329

 

        self.assertEqual("1.2.3dev4", plugin.__version__)

 

394

        self.assertEqual("1.2.3.dev.4", plugin.__version__)

330

395

 

331

396

    def test_final__version__with_version_info(self):

332

 

        self.setup_plugin("version_info = (1, 2, 3, 'final', 4)")

 

397

        self.setup_plugin("version_info = (1, 2, 3, 'final', 0)")

333

398

        plugin = bzrlib.plugin.plugins()['plugin']

334

399

        self.assertEqual("1.2.3", plugin.__version__)

335

400

 

339

404

    def split_help_commands(self):

340

405

        help = {}

341

406

        current = None

342

 

        for line in self.run_bzr('help commands')[0].splitlines():

 

407

        out, err = self.run_bzr('--no-plugins help commands')

 

408

        for line in out.splitlines():

343

409

            if not line.startswith(' '):

344

410

                current = line.split()[0]

345

411

            help[current] = help.get(current, '') + line

382

448

            self.assertContainsRe(help, '\[myplug\]')

383

449

        finally:

384

450

            # unregister command

385

 

            if bzrlib.commands.plugin_cmds.get('myplug', None):

386

 

                del bzrlib.commands.plugin_cmds['myplug']

 

451

            if 'myplug' in bzrlib.commands.plugin_cmds:

 

452

                bzrlib.commands.plugin_cmds.remove('myplug')

387

453

            # remove the plugin 'myplug'

388

454

            if getattr(bzrlib.plugins, 'myplug', None):

389

455

                delattr(bzrlib.plugins, 'myplug')

564

630

        mod = FakeModule('two lines of help\nand more', 'bzrlib.plugins.foo_bar')

565

631

        topic = plugin.ModuleHelpTopic(mod)

566

632

        self.assertEqual('foo_bar', topic.get_help_topic())

 

633

 

 

634

 

 

635

def clear_plugins(test_case):

 

636

    # Save the attributes that we're about to monkey-patch.

 

637

    old_plugins_path = bzrlib.plugins.__path__

 

638

    old_loaded = plugin._loaded

 

639

    old_load_from_path = plugin.load_from_path

 

640

    # Change bzrlib.plugin to think no plugins have been loaded yet.

 

641

    bzrlib.plugins.__path__ = []

 

642

    plugin._loaded = False

 

643

    # Monkey-patch load_from_path to stop it from actually loading anything.

 

644

    def load_from_path(dirs):

 

645

        pass

 

646

    plugin.load_from_path = load_from_path

 

647

    def restore_plugins():

 

648

        bzrlib.plugins.__path__ = old_plugins_path

 

649

        plugin._loaded = old_loaded

 

650

        plugin.load_from_path = old_load_from_path

 

651

    test_case.addCleanup(restore_plugins)

 

652

 

 

653

 

 

654

class TestPluginPaths(tests.TestCase):

 

655

 

 

656

    def test_set_plugins_path_with_args(self):

 

657

        clear_plugins(self)

 

658

        plugin.set_plugins_path(['a', 'b'])

 

659

        self.assertEqual(['a', 'b'], bzrlib.plugins.__path__)

 

660

 

 

661

    def test_set_plugins_path_defaults(self):

 

662

        clear_plugins(self)

 

663

        plugin.set_plugins_path()

 

664

        self.assertEqual(plugin.get_standard_plugins_path(),

 

665

                         bzrlib.plugins.__path__)

 

666

 

 

667

    def test_get_standard_plugins_path(self):

 

668

        path = plugin.get_standard_plugins_path()

 

669

        self.assertEqual(plugin.get_default_plugin_path(), path[0])

 

670

        for directory in path:

 

671

            self.assertNotContainsRe(r'\\/$', directory)

 

672

        try:

 

673

            from distutils.sysconfig import get_python_lib

 

674

        except ImportError:

 

675

            pass

 

676

        else:

 

677

            if sys.platform != 'win32':

 

678

                python_lib = get_python_lib()

 

679

                for directory in path:

 

680

                    if directory.startswith(python_lib):

 

681

                        break

 

682

                else:

 

683

                    self.fail('No path to global plugins')

 

684

 

 

685

    def test_get_standard_plugins_path_env(self):

 

686

        os.environ['BZR_PLUGIN_PATH'] = 'foo/'

 

687

        self.assertEqual('foo', plugin.get_standard_plugins_path()[0])

 

688

 

 

689

 

 

690

class TestLoadPlugins(tests.TestCaseInTempDir):

 

691

 

 

692

    def test_load_plugins(self):

 

693

        clear_plugins(self)

 

694

        plugin.load_plugins(['.'])

 

695

        self.assertEqual(bzrlib.plugins.__path__, ['.'])

 

696

        # subsequent loads are no-ops

 

697

        plugin.load_plugins(['foo'])

 

698

        self.assertEqual(bzrlib.plugins.__path__, ['.'])

 

699

 

 

700

    def test_load_plugins_default(self):

 

701

        clear_plugins(self)

 

702

        plugin.load_plugins()

 

703

        path = plugin.get_standard_plugins_path()

 

704

        self.assertEqual(path, bzrlib.plugins.__path__)

• Older »

Loggerhead is a web-based interface for Breezy
Version: 2.0.1