io.github.simple4tests.webdriver.framework.Reporter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of webdriver-overload Show documentation
WebDriver overload
There is a newer version: 3.0.6
package io.github.simple4tests.webdriver.framework;

import io.github.simple4tests.webdriver.utils.Groovy;
import org.hamcrest.Matcher;
import org.hamcrest.MatcherAssert;

import java.nio.file.Path;
import java.util.ArrayList;
import java.util.List;

public interface Reporter {

    List errors = new ArrayList<>();

    default boolean hasErrors() {
        return 0 < errors.size();
    }

    default void clearErrors() {
        errors.clear();
    }

    default String getErrorsSummary() {
        if (hasErrors()) {
            return String.format("ERROR(S) SUMMARY\n%s\n", String.join("\n", errors));
        }
        return "ERROR(S) SUMMARY\n*** CONGRATULATIONS! NO ERRORS FOUND ***\n";
    }

    default void throwAssertionErrorIfAny(boolean reportErrorsSummary) {
        if (hasErrors()) {
            if (reportErrorsSummary) {
                reportAction("Report error(s) summary");
                reportData(getErrorsSummary());
            }
            throw new AssertionError(String.format("%d error(s) found", errors.size()));
        }
    }

    default  void assertThat(final String check, final T actual, final Matcher expected) {
        reportCheck(check);
        try {
            MatcherAssert.assertThat("", actual, expected);
        } catch (AssertionError e) {
            reportError(getErrorDescription(check, String.format("Actual: %s%s", actual, e.getMessage())));
        }
    }

    default void groovyAssertThat(final String check, final String actual, final String expectedAsGroovyMatcher) {
        reportCheck(check);
        try {
            Groovy.getShell(Groovy.IMPORT_HAMCREST_MATCHERS)
                    .evaluate(String.format("assertThat '%s', %s", actual, expectedAsGroovyMatcher));
        } catch (Throwable t) {
            reportError(getErrorDescription(check, String.format("Actual: %s%s", actual, t.getMessage())));
        }
    }

    default void groovyAssert(final String check, final String groovyAssertExpression) {
        reportCheck(check);
        try {
            Groovy.getShell().evaluate(String.format("assert %s", groovyAssertExpression));
        } catch (Throwable t) {
            reportError(getErrorDescription(check, t.getMessage()));
        }
    }

    private String getErrorDescription(String check, String mismatch) {
        return String.format("%s ?\n%s\n", check, mismatch);
    }

    void reportAction(String action);

    void reportData(String data);

    void reportData(Path path);

    void reportCheck(String check);

    void reportError(String error);

    void reportError(Path path);

    void reportScreenshot();
}