hu.ibello.expect.package-info Maven / Gradle / Ivy
Show all versions of ibello-api Show documentation
/*
* Ark-Sys Kft. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/**
* This package contains interfaces used in different expectations.
* Ibello Expectation Engine
*
* During an expectation the program waits until a specific property of the examined
* entity changes or the time runs out. If the change occurs, the expectation will success
* and the test execution continues. If the time runs out, an exception will be thrown,
* every important information will be logged and the current test will fail. It means that
* the test execution will stop and the next test will be started.
*
*
* The examined entity can be an element on the page, a collection of elements, or the browser itself.
*
*
* The timeout of an expectation cannot be specified directly with a numeric value. All timeouts should
* be defined in the ibello configuration, with "ibello.timeout." prefix. The unit
* should be seconds. During the expectation, only the key of the timeout can be specified - it is the other half
* of the configuration property, after the "ibello.timeout." prefix. With this rule we can
* manage our timeout values in a more secure and general way, and can change them in different test execution
* environment easily.
*
*
* The center interface of the expectation engine is the {@link hu.ibello.expect.ExpectationBuilder}.
* It contains fluent methods to construct and run an expectation. This interface is available only in page objects
* - see {@link hu.ibello.pages.PageObject#expectations()} method.
*
*
* An expectation can be "hard" or "soft". If a "hard" expectation fails, the execution of the current test
* is instantly terminated. This is the difference from "soft" expectations, where the test execution continues,
* but at the end the test itself will be marked as failed. "Hard" expectations can be constructed with the
* expect(...) methods. For "soft" expectations, the assume(...) methods can be
* used.
*
*
* Examples (in a page object):
*
*
* WebElement button = ...;
* WebElements inputFields = ...;
*
* expectations().assume(button).toHave().text("Click me");
* expectations().expect(button).toBe().clickable();
* expectations().expect(inputFields).toHave().size(3);
* expectations().expect(browser()).toHave().url("ibello.com");
* expectations().any(() -> {
* expectations().expect(button).toBe().clickable();
* expectations().expect(inputFields).toHave().size(3);
* expectations().expect(browser()).toHave().url("ibello.com");
* });
*
* @author Kornél Simon
*/
package hu.ibello.expect;