/brz/remove-bazaar

# Copyright (C) 2005, 2006, 2007, 2008 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

# TODO: Perhaps there should be an API to find out if bzr running under the

# test suite -- some plugins might want to avoid making intrusive changes if

# this is the case.  However, we want behaviour under to test to diverge as

# little as possible, so this should be used rarely if it's added at all.

# (Suggestion from j-a-meinel, 2005-11-24)

# NOTE: Some classes in here use camelCaseNaming() rather than

# underscore_naming().  That's for consistency with unittest; it's not the

# general style of bzrlib.  Please continue that consistency when adding e.g.

# new assertFoo() methods.

import atexit

import codecs

from cStringIO import StringIO

import difflib

import doctest

import errno

import logging

import os

from pprint import pformat

import random

import re

import shlex

import stat

from subprocess import Popen, PIPE

import sys

import tempfile

import threading

import time

import unittest

import warnings

from bzrlib import (

    branchbuilder,

    bzrdir,

    debug,

    errors,

    memorytree,

    osutils,

    progress,

    ui,

    urlutils,

    registry,

    workingtree,

    )

import bzrlib.branch

import bzrlib.commands

import bzrlib.timestamp

import bzrlib.export

import bzrlib.inventory

import bzrlib.iterablefile

import bzrlib.lockdir

try:

    import bzrlib.lsprof

except ImportError:

    # lsprof not available

    pass

from bzrlib.merge import merge_inner

import bzrlib.merge3

import bzrlib.plugin

import bzrlib.plugins

import bzrlib.store

from bzrlib import symbol_versioning

from bzrlib.symbol_versioning import (

    DEPRECATED_PARAMETER,

    deprecated_function,

    deprecated_method,

    deprecated_passed,

    )

import bzrlib.trace

from bzrlib.transport import get_transport

import bzrlib.transport

from bzrlib.transport.local import LocalURLServer

from bzrlib.transport.memory import MemoryServer

from bzrlib.transport.readonly import ReadonlyServer

from bzrlib.trace import mutter, note

from bzrlib.tests import TestUtil

from bzrlib.tests.http_server import HttpServer

from bzrlib.tests.TestUtil import (

                          TestSuite,

                          TestLoader,

                          )

from bzrlib.tests.treeshape import build_tree_contents

import bzrlib.version_info_formats.format_custom

from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2

# Mark this python module as being part of the implementation

# of unittest: this gives us better tracebacks where the last

# shown frame is the test code, not our assertXYZ.

__unittest = 1

default_transport = LocalURLServer

class ExtendedTestResult(unittest._TextTestResult):

    """Accepts, reports and accumulates the results of running tests.

    Compared to the unittest version this class adds support for

    profiling, benchmarking, stopping as soon as a test fails,  and

    skipping tests.  There are further-specialized subclasses for

    different types of display.

    When a test finishes, in whatever way, it calls one of the addSuccess,

    addFailure or addError classes.  These in turn may redirect to a more

    specific case for the special test results supported by our extended

    tests.

    Note that just one of these objects is fed the results from many tests.

    """

    stop_early = False

    def __init__(self, stream, descriptions, verbosity,

                 bench_history=None,

                 num_tests=None,

                 ):

        """Construct new TestResult.

        :param bench_history: Optionally, a writable file object to accumulate

            benchmark results.

        """

        unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)

        if bench_history is not None:

            from bzrlib.version import _get_bzr_source_tree

            src_tree = _get_bzr_source_tree()

            if src_tree:

                try:

                    revision_id = src_tree.get_parent_ids()[0]

                except IndexError:

                    # XXX: if this is a brand new tree, do the same as if there

                    # is no branch.

                    revision_id = ''

            else:

                # XXX: If there's no branch, what should we do?

                revision_id = ''

            bench_history.write("--date %s %s\n" % (time.time(), revision_id))

        self._bench_history = bench_history

        self.ui = ui.ui_factory

        self.num_tests = num_tests

        self.error_count = 0

        self.failure_count = 0

        self.known_failure_count = 0

        self.skip_count = 0

        self.not_applicable_count = 0

        self.unsupported = {}

        self.count = 0

        self._overall_start_time = time.time()

    def _extractBenchmarkTime(self, testCase):

        """Add a benchmark time for the current test case."""

        return getattr(testCase, "_benchtime", None)

    def _elapsedTestTimeString(self):

        """Return a time string for the overall time the current test has taken."""

        return self._formatTime(time.time() - self._start_time)

    def _testTimeString(self, testCase):

        benchmark_time = self._extractBenchmarkTime(testCase)

        if benchmark_time is not None:

            return "%s/%s" % (

                self._formatTime(benchmark_time),

                self._elapsedTestTimeString())

        else:

            return "           %s" % self._elapsedTestTimeString()

    def _formatTime(self, seconds):

        """Format seconds as milliseconds with leading spaces."""

        # some benchmarks can take thousands of seconds to run, so we need 8

        # places

        return "%8dms" % (1000 * seconds)

    def _shortened_test_description(self, test):

        what = test.id()

        what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)

        return what

    def startTest(self, test):

        unittest.TestResult.startTest(self, test)

        self.report_test_start(test)

        test.number = self.count

        self._recordTestStartTime()

    def _recordTestStartTime(self):

        """Record that a test has started."""

        self._start_time = time.time()

    def _cleanupLogFile(self, test):

        # We can only do this if we have one of our TestCases, not if

        # we have a doctest.

        setKeepLogfile = getattr(test, 'setKeepLogfile', None)

        if setKeepLogfile is not None:

            setKeepLogfile()

    def addError(self, test, err):

        """Tell result that test finished with an error.

        Called from the TestCase run() method when the test

        fails with an unexpected error.

        """

        self._testConcluded(test)

        if isinstance(err[1], TestSkipped):

            return self._addSkipped(test, err)

        elif isinstance(err[1], UnavailableFeature):

            return self.addNotSupported(test, err[1].args[0])

        else:

            unittest.TestResult.addError(self, test, err)

            self.error_count += 1

            self.report_error(test, err)

            if self.stop_early:

                self.stop()

            self._cleanupLogFile(test)

    def addFailure(self, test, err):

        """Tell result that test failed.

        Called from the TestCase run() method when the test

        fails because e.g. an assert() method failed.

        """

        self._testConcluded(test)

        if isinstance(err[1], KnownFailure):

            return self._addKnownFailure(test, err)

        else:

            unittest.TestResult.addFailure(self, test, err)

            self.failure_count += 1

            self.report_failure(test, err)

            if self.stop_early:

                self.stop()

            self._cleanupLogFile(test)

    def addSuccess(self, test):

        """Tell result that test completed successfully.

        Called from the TestCase run()

        """

        self._testConcluded(test)

        if self._bench_history is not None:

            benchmark_time = self._extractBenchmarkTime(test)

            if benchmark_time is not None:

                self._bench_history.write("%s %s\n" % (

                    self._formatTime(benchmark_time),

                    test.id()))

        self.report_success(test)

        self._cleanupLogFile(test)

        unittest.TestResult.addSuccess(self, test)

        test._log_contents = ''

    def _testConcluded(self, test):

        """Common code when a test has finished.

        Called regardless of whether it succeded, failed, etc.

        """

        pass

    def _addKnownFailure(self, test, err):

        self.known_failure_count += 1

        self.report_known_failure(test, err)

    def addNotSupported(self, test, feature):

        """The test will not be run because of a missing feature.

        """

        # this can be called in two different ways: it may be that the

        # test started running, and then raised (through addError) 

        # UnavailableFeature.  Alternatively this method can be called

        # while probing for features before running the tests; in that

        # case we will see startTest and stopTest, but the test will never

        # actually run.

        self.unsupported.setdefault(str(feature), 0)

        self.unsupported[str(feature)] += 1

        self.report_unsupported(test, feature)

    def _addSkipped(self, test, skip_excinfo):

        if isinstance(skip_excinfo[1], TestNotApplicable):

            self.not_applicable_count += 1

            self.report_not_applicable(test, skip_excinfo)

        else:

            self.skip_count += 1

            self.report_skip(test, skip_excinfo)

        try:

            test.tearDown()

        except KeyboardInterrupt:

            raise

        except:

            self.addError(test, test._exc_info())

        else:

            # seems best to treat this as success from point-of-view of unittest

            # -- it actually does nothing so it barely matters :)

            unittest.TestResult.addSuccess(self, test)

            test._log_contents = ''

    def printErrorList(self, flavour, errors):

        for test, err in errors:

            self.stream.writeln(self.separator1)

            self.stream.write("%s: " % flavour)

            self.stream.writeln(self.getDescription(test))

            if getattr(test, '_get_log', None) is not None:

                self.stream.write('\n')

                self.stream.write(

                        ('vvvv[log from %s]' % test.id()).ljust(78,'-'))

                self.stream.write('\n')

                self.stream.write(test._get_log())

                self.stream.write('\n')

                self.stream.write(

                        ('^^^^[log from %s]' % test.id()).ljust(78,'-'))

                self.stream.write('\n')

            self.stream.writeln(self.separator2)

            self.stream.writeln("%s" % err)

    def finished(self):

        pass

    def report_cleaning_up(self):

        pass

    def report_success(self, test):

        pass

    def wasStrictlySuccessful(self):

        if self.unsupported or self.known_failure_count:

            return False

        return self.wasSuccessful()

class TextTestResult(ExtendedTestResult):

    """Displays progress and results of tests in text form"""

    def __init__(self, stream, descriptions, verbosity,

                 bench_history=None,

                 num_tests=None,

                 pb=None,

                 ):

        ExtendedTestResult.__init__(self, stream, descriptions, verbosity,

            bench_history, num_tests)

        if pb is None:

            self.pb = self.ui.nested_progress_bar()

            self._supplied_pb = False

        else:

            self.pb = pb

            self._supplied_pb = True

        self.pb.show_pct = False

        self.pb.show_spinner = False

        self.pb.show_eta = False,

        self.pb.show_count = False

        self.pb.show_bar = False

    def report_starting(self):

        self.pb.update('[test 0/%d] starting...' % (self.num_tests))

    def _progress_prefix_text(self):

        # the longer this text, the less space we have to show the test

        # name...

        a = '[%d' % self.count              # total that have been run

        # tests skipped as known not to be relevant are not important enough

        # to show here

        ## if self.skip_count:

        ##     a += ', %d skip' % self.skip_count

        ## if self.known_failure_count:

        ##     a += '+%dX' % self.known_failure_count

        if self.num_tests is not None:

            a +='/%d' % self.num_tests

        a += ' in '

        runtime = time.time() - self._overall_start_time

        if runtime >= 60:

            a += '%dm%ds' % (runtime / 60, runtime % 60)

        else:

            a += '%ds' % runtime

        if self.error_count:

            a += ', %d err' % self.error_count

        if self.failure_count:

            a += ', %d fail' % self.failure_count

        if self.unsupported:

            a += ', %d missing' % len(self.unsupported)

        a += ']'

        return a

    def report_test_start(self, test):

        self.count += 1

        self.pb.update(

                self._progress_prefix_text()

                + ' ' 

                + self._shortened_test_description(test))

    def _test_description(self, test):

        return self._shortened_test_description(test)

    def report_error(self, test, err):

        self.pb.note('ERROR: %s\n    %s\n', 

            self._test_description(test),

            err[1],

            )

    def report_failure(self, test, err):

        self.pb.note('FAIL: %s\n    %s\n', 

            self._test_description(test),

            err[1],

            )

    def report_known_failure(self, test, err):

        self.pb.note('XFAIL: %s\n%s\n',

            self._test_description(test), err[1])

    def report_skip(self, test, skip_excinfo):

        pass

    def report_not_applicable(self, test, skip_excinfo):

        pass

    def report_unsupported(self, test, feature):

        """test cannot be run because feature is missing."""

    def report_cleaning_up(self):

        self.pb.update('cleaning up...')

    def finished(self):

        if not self._supplied_pb:

            self.pb.finished()

class VerboseTestResult(ExtendedTestResult):

    """Produce long output, with one line per test run plus times"""

    def _ellipsize_to_right(self, a_string, final_width):

        """Truncate and pad a string, keeping the right hand side"""

        if len(a_string) > final_width:

            result = '...' + a_string[3-final_width:]

        else:

            result = a_string

        return result.ljust(final_width)

    def report_starting(self):

        self.stream.write('running %d tests...\n' % self.num_tests)

    def report_test_start(self, test):

        self.count += 1

        name = self._shortened_test_description(test)

        # width needs space for 6 char status, plus 1 for slash, plus 2 10-char

        # numbers, plus a trailing blank

        # when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space

        self.stream.write(self._ellipsize_to_right(name,

                          osutils.terminal_width()-30))

        self.stream.flush()

    def _error_summary(self, err):

        indent = ' ' * 4

        return '%s%s' % (indent, err[1])

    def report_error(self, test, err):

        self.stream.writeln('ERROR %s\n%s'

                % (self._testTimeString(test),

                   self._error_summary(err)))

    def report_failure(self, test, err):

        self.stream.writeln(' FAIL %s\n%s'

                % (self._testTimeString(test),

                   self._error_summary(err)))

    def report_known_failure(self, test, err):

        self.stream.writeln('XFAIL %s\n%s'

                % (self._testTimeString(test),

                   self._error_summary(err)))

    def report_success(self, test):

        self.stream.writeln('   OK %s' % self._testTimeString(test))

        for bench_called, stats in getattr(test, '_benchcalls', []):

            self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)

            stats.pprint(file=self.stream)

        # flush the stream so that we get smooth output. This verbose mode is

        # used to show the output in PQM.

        self.stream.flush()

    def report_skip(self, test, skip_excinfo):

        self.stream.writeln(' SKIP %s\n%s'

                % (self._testTimeString(test),

                   self._error_summary(skip_excinfo)))

    def report_not_applicable(self, test, skip_excinfo):

        self.stream.writeln('  N/A %s\n%s'

                % (self._testTimeString(test),

                   self._error_summary(skip_excinfo)))

    def report_unsupported(self, test, feature):

        """test cannot be run because feature is missing."""

        self.stream.writeln("NODEP %s\n    The feature '%s' is not available."

                %(self._testTimeString(test), feature))

class TextTestRunner(object):

    stop_on_failure = False

    def __init__(self,

                 stream=sys.stderr,

                 descriptions=0,

                 verbosity=1,

                 bench_history=None,

                 list_only=False

                 ):

        self.stream = unittest._WritelnDecorator(stream)

        self.descriptions = descriptions

        self.verbosity = verbosity

        self._bench_history = bench_history

        self.list_only = list_only

    def run(self, test):

        "Run the given test case or test suite."

        startTime = time.time()

        if self.verbosity == 1:

            result_class = TextTestResult

        elif self.verbosity >= 2:

            result_class = VerboseTestResult

        result = result_class(self.stream,

                              self.descriptions,

                              self.verbosity,

                              bench_history=self._bench_history,

                              num_tests=test.countTestCases(),

                              )

        result.stop_early = self.stop_on_failure

        result.report_starting()

        if self.list_only:

            if self.verbosity >= 2:

                self.stream.writeln("Listing tests only ...\n")

            run = 0

            for t in iter_suite_tests(test):

                self.stream.writeln("%s" % (t.id()))

                run += 1

            actionTaken = "Listed"

        else: 

            test.run(result)

            run = result.testsRun

            actionTaken = "Ran"

        stopTime = time.time()

        timeTaken = stopTime - startTime

        result.printErrors()

        self.stream.writeln(result.separator2)

        self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,

                            run, run != 1 and "s" or "", timeTaken))

        self.stream.writeln()

        if not result.wasSuccessful():

            self.stream.write("FAILED (")

            failed, errored = map(len, (result.failures, result.errors))

            if failed:

                self.stream.write("failures=%d" % failed)

            if errored:

                if failed: self.stream.write(", ")

                self.stream.write("errors=%d" % errored)

            if result.known_failure_count:

                if failed or errored: self.stream.write(", ")

                self.stream.write("known_failure_count=%d" %

                    result.known_failure_count)

            self.stream.writeln(")")

        else:

            if result.known_failure_count:

                self.stream.writeln("OK (known_failures=%d)" %

                    result.known_failure_count)

            else:

                self.stream.writeln("OK")

        if result.skip_count > 0:

            skipped = result.skip_count

            self.stream.writeln('%d test%s skipped' %

                                (skipped, skipped != 1 and "s" or ""))

        if result.unsupported:

            for feature, count in sorted(result.unsupported.items()):

                self.stream.writeln("Missing feature '%s' skipped %d tests." %

                    (feature, count))

        result.finished()

        return result

def iter_suite_tests(suite):

    """Return all tests in a suite, recursing through nested suites"""

    for item in suite._tests:

        if isinstance(item, unittest.TestCase):

            yield item

        elif isinstance(item, unittest.TestSuite):

            for r in iter_suite_tests(item):

                yield r

        else:

            raise Exception('unknown object %r inside test suite %r'

                            % (item, suite))

class TestSkipped(Exception):

    """Indicates that a test was intentionally skipped, rather than failing."""

class TestNotApplicable(TestSkipped):

    """A test is not applicable to the situation where it was run.

    This is only normally raised by parameterized tests, if they find that 

    the instance they're constructed upon does not support one aspect 

    of its interface.

    """

class KnownFailure(AssertionError):

    """Indicates that a test failed in a precisely expected manner.

    Such failures dont block the whole test suite from passing because they are

    indicators of partially completed code or of future work. We have an

    explicit error for them so that we can ensure that they are always visible:

    KnownFailures are always shown in the output of bzr selftest.

    """

class UnavailableFeature(Exception):

    """A feature required for this test was not available.

    The feature should be used to construct the exception.

    """

class CommandFailed(Exception):

    pass