feat: add clickable, displayedInViewport, selected

jcoreio · Dec 18, 2020 · a47781a · a47781a
1 parent d234d07
commit a47781a
Show file tree

Hide file tree

Showing 20 changed files with 187 additions and 326 deletions.
diff --git a/README.md b/README.md
@@ -26,9 +26,12 @@ All assertions start with a [WebdriverIO-compatible selector](http://webdriver.i
 
 Then, we can add our assertion to the chain.
 
-- `await expect(selector).to.be.existing()` - Test whether [at least one] matching element exists in the DOM
+- `await expect(selector).to.be.clickable()` - Test whether [at least one] matching element is clickable
 - `await expect(selector).to.be.displayed()` - Test whether or not [at least one] matching element is displayed
+- `await expect(selector).to.be.displayedInViewport()` - Test whether or not [at least one] matching element is displayed in viewport
+- `await expect(selector).to.be.existing()` - Test whether [at least one] matching element exists in the DOM
 - `await expect(selector).to.be.focused()` - Test whether or not [at least one] matching element is focused
+- `await expect(selector).to.be.selected()` - Test whether or not [at least one] matching element is selected
 - `await expect(selector).to.have.text('string')` - Test the text value of the selected element(s) against supplied string. Succeeds if at least one element matches exactly
 - `await expect(selector).to.have.text(/regex/)` - Test the text value of the selected element(s) against the supplied regular expression. Succeeds if at least one element matches
 - `await expect(selector).to.have.count(number)` - Test how many elements exist in the DOM with the supplied selector

diff --git a/chains/immediately.js b/chains/immediately.js
diff --git a/chains/immediately.js.flow b/chains/immediately.js.flow
diff --git a/src/assertions/atLeastOne.js b/src/assertions/atLeastOne.js
diff --git a/src/assertions/booleanAssertion.js b/src/assertions/booleanAssertion.js
@@ -18,8 +18,8 @@ const booleanAssertion = ({ predicate, expectation, allowNone }) => (
     if (!allowNone && !elements.length) {
       throw new chai.AssertionError(
         negate
-          ? `Expected <${selector}> to not be ${expectation} but no matching elements were found`
-          : `Expected <${selector}> to be ${expectation} but no matching elements were found`
+          ? `Expected element <${selector}> to not be ${expectation} but no matching elements were found`
+          : `Expected element <${selector}> to be ${expectation} but no matching elements were found`
       )
     }
 
@@ -29,8 +29,8 @@ const booleanAssertion = ({ predicate, expectation, allowNone }) => (
 
     this.assert(
       filteredList.length > 0,
-      `Expected <${selector}> to be ${expectation} but it is not`,
-      `Expected <${selector}> to not be ${expectation} but it is`
+      `Expected element <${selector}> to be ${expectation} but it is not`,
+      `Expected element <${selector}> to not be ${expectation} but it is`
     )
   }
 

diff --git a/src/assertions/clickable.js b/src/assertions/clickable.js
@@ -0,0 +1,12 @@
+/**
+ * NOTICE
+ * This file has been modified from the source in
+ * https://github.com/marcodejongh/chai-webdriverio
+ */
+
+import booleanAssertion from './booleanAssertion'
+
+export default booleanAssertion({
+  predicate: el => el.isClickable(),
+  expectation: 'clickable',
+})
diff --git a/src/assertions/displayedInViewport.js b/src/assertions/displayedInViewport.js
@@ -0,0 +1,13 @@
+/**
+ * NOTICE
+ * This file has been modified from the source in
+ * https://github.com/marcodejongh/chai-webdriverio
+ */
+
+import booleanAssertion from './booleanAssertion'
+
+export default booleanAssertion({
+  predicate: el => el.isDisplayedInViewport(),
+  expectation: 'displayed in viewport',
+  allowNone: true,
+})
diff --git a/src/assertions/selected.js b/src/assertions/selected.js
@@ -0,0 +1,13 @@
+/**
+ * NOTICE
+ * This file has been modified from the source in
+ * https://github.com/marcodejongh/chai-webdriverio
+ */
+
+import booleanAssertion from './booleanAssertion'
+
+export default booleanAssertion({
+  predicate: el => el.isSelected(),
+  expectation: 'selected',
+  allowNone: false,
+})
diff --git a/src/index.js b/src/index.js
@@ -1,22 +1,28 @@
-import existing from './assertions/existing'
-import displayed from './assertions/displayed'
+import clickable from './assertions/clickable'
 import count from './assertions/count'
+import displayed from './assertions/displayed'
+import displayedInViewport from './assertions/displayedInViewport'
+import enabled from './assertions/enabled'
+import existing from './assertions/existing'
+import focused from './assertions/focused'
+import selected from './assertions/selected'
 import text from './assertions/text'
 import value from './assertions/value'
-import focused from './assertions/focused'
-import enabled from './assertions/enabled'
 
 export default function(client, options = {}) {
   return function chaiWebdriverIO(chai, utils) {
     const methodsToAdd = {
-      existing,
-      displayed,
+      clickable,
       count,
-      text,
-      value,
+      displayed,
+      displayedInViewport,
+      enabled,
+      existing,
       focus: focused,
       focused,
-      enabled,
+      selected,
+      text,
+      value,
     }
 
     for (const name in methodsToAdd) {

diff --git a/test/assertions/booleanAssertionTest.js b/test/assertions/booleanAssertionTest.js
@@ -0,0 +1,86 @@
+import chai, { expect } from 'chai'
+
+import { describe, beforeEach, afterEach, it } from 'mocha'
+import FakeClient from '../stubs/fake-client'
+import FakeElement from '../stubs/fake-element'
+import chaiWebdriverio from '../../src'
+import { upperFirst, lowerCase } from 'lodash'
+
+export const booleanAssertionTest = ({
+  method,
+  expectation = lowerCase(method),
+  allowNone,
+}) =>
+  describe(method, () => {
+    let fakeClient
+    let fakeElement1
+
+    beforeEach(() => {
+      fakeClient = new FakeClient()
+      fakeElement1 = new FakeElement()
+
+      fakeElement1[`is${upperFirst(method)}`].resolves(false)
+      fakeClient.$$.withArgs('.some-selector').resolves([fakeElement1])
+      fakeClient.$$.withArgs('.other-selector').resolves([])
+
+      chai.use(chaiWebdriverio(fakeClient))
+    })
+
+    afterEach(() => {
+      fakeClient.__resetStubs__()
+      fakeElement1.__resetStubs__()
+    })
+
+    describe('When not negated', () => {
+      it(`resolves when element is ${expectation}`, async function() {
+        fakeElement1[`is${upperFirst(method)}`].resolves(true)
+        await expect('.some-selector').to.be[method]()
+      })
+      it(`rejects when element is not ${expectation}`, async function() {
+        await expect('.some-selector')
+          .to.be[method]()
+          .to.be.rejectedWith(
+            `Expected element <.some-selector> to be ${expectation} but it is not`
+          )
+      })
+      it(`rejects when element does not exist`, async function() {
+        await expect('.other-selector')
+          .to.be[method]()
+          .to.be.rejectedWith(
+            allowNone
+              ? `Expected element <.other-selector> to be ${expectation} but it is not`
+              : `Expected element <.other-selector> to be ${expectation} but no matching elements were found`
+          )
+      })
+    })
+    describe('When negated', () => {
+      it(`rejects when element is ${expectation}`, async function() {
+        fakeElement1[`is${upperFirst(method)}`].resolves(true)
+        await expect(
+          expect('.some-selector')
+            .not.to.be[method]()
+            .then(null)
+        ).to.be.rejectedWith(
+          `Expected element <.some-selector> to not be ${expectation} but it is`
+        )
+      })
+      it(`resolves when element is not ${expectation}`, async function() {
+        await expect('.some-selector').not.to.be[method]()
+      })
+      if (allowNone) {
+        it(`resolves when element does not exist`, async function() {
+          await expect(expect('.other-selector').not.to.be[method]())
+        })
+      } else {
+        it(`rejects when element does not exist`, async function() {
+          await expect(
+            expect('.other-selector')
+              .not.to.be[method]()
+              .then(null)
+          ).to.be.rejectedWith(
+            `Expected element <.other-selector> to not be ${expectation} but no matching elements were found`
+          )
+        })
+      }
+    })
+  })
diff --git a/test/assertions/clickable.js b/test/assertions/clickable.js
@@ -0,0 +1,9 @@
+/**
+ * NOTICE
+ * This file has been modified from the source in
+ * https://github.com/marcodejongh/chai-webdriverio
+ */
+
+import { booleanAssertionTest } from './booleanAssertionTest'
+
+booleanAssertionTest({ method: 'clickable' })
diff --git a/test/assertions/displayed-test.js b/test/assertions/displayed-test.js
@@ -4,67 +4,6 @@
  * https://github.com/marcodejongh/chai-webdriverio
  */
 
-import chai, { expect } from 'chai'
-import FakeClient from '../stubs/fake-client'
-import chaiWebdriverio from '../../src/index'
-import FakeElement from '../stubs/fake-element'
+import { booleanAssertionTest } from './booleanAssertionTest'
 
-describe('displayed', () => {
-  let fakeClient
-  let fakeElement1
-
-  beforeEach(() => {
-    fakeClient = new FakeClient()
-    fakeElement1 = new FakeElement()
-
-    fakeElement1.isDisplayed.resolves(false)
-    fakeClient.$$.withArgs('.some-selector').resolves([fakeElement1])
-    fakeClient.$$.withArgs('.other-selector').resolves([])
-
-    chai.use(chaiWebdriverio(fakeClient))
-  })
-
-  afterEach(() => {
-    fakeClient.__resetStubs__()
-    fakeElement1.__resetStubs__()
-  })
-
-  describe('When not negated', () => {
-    it(`resolves when element is displayed`, async function() {
-      fakeElement1.isDisplayed.resolves(true)
-      await expect('.some-selector').to.be.displayed()
-    })
-    it(`rejects when element is not displayed`, async function() {
-      await expect('.some-selector')
-        .to.be.displayed()
-        .to.be.rejectedWith(
-          'Expected <.some-selector> to be displayed but it is not'
-        )
-    })
-    it(`rejects when element does not exist`, async function() {
-      await expect('.other-selector')
-        .to.be.displayed()
-        .to.be.rejectedWith(
-          'Expected <.other-selector> to be displayed but it is not'
-        )
-    })
-  })
-  describe('When negated', () => {
-    it(`rejects when element is displayed`, async function() {
-      fakeElement1.isDisplayed.resolves(true)
-      await expect(
-        expect('.some-selector')
-          .not.to.be.displayed()
-          .then(null)
-      ).to.be.rejectedWith(
-        'Expected <.some-selector> to not be displayed but it is'
-      )
-    })
-    it(`resolves when element is not displayed`, async function() {
-      await expect('.some-selector').not.to.be.displayed()
-    })
-    it(`resolves when element does not exist`, async function() {
-      await expect('.other-selector').not.to.be.displayed()
-    })
-  })
-})
+booleanAssertionTest({ method: 'displayed', allowNone: true })
diff --git a/test/assertions/displayedInViewport-test.js b/test/assertions/displayedInViewport-test.js
@@ -0,0 +1,9 @@
+/**
+ * NOTICE
+ * This file has been modified from the source in
+ * https://github.com/marcodejongh/chai-webdriverio
+ */
+
+import { booleanAssertionTest } from './booleanAssertionTest'
+
+booleanAssertionTest({ method: 'displayedInViewport', allowNone: true })