/** * Copyright 2018 Google Inc. All rights reserved. * Modifications copyright (c) Microsoft Corporation. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ const path = require('path'); const zsSelectorEngineSource = require('../lib/generated/zsSelectorEngineSource'); /** * @type {PageTestSuite} */ module.exports.describe = function({testRunner, expect, playwright, FFOX, CHROMIUM, WEBKIT}) { const {describe, xdescribe, fdescribe} = testRunner; const {it, fit, xit, dit} = testRunner; const {beforeAll, beforeEach, afterAll, afterEach} = testRunner; describe('Page.$eval', function() { it('should work with css selector', async({page, server}) => { await page.setContent('
43543
'); const idAttribute = await page.$eval('css=section', e => e.id); expect(idAttribute).toBe('testAttribute'); }); it('should work with id selector', async({page, server}) => { await page.setContent('
43543
'); const idAttribute = await page.$eval('id=testAttribute', e => e.id); expect(idAttribute).toBe('testAttribute'); }); it('should work with data-test selector', async({page, server}) => { await page.setContent('
43543
'); const idAttribute = await page.$eval('data-test=foo', e => e.id); expect(idAttribute).toBe('testAttribute'); }); it('should work with data-testid selector', async({page, server}) => { await page.setContent('
43543
'); const idAttribute = await page.$eval('data-testid=foo', e => e.id); expect(idAttribute).toBe('testAttribute'); }); it('should work with data-test-id selector', async({page, server}) => { await page.setContent('
43543
'); const idAttribute = await page.$eval('data-test-id=foo', e => e.id); expect(idAttribute).toBe('testAttribute'); }); it('should work with text selector', async({page, server}) => { await page.setContent('
43543
'); const idAttribute = await page.$eval('text="43543"', e => e.id); expect(idAttribute).toBe('testAttribute'); }); it('should work with xpath selector', async({page, server}) => { await page.setContent('
43543
'); const idAttribute = await page.$eval('xpath=/html/body/section', e => e.id); expect(idAttribute).toBe('testAttribute'); }); it('should work with text selector', async({page, server}) => { await page.setContent('
43543
'); const idAttribute = await page.$eval('text=43543', e => e.id); expect(idAttribute).toBe('testAttribute'); }); it('should auto-detect css selector', async({page, server}) => { await page.setContent('
43543
'); const idAttribute = await page.$eval('section', e => e.id); expect(idAttribute).toBe('testAttribute'); }); it('should auto-detect css selector with attributes', async({page, server}) => { await page.setContent('
43543
'); const idAttribute = await page.$eval('section[id="testAttribute"]', e => e.id); expect(idAttribute).toBe('testAttribute'); }); it('should auto-detect nested selectors', async({page, server}) => { await page.setContent('
43543Hello
'); const idAttribute = await page.$eval('div[foo=bar] > section >> "Hello" >> div', e => e.id); expect(idAttribute).toBe('target'); }); it('should accept arguments', async({page, server}) => { await page.setContent('
hello
'); const text = await page.$eval('section', (e, suffix) => e.textContent + suffix, ' world!'); expect(text).toBe('hello world!'); }); it('should accept ElementHandles as arguments', async({page, server}) => { await page.setContent('
hello
world
'); const divHandle = await page.$('div'); const text = await page.$eval('section', (e, div) => e.textContent + div.textContent, divHandle); expect(text).toBe('hello world'); }); it('should throw error if no element is found', async({page, server}) => { let error = null; await page.$eval('section', e => e.id).catch(e => error = e); expect(error.message).toContain('failed to find element matching selector "section"'); }); it('should support >> syntax', async({page, server}) => { await page.setContent('
hello
'); const text = await page.$eval('css=section >> css=div', (e, suffix) => e.textContent + suffix, ' world!'); expect(text).toBe('hello world!'); }); it('should support >> syntax with different engines', async({page, server}) => { await page.setContent('
hello
'); const text = await page.$eval('xpath=/html/body/section >> css=div >> text="hello"', (e, suffix) => e.textContent + suffix, ' world!'); expect(text).toBe('hello world!'); }); it('should support spaces with >> syntax', async({page, server}) => { await page.goto(server.PREFIX + '/deep-shadow.html'); const text = await page.$eval(' css = div >>css=div>>css = span ', e => e.textContent); expect(text).toBe('Hello from root2'); }); it('should enter shadow roots with >> syntax', async({page, server}) => { await page.goto(server.PREFIX + '/deep-shadow.html'); const text1 = await page.$eval('css=div >> css=span', e => e.textContent); expect(text1).toBe('Hello from root1'); const text2 = await page.$eval('css=div >> css=*:nth-child(2) >> css=span', e => e.textContent); expect(text2).toBe('Hello from root2'); const nonExisting = await page.$('css=div div >> css=span'); expect(nonExisting).not.toBeTruthy(); const text3 = await page.$eval('css=section div >> css=span', e => e.textContent); expect(text3).toBe('Hello from root1'); const text4 = await page.$eval('xpath=/html/body/section/div >> css=div >> css=span', e => e.textContent); expect(text4).toBe('Hello from root2'); }); it('should not stop at first failure with >> syntax', async({page, server}) => { await page.setContent('
Next
'); const html = await page.$eval('button >> "Next"', e => e.outerHTML); expect(html).toBe(''); }); }); describe('Page.$$eval', function() { it('should work with css selector', async({page, server}) => { await page.setContent('
hello
beautiful
world!
'); const divsCount = await page.$$eval('css=div', divs => divs.length); expect(divsCount).toBe(3); }); it('should work with text selector', async({page, server}) => { await page.setContent('
hello
beautiful
beautiful
world!
'); const divsCount = await page.$$eval('text="beautiful"', divs => divs.length); expect(divsCount).toBe(2); }); it('should work with xpath selector', async({page, server}) => { await page.setContent('
hello
beautiful
world!
'); const divsCount = await page.$$eval('xpath=/html/body/div', divs => divs.length); expect(divsCount).toBe(3); }); it('should auto-detect css selector', async({page, server}) => { await page.setContent('
hello
beautiful
world!
'); const divsCount = await page.$$eval('div', divs => divs.length); expect(divsCount).toBe(3); }); it('should support >> syntax', async({page, server}) => { await page.setContent('
hello
beautiful
world!
Not this one'); const spansCount = await page.$$eval('css=div >> css=span', spans => spans.length); expect(spansCount).toBe(3); }); it('should enter shadow roots with >> syntax', async({page, server}) => { await page.goto(server.PREFIX + '/deep-shadow.html'); const spansCount = await page.$$eval('css=div >> css=div >> css=span', spans => spans.length); expect(spansCount).toBe(2); }); }); describe('Page.$', function() { it('should query existing element with css selector', async({page, server}) => { await page.setContent('
test
'); const element = await page.$('css=section'); expect(element).toBeTruthy(); }); it('should query existing element with text selector', async({page, server}) => { await page.setContent('
test
'); const element = await page.$('text="test"'); expect(element).toBeTruthy(); }); it('should query existing element with xpath selector', async({page, server}) => { await page.setContent('
test
'); const element = await page.$('xpath=/html/body/section'); expect(element).toBeTruthy(); }); it('should return null for non-existing element', async({page, server}) => { const element = await page.$('non-existing-element'); expect(element).toBe(null); }); it('should auto-detect xpath selector', async({page, server}) => { await page.setContent('
test
'); const element = await page.$('//html/body/section'); expect(element).toBeTruthy(); }); it('should auto-detect xpath selector with starting parenthesis', async({page, server}) => { await page.setContent('
test
'); const element = await page.$('(//section)[1]'); expect(element).toBeTruthy(); }); it('should auto-detect text selector', async({page, server}) => { await page.setContent('
test
'); const element = await page.$('"test"'); expect(element).toBeTruthy(); }); it('should auto-detect css selector', async({page, server}) => { await page.setContent('
test
'); const element = await page.$('section'); expect(element).toBeTruthy(); }); it('should support >> syntax', async({page, server}) => { await page.setContent('
test
'); const element = await page.$('css=section >> css=div'); expect(element).toBeTruthy(); }); }); describe('Page.$$', function() { it('should query existing elements', async({page, server}) => { await page.setContent('
A

B
'); const elements = await page.$$('div'); expect(elements.length).toBe(2); const promises = elements.map(element => page.evaluate(e => e.textContent, element)); expect(await Promise.all(promises)).toEqual(['A', 'B']); }); it('should return empty array if nothing is found', async({page, server}) => { await page.goto(server.EMPTY_PAGE); const elements = await page.$$('div'); expect(elements.length).toBe(0); }); }); describe('Page.$$ xpath', function() { it('should query existing element', async({page, server}) => { await page.setContent('
test
'); const elements = await page.$$('xpath=/html/body/section'); expect(elements[0]).toBeTruthy(); expect(elements.length).toBe(1); }); it('should return empty array for non-existing element', async({page, server}) => { const element = await page.$$('//html/body/non-existing-element'); expect(element).toEqual([]); }); it('should return multiple elements', async({page, server}) => { await page.setContent('
'); const elements = await page.$$('xpath=/html/body/div'); expect(elements.length).toBe(2); }); }); describe('ElementHandle.$', function() { it('should query existing element', async({page, server}) => { await page.goto(server.PREFIX + '/playground.html'); await page.setContent('
A
'); const html = await page.$('html'); const second = await html.$('.second'); const inner = await second.$('.inner'); const content = await page.evaluate(e => e.textContent, inner); expect(content).toBe('A'); }); it('should return null for non-existing element', async({page, server}) => { await page.setContent('
B
'); const html = await page.$('html'); const second = await html.$('.third'); expect(second).toBe(null); }); }); describe('ElementHandle.$eval', function() { it('should work', async({page, server}) => { await page.setContent('
100
10
'); const tweet = await page.$('.tweet'); const content = await tweet.$eval('.like', node => node.innerText); expect(content).toBe('100'); }); it('should retrieve content from subtree', async({page, server}) => { const htmlContent = '
not-a-child-div
a-child-div
'; await page.setContent(htmlContent); const elementHandle = await page.$('#myId'); const content = await elementHandle.$eval('.a', node => node.innerText); expect(content).toBe('a-child-div'); }); it('should throw in case of missing selector', async({page, server}) => { const htmlContent = '
not-a-child-div
'; await page.setContent(htmlContent); const elementHandle = await page.$('#myId'); const errorMessage = await elementHandle.$eval('.a', node => node.innerText).catch(error => error.message); expect(errorMessage).toBe(`Error: failed to find element matching selector ".a"`); }); }); describe('ElementHandle.$$eval', function() { it('should work', async({page, server}) => { await page.setContent('
100
10
'); const tweet = await page.$('.tweet'); const content = await tweet.$$eval('.like', nodes => nodes.map(n => n.innerText)); expect(content).toEqual(['100', '10']); }); it('should retrieve content from subtree', async({page, server}) => { const htmlContent = '
not-a-child-div
a1-child-div
a2-child-div
'; await page.setContent(htmlContent); const elementHandle = await page.$('#myId'); const content = await elementHandle.$$eval('.a', nodes => nodes.map(n => n.innerText)); expect(content).toEqual(['a1-child-div', 'a2-child-div']); }); it('should not throw in case of missing selector', async({page, server}) => { const htmlContent = '
not-a-child-div
'; await page.setContent(htmlContent); const elementHandle = await page.$('#myId'); const nodesLength = await elementHandle.$$eval('.a', nodes => nodes.length); expect(nodesLength).toBe(0); }); }); describe('ElementHandle.$$', function() { it('should query existing elements', async({page, server}) => { await page.setContent('
A

B
'); const html = await page.$('html'); const elements = await html.$$('div'); expect(elements.length).toBe(2); const promises = elements.map(element => page.evaluate(e => e.textContent, element)); expect(await Promise.all(promises)).toEqual(['A', 'B']); }); it('should return empty array for non-existing elements', async({page, server}) => { await page.setContent('A
B'); const html = await page.$('html'); const elements = await html.$$('div'); expect(elements.length).toBe(0); }); }); describe('ElementHandle.$$ xpath', function() { it('should query existing element', async({page, server}) => { await page.goto(server.PREFIX + '/playground.html'); await page.setContent('
A
'); const html = await page.$('html'); const second = await html.$$(`xpath=./body/div[contains(@class, 'second')]`); const inner = await second[0].$$(`xpath=./div[contains(@class, 'inner')]`); const content = await page.evaluate(e => e.textContent, inner[0]); expect(content).toBe('A'); }); it('should return null for non-existing element', async({page, server}) => { await page.setContent('
B
'); const html = await page.$('html'); const second = await html.$$(`xpath=/div[contains(@class, 'third')]`); expect(second).toEqual([]); }); }); describe('zselector', () => { beforeAll(async () => { try { await playwright.selectors.register('z', zsSelectorEngineSource.source); } catch (e) { if (!e.message.includes('has been already registered')) throw e; } }); it('query', async ({page}) => { await page.setContent(`
yo
ya
ye
`); expect(await page.$eval(`z="ya"`, e => e.outerHTML)).toBe('
ya
'); await page.setContent(`
`); expect(await page.$eval(`z=[foo="bar space"]`, e => e.outerHTML)).toBe('
'); await page.setContent(`
yo
`); expect(await page.$eval(`z=span`, e => e.outerHTML)).toBe(''); expect(await page.$eval(`z=div > span`, e => e.outerHTML)).toBe(''); expect(await page.$eval(`z=div span`, e => e.outerHTML)).toBe(''); expect(await page.$eval(`z="yo" > span`, e => e.outerHTML)).toBe(''); expect(await page.$eval(`z="yo" span`, e => e.outerHTML)).toBe(''); expect(await page.$eval(`z=span ^`, e => e.outerHTML)).toBe('
yo
'); expect(await page.$eval(`z=span ~ div`, e => e.outerHTML)).toBe('
yo
'); expect(await page.$eval(`z=span ~ "yo"`, e => e.outerHTML)).toBe('
yo
'); await page.setContent(`
yo
yo
`); expect(await page.$eval(`z="yo"#0`, e => e.outerHTML)).toBe('
yo
'); expect(await page.$eval(`z="yo"#1`, e => e.outerHTML)).toBe('
yo
'); expect(await page.$eval(`z="yo" ~ DIV#1`, e => e.outerHTML)).toBe('
yo
'); expect(await page.$eval(`z=span ~ div#1`, e => e.outerHTML)).toBe('
yo
'); expect(await page.$eval(`z=span ~ div#0`, e => e.outerHTML)).toBe('
yo
'); expect(await page.$eval(`z=span ~ "yo"#1 ^ > div`, e => e.outerHTML)).toBe('
yo
'); expect(await page.$eval(`z=span ~ "yo"#1 ^ > div#1`, e => e.outerHTML)).toBe('
yo
'); await page.setContent(`
yo
yo
`); expect(await page.$eval(`z="yo"`, e => e.outerHTML)).toBe('
yo
'); expect(await page.$$eval(`z="yo"`, es => es.map(e => e.outerHTML).join('\n'))).toBe('
yo
\n
yo
'); expect(await page.$$eval(`z="yo"#1`, es => es.map(e => e.outerHTML).join('\n'))).toBe('
yo
'); expect(await page.$$eval(`z="yo" ~ span`, es => es.map(e => e.outerHTML).join('\n'))).toBe('\n\n'); expect(await page.$$eval(`z="yo"#1 ~ span`, es => es.map(e => e.outerHTML).join('\n'))).toBe('\n'); expect(await page.$$eval(`z="yo" ~ span#0`, es => es.map(e => e.outerHTML).join('\n'))).toBe('\n'); expect(await page.$$eval(`z="yo" ~ span#1`, es => es.map(e => e.outerHTML).join('\n'))).toBe('\n'); }); it('create', async ({page}) => { await page.setContent(`
yo
ya
ya
`); expect(await playwright.selectors._createSelector('z', await page.$('div'))).toBe('"yo"'); expect(await playwright.selectors._createSelector('z', await page.$('div:nth-child(2)'))).toBe('"ya"'); expect(await playwright.selectors._createSelector('z', await page.$('div:nth-child(3)'))).toBe('"ya"#1'); await page.setContent(`foo bar`); expect(await playwright.selectors._createSelector('z', await page.$('img'))).toBe('img[alt="foo bar"]'); await page.setContent(`
yo
`); expect(await playwright.selectors._createSelector('z', await page.$('span'))).toBe('"yo"~SPAN'); expect(await playwright.selectors._createSelector('z', await page.$('span:nth-child(2)'))).toBe('SPAN#1'); }); it('children of various display parents', async ({page}) => { await page.setContent(`
yo
`); expect(await playwright.selectors._createSelector('z', await page.$('span'))).toBe('"yo"'); await page.setContent(`
yo
`); expect(await playwright.selectors._createSelector('z', await page.$('span'))).toBe('"yo"'); // "display: none" makes all children text invisible - fallback to tag name. await page.setContent(`
yo
`); expect(await playwright.selectors._createSelector('z', await page.$('span'))).toBe('SPAN'); }); it('boundary', async ({page}) => { await page.setContent(`
hey
hey
hey
yo
hello
hello
hello
unique
hey2
hello
hey
hello
ya
hello
hello
hello
hey2
hello
hey
hello
ya
hello
hello
hello
hey2
hello
hey
hello
`); expect(await playwright.selectors._createSelector('z', await page.$('#target'))).toBe('"ya"~"hey"~"hello"'); expect(await page.$eval(`z="ya"~"hey"~"hello"`, e => e.outerHTML)).toBe('
hello
'); expect(await page.$eval(`z="ya"~"hey"~"unique"`, e => e.outerHTML).catch(e => e.message)).toBe('Error: failed to find element matching selector "z="ya"~"hey"~"unique""'); expect(await page.$$eval(`z="ya" ~ "hey" ~ "hello"`, es => es.map(e => e.outerHTML).join('\n'))).toBe('
hello
\n
hello
'); }); it('should query existing element with zs selector', async({page, server}) => { await page.goto(server.PREFIX + '/playground.html'); await page.setContent('
A
'); const html = await page.$('z=html'); const second = await html.$('z=.second'); const inner = await second.$('z=.inner'); const content = await page.evaluate(e => e.textContent, inner); expect(content).toBe('A'); }); }); describe('text selector', () => { it('query', async ({page}) => { await page.setContent(`
yo
ya
\nye
`); expect(await page.$eval(`text=ya`, e => e.outerHTML)).toBe('
ya
'); expect(await page.$eval(`text="ya"`, e => e.outerHTML)).toBe('
ya
'); expect(await page.$eval(`text=/^[ay]+$/`, e => e.outerHTML)).toBe('
ya
'); expect(await page.$eval(`text=/Ya/i`, e => e.outerHTML)).toBe('
ya
'); expect(await page.$eval(`text=ye`, e => e.outerHTML)).toBe('
\nye
'); await page.setContent(`
ye
ye
`); expect(await page.$eval(`text="ye"`, e => e.outerHTML)).toBe('
ye
'); await page.setContent(`
yo
"ya
hello world!
`); expect(await page.$eval(`text="\\"ya"`, e => e.outerHTML)).toBe('
"ya
'); expect(await page.$eval(`text=/hello/`, e => e.outerHTML)).toBe('
hello world!
'); expect(await page.$eval(`text=/^\\s*heLLo/i`, e => e.outerHTML)).toBe('
hello world!
'); await page.setContent(`
yo
ya
hey
hey
`); expect(await page.$eval(`text=hey`, e => e.outerHTML)).toBe('
yo
ya
hey
hey
'); await page.setContent(`
yo
yo
`); expect(await page.$$eval(`text=yo`, es => es.map(e => e.outerHTML).join('\n'))).toBe('
yo
\n
yo
'); }); it('create', async ({page}) => { await page.setContent(`
yo
"ya
ye ye
`); expect(await playwright.selectors._createSelector('text', await page.$('div'))).toBe('yo'); expect(await playwright.selectors._createSelector('text', await page.$('div:nth-child(2)'))).toBe('"\\"ya"'); expect(await playwright.selectors._createSelector('text', await page.$('div:nth-child(3)'))).toBe('"ye ye"'); await page.setContent(`
yo
yo
ya
hey
`); expect(await playwright.selectors._createSelector('text', await page.$('div:nth-child(2)'))).toBe('hey'); await page.setContent(`
yo
ya
`); expect(await playwright.selectors._createSelector('text', await page.$('div'))).toBe('yo'); await page.setContent(`
"yo
ya
`); expect(await playwright.selectors._createSelector('text', await page.$('div'))).toBe('" \\"yo "'); }); it('should be case sensitive iff quotes are specified', async({page}) => { await page.setContent(`
yo
ya
\nye
`); expect(await page.$eval(`text=yA`, e => e.outerHTML)).toBe('
ya
'); expect(await page.$(`text="yA"`)).toBe(null); }); }); describe('selectors.register', () => { it('should work', async ({page}) => { const createTagSelector = () => ({ create(root, target) { return target.nodeName; }, query(root, selector) { return root.querySelector(selector); }, queryAll(root, selector) { return Array.from(root.querySelectorAll(selector)); } }); await playwright.selectors.register('tag', `(${createTagSelector.toString()})()`); await page.setContent('
'); expect(await playwright.selectors._createSelector('tag', await page.$('div'))).toBe('DIV'); expect(await page.$eval('tag=DIV', e => e.nodeName)).toBe('DIV'); expect(await page.$eval('tag=SPAN', e => e.nodeName)).toBe('SPAN'); expect(await page.$$eval('tag=DIV', es => es.length)).toBe(2); }); it('should work with path', async ({page}) => { await playwright.selectors.register('foo', { path: path.join(__dirname, 'assets/sectionselectorengine.js') }); await page.setContent('
'); expect(await page.$eval('foo=whatever', e => e.nodeName)).toBe('SECTION'); }); it('should work in main and isolated world', async ({page}) => { const createDummySelector = () => ({ create(root, target) { }, query(root, selector) { return window.__answer; }, queryAll(root, selector) { return [document.body, document.documentElement, window.__answer]; } }); await playwright.selectors.register('main', createDummySelector); await playwright.selectors.register('isolated', createDummySelector, { contentScript: true }); await page.setContent('
'); await page.evaluate(() => window.__answer = document.querySelector('span')); // Works in main if asked. expect(await page.$eval('main=ignored', e => e.nodeName)).toBe('SPAN'); expect(await page.$eval('css=div >> main=ignored', e => e.nodeName)).toBe('SPAN'); expect(await page.$$eval('main=ignored', es => window.__answer !== undefined)).toBe(true); expect(await page.$$eval('main=ignored', es => es.filter(e => e).length)).toBe(3); // Works in isolated by default. expect(await page.$('isolated=ignored')).toBe(null); expect(await page.$('css=div >> isolated=ignored')).toBe(null); // $$eval always works in main, to avoid adopting nodes one by one. expect(await page.$$eval('isolated=ignored', es => window.__answer !== undefined)).toBe(true); expect(await page.$$eval('isolated=ignored', es => es.filter(e => e).length)).toBe(3); // At least one engine in main forces all to be in main. expect(await page.$eval('main=ignored >> isolated=ignored', e => e.nodeName)).toBe('SPAN'); expect(await page.$eval('isolated=ignored >> main=ignored', e => e.nodeName)).toBe('SPAN'); // Can be chained to css. expect(await page.$eval('main=ignored >> css=section', e => e.nodeName)).toBe('SECTION'); }); it('should update', async ({page}) => { await page.setContent('
'); expect(await page.$eval('div', e => e.nodeName)).toBe('DIV'); let error = await page.$('dummy=ignored').catch(e => e); expect(error.message).toContain('Unknown engine dummy while parsing selector dummy=ignored'); const createDummySelector = () => ({ create(root, target) { return target.nodeName; }, query(root, selector) { return root.querySelector('dummy'); }, queryAll(root, selector) { return Array.from(root.querySelectorAll('dummy')); } }); error = await playwright.selectors.register('$', createDummySelector).catch(e => e); expect(error.message).toBe('Selector engine name may only contain [a-zA-Z0-9_] characters'); await playwright.selectors.register('dummy', createDummySelector); expect(await page.$eval('dummy=ignored', e => e.id)).toBe('d1'); expect(await page.$eval('css=span >> dummy=ignored', e => e.id)).toBe('d2'); error = await playwright.selectors.register('dummy', createDummySelector).catch(e => e); expect(error.message).toBe('"dummy" selector engine has been already registered'); error = await playwright.selectors.register('css', createDummySelector).catch(e => e); expect(error.message).toBe('"css" is a predefined selector engine'); }); }); };