ExpectationBuilder (Ibello API 1.21.1 API)

All Superinterfaces:

TimeoutRelated<ExpectationBuilder>
```
public interface ExpectationBuilder
extends TimeoutRelated<ExpectationBuilder>
```
An instance of this interface builds and executes expectations. The interface offers fluent methods (through another interfaces).
- Methods to set timeout: see TimeoutRelated.withTimeout(Enum) and TimeoutRelated.withTimeout(String).
- Methods to build a simple "hard" expectation: see expect(Browser), expect(WebElement), expect(List).
- Methods to build a simple "soft" expectation: see assume(Browser), assume(WebElement), assume(List).
- Methods to build complex expectations: see all(Runnable) and any(Runnable).
About the ibello expectation engine, see hu.ibello.expect.
Author:

Kornél Simon

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`all(Runnable expectations)` Executes a complex expectation.
`void`	`any(Runnable expectations)` Executes a complex expectation.
`BrowserExpectationBuilder`	`assume(Browser browser)` Starts to build a simple expectation about the browser.
`WebElementsExpectationBuilder`	`assume(List<WebElement> elements)` Starts to build a simple expectation about the given elements.
`WebElementExpectationBuilder`	`assume(WebElement element)` Starts to build a simple expectation about the given element.
`BrowserExpectationBuilder`	`expect(Browser browser)` Starts to build a simple expectation about the browser.
`WebElementsExpectationBuilder`	`expect(List<WebElement> elements)` Starts to build a simple expectation about the given elements.
`WebElementExpectationBuilder`	`expect(WebElement element)` Starts to build a simple expectation about the given element.
`default void`	`expectAll(Runnable expectations)` Deprecated.
`default void`	`expectAny(Runnable expectations)` Deprecated.

Methods inherited from interface hu.ibello.core.TimeoutRelated
withTimeout, withTimeout

- Method Detail
  - expect
```
WebElementExpectationBuilder expect(WebElement element)
```
    Starts to build a simple expectation about the given element. The expectations will use the timeout specified in this ExpectationBuilder instance. The result is also an interface instance which has methods to build the expectation further.
    The expectation provided by this method is a "hard" one. If it fails, the execution of the current test will be terminated. This is the difference between assume(WebElement) and expect(WebElement).
    
    Parameters:
    
    element - a WebElement
    
    Returns:
    
    WebElementExpectationBuilder instance to continue the expectation
  - expect
```
WebElementsExpectationBuilder expect(List<WebElement> elements)
```
    Starts to build a simple expectation about the given elements. The expectations will use the timeout specified in this ExpectationBuilder instance. The result is also an interface instance which has methods to build the expectation further.
    The expectation provided by this method is a "hard" one. If it fails, the execution of the current test will be terminated. This is the difference between assume(List) and expect(List).
    
    Parameters:
    
    elements - collection of WebElement objects - it can be WebElements
    
    Returns:
    
    WebElementsExpectationBuilder instance to continue the expectation
  - expect
```
BrowserExpectationBuilder expect(Browser browser)
```
    Starts to build a simple expectation about the browser. The expectations will use the timeout specified in this ExpectationBuilder instance. The result is also an interface instance which has methods to build the expectation further.
    The expectation provided by this method is a "hard" one. If it fails, the execution of the current test will be terminated. This is the difference between assume(Browser) and expect(Browser).
    
    Parameters:
    
    browser - the browser object, PageObject.browser()
    
    Returns:
    
    BrowserExpectationBuilder instance to continue the expectation
  - assume
```
WebElementExpectationBuilder assume(WebElement element)
```
    Starts to build a simple expectation about the given element. The expectations will use the timeout specified in this ExpectationBuilder instance. The result is also an interface instance which has methods to build the expectation further.
    The expectation provided by this method is a "soft" one. If it fails, the execution of the test code will not be stopped. This is the difference between expect(WebElement) and assume(WebElement).
    
    Parameters:
    
    element - a WebElement
    
    Returns:
    
    WebElementExpectationBuilder instance to continue the expectation
  - assume
```
WebElementsExpectationBuilder assume(List<WebElement> elements)
```
    Starts to build a simple expectation about the given elements. The expectations will use the timeout specified in this ExpectationBuilder instance. The result is also an interface instance which has methods to build the expectation further.
    The expectation provided by this method is a "soft" one. If it fails, the execution of the test code will not be stopped. This is the difference between expect(List) and assume(List).
    
    Parameters:
    
    elements - collection of WebElement objects - it can be WebElements
    
    Returns:
    
    WebElementsExpectationBuilder instance to continue the expectation
  - assume
```
BrowserExpectationBuilder assume(Browser browser)
```
    Starts to build a simple expectation about the browser. The expectations will use the timeout specified in this ExpectationBuilder instance. The result is also an interface instance which has methods to build the expectation further.
    The expectation provided by this method is a "soft" one. If it fails, the execution of the test code will not be stopped. This is the difference between expect(Browser) and assume(Browser).
    
    Parameters:
    
    browser - the browser object, PageObject.browser()
    
    Returns:
    
    BrowserExpectationBuilder instance to continue the expectation
  - expectAll
```
@Deprecated
default void expectAll(Runnable expectations)
```
    Deprecated.
    
    Deprecated method, use all(Runnable).
    
    Parameters:
    
    expectations - a Runnable instance which calls the child expectations
  - all
```
void all(Runnable expectations)
```
    Executes a complex expectation. It receives a Runnable instance, in which we can call multiple expectations (even another complex ones). As result, all expectations will be executed in arbitrary order. The complex expectation will fail if any of the child expectations fails. (So all of them should be successful.)
    Example (in a page object):
```
 expectations().all(() -> {
     expectations().expect(browser()).toHave().url("https://ibello.eu");
     expectations().expect(registerButton).toBe().clickable();
 });
 
```
    In the complex expectation we can use "hard" and "soft" child expectations. If the complex expectation fails because a "hard" child failed, then the execution of the current test will be terminated instantly. If the reason of the failure was a "soft" expectation, then the test will continue with the next step. In both cases, at the end the test will be marked as failed.
    Parameters:
    
    expectations - a Runnable instance which calls the child expectations
  - expectAny
```
@Deprecated
default void expectAny(Runnable expectations)
```
    Deprecated.
    
    Deprecated method, use any(Runnable).
    
    Parameters:
    
    expectations - a Runnable instance which calls the child expectations
  - any
```
void any(Runnable expectations)
```
    Executes a complex expectation. It receives a Runnable instance, in which we can call multiple expectations (even another complex ones). As result, all expectations will be executed in arbitrary order. The complex expectation will fail if all of the child expectations fail. (So at least one should be successful.) After the first successful child expectation the execution of the children will stop.
    Example (in a page object):
```
 expectations().any(() -> {
     expectations().expect(loginButton).toBe().clickable();
     expectations().expect(registerButton).toBe().clickable();
 });
 
```
    In the complex expectation we can use "hard" and "soft" child expectations. If we use at least one "hard" expectation, and the complex expectation fails, then the test run will be instantly terminated (because that "hard" one failed). If the complex expectation contains only "soft" children, then the test execution will continue even if the expectation fails. In both cases, at the end the test will be marked as failed.
    Parameters:
    
    expectations - a Runnable instance which calls the child expectations

Interface ExpectationBuilder

Method Summary

Methods inherited from interface hu.ibello.core.TimeoutRelated

Method Detail

expect

expect

expect

assume

assume

assume

expectAll

all

expectAny

any