add required

Author: lsoares

README.md

@@ -61,6 +61,21 @@ driver.user.selectOptions(driver.findElement(ByRole("listbox")), "C")
 
 ℹ️ _user-event's JavaScript only loads if it's used._
 
+## jest-dom matchers
+
+[jest-dom](https://testing-library.com/docs/ecosystem-jest-dom) matchers are mapped:
+
+```kotlin
+val input = driver.findElements(ByTestId("test1"))
+assertTrue(input.isInTheDocument)
+assertFalse(input.isEmptyDomElement)
+
+// alternative API:
+expect(input).not.toBeInvalid()
+expect(input).toBeInTheDocument()
+
+```
+
 ---
 
 ℹ️ _Want to know about the creation process? Read more about it

lib/src/main/kotlin/seleniumtestinglib/coreapi/Api.kt

@@ -48,7 +48,7 @@ enum class MatchType {
 }
 
 /**
- * https://testing-library.com/docs/queries/about
+ * https://testing-library.com/docs/dom-testing-library/intro
  */
 private fun RemoteWebDriver.executeTLScript(script: String, vararg args: Any?): Any? {
     ensureScript("testing-library.js", "screen?.getAllByAltText")

lib/src/main/kotlin/seleniumtestinglib/jestdom/Api.kt

@@ -37,4 +37,8 @@ class JestDomExpect(
     fun toBeInvalid() {
         assert(webElement?.isInvalid)
     }
+
+    fun toBeRequired() {
+        assert(webElement?.isRequired)
+    }
 }

lib/src/main/kotlin/seleniumtestinglib/jestdom/JestDom.kt

@@ -10,6 +10,7 @@ val WebElement.isDisabled get() = executeJestDomQuery("toBeDisabled")
 val WebElement.isEmptyDomElement get() = executeJestDomQuery("toBeEmptyDOMElement")
 val WebElement.isInTheDocument get() = executeJestDomQuery("toBeInTheDocument")
 val WebElement.isInvalid get() = executeJestDomQuery("toBeInvalid")
+val WebElement.isRequired get() = executeJestDomQuery("toBeRequired")
 
 private fun WebElement.executeJestDomQuery(domFunction: String): Boolean {
     val driver = (this as RemoteWebElement).wrappedDriver as RemoteWebDriver

lib/src/test/kotlin/seleniumtestinglib/jestdom/RequiredTest.kt

@@ -0,0 +1,31 @@
+package seleniumtestinglib.jestdom
+
+import org.junit.jupiter.api.extension.ExtendWith
+import org.openqa.selenium.By
+import org.openqa.selenium.remote.RemoteWebDriver
+import seleniumtestinglib.DriverLifeCycle
+import seleniumtestinglib.render
+import kotlin.test.Test
+import kotlin.test.assertFalse
+import kotlin.test.assertTrue
+
+@ExtendWith(DriverLifeCycle::class)
+class RequiredTest(private val driver: RemoteWebDriver) {
+
+    @Test
+    fun required() {
+        driver.render(
+            """
+            <input required />
+            <input />
+        """
+        )
+
+        val required = driver.findElements(By.tagName("input")).first()
+        assertTrue(required.isRequired)
+        expect(required).toBeRequired()
+        val notRequired = driver.findElements(By.tagName("input")).last()
+        assertFalse(notRequired.isRequired)
+        expect(notRequired).not.toBeRequired()
+    }
+}