Модули для нескольких устройств

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

Образец

Предоставляется модуль CTS wifi-aware multidevice. Он отправляет сообщение с одного устройства по wifi и проверяет, что другое устройство его получает.

Исходный код модуля находится по адресу packages/modules/Wifi/tests/hostsidetests/multidevices/test/aware/ .

Мы снабдили пример всеми необходимыми, на наш взгляд, комментариями.

Шаг 1: Создайте папку модуля

Рекомендуется создать папку для вашего модуля multi-devices в проекте пакета, к которому он принадлежит. Например: cts/hostsidetests/multidevices/ . Мы рекомендуем это, чтобы все модули multi-devices оставались совместно размещенными, по крайней мере, на первых порах, что облегчит обнаружение примеров.

Все файлы этого модуля должны быть помещены в собственную папку модуля. Например: wifi_aware .

Шаг 2: Создайте тест

Здесь вы реализуете свою тестовую логику. Она сильно зависит от того, что именно тестируется.

Создайте исходный код теста Mobly, например: wifi_aware_test.py .

Шаг 3: Создайте файл сборки: Android.bp

Добавьте файл Android.bp, например packages/modules/Wifi/tests/hostsidetests/multidevices/test/Android.bp . Определите модуль python_test_host, похожий на:

python_test_host {
    name: "CtsWifiAwareTestCases",
    main: "wifi_aware_test.py",
    srcs: ["wifi_aware_test.py"],
    test_suites: [
        "cts",
        "general-tests",
    ],
    test_options: {
        unit_test: false,
    },
    data: [
          // Package the snippet with the mobly test
        ":wifi_aware_snippet",
    ],
}

Укажите фрагменты для теста с полем данных, которые будут упакованы в двоичный файл и могут быть найдены и установлены в тесте с помощью ATest или в режиме непрерывного выполнения.

Mobly Bundled Snippets доступны в Android по адресу external/mobly-bundled-snippets/ .

Необязательно: создайте пользовательские фрагменты

Некоторые многоустройственные модули могут потребовать пользовательских фрагментов Mobly. Тестовый пример включает фрагмент с поддержкой Wi-Fi в packages/modules/Wifi/tests/hostsidetests/multidevices/com.google.snippet.wifi/aware/WifiAwareSnippet.java , который создан с помощью Mobly Snippet Lib, доступной в Android по адресу: external/mobly-snippet-lib/ .

Фрагмент должен быть определен с помощью правила android_test в Android.bp, как стандартный инструментарий:

android_test {
    name: "wifi_aware_snippet",
    sdk_version: "current",
    srcs: [
        "CallbackUtils.java",
        "WifiAwareSnippet.java",
    ],
    manifest: "AndroidManifest.xml",
    static_libs: [
        "androidx.test.runner",
        "guava",
        "mobly-snippet-lib",
    ],
}

Шаг 4: Создайте конфигурацию модуля: AndroidTest.xml

Добавьте файл AndroidTest.xml, например packages/modules/Wifi/tests/hostsidetests/multidevices/test/aware/AndroidTest.xml . В этой конфигурации теста вам нужно указать два устройства для теста, аналогично:

<configuration description="Config for CTS Wifi Aware test cases">
    <option name="test-suite-tag" value="cts" />
    <option name="config-descriptor:metadata" key="component" value="wifi" />
    <option name="config-descriptor:metadata" key="parameter" value="not_instant_app" />
    <option name="config-descriptor:metadata" key="parameter" value="not_multi_abi" />
    <option name="config-descriptor:metadata" key="parameter" value="not_secondary_user" />

    <device name="device1">
        <!-- For coverage to work, the APK should not be uninstalled until after coverage is pulled.
             So it's a lot easier to install APKs outside the python code.
        -->
        <target_preparer class="com.android.tradefed.targetprep.suite.SuiteApkInstaller">
            <option name="test-file-name" value="wifi_aware_snippet.apk" />
        </target_preparer>
        <target_preparer class="com.android.tradefed.targetprep.RunCommandTargetPreparer">
            <option name="run-command" value="input keyevent KEYCODE_WAKEUP" />
            <option name="run-command" value="wm dismiss-keyguard" />
        </target_preparer>
        <target_preparer class="com.android.tradefed.targetprep.PythonVirtualenvPreparer">
          <!-- Any python dependencies can be specified and will be installed with pip -->
          <option name="dep-module" value="mobly" />
        </target_preparer>
    </device>
    <device name="device2">
        <target_preparer class="com.android.tradefed.targetprep.suite.SuiteApkInstaller">
            <option name="test-file-name" value="wifi_aware_snippet.apk" />
        </target_preparer>
        <target_preparer class="com.android.tradefed.targetprep.RunCommandTargetPreparer">
            <option name="run-command" value="input keyevent KEYCODE_WAKEUP" />
            <option name="run-command" value="wm dismiss-keyguard" />
        </target_preparer>
    </device>

    <test class="com.android.tradefed.testtype.mobly.MoblyBinaryHostTest">
      <!-- The mobly-par-file-name should match the module name -->
      <option name="mobly-par-file-name" value="CtsWifiAwareTestCases" />
      <!-- Timeout limit in milliseconds for all test cases of the python binary -->
      <option name="mobly-test-timeout" value="60000" />
    </test>
</configuration>

Обратите внимание, что:

  • Этот тестовый пример имеет зависимость от Mobly. Любая зависимость может быть указана для PythonVirtualenvPreparer и будет установлена ​​с помощью pip.
  • mobly-par-file-name для MoblyBinaryHostTest должно совпадать с именем модуля, как в Android.bp.
  • Укажите mobly-test-timeout для теста. Он указывается в миллисекундах и применяется ко всему выполнению бинарного файла python (все тестовые случаи вместе). Это необходимо для того, чтобы тестовые случаи не зависали вечно в случае возникновения каких-либо проблем.
  • Каждый тег device может содержать отдельную настройку для каждого устройства. Конфигурация Mobly будет получать их в том же порядке, который указан в XML.

Относится к установке apk-файла:

  • Первоначальный POC был обновлен для установки APK-файлов фрагментов через target_preparer в связи с обсуждением с командой Coverage: чтобы гарантировать, что измерения покрытия не будут удалены слишком рано, удаление с помощью Harness, а не с помощью тестового кода в двоичных файлах Python, обеспечивает лучшие гарантии с точки зрения сроков.

Шаг 5: Запустите тест локально: atest

В настоящее время многоустройственные тесты выполняются только на физических устройствах. Перед запуском теста убедитесь, что ваши тестовые устройства находятся в надлежащем состоянии. Команда adb devices должна выдать список подключенных устройств. Если в списке есть устройства, не предназначенные для тестирования, укажите устройства для теста с помощью флага -s.

Для тестирования Wi-Fi убедитесь, что на устройствах включен Wi-Fi (после сброса настроек к заводским).

Вы можете запустить тест локально с помощью atest:

$ atest CtsWifiAwareTestCases

Вы должны увидеть количество использованных устройств в сводном заголовке выходных данных теста, что-то вроде Test executed with 2 device(s) .

Поиск неисправностей

Если тест не пройден локально по следующим причинам:

Ошибка Virtualenv 

java.io.IOException: Cannot run program
"virtualenv": error=2, No such file or directory

Пожалуйста, убедитесь, что virtualenv есть в вашем PATH. Добавление "~/.local/bin" в PATH должно исправить это. Если virtualenv не установлен, следуйте: https://virtualenv.pypa.io/en/latest/installation.html

Ожидалось получить не менее 2 объектов контроллера, получено 1

Тестовые модули бывают либо многоустройственными, либо одноустройственными, смешанных модулей нет. Если вы попытаетесь запустить многоустройственный модуль без нескольких устройств, вы увидите эту ошибку:

Expected to get at least 2 controller objects, got 1

Выполнение модуля в режиме нескольких устройств решит проблему.

Для CTS: вы можете использовать шардинг для его запуска (например: --shard-count 2) или run cts-multidevces .