@wtto00/karma-android-launcher v1.0.0

karma-android-launcher

English | 简体中文

Launch System WebView on Android Emulator and Android Device. A Karma plugin.

Install

pnpm add @wtto00/karma-android-launcher -D
# yarn add @wtto00/karma-android-launcher -D
# npm i @wtto00/karma-android-launcher -D

Usage

karma.config.js

// use android emulator
module.exports = function (config) {
  config.set({
    // ...
    hostname: "10.0.2.2", // emulator can use a fixed IP: 10.0.2.2.
    browsers: ["AndroidEmulator"],
    captureTimeout: 1200000,
    browserDisconnectTimeout: 60000,
    browserNoActivityTimeout: 300000,
    plugins: [
      // ...
      require("@wtto00/karma-android-launcher"),
    ],
  });
};

// use connected device
const ip = require("ip");
module.exports = function (config) {
  config.set({
    // ...
    hostname: ip.address(), // The connected device needs to use a local network IP address.
    browsers: ["AndroidDevice"],
    captureTimeout: 1200000,
    browserDisconnectTimeout: 60000,
    browserNoActivityTimeout: 300000,
    plugins: [
      // ...
      require("@wtto00/karma-android-launcher"),
    ],
  });
};

You can also customize the Android version to use, but it is best to install the image in advance because the installation process is very time-consuming and may result in test timeouts and failure.

// Custom Android version emulator
const customLaunchers = {
  // Minimum support for Android 5.0.
  android_emulator_5: {
    base: "AndroidEmulator", // Here define the use of an Android emulator.
    avdName: "android_emulator_21", // The name of this custom emulator
    apiLevel: 21, // Define Android SDK version here.
    // ... More parameters can be found in the description below.
  },
};
module.exports = function (config) {
  config.set({
    // ...
    hostname: "10.0.2.2", // emulator can use a fixed IP: 10.0.2.2.
    browsers: ["android_emulator_5"],
    customLaunchers,
    captureTimeout: 1200000,
    browserDisconnectTimeout: 60000,
    browserNoActivityTimeout: 300000,
    plugins: [
      // ...
      require("@wtto00/karma-android-launcher"),
    ],
  });
};

Parameters for customize emulator

Parameters for starting the emulator

Usage for Github Action

You can refer to the configuration file of this project test.yml.

The browser name used in matrix.config.targetBrowser needs to be defined in your own karma configuration before it can be used.

Then you can use process.env[TARGET_BROWSER] in karma to get the currently used browser.

Notes

1. The version of WebView in the Android system.
   • Android 5.0 Lollipop (WebView version 44)
   • Android 5.1 Lollipop (WebView version 45)
   • Android 6.0 Marshmallow (WebView version 46)
   • Android 7.0 Nougat (WebView version 51)
   • Android 7.1 Nougat (WebView version 52)
   • Android 8.0 Oreo (WebView version 60)
   • Android 8.1 Oreo (WebView version 61)
   • Android 9.0 Pie (WebView version 67)
   • Android 10 (WebView version 69)
   • Android 11 (WebView version 85)