nextcloud/tests/acceptance/features/bootstrap/SettingsMenuContext.php

220 lines
5.7 KiB
PHP
Raw Normal View History

<?php
/**
*
* @copyright Copyright (c) 2017, Daniel Calviño Sánchez (danxuliu@gmail.com)
* @copyright Copyright (c) 2018, John Molakvoæ (skjnldsv) (skjnldsv@protonmail.com)
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
use Behat\Behat\Context\Context;
class SettingsMenuContext implements Context, ActorAwareInterface {
use ActorAware;
/**
* @return Locator
*/
public static function settingsSectionInHeader() {
return Locator::forThe()->xpath("//*[@id = 'header']//*[@id = 'settings']")->
describedAs("Settings menu section in the header");
}
/**
* @return Locator
*/
public static function settingsMenuButton() {
return Locator::forThe()->id("expand")->
descendantOf(self::settingsSectionInHeader())->
describedAs("Settings menu button");
}
/**
* @return Locator
*/
public static function settingsMenu() {
return Locator::forThe()->id("expanddiv")->
descendantOf(self::settingsSectionInHeader())->
describedAs("Settings menu");
}
/**
* @return Locator
*/
public static function usersMenuItem() {
return self::menuItemFor("Users");
}
/**
* @return Locator
*/
public static function usersAppsItem() {
return self::menuItemFor("Apps");
}
/**
* @return Locator
*/
public static function logOutMenuItem() {
return self::menuItemFor("Log out");
}
/**
* @return Locator
*/
private static function menuItemFor($itemText) {
Remove "content" locator from acceptance tests The "content" locator uses the "named" Mink selector and the "content" Mink locator to find the element. The "named" Mink first tries to find the elements whose content match exactly the given content but, if none is found, then it tries to find elements that just contain the given content. This behaviour can lead to hard to track issues. Finding the exact match and, if not found, finding the partial match is done in quick succession. In most cases, when looking for an exact match the element is already there, it is returned, and everything works as expected. Or it may not be there, but then it is not there either when finding the partial match, so no element is returned, and everything works as expected (that is, the actor tries to find again the element after some time). However, it can also happen that when looking for an exact match there is no element yet, but it appears after trying to find the exact match but before trying to find the partial match. In that situation the desired element would be returned along with its ancestors. However, as only the first found element is taken into account and the ancestors would appear first the find action would be successful, but the returned element would not be the expected one. This is highly unlikely, yet possible, and can cause sporadic failures in acceptance tests that, apparently, work as expected. Using a "named_exact" Mink selector instead of the "named" Mink selector does not provide the desired behaviour in most cases either. As it finds any element whose content matches exactly the given content, looking for "Hello world" in "<div><p><a>Hello world</a></p></div>" would match the "div", "p" and "a" elements; in that situation the "div" element would be the one returned, when typically the "a" element would be the expected one. As it is error prone and easily replaceable by more robust locators the "content" locator was removed from the predefined ones (although it can still be used if needed through the "customSelector" method in the builder object). Signed-off-by: Daniel Calviño Sánchez <danxuliu@gmail.com>
2017-05-02 13:49:27 +03:00
return Locator::forThe()->xpath("//a[normalize-space() = '$itemText']")->
descendantOf(self::settingsMenu())->
describedAs($itemText . " item in Settings menu");
}
/**
* @param string $itemText
* @return Locator
*/
private static function settingsPanelFor($itemText) {
return Locator::forThe()->xpath("//div[@id = 'app-navigation']//ul//li[@class = 'app-navigation-caption' and normalize-space() = '$itemText']")->
describedAs($itemText . " item in Settings panel");
}
/**
* @param string $itemText
* @return Locator
*/
private static function settingsPanelEntryFor($itemText) {
return Locator::forThe()->xpath("//div[@id = 'app-navigation']//ul//li[normalize-space() = '$itemText']")->
describedAs($itemText . " entry in Settings panel");
}
/**
* @return array
*/
public function menuItems() {
return $this->actor->find(self::settingsMenu(), 10)
->getWrappedElement()->findAll('xpath', '//a');
}
/**
* @When I open the Settings menu
*/
public function iOpenTheSettingsMenu() {
$this->actor->find(self::settingsMenuButton(), 10)->click();
}
/**
* @When I open the User settings
*/
public function iOpenTheUserSettings() {
$this->iOpenTheSettingsMenu();
$this->actor->find(self::usersMenuItem(), 2)->click();
}
/**
* @When I open the Apps management
*/
public function iOpenTheAppsManagement() {
$this->iOpenTheSettingsMenu();
$this->actor->find(self::usersAppsItem(), 2)->click();
}
/**
* @When I visit the settings page
*/
public function iVisitTheSettingsPage() {
$this->iOpenTheSettingsMenu();
$this->actor->find(self::menuItemFor('Settings'), 2)->click();
}
/**
* @When I log out
*/
public function iLogOut() {
$this->iOpenTheSettingsMenu();
$this->actor->find(self::logOutMenuItem(), 2)->click();
}
/**
* @Then I see that the Settings menu is shown
*/
public function iSeeThatTheSettingsMenuIsShown() {
PHPUnit_Framework_Assert::assertTrue(
$this->actor->find(self::settingsMenu(), 10)->isVisible());
}
/**
* @Then I see that the Settings menu has only :items items
*/
public function iSeeThatTheSettingsMenuHasOnlyXItems($items) {
PHPUnit_Framework_Assert::assertCount(intval($items), self::menuItems());
}
/**
* @Then I see that the :itemText item in the Settings menu is shown
*/
public function iSeeThatTheItemInTheSettingsMenuIsShown($itemText) {
PHPUnit_Framework_Assert::assertTrue(
$this->actor->find(self::menuItemFor($itemText), 10)->isVisible());
}
/**
* @Then I see that the :itemText item in the Settings menu is not shown
*/
public function iSeeThatTheItemInTheSettingsMenuIsNotShown($itemText) {
$this->iSeeThatTheSettingsMenuIsShown();
try {
PHPUnit_Framework_Assert::assertFalse(
$this->actor->find(self::menuItemFor($itemText))->isVisible());
} catch (NoSuchElementException $exception) {
}
}
/**
* @Then I see that the :itemText settings panel is shown
*/
public function iSeeThatTheItemSettingsPanelIsShown($itemText) {
PHPUnit_Framework_Assert::assertTrue(
$this->actor->find(self::settingsPanelFor($itemText), 10)->isVisible()
);
}
/**
* @Then I see that the :itemText entry in the settings panel is shown
*/
public function iSeeThatTheItemEntryInTheSettingsPanelIsShown($itemText) {
PHPUnit_Framework_Assert::assertTrue(
$this->actor->find(self::settingsPanelEntryFor($itemText), 10)->isVisible()
);
}
/**
* @Then I see that the :itemText settings panel is not shown
*/
public function iSeeThatTheItemSettingsPanelIsNotShown($itemText) {
try {
PHPUnit_Framework_Assert::assertFalse(
$this->actor->find(self::settingsPanelFor($itemText), 10)->isVisible()
);
} catch (NoSuchElementException $exception) {
}
}
}