Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added missing isEnabled command in new Element API #4041

Merged
merged 13 commits into from
Feb 28, 2024
30 changes: 30 additions & 0 deletions lib/api/web-element/commands/isEnabled.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
/**
* Determines if an element is enabled.
*
* For more info on working with DOM elements in Nightwatch, refer to the <a href="https://nightwatchjs.org/guide/writing-tests/finding-interacting-with-dom-elements.html">Finding & interacting with DOM Elements</a> guide page.
*
* @example
* describe('isEnabled Demo', function() {
* it('test isEnabled', function(browser) {
* browser.element('#search')
* .isEnabled()
* .assert.equals(true);
* });
*
* it('test async isEnabled', async function(browser) {
* const result = await browser.element('#search').isEnabled();
* browser.assert.equal(result, true);
* });
* });
*
* @since 3.5.0
* @method isEnabled
* @memberof ScopedWebElement
* @instance
* @syntax browser.element(selector).isEnabled()
* @see https://www.w3.org/TR/webdriver/#is-element-enabled
* @returns {ScopedValue<boolean>}
*/
module.exports.command = function () {
return this.runQueuedCommandScoped('isElementEnabled');
};
122 changes: 122 additions & 0 deletions test/src/api/commands/web-element/testIsEnabled.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
const assert = require('assert');
const {WebElement} = require('selenium-webdriver');
const MockServer = require('../../../../lib/mockserver.js');
const CommandGlobals = require('../../../../lib/globals/commands-w3c.js');
const common = require('../../../../common.js');
const Element = common.require('element/index.js');

describe('element().isEnabled() command', function() {
before(function (done) {
CommandGlobals.beforeEach.call(this, done);
});

after(function (done) {
CommandGlobals.afterEach.call(this, done);
});

it('test .element().isEnabled() enabled', async function() {
MockServer.addMock({
url: '/session/13521-10219-202/element/0/enabled',
method: 'GET',
response: JSON.stringify({
value: true
})
}, true);

const resultPromise = this.client.api.element('#signupSection').isEnabled();
assert.strictEqual(resultPromise instanceof Element, false);
assert.strictEqual(typeof resultPromise.find, 'undefined');

assert.strictEqual(resultPromise instanceof Promise, false);
assert.strictEqual(typeof resultPromise.then, 'function');

const result = await resultPromise;
assert.strictEqual(result instanceof WebElement, false);
assert.strictEqual(result, true);

});

it('test .element().isEnabled() not enabled', async function() {
MockServer.addMock({
url: '/session/13521-10219-202/element/0/enabled',
method: 'GET',
response: JSON.stringify({
value: false
})
}, true);

const resultPromise = this.client.api.element('#signupSection').isEnabled();
assert.strictEqual(resultPromise instanceof Element, false);
assert.strictEqual(typeof resultPromise.find, 'undefined');

assert.strictEqual(resultPromise instanceof Promise, false);
assert.strictEqual(typeof resultPromise.then, 'function');

const result = await resultPromise;
assert.strictEqual(result instanceof WebElement, false);
assert.strictEqual(result, false);
});

it('test .element().find().isEnabled()', async function() {
MockServer.addMock({
url: '/session/13521-10219-202/element/1/enabled',
method: 'GET',
response: JSON.stringify({
value: true
})
}, true);

const resultPromise = this.client.api.element('#signupSection').find('#helpBtn').isEnabled();
assert.strictEqual(resultPromise instanceof Element, false);
assert.strictEqual(typeof resultPromise.find, 'undefined');

assert.strictEqual(resultPromise instanceof Promise, false);
assert.strictEqual(typeof resultPromise.then, 'function');

const result = await resultPromise;
assert.strictEqual(result instanceof WebElement, false);
assert.strictEqual(result, true);
});

it('test .element.find().isEnabled() not enabled', async function() {
MockServer.addMock({
url: '/session/13521-10219-202/element/0/enabled',
method: 'GET',
response: JSON.stringify({
value: false
})
}, true);

const resultPromise = this.client.api.element.find('#signupSection').isEnabled();
assert.strictEqual(resultPromise instanceof Element, false);
assert.strictEqual(typeof resultPromise.find, 'undefined');

assert.strictEqual(resultPromise instanceof Promise, false);
assert.strictEqual(typeof resultPromise.then, 'function');

const result = await resultPromise;
assert.strictEqual(result instanceof WebElement, false);
assert.strictEqual(result, false);
});

it('test .element().isEnabled() assert', async function() {
MockServer.addMock({
url: '/session/13521-10219-202/element/0/enabled',
method: 'GET',
response: JSON.stringify({
value: true
})
}, true);

const resultPromise = this.client.api.element('#signupSection').isEnabled();
assert.strictEqual(resultPromise instanceof Element, false);
assert.strictEqual(typeof resultPromise.find, 'undefined');

assert.strictEqual(resultPromise instanceof Promise, false);
assert.strictEqual(typeof resultPromise.then, 'function');

assert.strictEqual(await resultPromise.assert.equals(true), true);
assert.strictEqual(await resultPromise.assert.not.equals(false), true);
});

});
1 change: 1 addition & 0 deletions types/tests/webElement.test-d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,7 @@ describe('new element() api', function () {
expectType<ElementValue<string | null>>(elem.getProperty('property-name'));
expectType<ElementValue<string | null>>(elem.getAttribute('attrib-name'));
expectType<ElementValue<string | null>>(elem.getValue());
expectType<ElementValue<boolean>>(elem.isEnabled());

expectType<ElementValue<ScopedElementRect>>(elem.getRect());
expectType<ElementValue<ScopedElementRect>>(elem.getSize());
Expand Down
2 changes: 2 additions & 0 deletions types/web-element.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,8 @@ export interface ScopedElement extends Element, PromiseLike<WebElement> {
rightClick(): Promise<WebElement>;

waitUntil(signalOrOptions: WaitUntilActions | WaitUntilOptions, waitOptions?: WaitUntilOptions): Promise<WebElement>;

isEnabled(): ElementValue<boolean>;
}

type WaitUntilOptions = {
Expand Down
Loading