# Setting the browser
tt.browser.setting=chrome

# ... or with version
tt.browser.setting=chrome:120

# Setting the start page
tt.baseurl=http://example.org

import eu.tsystems.mms.tic.testframework.pageobjects.Page;
import eu.tsystems.mms.tic.testframework.pageobjects.UiElement;

public class ExamplePage extends Page {

    @Check
    private UiElement moreInformationLink =
        find(By.partialLinkText("More information"));

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

    public void clickOnMoreInformation() {
        moreInformationLink.click();
    }
}

<!DOCTYPE suite SYSTEM "https://testng.org/testng-1.0.dtd" >
<suite name="Suite1" verbose="1" thread-count="10" configfailurepolicy="continue" parallel="false">
    <test name="Test1" parallel="methods">
        <classes>
            <class name="ExampleTest"/>
        </classes>
    </test>
</suite>

gradle test -Dhttps.proxyHost=your-proxy-host.com -Dhttps.proxyPort=8080

https.proxyHost=your-proxy-host.com
https.proxyPort=8080
https.proxyUser=
https.proxyPassword=
https.nonProxyHosts=localhost|192.168.0.1

http.proxyHost=your-proxy-host.com
http.proxyPort=8080
http.proxyUser=
http.proxyPassword=

gradle test -Djava.net.useSystemProxies=true

class MyClass implements Loggable {

    public void doSomething() {
        log().info("Do something");
    }
}

[main][INFO][MCID:xyz][SCID:abc]: MyClass - Do something

tt.selenium.server.url=http://localhost:4444/wd/hub

# Only browser type
tt.browser.setting=firefox

# ... or with version
tt.browser.setting=firefox:65

WebDriver driver = WEB_DRIVER_MANAGER.getWebDriver();

WebDriver driver = WEB_DRIVER_MANAGER.getWebDriver();
WebDriver driverWindow2 = WEB_DRIVER_MANAGER.getWebDriver("window2");

// Get the session key
String key1 = WEB_DRIVER_MANAGER.getSessionKey(driver);        // key1 contains 'default'

String key2 = WEB_DRIVER_MANAGER.getSessionKey(driverWindow2); // key2 contains 'window2'

// Shutdown a session by key
WEB_DRIVER_MANAGER.shutdownSession(String);

// Shutdown an explicit driver
WEB_DRIVER_MANAGER.shutdownSession(WebDriver);

// Close all active session in the current test context.
WEB_DRIVER_MANAGER.shutdownAllThreadSessions();

// Close all active session in all current parallel test threads.
WEB_DRIVER_MANAGER.shutdownAllSessions()

tt.wdm.closewindows.aftertestmethods=false

@Test
public void test1() {
    WebDriver driver = WEB_DRIVER_MANAGER.getWebDriver();
}

@Test
public void test2() {
    // You get the already opened session from test1
    WebDriver driver = WEB_DRIVER_MANAGER.getWebDriver();
}

@BeforeMethod
public void setupBrowser() {
    DesktopWebDriverRequest request = new DesktopWebDriverRequest();
    request.setShutdownAfterTest(false);
    WebDriver driver = WEB_DRIVER_MANAGER.getWebDriver(request);
}

@Test
public void test() {
    WebDriver driver = WEB_DRIVER_MANAGER.getWebDriver();
}

@AfterMethod(alwaysRun = true)
public void shutdownBrowser() {
    WEB_DRIVER_MANAGER.shutdownAllThreadSessions();
}

private static String uuid = null;

@Test
public void test1() {
    WebDriver driver = WEB_DRIVER_MANAGER.getWebDriver();
    uuid = WEB_DRIVER_MANAGER.makeExclusive(driver);
}

@Test
public void test2() {
    // Get the exclusive session
    WebDriver driver = WEB_DRIVER_MANAGER.getWebDriver(uuid);
}

DesktopWebDriverRequest myRequest = new DesktopWebDriverRequest();
myRequest.setBaseUrl("http://example.org");
myRequest.setBrowser(Browsers.firefox);
myRequest.setBrowserVersion("66");
myRequest.setSessionKey("mysession");
myRequest.setWindowSize(new Dimension(2560,1440));  // tt.window.size
myRequest.setShutdownAfterTest(false);              // applies to all test method results
                                                    // tt.wdm.closewindows.aftertestmethods
myRequest.setShutdownAfterTestFailed(false);        // applies only to failed test methods
                                                    // tt.wdm.closewindows.onfailure
myRequest.setMaximizeBrowser(true);                 // tt.browser.maximize

WebDriver driver = WEB_DRIVER_MANAGER.getWebDriver(myRequest);

Optional<SessionContext> sessionContext = WEB_DRIVER_MANAGER.getSessionContext(webDriver);
// In case of a desktop browser you can cast to 'DesktopWebDriverRequest'
// Be careful if you are using other session types like Appium sessions!
DesktopWebDriverRequest webDriverRequest
    = (DesktopWebDriverRequest) sessionContext.get().getWebDriverRequest();

WebDriver driver = WebDriverManager.getWebDriver();
Optional<SessionContext> sessionContext = WEB_DRIVER_MANAGER.getSessionContext(driver);

// Switch to a window by matching title with 'equals()'
WEB_DRIVER_MANAGER.switchToWindowTitle(WebDriver webDriver, String windowTitle);

// Switch to a given window handle
WEB_DRIVER_MANAGER.switchToWindowHandle(WebDriver webDriver, String windowHandle);

// Switch to a window by a custom condition
boolean switched = WEB_DRIVER_MANAGER
        .switchToWindow(WebDriver webDriver, webDriver -> webDriver.getCurrentUrl().contains("login"));

Assert.assertTrue(switched, "Login window not found");

int secondsForRetry = 6;
CONTROL.retryFor(secondsForRetry, () -> {
    WEB_DRIVER_MANAGER.switchToWindowTitle(webDriver, "MyWindowTitle");
});

// Using a predicate you have to check the result of switching
CONTROL.retryFor(secondsForRetry, () -> {
    boolean result = WEB_DRIVER_MANAGER
            .switchToWindow(webDriver, driver -> driver.getTitle().contains("MyWindowTitle"));
    Assert.assertTrue(result);
});

UiElement myElement = find(By.id("elementId"));
UiElement button1 = find(By.name("button"));
UiElement textOutputField = find(By.xpath("//p[@id='99']"));

UiElement upper = find(By.name("upperElement"));

// Create the sub elements
UiElement lower = upper.find(By.name("lowerElement"));
UiElement lower = upper.find(By.xpath(".//p[@id='element']")); (1)
UiElement lower = upper.find(By.xpath("//p[@id='element']")); (2)
UiElement lower = upper.find(By.xpath("./p[@id='element']")); (3)

import eu.tsystems.mms.tic.testframework.pageobjects.UiElementFinder;
import eu.tsystems.mms.tic.testframework.testing.TesterraTest;
import eu.tsystems.mms.tic.testframework.testing.UiElementFinderFactoryProvider;
import eu.tsystems.mms.tic.testframework.testing.WebDriverManagerProvider;

class MyTest extends TesterraTest implements
    UiElementFinderFactoryProvider,
    WebDriverManagerProvider
{
    protected UiElementFinder createFinder() {
        return UI_ELEMENT_FINDER_FACTORY.create(WEB_DRIVER_MANAGER.getWebDriver());
    }

    @Test
    public void test() {
        UiElementFinder finder = createFinder();
        UiElement myElement = finder.find(By.id("elementId"));
        UiElement button1 = finder.find(By.name("button"));
        UiElement textOutputField = finder.find(By.xpath("//p[@id='99']"));
    }
}

UiElement frame1 = find(By.id("frame1"));

// frame2 is child of frame1
UiElement frame2 = frame1.find(By.id("frame2"));

// target is child of frame2 which is child of frame1,
UiElement target = frame2.find(By.id("target"));

// in this case the frames are searched recurse automatically
UiElement target = findDeep(By.id("target"));

<div>First</div>
<div>Second</div>
<div>Third</div>

UiElement div = find(By.tagName("div"));
div.list().first().expect().text("First");
div.list().last().expect().text("Third");

div.list().forEach(uiElement -> {});
div.list().stream().forEach(uiElement -> {});

UiElement empty = createEmpty(Locator);

UiElement sensitiveElement = findById("secret").sensitiveData();

Nameable parent = element.getParent();

element.traceAncestors(ancestor -> true);

XPath.from("div").classes("navigation", "header");

<div class="header large navigation">

<div class="navigation-header">

XPath.from("nav")
    .classes("mobile")
    .enclose("/div")
        .classes("navigation", "header");

<nav class="mobile">
    <div class="navigation header"></div>
</nav>

XPath.from("*").text().hasWords("Login", "here");
XPath.from("*").text().contains("first");
XPath.from("*").text().endsWith("here ");

<a> Login first
    here </a>

XPath.from("*").attribute("src").endsWith(".png");

<img src="http://example.com/image.png"/>

XPath.from("form")
    .attribute("name", "login")
    .select("button")
        .text().hasWords("Login here");

<form name="login">
    <button> Login here * </button>
</form>

element.expect().present(boolean);

element.expect().displayed(boolean);

element.expect().visiblePartial(boolean);
element.expect().visibleFull(boolean);

// The following methods are calling the standard webelement method
element.expect().enabled(boolean);
element.expect().selected(boolean);

// Tries to find out if an element could be selected.
element.expect().selectable(boolean);

UiElement element = find(By.id("button"));

// Expect the element text
element.expect().text("Hello World");
element.expect().text().contains("World").is(boolean);
element.expect().text().isContaining("World");  // Short form
element.expect().text().map(String::trim).startsWith("Hello").is(boolean);

// Expect the existence of an attribute
element.expect().attribute(Attribute.DISABLED).isNot(null);

// Expect the value of an input element matches an regular expression
element.expect().value().matches("^hello\\s.orld").is(boolean);

// CSS property checks
element.expect().css("display").is("none");

// CSS class checks
element.expect().hasClasses("active", "button").is(boolean);

// Visibility checks
element.expect().visiblePartial(boolean);
element.expect().visibleFull(boolean);

UiElement left = find(By.id("left"));
UiElement right = find(By.id("right"));

left.expect().bounds().leftOf(right).is(true);

UiElement image1 = find(By.xpath("//..."));
UiElement image2 = find(By.xpath("//..."));
UiElement image3 = find(By.xpath("//..."));

// Assertions are true
image1.expect().bounds().leftOf(image2).is(true);
image1.expect().bounds().fromTop().toTopOf(image2).is(0);
image1.expect().bounds().fromBottom().toBottomOf(image3).is(0);

// Assertions are false
image1.expect().bounds().fromBottom().toBottomOf(image2).is(0);

public class DragAndDropPage extends Page {
    ...
    private UiElement columnA = find(By.id("column-a"));

    public TestableUiElement getColumnA() {
        return this.columnA;
    }
}
...
public MyTest extends TesterraTest implements PageFactoryProvider {
    @Test
    public void myTest() {
        DragAndDropPage page = PAGE_FACTORY.createPage(DragAndDropPage.class);
        page.getColumnA().expect().displayed().is(false); (1)
        page.getColumnB().expect().displayed().is(false, "Foo"); (2)
    }
}

UiElement element = find(By.id("button"));

element.click();
element.doubleClick();
element.contextClick();

UiElement element = find(By.id("input"));

// Enters the given text in a input or textfield.
// Any old values are automatically deleted before input.
// The type method has a value check. If the given string is NULL or empty, the method does nothing.
element.type("my text");

// The standard Selenium method is used.
// You can also use the Selenim Keys class to enter special keys.
element.sendKeys("my text");
element.sendKeys("my text" + Keys.ENTER);

// Delete the content of an input field.
element.clear();

UiElement element = find(By.id("select"));

// Get the Select WebElement of a UiElement
element.findWebElement(webElement -> {
    Select select = new Select(webElement);

    // You can use all Selenium Select methods to interact.
    select.selectByIndex(2);
    select.selectByVisibleText("option");
    List<WebElements> list = select.getAllSelectedOptions();
});

UiElement element = find(By.id("checkbox"));

// Check and uncheck the check box
element.select();
element.deselect();

// true = check, false = uncheck
element.select(boolean);

element.scrollIntoView();

// Lets offset pixel distance from the top of the viewport
element.scrollIntoView(new Point(0, -20))

element.hover();

UiElement source = find(By.id("elem1"));
UiElement target = find(By.id("elem2"));

MouseActions.dragAndDropJS(source, target);

// You can add one or more DragAndDropActions
MouseActions.dragAndDropJS(source, target, DragAndDropOption.CLICK_AFTER_RELEASE);

// This method provides a swipe of an element to a relative position from the element.
int offsetX = 50;   // Pixel
int offsetY = 125;  // Pixel
MouseActions.swipeElement(source, offsetX, offsetY);

element.highlight();

// Or by a given color
element.highlight(new Color(int, int, int));

<a href="newpage.html" class="foolink" style="font-size: 20px;">My link</a>

UiElement element = find(By.xpath("//a"));

String text = element.waitFor().text().getActual();             // returns "My link"
String href = element.waitFor().attribute("href").getActual();  // returns "newpage.html"
String tag = element.waitFor().tagName().getActual();           // returns "a"
String classes = element.waitFor().classes().getActual();       // returns "foolink"
String css = element.waitFor().css("font-size").getActual();    // returns "20px"

<a href="newpage.html" style="font-size: 20px;">My link</a>

UiElement element = find(By.xpath("//a"));

element.findWebElement(webElement -> {
    Point point = webElement.getLocation();     // returns the top left corner of the element
    Dimension dim = webElement.getSize();       // returns width and heigth of the element
    Rectangle rect = webElement.getRect();      // returns rectangle with location and size
});

public class SearchPage extends Page {

    @Check
    private final UiElement searchButton = find(By.name("searchButton"));

    @Check
    private final UiElement inputField = find(By.name("inputField"));

    // constructor
    public SearchPage(WebDriver driver) {
        super(driver);
    }

    // search action on page
    public ResultPage search(String text) {
        inputField.type(text);
        searchButton.click();
        return createPage(ResultPage.class);
    }
}

public class TestClass extends TesterraTest implements PageFactoryProvider {

    @Test
    public void myTest() {
        HomePage homePage = PAGE_FACTORY.createPage(HomePage.class);
        SearchPage searchPage = homePage.openSearch();
        ResultPage resultPage = searchPage.search("search text");
        resultPage.assertResultSetIsNotEmpty();
        homePage = resultPage.close();
    }
}

HomePage homePage = PAGE_FACTORY.createPage(HomePage.class);

// Or use an explicit WebDriver
HomePage homePage = PAGE_FACTORY.createPage(HomePage.class, WebDriver otherWebDriver);

OtherPage otherPage = homePage.createPage(OtherPage.class);

homePage.waitForPage(OtherPage.class).ifPresent(otherPage -> {});
homePage.waitForPage(OtherPage.class, int seconds).ifPresent(otherPage -> {});

class MyPage extends Page {

    @Override
    protected void pageLoaded() {
        super.pageLoaded();

        // additional actions
    }
}

PAGE_FACTORY.setGlobalPagesPrefix("Variation1");
//this actualy creates a Variation1BaseClass
BaseClass baseClass = PAGE_FACTORY.createPage(BaseClass.class);

// Set a global Prefix
PAGE_FACTORY.setGlobalPagesPrefix("prefix");

// Set a thread local prefix. See next row about cleaning this prefix.
PAGE_FACTORY.setThreadLocalPagesPrefix("prefix");

// The thread local pages prefix is not cleared automatically,
// be sure to always set the correct one or clear it after using.
PAGE_FACTORY.removeThreadLocalPagePrefix();

..
<div id="container">
    <input type="text" id="mytext">
    <button id="button">Send</button>
</div>
..

import eu.tsystems.mms.tic.testframework.pageobjects.AbstractComponent;

public class MyComponent extends AbstractComponent<MyComponent> {

    @Check
    UiElement input = find(By.id("mytext"));
    @Check
    UiElement button = find(By.id("button"));

    public MyComponent(UiElement rootElement) {
        super(rootElement);
    }
}

public class MyPage extends Page {

    MyComponent component = createComponent(MyComponent.class, find(By.id("container")));

}

UiElement table = find(By.tagName("table"));
TableRow rows = createComponent(TableRow.class, table.find(By.tagName("tr")));

rows.list().forEach(row -> {
    row.getNameColumn().text().contains("Hello").is(true);
});

public class MyComponent extends AbstractComponent<MyComponent>
        implements UiElementFinderFactoryProvider {

    // This element is a subelement from component's root element
    private UiElement input = find(By.id("mytext"));

    // This element can be outside
    private UiElement button = this.getExternalElement(By.id("button"));

    public MyComponent(UiElement rootElement) {
        super(rootElement);
    }

    private UiElement getExternalElement(By by) {
        UiElementFinder uiElementFinder = UI_ELEMENT_FINDER_FACTORY.create(this.getWebDriver());
        UiElement uiElement = uiElementFinder.find(by);
        if (uiElement instanceof NameableChild) {
            ((NameableChild<?>) uiElement).setParent(this);
        }
        return uiElement;
    }

}

# activate demo mode, default = false
tt.demomode=true

# Set a custom timeout in ms
# 0 -> infinite timeout
# default is 2000
tt.demomode.timeout=5000

@Test
@Fails(description="This test fails for reasons")
public void testItWillFail() {
    Assert.assertTrue(false);
}

public boolean browserCouldFail(MethodContext methodContext) {
    return methodContext.readSessionContexts()
                .map(SessionContext::getActualBrowserName)
                .anyMatch(s -> s.contains("internet explorer"));
}

@Test
@Fails(validator = "browserCouldFail")
public void testSomething() {
    // Perform your tests here
}

public class FailsValidator {
    public boolean expectedFailIsValid(MethodContext methodContext) {
        return true;
    }
}

@Test
@Fails(validatorClass = FailsValidator.class, validator = "expectedFailIsValid")
public void testSomething() {
    // Perform your tests here
}

public class FailsValidator {
    public boolean expectedFailOnCertainException(MethodContext methodContext) {
        // of course it's possible to check for more things inside the throwable
        return methodContext.getTestNgResult().isPresent()
                && methodContext.getTestNgResult().get().getThrowable()
                   instanceof CertainException;
    }
}

@Test
@Fails(validatorClass = FailsValidator.class, validator = "expectedFailOnCertainException")
public void test_customFails() throws CertainException {
    throw new CertainException();
}

@Test()
@Retry(maxRetries = 2)
public void testMethod() {
    // ...
}

# Set additional classes that engage a retry,
tt.failed.tests.if.throwable.classes=java.sql.SQLRecoverableException

# Set additional messages of Throwable that engage a retry,
tt.failed.tests.if.throwable.messages=failed to connect, error communicating with database

// custom Retryanalyzers need to implement the functional interface AdditionalRetryAnalyzer
public class InstantiationExceptionRetryAnalyzer implements AdditionalRetryAnalyzer {

    final String message = "failed instantiation";

    @Override
    public Optional<Throwable> analyzeThrowable(Throwable throwable) {
        String tMessage = throwable.getMessage();
        if (throwable instanceof InstantiationException) {
            if (tMessage != null) {
                final String tMessageLC = tMessage.toLowerCase();
                boolean match = tMessageLC.contains(message);
                if (match) {
                    return Optional.of(throwable);
                }
            }
        }

        return Optional.empty();
    }
}

public class AbstractTest extends TesterraTest {

    static {
        // register the additional Analyzer,
        // which checks for "InstantiationException" and the message "failed instantiation"
        RetryAnalyzer.registerAdditionalRetryAnalyzer(new InstantiationExceptionRetryAnalyzer());
    }

}

@Test()
@NoRetry(name = "No retry because it's not allowed.", color="rgb(255, 236, 139)")
public void testMethod() {
    ...
}

# activate the dry run, default = false
tt.dryrun=true

public class MyTestClass extends TesterraTest implements Loggable {

    @Test
    public void testT01_PriorityMessages() {

    	log().info("It's gonna be ok.", Loggable.prompt);

    	// some test activities ...
        log().warn("Warn me!", Loggable.prompt);

        // some test activities ...
        log().error("Tell me more!", Loggable.prompt);
    }
}

    @Test(groups = "LOGS")
    public void test_promptOutSideMethodContext() {
        new Thread(() -> log().info("Prompt outside method context", Loggable.prompt)).start();
    }

# Exclude all packages or classes which names contain 'abstract' or 'foo', ignoring case sensitives
tt.report.source.exclusion.regex=(?i:abstract|foo)

tt.layoutcheck.reference.path=src/test/resources/layout-references/{tt.browser}
tt.layoutcheck.reference.nametemplate=%s.png

# Highly recommended to disable full screen for browser
tt.browser.maximize=false

# Highly recommended to switch of the demo mode for layout tests
tt.demomode=false

// 1% of the pixels are allowed to be different
float pixelDistanceToleranceThresholdPercent = 1.0;

page.expect().screenshot().pixelDistance("WelcomePage").isLowerThan(pixelDistanceToleranceThresholdPercent);

// 10% of the pixels are allowed to be different
float pixelDistanceToleranceThresholdPercent = 10.0;

uiElement.expect().screenshot().pixelDistance("HeaderComponent").isLowerThan(pixelDistanceToleranceThresholdPercent);

// 5% of the pixels are allowed to be different
float pixelDistanceToleranceThresholdPercent = 5.0;

File absoluteFile = FileUtils.getResourceFile("images/actual.png");
LayoutCheck.assertImage(absoluteFile, "reference", pixelDistanceToleranceThresholdPercent);

tt.layoutcheck.takereference=true

systemProp.file.encoding=utf-8

import eu.tsystems.mms.tic.testframework.l10n.SimpleLocalization;

UiElement loginBtn = find(By.linkText(SimpleLocalization.getText("BTN_LOGIN")));

LocalizedBundle defaultBundle = SimpleLocalization.setDefault(Locale.GERMAN);

Locale sessionLocale = WebDriverManager.getSessionLocale(WebDriver).orElse(Locale.getDefault());

LocalizedBundle sessionBundle = new LocalizedBundle("testdata", sessionLocale);
sessionBundle.getString("TEST_KEY");

public class LocalizedPage extends Page {

    public void switchLocale(Locale locale) {
        // Implement your language switch here
        // ...

        // Don't forget to set the sessions locale
        WebDriverManager.setSessionLocale(getWebDriver(), locale);
    }
}

gradle test -Duser.language=de

<project>
    <properties>
        <user.language>de</user.language>
        <user.country>DE</user.country>
        <argLine>-Duser.language=${user.language} -Duser.country=${user.country}</argLine>
    </properties>
</project>

mvn test -Duser.language=de -Duser.country=DE

String testLanguage = PROPERTY_MANAGER.getProperty("test.language", "de");
Locale.setDefault(Locale.forLanguageTag(testLanguage));

// Jakarta Mail 1.6.x
import javax.mail.Message;
import javax.mail.internet.MimeBodyPart;
import javax.mail.search.AndTerm;
import javax.mail.search.SearchTerm;
...

// Jakarta Mail 2.x
import jakarta.mail.Message;
import jakarta.mail.internet.MimeBodyPart;
import jakarta.mail.search.AndTerm;
import jakarta.mail.search.SearchTerm;
...

POP3MailConnector pop3MailConnector = new POP3MailConnector();

// wait until the email with subject 'test' arrived in the InboxFolder
SubjectTerm subjectTerm = new SubjectTerm(subject);
EmailQuery query = new EmailQuery().setSearchTerm(subjectTerm);
Email email = pop3MailConnector.query(query).findFirst().get();

// delete all emails with this subject from the server while setting timeout and max number of polls explicitly
query.setRetryCount(5);
query.setPauseMs(2000);

Email email = pop3MailConnector.query(query).findFirst().get();

// delete mails matching the given criteria
String recipient = email.getRecipients().get(0));

SearchTerm searchTerm = new AndTerm(new SearchTerm[]{
        subjectTerm,
        new RecipientTerm(RecipientType.TO, new InternetAddress(recipient))
});

pop3MailConnector.deleteMessage(searchTerm);

// wait until the email with subject 'test' arrived in the InboxFolder
EmailQuery query = new EmailQuery().setSearchTerm(new SubjectTerm(subject));
Email email = pop3MailConnector.query(query).findFirst().get();

try {
    Multipart content = (Multipart) email.getMessage().getContent();
    int contentCnt = content.getCount();
    String attachmentFileName = null;

    for (int i = 0; i < contentCnt; i++) {
        Part part = content.getBodyPart(i);

        // Retrieve attachment
        if (part.getDisposition().equals(Part.ATTACHMENT)) {
            attachmentFileName = part.getFileName();
        }
    }
} catch (IOException e) {
    e.printStackTrace();
} catch (MessagingException e) {
    e.printStackTrace();
}

SMTPMailConnector smtpMailConnector = new SMTPMailConnector();

// send a created message
MimeMessage createdMessage = new MimeMessage(session);
try {
    msg.addRecipients(RecipientType.TO, RECIPIENT);
    msg.addFrom(new Address[]{new InternetAddress(SENDER)});
    msg.setSubject("testerra");
    msg.setText("mail text");
} catch (MessagingException e) {
    LOGGER.error(e.toString());
}
smtpMailConnector.sendMessage(createdMessage);

// send an existing message
MimeMessage existingMessage = MailUtils.loadEmailFile("test-mail.eml");
smtpMailConnector.sendMessage(existingMessage);

ImapMailConnector imapMailConnector = new ImapMailConnector();

EmailQuery query = new EmailQuery().setSearchTerm(new SubjectTerm(subject));
imapMailConnector.query(query).findFirst().ifPresent(email -> {
    // EMail found
});

// mark all mails in inbox as seen
imapMailConnector.markAllMailsAsSeen();

// delete all mails in inbox
imapMailConnector.deleteAllMessages();

connector.getMessageCount();
connector.getMessageCount("FolderName");

IMAP_SSL_ENABLED=false
POP3_SSL_ENABLED=false
SMTP_SSL_ENABLED=true

connector.configureSessionProperties(properties -> {
    properties.put("mail.imaps.auth.ntlm.disable", true);
});

connector.getSession().setDebug(true);

DEBUG_SETTING=true

String pahtKeyStore = "your/path/to/cacert.p12";
String password = "123456";
String subject = "test";
String sentContent = "Testerra Testmail"

SMTPMailConnector smtpMailConnector = new SMTPMailConnector();
Session session = smtpMailConnector.getSession();

MimeMessage sentMessage = new MimeMessage(session);
sentMessage.setText(sentContent);
sentMessage.setSubject(subject);

// encrypt message
MimeMessage encryptedMsg = MailUtils.encryptMessageWithKeystore(sentMessage, session, pahtKeyStore, password);

smtpMailConnector.sendMessage(encryptedMsg);
Email receivedMsg = waitForMessage(subject);

// compare Mails and verify difference due to encryption
boolean areContentsEqual = MailUtils.compareSentAndReceivedEmailContents(sentMessage, receivedMsg);
Assert.assertFalse(areContentsEqual);

// decrypt message
MimeMessage decryptedMsg = MailUtils.decryptMessageWithKeystore(encryptedMsg, session, pahtKeyStore, password);
// verify receivedContent is equal to sentContent
String receivedContent = ((Multipart) decryptedMsg.getContent()).getBodyPart(0).getContent().toString();
Assert.assertEquals(receivedContent, sentContent);

PROPERTY_MANAGER.loadProperties("my.property.file");

common.PropertyManager - Load system properties: /path/to/your/system.properties

PROPERTY_MANAGER.setTestLocalProperty("myproperty", "myvalue");

UiElement element = find(By.id("label"));
DesktopWebDriverUtils utils = new DesktopWebDriverUtils();

utils.clickJS(element);

UiElement hiddenUploadField = findById("hidden-upload-field");
hiddenUploadField.expect().present(true);

hiddenUploadField.findWebElement(webElement -> {
    // will change style to display a hidden element
    JSUtils.executeScript(hiddenUploadField.getWebDriver(), "arguments[0].setAttribute('style', 'display:block; opacity: 1')", webElement);
});

// WebDriver, Path to resource file, id of the script-tag
JSUtils.implementJavascriptOnPage(driver, "js/inject/custom.js", "customJs");

<script id="customJs" type="text/javascript">
    // your javascript code here.
</script>

// define the url where to download the resource from
String downloadUrl = "https://upload.wikimedia.org/wikipedia/commons/thumb/0/0a/"+
	"S%C3%A5g_med_arm_av_valn%C3%B6t_-_Skoklosters_slott_-_92588.tif/"+
	"lossy-page1-1024px-S%C3%A5g_med_arm_av_valn%C3%B6t_-_Skoklosters_slott_-_92588.tif.jpg";

// construct the downloader
FileDownloader downloader = new FileDownloader();

// perform the download
File downloadFile = downloader.download(downloadUrl);

System.out.println("downloaded file exists:" + downloadFile.exists());

CertUtils certUtils = new CertUtils();
certUtils.setTrustAllHosts(true);

DefaultConnectionConfigurator connectionConfigurator = new DefaultConnectionConfigurator();
connectionConfigurator.useCertUtils(certUtils);
connectionConfigurator.immitateCookiesFrom(WebDriver)

FileDownloader downloader = new FileDownloader();
downloader.setConnectionConfigurator(connectionConfigurator);
downloader.setDownloadLocation("/some/directory");
downloader.setProxy(new Proxy(Proxy.Type.HTTP, new InetSocketAddress("123.0.0.1", 8080)));

downloader.cleanup();

// reads text from a file given by a filename (absolute path of file).
String textFromPdf = PdfUtils.getStringFromPdf(String pdfFileLocation);

//reads text from only one page of a pdf given as input steam.
String textFromPdf = PdfUtils.getStringFromPdf(InputStream stream, int pageNumber);

int dpi = 150;
String absoluteFilePath = FileUtils.getAbsoluteFilePath("testfiles/TestDocument.pdf");
int pageNumber = 2;

/*
 The image files are saved under the name of the PDF-document with the corresponding page number appended,
 in this case the second page will be saved as "TestDocument.pdf_page2.png"
*/
File savedImage = PdfUtils.getImageFromPdf(absoluteFilePath, dpi, confidenceThreshold);

int dpi = 150;
int confidenceThreshold = 5;
String absoluteFilePath = FileUtils.getAbsoluteFilePath("testfiles/TestDocument.pdf");

List<File> actualImages = PdfUtils.getImageFromPdf(absoluteFilePath, dpi);

for (File image : actualImages) {
    String referenceName = FilenameUtils.removeExtension(image.getName());
    LayoutCheck.assertImage(image, referenceName, confidenceThreshold);
}

import eu.tsystems.mms.tic.testframework.utils.Sleepy;

class MyWorkflow implements Sleepy {
    public void doSomething() {
        sleep();        // Sleeps for an internal default timeout
        sleep(long);    // Sleeps for milliseconds
    }
}

MyWorkflow - sleep(200ms) on MyWorkflow@62b635fe

// Will pause current thread for 1 second.
TimerUtils.sleep(1000);

// You can pass a comment as well
TimerUtils.sleep(5000, "Wait for something to happen.");

final Timer timer = new Timer(500, 15_000);
timer.executeSequence(new Timer.Sequence<Boolean>() {
    @Override
    public void run() throws Throwable {
        // sequence code here
    }
});

public MyObject runTimer() {
    final Timer timer = new Timer(500, 15_000);
    ThrowablePackedResponse<MyObject> myObjectResponse
        = timer.executeSequenceThread(new Timer.Sequence<MyObject>() {
        @Override
        public void run() throws Throwable {
            // sequence code here
            setPassState(boolean);  // exit the sequence if your condition is true before timeout
            setReturningObject(new MyObject());

        }
    });
    return myObjectResponse.getResponse();
}

WebDriver driver = WEB_DRIVER_MANAGER.getWebDriver();
// Do some test stuff with session your session

// Starting a second session for example to test concurrent interactions.
WebDriver driverWithOtherUser = WEB_DRIVER_MANAGER.getWebDriver("Session2");

// Keep alive driver while doing actions on driverWithOtherUser for 90 seconds, while refreshing all 10 seconds
WEB_DRIVER_MANAGER.keepAlive(driver, 10, 90);

// Do your things with your second driver

// NOTE: Please release your WebDriverKeepAliveSequence as you dont need the lock
WEB_DRIVER_MANAGER.stopKeepingAlive(driver);

...
WARNING: Support for Legacy Capabilities is deprecated; You are sending the following invalid capabilities: [foo]; Please update to W3C Syntax: https://www.selenium.dev/blog/2022/legacy-protocol-support/
...
java.lang.IllegalArgumentException: Illegal key values seen in w3c capabilities: [foo]
...

DesktopWebDriverRequest request = new DesktopWebDriverRequest();
MutableCapabilities caps = request.getMutableCapabilities();

// The custom caps have to packaged into an additional map and added to the request with a vendor prefix.
Map<String, Object> customCaps = Map.of("foo", "bar");
caps.setCapability("custom:caps", customCaps);

WebDriver driver = WEB_DRIVER_MANAGER.getWebDriver(request);

public class WebDriverBiDiTests extends TesterraTest implements
        Loggable,
        WebDriverManagerProvider,
        UiElementFinderFactoryProvider {

    @Test
    public void testT01_LogListener_ConsoleLogs() throws MalformedURLException {
        DesktopWebDriverRequest request = new DesktopWebDriverRequest();
        request.setBrowser(Browsers.chrome);
        request.setBaseUrl(
                "https://www.selenium.dev/selenium/web/bidi/logEntryAdded.html"
        );
        // Important to activate websocket communication
        request.getMutableCapabilities().setCapability("webSocketUrl", true);
        WebDriver webDriver = WEB_DRIVER_MANAGER.getWebDriver(request);

        UiElementFinder uiElementFinder
            = UI_ELEMENT_FINDER_FACTORY.create(webDriver);

        // You need the RemoteWebDriver or the ChromeDriver instance
        // Testerra generates a driver instance of type EventFiringWebDriver
        // which does not work for LogInspector
        Augmenter augmenter = new Augmenter();
        RemoteWebDriver remoteWebDriver
            = WEB_DRIVER_MANAGER.unwrapWebDriver(webDriver, RemoteWebDriver.class).get();
        WebDriver remoteDriver = augmenter.augment(remoteWebDriver);
        LogInspector logInspector = new LogInspector(remoteDriver);

        // Look for the type of log entries you want to catch
        List<LogEntry> logEntryList = new ArrayList<>();
        logInspector.onConsoleEntry(logEntryList::add);

        uiElementFinder.find(By.id("consoleLog")).click();
        uiElementFinder.find(By.id("consoleError")).click();
        uiElementFinder.find(By.id("jsException")).click();
        uiElementFinder.find(By.id("logWithStacktrace")).click();

        // To make sure we have at least 4 elements in our list
        CONTROL.retryTimes(5, () -> {
            ASSERT.assertTrue(logEntryList.size() >= 4);
            TimerUtils.sleepSilent(1000);
        });

        logEntryList.forEach(logEntry -> {
            AtomicReference<GenericLogEntry> genericLogEntry = new AtomicReference<>();
            // 'LogEntry' is only a container for different types of logs.
            logEntry.getConsoleLogEntry().ifPresent(genericLogEntry::set);
            logEntry.getJavascriptLogEntry().ifPresent(genericLogEntry::set);

            log().info("LOG_ENTRY: {} {} {} {} - {}",
                    genericLogEntry.get().getTimestamp(),
                    genericLogEntry.get().getType(),
                    genericLogEntry.get().getLevel(),
                    genericLogEntry.get().getType(),
                    genericLogEntry.get().getText()
            );
        });

        ASSERT.assertEquals(logEntryList.size(), 4, "LogEntry list");
    }

}

import org.openqa.selenium.UsernameAndPassword;
...

public class ChromeDevToolsTests extends TesterraTest implements
        ChromeDevToolsProvider,
        WebDriverManagerProvider,
        UiElementFinderFactoryProvider {

    @Test
    public void test_CDP_BasicAuthentication() {
        WebDriver webDriver = WEB_DRIVER_MANAGER.getWebDriver();
        UiElementFinder uiElementFinder = UI_ELEMENT_FINDER_FACTORY.create(webDriver);

        // Credentials are used for all further website calls in your webdriver session
        CHROME_DEV_TOOLS
            .setBasicAuthentication(webDriver, UsernameAndPassword.of("admin", "admin"));

        webDriver.get("https://the-internet.herokuapp.com/basic_auth");
        uiElementFinder.find(By.tagName("p"))
            .assertThat().text().isContaining("Congratulations");
    }

}

CHROME_DEV_TOOLS
    .setBasicAuthentication(
            webDriver,
            UsernameAndPassword.of("admin", "admin"),
            "herokuapp.com",
            "example.com");

public class ChromeDevToolsTests extends TesterraTest implements
        ChromeDevToolsProvider,
        WebDriverManagerProvider,
        UiElementFinderFactoryProvider {

    @Test
    public void test_CDP_GeoLocation() {
        WebDriver webDriver = WEB_DRIVER_MANAGER.getWebDriver();
        UiElementFinder uiElementFinder = UI_ELEMENT_FINDER_FACTORY.create(webDriver);

        CHROME_DEV_TOOLS.setGeoLocation(
                webDriver,
                52.52084,      // latitude
                13.40943,      // longitude
                1);            // accuracy

        webDriver.get("https://my-location.org/");
        uiElementFinder.find(By.xpath("//button[@aria-label = 'Consent']"))
            .click(); // Cookie disclaimer
        uiElementFinder.find(By.id("latitude"))
            .assertThat().text().isContaining("52.52084");
        uiElementFinder.find(By.id("longitude"))
            .assertThat().text().isContaining("13.40943");
    }

}

import org.openqa.selenium.devtools.events.ConsoleEvent;
...

public class ChromeDevToolsTests extends TesterraTest implements
        ChromeDevToolsProvider,
        Loggable,
        WebDriverManagerProvider,
        UiElementFinderFactoryProvider {

    @Test
    public void test_CDP_LogListener_JsLogs() throws MalformedURLException {
        DesktopWebDriverRequest request = new DesktopWebDriverRequest();
        request
            .setBaseUrl("https://www.selenium.dev/selenium/web/bidi/logEntryAdded.html");
        WebDriver webDriver = WEB_DRIVER_MANAGER.getWebDriver(request);
        DevTools devTools = CHROME_DEV_TOOLS.getRawDevTools(webDriver);

        // Create a list for console events
        List<ConsoleEvent> consoleEvents = new ArrayList<>();
        // Create a consumer and add them to a listener
        Consumer<ConsoleEvent> addEntry = consoleEvents::add;
        devTools.getDomains().events().addConsoleListener(addEntry);

        UiElementFinder uiElementFinder = UI_ELEMENT_FINDER_FACTORY.create(webDriver);
        uiElementFinder.find(By.id("consoleLog")).click();
        uiElementFinder.find(By.id("consoleError")).click();

        consoleEvents.forEach(event ->
                log().info(
                        "JS_LOGS: {} {} - {}",
                        event.getTimestamp(),
                        event.getType(),
                        event.getMessages().toString())
        );
    }
}

import org.openqa.selenium.JavascriptException;
...

public class ChromeDevToolsTests extends TesterraTest implements
        ChromeDevToolsProvider,
        Loggable,
        WebDriverManagerProvider,
        UiElementFinderFactoryProvider {

    @Test
    public void testT_CDP_LogListener_JsExceptions() throws MalformedURLException {
        DesktopWebDriverRequest request = new DesktopWebDriverRequest();
        request
            .setBaseUrl("https://www.selenium.dev/selenium/web/bidi/logEntryAdded.html");
        WebDriver webDriver = WEB_DRIVER_MANAGER.getWebDriver(request);
        DevTools devTools = CHROME_DEV_TOOLS.getRawDevTools(webDriver);

        // Create a list for JS exceptions
        List<JavascriptException> jsExceptionsList = new ArrayList<>();
        Consumer<JavascriptException> addEntry = jsExceptionsList::add;
        devTools.getDomains().events().addJavascriptExceptionListener(addEntry);

        UiElementFinder uiElementFinder = UI_ELEMENT_FINDER_FACTORY.create(webDriver);
        uiElementFinder.find(By.id("jsException")).click();
        uiElementFinder.find(By.id("logWithStacktrace")).click();

        jsExceptionsList.forEach(jsException ->
                log().info(
                        "JS_EXCEPTION: {} {}",
                        jsException.getMessage(),
                        jsException.getSystemInformation()
                )
        );
    }

}

import org.openqa.selenium.devtools.v137.log.model.LogEntry;
...

public class ChromeDevToolsTests extends TesterraTest implements
        ChromeDevToolsProvider,
        Loggable,
        WebDriverManagerProvider {

    @Test
    public void test_CDP_LogListener_BrokenImages() {
        WebDriver webDriver = WEB_DRIVER_MANAGER.getWebDriver();
        DevTools devTools = CHROME_DEV_TOOLS.getRawDevTools(webDriver);
        devTools.send(Log.enable());

        List<LogEntry> logEntries = new ArrayList<>();
        Consumer<LogEntry> addedLog = logEntries::add;
        devTools.addListener(Log.entryAdded(), addedLog);

        webDriver.get("http://the-internet.herokuapp.com/broken_images");
        TimerUtils.sleep(1000);     // Short wait to get delayed logs

        logEntries.forEach(logEntry ->
                log().info(
                        "LOG_ENTRY: {} {} {} - {} ({})",
                        logEntry.getTimestamp(),
                        logEntry.getLevel(),
                        logEntry.getSource(),
                        logEntry.getText(),
                        logEntry.getUrl()
                )
        );
    }

}

import org.openqa.selenium.devtools.v137.network.Network;
import org.openqa.selenium.devtools.v137.network.model.RequestWillBeSent;
import org.openqa.selenium.devtools.v137.network.model.ResponseReceived;
...

public class ChromeDevToolsTests extends TesterraTest implements
        ChromeDevToolsProvider,
        Loggable,
        WebDriverManagerProvider {

    @Test
    public void test_CDP_NetworkListener() {
        WebDriver webDriver = WEB_DRIVER_MANAGER.getWebDriver();
        DevTools devTools = CHROME_DEV_TOOLS.getRawDevTools(webDriver);
        devTools.send(Network.enable(Optional.empty(), Optional.empty(), Optional.empty()));

        // Create lists for requests and responses
        List<ResponseReceived> responseList = new ArrayList<>();
        List<RequestWillBeSent> requestList = new ArrayList<>();

        devTools.addListener(Network.responseReceived(), response -> responseList.add(response));
        devTools.addListener(Network.requestWillBeSent(), request -> requestList.add(request));

        webDriver.get("https://the-internet.herokuapp.com/broken_images");

        requestList.forEach(request ->
                log().info(
                        "Request: {} {} - {}",
                        request.getRequestId().toString(),
                        request.getRequest().getMethod(),
                        request.getRequest().getUrl()
                )
        );

        responseList.forEach(response ->
                log().info(
                        "Response: {} {} - {}",
                        response.getRequestId().toString(),
                        response.getResponse().getStatus(),
                        response.getResponse().getStatusText()
                )
        );
    }

}

public class ChromeDevToolsTests extends TesterraTest implements
        ChromeDevToolsProvider,
        WebDriverManagerProvider {

    @Test
    public void test_CDP_GeoLocation() {
        WebDriver webDriver = WEB_DRIVER_MANAGER.getWebDriver();

        CHROME_DEV_TOOLS.setDevice(
                webDriver,
                new Dimension(400, 900),    // resolution
                100,                        // Scale factor
                true);                      // it's a mobile device

        webDriver.get("...");
    }

}

WebDriver webDriver = WEB_DRIVER_MANAGER.getWebDriver();
DevTools devTools = CHROME_DEV_TOOLS.getRawDevTools(webDriver);
devTools.send(Emulation.setDeviceMetricsOverride(...);

public class ChromeDevToolsTests extends TesterraTest implements
        ChromeDevToolsProvider,
        UiElementFinderFactoryProvider,
        WebDriverManagerProvider {

    // https://weatherstack.com/ uses your client IP address to find out your location.
    // There is a REST api call to https://weatherstack.com/ws_api.php?ip=<ip> to get
    // the local weather information.
    // This test updates the REST api call with a static public IP address
    @Test
    public void testCDP_Network_changeRequest() {
        WebDriver webDriver = WEB_DRIVER_MANAGER.getWebDriver();
        DevTools rawDevTools = CHROME_DEV_TOOLS.getRawDevTools(webDriver);
        final String location1 = "213.136.89.121";  // free German proxy server in Munich

        rawDevTools.send(Fetch.enable(Optional.empty(), Optional.empty()));
        rawDevTools.addListener(Fetch.requestPaused(), requestConsumer -> {
            Request request = requestConsumer.getRequest();
            String currentUrl = request.getUrl();
            if (currentUrl.contains("ws_api.php?ip=")) {
                String updatedUrl = currentUrl.substring(0, currentUrl.indexOf("?"))
                        + "?ip=" + location1;
                rawDevTools.send(
                        Fetch.continueRequest(
                                requestConsumer.getRequestId(),
                                Optional.of(updatedUrl),
                                Optional.empty(),
                                Optional.empty(),
                                Optional.empty(),
                                Optional.empty()));
            } else {
                // All other requests will be sent without any change
                rawDevTools.send(
                        Fetch.continueRequest(
                                requestConsumer.getRequestId(),
                                Optional.of(currentUrl),
                                Optional.empty(),
                                Optional.empty(),
                                Optional.empty(),
                                Optional.empty()));

            }

        });


        webDriver.get("https://weatherstack.com/");

        UiElementFinder uiElementFinder = UI_ELEMENT_FINDER_FACTORY.create(webDriver);
        uiElementFinder.find(By.xpath("//div[@id = 'cookiescript_accept']")).click();
        UiElement weatherLocation = uiElementFinder
                .find(By.xpath("//span[@data-api = 'location']"));
        weatherLocation.assertThat().text().isContaining("Munich");
    }
}

import com.google.common.eventbus.Subscribe;
import eu.tsystems.mms.tic.testframework.events.TestStatusUpdateEvent;
import eu.tsystems.mms.tic.testframework.report.model.context.MethodContext;
import eu.tsystems.mms.tic.testframework.logging.Loggable;

public class MyStatusListener implements TestStatusUpdateEvent.Listener, Loggable {

    @Override
    @Subscribe
    public void onTestStatusUpdate(TestStatusUpdateEvent event) {
        MethodContext methodContext = event.getMethodContext();
        log().info(
                String.format("%s has the status %s", methodContext.getName(),
                        methodContext.getStatus())
        );
    }
}

Testerra.getEventBus().register(new LogEventListener());

// Update some data in data model...
methodContext.name = "new_Test_Method_Name";

Testerra.getEventBus().post(new ContextUpdateEvent().setContext(methodContext));

public class CustomEvent {
    public interface Listener {
        void onCustomEvent(CustomEvent event);
    }
}

@Override
@Subscribe
public void onCustomEvent(CustomEvent event) {
   log().info("Custom Event started!");
}

import eu.tsystems.mms.tic.testframework.events.InterceptMethodsEvent;

public class MyTest extends TesterraTest {

    public class MyListener implements InterceptMethodsEvent.Listener {

        @Override
        @Subscribe
        public void onInterceptMethods(InterceptMethodsEvent event) {
            event.getMethodInstances().removeIf(iMethodInstance -> true);
        }
    }

    @BeforeTest
    public void setupListener() {
        Testerra.getEventBus().register(new MyListener());
    }
}

import eu.tsystems.mms.tic.testframework.logging.Loggable;
import com.google.common.eventbus.Subscribe;
import org.testng.ISuite;
import org.testng.ISuiteListener;

class MySuiteListener implements ISuiteListener, Loggable {

    @Subscribe
    @Override
    public void onStart(ISuite suite) {
        log().info("Suite started");
    }
}

import com.google.common.eventbus.EventBus;
import eu.tsystems.mms.tic.testframework.listeners.AbstractReportModelListener;
import eu.tsystems.mms.tic.testframework.hooks.ModuleHook;
import eu.tsystems.mms.tic.testframework.report.TesterraListener;

public class CustomReportModuleHook implements ModuleHook {

    @Override
    public void init() {
        Report report = Testerra.getInjector().getInstance(Report.class);
        EventBus eventBus = Testerra.getEventBus();
        eventBus.register(new GenerateReportModelListener(report.getReportDirectory()));
    }
}

<input type="radio" name="beverage" value="tee">
<input type="radio" name="beverage" value="coffee">

// Good practice
PreparedLocator locator = LOCATE.prepare("//input[@name='%s' and @value='%s']");
UiElement teeOption = find(locator.with("beverage", "tee"));
UiElement coffeeOption = find(locator.with("beverage", "coffee"));

// Bad practice
UiElement options = find(By.name("beverage"));

<body>
    <div id="wrapper">
    <!-- HTML code-->
    <my-custom-shadow-root-element>
    <!-- #shadowRoot -->
        <div class="custom-component">
            <input id="custom-component-login-name" name="name">
        </div>
    </my-custom-shadow-root-element>
    </div>
    <!-- HTML code-->
</body>

UiElement shadowRootElement = find(By.cssSelector("my-custom-shadow-root-element")).shadowRoot();
// You have to use CSS selectors for child elements.
UiElement input = shadowRootElement.find(By.cssSelector("#custom-component-login-name"));

tt.browser=chrome
tt.baseurl=http://example.org

tt.browser=firefox
tt.baseurl=http://qa.example.org

@BeforeSuite
public void setup() {
    String env = PROPERTY_MANAGER.getProperty("env", "");
    if (!"".equals(env)) {
        PROPERTY_MANAGER.loadProperties("test_" + env + ".properties");
    }
}

gradle test -Denv=qa

WebDriver webDriver = WEB_DRIVER_MANAGER.getWebDriver();

ChromeDriver chromeDriver = WEB_DRIVER_MANAGER
        .unwrapWebDriver(webDriver, ChromeDriver.class).get();

DevTools devTools = chromeDriver.getDevTools();
devTools.createSession();
devTools.send(Emulation.setGeolocationOverride(
        Optional.of(52.52084),
        Optional.of(13.40943),
        Optional.of(1)));

webDriver.get("https://my-location.org/");      // page gets the new geo location information

WebDriver webDriver = WEB_DRIVER_MANAGER.getWebDriver();

RemoteWebDriver remoteWebDriver = WEB_DRIVER_MANAGER
        .unwrapWebDriver(webDriver, RemoteWebDriver.class).get();
webDriver = new Augmenter().augment(remoteWebDriver);

DevTools devTools = ((HasDevTools) webDriver).getDevTools();
devTools.createSession();

devTools.send(Emulation.setGeolocationOverride(
        Optional.of(52.52084),
        Optional.of(13.40943),
        Optional.of(1)));

webDriver.get("https://my-location.org/");

WebDriver webDriver = WEB_DRIVER_MANAGER.getWebDriver();
WebDriver remoteWebDriver = WEB_DRIVER_MANAGER.unwrapWebDriver(webDriver, RemoteWebDriver.class).get();

AtomicReference<DevTools> devToolsAtomicReference = new AtomicReference<>();

remoteWebDriver = new Augmenter()
        .addDriverAugmentation(
                "chrome",
                HasAuthentication.class,
                (caps, exec) -> (whenThisMatches, useTheseCredentials) -> {
                    devToolsAtomicReference.get().createSessionIfThereIsNotOne();
                    devToolsAtomicReference.get().getDomains()
                            .network()
                            .addAuthHandler(whenThisMatches, useTheseCredentials);
                })
        .augment(remoteWebDriver);

DevTools devTools = ((HasDevTools) remoteWebDriver).getDevTools();
devTools.createSession();
devToolsAtomicReference.set(devTools);

// Set credentials and call the page with 'basic authentication' protection
((HasAuthentication) remoteWebDriver).register(UsernameAndPassword.of("admin", "admin"));
webDriver.get("https://the-internet.herokuapp.com/basic_auth");

public class MyForm extends AbstractComponent<MyForm> {
    public MyForm(UiElement rootElement) {
        super(rootElement);
    }
}

class MyPage extends Page {
    private MyForm form = createComponent(MyForm.class, find(By.tagName("form")));
}

class MyPage extends Page {
    @Check
    private UiElement uiElement = findById(42);
}

uiElement.expect().displayed(true); (1)
uiElement.expect().value().contains("Hallo Welt").is(true); (2)

if (uiElement.waitFor().displayed(true)) {
    // Optional element became visible
}

uiElement.expect().css("display").is("none"); (1)
uiElement.expect().text()
    .map(value -> value.toLowerCase()) (2)
    .matches("^hello\\s.orld") (3)
    .is(true);

uiElement.expect().displayed().is(true, "Element is displayed");

page.expect().url().endsWith("index.html").is(true); (1)

class MyPage extends Page {
    public void checkIfPageContainsText(String text) {
        this.getFinder()
            .findDeep(XPath.from("*").text().contains(text))
            .expect().displayed(true); (2)
    }
}

uiElement.expect().screenshot().pixelDistance("ElementReference").isLowerThan(1);
page.expect().screenshot().pixelDistance("PageReference").isBetween(0, 10);

page.screenshotToReport();

UiElement left = find(By.id("left"));
UiElement right = find(By.id("right"));

left.expect().bounds().leftOf(right).is(true);
left.expect().bounds().intersects(right).is(false);

UiElement top = find(By.id("top"));
UiElement bottom = find(By.id("bottom"));

top.expect().bounds().fromRight().toRightOf(bottom).is(0);

UiElement body = find(By.tagName("body"));
UiElement nav = parent.find(By.tagName("nav"));

body.expect().bounds().contains(nav).is(true);

CONTROL.collectAssertions(() -> uiElement.expect().displayed(true));

CONTROL.collectAssertions(() -> {
    MyPage page = PAGE_FACTORY.create(MyPage.class);
    page.expect().title().is("TestPage");
    uiElement.expect().value().contains("Hello");
});

CONTROL.collectAssertions(() -> {
    String data = loadSomeData();
    ASSERT.assertEquals(data, "Hello World", "some data");
});

@Test
public void test_CollectEverything() {
    CONTROL.collectAssertions(() -> test_TestSomething());
}

CONTROL.optionalAssertions(() -> uiElement.expect().displayed(true));

class MyPage extends Page {
    @Check(timeout = 1)
    private UiElement uiElement;
}

@PageOptions(elementTimeoutInSeconds = 1)
class MyPage extends Page {...}

CONTROL.withTimeout(1, () -> uiElement.expect().displayed(true));

CONTROL.withTimeout(1, () -> {
    MyPage page = PAGE_FACTORY.create(MyPage.class);
    page.expect().title().is("TestPage");
    uiElement.expect().value().contains("Hello");
});

@Test
public void test_TestSomething_fast() {
    CONTROL.withTimeout(1, () -> test_TestSomething());
}