<?php
|
|
/*
|
+-----------------------------------------------------------------------+
|
| tests/Selenium/bootstrap.php |
|
| |
|
| This file is part of the Roundcube Webmail client |
|
| Copyright (C) 2009-2014, The Roundcube Dev Team |
|
| |
|
| Licensed under the GNU General Public License version 3 or |
|
| any later version with exceptions for skins & plugins. |
|
| See the README file for a full license statement. |
|
| |
|
| PURPOSE: |
|
| Environment initialization script for unit tests |
|
+-----------------------------------------------------------------------+
|
| Author: Thomas Bruederli <roundcube@gmail.com> |
|
| Author: Aleksander Machniak <alec@alec.pl> |
|
+-----------------------------------------------------------------------+
|
*/
|
|
if (php_sapi_name() != 'cli')
|
die("Not in shell mode (php-cli)");
|
|
if (!defined('INSTALL_PATH')) define('INSTALL_PATH', realpath(__DIR__ . '/../../') . '/' );
|
|
define('TESTS_DIR', realpath(__DIR__ . '/../') . '/');
|
|
if (@is_dir(TESTS_DIR . 'config')) {
|
define('RCUBE_CONFIG_DIR', TESTS_DIR . 'config');
|
}
|
|
require_once(INSTALL_PATH . 'program/include/iniset.php');
|
|
// Extend include path so some plugin test won't fail
|
$include_path = ini_get('include_path') . PATH_SEPARATOR . TESTS_DIR . '..';
|
if (set_include_path($include_path) === false) {
|
die("Fatal error: ini_set/set_include_path does not work.");
|
}
|
|
$rcmail = rcmail::get_instance(0, 'test');
|
|
define('TESTS_URL', $rcmail->config->get('tests_url'));
|
define('TESTS_BROWSER', $rcmail->config->get('tests_browser', 'firefox'));
|
define('TESTS_USER', $rcmail->config->get('tests_username'));
|
define('TESTS_PASS', $rcmail->config->get('tests_password'));
|
define('TESTS_SLEEP', $rcmail->config->get('tests_sleep', 5));
|
|
PHPUnit_Extensions_Selenium2TestCase::shareSession(true);
|
|
|
/**
|
* satisfy PHPUnit
|
*/
|
class bootstrap
|
{
|
static $imap_ready = null;
|
|
/**
|
* Wipe and re-initialize (mysql) database
|
*/
|
public static function init_db()
|
{
|
$rcmail = rcmail::get_instance();
|
$dsn = rcube_db::parse_dsn($rcmail->config->get('db_dsnw'));
|
|
if ($dsn['phptype'] == 'mysql' || $dsn['phptype'] == 'mysqli') {
|
// drop all existing tables first
|
$db = $rcmail->get_dbh();
|
$db->query("SET FOREIGN_KEY_CHECKS=0");
|
$sql_res = $db->query("SHOW TABLES");
|
while ($sql_arr = $db->fetch_array($sql_res)) {
|
$table = reset($sql_arr);
|
$db->query("DROP TABLE $table");
|
}
|
|
// init database with schema
|
system(sprintf('cat %s %s | mysql -h %s -u %s --password=%s %s',
|
realpath(INSTALL_PATH . '/SQL/mysql.initial.sql'),
|
realpath(TESTS_DIR . 'Selenium/data/mysql.sql'),
|
escapeshellarg($dsn['hostspec']),
|
escapeshellarg($dsn['username']),
|
escapeshellarg($dsn['password']),
|
escapeshellarg($dsn['database'])
|
));
|
}
|
else if ($dsn['phptype'] == 'sqlite') {
|
// delete database file -- will be re-initialized on first access
|
system(sprintf('rm -f %s', escapeshellarg($dsn['database'])));
|
}
|
}
|
|
/**
|
* Wipe the configured IMAP account and fill with test data
|
*/
|
public static function init_imap()
|
{
|
if (!TESTS_USER) {
|
return false;
|
}
|
else if (self::$imap_ready !== null) {
|
return self::$imap_ready;
|
}
|
|
self::connect_imap(TESTS_USER, TESTS_PASS);
|
self::purge_mailbox('INBOX');
|
self::ensure_mailbox('Archive', true);
|
|
return self::$imap_ready;
|
}
|
|
/**
|
* Authenticate to IMAP with the given credentials
|
*/
|
public static function connect_imap($username, $password, $host = null)
|
{
|
$rcmail = rcmail::get_instance();
|
$imap = $rcmail->get_storage();
|
|
if ($imap->is_connected()) {
|
$imap->close();
|
self::$imap_ready = false;
|
}
|
|
$imap_host = $host ?: $rcmail->config->get('default_host');
|
$a_host = parse_url($imap_host);
|
if ($a_host['host']) {
|
$imap_host = $a_host['host'];
|
$imap_ssl = isset($a_host['scheme']) && in_array($a_host['scheme'], array('ssl','imaps','tls'));
|
$imap_port = isset($a_host['port']) ? $a_host['port'] : ($imap_ssl ? 993 : 143);
|
}
|
else {
|
$imap_port = 143;
|
$imap_ssl = false;
|
}
|
|
if (!$imap->connect($imap_host, $username, $password, $imap_port, $imap_ssl)) {
|
die("IMAP error: unable to authenticate with user " . TESTS_USER);
|
}
|
|
self::$imap_ready = true;
|
}
|
|
/**
|
* Import the given file into IMAP
|
*/
|
public static function import_message($filename, $mailbox = 'INBOX')
|
{
|
if (!self::init_imap()) {
|
die(__METHOD__ . ': IMAP connection unavailable');
|
}
|
|
$imap = rcmail::get_instance()->get_storage();
|
$imap->save_message($mailbox, file_get_contents($filename));
|
}
|
|
/**
|
* Delete all messages from the given mailbox
|
*/
|
public static function purge_mailbox($mailbox)
|
{
|
if (!self::init_imap()) {
|
die(__METHOD__ . ': IMAP connection unavailable');
|
}
|
|
$imap = rcmail::get_instance()->get_storage();
|
$imap->delete_message('*', $mailbox);
|
}
|
|
/**
|
* Make sure the given mailbox exists in IMAP
|
*/
|
public static function ensure_mailbox($mailbox, $empty = false)
|
{
|
if (!self::init_imap()) {
|
die(__METHOD__ . ': IMAP connection unavailable');
|
}
|
|
$imap = rcmail::get_instance()->get_storage();
|
|
$folders = $imap->list_folders();
|
if (!in_array($mailbox, $folders)) {
|
$imap->create_folder($mailbox, true);
|
}
|
else if ($empty) {
|
$imap->delete_message('*', $mailbox);
|
}
|
}
|
}
|
|
// @TODO: make sure mailbox has some content (always the same) or is empty
|
// @TODO: plugins: enable all?
|
|
/**
|
* Base class for all tests in this directory
|
*/
|
class Selenium_Test extends PHPUnit_Extensions_Selenium2TestCase
|
{
|
protected $login_data = null;
|
|
protected function setUp()
|
{
|
$this->setBrowser(TESTS_BROWSER);
|
$this->login_data = array(TESTS_USER, TESTS_PASS);
|
|
// Set root to our index.html, for better performance
|
// See https://github.com/sebastianbergmann/phpunit-selenium/issues/217
|
$baseurl = preg_replace('!/index(-.+)?\.php^!', '', TESTS_URL);
|
$this->setBrowserUrl($baseurl . '/tests/Selenium');
|
}
|
|
protected function login($username = null, $password = null)
|
{
|
if (!empty($username)) {
|
$this->login_data = array($username, $password);
|
}
|
|
$this->go('mail', null, true);
|
}
|
|
protected function do_login()
|
{
|
$user_input = $this->byCssSelector('form input[name="_user"]');
|
$pass_input = $this->byCssSelector('form input[name="_pass"]');
|
$submit = $this->byCssSelector('form input[type="submit"]');
|
|
$user_input->value($this->login_data[0]);
|
$pass_input->value($this->login_data[1]);
|
|
// submit login form
|
$submit->click();
|
|
// wait after successful login
|
sleep(TESTS_SLEEP);
|
}
|
|
protected function go($task = 'mail', $action = null, $login = true)
|
{
|
$this->url(TESTS_URL . '?_task=' . $task);
|
|
// wait for interface load (initial ajax requests, etc.)
|
sleep(TESTS_SLEEP);
|
|
// check if we have a valid session
|
$env = $this->get_env();
|
if ($login && $env['task'] == 'login') {
|
$this->do_login();
|
}
|
|
if ($action) {
|
$this->click_button($action);
|
sleep(TESTS_SLEEP);
|
}
|
}
|
|
protected function get_env()
|
{
|
return $this->execute(array(
|
'script' => 'return window.rcmail ? rcmail.env : {};',
|
'args' => array(),
|
));
|
}
|
|
protected function get_buttons($action)
|
{
|
$buttons = $this->execute(array(
|
'script' => "return rcmail.buttons['$action'];",
|
'args' => array(),
|
));
|
|
if (is_array($buttons)) {
|
foreach ($buttons as $idx => $button) {
|
$buttons[$idx] = $button['id'];
|
}
|
}
|
|
return (array) $buttons;
|
}
|
|
protected function get_objects()
|
{
|
return $this->execute(array(
|
'script' => "var i,r = []; for (i in rcmail.gui_objects) r.push(i); return r;",
|
'args' => array(),
|
));
|
}
|
|
protected function click_button($action)
|
{
|
$buttons = $this->get_buttons($action);
|
$id = array_shift($buttons);
|
|
// this doesn't work for me
|
$this->byId($id)->click();
|
}
|
|
protected function ajaxResponse($action, $script = '', $button = false)
|
{
|
if (!$script && !$button) {
|
$script = "rcmail.command('$action')";
|
}
|
|
$script =
|
"if (!window.test_ajax_response) {
|
window.test_ajax_response_object = {};
|
function test_ajax_response(response)
|
{
|
if (response.response && response.response.action) {
|
window.test_ajax_response_object[response.response.action] = response.response;
|
}
|
}
|
rcmail.addEventListener('responsebefore', test_ajax_response);
|
}
|
window.test_ajax_response_object['$action'] = null;
|
$script;
|
";
|
|
// run request
|
$this->execute(array(
|
'script' => $script,
|
'args' => array(),
|
));
|
|
if ($button) {
|
$this->click_button($action);
|
}
|
|
// wait
|
sleep(TESTS_SLEEP);
|
|
// get response
|
$response = $this->execute(array(
|
'script' => "return window.test_ajax_response_object ? test_ajax_response_object['$action'] : {};",
|
'args' => array(),
|
));
|
|
return $response;
|
}
|
|
protected function getText($element)
|
{
|
return $element->text() ?: $element->attribute('textContent');
|
}
|
|
protected function assertHasClass($classname, $element)
|
{
|
$this->assertContains($classname, $element->attribute('class'));
|
}
|
}
|