Skip to content

[Nightwatch] Add: types for BDD testing #59263

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.

Sign up for GitHub

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

Merged
typescript-bot merged 8 commits into from
Apr 1, 2022
Merged

[Nightwatch] Add: types for BDD testing #59263

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4f75c48
Add: types for BDD testing
Mar 14, 2022
0320d12
revert: NightwatchTest type
Mar 14, 2022
c94f387
refactor(index.ts): DescribeInstance
Mar 14, 2022
2f87231
Merge remote-tracking branch 'origin/master' into feat/bdd-typings-an…
Mar 30, 2022
355b497
Merge remote-tracking branch 'origin/master' into feat/bdd-typings-an…
Apr 1, 2022
b369154
fix: DescribeInstance types
Apr 1, 2022
6c12bb2
fix: more types
Apr 1, 2022
1513f5d
fix: types of DescribeInstance
Apr 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 72 additions & 2 deletions types/nightwatch/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1464,8 +1464,7 @@ export interface NightwatchComponentTestingCommands {
// tslint:disable-next-line
export interface NightwatchElement extends WebElement {}

export type NightwatchTest = (browser: NightwatchBrowser) => void;

export type NightwatchTest = (browser?: NightwatchBrowser) => void;
export interface NightwatchTestFunctions {
before?: NightwatchTestHook | undefined;
after?: NightwatchTestHook | undefined;
Expand Down Expand Up @@ -1493,6 +1492,77 @@ export function element(locator: string | ElementProperties | By | WebElement, o

export type NightwatchTests = NightwatchTestFunctions | NightwatchTestHooks;

export class DescribeInstance {
'[instance]': any;
'[attributes]': {};
'[client]': NightwatchClient;
name(): string;
tags(): string | string[];
unitTest(): boolean;
endSessionOnFail(): boolean;
skipTestcasesOnFail(): boolean;
disabled(): boolean;
desiredCapabilities(): NightwatchDesiredCapabilities;
page(): any;
globals(): NightwatchGlobals;
settings(): NightwatchOptions;
argv(): any;
timeout(value: number): void;
waitForTimeout(value: number): number | void;
waitForRetryInterval(value: number): number | void;
retryInterval(value: number): void;
retries(n: any): void;
suiteRetries(n: any): void;
define(name: any, value: any): any;
}

interface SuiteFunction {
(title: string, fn?: (this: DescribeInstance) => void): this;
only: ExclusiveSuiteFunction;
skip: PendingSuiteFunction;
}

interface ExclusiveSuiteFunction {
(title: string, fn?: (this: DescribeInstance) => void): this;
}

interface PendingSuiteFunction {
(title: string, fn: (this: DescribeInstance) => void): this | void;
}

interface ExclusiveTestFunction {
(fn: NormalFunc | AsyncFunc): this;
(title: string, fn?: NormalFunc | AsyncFunc): this;
}

interface PendingTestFunction {
(fn: NormalFunc | AsyncFunc): this;
(title: string, fn?: NormalFunc | AsyncFunc): this;
}

type NormalFunc = (this: DescribeInstance) => any;
type AsyncFunc = (this: DescribeInstance) => PromiseLike<any>;
interface TestFunction {
(fn: NormalFunc | AsyncFunc): this;
(title: string, fn?: NormalFunc | AsyncFunc): this;
only: ExclusiveTestFunction;
skip: PendingTestFunction;
retries(n: number): void;
}

export const describe: SuiteFunction;
export const xdescribe: PendingSuiteFunction;
export const context: SuiteFunction;
export const xcontext: PendingSuiteFunction;
export const test: TestFunction;
export const it: TestFunction;
export const xit: PendingTestFunction;
export const specify: TestFunction;
export const xspecify: PendingTestFunction;
export const before: GlobalNightwatchTestHook;
export const after: GlobalNightwatchTestHook;
export const beforeEach: GlobalNightwatchTestHookEach;
export const afterEach: GlobalNightwatchTestHookEach;
/**
* Performs an assertion
*
Expand Down
44 changes: 44 additions & 0 deletions types/nightwatch/test/nightwatch-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@ import {
NightwatchAPI,
NightwatchAssertion,
NightwatchTests,
describe,
it,
before,
after,
xit,
xdescribe,
test,
PageObjectModel,
} from 'nightwatch';

Expand Down Expand Up @@ -68,6 +75,43 @@ const testGeneral: NightwatchTests = {
},
};

describe('Ecosia', () => {
before(browser => browser.url('https://www.ecosia.org/'));

it('Demo test ecosia.org', () => {
browser
.waitForElementVisible('body')
.assert.titleContains('Ecosia')
.assert.titleContains('Ecosia')
.assert.visible('input[type=search]')
.setValue('input[type=search]', 'nightwatch')
.assert.visible('button[type=submit]')
.click('button[type=submit]');
});

xit('this test will be skipped', () => {
browser.waitForElementVisible('body');
});

after(browser => browser.end());
});

xdescribe('whole describle block will be skipped', () => {
test('ecosia', () => {
browser.url('https://ecosia.org').end();
});
});

describe('Async Ecosia', () => {
before(browser => browser.url('https://www.ecosia.org/'));

it('Demo test ecosia.org', async () => {
browser.waitForElementVisible('body');
});

after(browser => browser.end());
});

//
// ./pages/google.ts
//
Expand Down