IntegrationTestCase.php

<?php
/**
 * Piwik - Open source web analytics
 *
 * @link http://piwik.org
 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 */
use Piwik\Access;
use Piwik\API\DocumentationGenerator;
use Piwik\API\Proxy;
use Piwik\API\Request;
use Piwik\ArchiveProcessor\Rules;
use Piwik\Common;
use Piwik\Config;
use Piwik\DataAccess\ArchiveTableCreator;
use Piwik\DataTable\Manager;
use Piwik\Db;
use Piwik\Option;
use Piwik\Piwik;
use Piwik\Plugins\LanguagesManager\API;
use Piwik\ReportRenderer;
use Piwik\Site;
use Piwik\Tracker\Cache;
use Piwik\Translate;
use Piwik\UrlHelper;

require_once PIWIK_INCLUDE_PATH . '/libs/PiwikTracker/PiwikTracker.php';

/**
 * Base class for Integration tests.
 *
 * Provides helpers to track data and then call API get* methods to check outputs automatically.
 *
 */
abstract class IntegrationTestCase extends PHPUnit_Framework_TestCase
{
    /**
     * Identifies the last language used in an API/Controller call.
     *
     * @var string
     */
    protected $lastLanguage;

    /**
     * Creates a config object for use w/ tests.
     */
    public static function createTestConfig()
    {
        Config::getInstance()->setTestEnvironment();
    }

    /**
     * Sets up access instance.
     */
    public static function createAccessInstance()
    {
        Access::setSingletonInstance(null);
        Access::getInstance();
        Piwik_PostEvent('FrontController.initAuthenticationObject');
    }
    
    /**
     * Connects to MySQL w/o specifying a database.
     */
    public static function connectWithoutDatabase()
    {
        $dbConfig = Config::getInstance()->database;
        $oldDbName = $dbConfig['dbname'];
        $dbConfig['dbname'] = null;

        Piwik::createDatabaseObject($dbConfig);

        $dbConfig['dbname'] = $oldDbName;
    }

    public static function setUpBeforeClass()
    {
        self::_setUpBeforeClass();

        if (isset(static::$fixture)) {
            self::setupFixture(static::$fixture);
        }
    }

    /**
     * @param bool $installPlugins
     */
    protected static function installAndLoadPlugins($installPlugins)
    {
        $pluginsManager = \Piwik\PluginsManager::getInstance();
        $plugins = $pluginsManager->readPluginsDirectory();

        $pluginsManager->loadPlugins($plugins);
        if ($installPlugins)
        {
            $pluginsManager->installLoadedPlugins();
        }
    }

    public static function loadAllPlugins()
    {
        $pluginsManager = \Piwik\PluginsManager::getInstance();
        $pluginsToLoad = Config::getInstance()->Plugins['Plugins'];
        $pluginsToLoad[] = 'DevicesDetection';
        
        $pluginsManager->loadPlugins($pluginsToLoad);
    }

    public static function unloadAllPlugins()
    {
        try {
            $plugins = \Piwik\PluginsManager::getInstance()->getLoadedPlugins();
            foreach ($plugins AS $plugin) {
                $plugin->uninstall();
            }
            \Piwik\PluginsManager::getInstance()->unloadPlugins();
        } catch (Exception $e) {
        }
    }

    protected static function setupFixture($fixture)
    {
        try {
            $fixture->setUp();
        } catch (Exception $e) {
            // Skip whole test suite if an error occurs while setup
            throw new PHPUnit_Framework_SkippedTestSuiteError($e->getMessage() . "\n" . $e->getTraceAsString());
        }
    }

    protected static function teardownFixture($fixture)
    {
        if (isset(static::$fixture)) {
            self::tearDownFixture(static::$fixture);
        }

        $fixture->tearDown();
    }

    /**
     * setupBeforeClass' implementation. Can be called by derived classes in case
     * they need to do some custom setup procedure.
     */
    public static function _setUpBeforeClass($dbName = false, $createEmptyDatabase = true, $createConfig = true, $installPlugins = null)
    {
        try {
            \Piwik\SettingsPiwik::$piwikUrlCache = '';

            if ($createConfig) {
                static::createTestConfig();
            }

            if ($dbName === false) // must be after test config is created
            {
                $dbName = Config::getInstance()->database['dbname'];
            }

            self::connectWithoutDatabase();
            if ($createEmptyDatabase) {
                Piwik::dropDatabase();
            }
            Piwik::createDatabase($dbName);
            Piwik::disconnectDatabase();

            // reconnect once we're sure the database exists
            Config::getInstance()->database['dbname'] = $dbName;
            Piwik::createDatabaseObject();

            Piwik::createTables();
            \Piwik\Log::make();

            \Piwik\PluginsManager::getInstance()->loadPlugins(array());
        } catch (Exception $e) {
            self::fail("TEST INITIALIZATION FAILED: " . $e->getMessage() . "\n" . $e->getTraceAsString());
        }

        include "DataFiles/SearchEngines.php";
        include "DataFiles/Languages.php";
        include "DataFiles/Countries.php";
        include "DataFiles/Currencies.php";
        include "DataFiles/LanguageToCountry.php";
        include "DataFiles/Providers.php";
        
        static::createAccessInstance();

        // We need to be SU to create websites for tests
        Piwik::setUserIsSuperUser();

        Cache::deleteTrackerCache();
        if ($installPlugins === null) $installPlugins = $createEmptyDatabase;
        self::installAndLoadPlugins( $installPlugins);


        $_GET = $_REQUEST = array();
        $_SERVER['HTTP_REFERER'] = '';

        // Make sure translations are loaded to check messages in English
        Translate::getInstance()->reloadLanguage('en');
        API::getInstance()->setLanguageForUser('superUserLogin', 'en');