You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
421 lines
12 KiB
PHP
421 lines
12 KiB
PHP
<?php
|
|
|
|
namespace Tests\Browser;
|
|
|
|
use PHPUnit\Framework\TestCase;
|
|
use Facebook\WebDriver\Chrome\ChromeOptions;
|
|
use Facebook\WebDriver\Remote\RemoteWebDriver;
|
|
use Facebook\WebDriver\Remote\DesiredCapabilities;
|
|
use Laravel\Dusk\Browser;
|
|
use Laravel\Dusk\Chrome\SupportsChrome;
|
|
use Laravel\Dusk\Concerns\ProvidesBrowser;
|
|
use Symfony\Component\Finder\Finder;
|
|
use Symfony\Component\Process\Process;
|
|
|
|
abstract class DuskTestCase extends TestCase
|
|
{
|
|
use ProvidesBrowser,
|
|
SupportsChrome;
|
|
|
|
protected $app;
|
|
protected static $phpProcess;
|
|
|
|
|
|
/**
|
|
* Prepare for Dusk test execution.
|
|
*
|
|
* @beforeClass
|
|
* @return void
|
|
*/
|
|
public static function prepare()
|
|
{
|
|
static::startWebServer();
|
|
static::startChromeDriver();
|
|
}
|
|
|
|
/**
|
|
* Create the RemoteWebDriver instance.
|
|
*
|
|
* @return \Facebook\WebDriver\Remote\RemoteWebDriver
|
|
*/
|
|
protected function driver()
|
|
{
|
|
$options = (new ChromeOptions())->addArguments([
|
|
'--lang=en_US',
|
|
'--disable-gpu',
|
|
'--headless',
|
|
]);
|
|
|
|
if (getenv('TESTS_MODE') == 'phone') {
|
|
// Fake User-Agent string for mobile mode
|
|
$ua = 'Mozilla/5.0 (Linux; Android 4.0.4; Galaxy Nexus Build/IMM76B) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/60.0.3112.90 Mobile Safari/537.36';
|
|
$options->setExperimentalOption('mobileEmulation', ['userAgent' => $ua]);
|
|
$options->addArguments(['--window-size=375,667']);
|
|
}
|
|
else if (getenv('TESTS_MODE') == 'tablet') {
|
|
// Fake User-Agent string for mobile mode
|
|
$ua = 'Mozilla/5.0 (Linux; Android 6.0.1; vivo 1603 Build/MMB29M) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.83 Mobile Safari/537.36';
|
|
$options->setExperimentalOption('mobileEmulation', ['userAgent' => $ua]);
|
|
$options->addArguments(['--window-size=1024,768']);
|
|
}
|
|
else {
|
|
$options->addArguments(['--window-size=1280,720']);
|
|
}
|
|
|
|
return RemoteWebDriver::create(
|
|
'http://localhost:9515',
|
|
DesiredCapabilities::chrome()->setCapability(
|
|
ChromeOptions::CAPABILITY,
|
|
$options
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Set up the test run
|
|
*
|
|
* @return void
|
|
*/
|
|
protected function setUp()
|
|
{
|
|
parent::setUp();
|
|
|
|
$this->app = \rcmail::get_instance();
|
|
|
|
Browser::$baseUrl = 'http://localhost:8000';
|
|
Browser::$storeScreenshotsAt = __DIR__ . '/screenshots';
|
|
Browser::$storeConsoleLogAt = __DIR__ . '/console';
|
|
|
|
// This folder must exist in case Browser will try to write logs to it
|
|
if (!is_dir(Browser::$storeConsoleLogAt)) {
|
|
mkdir(Browser::$storeConsoleLogAt, 0777, true);
|
|
}
|
|
|
|
// Purge screenshots from the last test run
|
|
$pattern = sprintf('failure-%s_%s-*',
|
|
str_replace("\\", '_', get_class($this)),
|
|
$this->getName(false)
|
|
);
|
|
|
|
try {
|
|
$files = Finder::create()->files()->in(Browser::$storeScreenshotsAt)->name($pattern);
|
|
foreach ($files as $file) {
|
|
@unlink($file->getRealPath());
|
|
}
|
|
}
|
|
catch (\Symfony\Component\Finder\Exception\DirectoryNotFoundException $e) {
|
|
// ignore missing screenshots directory
|
|
}
|
|
|
|
// Purge console logs from the last test run
|
|
$pattern = sprintf('%s_%s-*',
|
|
str_replace("\\", '_', get_class($this)),
|
|
$this->getName(false)
|
|
);
|
|
|
|
try {
|
|
$files = Finder::create()->files()->in(Browser::$storeConsoleLogAt)->name($pattern);
|
|
foreach ($files as $file) {
|
|
@unlink($file->getRealPath());
|
|
}
|
|
}
|
|
catch (\Symfony\Component\Finder\Exception\DirectoryNotFoundException $e) {
|
|
// ignore missing screenshots directory
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Check if in Phone mode
|
|
*/
|
|
public static function isPhone()
|
|
{
|
|
return getenv('TESTS_MODE') == 'phone';
|
|
}
|
|
|
|
/**
|
|
* Check if in Tablet mode
|
|
*/
|
|
public static function isTablet()
|
|
{
|
|
return getenv('TESTS_MODE') == 'tablet';
|
|
}
|
|
|
|
/**
|
|
* Check if in Desktop mode
|
|
*/
|
|
public static function isDesktop()
|
|
{
|
|
return !self::isPhone() && !self::isTablet();
|
|
}
|
|
|
|
/**
|
|
* Assert specified rcmail.env value
|
|
*/
|
|
protected function assertEnvEquals($key, $expected)
|
|
{
|
|
$this->assertEquals($expected, $this->getEnv($key));
|
|
}
|
|
|
|
/**
|
|
* Assert specified checkbox state
|
|
*/
|
|
protected function assertCheckboxState($selector, $state)
|
|
{
|
|
$this->browse(function (Browser $browser) use ($selector, $state) {
|
|
if ($state) {
|
|
$browser->assertChecked($selector);
|
|
}
|
|
else {
|
|
$browser->assertNotChecked($selector);
|
|
}
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Assert Task menu state
|
|
*/
|
|
protected function assertTaskMenu($selected)
|
|
{
|
|
$this->browse(function (Browser $browser) use ($selected) {
|
|
// On phone the menu is invisible, open it
|
|
if ($this->isPhone()) {
|
|
$browser->click('.task-menu-button');
|
|
}
|
|
|
|
$browser->with('#taskmenu', function(Browser $browser) use ($selected) {
|
|
$options = ['compose', 'mail', 'contacts', 'settings', 'about', 'logout'];
|
|
foreach ($options as $option) {
|
|
$browser->assertVisible("a.{$option}:not(.disabled)" . ($selected == $option ? ".selected" : ":not(.selected)"));
|
|
}
|
|
});
|
|
|
|
// hide the menu back
|
|
if ($this->isPhone()) {
|
|
$browser->click('.popover a.button.cancel');
|
|
$browser->waitUntilMissing('#taskmenu');
|
|
}
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Assert toolbar menu state
|
|
*/
|
|
protected function assertToolbarMenu($active, $disabled)
|
|
{
|
|
$this->browse(function (Browser $browser) use ($active, $disabled) {
|
|
// On phone the menu is invisible, open it
|
|
if ($this->isPhone()) {
|
|
$browser->click('.toolbar-menu-button');
|
|
}
|
|
|
|
$browser->with('#toolbar-menu', function(Browser $browser) use ($active, $disabled) {
|
|
foreach ($active as $option) {
|
|
// Print action is disabled on phones
|
|
if ($option == 'print' && $this->isPhone()) {
|
|
$browser->assertMissing("a.print");
|
|
}
|
|
else {
|
|
$browser->assertVisible("a.{$option}:not(.disabled)");
|
|
}
|
|
}
|
|
foreach ($disabled as $option) {
|
|
if ($option == 'print' && $this->isPhone()) {
|
|
$browser->assertMissing("a.print");
|
|
}
|
|
else {
|
|
$browser->assertVisible("a.{$option}.disabled");
|
|
}
|
|
}
|
|
});
|
|
|
|
$this->closeToolbarMenu();
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Close toolbar menu (on phones)
|
|
*/
|
|
protected function closeToolbarMenu()
|
|
{
|
|
// hide the menu back
|
|
if ($this->isPhone()) {
|
|
$this->browse(function (Browser $browser) {
|
|
$browser->script("window.UI.menu_hide('toolbar-menu')");
|
|
$browser->waitUntilMissing('#toolbar-menu');
|
|
// FIXME: For some reason sometimes .popover-overlay does not close,
|
|
// we have to remove it manually
|
|
$browser->script(
|
|
"Array.from(document.getElementsByClassName('popover-overlay')).forEach(function(elem) { elem.parentNode.removeChild(elem); })"
|
|
);
|
|
});
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Select taskmenu item
|
|
*/
|
|
protected function clickTaskMenuItem($name)
|
|
{
|
|
$this->browse(function (Browser $browser) use ($name) {
|
|
if ($this->isPhone()) {
|
|
$browser->click('.task-menu-button');
|
|
}
|
|
|
|
$browser->click("#taskmenu a.{$name}");
|
|
|
|
if ($this->isPhone()) {
|
|
$browser->waitUntilMissing('#taskmenu');
|
|
}
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Select toolbar menu item
|
|
*/
|
|
protected function clickToolbarMenuItem($name)
|
|
{
|
|
$this->browse(function (Browser $browser) use ($name) {
|
|
if ($this->isPhone()) {
|
|
$browser->click('.toolbar-menu-button');
|
|
}
|
|
|
|
$browser->click("#toolbar-menu a.{$name}");
|
|
|
|
if ($this->isPhone()) {
|
|
$this->closeToolbarMenu();
|
|
// $browser->waitUntilMissing('#toolbar-menu');
|
|
}
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Get content of rcmail.env entry
|
|
*/
|
|
protected function getEnv($key)
|
|
{
|
|
$this->browse(function (Browser $browser) use ($key, &$result) {
|
|
$result = $browser->script("return rcmail.env['$key']");
|
|
$result = $result[0];
|
|
});
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Get HTML IDs of defined buttons for specified Roundcube action
|
|
*/
|
|
protected function getButtons($action)
|
|
{
|
|
$this->browse(function (Browser $browser) use ($action, &$buttons) {
|
|
$buttons = $browser->script("return rcmail.buttons['$action']");
|
|
$buttons = $buttons[0];
|
|
});
|
|
|
|
if (is_array($buttons)) {
|
|
foreach ($buttons as $idx => $button) {
|
|
$buttons[$idx] = $button['id'];
|
|
}
|
|
}
|
|
|
|
return (array) $buttons;
|
|
}
|
|
|
|
/**
|
|
* Return names of defined gui_objects
|
|
*/
|
|
protected function getObjects()
|
|
{
|
|
$this->browse(function (Browser $browser) use (&$objects) {
|
|
$objects = $browser->script("var i, r = []; for (i in rcmail.gui_objects) r.push(i); return r");
|
|
$objects = $objects[0];
|
|
});
|
|
|
|
return (array) $objects;
|
|
}
|
|
|
|
/**
|
|
* Log in the test user
|
|
*/
|
|
protected function doLogin()
|
|
{
|
|
$this->browse(function (Browser $browser) {
|
|
$browser->type('_user', TESTS_USER);
|
|
$browser->type('_pass', TESTS_PASS);
|
|
$browser->click('button[type="submit"]');
|
|
|
|
// wait after successful login
|
|
//$browser->waitForReload();
|
|
$browser->waitUntil('!rcmail.busy');
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Visit specified task/action with logon if needed
|
|
*/
|
|
protected function go($task = 'mail', $action = null, $login = true)
|
|
{
|
|
$this->browse(function (Browser $browser) use ($task, $action, $login) {
|
|
$browser->visit("/?_task=$task&_action=$action");
|
|
|
|
// check if we have a valid session
|
|
if ($login && $this->getEnv('task') == 'login') {
|
|
$this->doLogin();
|
|
}
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Change state of the Elastic's pretty checkbox
|
|
*/
|
|
protected function setCheckboxState($selector, $state)
|
|
{
|
|
// Because you can't operate on the original checkbox directly
|
|
$this->browse(function (Browser $browser) use ($selector, $state) {
|
|
$browser->ensurejQueryIsAvailable();
|
|
|
|
if ($state) {
|
|
$run = "if (!element.prev().is(':checked')) element.click()";
|
|
}
|
|
else {
|
|
$run = "if (element.prev().is(':checked')) element.click()";
|
|
}
|
|
|
|
$browser->script(
|
|
"var element = jQuery('$selector')[0] || jQuery('input[name=$selector]')[0];"
|
|
."element = jQuery(element).next('.custom-control-label'); $run;"
|
|
);
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Wait for UI (notice/confirmation/loading/error/warning) message
|
|
* and assert it's text
|
|
*/
|
|
protected function waitForMessage($type, $text)
|
|
{
|
|
$selector = '#messagestack > div.' . $type;
|
|
|
|
$this->browse(function ($browser) use ($selector, $text) {
|
|
$browser->waitFor($selector)->assertSeeIn($selector, $text);
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Starts PHP server.
|
|
*/
|
|
protected static function startWebServer()
|
|
{
|
|
$path = realpath(__DIR__ . '/../../public_html');
|
|
$cmd = ['php', '-S', 'localhost:8000'];
|
|
$env = [];
|
|
|
|
static::$phpProcess = new Process($cmd, null, $env);
|
|
static::$phpProcess->setWorkingDirectory($path);
|
|
static::$phpProcess->start();
|
|
|
|
static::afterClass(function () {
|
|
static::$phpProcess->stop();
|
|
});
|
|
}
|
|
}
|