class.ThinkUpBasicUnitTestCase.php

<?php
/**
 *
 * ThinkUp/tests/classes/class.ThinkUpBasicUnitTestCase.php
 *
 * Copyright (c) 2009-2013 Gina Trapani
 *
 * LICENSE:
 *
 * This file is part of ThinkUp (http://thinkup.com).
 *
 * ThinkUp 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.
 *
 * ThinkUp 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 ThinkUp.  If not, see
 * <http://www.gnu.org/licenses/>.
 *
 * ThinkUp Basic Unit Test Case
 *
 * Base test case for tests without the need for database availability.
 * @license http://www.gnu.org/licenses/gpl.html
 * @copyright 2009-2013 Gina Trapani
 * @author Gina Trapani <ginatrapani[at]gmail[dot]com>
 *
 */
require_once THINKUP_WEBAPP_PATH.'_lib/class.Loader.php';

class ThinkUpBasicUnitTestCase extends UnitTestCase {
    /**
     * Test CSRF Token
     */
    const CSRF_TOKEN = 'test_csrf_token_123';

    /**
     * Constructor
     * Occasionally spit out a . if we are running in travis so that travis doesn't give up on us.
     */
    public function __construct() {
        parent::__construct();
        if (getenv('TRAVIS') == 'true') {
            if (mt_rand(1,20) == 1) print ".";
            sleep(3);
        }
    }

    /**
     * Initialize Config and Webapp objects, clear $_SESSION, $_POST, $_GET, $_REQUEST
     */
    public function setUp() {
        parent::setUp();
        Loader::register(array(
        THINKUP_ROOT_PATH . 'tests/',
        THINKUP_ROOT_PATH . 'tests/classes/',
        THINKUP_ROOT_PATH . 'tests/fixtures/',
        ));

        $config = Config::getInstance();
        //disable caching for tests
        $config->setValue('cache_pages', false);

        //tests assume profiling is off
        $config->setValue('enable_profiler', false);
        if ($config->getValue('timezone')) {
            date_default_timezone_set($config->getValue('timezone'));
        }
        //tests assume no redirect to ThinkUp LLC
        if ($config->getValue('thinkupllc_endpoint') != null) {
            $config->setValue('thinkupllc_endpoint', null);
        }

        $webapp_plugin_registrar = PluginRegistrarWebapp::getInstance();
        $crawler_plugin_registrar = PluginRegistrarCrawler::getInstance();
        $this->DEBUG = (getenv('TEST_DEBUG')!==false) ? true : false;

        ini_set('session.use_cookies', 0);
        session_cache_limiter('');

        self::isTestEnvironmentReady();
    }

    /**
     * Destroy Config, Webapp, $_SESSION, $_POST, $_GET, $_REQUEST
     */
    public function tearDown() {
        Config::destroyInstance();
        PluginRegistrarWebapp::destroyInstance();
        PluginRegistrarCrawler::destroyInstance();
        if (isset($_SESSION)) {
            $this->unsetArray($_SESSION);
        }
        $this->unsetArray($_POST);
        $this->unsetArray($_GET);
        $this->unsetArray($_REQUEST);
        $this->unsetArray($_SERVER);
        $this->unsetArray($_FILES);
        Loader::unregister();
        $backup_dir = FileDataManager::getBackupPath();
        if (file_exists($backup_dir)) {
            try {
                @exec('cd '.$backup_dir.'; rm -rf *');
                rmdir($backup_dir); // won't delete if has files
            } catch (Exception $e) {
            }
        }
        $data_dir = FileDataManager::getDataPath();
        if (file_exists($data_dir.'compiled_view')) {
            try {
                @exec('cd '.$data_dir.'; rm -rf compiled_view');
            } catch (Exception $e) {
            }
        }
        parent::tearDown();
    }

    /**
     * Unset all the values for every key in an array
     * @param array $array
     */
    protected function unsetArray(array &$array) {
        $keys = array_keys($array);
        foreach ($keys as $key) {
            unset($array[$key]);
        }
    }

    /**
     * Move webapp/config.inc.php to webapp/config.inc.bak.php for tests with no config file
     */
    protected function removeConfigFile() {
        if (file_exists(THINKUP_WEBAPP_PATH . 'config.inc.php')) {
            $cmd = 'mv '.THINKUP_WEBAPP_PATH . 'config.inc.php ' .THINKUP_WEBAPP_PATH . 'config.inc.bak.php';
            @exec($cmd, $output, $return_val);
            if ($return_val != 0) {
                echo "Could not ".$cmd;
            }
        }
    }

    /**
     * Move webapp/config.inc.bak.php to webapp/config.inc.php
     */
    protected function restoreConfigFile() {
        if (file_exists(THINKUP_WEBAPP_PATH . 'config.inc.bak.php')) {
            $cmd = 'mv '.THINKUP_WEBAPP_PATH . 'config.inc.bak.php ' .THINKUP_WEBAPP_PATH . 'config.inc.php';
            @exec($cmd, $output, $return_val);
            if ($return_val != 0) {
                echo "Could not ".$cmd;
            }
        }
    }

    public function __destruct() {
        $this->restoreConfigFile();
    }

    /**
     * Wrapper for logging in a ThinkUp user in a test
     * @param str $email
     * @param bool $is_admin Default to false
     * @param bool $use_csrf_token Whether or not to put down valid CSRF token, default to false
     */
    protected function simulateLogin($email, $is_admin = false, $use_csrf_token = false) {
        SessionCache::put('user', $email);
        if ($is_admin) {
            SessionCache::put('user_is_admin', true);
        }
        if ($use_csrf_token) {
            SessionCache::put('csrf_token', self::CSRF_TOKEN);
        }
    }

    public function debug($message) {
        if ($this->DEBUG) {
            $bt = debug_backtrace();
            print get_class($this) . ": line " . $bt[0]['line'] . " - " . $message . "\n";
        }
    }

    static private function isLogWritable($path) {
        return (is_file($path) && is_writable($path)) ||
        (is_dir(dirname($path)) && is_writable(dirname($path)));
    }

    /**
     * Preemptively halt test run if testing environment requirement isn't met.
     * Prevents unnecessary/inexplicable failures and data loss.
     */
    public static function isTestEnvironmentReady() {
        require THINKUP_WEBAPP_PATH.'config.inc.php';

        $datadir_path = FileDataManager::getDataPath();
        if (!is_writable($datadir_path)) {
            $message = "In order to test your ThinkUp installation, $datadir_path must be writable.";
        }
        if (!is_writable($datadir_path.'compiled_view/')) {
            try {
                @exec('cd '.$datadir_path.'; rm -rf compiled_view');
            } catch (Exception $e) {
            }
        }
        if (!file_exists($datadir_path.'compiled_view/')) {
            mkdir($datadir_path.'compiled_view/');
            @exec('chmod -R 777 '.$datadir_path.'compiled_view/');
        }
        if (!is_writable($datadir_path.'compiled_view/')) {
            $message = "In order to test your ThinkUp installation, ".$datadir_path."compiled_view/ must be writable.";
        }

        if ($THINKUP_CFG['log_location'] === false) {
            $message = "In order to test your ThinkUp installation, \$THINKUP_CFG['log_location'] must be set to a ".
            "writable file.";
        } else if (!self::isLogWritable($THINKUP_CFG['log_location'])) {
            $message = "In order to test your ThinkUp installation with your current settings, ".
            $THINKUP_CFG['log_location']. " must be a writable file.";
        } else if (file_exists($THINKUP_CFG['log_location']) && filesize($THINKUP_CFG['log_location']) > 10485760) {
            $message = "Your crawler log file is so large it may cause a PHP Fatal error due to memory usage. ".
            "Please make ". $THINKUP_CFG['log_location']. " less than 10MB in size and try again.";
        }
        if ( !isset($THINKUP_CFG['stream_log_location']) || $THINKUP_CFG['stream_log_location'] === false) {
            $message = "In order to test your ThinkUp installation, \$THINKUP_CFG['stream_log_location'] must be set ".
            "to a writable file.";
        } else if (!self::isLogWritable($THINKUP_CFG['stream_log_location'])) {
            $message = "In order to test your ThinkUp installation with your current settings, ".
            $THINKUP_CFG['stream_log_location']. " must be a writable file.";
        } else if (file_exists($THINKUP_CFG['stream_log_location'])
        && filesize($THINKUP_CFG['stream_log_location']) > 10485760) {
            $message = "Your stream log file is so large it may cause a PHP Fatal error due to memory usage. ".
            "Please make ". $THINKUP_CFG['stream_log_location']. " less than 10MB in size and try again.";
        }

        global $TEST_DATABASE;

        if (getenv("RD_MODE")=="1") {
            $TEST_DATABASE = $THINKUP_CFG['db_name'];
        }


        if ($THINKUP_CFG['db_name'] != $TEST_DATABASE) {
            $message = "The database name in webapp/config.inc.php does not match \$TEST_DATABASE in ".
            "tests/config.tests.inc.php.
In order to test your ThinkUp installation without losing data, these database names must both point to the same ".
"empty test database.";
        }

        if ($THINKUP_CFG['cache_pages']) {
            $message = "In order to test your ThinkUp installation, \$THINKUP_CFG['cache_pages'] must be set to false.";
        }

        $cmd = "find . -type f -path '????????????????????????????????????????????????????????????????????????????????".
        "?????????????????????????????????????????????????????????????????????????????????????????????????????????????".
        "????????*'";
        @exec($cmd, $filenames, $return_val);
        if (is_array($filenames) && sizeof($filenames) > 1 ) {
            $message = "Filenames in the repository are greater than 200 characters in length:
";
            foreach ($filenames as $filename) {
                $message  .= $filename."
";
            }
        }

        if (isset($message)) {
            echo "Stopping tests...Test environment isn't ready.
".$message."
Please try again.
";
            exit(1);
        }

        $cmd = "find . -type f -name '*:*'";
        @exec($cmd, $filenames, $return_val);
        if (is_array($filenames) && sizeof($filenames) > 1 ) {
            $message = "Files in the repository have a colon in their names, an invalid character on Windows:
";
            foreach ($filenames as $filename) {
                $message  .= $filename."
";
            }
        }

        if (isset($message)) {
            echo "Stopping tests...Test environment isn't ready.
".$message."
Please try again.
";
            exit(1);
        }
    }
}