_assert($condition[, $message])

Details

_assert will do nothing if the condition passed to it is true.
_assert will log failures to the playback logs if the condition evaluates to false.

_assertTrue($condition[, $message])

Details

Same as _assert

_assertNotTrue($condition[, $message])

Details

_assertNotTrue will do nothing if the condition evaluates to false.
_assertNotTrue will log failures to the playback logs if the condition evaluates to true.

_assertFalse($condition[, $message])

Details

_assertFalse will do nothing if the condition evaluates to false.
_assertFalse will log failures to the playback logs if the condition evaluates to true.

_assertNull($value[, $message])

Details

_assertNull will do nothing if the value passed is null.
_assertNull will log failures to the playback logs if the value is not null.

_assertNotNull($value[, $message])

Details

_assertNotNull will do nothing if the value passed is not null.
_assertNotNull will log failures to the playback logs if the value is null.

_assertExists($element[, $message])

Details

_assertExists will do nothing if the element exists.
_assertExists will log failures to the playback logs if the element does not exist

_assertVisible($element[, $message])

Details

_assertVisible will do nothing if the element is visible.
_assertVisible will log failures to the playback logs if the element is not visible

_assertNotVisible($element[, $message])

Details

_assertNotVisible will do nothing if the element is not visible.
_assertNotVisible will log failures to the playback logs if the element is visible

_assertNotExists($element[, $message])

Details

_assertNotExists will do nothing if the element does not exist.
_assertNotExists will log failures to the playback logs if the element exists

_assertEqual($expected, $actual[, $message])

Details

_assertEqual will do nothing if the expected and actual values match.
_assertEqual will log failures to the playback logs if the expected and actual values are not equal

_assertEqualArrays($expected, $actual[, $message])

Details

Asserts that expected and actual arrays are equal, else logs the message.

_assertNotEqual($expected, $actual[, $message])

Details

_assertNotEqual will do nothing if the expected and actual values do not match.
_assertNotEqual will log failures to the playback logs if the expected and actual values are equal

_assertContainsText($expected, $element[, $message])

Details

_assertContainsText will do nothing if the expected string/regex is part of the text content of given element.
_assertContainsText will log failures to the playback logs if the expected string/regex is not part of the text content of given element

_assertNotContainsText($expected, $element[, $message])

Details

_assertNotContainsText will do nothing if the expected string/regex is not part of the text content of given element.
_assertNotContainsText will log failures to the playback logs if the expected string/regex is part of the text content of given element

_assertEqualImages($expectedImagePath, $actualImagePath[, $differenceThreshold[, $displayOnSuccess[, $failureMessage]]])

Details

_assertEqualImages compares two images. If the images are similar, assertion passes. If the images are dissimilar, the images and the failure messasge will be displayed in logs as failure.

_assertHorizontallyAligned($leftElement, $rightElement[, $position[, $gap[, $offset[, $message]]]])

Details

_assertHorizontallyAligned checks if two elements are horizontally aligned. If the elements are horizontally aligned, assertion passes. If the elements are not horizontally aligned, the failure messasge will be displayed in logs as failure. Example

_assertHorizontallyAligned(_div("item1"), _div("item2")) //by default middle position will be checked
_assertHorizontallyAligned(_div("item1"), _div("item2"), "top")
_assertHorizontallyAligned(_div("item1"), _div("item2"), "top", 20) //gap can take the values between [-20, 20]
_assertHorizontallyAligned(_div("item1"), _div("item2"), "top", [0, 20]) //gap is only positive i.e. no overlapping is allowed
_assertHorizontallyAligned(_div("item1"), _div("item2"), "top", [0, 20], 10) //gap is only positive i.e. no overlapping is allowed and offset for the top edge is 10

_assertVerticallyAligned($topElement, $bottomElement[, $position[, $gap[, $offset[, $message]]]])

Details

_assertVerticallyAligned checks if two elements are vertically aligned. If the elements are vertically aligned, assertion passes. If the elements are not vertically aligned, the failure messasge will be displayed in logs as failure. Example

_assertVerticallyAligned(_div("item1"), _div("item2")) //by default center position will be checked
_assertVerticallyAligned(_div("item1"), _div("item2"), "left")
_assertVerticallyAligned(_div("item1"), _div("item2"), "left", 20) //gap can take the values between [-20, 20]
_assertVerticallyAligned(_div("item1"), _div("item2"), "left", [0, 20]) //gap is only positive i.e. no overlapping is allowed

_assertCentered($element, $containerElement, $alignment[, $message])

Details

_assertCentered checks if inner element is vertically or horizontally centered to the container element. If the elements are vertically or horizontally aligned, assertion passes. If the elements are not vertically or horizontally aligned, the failure messasge will be displayed in logs as failure. Example

_assertCentered(_div("item1"), _div("item2"), "vertical")
_assertCentered(_div("item1"), _div("item2"), "horizontal")

_assertVisiblyInside($element1, $element2[, $message])

Details

_assertVisiblyInside checks if element1 is visibly inside element2. If element1 is visibly inside element2, assertion passes. If element1 is not visibly inside element2, the failure messasge will be displayed in logs as failure.

_assertVisiblyOutside($element1, $element2[, $message])

Details

_assertVisiblyOutside checks if element1 is visibly outside element2 i.e one is not contained within other. If element1 is visibly outside element2, assertion passes. If element1 is not visibly outside element2, the failure messasge will be displayed in logs as failure.

_assertVisiblyOn($element1, $element2[, $topSpace[, $rightSpace[, $bottomSpace[, $leftSpace[, $message]]]]])

Details

_assertVisiblyOn checks if element1 placed on element2. element1 may extend beyond element2 boundaries. If element1 is visibly placed on element2, assertion passes. If element1 is not visibly placed on element2, the failure messasge will be displayed in logs as failure. Example

_assertVisiblyOn(_div("item1"), _div("item2"), [0,25]); //implies _div("item1") is placed on _div("item2") where top edge of div("item1") can be upto
// 25 units below div("item2") top edge

_assertFitsWidth($element1, $element2[, $leftSpace[, $rightSpace[, $message]]])

Details

_assertFitsWidth checks if element1 fits within the width of element2. If element1 fits within element2, assertion passes. If element1 does not fits within element2, the failure messasge will be displayed in logs as failure. Example

_assertFitsWidth(_div("item1"), _div("item2"), [0,25], [-25,0]);  //implies _div("item1") is  on _div("item2") where left edge of div("item1") can be
//upto 25 units right to div("item2") left edge and right edge of div("item1") can be upto 25 units left to div("item2") right edge

_assertFitsHeight($element1, $element2[, $topSpace[, $bottomSpace[, $message]]])

Details

_assertFitsHeight checks if element1 fits within the height of element2. If element1 fits within element2, assertion passes. If element1 does not fits within element2, the failure messasge will be displayed in logs as failure. Example

_assertFitsHeight(_div("item1"), _div("item2"), [0,25], [-25,0]);  //implies _div("item1") is  on _div("item2") where top edge of div("item1") can be
//upto 25 units below div("item2") top edge and bottom edge of div("item1") can be upto 25 units above div("item2") bottom edge