Skip to content

Commit

Permalink
WebElementWrapper: add findByTestSubject/findAllByTestSubject to sear…
Browse files Browse the repository at this point in the history
…ch with data-test-subj (#60568) (#60756)

* [web_element_wrapper] add find/findAll to search with data-test-subj

* fixes

* fix wrong function call

* review fixes

* simplify test

Co-authored-by: Elastic Machine <[email protected]>

Co-authored-by: Elastic Machine <[email protected]>
  • Loading branch information
dmlemeshko and elasticmachine authored Mar 23, 2020
1 parent 785b9bc commit 4c7a447
Show file tree
Hide file tree
Showing 17 changed files with 88 additions and 82 deletions.
3 changes: 1 addition & 2 deletions test/functional/apps/visualize/_tile_map.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ export default function({ getService, getPageObjects }) {
const log = getService('log');
const retry = getService('retry');
const inspector = getService('inspector');
const find = getService('find');
const filterBar = getService('filterBar');
const testSubjects = getService('testSubjects');
const browser = getService('browser');
Expand Down Expand Up @@ -278,7 +277,7 @@ export default function({ getService, getPageObjects }) {
it('should suppress zoom warning if suppress warnings button clicked', async () => {
last = true;
await PageObjects.visChart.waitForVisualization();
await find.clickByCssSelector('[data-test-subj="suppressZoomWarnings"]');
await testSubjects.click('suppressZoomWarnings');
await PageObjects.tileMap.clickMapZoomOut(waitForLoading);
await testSubjects.waitForDeleted('suppressZoomWarnings');
await PageObjects.tileMap.clickMapZoomIn(waitForLoading);
Expand Down
2 changes: 1 addition & 1 deletion test/functional/page_objects/common_page.ts
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ export function CommonPageProvider({ getService, getPageObjects }: FtrProviderCo
private async loginIfPrompted(appUrl: string) {
let currentUrl = await browser.getCurrentUrl();
log.debug(`currentUrl = ${currentUrl}\n appUrl = ${appUrl}`);
await find.byCssSelector('[data-test-subj="kibanaChrome"]', 6 * defaultFindTimeout); // 60 sec waiting
await testSubjects.find('kibanaChrome', 6 * defaultFindTimeout); // 60 sec waiting
const loginPage = currentUrl.includes('/login');
const wantedLoginPage = appUrl.includes('/login') || appUrl.includes('/logout');

Expand Down
4 changes: 2 additions & 2 deletions test/functional/page_objects/discover_page.ts
Original file line number Diff line number Diff line change
Expand Up @@ -255,14 +255,14 @@ export function DiscoverPageProvider({ getService, getPageObjects }: FtrProvider
public async clickFieldListPlusFilter(field: string, value: string) {
// this method requires the field details to be open from clickFieldListItem()
// testSubjects.find doesn't handle spaces in the data-test-subj value
await find.clickByCssSelector(`[data-test-subj="plus-${field}-${value}"]`);
await testSubjects.click(`plus-${field}-${value}`);
await header.waitUntilLoadingHasFinished();
}

public async clickFieldListMinusFilter(field: string, value: string) {
// this method requires the field details to be open from clickFieldListItem()
// testSubjects.find doesn't handle spaces in the data-test-subj value
await find.clickByCssSelector('[data-test-subj="minus-' + field + '-' + value + '"]');
await testSubjects.click(`minus-${field}-${value}`);
await header.waitUntilLoadingHasFinished();
}

Expand Down
2 changes: 1 addition & 1 deletion test/functional/page_objects/newsfeed_page.ts
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ export function NewsfeedPageProvider({ getService, getPageObjects }: FtrProvider

async getNewsfeedList() {
const list = await testSubjects.find('NewsfeedFlyout');
const cells = await list.findAllByCssSelector('[data-test-subj="newsHeadAlert"]');
const cells = await list.findAllByTestSubject('newsHeadAlert');

const objects = [];
for (const cell of cells) {
Expand Down
3 changes: 1 addition & 2 deletions test/functional/page_objects/settings_page.ts
Original file line number Diff line number Diff line change
Expand Up @@ -211,9 +211,8 @@ export function SettingsPageProvider({ getService, getPageObjects }: FtrProvider
}

async getScriptedFieldsTabCount() {
const selector = '[data-test-subj="tab-count-scriptedFields"]';
return await retry.try(async () => {
const theText = await (await find.byCssSelector(selector)).getVisibleText();
const theText = await testSubjects.getVisibleText('tab-count-scriptedFields');
return theText.replace(/\((.*)\)/, '$1');
});
}
Expand Down
5 changes: 2 additions & 3 deletions test/functional/page_objects/timelion_page.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@

export function TimelionPageProvider({ getService, getPageObjects }) {
const testSubjects = getService('testSubjects');
const find = getService('find');
const log = getService('log');
const PageObjects = getPageObjects(['common', 'header']);
const esArchiver = getService('esArchiver');
Expand Down Expand Up @@ -55,12 +54,12 @@ export function TimelionPageProvider({ getService, getPageObjects }) {
}

async getSuggestionItemsText() {
const elements = await find.allByCssSelector('[data-test-subj="timelionSuggestionListItem"]');
const elements = await testSubjects.findAll('timelionSuggestionListItem');
return await Promise.all(elements.map(async element => await element.getVisibleText()));
}

async clickSuggestion(suggestionIndex = 0, waitTime = 500) {
const elements = await find.allByCssSelector('[data-test-subj="timelionSuggestionListItem"]');
const elements = await testSubjects.findAll('timelionSuggestionListItem');
if (suggestionIndex > elements.length) {
throw new Error(
`Unable to select suggestion ${suggestionIndex}, only ${elements.length} suggestions available.`
Expand Down
4 changes: 2 additions & 2 deletions test/functional/page_objects/visual_builder_page.ts
Original file line number Diff line number Diff line change
Expand Up @@ -485,7 +485,7 @@ export function VisualBuilderPageProvider({ getService, getPageObjects }: FtrPro
const labels = await testSubjects.findAll('aggRow');
const label = labels[aggNth];

return (await label.findAllByCssSelector('[data-test-subj = "comboBoxInput"]'))[1];
return (await label.findAllByTestSubject('comboBoxInput'))[1];
}

public async clickColorPicker(): Promise<void> {
Expand Down Expand Up @@ -533,7 +533,7 @@ export function VisualBuilderPageProvider({ getService, getPageObjects }: FtrPro
*/
public async getAggregationCount(nth: number = 0): Promise<number> {
const series = await this.getSeries();
const aggregation = await series[nth].findAllByCssSelector('[data-test-subj="draggable"]');
const aggregation = await series[nth].findAllByTestSubject('draggable');
return aggregation.length;
}

Expand Down
2 changes: 1 addition & 1 deletion test/functional/page_objects/visualize_editor_page.ts
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ export function VisualizeEditorPageProvider({ getService, getPageObjects }: FtrP
*/
public async clickBucket(bucketName: string, type = 'buckets') {
await testSubjects.click(`visEditorAdd_${type}`);
await find.clickByCssSelector(`[data-test-subj="visEditorAdd_${type}_${bucketName}"`);
await testSubjects.click(`visEditorAdd_${type}_${bucketName}`);
}

public async clickEnableCustomRanges() {
Expand Down
10 changes: 4 additions & 6 deletions test/functional/services/combo_box.ts
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ export function ComboBoxProvider({ getService, getPageObjects }: FtrProviderCont
return;
}

const clearBtn = await comboBox.findByCssSelector('[data-test-subj="comboBoxClearButton"]');
const clearBtn = await comboBox.findByTestSubject('comboBoxClearButton');
await clearBtn.click();

const clearButtonStillExists = await this.doesClearButtonExist(comboBox);
Expand All @@ -230,8 +230,8 @@ export function ComboBoxProvider({ getService, getPageObjects }: FtrProviderCont
}

public async doesClearButtonExist(comboBoxElement: WebElementWrapper): Promise<boolean> {
const found = await comboBoxElement.findAllByCssSelector(
'[data-test-subj="comboBoxClearButton"]',
const found = await comboBoxElement.findAllByTestSubject(
'comboBoxClearButton',
WAIT_FOR_EXISTS_TIME
);
return found.length > 0;
Expand Down Expand Up @@ -264,9 +264,7 @@ export function ComboBoxProvider({ getService, getPageObjects }: FtrProviderCont
public async openOptionsList(comboBoxElement: WebElementWrapper): Promise<void> {
const isOptionsListOpen = await testSubjects.exists('~comboBoxOptionsList');
if (!isOptionsListOpen) {
const toggleBtn = await comboBoxElement.findByCssSelector(
'[data-test-subj="comboBoxToggleListButton"]'
);
const toggleBtn = await comboBoxElement.findByTestSubject('comboBoxToggleListButton');
await toggleBtn.click();
}
}
Expand Down
18 changes: 8 additions & 10 deletions test/functional/services/doc_table.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,12 +48,12 @@ export function DocTableProvider({ getService, getPageObjects }: FtrProviderCont

public async getBodyRows(): Promise<WebElementWrapper[]> {
const table = await this.getTable();
return await table.findAllByCssSelector('[data-test-subj~="docTableRow"]');
return await table.findAllByTestSubject('~docTableRow');
}

public async getAnchorRow(): Promise<WebElementWrapper> {
const table = await this.getTable();
return await table.findByCssSelector('[data-test-subj~="docTableAnchorRow"]');
return await table.findByTestSubject('~docTableAnchorRow');
}

public async getRow(options: SelectOptions): Promise<WebElementWrapper> {
Expand All @@ -73,7 +73,7 @@ export function DocTableProvider({ getService, getPageObjects }: FtrProviderCont
options: SelectOptions = { isAnchorRow: false, rowIndex: 0 }
): Promise<void> {
const row = await this.getRow(options);
const toggle = await row.findByCssSelector('[data-test-subj~="docTableExpandToggleColumn"]');
const toggle = await row.findByTestSubject('~docTableExpandToggleColumn');
await toggle.click();
}

Expand All @@ -90,7 +90,7 @@ export function DocTableProvider({ getService, getPageObjects }: FtrProviderCont
const detailsRow = options.isAnchorRow
? await this.getAnchorDetailsRow()
: (await this.getDetailsRows())[options.rowIndex];
return await detailsRow.findAllByCssSelector('[data-test-subj~="docTableRowAction"]');
return await detailsRow.findAllByTestSubject('~docTableRowAction');
}

public async getFields(options: { isAnchorRow: boolean } = { isAnchorRow: false }) {
Expand Down Expand Up @@ -122,15 +122,13 @@ export function DocTableProvider({ getService, getPageObjects }: FtrProviderCont
detailsRow: WebElementWrapper,
fieldName: WebElementWrapper
): Promise<WebElementWrapper> {
return await detailsRow.findByCssSelector(`[data-test-subj~="tableDocViewRow-${fieldName}"]`);
return await detailsRow.findByTestSubject(`~tableDocViewRow-${fieldName}`);
}

public async getAddInclusiveFilterButton(
tableDocViewRow: WebElementWrapper
): Promise<WebElementWrapper> {
return await tableDocViewRow.findByCssSelector(
`[data-test-subj~="addInclusiveFilterButton"]`
);
return await tableDocViewRow.findByTestSubject(`~addInclusiveFilterButton`);
}

public async addInclusiveFilter(
Expand All @@ -146,7 +144,7 @@ export function DocTableProvider({ getService, getPageObjects }: FtrProviderCont
public async getAddExistsFilterButton(
tableDocViewRow: WebElementWrapper
): Promise<WebElementWrapper> {
return await tableDocViewRow.findByCssSelector(`[data-test-subj~="addExistsFilterButton"]`);
return await tableDocViewRow.findByTestSubject(`~addExistsFilterButton`);
}

public async addExistsFilter(
Expand All @@ -171,7 +169,7 @@ export function DocTableProvider({ getService, getPageObjects }: FtrProviderCont
const detailsRow = await row.findByXpath(
'./following-sibling::*[@data-test-subj="docTableDetailsRow"]'
);
return detailsRow.findByCssSelector('[data-test-subj~="docViewer"]');
return detailsRow.findByTestSubject('~docViewer');
});
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -537,6 +537,40 @@ export class WebElementWrapper {
});
}

/**
* Gets the first element inside this element matching the given data-test-subj selector.
*
* @param {string} selector
* @return {Promise<WebElementWrapper>}
*/
public async findByTestSubject(selector: string) {
return await this.retryCall(async function find(wrapper) {
return wrapper._wrap(
await wrapper._webElement.findElement(wrapper.By.css(testSubjSelector(selector))),
wrapper.By.css(selector)
);
});
}

/**
* Gets all elements inside this element matching the given data-test-subj selector.
*
* @param {string} selector
* @param {number} timeout
* @return {Promise<WebElementWrapper[]>}
*/
public async findAllByTestSubject(selector: string, timeout?: number) {
return await this.retryCall(async function findAll(wrapper) {
return wrapper._wrapAll(
await wrapper._findWithCustomTimeout(
async () =>
await wrapper._webElement.findElements(wrapper.By.css(testSubjSelector(selector))),
timeout
)
);
});
}

/**
* Gets the first element inside this element matching the given CSS class name.
* https://seleniumhq.github.io/selenium/docs/api/javascript/module/selenium-webdriver/lib/webdriver_exports_WebElement.html#findElement
Expand Down
2 changes: 1 addition & 1 deletion x-pack/test/functional/page_objects/gis_page.js
Original file line number Diff line number Diff line change
Expand Up @@ -451,7 +451,7 @@ export function GisPageProvider({ getService, getPageObjects }) {

async getCodeBlockParsedJson(dataTestSubjName) {
log.debug(`Get parsed code block for ${dataTestSubjName}`);
const indexRespCodeBlock = await find.byCssSelector(`[data-test-subj="${dataTestSubjName}"]`);
const indexRespCodeBlock = await testSubjects.find(`${dataTestSubjName}`);
const indexRespJson = await indexRespCodeBlock.getAttribute('innerText');
return JSON.parse(indexRespJson);
}
Expand Down
30 changes: 10 additions & 20 deletions x-pack/test/functional/page_objects/rollup_page.js
Original file line number Diff line number Diff line change
Expand Up @@ -111,28 +111,18 @@ export function RollupPageProvider({ getService, getPageObjects }) {
async getJobList() {
const jobs = await testSubjects.findAll('jobTableRow');
return mapAsync(jobs, async job => {
const jobNameElement = await job.findByCssSelector('[data-test-subj="jobTableCell-id"]');
const jobStatusElement = await job.findByCssSelector(
'[data-test-subj="jobTableCell-status"]'
const jobNameElement = await job.findByTestSubject('jobTableCell-id');
const jobStatusElement = await job.findByTestSubject('jobTableCell-status');
const jobIndexPatternElement = await job.findByTestSubject('jobTableCell-indexPattern');
const jobRollUpIndexPatternElement = await job.findByTestSubject(
'jobTableCell-rollupIndex'
);
const jobIndexPatternElement = await job.findByCssSelector(
'[data-test-subj="jobTableCell-indexPattern"]'
);
const jobRollUpIndexPatternElement = await job.findByCssSelector(
'[data-test-subj="jobTableCell-rollupIndex"]'
);
const jobDelayElement = await job.findByCssSelector(
'[data-test-subj="jobTableCell-rollupDelay"]'
);
const jobIntervalElement = await job.findByCssSelector(
'[data-test-subj="jobTableCell-dateHistogramInterval"]'
);
const jobGroupElement = await job.findByCssSelector(
'[data-test-subj="jobTableCell-groups"]'
);
const jobMetricsElement = await job.findByCssSelector(
'[data-test-subj="jobTableCell-metrics"]'
const jobDelayElement = await job.findByTestSubject('jobTableCell-rollupDelay');
const jobIntervalElement = await job.findByTestSubject(
'jobTableCell-dateHistogramInterval'
);
const jobGroupElement = await job.findByTestSubject('jobTableCell-groups');
const jobMetricsElement = await job.findByTestSubject('jobTableCell-metrics');

return {
jobName: await jobNameElement.getVisibleText(),
Expand Down
27 changes: 11 additions & 16 deletions x-pack/test/functional/page_objects/security_page.js
Original file line number Diff line number Diff line change
Expand Up @@ -229,13 +229,12 @@ export function SecurityPageProvider({ getService, getPageObjects }) {
async getElasticsearchUsers() {
const users = await testSubjects.findAll('userRow');
return mapAsync(users, async user => {
const fullnameElement = await user.findByCssSelector('[data-test-subj="userRowFullName"]');
const usernameElement = await user.findByCssSelector('[data-test-subj="userRowUserName"]');
const emailElement = await user.findByCssSelector('[data-test-subj="userRowEmail"]');
const rolesElement = await user.findByCssSelector('[data-test-subj="userRowRoles"]');
// findAllByCssSelector is substantially faster than `find.descendantExistsByCssSelector for negative cases
const isUserReserved =
(await user.findAllByCssSelector('span[data-test-subj="userReserved"]', 1)).length > 0;
const fullnameElement = await user.findByTestSubject('userRowFullName');
const usernameElement = await user.findByTestSubject('userRowUserName');
const emailElement = await user.findByTestSubject('userRowEmail');
const rolesElement = await user.findByTestSubject('userRowRoles');
// findAll is substantially faster than `find.descendantExistsByCssSelector for negative cases
const isUserReserved = (await user.findAllByTestSubject('userReserved', 1)).length > 0;

return {
username: await usernameElement.getVisibleText(),
Expand All @@ -251,15 +250,11 @@ export function SecurityPageProvider({ getService, getPageObjects }) {
const users = await testSubjects.findAll('roleRow');
return mapAsync(users, async role => {
const [rolename, reserved, deprecated] = await Promise.all([
role.findByCssSelector('[data-test-subj="roleRowName"]').then(el => el.getVisibleText()),
// findAllByCssSelector is substantially faster than `find.descendantExistsByCssSelector for negative cases
role
.findAllByCssSelector('span[data-test-subj="roleReserved"]', 1)
.then(el => el.length > 0),
// findAllByCssSelector is substantially faster than `find.descendantExistsByCssSelector for negative cases
role
.findAllByCssSelector('span[data-test-subj="roleDeprecated"]', 1)
.then(el => el.length > 0),
role.findByTestSubject('roleRowName').then(el => el.getVisibleText()),
// findAll is substantially faster than `find.descendantExistsByCssSelector for negative cases
role.findAllByTestSubject('roleReserved', 1).then(el => el.length > 0),
// findAll is substantially faster than `find.descendantExistsByCssSelector for negative cases
role.findAllByTestSubject('roleDeprecated', 1).then(el => el.length > 0),
]);

return {
Expand Down
18 changes: 6 additions & 12 deletions x-pack/test/functional/page_objects/snapshot_restore_page.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,21 +28,15 @@ export function SnapshotRestorePageProvider({ getService }: FtrProviderContext)
},
async getRepoList() {
const table = await testSubjects.find('repositoryTable');
const rows = await table.findAllByCssSelector('[data-test-subj="row"]');
const rows = await table.findAllByTestSubject('row');
return await Promise.all(
rows.map(async row => {
return {
repoName: await (
await row.findByCssSelector('[data-test-subj="Name_cell"]')
).getVisibleText(),
repoLink: await (
await row.findByCssSelector('[data-test-subj="Name_cell"]')
).findByCssSelector('a'),
repoType: await (
await row.findByCssSelector('[data-test-subj="Type_cell"]')
).getVisibleText(),
repoEdit: await row.findByCssSelector('[data-test-subj="editRepositoryButton"]'),
repoDelete: await row.findByCssSelector('[data-test-subj="deleteRepositoryButton"]'),
repoName: await (await row.findByTestSubject('Name_cell')).getVisibleText(),
repoLink: await (await row.findByTestSubject('Name_cell')).findByCssSelector('a'),
repoType: await (await row.findByTestSubject('Type_cell')).getVisibleText(),
repoEdit: await row.findByTestSubject('editRepositoryButton'),
repoDelete: await row.findByTestSubject('deleteRepositoryButton'),
};
})
);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => {
await testSubjects.click('slackAddVariableButton');
const variableMenuButton = await testSubjects.find('variableMenuButton-0');
await variableMenuButton.click();
await find.clickByCssSelector('[data-test-subj="saveAlertButton"]');
await testSubjects.click('saveAlertButton');
const toastTitle = await pageObjects.common.closeToast();
expect(toastTitle).to.eql(`Saved '${alertName}'`);
await pageObjects.triggersActionsUI.searchAlerts(alertName);
Expand Down
Loading

0 comments on commit 4c7a447

Please sign in to comment.