com.github.loyada.jdollarx.singlebrowser.custommatchers.AgGridMatchers Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dollarx-java Show documentation
There is a newer version: 1.5.5
package com.github.loyada.jdollarx.singlebrowser.custommatchers;

import com.github.loyada.jdollarx.ElementProperties;
import com.github.loyada.jdollarx.ElementProperty;
import com.github.loyada.jdollarx.Operations;
import com.github.loyada.jdollarx.singlebrowser.AgGrid;
import com.github.loyada.jdollarx.singlebrowser.AgGridHighLevelOperations;
import com.github.loyada.jdollarx.singlebrowser.InBrowserSinglton;
import org.hamcrest.Description;
import org.hamcrest.Matcher;
import org.hamcrest.TypeSafeMatcher;
import org.openqa.selenium.NoSuchElementException;

import java.util.AbstractMap;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;

import static java.lang.String.format;

/**
 * Hamcrest matchers for an AgGrid
 */
public class AgGridMatchers {
    public static int timeoutMillisecOverride = -1;

    /**
     * Verify that the grid, as defined, is present in the browser.
     * In case of an assertion error, gives a useful error message.
     * The assertion can be strict, in which case only the defined rows are expected to exist.
     *
     * @return a Hamcrest matcher
     */
    public static Matcher isPresent() {
        return new TypeSafeMatcher() {
            private AgGrid grid;
            private Exception ex;

            @Override
            public String toString() {
                return "The given Ag-Grid instance is present in the browser";
            }

            @Override
            public void describeTo(final Description description) {
                description.appendText("browser page contains " + grid);
            }

            @Override
            protected void describeMismatchSafely(final AgGrid el,
                                                  final Description mismatchDescription) {
                mismatchDescription.appendText(
                        format("%s is absent.\n Reason: could not find %s", grid, this.ex.getMessage()));
            }

            @Override
            protected boolean matchesSafely(final AgGrid grid) {
                this.grid = grid;
                try {
                    int timeout = getTimeoutInMillis() / 4;
                    Operations.doWithRetries(grid::findTableInBrowser,
                            4,
                            timeout);
                    return true;
                } catch(NoSuchElementException e) {
                    this.ex = e;
                    return false;
                } finally {
                    // return implicit timeout to a more reasonable value
                    if (grid.isVirtualized())
                        grid.setFinalTimeout();
                }
            }
        };
    }

    /**
     * Verify that the grid, as defined, contains a row (which can be partial)
     *
     * @return a Hamcrest matcher
     */
    public static TypeSafeMatcher containsRow(Map row) {
        return new TypeSafeMatcher() {

            @Override
            public String toString() {
                return "The given Ag-Grid instance contains the row";
            }

            @Override
            public void describeTo(final Description description) {
                description.appendText("grid contains row");
            }

            @Override
            protected void describeMismatchSafely(
                    final AgGridHighLevelOperations agGridHighLevelOperations,
                    final Description mismatchDescription) {
                mismatchDescription.appendText(
                        format("there is no grid with the row %s in the grid", row.toString()));
            }

            @Override
            protected boolean matchesSafely(final AgGridHighLevelOperations agGridHighLevelOperations) {
                List columns = new ArrayList<>(row.keySet());
                AgGrid grid = agGridHighLevelOperations.buildMinimalGridFromHeader(columns);
                Map transformedRow = row.entrySet().stream()
                        .map(e -> new AbstractMap.SimpleEntry<>(
                                e.getKey(),
                                ElementProperties.hasAggregatedTextEqualTo(e.getValue()==null ? "" : e.getValue())))
                        .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));

                try {
                    int timeout = getTimeoutInMillis() / 4;
                    Operations.doWithRetries(() -> grid.findRowIndex(transformedRow),
                            4,
                            timeout);
                    return true;
                } catch (Exception e) {
                    return false;
                }
            }
        };
    }

    private static int getTimeoutInMillis() {
        return (timeoutMillisecOverride >= 0 ?
                timeoutMillisecOverride :
                (int)InBrowserSinglton.getImplicitTimeoutInMillisec());
    }
}