summaryrefslogtreecommitdiffstats
path: root/integration-tests/src/test/java/org/onap/sdc/frontend/ci/tests/utilities/LoaderHelper.java
blob: 6406c2a46029c0c438b0dcce34a6be3a2258816e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
/*
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2019 Nordix Foundation
 *  ================================================================================
 *  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.
 *
 *  SPDX-License-Identifier: Apache-2.0
 *  ============LICENSE_END=========================================================
 */

package org.onap.sdc.frontend.ci.tests.utilities;

import lombok.AllArgsConstructor;
import lombok.Getter;
import org.onap.sdc.frontend.ci.tests.pages.AbstractPageObject;
import org.openqa.selenium.By;
import org.openqa.selenium.WebDriver;

public class LoaderHelper extends AbstractPageObject {

    private final By loaderLocator = By.xpath(
        "//*[@data-tests-id='loader' or @class='tlv-loader' or @class='sdc-loader' or @class='sdc-loader-global-wrapper sdc-loader-background']");

    public LoaderHelper(final WebDriver webDriver) {
        super(webDriver);
    }

    /**
     * Wait for the loader to be visible and then invisible.
     *
     * @param timeout the time in seconds to wait for the loader.
     * @deprecated this method uses a generic locator to find for the loader, but the selector is not generic enough to every loader and can find
     * unrelated loaders on the screen. Use {@link #waitForLoader(XpathSelector, int)} instead, where it is possible to use a specific loader
     * selector.
     */
    @Deprecated
    public void waitForLoader(final int timeout) {
        waitForElementVisibility(loaderLocator, timeout);
        waitForElementInvisibility(loaderLocator, timeout);
    }

    /**
     * Wait for the loader to be visible and then invisible.
     *
     * @param xpathSelector    the xpath to find the loader
     * @param timeoutInSeconds the time in seconds to wait for the loader.
     */
    public void waitForLoader(final XpathSelector xpathSelector, final int timeoutInSeconds) {
        final By xpath = By.xpath(xpathSelector.getXpath());
        try {
            waitForElementVisibility(xpath, timeoutInSeconds);
        } catch (final Exception ignored) {
            //if no loader is visible anymore, just ignore
        }
        waitForElementInvisibility(xpath, timeoutInSeconds);
    }

    public void waitForLoaderInvisibility(final int timeout) {
        waitForElementInvisibility(loaderLocator, timeout);
    }

    @Override
    public void isLoaded() {
        //is loaded is not applicable to this component.
    }

    /**
     * Enum that contains identifiers and xpath expressions to elements related to the enclosing page object.
     */
    @AllArgsConstructor
    @Getter
    public enum XpathSelector {
        LOADER_WITH_LOADER_BACKGROUND("//*[contains(@class, 'sdc-loader-background')]");

        private final String xpath;
    }
}