Android

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

Требования

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

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

• Неподдерживается прямое взаимодействие по 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(wsEndpoint);
await android.connect(wsEndpoint, options);

Аргументы

• wsEndpoint строка

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

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

  • headers объект<строка, строка> (необязательно)

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

  • slowMo число (необязательно)

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

  • timeout число (необязательно)

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

Возвращает

• Promise<AndroidDevice>

devices​

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

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

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

Аргументы

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

  • host строка (необязательно)

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

  • omitDriverInstall логическое значение (необязательно)

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

  • port число (необязательно)

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

Возвращает

• Promise<массив<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 объект (необязательно)

  • adbHost строка (необязательно)

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

  • adbPort число (необязательно)

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

  • deviceSerialNumber строка (необязательно)

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

  • host строка (необязательно)

    Хост для использования в WebSocket. Необязательно, если опущено, сервер будет принимать подключения к неявному IPv6-адресу (::), если IPv6 доступен, или неявному IPv4-адресу (0.0.0.0) в противном случае. Рассмотрите возможность защиты, указав конкретный интерфейс.

  • omitDriverInstall логическое значение (необязательно)

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

  • port число (необязательно)

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

  • wsPath строка (необязательно)

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

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

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

Возвращает

• Promise<BrowserServer>

setDefaultTimeout​

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

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

android.setDefaultTimeout(timeout);

Аргументы

• timeout число

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