# 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 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


from unittest import TestResult, TestCase


class TestBase(TestCase):
    """Base class for bzr test cases.

    Just defines some useful helper functions; doesn't actually test
    anything.
    """
    # TODO: Special methods to invoke bzr
    
    def runcmd(self, cmd, expected=0):
        self.log('$ ' + ' '.join(cmd))
        from os import spawnvp, P_WAIT
        rc = spawnvp(P_WAIT, cmd[0], cmd)
        if rc != expected:
            self.fail("command %r returned status %d" % (cmd, rc))


    def backtick(self, cmd):
        """Run a command and return its output"""
        from os import popen
        self.log('$ ' + ' '.join(cmd))
        pipe = popen(cmd)
        out = ''
        while True:
            buf = pipe.read()
            if buf:
                out += buf
            else:
                break
        rc = pipe.close()
        if rc:
            self.fail("command %r returned status %d" % (cmd, rc))
        else:
            return out
            

    def log(self, msg):
        """Log a message to a progress file"""
        print >>TEST_LOG, msg
               



class _MyResult(TestResult):
    """
    Custom TestResult.

    No special behaviour for now.
    """
#     def startTest(self, test):
#         print str(test).ljust(50),
#         TestResult.startTest(self, test)

#     def stopTest(self, test):
#         print
#         TestResult.stopTest(self, test)


    pass




def selftest():
    from unittest import TestLoader, TestSuite
    import bzrlib
    import bzrlib.whitebox
    import bzrlib.blackbox
    from doctest import DocTestSuite
    import os
    import shutil
    import time

    _setup_test_log()
    _setup_test_dir()

    suite = TestSuite()
    tl = TestLoader()

    for m in bzrlib.whitebox, bzrlib.blackbox:
        suite.addTest(tl.loadTestsFromModule(m))

    for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
            bzrlib.commands:
        suite.addTest(DocTestSuite(m))

    result = _MyResult()
    suite.run(result)

    _show_results(result)

    return result.wasSuccessful()


def _setup_test_log():
    import time
    import os
    
    global TEST_LOG
    log_filename = os.path.abspath('testbzr.log')
    TEST_LOG = open(log_filename, 'wt', buffering=1) # line buffered

    print >>TEST_LOG, "bzr tests run at " + time.ctime()
    print '%-30s %s' % ('test log', log_filename)


def _setup_test_dir():
    import os
    import shutil
    
    global ORIG_DIR, TEST_DIR
    ORIG_DIR = os.getcwdu()
    TEST_DIR = os.path.abspath("testbzr.tmp")

    print '%-30s %s' % ('running tests in', TEST_DIR)

    if os.path.exists(TEST_DIR):
        shutil.rmtree(TEST_DIR)
    os.mkdir(TEST_DIR)
    os.chdir(TEST_DIR)    

    

def _show_results(result):
     for case, tb in result.errors:
         _show_test_failure('ERROR', case, tb)

     for case, tb in result.failures:
         _show_test_failure('FAILURE', case, tb)
         
     print
     print '%4d tests run' % result.testsRun
     print '%4d errors' % len(result.errors)
     print '%4d failures' % len(result.failures)



def _show_test_failure(kind, case, tb):
     print (kind + '! ').ljust(60, '-')
     print case
     print tb
     print ''.ljust(60, '-')