mirror of
				https://github.com/microsoft/playwright.git
				synced 2025-06-26 21:40:17 +00:00 
			
		
		
		
	 356fc35b85
			
		
	
	
		356fc35b85
		
			
		
	
	
	
	
		
			
			- This supports `role=button[name=Hello]` similarly to CSS selectors. - Does not change `_react` or `_vue` behavior that insist on quoting the string. - Uses CSS notion of "identifier" characters.
		
			
				
	
	
		
			325 lines
		
	
	
		
			13 KiB
		
	
	
	
		
			TypeScript
		
	
	
	
	
	
			
		
		
	
	
			325 lines
		
	
	
		
			13 KiB
		
	
	
	
		
			TypeScript
		
	
	
	
	
	
| /**
 | |
|  * 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.
 | |
|  */
 | |
| 
 | |
| import { test, expect } from './pageTest';
 | |
| 
 | |
| test.skip(({ mode }) => mode !== 'default', 'Experimental features only work in default mode');
 | |
| 
 | |
| test('should detect roles', async ({ page }) => {
 | |
|   await page.setContent(`
 | |
|     <button>Hello</button>
 | |
|     <select multiple="" size="2"></select>
 | |
|     <select></select>
 | |
|     <h3>Heading</h3>
 | |
|     <details><summary>Hello</summary></details>
 | |
|     <div role="dialog">I am a dialog</div>
 | |
|   `);
 | |
|   expect(await page.$$eval(`role=button`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<button>Hello</button>`,
 | |
|   ]);
 | |
|   expect(await page.$$eval(`role=listbox`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<select multiple="" size="2"></select>`,
 | |
|   ]);
 | |
|   expect(await page.$$eval(`role=combobox`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<select></select>`,
 | |
|   ]);
 | |
|   expect(await page.$$eval(`role=heading`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<h3>Heading</h3>`,
 | |
|   ]);
 | |
|   expect(await page.$$eval(`role=group`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<details><summary>Hello</summary></details>`,
 | |
|   ]);
 | |
|   expect(await page.$$eval(`role=dialog`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<div role="dialog">I am a dialog</div>`,
 | |
|   ]);
 | |
|   expect(await page.$$eval(`role=menuitem`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|   ]);
 | |
| });
 | |
| 
 | |
| test('should support selected', async ({ page }) => {
 | |
|   await page.setContent(`
 | |
|     <select>
 | |
|       <option>Hi</option>
 | |
|       <option selected>Hello</option>
 | |
|     </select>
 | |
|     <div>
 | |
|       <div role="option" aria-selected="true">Hi</div>
 | |
|       <div role="option" aria-selected="false">Hello</div>
 | |
|     </div>
 | |
|   `);
 | |
|   expect(await page.$$eval(`role=option[selected]`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<option selected="">Hello</option>`,
 | |
|     `<div role="option" aria-selected="true">Hi</div>`,
 | |
|   ]);
 | |
|   expect(await page.$$eval(`role=option[selected=true]`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<option selected="">Hello</option>`,
 | |
|     `<div role="option" aria-selected="true">Hi</div>`,
 | |
|   ]);
 | |
|   expect(await page.$$eval(`role=option[selected=false]`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<option>Hi</option>`,
 | |
|     `<div role="option" aria-selected="false">Hello</div>`,
 | |
|   ]);
 | |
| });
 | |
| 
 | |
| test('should support checked', async ({ page }) => {
 | |
|   await page.setContent(`
 | |
|     <input type=checkbox>
 | |
|     <input type=checkbox checked>
 | |
|     <input type=checkbox indeterminate>
 | |
|     <div role=checkbox aria-checked="true">Hi</div>
 | |
|     <div role=checkbox aria-checked="false">Hello</div>
 | |
|     <div role=checkbox>Unknown</div>
 | |
|   `);
 | |
|   await page.$eval('[indeterminate]', input => (input as HTMLInputElement).indeterminate = true);
 | |
|   expect(await page.$$eval(`role=checkbox[checked]`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<input type="checkbox" checked="">`,
 | |
|     `<div role="checkbox" aria-checked="true">Hi</div>`,
 | |
|   ]);
 | |
|   expect(await page.$$eval(`role=checkbox[checked=true]`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<input type="checkbox" checked="">`,
 | |
|     `<div role="checkbox" aria-checked="true">Hi</div>`,
 | |
|   ]);
 | |
|   expect(await page.$$eval(`role=checkbox[checked=false]`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<input type="checkbox">`,
 | |
|     `<div role="checkbox" aria-checked="false">Hello</div>`,
 | |
|     `<div role="checkbox">Unknown</div>`,
 | |
|   ]);
 | |
|   expect(await page.$$eval(`role=checkbox[checked="mixed"]`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<input type="checkbox" indeterminate="">`,
 | |
|   ]);
 | |
|   expect(await page.$$eval(`role=checkbox`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<input type="checkbox">`,
 | |
|     `<input type="checkbox" checked="">`,
 | |
|     `<input type="checkbox" indeterminate="">`,
 | |
|     `<div role="checkbox" aria-checked="true">Hi</div>`,
 | |
|     `<div role="checkbox" aria-checked="false">Hello</div>`,
 | |
|     `<div role="checkbox">Unknown</div>`,
 | |
|   ]);
 | |
| });
 | |
| 
 | |
| test('should support pressed', async ({ page }) => {
 | |
|   await page.setContent(`
 | |
|     <button>Hi</button>
 | |
|     <button aria-pressed="true">Hello</button>
 | |
|     <button aria-pressed="false">Bye</button>
 | |
|     <button aria-pressed="mixed">Mixed</button>
 | |
|   `);
 | |
|   expect(await page.$$eval(`role=button[pressed]`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<button aria-pressed="true">Hello</button>`,
 | |
|   ]);
 | |
|   expect(await page.$$eval(`role=button[pressed=true]`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<button aria-pressed="true">Hello</button>`,
 | |
|   ]);
 | |
|   expect(await page.$$eval(`role=button[pressed=false]`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<button>Hi</button>`,
 | |
|     `<button aria-pressed="false">Bye</button>`,
 | |
|   ]);
 | |
|   expect(await page.$$eval(`role=button[pressed="mixed"]`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<button aria-pressed="mixed">Mixed</button>`,
 | |
|   ]);
 | |
|   expect(await page.$$eval(`role=button`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<button>Hi</button>`,
 | |
|     `<button aria-pressed="true">Hello</button>`,
 | |
|     `<button aria-pressed="false">Bye</button>`,
 | |
|     `<button aria-pressed="mixed">Mixed</button>`,
 | |
|   ]);
 | |
| });
 | |
| 
 | |
| test('should support expanded', async ({ page }) => {
 | |
|   await page.setContent(`
 | |
|     <button>Hi</button>
 | |
|     <button aria-expanded="true">Hello</button>
 | |
|     <button aria-expanded="false">Bye</button>
 | |
|   `);
 | |
|   expect(await page.$$eval(`role=button[expanded]`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<button aria-expanded="true">Hello</button>`,
 | |
|   ]);
 | |
|   expect(await page.$$eval(`role=button[expanded=true]`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<button aria-expanded="true">Hello</button>`,
 | |
|   ]);
 | |
|   expect(await page.$$eval(`role=button[expanded=false]`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<button>Hi</button>`,
 | |
|     `<button aria-expanded="false">Bye</button>`,
 | |
|   ]);
 | |
| });
 | |
| 
 | |
| test('should support disabled', async ({ page }) => {
 | |
|   await page.setContent(`
 | |
|     <button>Hi</button>
 | |
|     <button disabled>Bye</button>
 | |
|     <button aria-disabled="true">Hello</button>
 | |
|     <button aria-disabled="false">Oh</button>
 | |
|     <fieldset disabled>
 | |
|       <button>Yay</button>
 | |
|     </fieldset>
 | |
|   `);
 | |
|   expect(await page.$$eval(`role=button[disabled]`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<button disabled="">Bye</button>`,
 | |
|     `<button aria-disabled="true">Hello</button>`,
 | |
|     `<button>Yay</button>`,
 | |
|   ]);
 | |
|   expect(await page.$$eval(`role=button[disabled=true]`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<button disabled="">Bye</button>`,
 | |
|     `<button aria-disabled="true">Hello</button>`,
 | |
|     `<button>Yay</button>`,
 | |
|   ]);
 | |
|   expect(await page.$$eval(`role=button[disabled=false]`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<button>Hi</button>`,
 | |
|     `<button aria-disabled="false">Oh</button>`,
 | |
|   ]);
 | |
| });
 | |
| 
 | |
| test('should support level', async ({ page }) => {
 | |
|   await page.setContent(`
 | |
|     <h1>Hello</h1>
 | |
|     <h3>Hi</h3>
 | |
|     <div role="heading" aria-level="5">Bye</div>
 | |
|   `);
 | |
|   expect(await page.$$eval(`role=heading[level=1]`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<h1>Hello</h1>`,
 | |
|   ]);
 | |
|   expect(await page.$$eval(`role=heading[level=3]`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<h3>Hi</h3>`,
 | |
|   ]);
 | |
|   expect(await page.$$eval(`role=heading[level=5]`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<div role="heading" aria-level="5">Bye</div>`,
 | |
|   ]);
 | |
| });
 | |
| 
 | |
| test('should filter hidden, unless explicitly asked for', async ({ page }) => {
 | |
|   await page.setContent(`
 | |
|     <button>Hi</button>
 | |
|     <button hidden>Hello</button>
 | |
|     <button aria-hidden="true">Yay</button>
 | |
|     <button aria-hidden="false">Nay</button>
 | |
|     <button style="visibility:hidden">Bye</button>
 | |
|     <div style="visibility:hidden">
 | |
|       <button>Oh</button>
 | |
|     </div>
 | |
|     <div style="visibility:hidden">
 | |
|       <button style="visibility:visible">Still here</button>
 | |
|     </div>
 | |
|     <button style="display:none">Never</button>
 | |
|     <div id=host1></div>
 | |
|     <div id=host2 style="display:none"></div>
 | |
|     <script>
 | |
|       function addButton(host, text) {
 | |
|         const root = host.attachShadow({ mode: 'open' });
 | |
|         const button = document.createElement('button');
 | |
|         button.textContent = text;
 | |
|         root.appendChild(button);
 | |
|       }
 | |
|       addButton(document.getElementById('host1'), 'Shadow1');
 | |
|       addButton(document.getElementById('host2'), 'Shadow2');
 | |
|     </script>
 | |
|   `);
 | |
|   expect(await page.$$eval(`role=button`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<button>Hi</button>`,
 | |
|     `<button aria-hidden="false">Nay</button>`,
 | |
|     `<button style="visibility:visible">Still here</button>`,
 | |
|     `<button>Shadow1</button>`,
 | |
|   ]);
 | |
|   expect(await page.$$eval(`role=button[include-hidden]`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<button>Hi</button>`,
 | |
|     `<button hidden="">Hello</button>`,
 | |
|     `<button aria-hidden="true">Yay</button>`,
 | |
|     `<button aria-hidden="false">Nay</button>`,
 | |
|     `<button style="visibility:hidden">Bye</button>`,
 | |
|     `<button>Oh</button>`,
 | |
|     `<button style="visibility:visible">Still here</button>`,
 | |
|     `<button style="display:none">Never</button>`,
 | |
|     `<button>Shadow1</button>`,
 | |
|     `<button>Shadow2</button>`,
 | |
|   ]);
 | |
|   expect(await page.$$eval(`role=button[include-hidden=true]`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<button>Hi</button>`,
 | |
|     `<button hidden="">Hello</button>`,
 | |
|     `<button aria-hidden="true">Yay</button>`,
 | |
|     `<button aria-hidden="false">Nay</button>`,
 | |
|     `<button style="visibility:hidden">Bye</button>`,
 | |
|     `<button>Oh</button>`,
 | |
|     `<button style="visibility:visible">Still here</button>`,
 | |
|     `<button style="display:none">Never</button>`,
 | |
|     `<button>Shadow1</button>`,
 | |
|     `<button>Shadow2</button>`,
 | |
|   ]);
 | |
|   expect(await page.$$eval(`role=button[include-hidden=false]`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<button>Hi</button>`,
 | |
|     `<button aria-hidden="false">Nay</button>`,
 | |
|     `<button style="visibility:visible">Still here</button>`,
 | |
|     `<button>Shadow1</button>`,
 | |
|   ]);
 | |
| });
 | |
| 
 | |
| test('should support name', async ({ page }) => {
 | |
|   await page.setContent(`
 | |
|     <div role="button" aria-label="Hello"></div>
 | |
|     <div role="button" aria-label="Hallo"></div>
 | |
|     <div role="button" aria-label="Hello" aria-hidden="true"></div>
 | |
|     <div role="button" aria-label="123" aria-hidden="true"></div>
 | |
|   `);
 | |
|   expect(await page.$$eval(`role=button[name="Hello"]`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<div role="button" aria-label="Hello"></div>`,
 | |
|   ]);
 | |
|   expect(await page.$$eval(`role=button[name*="all"]`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<div role="button" aria-label="Hallo"></div>`,
 | |
|   ]);
 | |
|   expect(await page.$$eval(`role=button[name=/^H[ae]llo$/]`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<div role="button" aria-label="Hello"></div>`,
 | |
|     `<div role="button" aria-label="Hallo"></div>`,
 | |
|   ]);
 | |
|   expect(await page.$$eval(`role=button[name=/h.*o/i]`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<div role="button" aria-label="Hello"></div>`,
 | |
|     `<div role="button" aria-label="Hallo"></div>`,
 | |
|   ]);
 | |
|   expect(await page.$$eval(`role=button[name="Hello"][include-hidden]`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<div role="button" aria-label="Hello"></div>`,
 | |
|     `<div role="button" aria-label="Hello" aria-hidden="true"></div>`,
 | |
|   ]);
 | |
|   expect(await page.$$eval(`role=button[name=Hello]`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<div role="button" aria-label="Hello"></div>`,
 | |
|   ]);
 | |
|   expect(await page.$$eval(`role=button[name=123][include-hidden]`, els => els.map(e => e.outerHTML))).toEqual([
 | |
|     `<div role="button" aria-label="123" aria-hidden="true"></div>`,
 | |
|   ]);
 | |
| });
 | |
| 
 | |
| test('errors', async ({ page }) => {
 | |
|   const e0 = await page.$('role=[bar]').catch(e => e);
 | |
|   expect(e0.message).toContain(`Role must not be empty`);
 | |
| 
 | |
|   const e1 = await page.$('role=foo[sElected]').catch(e => e);
 | |
|   expect(e1.message).toContain(`Unknown attribute "sElected", must be one of "checked", "disabled", "expanded", "include-hidden", "level", "name", "pressed", "selected"`);
 | |
| 
 | |
|   const e2 = await page.$('role=foo[bar . qux=true]').catch(e => e);
 | |
|   expect(e2.message).toContain(`Unknown attribute "bar.qux"`);
 | |
| 
 | |
|   const e3 = await page.$('role=heading[level="bar"]').catch(e => e);
 | |
|   expect(e3.message).toContain(`"level" attribute must be compared to a number`);
 | |
| 
 | |
|   const e4 = await page.$('role=checkbox[checked="bar"]').catch(e => e);
 | |
|   expect(e4.message).toContain(`"checked" must be one of true, false, "mixed"`);
 | |
| 
 | |
|   const e5 = await page.$('role=checkbox[checked~=true]').catch(e => e);
 | |
|   expect(e5.message).toContain(`cannot use ~= in attribute with non-string matching value`);
 | |
| 
 | |
|   const e6 = await page.$('role=button[level=3]').catch(e => e);
 | |
|   expect(e6.message).toContain(`"level" attribute is only supported for roles: "heading", "listitem", "row", "treeitem"`);
 | |
| 
 | |
|   const e7 = await page.$('role=button[name]').catch(e => e);
 | |
|   expect(e7.message).toContain(`"name" attribute must have a value`);
 | |
| });
 |