Modules

Kohana_Unittest_Tests

This class is a transparent base class for Unittest_Tests and should not be accessed directly.

PHPUnit testsuite for kohana application

package: Kohana/UnitTest
author: Kohana Team; BRMatt; Paul Banks
copyright: © 2008-2009 Kohana Team
license: http://kohanaphp.com/license

Class declared in MODPATH/unittest/classes/Kohana/Unittest/Tests.php on line 13.

Constants

None

Properties

$cache

Propertieslink to this

protected static $cachelink to this

array(0)

Methodslink to this

public static addTests( Unittest_TestSuite $suite , array $files ) (defined in Kohana_Unittest_Tests) link to this

Add files to test suite $suite

Uses recursion to scan subdirectories

Parameters

Unittest_TestSuite $suite required - The test suite to add to
array $files required - Array of files to test

Source Code

?
static function addTests(Unittest_TestSuite $suite, array $files)
{
 
    foreach ($files as $path => $file)
    {
        if (is_array($file))
        {
            if ($path != 'tests'.DIRECTORY_SEPARATOR.'test_data')
            {                   
                self::addTests($suite, $file);
            }
        }
        else
        {
            // Make sure we only include php files
            if (is_file($file) AND substr($file, -strlen(EXT)) === EXT)
            {
                // The default PHPUnit TestCase extension
                if ( ! strpos($file, 'TestCase'.EXT))
                {
                    $suite->addTestFile($file);
                }
                else
                {
                    require_once($file);
                }
 
                $suite->addFileToBlacklist($file);
            }
        }
    }
}

public static autoload( $class ) (defined in Kohana_Unittest_Tests) link to this

Loads test files if they cannot be found by kohana

Parameters

$class required - $class

Source Code

?
static function autoload($class)
{
    $file = str_replace('_', '/', $class);
 
    if ($file = Kohana::find_file('tests', $file))
    {
        require_once $file;
    }
}

public static blacklist( array $blacklist_items [, Unittest_TestSuite $suite = NULL ] ) (defined in Kohana_Unittest_Tests) link to this

Blacklist a set of files in PHPUnit code coverage

Parameters

array $blacklist_items required - A set of files to blacklist
Unittest_TestSuite $suite = NULL - The test suite

Source Code

?
static public function blacklist(array $blacklist_items, Unittest_TestSuite $suite = NULL)
{
    foreach ($blacklist_items as $item)
    {
        if (is_dir($item))
        {
            $suite->addDirectoryToBlacklist($item);
        }
        else
        {
            $suite->addFileToBlacklist($item);
        }
    }
}

public static configure_environment( ) (defined in Kohana_Unittest_Tests) link to this

Configures the environment for testing

Does the following:

Loads the phpunit framework (for the web ui)
Restores exception phpunit error handlers (for cli)
registeres an autoloader to load test files

Source Code

?
static public function configure_environment($do_whitelist = TRUE, $do_blacklist = TRUE)
{
    restore_exception_handler();
    restore_error_handler();
 
    spl_autoload_register(array('Unittest_tests', 'autoload'));
 
    Unittest_tests::$cache = (($cache = Kohana::cache('unittest_whitelist_cache')) === NULL) ? array() : $cache;
 
}

public static suite( ) (defined in Kohana_Unittest_Tests) link to this

Creates the test suite for kohana

Return Values

Unittest_TestSuite

Source Code

?
static function suite()
{
    static $suite = NULL;
 
    if ($suite instanceof PHPUnit_Framework_TestSuite)
    {
        return $suite;
    }
 
    Unittest_Tests::configure_environment();
 
    $suite = new Unittest_TestSuite;
     
    // Load the whitelist and blacklist for code coverage       
    $config = Kohana::$config->load('unittest');
     
    if ($config->use_whitelist)
    {
        Unittest_Tests::whitelist(NULL, $suite);
    }
     
    if (count($config['blacklist']))
    {
        Unittest_Tests::blacklist($config->blacklist, $suite);
    }
 
    // Add tests
    $files = Kohana::list_files('tests');
    self::addTests($suite, $files);
 
    return $suite;
}

public static whitelist( [ array $directories = NULL , Unittest_Testsuite $suite = NULL ] ) (defined in Kohana_Unittest_Tests) link to this

Sets the whitelist

If no directories are provided then the function'll load the whitelist set in the config file

Parameters

array $directories = NULL - Optional directories to whitelist
Unittest_Testsuite $suite = NULL - Suite to load the whitelist into

Source Code

?
static public function whitelist(array $directories = NULL, Unittest_TestSuite $suite = NULL)
{
    if (empty($directories))
    {
        $directories = self::get_config_whitelist();
    }
 
    if (count($directories))
    {
        foreach ($directories as & $directory)
        {
            $directory = realpath($directory).'/';
        }
 
        // Only whitelist the "top" files in the cascading filesystem
        self::set_whitelist(Kohana::list_files('classes', $directories), $suite);
    }
}

protected static get_config_whitelist( ) (defined in Kohana_Unittest_Tests) link to this

Works out the whitelist from the config Used only on the CLI

Source Code

?
static protected function get_config_whitelist()
{
    $config = Kohana::$config->load('unittest');
    $directories = array();
 
    if ($config->whitelist['app'])
    {
        $directories['k_app'] = APPPATH;
    }
 
    if ($modules = $config->whitelist['modules'])
    {
        $k_modules = Kohana::modules();
 
        // Have to do this because kohana merges config...
        // If you want to include all modules & override defaults then TRUE must be the first
        // value in the modules array of your app/config/unittest file
        if (array_search(TRUE, $modules, TRUE) === (count($modules) - 1))
        {
            $modules = $k_modules;
        }
        elseif (array_search(FALSE, $modules, TRUE) === FALSE)
        {
            $modules = array_intersect_key($k_modules, array_combine($modules, $modules));
        }
        else
        {
            // modules are disabled
            $modules = array();
        }
 
        $directories += $modules;
    }
 
    if ($config->whitelist['system'])
    {
        $directories['k_sys'] = SYSPATH;
    }
 
    return $directories;
}

protected static set_whitelist( array $files [, Unittest_TestSuite $suite = NULL ] ) (defined in Kohana_Unittest_Tests) link to this

Recursively whitelists an array of files

Parameters

array $files required - Array of files to whitelist
Unittest_TestSuite $suite = NULL - Suite to load the whitelist into

Source Code

?
static protected function set_whitelist($files, Unittest_TestSuite $suite = NULL)
{
 
    foreach ($files as $file)
    {
        if (is_array($file))
        {
            self::set_whitelist($file, $suite);
        }
        else
        {
            if ( ! isset(Unittest_tests::$cache[$file]))
            {
                $relative_path = substr($file, strrpos($file, 'classes'.DIRECTORY_SEPARATOR) + 8, -strlen(EXT));
                $cascading_file = Kohana::find_file('classes', $relative_path);
 
                // The theory is that if this file is the highest one in the cascading filesystem
                // then it's safe to whitelist
                Unittest_tests::$cache[$file] =  ($cascading_file === $file);
            }
 
            if (Unittest_tests::$cache[$file])
            {
                if (isset($suite))
                {
                    $suite->addFileToWhitelist($file);
                }
                else
                {
                    PHPUnit_Util_Filter::addFileToWhitelist($file);
                }
            }
        }
    }
}

Modules

Kohana_Unittest_Tests

Constants

Properties

Methods

Propertieslink to this

protected static $cachelink to this

Methodslink to this

public static addTests( Unittest_TestSuite $suite , array $files ) (defined in Kohana_Unittest_Tests) link to this

Parameters

Source Code

public static autoload( $class ) (defined in Kohana_Unittest_Tests) link to this

Parameters

Source Code

public static blacklist( array $blacklist_items [, Unittest_TestSuite $suite = NULL ] ) (defined in Kohana_Unittest_Tests) link to this

Parameters

Source Code

public static configure_environment( ) (defined in Kohana_Unittest_Tests) link to this

Source Code

public static suite( ) (defined in Kohana_Unittest_Tests) link to this

Return Values

Source Code

public static whitelist( [ array $directories = NULL , Unittest_Testsuite $suite = NULL ] ) (defined in Kohana_Unittest_Tests) link to this

Parameters

Source Code

protected static get_config_whitelist( ) (defined in Kohana_Unittest_Tests) link to this

Tags

Source Code

protected static set_whitelist( array $files [, Unittest_TestSuite $suite = NULL ] ) (defined in Kohana_Unittest_Tests) link to this

Parameters

Source Code