Android WebView CTS Test Configuration

Test apk(s) and tests to run on Android are configurable on a per Android release basis by editing webview_cts_gcs_path.json.

File format

{
  {
    "<Android dessert letter>": {
      "arch": {
        "<arch1>": {
          "filename": "<relative path to cts_archive_dir of cts zip>",
          "_origin": "<CTS zip download url>",
          "unzip_dir": "<relative path to work directory where cts should be unzipped to>"
        },
        "<arch2>": {
          "filename": "<relative path to cts_archive_dir of cts zip>",
          "_origin": "<CTS zip download url>",
          "unzip_dir": "<relative path to work directory where cts should be unzipped to>"
        }
      },
      "test_runs": [
        {
          "apk": "location of the test apk in the cts zip file",
          "additional_apks": [
            // optional list of additional apks that need to be installed
            // for the test to run
            {
              "apk": "location of the additional apk in the cts zip file",
            },
            {
              "apk": "location of the additional apk in the cts zip file",
              // An optional boolean flag to indicate if the APK should
              // be queryable by other APKs
              // Only usable from Android 11+
              "forced_queryable": true
            },
            {
              "apk": "location of the additional apk in the cts zip file",
              // An optional boolean flag to indicate an additional APK should always
              // be installed in full mode, even when the tests are being run in
              // instant mode
              // This flag is only available for additional APKs
              "force_full_mode": true
            }
          ]
        },
        {
          "apk": "location of the test apk in the cts zip file",
          "voice_service": "<An optional override to use a custom voice service, eg: android.assist.service/.MainInteractionService - used by CTS assistant tests>"
        },
        {
          "apk": "location of the test apk in the cts zip file",
          "setup_commands": [
            "<custom shell command to be run on the device (don't include 'adb shell') as a setup step>"
          ],
          "teardown_commands": [
            "<custom shell command to be run on the device (don't include 'adb shell') as a teardown step>"
          ]
        },
        {
          "apk": "location of the test apk in the cts zip file",
          "excludes": [
            {
              "match": "<class#testcase (wildcard supported) expression of test to skip>",
              "arch": "<the architecture to skip for, optional, eg: x86 - if not provided, will match all architectures>",
              "mode": "<the app mode to skip for, optional - either 'instant' or 'full' - if not provided, will run in all modes>",
              "_bug_id": "<bug reference comment, optional>"
            }
          ]
        },
        {
          "apk": "location of the test apk in the cts zip file",
          "includes": [
            {
              "match": "<class#testcase (wildcard supported) expression of test to run>",
              "arch": "<the architecture to include for, optional, eg: arm64 - if not provided, will match all architectures>",
              "mode": "<the app mode to include for, optional - either 'instant' or 'full' - if not provided, will run in all modes>"
            }
          ]
        }
      ]
    }
  },
  ...
}

Disabling/Skipping tests

CTS regressions are more serious than most test failures. CTS failures block Android vendors from shipping devices and prevent the WebView team from dropping new Chrome and WebView APKs in the Android source tree. If you need to disable a test, please file a P1 crbug with ReleaseBlock-Dev in the Mobile>WebView component.

If you must disable a test, you can add an entry to the excludes list for the correct apk (most tests belong to CtsWebkitTestCases.apk) under test_runs for each OS level which is failing.

Re-enabling skipped tests

Before re-enabling tests, make sure it's actually safe to enable the test again.

• The test source code lives in Android and line numbers vary between OS versions. You can find test code for a particular CTS release by finding the appropriate git branch in codesearch:
  • Lollipop: lollipop-mr1-cts-release
  • Marshmallow: marshmallow-cts-release
  • Nougat: nougat-cts-dev
  • Oreo: oreo-cts-dev
  • Pie: pie-cts-dev
  • Android 10 (Q): android10-tests-dev
• If the test was fixed on the Android side, the fix must be cherry-picked back to the earliest applicable version (see the git branches above). Ex. if the test was added in Android Oreo (API 26), the fix should be picked back to aosp/oreo-cts-dev.
  • Note: some OS levels are no longer supported by the CTS team and will no longer receive CTS releases. Unfortunately, if there was a test bug for these OS levels, we must disable the test forever on that OS (and you should cherry-pick the fix to the earliest supported CTS branch).
• If the failure was due to a chromium-side bug/regression, you can re-enable the test as soon as the bug is fixed on trunk. You can run CTS on a device or emulator with this guide.

Re-enabling the test case is as simple as removing it from the excludes for the relevant OS levels. Please verify this change by adding the android-webview-* trybots (not enabled by default).

Changing CTS tests retroactively

Android generally has strict backward compatibility requirements, and this extends to CTS. However, sometimes it's appropriate to change the test logic rather than restoring the old chromium behavior, such as when the test logic is responsible for flakiness or relies on an invalid assumption. Please reach out to the WebView team quickly if you think a CTS test needs to change (the failure is still considered ReleaseBlock-Dev until the test change actually lands in Android).

Any CTS changes must be backward compatible. The original WebView version which shipped on that OS version must continue to pass the revised CTS test.