net.serenitybdd.screenplay.ensure.web.TargetEnsure.kt Maven / Gradle / Ivy
package net.serenitybdd.screenplay.ensure.web
import net.serenitybdd.core.pages.WebElementFacade
import net.serenitybdd.markers.CanBeSilent
import net.serenitybdd.screenplay.Actor
import net.serenitybdd.screenplay.ensure.*
import net.serenitybdd.screenplay.targets.Target
import org.openqa.selenium.By
class TargetEnsure(val value: Target, val targetDescription: String = value.toString()) : CanBeSilent {
constructor(byLocator: By) : this(Target.the(byLocator.toString()).located(byLocator))
private var negated = false
fun not(): TargetEnsure {
negated = !negated
return this
}
private fun isNegated() = negated
var silent = false
override fun isSilent() = silent
fun silently(): TargetEnsure {
silent = true
return this
}
/**
* Verifies that the element is currently displayed
*/
fun isDisplayed() = PerformablePredicate(value, IS_DISPLAYED, isNegated(), targetDescription)
/**
* Verifies that the element is currently displayed
*/
fun isNotDisplayed() = PerformablePredicate(value, IS_NOT_DISPLAYED, isNegated(), targetDescription)
/**
* Verifies that the element is currently disabled
*/
fun isDisabled() = PerformablePredicate(value, IS_DISABLED, isNegated(), targetDescription)
/**
* Verifies that the element is currently enabled
*/
fun isEnabled() = PerformablePredicate(value, IS_ENABLED, isNegated(), targetDescription)
/**
* Verifies the text value of the specified element
*/
fun text(): StringEnsure = StringEnsure(textValueOf(value), "$targetDescription with text value")
/**
* Verifies that the text value of an element exacly matches the specified value
*/
fun hasText(expectedValue: String) = StringEnsure(textValueOf(value), "$targetDescription with text value").isEqualTo(expectedValue)
/**
* Verifies the text value of the specified element
*/
fun textValues(): CollectionEnsure = CollectionEnsure(textValuesOf(value), "$targetDescription with text values")
/**
* Verifies the text content of the specified element
*/
fun textContent(): StringEnsure = StringEnsure(textValueOf(value), "$targetDescription with text content")
/**
* Verifies the text content of the specified element is equal to the expected value
*/
fun hasTextContent(expectedValue: String) = StringEnsure(textValueOf(value), "$targetDescription with text content").isEqualTo(expectedValue)
/**
* Verifies the trimmed text content (excluding surrounding spaces) of the specified element is equal to the expected value
*/
fun hasTrimmedTextContent(expectedValue: String) = StringEnsure(trimmedTextValueOf(value), "$targetDescription with trimmed text content").isEqualTo(expectedValue)
/**
* Verifies the text content of the specified element
*/
fun textContentValues(): CollectionEnsure = CollectionEnsure(textContentsOf(value), "$targetDescription with text contents")
/**
* Verifies the value attribute of an element
*/
fun value(): StringEnsure = StringEnsure(valueOf(value), "$targetDescription with value")
/**
* Verifies the value attribute of an element is equal to the expected value
*/
fun hasValue(expectedValue: String) = StringEnsure(valueOf(value), "$targetDescription with value").isEqualTo(expectedValue)
/**
* Verifies the value attributes of all matching elements
*/
fun values(): CollectionEnsure = CollectionEnsure(valuesOf(value), "$targetDescription with values")
/**
* Verifies the value attribute of an element
*/
fun attribute(attributeName: String): StringEnsure = StringEnsure(attributeValueOf(attributeName, value), "$targetDescription with $attributeName attribute")
/**
* Verifies the value attribute of an element
*/
fun attributeValues(attributeName: String): CollectionEnsure =
CollectionEnsure(attributeValuesOf(attributeName, value), "$targetDescription with $attributeName attribute values")
/**
* Verifies the selected value attribute of a dropdown list
*/
fun selectedValue(): StringEnsure = StringEnsure(selectedValueOf(value), "$targetDescription with selected value")
fun hasSelectedValue(expectedValue: String) = StringEnsure(selectedValueOf(value), "$targetDescription with selected value").isEqualTo(expectedValue)
/**
* Verifies the selected value attribute of a dropdown list
*/
fun selectedVisibleText(): StringEnsure = StringEnsure(selectedVisibleTextOf(value), "$targetDescription with selected visible text")
fun hasSelectedVisibleText(expectedValue: String) = StringEnsure(selectedVisibleTextOf(value), "$targetDescription with selected visible text").isEqualTo(expectedValue)
/**
* Verifies that the element has a given CSS class
*/
fun hasCssClass(cssClass: String) = PerformablePredicate(value, hasCssClassWithName(cssClass), isNegated(),
targetDescription)
/**
* Verifies that the element contains at least one element matching a given locator
*/
fun containsElements(cssOrXPathExpression: String) = PerformablePredicate(value, containsElementsLocatedBy(cssOrXPathExpression), isNegated(),
targetDescription)
/**
* Verifies that the element contains at least one element matching a given locator
*/
fun containsElements(byLocator: By) = PerformablePredicate(value, containsElementsLocatedBy(byLocator), isNegated(), targetDescription)
private fun textValueOf(target: Target): KnowableValue =
fun(actor: Actor?): String {
if (actor == null) return ""
return target.resolveFor(actor).text
}
private fun trimmedTextValueOf(target: Target): KnowableValue =
fun(actor: Actor?): String {
if (actor == null) return ""
return target.resolveFor(actor).text.trim()
}
private fun textContentOf(target: Target): KnowableValue =
fun(actor: Actor?): String {
if (actor == null) return ""
return target.resolveFor(actor).textContent
}
private fun textValuesOf(target: Target): KnowableValue?> =
fun(actor: Actor?): List {
if (actor == null) return emptyList()
return target.resolveAllFor(actor).map { it.text }
}
private fun textContentsOf(target: Target): KnowableValue?> =
fun(actor: Actor?): List {
if (actor == null) return emptyList()
return target.resolveAllFor(actor).map { it.textContent }
}
private fun valueOf(target: Target): KnowableValue =
fun(actor: Actor?): String {
if (actor == null) return ""
return target.resolveFor(actor).value
}
private fun valuesOf(target: Target): KnowableValue?> =
fun(actor: Actor?): List {
if (actor == null) return emptyList()
return target.resolveAllFor(actor).map { it.value }
}
private fun attributeValueOf(attributeName: String, target: Target): KnowableValue =
fun(actor: Actor?): String {
if (actor == null) return ""
return target.resolveFor(actor).getAttribute(attributeName)
}
private fun attributeValuesOf(attributeName: String, target: Target): KnowableValue?> =
fun(actor: Actor?): List {
if (actor == null) return emptyList()
return target.resolveAllFor(actor).map { it.getAttribute(attributeName) }
}
private fun selectedValueOf(target: Target): KnowableValue =
fun(actor: Actor?): String {
if (actor == null) return ""
return target.resolveFor(actor).selectedValue
}
private fun selectedVisibleTextOf(target: Target): KnowableValue =
fun(actor: Actor?): String {
if (actor == null) return ""
return target.resolveFor(actor).selectedVisibleTextValue
}
private fun hasCssClassWithName(cssClass: String) = expectThatActualIs("has CSS class: \"$cssClass\"", "does not have CSS class: \"$cssClass\"",
fun(actor: Actor?, element: Target?): Boolean {
if ((actor == null) || (element == null)) return false
val resolvedElement = element.resolveFor(actor)
val actualCssClasses = resolvedElement.getAttribute("class")
BlackBox.logAssertionValues(actualCssClasses, cssClass)
return resolvedElement.hasClass(cssClass)
}
)
private fun containsElementsLocatedBy(xPathOrCssExpression: String) = expectThatActualIs("contains elements located by: $xPathOrCssExpression", "does not contain any elements located by: $xPathOrCssExpression",
fun(actor: Actor?, element: Target?): Boolean {
if ((actor == null) || (element == null)) return false
return element.resolveFor(actor).containsElements(xPathOrCssExpression)
}
)
private fun containsElementsLocatedBy(byLocator: By?) = expectThatActualIs("contains elements located by: $byLocator", "does not contain any elements located by: $byLocator",
fun(actor: Actor?, element: Target?): Boolean {
if ((actor == null) || (element == null)) return false
return element.resolveFor(actor).containsElements(byLocator)
}
)
companion object {
private val IS_DISPLAYED = expectThatActualIs("displayed",
fun(actor: Actor?, element: Target?): Boolean {
if ((actor == null) || (element == null)) return false
val resolvedElements = element.resolveAllFor(actor)
val actualValue = resolvedElements.size > 0 && resolvedElements[0].isCurrentlyVisible
BlackBox.logAssertionValues(isDisplayedOrNot(actualValue), "an element that is displayed")
return actualValue
}
)
private val IS_NOT_DISPLAYED = expectThatActualIs("not displayed",
fun(actor: Actor?, element: Target?): Boolean {
if ((actor == null) || (element == null)) return false
val resolvedElements = element.resolveAllFor(actor);
val actualValue = resolvedElements.size == 0 || !resolvedElements[0].isCurrentlyVisible
BlackBox.logAssertionValues(isNotDisplayed(actualValue), "an element that is not displayed")
return actualValue
}
)
private val IS_DISABLED = expectThatActualIs("disabled",
fun(actor: Actor?, element: Target?): Boolean {
if ((actor == null) || (element == null)) return false
val actualValue = element.resolveFor(actor).isDisabled
BlackBox.logAssertionValues(isDisabledOrNot(actualValue), "an element that is disabled")
return actualValue
}
)
private val IS_ENABLED = expectThatActualIs("enabled",
fun(actor: Actor?, element: Target?): Boolean {
if ((actor == null) || (element == null)) return false
val actualValue = !element.resolveFor(actor).isDisabled
BlackBox.logAssertionValues(isEnabledOrNot(actualValue), "an element that is not disabled")
return actualValue
}
)
private fun isDisabledOrNot(actualValue: Boolean) = if (actualValue) "web element is disabled" else "web element is not disabled"
private fun isEnabledOrNot(actualValue: Boolean) = if (actualValue) "web element is enabled" else "web element is not enabled"
private fun isDisplayedOrNot(actualValue: Boolean) = if (actualValue) "web element is displayed" else "web element is not displayed"
private fun isNotDisplayed(actualValue: Boolean) = if (actualValue) "web element is not displayed" else "web element is displayed"
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy