/brz/remove-bazaar

# Copyright (C) 2006 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 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 of the bzr serve command."""

import os

import signal

import subprocess

import threading

from bzrlib import errors

from bzrlib.branch import Branch

from bzrlib.bzrdir import BzrDir

from bzrlib.errors import ParamikoNotPresent

from bzrlib.tests import TestCaseWithTransport, TestSkipped

from bzrlib.transport import get_transport, smart

class DoesNotCloseStdOutClient(smart.SmartStreamClient):

    """A client that doesn't close stdout upon disconnect().

    We wish to let stdout remain open so that we can see if the server writes

    anything to stdout during its shutdown.

    """

    def disconnect(self):

        if self._connected:

            self._connected = False

            # The client's out is the server's in.

            self._out.close()

class TestBzrServe(TestCaseWithTransport):

    def assertInetServerShutsdownCleanly(self, client, process):

        """Shutdown the server process looking for errors."""

        # Disconnect the client forcefully JUST IN CASE because of __del__'s use

        # in the smart module.

        client.disconnect()

        # Shutdown the server: the client should have disconnected cleanly and

        # closed stdin, so the server process should shut itself down.

        self.assertTrue(process.stdin.closed)

        # Hide stdin from the subprocess module, so it won't fail to close it.

        process.stdin = None

        result = self.finish_bzr_subprocess(process, retcode=0)

        self.assertEqual('', result[0])

        self.assertEqual('', result[1])

    def assertServerFinishesCleanly(self, process):

        """Shutdown the bzr serve instance process looking for errors."""

        # Shutdown the server

        result = self.finish_bzr_subprocess(process, retcode=3,

                                            send_signal=signal.SIGINT)

        self.assertEqual('', result[0])

        self.assertEqual('bzr: interrupted\n', result[1])

    def start_server_inet(self, extra_options=()):

        """Start a bzr server subprocess using the --inet option.

        :param extra_options: extra options to give the server.

        :return: a tuple with the bzr process handle for passing to

            finish_bzr_subprocess, a client for the server, and a transport.

        """

        # Serve from the current directory

        process = self.start_bzr_subprocess(['serve', '--inet'])

        # Connect to the server

        # We use this url because while this is no valid URL to connect to this

        # server instance, the transport needs a URL.

        client = DoesNotCloseStdOutClient(

            lambda: (process.stdout, process.stdin))

        transport = smart.SmartTransport('bzr://localhost/', client=client)

        return process, client, transport

    def start_server_port(self, extra_options=()):

        """Start a bzr server subprocess.

        :param extra_options: extra options to give the server.

        :return: a tuple with the bzr process handle for passing to

            finish_bzr_subprocess, and the base url for the server.

        """

        # Serve from the current directory

        args = ['serve', '--port', 'localhost:0']

        args.extend(extra_options)

        process = self.start_bzr_subprocess(args, skip_if_plan_to_signal=True)

        port_line = process.stdout.readline()

        prefix = 'listening on port: '

        self.assertStartsWith(port_line, prefix)

        port = int(port_line[len(prefix):])

        return process,'bzr://localhost:%d/' % port

    def test_bzr_serve_inet_readonly(self):

        """bzr server should provide a read only filesystem by default."""

        process, client, transport = self.start_server_inet()

        self.assertRaises(errors.TransportNotPossible, transport.mkdir, 'adir')

        # finish with the transport

        del transport

        self.assertInetServerShutsdownCleanly(client, process)

    def test_bzr_serve_inet_readwrite(self):

        # Make a branch

        self.make_branch('.')

        process, client, transport = self.start_server_inet(['--allow-writes'])

        # We get a working branch

        branch = BzrDir.open_from_transport(transport).open_branch()

        branch.repository.get_revision_graph()

        self.assertEqual(None, branch.last_revision())

        # finish with the transport

        del transport

        self.assertInetServerShutsdownCleanly(client, process)

    def test_bzr_serve_port_readonly(self):

        """bzr server should provide a read only filesystem by default."""

        process, url = self.start_server_port()

        transport = get_transport(url)

        self.assertRaises(errors.TransportNotPossible, transport.mkdir, 'adir')

        self.assertServerFinishesCleanly(process)

    def test_bzr_serve_port_readwrite(self):

        # Make a branch

        self.make_branch('.')

        process, url = self.start_server_port(['--allow-writes'])

        # Connect to the server

        branch = Branch.open(url)

        # We get a working branch

        branch.repository.get_revision_graph()

        self.assertEqual(None, branch.last_revision())

        self.assertServerFinishesCleanly(process)

    def test_bzr_serve_no_args(self):

        """'bzr serve' with no arguments or options should not traceback."""

        out, err = self.run_bzr_error(

            ['bzr serve requires one of --inet or --port'], 'serve')

    def test_bzr_connect_to_bzr_ssh(self):

        """User acceptance that get_transport of a bzr+ssh:// behaves correctly.

        bzr+ssh:// should cause bzr to run a remote bzr smart server over SSH.

        """

        try:

            from bzrlib.transport.sftp import SFTPServer

        except ParamikoNotPresent:

            raise TestSkipped('Paramiko not installed')

        from bzrlib.tests.stub_sftp import StubServer

        # Make a branch

        self.make_branch('a_branch')

        # Start an SSH server

        # XXX: This is horrible -- we define a really dumb SSH server that

        # executes commands, and manage the hooking up of stdin/out/err to the

        # SSH channel ourselves.  Surely this has already been implemented

        # elsewhere?

        class StubSSHServer(StubServer):

            test = self

            def check_channel_exec_request(self, channel, command):

                self.test.command_executed = command

                proc = subprocess.Popen(

                    command, shell=True, stdin=subprocess.PIPE,

                    stdout=subprocess.PIPE, stderr=subprocess.PIPE)

                # XXX: horribly inefficient, not to mention ugly.

                def do_stdin():

                    # copy bytes from the channel to the subprocess's stdin

                    while True:

                        bytes = channel.recv(1)

                        if bytes == '':

                            proc.stdin.close()

                            break

                        proc.stdin.write(bytes)

                        proc.stdin.flush()

                threading.Thread(target=do_stdin).start()

                def ferry_bytes(pipe):

                    while True:

                        bytes = pipe.read(1)

                        if bytes == '':

                            channel.close()

                            break

                        channel.sendall(bytes)

                threading.Thread(target=ferry_bytes, args=(proc.stdout,)).start()

                threading.Thread(target=ferry_bytes, args=(proc.stderr,)).start()

                return True

        ssh_server = SFTPServer(StubSSHServer)

        # XXX: We *don't* want to override the default SSH vendor, so we set

        # _vendor to what _get_ssh_vendor returns.

        ssh_server.setUp()

        self.addCleanup(ssh_server.tearDown)

        port = ssh_server._listener.port

        # Access the branch via a bzr+ssh URL.  The BZR_REMOTE_PATH environment

        # variable is used to tell bzr what command to run on the remote end.

        path_to_branch = os.path.abspath('a_branch')

        orig_bzr_remote_path = os.environ.get('BZR_REMOTE_PATH')

        os.environ['BZR_REMOTE_PATH'] = self.get_bzr_path()

        try:

            branch = Branch.open(

                'bzr+ssh://fred:secret@localhost:%d%s' % (port, path_to_branch))

            branch.repository.get_revision_graph()

            self.assertEqual(None, branch.last_revision())

            # Check we can perform write operations

            branch.bzrdir.root_transport.mkdir('foo')

        finally:

            # Restore the BZR_REMOTE_PATH environment variable back to its

            # original state.

            if orig_bzr_remote_path is None:

                del os.environ['BZR_REMOTE_PATH']

            else:

                os.environ['BZR_REMOTE_PATH'] = orig_bzr_remote_path

        self.assertEqual(

            '%s serve --inet --directory=/ --allow-writes'

            % self.get_bzr_path(),

            self.command_executed)