PermissionsSubPage.java

/*
 * (C) Copyright 2016 Nuxeo SA (http://nuxeo.com/) and others.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Contributors:
 *     Thomas Roger
 *     Yannis JULIENNE
 */
package org.nuxeo.functionaltests.pages.tabs;

import java.io.File;
import java.util.List;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.nuxeo.functionaltests.AjaxRequestManager;
import org.nuxeo.functionaltests.Locator;
import org.nuxeo.functionaltests.Required;
import org.nuxeo.functionaltests.ScreenshotTaker;
import org.nuxeo.functionaltests.WaitForJQueryAjaxOnLoading;
import org.nuxeo.functionaltests.forms.Select2WidgetElement;
import org.nuxeo.functionaltests.pages.AbstractPage;
import org.openqa.selenium.By;
import org.openqa.selenium.NoSuchElementException;
import org.openqa.selenium.NotFoundException;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.support.FindBy;

/**
 * @since 7.10
 */
@WaitForJQueryAjaxOnLoading
public class PermissionsSubPage extends AbstractPage {

    private static final Log log = LogFactory.getLog(PermissionsSubPage.class);

    // moved @Required on this element to allow read only view
    @Required
    @FindBy(xpath = "//div[contains(@class, 'jsLocalPermissions')]")
    WebElement localPermissions;

    @FindBy(xpath = "//div[contains(@class, 'jsLocalPermissions')]/*/paper-button")
    WebElement newPermission;

    @FindBy(xpath = "//paper-button[@id='block']")
    WebElement blockPermissions;

    @FindBy(xpath = "//paper-button[@id='unblock']")
    WebElement unblockPermissions;

    public PermissionsSubPage(WebDriver driver) {
        super(driver);
    }

    /**
     * @deprecated as of 8.3, replaced by {@link #hasPermission(String, String)}
     */
    @Deprecated
    public boolean hasPermissionForUser(String permission, String username) {
        return hasPermission(permission, username);
    }

    /**
     * @since 8.3
     */
    public boolean hasPermission(String permission, String userOrGroupName) {
        List<WebElement> elements = driver.findElements(By.xpath("//div[contains(@class, 'acl-table-row effective')]"));
        boolean hasPermission = false;
        for (WebElement element : elements) {
            List<WebElement> names = element.findElements(By.xpath(".//span[contains(@class, 'tag')]"));
            List<WebElement> perms = element.findElements(By.className("label"));
            if (names.size() > 0 && perms.size() > 0) {
                String title = names.get(0).getAttribute("title");
                String perm = perms.get(0).getText();
                if (title.startsWith(userOrGroupName) && permission.equalsIgnoreCase(perm)) {
                    hasPermission = true;
                    break;
                }
            }
        }
        return hasPermission;
    }

    /**
     * @deprecated as of 8.3, replaced by {@link #grantPermission(String, String)}
     */
    @Deprecated
    public PermissionsSubPage grantPermissionForUser(String permission, String username) {
        return grantPermission(permission, username);
    }

    /**
     * @since 8.3
     */
    public PermissionsSubPage grantPermission(String permission, String userOrGroupName) {

        waitUntilEnabledAndClick(newPermission);

        WebElement addPermissionH2 = findElementWithTimeout(By.xpath("//h2[text()='Add a Permission']"));
        WebElement popup = addPermissionH2.findElement(By.xpath(".."));

        Select2WidgetElement userSelection = new Select2WidgetElement(driver,
                popup.findElement(By.className("select2-container")), false);
        userSelection.selectValue(userOrGroupName);

        // select the permission
        popup.findElement(By.tagName("iron-icon")).click();
        Locator.waitUntilGivenFunction(input -> {
            try {
                WebElement el = popup.findElement(By.tagName("paper-item"));
                return el.isDisplayed();
            } catch (NoSuchElementException e) {
                return false;
            }
        });
        List<WebElement> elements = popup.findElements(By.tagName("paper-item"));
        for (WebElement element : elements) {
            if (permission.equalsIgnoreCase(element.getText())) {
                element.click();
                break;
            }
        }

        // NXP-19932: take screenshot to help understanding potential randoms on click
        ScreenshotTaker taker = new ScreenshotTaker();
        File screenShot = taker.takeScreenshot(driver, "PermissionSubPage-add-permission-");
        log.warn("Screenshot taken : " + screenShot.getAbsolutePath());
        // click on Create
        Locator.findElementWaitUntilEnabledAndClick(popup, By.xpath(".//paper-button[text()='Create']"));
        waitForPermissionAdded(permission, userOrGroupName);

        return asPage(PermissionsSubPage.class);
    }

    protected void waitForPermissionAdded(String permission, String userOrGroupName) {
        // wait for any JQuery ajax request to complete
        new AjaxRequestManager(driver).waitForJQueryRequests();
        Locator.waitUntilGivenFunction(input -> hasPermission(permission, userOrGroupName));
    }

    /**
     * @since 8.3
     */
    public PermissionsSubPage blockPermissions() {
        waitUntilEnabledAndClick(blockPermissions);
        Locator.waitUntilElementPresent(By.xpath("//paper-button[@id='unblock']"));
        return asPage(PermissionsSubPage.class);
    }

    /**
     * @since 8.3
     */
    public PermissionsSubPage unblockPermissions() {
        waitUntilEnabledAndClick(unblockPermissions);
        Locator.waitUntilElementPresent(By.xpath("//paper-button[@id='block']"));
        return asPage(PermissionsSubPage.class);
    }

    /**
     * @since 8.3
     */
    public PermissionsSubPage deletePermission(String permission, String userOrGroupName) {
        WebElement deleteButton = findDeleteButton(permission, userOrGroupName);
        if (deleteButton != null) {
            Locator.waitUntilEnabledAndClick(deleteButton);
            Locator.waitUntilElementPresent(
                    By.xpath("//h2[contains(text(), 'The following permission will be deleted')]"));
            findElementWaitUntilEnabledAndClick(By.xpath("//paper-button[text()='Delete']"));
            Locator.waitUntilElementPresent(By.xpath("//span[text()='Permission deleted.']"));
        }
        return asPage(PermissionsSubPage.class);
    }

    private WebElement findDeleteButton(String permission, String userOrGroupName) {
        List<WebElement> elements = driver.findElements(By.xpath("//div[contains(@class, 'acl-table-row effective')]"));
        for (WebElement element : elements) {
            List<WebElement> names = element.findElements(By.xpath(".//span[contains(@class, 'tag')]"));
            List<WebElement> perms = element.findElements(By.className("label"));
            if (names.size() > 0 && perms.size() > 0) {
                String title = names.get(0).getAttribute("title");
                String perm = perms.get(0).getText();
                if (title.startsWith(userOrGroupName) && permission.equalsIgnoreCase(perm)) {
                    return element.findElement(By.xpath(".//paper-icon-button[@icon='delete']"));
                }
            }
        }
        return null;
    }

    /**
     * @since 8.3
     */
    public boolean hasNewPermissionButton() {
        try {
            waitUntilEnabled(newPermission);
            return true;
        } catch (NotFoundException e) {
            return false;
        }
    }
}