/brz/remove-bazaar

# Copyright (C) 2005 by Canonical Ltd

#

# This program is free software; you can redistribute it and/or modify

# it under the terms of the GNU General Public License version 2 as published by

# the Free Software Foundation.

#

# 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

"""Tests for the test framework

"""

import os

import sys

import unittest

import warnings

import bzrlib

from bzrlib.tests import (

                          _load_module_by_name,

                          ChrootedTestCase,

                          TestCase,

                          TestCaseInTempDir,

                          TestCaseWithTransport,

                          TestSkipped,

                          TextTestRunner,

                          )

import bzrlib.errors as errors

class SelftestTests(TestCase):

    def test_import_tests(self):

        mod = _load_module_by_name('bzrlib.tests.test_selftest')

        self.assertEqual(mod.SelftestTests, SelftestTests)

    def test_import_test_failure(self):

        self.assertRaises(ImportError,

                          _load_module_by_name,

                          'bzrlib.no-name-yet')

class MetaTestLog(TestCase):

    def test_logging(self):

        """Test logs are captured when a test fails."""

        self.log('a test message')

        self._log_file.flush()

        self.assertContainsRe(self._get_log(), 'a test message\n')

class TestTreeShape(TestCaseInTempDir):

    def test_unicode_paths(self):

        filename = u'hell\u00d8'

        try:

            self.build_tree_contents([(filename, 'contents of hello')])

        except UnicodeEncodeError:

            raise TestSkipped("can't build unicode working tree in "

                "filesystem encoding %s" % sys.getfilesystemencoding())

        self.failUnlessExists(filename)

class TestSkippedTest(TestCase):

    """Try running a test which is skipped, make sure it's reported properly."""

    def test_skipped_test(self):

        # must be hidden in here so it's not run as a real test

        def skipping_test():

            raise TestSkipped('test intentionally skipped')

        runner = TextTestRunner(stream=self._log_file)

        test = unittest.FunctionTestCase(skipping_test)

        result = runner.run(test)

        self.assertTrue(result.wasSuccessful())

class TestTransportProviderAdapter(TestCase):

    """A group of tests that test the transport implementation adaption core.

    This is a meta test that the tests are applied to all available 

    transports.

    This will be generalised in the future which is why it is in this 

    test file even though it is specific to transport tests at the moment.

    """

    def test_get_transport_permutations(self):

        # this checks that we the module get_test_permutations call

        # is made by the adapter get_transport_test_permitations method.

        class MockModule(object):

            def get_test_permutations(self):

                return sample_permutation

        sample_permutation = [(1,2), (3,4)]

        from bzrlib.transport import TransportTestProviderAdapter

        adapter = TransportTestProviderAdapter()

        self.assertEqual(sample_permutation,

                         adapter.get_transport_test_permutations(MockModule()))

    def test_adapter_checks_all_modules(self):

        # this checks that the adapter returns as many permurtations as

        # there are in all the registered# transport modules for there

        # - we assume if this matches its probably doing the right thing

        # especially in combination with the tests for setting the right

        # classes below.

        from bzrlib.transport import (TransportTestProviderAdapter,

                                      _get_transport_modules

                                      )

        modules = _get_transport_modules()

        permutation_count = 0

        for module in modules:

            try:

                permutation_count += len(reduce(getattr, 

                    (module + ".get_test_permutations").split('.')[1:],

                     __import__(module))())

            except errors.DependencyNotPresent:

                pass

        input_test = TestTransportProviderAdapter(

            "test_adapter_sets_transport_class")

        adapter = TransportTestProviderAdapter()

        self.assertEqual(permutation_count,

                         len(list(iter(adapter.adapt(input_test)))))

    def test_adapter_sets_transport_class(self):

        # when the adapter adapts a test it needs to 

        # place one of the permutations from the transport

        # providers in each test case copy. This checks

        # that it does not just use the same one all the time.

        # and that the id is set correctly so that debugging is

        # easy.

        # 

        # An instance of this test is actually used as the input

        # for adapting it to all the available transports

        # (or i think so - ??? mbp)

        from bzrlib.transport.local import (LocalTransport,

                                            LocalRelpathServer,

                                            LocalAbspathServer,

                                            LocalURLServer

                                            )

        try:

            from bzrlib.transport.sftp import (SFTPTransport,

                                               SFTPAbsoluteServer,

                                               SFTPHomeDirServer,

                                               SFTPSiblingAbsoluteServer,

                                               )

        except errors.ParamikoNotPresent, e:

            warnings.warn(str(e))

            has_paramiko = False

        else:

            has_paramiko = True

        from bzrlib.transport.http import (HttpTransport,

                                           HttpServer

                                           )

        from bzrlib.transport.ftp import FtpTransport

        from bzrlib.transport.memory import (MemoryTransport,

                                             MemoryServer

                                             )

        from bzrlib.transport import TransportTestProviderAdapter

        # FIXME. What we want is a factory for the things

        # needed to test the implementation. I.e. for transport we want:

        # the class that connections should get; a local server factory

        # so we would want the following permutations:

        # LocalTransport relpath-factory

        # LocalTransport abspath-factory

        # LocalTransport file://-factory

        # SFTPTransport homedir-factory

        # SFTPTransport abssolute-factory

        # HTTPTransport http-factory

        # HTTPTransport https-factory

        # etc, but we are currently lacking in this, so print out that

        # this should be fixed.

        input_test = TestTransportProviderAdapter(

            "test_adapter_sets_transport_class")

        suite = TransportTestProviderAdapter().adapt(input_test)

        # tests are generated in collation order. 

        # XXX: but i'm not sure the order should really be part of the 

        # contract of the adapter, should it -- mbp 20060201

        test_iter = iter(suite)

        http_test = test_iter.next()

        local_relpath_test = test_iter.next()

        local_abspath_test = test_iter.next()

        local_urlpath_test = test_iter.next()

        memory_test = test_iter.next()

        readonly_test = test_iter.next()

        if has_paramiko:

            sftp_abs_test = test_iter.next()

            sftp_homedir_test = test_iter.next()

            sftp_sibling_abs_test = test_iter.next()

        # ftp_test = test_iter.next()

        # should now be at the end of the test

        self.assertRaises(StopIteration, test_iter.next)

        self.assertEqual(LocalTransport, local_relpath_test.transport_class)

        self.assertEqual(LocalRelpathServer, local_relpath_test.transport_server)

        self.assertEqual(LocalTransport, local_abspath_test.transport_class)

        self.assertEqual(LocalAbspathServer, local_abspath_test.transport_server)

        self.assertEqual(LocalTransport, local_urlpath_test.transport_class)

        self.assertEqual(LocalURLServer, local_urlpath_test.transport_server)

        if has_paramiko:

            self.assertEqual(SFTPTransport, sftp_abs_test.transport_class)

            self.assertEqual(SFTPAbsoluteServer, sftp_abs_test.transport_server)

            self.assertEqual(SFTPTransport, sftp_homedir_test.transport_class)

            self.assertEqual(SFTPHomeDirServer, sftp_homedir_test.transport_server)

            self.assertEqual(SFTPTransport, sftp_sibling_abs_test.transport_class)

            self.assertEqual(SFTPSiblingAbsoluteServer,

                             sftp_sibling_abs_test.transport_server)

        self.assertEqual(HttpTransport, http_test.transport_class)

        self.assertEqual(HttpServer, http_test.transport_server)

        # self.assertEqual(FtpTransport, ftp_test.transport_class)

        self.assertEqual(MemoryTransport, memory_test.transport_class)

        self.assertEqual(MemoryServer, memory_test.transport_server)

        # we could test all of them for .id, but two is probably sufficient.

        self.assertEqual("bzrlib.tests.test_selftest."

                         "TestTransportProviderAdapter."

                         "test_adapter_sets_transport_class(MemoryServer)",

                         memory_test.id())

        self.assertEqual("bzrlib.tests.test_selftest."

                         "TestTransportProviderAdapter."

                         "test_adapter_sets_transport_class(LocalRelpathServer)",

                         local_relpath_test.id())

class TestBranchProviderAdapter(TestCase):

    """A group of tests that test the branch implementation test adapter."""

    def test_adapted_tests(self):

        # check that constructor parameters are passed through to the adapted

        # test.

        from bzrlib.branch import BranchTestProviderAdapter

        input_test = TestBranchProviderAdapter(

            "test_adapted_tests")

        server1 = "a"

        server2 = "b"

        formats = ["c", "d"]

        adapter = BranchTestProviderAdapter(server1, server2, formats)

        suite = adapter.adapt(input_test)

        tests = list(iter(suite))

        self.assertEqual(2, len(tests))

        self.assertEqual(tests[0].branch_format, formats[0])

        self.assertEqual(tests[0].transport_server, server1)

        self.assertEqual(tests[0].transport_readonly_server, server2)

        self.assertEqual(tests[1].branch_format, formats[1])

        self.assertEqual(tests[1].transport_server, server1)

        self.assertEqual(tests[1].transport_readonly_server, server2)

class TestTestCaseWithTransport(TestCaseWithTransport):

    """Tests for the convenience functions TestCaseWithTransport introduces."""

    def test_get_readonly_url_none(self):

        from bzrlib.transport import get_transport

        from bzrlib.transport.memory import MemoryServer

        from bzrlib.transport.readonly import ReadonlyTransportDecorator

        self.transport_server = MemoryServer

        self.transport_readonly_server = None

        # calling get_readonly_transport() constructs a decorator on the url

        # for the server

        url = self.get_readonly_url()

        url2 = self.get_readonly_url('foo/bar')

        t = get_transport(url)

        t2 = get_transport(url2)

        self.failUnless(isinstance(t, ReadonlyTransportDecorator))

        self.failUnless(isinstance(t2, ReadonlyTransportDecorator))

        self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))

    def test_get_readonly_url_http(self):

        from bzrlib.transport import get_transport

        from bzrlib.transport.local import LocalRelpathServer

        from bzrlib.transport.http import HttpServer, HttpTransport

        self.transport_server = LocalRelpathServer

        self.transport_readonly_server = HttpServer

        # calling get_readonly_transport() gives us a HTTP server instance.

        url = self.get_readonly_url()

        url2 = self.get_readonly_url('foo/bar')

        t = get_transport(url)

        t2 = get_transport(url2)

        self.failUnless(isinstance(t, HttpTransport))

        self.failUnless(isinstance(t2, HttpTransport))

        self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))

class TestChrootedTest(ChrootedTestCase):

    def test_root_is_root(self):

        from bzrlib.transport import get_transport

        t = get_transport(self.get_readonly_url())

        url = t.base

        self.assertEqual(url, t.clone('..').base)