/brz/remove-bazaar

# Copyright (C) 2006, 2007 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

"""Tests for remote bzrdir/branch/repo/etc

These are proxy objects which act on remote objects by sending messages

through a smart client.  The proxies are to be created when attempting to open

the object given a transport that supports smartserver rpc operations. 

"""

from cStringIO import StringIO

from bzrlib import (

    bzrdir,

    errors,

    remote,

    tests,

    )

from bzrlib.branch import Branch

from bzrlib.bzrdir import BzrDir, BzrDirFormat

from bzrlib.remote import (

    RemoteBranch,

    RemoteBzrDir,

    RemoteBzrDirFormat,

    RemoteRepository,

    )

from bzrlib.revision import NULL_REVISION

from bzrlib.smart import server

from bzrlib.smart.client import SmartClient

from bzrlib.transport import remote as remote_transport

from bzrlib.transport.memory import MemoryTransport

class BasicRemoteObjectTests(tests.TestCaseWithTransport):

    def setUp(self):

        super(BasicRemoteObjectTests, self).setUp()

        self.transport_server = server.SmartTCPServer_for_testing

        self.transport = self.get_transport()

        self.client = self.transport.get_smart_client()

        # make a branch that can be opened over the smart transport

        self.local_wt = BzrDir.create_standalone_workingtree('.')

    def test_create_remote_bzrdir(self):

        b = remote.RemoteBzrDir(self.transport)

        self.assertIsInstance(b, BzrDir)

    def test_open_remote_branch(self):

        # open a standalone branch in the working directory

        b = remote.RemoteBzrDir(self.transport)

        branch = b.open_branch()

    def test_remote_repository(self):

        b = BzrDir.open_from_transport(self.transport)

        repo = b.open_repository()

        revid = u'\xc823123123'

        self.assertFalse(repo.has_revision(revid))

        self.local_wt.commit(message='test commit', rev_id=revid)

        self.assertTrue(repo.has_revision(revid))

    def test_remote_branch_revision_history(self):

        b = BzrDir.open_from_transport(self.transport).open_branch()

        self.assertEqual([], b.revision_history())

        r1 = self.local_wt.commit('1st commit')

        r2 = self.local_wt.commit('1st commit', rev_id=u'\xc8')

        self.assertEqual([r1, r2], b.revision_history())

    def test_find_correct_format(self):

        """Should open a RemoteBzrDir over a RemoteTransport"""

        fmt = BzrDirFormat.find_format(self.transport)

        self.assertTrue(RemoteBzrDirFormat in BzrDirFormat._control_formats)

        self.assertIsInstance(fmt, remote.RemoteBzrDirFormat)

    def test_open_detected_smart_format(self):

        fmt = BzrDirFormat.find_format(self.transport)

        d = fmt.open(self.transport)

        self.assertIsInstance(d, BzrDir)

class FakeProtocol(object):

    """Lookalike SmartClientRequestProtocolOne allowing body reading tests."""

    def __init__(self, body):

        self._body_buffer = StringIO(body)

    def read_body_bytes(self, count=-1):

        return self._body_buffer.read(count)

class FakeClient(SmartClient):

    """Lookalike for SmartClient allowing testing."""

    def __init__(self, responses):

        # We don't call the super init because there is no medium.

        """create a FakeClient.

        :param respones: A list of response-tuple, body-data pairs to be sent

            back to callers.

        """

        self.responses = responses

        self._calls = []

    def call(self, method, *args):

        self._calls.append(('call', method, args))

        return self.responses.pop(0)[0]

    def call2(self, method, *args):

        self._calls.append(('call2', method, args))

        result = self.responses.pop(0)

        return result[0], FakeProtocol(result[1])

class TestBranchLastRevisionInfo(tests.TestCase):

    def test_empty_branch(self):

        # in an empty branch we decode the response properly

        client = FakeClient([(('ok', '0', ''), )])

        transport = MemoryTransport()

        transport.mkdir('quack')

        transport = transport.clone('quack')

        # we do not want bzrdir to make any remote calls

        bzrdir = RemoteBzrDir(transport, _client=False)

        branch = RemoteBranch(bzrdir, None, _client=client)

        result = branch.last_revision_info()

        self.assertEqual(

            [('call', 'Branch.last_revision_info', ('///quack/',))],

            client._calls)

        self.assertEqual((0, NULL_REVISION), result)

    def test_non_empty_branch(self):

        # in a non-empty branch we also decode the response properly

        client = FakeClient([(('ok', '2', u'\xc8'.encode('utf8')), )])

        transport = MemoryTransport()

        transport.mkdir('kwaak')

        transport = transport.clone('kwaak')

        # we do not want bzrdir to make any remote calls

        bzrdir = RemoteBzrDir(transport, _client=False)

        branch = RemoteBranch(bzrdir, None, _client=client)

        result = branch.last_revision_info()

        self.assertEqual(

            [('call', 'Branch.last_revision_info', ('///kwaak/',))],

            client._calls)

        self.assertEqual((2, u'\xc8'), result)

class TestBranchSetLastRevision(tests.TestCase):

    def test_set_empty(self):

        # set_revision_history([]) is translated to calling

        # Branch.set_last_revision(path, '') on the wire.

        client = FakeClient([(('ok',), )])

        transport = MemoryTransport()

        transport.mkdir('branch')

        transport = transport.clone('branch')

        bzrdir = RemoteBzrDir(transport, _client=False)

        branch = RemoteBranch(bzrdir, None, _client=client)

        result = branch.set_revision_history([])

        self.assertEqual(

            [('call', 'Branch.set_last_revision', ('///branch/', ''))],

            client._calls)

        self.assertEqual(None, result)

    def test_set_nonempty(self):

        # set_revision_history([rev-id1, ..., rev-idN]) is translated to calling

        # Branch.set_last_revision(path, rev-idN) on the wire.

        client = FakeClient([(('ok',), )])

        transport = MemoryTransport()

        transport.mkdir('branch')

        transport = transport.clone('branch')

        bzrdir = RemoteBzrDir(transport, _client=False)

        branch = RemoteBranch(bzrdir, None, _client=client)

        result = branch.set_revision_history(['rev-id1', 'rev-id2'])

        self.assertEqual(

            [('call', 'Branch.set_last_revision', ('///branch/', 'rev-id2'))],

            client._calls)

        self.assertEqual(None, result)

    def test_no_such_revision(self):

        # A response of 'NoSuchRevision' is translated into an exception.

        client = FakeClient([(('NoSuchRevision', 'rev-id'), )])

        transport = MemoryTransport()

        transport.mkdir('branch')

        transport = transport.clone('branch')

        bzrdir = RemoteBzrDir(transport, _client=False)

        branch = RemoteBranch(bzrdir, None, _client=client)

        self.assertRaises(

            errors.NoSuchRevision, branch.set_revision_history, ['rev-id'])

class TestBranchControlGetBranchConf(tests.TestCase):

    """Test branch.control_files api munging...

    we special case RemoteBranch.control_files.get('branch.conf') to

    call a specific API so that RemoteBranch's can intercept configuration

    file reading, allowing them to signal to the client about things like

    'email is configured for commits'.

    """

    def test_get_branch_conf(self):

        # in an empty branch we decode the response properly

        client = FakeClient([(('ok', ), 'config file body')])

        transport = MemoryTransport()

        transport.mkdir('quack')

        transport = transport.clone('quack')

        # we do not want bzrdir to make any remote calls

        bzrdir = RemoteBzrDir(transport, _client=False)

        branch = RemoteBranch(bzrdir, None, _client=client)

        result = branch.control_files.get('branch.conf')

        self.assertEqual(

            [('call2', 'Branch.get_config_file', ('///quack/',))],

            client._calls)

        self.assertEqual('config file body', result.read())

class TestRemoteRepository(tests.TestCase):

    def setup_fake_client_and_repository(self, responses, transport_path):

        """Create the fake client and repository for testing with."""

        client = FakeClient(responses)

        transport = MemoryTransport()

        transport.mkdir(transport_path)

        transport = transport.clone(transport_path)

        # we do not want bzrdir to make any remote calls

        bzrdir = RemoteBzrDir(transport, _client=False)

        repo = RemoteRepository(bzrdir, None, _client=client)

        return repo, client

class TestRepositoryGatherStats(TestRemoteRepository):

    def test_revid_none(self):

        # ('ok',), body with revisions and size

        responses = [(('ok', ), 'revisions: 2\nsize: 18\n')]

        transport_path = 'quack'

        repo, client = self.setup_fake_client_and_repository(

            responses, transport_path)

        result = repo.gather_stats(None)

        self.assertEqual(

            [('call2', 'Repository.gather_stats', ('///quack/','','no'))],

            client._calls)

        self.assertEqual({'revisions': 2, 'size': 18}, result)

    def test_revid_no_committers(self):

        # ('ok',), body without committers

        responses = [(('ok', ),

                      'firstrev: 123456.300 3600\n'

                      'latestrev: 654231.400 0\n'

                      'revisions: 2\n'

                      'size: 18\n')]

        transport_path = 'quick'

        revid = u'\xc8'

        repo, client = self.setup_fake_client_and_repository(

            responses, transport_path)

        result = repo.gather_stats(revid)

        self.assertEqual(

            [('call2', 'Repository.gather_stats',

              ('///quick/', revid.encode('utf8'), 'no'))],

            client._calls)

        self.assertEqual({'revisions': 2, 'size': 18,

                          'firstrev': (123456.300, 3600),

                          'latestrev': (654231.400, 0),},

                         result)

    def test_revid_with_committers(self):

        # ('ok',), body with committers

        responses = [(('ok', ),

                      'committers: 128\n'

                      'firstrev: 123456.300 3600\n'

                      'latestrev: 654231.400 0\n'

                      'revisions: 2\n'

                      'size: 18\n')]

        transport_path = 'buick'

        revid = u'\xc8'

        repo, client = self.setup_fake_client_and_repository(

            responses, transport_path)

        result = repo.gather_stats(revid, True)

        self.assertEqual(

            [('call2', 'Repository.gather_stats',

              ('///buick/', revid.encode('utf8'), 'yes'))],

            client._calls)

        self.assertEqual({'revisions': 2, 'size': 18,

                          'committers': 128,

                          'firstrev': (123456.300, 3600),

                          'latestrev': (654231.400, 0),},

                         result)

class TestRepositoryGetRevisionGraph(TestRemoteRepository):

    def test_null_revision(self):

        # a null revision has the predictable result {}, we should have no wire

        # traffic when calling it with this argument

        responses = [(('notused', ), '')]

        transport_path = 'empty'

        repo, client = self.setup_fake_client_and_repository(

            responses, transport_path)

        result = repo.get_revision_graph(NULL_REVISION)

        self.assertEqual([], client._calls)

        self.assertEqual({}, result)

    def test_none_revision(self):

        # with none we want the entire graph

        r1 = u'\u0e33'

        r2 = u'\u0dab'

        lines = [' '.join([r2, r1]), r1]

        encoded_body = '\n'.join(lines).encode('utf8')

        responses = [(('ok', ), encoded_body)]

        transport_path = 'sinhala'

        repo, client = self.setup_fake_client_and_repository(

            responses, transport_path)

        result = repo.get_revision_graph()

        self.assertEqual(

            [('call2', 'Repository.get_revision_graph', ('///sinhala/', ''))],

            client._calls)

        self.assertEqual({r1: [], r2: [r1]}, result)

    def test_specific_revision(self):

        # with a specific revision we want the graph for that

        # with none we want the entire graph

        r11 = u'\u0e33'

        r12 = u'\xc9'

        r2 = u'\u0dab'

        lines = [' '.join([r2, r11, r12]), r11, r12]

        encoded_body = '\n'.join(lines).encode('utf8')

        responses = [(('ok', ), encoded_body)]

        transport_path = 'sinhala'

        repo, client = self.setup_fake_client_and_repository(

            responses, transport_path)

        result = repo.get_revision_graph(r2)

        self.assertEqual(

            [('call2', 'Repository.get_revision_graph', ('///sinhala/', r2.encode('utf8')))],

            client._calls)

        self.assertEqual({r11: [], r12: [], r2: [r11, r12], }, result)

    def test_no_such_revision(self):

        revid = '123'

        responses = [(('nosuchrevision', revid), '')]

        transport_path = 'sinhala'

        repo, client = self.setup_fake_client_and_repository(

            responses, transport_path)

        # also check that the right revision is reported in the error

        self.assertRaises(errors.NoSuchRevision,

            repo.get_revision_graph, revid)

        self.assertEqual(

            [('call2', 'Repository.get_revision_graph', ('///sinhala/', revid))],

            client._calls)

class TestRepositoryIsShared(TestRemoteRepository):

    def test_is_shared(self):

        # ('yes', ) for Repository.is_shared -> 'True'.

        responses = [(('yes', ), )]

        transport_path = 'quack'

        repo, client = self.setup_fake_client_and_repository(

            responses, transport_path)

        result = repo.is_shared()

        self.assertEqual(

            [('call', 'Repository.is_shared', ('///quack/',))],

            client._calls)

        self.assertEqual(True, result)

    def test_is_not_shared(self):

        # ('no', ) for Repository.is_shared -> 'False'.

        responses = [(('no', ), )]

        transport_path = 'qwack'

        repo, client = self.setup_fake_client_and_repository(

            responses, transport_path)

        result = repo.is_shared()

        self.assertEqual(

            [('call', 'Repository.is_shared', ('///qwack/',))],

            client._calls)

        self.assertEqual(False, result)

class TestRepositoryLockWrite(TestRemoteRepository):

    def test_lock_write(self):

        responses = [(('ok', 'a token'), '')]

        transport_path = 'quack'

        repo, client = self.setup_fake_client_and_repository(

            responses, transport_path)

        result = repo.lock_write()

        self.assertEqual(

            [('call', 'Repository.lock_write', ('///quack/',))],

            client._calls)

        self.assertEqual('a token', result)

    def test_lock_write_already_locked(self):

        responses = [(('LockContention', ), '')]

        transport_path = 'quack'

        repo, client = self.setup_fake_client_and_repository(

            responses, transport_path)

        self.assertRaises(errors.LockContention, repo.lock_write)

        self.assertEqual(

            [('call', 'Repository.lock_write', ('///quack/',))],

            client._calls)

class TestRepositoryUnlock(TestRemoteRepository):

    def test_unlock(self):

        responses = [(('ok', 'a token'), ''),

                     (('ok',), '')]

        transport_path = 'quack'

        repo, client = self.setup_fake_client_and_repository(

            responses, transport_path)

        repo.lock_write()

        repo.unlock()

        self.assertEqual(

            [('call', 'Repository.lock_write', ('///quack/',)),

             ('call', 'Repository.unlock', ('///quack/', 'a token'))],

            client._calls)

    def test_unlock_wrong_token(self):

        # If somehow the token is wrong, unlock will raise TokenMismatch.

        responses = [(('ok', 'a token'), ''),

                     (('TokenMismatch',), '')]

        transport_path = 'quack'

        repo, client = self.setup_fake_client_and_repository(

            responses, transport_path)

        repo.lock_write()

        self.assertRaises(errors.TokenMismatch, repo.unlock)