<?php
//
// +------------------------------------------------------------------------+
// | PEAR :: PHPUnit                                                        |
// +------------------------------------------------------------------------+
// | Copyright (c) 2002-2005 Sebastian Bergmann <sb@sebastian-bergmann.de>. |
// +------------------------------------------------------------------------+
// | This source file is subject to version 3.00 of the PHP License,        |
// | that is available at http://www.php.net/license/3_0.txt.               |
// | If you did not receive a copy of the PHP license and are unable to     |
// | obtain it through the world-wide-web, please send a note to            |
// | license@php.net so we can mail you a copy immediately.                 |
// +------------------------------------------------------------------------+
//
// $Id: TestSuite.php,v 1.2 2009/06/23 13:02:38 ds Exp $
//

require_once 'PHPUnit/TestCase.php';

/**
 * A TestSuite is a Composite of Tests. It runs a collection of test cases.
 *
 * Here is an example using the dynamic test definition.
 *
 * <code>
 * <?php
 * $suite = new PHPUnit_TestSuite();
 * $suite->addTest(new MathTest('testPass'));
 * ?>
 * </code>
 *
 * Alternatively, a TestSuite can extract the tests to be run automatically.
 * To do so you pass the classname of your TestCase class to the TestSuite
 * constructor.
 *
 * <code>
 * <?php
 * $suite = new TestSuite('classname');
 * ?>
 * </code>
 *
 * This constructor creates a suite with all the methods starting with
 * "test" that take no arguments.
 *
 * @author      Sebastian Bergmann <sb@sebastian-bergmann.de>
 * @copyright   Copyright &copy; 2002-2005 Sebastian Bergmann <sb@sebastian-bergmann.de>
 * @license     http://www.php.net/license/3_0.txt The PHP License, Version 3.0
 * @category    Testing
 * @package     PHPUnit
 */
class PHPUnit_TestSuite {
    /**
    * The name of the test suite.
    *
    * @var    string
    * @access private
    */
    var $_name = '';

    /**
    * The tests in the test suite.
    *
    * @var    array
    * @access private
    */
    var $_tests = array();

    /**
    * Constructs a TestSuite.
    *
    * @param  mixed
    * @access public
    */
    function PHPUnit_TestSuite($test = FALSE) {
        if ($test !== FALSE) {
            $this->setName($test);
            $this->addTestSuite($test);
        }
    }

    /**
    * Adds a test to the suite.
    *
    * @param  object
    * @access public
    */
    function addTest(&$test) {
        $this->_tests[] = &$test;
    }

    /**
    * Adds the tests from the given class to the suite.
    *
    * @param  string
    * @access public
    */
    function addTestSuite($testClass) {
        if (class_exists($testClass)) {
            $methods       = get_class_methods($testClass);
            $parentClasses = array(strtolower($testClass));
            $parentClass   = $testClass;

            while(is_string($parentClass = get_parent_class($parentClass))) {
                $parentClasses[] = $parentClass;
            }

            foreach ($methods as $method) {
                if (substr($method, 0, 4) == 'test' &&
                    !in_array($method, $parentClasses)) {
                    $this->addTest(new $testClass($method));
                }
            }
        }
    }

    /**
    * Counts the number of test cases that will be run by this test.
    *
    * @return integer
    * @access public
    */
    function countTestCases() {
        $count = 0;

        foreach ($this->_tests as $test) {
            $count += $test->countTestCases();
        }

        return $count;
    }

    /**
    * Returns the name of the suite.
    *
    * @return string
    * @access public
    */
    function getName() {
        return $this->_name;
    }

    /**
    * Runs the tests and collects their result in a TestResult.
    *
    * @param  object
    * @access public
    */
    function run(&$result) {
        for ($i = 0; $i < sizeof($this->_tests) && !$result->shouldStop(); $i++) {
            $this->_tests[$i]->run($result);
        }
    }

    /**
    * Runs a test.
    *
    * @param  object
    * @param  object
    * @access public
    */
    function runTest(&$test, &$result) {
        $test->run($result);
    }

    /**
    * Sets the name of the suite.
    *
    * @param  string
    * @access public
    */
    function setName($name) {
        $this->_name = $name;
    }

    /**
    * Returns the test at the given index.
    *
    * @param  integer
    * @return object
    * @access public
    */
    function &testAt($index) {
        if (isset($this->_tests[$index])) {
            return $this->_tests[$index];
        } else {
            return FALSE;
        }
    }

    /**
    * Returns the number of tests in this suite.
    *
    * @return integer
    * @access public
    */
    function testCount() {
        return sizeof($this->_tests);
    }

    /**
    * Returns the tests as an enumeration.
    *
    * @return array
    * @access public
    */
    function &tests() {
        return $this->_tests;
    }

    /**
    * Returns a string representation of the test suite.
    *
    * @return string
    * @access public
    */
    function toString() {
        return '';
    }
}
?>
