Android

Playwright поддерживает экспериментальную автоматизацию Android. Она включает Chrome для Android и Android WebView.

Требования

• Устройство Android или эмулятор AVD.
• Демон ADB должен быть запущен и авторизован для работы с устройством. Обычно достаточно выполнить adb devices.
• Chrome 87 или более новая версия должна быть установлена на устройстве
• В chrome://flags должна быть включена настройка «Разрешить командную строку на устройствах без root-доступа».

Известные ограничения

• Прямая работа через USB пока не поддерживается, поэтому необходим ADB.
• Для создания снимков экрана устройство должно быть включено. Включите режим разработчика «Не выключать экран».
• Мы не запускали все тесты на устройстве, поэтому не всё работает.

Как запустить

Пример сценария автоматизации Android:

const { _android: android } = require('playwright');

(async () => {
  // Connect to the device.
  const [device] = await android.devices();
  console.log(`Model: ${device.model()}`);
  console.log(`Serial: ${device.serial()}`);
  // Take screenshot of the whole device.
  await device.screenshot({ path: 'device.png' });

  {
    // --------------------- WebView -----------------------

    // Launch an application with WebView.
    await device.shell('am force-stop org.chromium.webview_shell');
    await device.shell('am start org.chromium.webview_shell/.WebViewBrowserActivity');
    // Get the WebView.
    const webview = await device.webView({ pkg: 'org.chromium.webview_shell' });

    // Fill the input box.
    await device.fill({
      res: 'org.chromium.webview_shell:id/url_field',
    }, 'github.com/microsoft/playwright');
    await device.press({
      res: 'org.chromium.webview_shell:id/url_field',
    }, 'Enter');

    // Work with WebView's page as usual.
    const page = await webview.page();
    await page.waitForNavigation({ url: /.*microsoft\/playwright.*/ });
    console.log(await page.title());
  }

  {
    // --------------------- Browser -----------------------

    // Launch Chrome browser.
    await device.shell('am force-stop com.android.chrome');
    const context = await device.launchBrowser();

    // Use BrowserContext as usual.
    const page = await context.newPage();
    await page.goto('https://webkit.org/');
    console.log(await page.evaluate(() => window.location.href));
    await page.screenshot({ path: 'page.png' });

    await context.close();
  }

  // Close the device.
  await device.close();
})();

Методы​

connect​

Этот метод подключает Playwright к существующему устройству Android. Используйте android.launchServer(), чтобы запустить новый экземпляр сервера Android.

Использование

await android.connect(endpoint);
await android.connect(endpoint, options);

Аргументы

• endpoint string

  Адрес конечной точки WebSocket браузера для подключения.

• options Object (необязательно)

  • headers Object<string, string> (необязательно)

    Дополнительные HTTP-заголовки, отправляемые вместе с запросом на установление WebSocket-соединения. Необязательно.

  • slowMo number (необязательно)

    Замедляет выполнение операций Playwright на указанное количество миллисекунд. Полезно, чтобы видеть происходящее. По умолчанию 0.

  • timeout number (необязательно)

    Максимальное время ожидания установки соединения в миллисекундах. По умолчанию 30000 (30 секунд). Передайте 0, чтобы отключить тайм-аут.

Возвращает

• Promise<AndroidDevice>

devices​

Возвращает список обнаруженных устройств Android.

Использование

await android.devices();
await android.devices(options);

Аргументы

• options Object (необязательно)

  • host string (необязательно)

    Необязательный хост для подключения к серверу ADB. По умолчанию 127.0.0.1.

  • omitDriverInstall boolean (необязательно)

    Предотвращает автоматическую установку драйвера Playwright при подключении. Предполагается, что драйверы уже установлены.

  • port number (необязательно)

    Необязательный порт для подключения к серверу ADB. По умолчанию 5037.

Возвращает

• Promise<Array<AndroidDevice>>

launchServer​

Запускает сервер Playwright для Android, к которому могут подключаться клиенты. См. следующий пример:

Использование

На стороне сервера:

const { _android } = require('playwright');

(async () => {
  const browserServer = await _android.launchServer({
    // If you have multiple devices connected and want to use a specific one.
    // deviceSerialNumber: '<deviceSerialNumber>',
  });
  const wsEndpoint = browserServer.wsEndpoint();
  console.log(wsEndpoint);
})();

На стороне клиента:

const { _android } = require('playwright');

(async () => {
  const device = await _android.connect('<wsEndpoint>');

  console.log(device.model());
  console.log(device.serial());
  await device.shell('am force-stop com.android.chrome');
  const context = await device.launchBrowser();

  const page = await context.newPage();
  await page.goto('https://webkit.org/');
  console.log(await page.evaluate(() => window.location.href));
  await page.screenshot({ path: 'page-chrome-1.png' });

  await context.close();
})();

Аргументы

• options Object (необязательно)

  • adbHost string (необязательно)

    Необязательный хост для подключения к серверу ADB. По умолчанию 127.0.0.1.

  • adbPort number (необязательно)

    Необязательный порт для подключения к серверу ADB. По умолчанию 5037.

  • deviceSerialNumber string (необязательно)

    Необязательный серийный номер устройства, на котором нужно запустить браузер. Если не указан, при подключении нескольких устройств будет выброшено исключение.

  • host string (необязательно)

    Хост для WebSocket. Необязательный параметр; по умолчанию используется localhost, что позволяет принимать соединения только через интерфейс обратной петли. Укажите явный адрес (например, 0.0.0.0), чтобы принимать соединения из сети. Учтите, что в этом случае RPC устройства станет доступен всем, кто может подключиться к прослушиваемому порту.

  • omitDriverInstall boolean (необязательно)

    Предотвращает автоматическую установку драйвера Playwright при подключении. Предполагается, что драйверы уже установлены.

  • port number (необязательно)

    Порт для WebSocket. По умолчанию 0 — будет выбран любой доступный порт.

  • wsPath string (необязательно)

    Путь, по которому будет доступен сервер Android. В целях безопасности по умолчанию используется непредсказуемая строка.

    предупреждение

    Любой процесс или веб-страница (в том числе запущенные в Playwright), которым известен wsPath, могут получить контроль над пользователем ОС. Поэтому при использовании этого параметра следует указывать непредсказуемый токен.

Возвращает

• Promise<BrowserServer>

setDefaultTimeout​

Этот параметр изменяет максимальное время ожидания по умолчанию для всех методов, принимающих параметр timeout.

Использование

android.setDefaultTimeout(timeout);

Аргументы

• timeout number

  Максимальное время в миллисекундах