从 Protractor 迁移

迁移原则

• 无需 "webdriver-manager" / Selenium。
• Protractor 的 ElementFinder ⇄ Playwright Test Locator
• Protractor 的 waitForAngular ⇄ Playwright Test 自动等待
• 不要忘记在 Playwright Test 中使用 await

速查表

Protractor	Playwright Test
element(by.buttonText('...'))	page.locator('button, input[type="button"], input[type="submit"] >> text="..."')
element(by.css('...'))	page.locator('...')
element(by.cssContainingText('..1..', '..2..'))	page.locator('..1.. >> text=..2..')
element(by.id('...'))	page.locator('#...')
element(by.model('...'))	page.locator('[ng-model="..."]')
element(by.repeater('...'))	page.locator('[ng-repeat="..."]')
element(by.xpath('...'))	page.locator('xpath=...')
element.all	page.locator
browser.get(url)	await page.goto(url)
browser.getCurrentUrl()	page.url()

示例

Protractor

describe('angularjs homepage todo list', function() {
  it('should add a todo', function() {
    browser.get('https://angularjs.org');

    element(by.model('todoList.todoText')).sendKeys('first test');
    element(by.css('[value="add"]')).click();

    const todoList = element.all(by.repeater('todo in todoList.todos'));
    expect(todoList.count()).toEqual(3);
    expect(todoList.get(2).getText()).toEqual('first test');

    // You wrote your first test, cross it off the list
    todoList.get(2).element(by.css('input')).click();
    const completedAmount = element.all(by.css('.done-true'));
    expect(completedAmount.count()).toEqual(2);
  });
});

逐行迁移到 Playwright Test

const { test, expect } = require('@playwright/test'); // 1

test.describe('angularjs homepage todo list', () => {
  test('should add a todo', async ({ page }) => { // 2, 3
    await page.goto('https://angularjs.org'); // 4

    await page.locator('[ng-model="todoList.todoText"]').fill('first test');
    await page.locator('[value="add"]').click();

    const todoList = page.locator('[ng-repeat="todo in todoList.todos"]'); // 5
    await expect(todoList).toHaveCount(3);
    await expect(todoList.nth(2)).toHaveText('first test', {
      useInnerText: true,
    });

    // You wrote your first test, cross it off the list
    await todoList.nth(2).getByRole('textbox').click();
    const completedAmount = page.locator('.done-true');
    await expect(completedAmount).toHaveCount(2);
  });
});

迁移要点 (请参阅 Playwright Test 代码片段中的内联注释)

1. 每个 Playwright Test 文件都显式导入了 test 和 expect 函数
2. 测试函数用 async 标记
3. Playwright Test 将 page 作为其参数之一。这是 Playwright Test 中众多 有用的 fixtures 之一。
4. 几乎所有 Playwright 调用都以前缀 await 开头
5. 使用 page.locator() 创建 Locator 是少数同步方法之一。

waitForAngular 的 Polyfill

Playwright Test 内置了 自动等待 功能，这使得 protractor 的 waitForAngular 在一般情况下不再需要。

但是，在某些极端情况下可能会派上用场。以下是如何在 Playwright Test 中对 waitForAngular 函数进行 polyfill

1. 确保你的 package.json 中安装了 protractor

2. Polyfill 函数

   async function waitForAngular(page) {
     const clientSideScripts = require('protractor/built/clientsidescripts.js');
   
     async function executeScriptAsync(page, script, ...scriptArgs) {
       await page.evaluate(`
         new Promise((resolve, reject) => {
           const callback = (errMessage) => {
             if (errMessage)
               reject(new Error(errMessage));
             else
               resolve();
           };
           (function() {${script}}).apply(null, [...${JSON.stringify(scriptArgs)}, callback]);
         })
       `);
     }
   
     await executeScriptAsync(page, clientSideScripts.waitForAngular, '');
   }

   如果你不想保留 protractor 的版本，也可以使用这种更简单的方法 (仅适用于 Angular 2+)

   async function waitForAngular(page) {
     await page.evaluate(async () => {
       // @ts-expect-error
       if (window.getAllAngularTestabilities) {
         // @ts-expect-error
         await Promise.all(window.getAllAngularTestabilities().map(whenStable));
         // @ts-expect-error
         async function whenStable(testability) {
           return new Promise(res => testability.whenStable(res));
         }
       }
     });
   }

3. Polyfill 使用

   const page = await context.newPage();
   await page.goto('https://example.org');
   await waitForAngular(page);

Playwright Test 强大功能

一旦你使用了 Playwright Test，你就能获得很多好处！

• 全面的零配置 TypeScript 支持
• 在 所有 Web 引擎 (Chrome, Firefox, Safari) 和 任何流行的操作系统 (Windows, macOS, Ubuntu) 上运行测试
• 全面支持多个源、(i)frames、标签页和上下文
• 在多个浏览器中并行运行测试
• 内置的测试 产物收集

你还将获得所有这些 ✨ 出色的工具 ✨，它们与 Playwright Test 捆绑在一起

• Playwright Inspector
• Playwright Test 代码生成
• 用于事后调试的 Playwright Tracing

延伸阅读

了解有关 Playwright Test 运行器的更多信息

• 入门
• Fixtures
• 定位符
• 断言
• 自动等待