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

540 lines
18 KiB
PHP

<?php
/**
*
* @copyright Copyright (c) 2018, Daniel Calviño Sánchez (danxuliu@gmail.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 FilesAppSharingContext implements Context, ActorAwareInterface {
use ActorAware;
/**
* @return Locator
*/
public static function sharedByLabel() {
return Locator::forThe()->css(".sharing-entry__reshare")->
descendantOf(FilesAppContext::detailsView())->
describedAs("Shared by label in the details view in Files app");
}
/**
* @return Locator
*/
public static function shareWithInput() {
return Locator::forThe()->css(".sharing-input .multiselect__input")->
descendantOf(FilesAppContext::detailsView())->
describedAs("Share with input in the details view in Files app");
}
/**
* @return Locator
*/
public static function shareWithInputResults() {
return Locator::forThe()->css(".sharing-input .multiselect__content-wrapper")->
descendantOf(FilesAppContext::detailsView())->
describedAs("Share with input results list in the details view in Files app");
}
/**
* @return Locator
*/
public static function shareWithInputResult($result) {
return Locator::forThe()->xpath("//li[contains(concat(' ', normalize-space(@class), ' '), ' multiselect__element ')]//span[normalize-space() = '$result']/ancestor::li")->
descendantOf(self::shareWithInputResults())->
describedAs("Share with input result from the results list in the details view in Files app");
}
/**
* @return Locator
*/
public static function shareeList() {
return Locator::forThe()->css(".sharing-sharee-list")->
descendantOf(FilesAppContext::detailsView())->
describedAs("Sharee list in the details view in Files app");
}
/**
* @return Locator
*/
public static function sharedWithRow($sharedWithName) {
// "username" class is used for any type of share, not only for shares
// with users.
return Locator::forThe()->xpath("//li[contains(concat(' ', normalize-space(@class), ' '), ' sharing-entry ')]//h5[normalize-space() = '$sharedWithName']/ancestor::li")->
descendantOf(self::shareeList())->
describedAs("Shared with $sharedWithName row in the details view in Files app");
}
/**
* @return Locator
*/
public static function shareWithMenuButton($sharedWithName) {
return Locator::forThe()->css(".sharing-entry__actions > .action-item__menutoggle")->
descendantOf(self::sharedWithRow($sharedWithName))->
describedAs("Share with $sharedWithName menu button in the details view in Files app");
}
/**
* @return Locator
*/
public static function shareWithMenu($sharedWithName) {
return Locator::forThe()->css(".sharing-entry__actions > .action-item__menu")->
descendantOf(self::sharedWithRow($sharedWithName))->
describedAs("Share with $sharedWithName menu in the details view in Files app");
}
/**
* @return Locator
*/
public static function permissionCheckboxFor($sharedWithName, $itemText) {
// forThe()->checkbox($itemText) can not be used here; that would return
// the checkbox itself, but the element that the user interacts with is
// the label.
return Locator::forThe()->xpath("//label[normalize-space() = '$itemText']")->
descendantOf(self::shareWithMenu($sharedWithName))->
describedAs("$itemText checkbox in the share with $sharedWithName menu in the details view in Files app");
}
/**
* @return Locator
*/
public static function permissionCheckboxInputFor($sharedWithName, $itemText) {
return Locator::forThe()->checkbox($itemText)->
descendantOf(self::shareWithMenu($sharedWithName))->
describedAs("$itemText checkbox input in the share with $sharedWithName menu in the details view in Files app");
}
/**
* @return Locator
*/
public static function canReshareCheckbox($sharedWithName) {
return self::permissionCheckboxFor($sharedWithName, 'Allow resharing');
}
/**
* @return Locator
*/
public static function canReshareCheckboxInput($sharedWithName) {
return self::permissionCheckboxInputFor($sharedWithName, 'Allow resharing');
}
/**
* @return Locator
*/
public static function shareLinkRow() {
return Locator::forThe()->css(".sharing-link-list .sharing-entry__link:first-child")->
descendantOf(FilesAppContext::detailsView())->
describedAs("Share link row in the details view in Files app");
}
/**
* @return Locator
*/
public static function shareLinkAddNewButton() {
// When there is no link share the "Add new share" item is shown instead
// of the menu button as a direct child of ".share-menu".
return Locator::forThe()->css(".action-item.icon-add")->
descendantOf(self::shareLinkRow())->
describedAs("Add new share link button in the details view in Files app");
}
/**
* @return Locator
*/
public static function copyLinkButton() {
return Locator::forThe()->css("a.sharing-entry__copy")->
descendantOf(self::shareLinkRow())->
describedAs("Copy link button in the details view in Files app");
}
/**
* @return Locator
*/
public static function shareLinkMenuButton() {
return Locator::forThe()->css(".sharing-entry__actions .action-item__menutoggle")->
descendantOf(self::shareLinkRow())->
describedAs("Share link menu button in the details view in Files app");
}
/**
* @return Locator
*/
public static function shareLinkMenu() {
return Locator::forThe()->css(".sharing-entry__actions .action-item__menu")->
descendantOf(self::shareLinkRow())->
describedAs("Share link menu in the details view in Files app");
}
/**
* @return Locator
*/
public static function hideDownloadCheckbox() {
// forThe()->checkbox("Hide download") can not be used here; that would
// return the checkbox itself, but the element that the user interacts
// with is the label.
return Locator::forThe()->xpath("//label[normalize-space() = 'Hide download']")->
descendantOf(self::shareLinkMenu())->
describedAs("Hide download checkbox in the details view in Files app");
}
/**
* @return Locator
*/
public static function hideDownloadCheckboxInput() {
return Locator::forThe()->checkbox("Hide download")->
descendantOf(self::shareLinkMenu())->
describedAs("Hide download checkbox input in the details view in Files app");
}
/**
* @return Locator
*/
public static function allowUploadAndEditingRadioButton() {
// forThe()->radio("Allow upload and editing") can not be used here;
// that would return the radio button itself, but the element that the
// user interacts with is the label.
return Locator::forThe()->xpath("//label[normalize-space() = 'Allow upload and editing']")->
descendantOf(self::shareLinkMenu())->
describedAs("Allow upload and editing radio button in the details view in Files app");
}
/**
* @return Locator
*/
public static function passwordProtectCheckbox() {
// forThe()->checkbox("Password protect") can not be used here; that
// would return the checkbox itself, but the element that the user
// interacts with is the label.
return Locator::forThe()->xpath("//label[normalize-space() = 'Password protect']")->
descendantOf(self::shareLinkMenu())->
describedAs("Password protect checkbox in the details view in Files app");
}
/**
* @return Locator
*/
public static function passwordProtectCheckboxInput() {
return Locator::forThe()->checkbox("Password protect")->
descendantOf(self::shareLinkMenu())->
describedAs("Password protect checkbox input in the details view in Files app");
}
/**
* @return Locator
*/
public static function passwordProtectField() {
return Locator::forThe()->css(".share-link-password input.action-input__input")->descendantOf(self::shareLinkMenu())->
describedAs("Password protect field in the details view in Files app");
}
/**
* @return Locator
*/
public static function disabledPasswordProtectField() {
return Locator::forThe()->css(".share-link-password input.action-input__input[disabled]")->descendantOf(self::shareLinkMenu())->
describedAs("Disabled password protect field in the details view in Files app");
}
/**
* @return Locator
*/
public static function passwordProtectByTalkCheckbox() {
// forThe()->checkbox("Password protect by Talk") can not be used here;
// that would return the checkbox itself, but the element that the user
// interacts with is the label.
return Locator::forThe()->xpath("//label[normalize-space() = 'Password protect by Talk']")->
descendantOf(self::shareLinkMenu())->
describedAs("Password protect by Talk checkbox in the details view in Files app");
}
/**
* @return Locator
*/
public static function passwordProtectByTalkCheckboxInput() {
return Locator::forThe()->checkbox("Password protect by Talk")->
descendantOf(self::shareLinkMenu())->
describedAs("Password protect by Talk checkbox input in the details view in Files app");
}
/**
* @Given I share the link for :fileName
*/
public function iShareTheLinkFor($fileName) {
$this->actor->find(FileListContext::shareActionForFile(FilesAppContext::currentSectionMainView(), $fileName), 10)->click();
$this->actor->find(self::shareLinkAddNewButton(), 5)->click();
}
/**
* @Given I share :fileName with :shareWithName
*/
public function iShareWith($fileName, $shareWithName) {
$this->actor->find(FileListContext::shareActionForFile(FilesAppContext::currentSectionMainView(), $fileName), 10)->click();
$this->actor->find(self::shareWithInput(), 5)->setValue($shareWithName);
// "setValue()" ends sending a tab, which unfocuses the input and causes
// the results to be hidden, so the input needs to be clicked to show
// the results again.
$this->actor->find(self::shareWithInput())->click();
$this->actor->find(self::shareWithInputResult($shareWithName), 5)->click();
}
/**
* @Given I write down the shared link
*/
public function iWriteDownTheSharedLink() {
$this->actor->find(self::copyLinkButton(), 10)->click();
// Clicking on the menu item copies the link to the clipboard, but it is
// not possible to access that value from the acceptance tests. Due to
// this the value of the attribute that holds the URL is used instead.
$this->actor->getSharedNotebook()["shared link"] = $this->actor->find(self::copyLinkButton(), 2)->getWrappedElement()->getAttribute("href");
}
/**
* @When I set the download of the shared link as hidden
*/
public function iSetTheDownloadOfTheSharedLinkAsHidden() {
$this->showShareLinkMenuIfNeeded();
$this->iSeeThatTheDownloadOfTheLinkShareIsShown();
$this->actor->find(self::hideDownloadCheckbox(), 2)->click();
}
/**
* @When I set the download of the shared link as shown
*/
public function iSetTheDownloadOfTheSharedLinkAsShown() {
$this->showShareLinkMenuIfNeeded();
$this->iSeeThatTheDownloadOfTheLinkShareIsHidden();
$this->actor->find(self::hideDownloadCheckbox(), 2)->click();
}
/**
* @When I set the shared link as editable
*/
public function iSetTheSharedLinkAsEditable() {
$this->showShareLinkMenuIfNeeded();
$this->actor->find(self::allowUploadAndEditingRadioButton(), 2)->click();
}
/**
* @When I protect the shared link with the password :password
*/
public function iProtectTheSharedLinkWithThePassword($password) {
$this->showShareLinkMenuIfNeeded();
$this->actor->find(self::passwordProtectCheckbox(), 2)->click();
$this->actor->find(self::passwordProtectField(), 2)->setValue($password . "\r");
}
/**
* @When I set the password of the shared link as protected by Talk
*/
public function iSetThePasswordOfTheSharedLinkAsProtectedByTalk() {
$this->showShareLinkMenuIfNeeded();
$this->iSeeThatThePasswordOfTheLinkShareIsNotProtectedByTalk();
$this->actor->find(self::passwordProtectByTalkCheckbox(), 2)->click();
}
/**
* @When I set the password of the shared link as not protected by Talk
*/
public function iSetThePasswordOfTheSharedLinkAsNotProtectedByTalk() {
$this->showShareLinkMenuIfNeeded();
$this->iSeeThatThePasswordOfTheLinkShareIsProtectedByTalk();
$this->actor->find(self::passwordProtectByTalkCheckbox(), 2)->click();
}
/**
* @When I set the share with :shareWithName as not reshareable
*/
public function iSetTheShareWithAsNotReshareable($shareWithName) {
$this->showShareWithMenuIfNeeded($shareWithName);
$this->iSeeThatCanReshareTheShare($shareWithName);
$this->actor->find(self::canReshareCheckbox($shareWithName), 2)->click();
}
/**
* @Then I see that the file is shared with me by :sharedByName
*/
public function iSeeThatTheFileIsSharedWithMeBy($sharedByName) {
PHPUnit_Framework_Assert::assertEquals(
$this->actor->find(self::sharedByLabel(), 10)->getText(), "Shared with you by $sharedByName");
}
/**
* @Then I see that the file is shared with :sharedWithName
*/
public function iSeeThatTheFileIsSharedWith($sharedWithName) {
PHPUnit_Framework_Assert::assertTrue(
$this->actor->find(self::sharedWithRow($sharedWithName), 10)->isVisible());
}
/**
* @Then I see that resharing the file is not allowed
*/
public function iSeeThatResharingTheFileIsNotAllowed() {
PHPUnit_Framework_Assert::assertEquals(
$this->actor->find(self::shareWithInput(), 10)->getWrappedElement()->getAttribute("disabled"), "disabled");
PHPUnit_Framework_Assert::assertEquals(
$this->actor->find(self::shareWithInput(), 10)->getWrappedElement()->getAttribute("placeholder"), "Resharing is not allowed");
}
/**
* @Then I see that :sharedWithName can reshare the share
*/
public function iSeeThatCanReshareTheShare($sharedWithName) {
$this->showShareWithMenuIfNeeded($sharedWithName);
PHPUnit_Framework_Assert::assertTrue(
$this->actor->find(self::canReshareCheckboxInput($sharedWithName), 10)->isChecked());
}
/**
* @Then I see that :sharedWithName can not reshare the share
*/
public function iSeeThatCanNotReshareTheShare($sharedWithName) {
$this->showShareWithMenuIfNeeded($sharedWithName);
PHPUnit_Framework_Assert::assertFalse(
$this->actor->find(self::canReshareCheckboxInput($sharedWithName), 10)->isChecked());
}
/**
* @Then I see that the download of the link share is hidden
*/
public function iSeeThatTheDownloadOfTheLinkShareIsHidden() {
$this->showShareLinkMenuIfNeeded();
PHPUnit_Framework_Assert::assertTrue($this->actor->find(self::hideDownloadCheckboxInput(), 10)->isChecked());
}
/**
* @Then I see that the download of the link share is shown
*/
public function iSeeThatTheDownloadOfTheLinkShareIsShown() {
$this->showShareLinkMenuIfNeeded();
PHPUnit_Framework_Assert::assertFalse($this->actor->find(self::hideDownloadCheckboxInput(), 10)->isChecked());
}
/**
* @Then I see that the password protect is disabled while loading
*/
public function iSeeThatThePasswordProtectIsDisabledWhileLoading() {
PHPUnit_Framework_Assert::assertNotNull($this->actor->find(self::disabledPasswordProtectField(), 10));
if (!WaitFor::elementToBeEventuallyNotShown(
$this->actor,
self::disabledPasswordProtectField(),
$timeout = 10 * $this->actor->getFindTimeoutMultiplier())) {
PHPUnit_Framework_Assert::fail("The password protect field is still disabled after $timeout seconds");
}
}
/**
* @Then I see that the link share is password protected
*/
public function iSeeThatTheLinkShareIsPasswordProtected() {
$this->showShareLinkMenuIfNeeded();
PHPUnit_Framework_Assert::assertTrue($this->actor->find(self::passwordProtectCheckboxInput(), 10)->isChecked(), "Password protect checkbox is checked");
PHPUnit_Framework_Assert::assertTrue($this->actor->find(self::passwordProtectField(), 10)->isVisible(), "Password protect field is visible");
}
/**
* @Then I see that the password of the link share is protected by Talk
*/
public function iSeeThatThePasswordOfTheLinkShareIsProtectedByTalk() {
$this->showShareLinkMenuIfNeeded();
PHPUnit_Framework_Assert::assertTrue($this->actor->find(self::passwordProtectByTalkCheckboxInput(), 10)->isChecked());
}
/**
* @Then I see that the password of the link share is not protected by Talk
*/
public function iSeeThatThePasswordOfTheLinkShareIsNotProtectedByTalk() {
$this->showShareLinkMenuIfNeeded();
PHPUnit_Framework_Assert::assertFalse($this->actor->find(self::passwordProtectByTalkCheckboxInput(), 10)->isChecked());
}
/**
* @Then I see that the checkbox to protect the password of the link share by Talk is not shown
*/
public function iSeeThatTheCheckboxToProtectThePasswordOfTheLinkShareByTalkIsNotShown() {
$this->showShareLinkMenuIfNeeded();
try {
PHPUnit_Framework_Assert::assertFalse(
$this->actor->find(self::passwordProtectByTalkCheckbox())->isVisible());
} catch (NoSuchElementException $exception) {
}
}
/**
* @Given I share the link for :fileName protected by the password :password
*/
public function iShareTheLinkForProtectedByThePassword($fileName, $password) {
$this->iShareTheLinkFor($fileName);
$this->iProtectTheSharedLinkWithThePassword($password);
$this->iSeeThatThePasswordProtectIsDisabledWhileLoading();
}
private function showShareLinkMenuIfNeeded() {
// In some cases the share menu is hidden after clicking on an action of
// the menu. Therefore, if the menu is visible, wait a little just in
// case it is in the process of being hidden due to a previous action,
// in which case it is shown again.
if (WaitFor::elementToBeEventuallyNotShown(
$this->actor,
self::shareLinkMenu(),
$timeout = 2 * $this->actor->getFindTimeoutMultiplier())) {
$this->actor->find(self::shareLinkMenuButton(), 10)->click();
}
}
private function showShareWithMenuIfNeeded($shareWithName) {
// In some cases the share menu is hidden after clicking on an action of
// the menu. Therefore, if the menu is visible, wait a little just in
// case it is in the process of being hidden due to a previous action,
// in which case it is shown again.
if (WaitFor::elementToBeEventuallyNotShown(
$this->actor,
self::shareWithMenu($shareWithName),
$timeout = 2 * $this->actor->getFindTimeoutMultiplier())) {
$this->actor->find(self::shareWithMenuButton($shareWithName), 10)->click();
}
}
}