# Setting the browser
tt.browser=chrome

# 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

tt.webdriver.mode=remote

# Selenium host and port
tt.selenium.server.host=localhost
tt.selenium.server.port=4444

# Or combined as URL
tt.selenium.server.url=http://localhost:4444/wd/hub

tt.webdriver.mode=local
webdriver.gecko.driver="C:\\absolute\\path\to\\your\\geckodriver.exe"

# or for other browsers
webdriver.chrome.driver=...
webdriver.edge.driver=...
webdriver.ie.driver=...

-Dwebdriver.gecko.driver=C:\absolute\path\to\your\geckodriver.exe

# Browser name and version
tt.browser=firefox
tt.browser.version=65

# Or both combined
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();
}

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");     // if no custom session defined, the default value 'default' is set

WebDriver driver = WEB_DRIVER_MANAGER.getWebDriver(myRequest);

// tt.wdm.closewindows.aftertestmethods
WEB_DRIVER_MANAGER.getConfig().setShutdownSessionAfterTestMethod(true);

// tt.wdm.closewindows.onfailure
WEB_DRIVER_MANAGER.getConfig().setShutdownSessionOnFailure(false);

// tt.browser.maximize
WEB_DRIVER_MANAGER.getConfig().setMaximizeViewport(true);

WEB_DRIVER_MANAGER.getConfig().reset();

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

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

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

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

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

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 sensibleElement = findById("secret").sensibleData();

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>

// 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 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);

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 selectElement = 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));

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();

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);
});

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

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

# test.properties
environment=test
country=de

@Test
@Fails(description = "Failing for environment 'test' and country 'de'", validFor = {"environment=test", "country=de"})
public void testExpectedFailed() {
    Assert.fail();
}

tt.failed.tests.max.retries=1

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

# set additional classes that engage a retry,
# instances of TimeoutException are always retried
tt.failed.tests.if.throwable.classes=java.sql.SQLRecoverableException

# set additional messages of Throwable that engage a retry,
# by default the following messages are evaluated
#           "Error communicating with the remote browser. It may have died",
#           "was terminated due to TIMEOUT",
#           "was terminated due to SO_TIMEOUT",
#           "The requested URL could not be retrieved",
#           "Squid is unable to create a TCP socket"

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 Throwable analyzeThrowable(Throwable throwable, String tMessage) {
        if (throwable instanceof InstantiationException) {
            if (tMessage != null) {
                final String tMessageLC = tMessage.toLowerCase();
                boolean match = tMessageLC.contains(message);
                if (match) {
                return throwable;
                }
            }
        }

        return null;
    }
}

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

import eu.tsystems.mms.tic.testerra.bup.BrowserUpRemoteProxyManager;
import eu.tsystems.mms.tic.testerra.bup.BrowserUpRemoteProxyServer;
import eu.tsystems.mms.tic.testframework.testing.TesterraTest;
import org.openqa.selenium.Proxy;
import org.testng.annotations.AfterSuite;
import org.testng.annotations.BeforeSuite;

import java.net.MalformedURLException;
import java.net.URL;

public class AbstractTest extends TesterraTest {

    private static BrowserUpRemoteProxyServer bupProxy;

    @BeforeSuite
    public void setupProxy() throws MalformedURLException {

        final URL apiUrl = new URL("http://localhost:8080");
        final BrowserUpRemoteProxyManager bupRemoteProxyManager = new BrowserUpRemoteProxyManager(apiUrl);
        bupProxy = bupRemoteProxyManager.startServer();

        /* Additional Proxy setup here */
        final String bmpProxyAddress = String.format("%s:%d", apiUrl.getHost(), bupProxy.getPort());

        // For selenium usage.
        final Proxy proxy = new Proxy();
        proxy.setHttpProxy(bmpProxyAddress)
                .setFtpProxy(bmpProxyAddress)
                .setSslProxy(bmpProxyAddress);

        WebDriverManager.setGlobalExtraCapability(CapabilityType.PROXY, proxy);
    }

    @AfterSuite
    public void tearDownProxy() throws MalformedURLException {

        final URL apiBaseUrl = new URL("http://localhost:8080");
        final BrowserUpRemoteProxyManager browserUpRemoteProxyManager = new BrowserUpRemoteProxyManager(apiBaseUrl);

        for (final Integer proxyPort : browserUpRemoteProxyManager.getProxies()) {
            final BrowserUpRemoteProxyServer bupToStop = new BrowserUpRemoteProxyServer();
            bupToStop.setPort(proxyPort);
            browserUpRemoteProxyManager.stopServer(bupToStop);
        }
    }
}

BrowserUpRemoteProxyServer browserUpRemoteProxyServer = new BrowserUpRemoteProxyServer();
browserUpRemoteProxyServer.setPort(8088);

browserUpRemoteProxyServer = browserUpRemoteProxyManager.startServer(browserUpRemoteProxyServer);

List<Integer> portPool = new ArrayList<>();
ports.add(8090);
ports.add(8091);
ports.add(8092);
ports.add(8093);
ports.add(8094);
ports.add(8095);

BrowserUpLocalProxyManager bupLocalManager = new BrowserUpLocalProxyManager(ports);

// Start instance
BrowserUpProxyServer browserUpProxyServer = new BrowserUpProxyServer();
browserUpProxyServer = bupLocalManager.startServer(browserUpProxyServer);

// assert that a port of given port pool was used.
Assert.assertTrue(portPool.contains(port), "Port of range was used.");

// assert proxy is started.
Assert.assertTrue(bup1.isStarted(), "Proxy started");

import org.testng.annotations.BeforeSuite;
import org.testng.annotations.AfterSuite;
import eu.tsystems.mms.tic.testframework.bmp.BmpRestClient;
import eu.tsystems.mms.tic.testframework.webdrivermanager.WebDriverManager;
import org.openqa.selenium.Proxy;

public abstract class AbstractTest extends TesterraTest {

    private static BmpRestClient bmpClient;

    @BeforeSuite
    public void proxySetup() {

        final URL apiUrl = new URL("http://localhost:8080");
        bmpClient = new BmpRestClient(apiUrl);

        /* Additional Proxy setup here */
        final int proxyPort = bmpClient.startServer();
        final String bmpProxyAddress = String.format("%s:%d", apiUrl.getHost(), proxyPort);

        // For selenium usage.
        final Proxy proxy = new Proxy();
        proxy.setHttpProxy(bmpProxyAddress)
            .setFtpProxy(bmpProxyAddress)
            .setSslProxy(bmpProxyAddress);

        WEB_DRIVER_MANAGER.setGlobalCapability(CapabilityType.PROXY, proxy);
    }

    @AfterSuite
    public void proxyTeardown() {
        bmpClient.stopServer();
    }
}

...
int customPort = 8085;
final int proxyPort = bmpClient.startServer(customPort);
...

import java.net.URL;

/* Additional Proxy setup here */
URL baseUrl = WEB_DRIVER_MANAGER.getConfig().getBaseUrl();
final String basicAuthUser;
final String basicAuthPassword;
bmpClient.setBasicAuth(baseUrl.getHost(), basicAuthUser, basicAuthPassword);

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

bmpClient.setUpstreamProxy(ProxyUtils.getSystemHttpProxyUrl());

/*
 Checks if a proxy server is available by a custom port.
 */
int port = 8085;
boolean isUsed = bmpClient.isProxyRunningAtPort(port);

/*
 Maps specifc host names to another host names or IP adresses
 */
bmpClient.setHostMapping(Map<String, String> hostNameMapping);

/*
 Capture the traffic and return it as a JsonElement
 You can choose, if you want to capture only the headers, the content or both via the boolean flags.
 */
bmpClient.startCapture(boolean headers, boolean content);
JsonElement element = client.stopCapture();

/*
 Adds additional key-value pairs to the headers.
*/
bmpClient.setHeader(String key, String value);

final CSVTestDataReader csvTestDataReader = new CSVTestDataReader();

final List<Map<String, String>> testDataMap = csvTestDataReader.readCsvTestDataFromResource("testfiles/TestCsvReader.csv");

Assert.assertEquals(testDataMap.size(), 2);
Assert.assertEquals(testDataMap.get(0).get("id"), "AH_1");
Assert.assertEquals(testDataMap.get(1).get("id"), "AH_2");

final CSVTestDataReader csvTestDataReader = new CSVTestDataReader();

final List<TestCsvReaderBean> testDataList = csvTestDataReader.readCsvIntoBeans("testfiles/TestCsvReader.csv", TestCsvReaderBean.class);

Assert.assertNotNull(testDataList);####
Assert.assertNotEquals(testDataList.size(), 0);

final TestCsvReaderBean testCSVReader = testDataList.get(0);
final String id = testCSVReader.getId();
Assert.assertEquals(id, "AH_1");

public class TestCsvReaderBeanWithSubModel {

    private String id;
    private String name;
    private String firstName;
    private TestCsvReaderSubModel subModel;

    // getter and setter here...
}

public class TestCsvReaderSubModel {

    private String id;
    private String street;
    private String city;

    // getter and setter here...
}

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

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

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

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

LocalizedBundle bundle = new LocalizedBundle("testdata");
bundle.getString("TEST_KEY");

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));

POP3MailConnector pop3MailConnector = new POP3MailConnector();

// 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();

// 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));
String subject = email.getSubject();
String messageId = null;

pop3MailConnector.deleteMessage(recipient, RecipientType.TO, subject, messageId);

// 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");

tt.cert.trusted.hosts=example.com google.com

tt.cert.trusted.hosts=*

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";

// request access to the current web driver instance
WebDriver driver = WebDriverManager.getWebDriver();

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

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

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

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

downloader.cleanup();

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);

import com.google.common.eventbus.Subscribe;
import eu.tsystems.mms.tic.testframework.events.MethodStartEvent;
import eu.tsystems.mms.tic.testframework.logging.Loggable;

public class LogEventListener implements MethodStartEvent.Listener, Loggable {

    @Override
    @Subscribe
    public void onMethodStart(MethodStartEvent event) {
        log().info("Event logged: " + event.getMethod());
    }
}

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']").unique();
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();
UiElement inputName = shadowRootElement.find(By.xpath("./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

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(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); (1)
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); (2)

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());
}