Merge "Measure baseline IMF latency (1/n)"

// Copyright (C) 2020 The Android Open Source Project

//

// Licensed under the Apache License, Version 2.0 (the "License");

// you may not use this file except in compliance with the License.

// You may obtain a copy of the License at

//

//      http://www.apache.org/licenses/LICENSE-2.0

//

// Unless required by applicable law or agreed to in writing, software

// distributed under the License is distributed on an "AS IS" BASIS,

// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

// See the License for the specific language governing permissions and

// limitations under the License.

android_test {

    name: "ImePerfTests",

    srcs: ["src/**/*.java"],

    static_libs: [

        "androidx.test.rules",

        "androidx.annotation_annotation",

        "apct-perftests-utils",

        "collector-device-lib",

        "compatibility-device-util-axt",

        "platform-test-annotations",

    ],

    test_suites: ["device-tests"],

    data: [":perfetto_artifacts"],

    platform_apis: true,

    certificate: "platform",

}

<?xml version="1.0" encoding="utf-8"?>

<!-- Copyright (C) 2020 The Android Open Source Project

     Licensed under the Apache License, Version 2.0 (the "License");

     you may not use this file except in compliance with the License.

     You may obtain a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

     Unless required by applicable law or agreed to in writing, software

     distributed under the License is distributed on an "AS IS" BASIS,

     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

     See the License for the specific language governing permissions and

     limitations under the License.

-->

<manifest xmlns:android="http://schemas.android.com/apk/res/android"

    package="com.android.perftests.inputmethod">

    <application>

        <uses-library android:name="android.test.runner" />

        <activity android:name="android.perftests.utils.PerfTestActivity"

            android:exported="true">

          <intent-filter>

            <action android:name="com.android.perftests.core.PERFTEST" />

          </intent-filter>

        </activity>

        <service android:name="android.inputmethod.ImePerfTest$BaselineIme"

                 android:process=":BaselineIME"

                 android:label="Baseline IME"

                 android:permission="android.permission.BIND_INPUT_METHOD"

                 android:exported="true">

            <intent-filter>

                <action android:name="android.view.InputMethod"/>

            </intent-filter>

            <meta-data android:name="android.view.im"

                       android:resource="@xml/simple_method"/>

        </service>

    </application>

    <instrumentation android:name="androidx.test.runner.AndroidJUnitRunner"

        android:targetPackage="com.android.perftests.inputmethod">

        <meta-data android:name="listener" android:value="android.inputmethod.ImePerfRunPrecondition" />

    </instrumentation>

</manifest>

<?xml version="1.0" encoding="utf-8"?>

<!-- Copyright (C) 2020 The Android Open Source Project

     Licensed under the Apache License, Version 2.0 (the "License");

     you may not use this file except in compliance with the License.

     You may obtain a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

     Unless required by applicable law or agreed to in writing, software

     distributed under the License is distributed on an "AS IS" BASIS,

     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

     See the License for the specific language governing permissions and

     limitations under the License.

-->

<configuration description="Runs ImePerfTests metric instrumentation.">

    <option name="test-suite-tag" value="apct" />

    <option name="test-suite-tag" value="apct-metric-instrumentation" />

    <target_preparer class="com.android.tradefed.targetprep.suite.SuiteApkInstaller">

        <option name="cleanup-apks" value="true" />

        <option name="test-file-name" value="ImePerfTests.apk" />

    </target_preparer>

    <target_preparer class="com.android.tradefed.targetprep.DeviceSetup">

        <option name="force-skip-system-props" value="true" />

        <option name="run-command" value="input keyevent KEYCODE_WAKEUP" />

        <option name="run-command" value="cmd window dismiss-keyguard" />

        <option name="run-command" value="cmd package compile -m speed com.android.perftests.inputmethod" />

    </target_preparer>

    <!-- Needed for pushing the trace config file -->

    <target_preparer class="com.android.tradefed.targetprep.RootTargetPreparer"/>

    <target_preparer class="com.android.tradefed.targetprep.PushFilePreparer">

        <option name="push-file" key="trace_config_detailed.textproto" value="/data/misc/perfetto-traces/trace_config.textproto" />

        <!--Install the content provider automatically when we push some file in sdcard folder.-->

        <!--Needed to avoid the installation during the test suite.-->

        <option name="push-file" key="trace_config_detailed.textproto" value="/sdcard/sample.textproto" />

    </target_preparer>

    <!-- Needed for storing the perfetto trace files in the sdcard/test_results-->

    <option name="isolated-storage" value="false" />

    <test class="com.android.tradefed.testtype.AndroidJUnitTest" >

        <option name="package" value="com.android.perftests.inputmethod" />

        <option name="hidden-api-checks" value="false"/>

        <!-- Listener related args for collecting the traces and waiting for the device to stabilize. -->

        <option name="device-listeners" value="android.device.collectors.ProcLoadListener,android.device.collectors.PerfettoListener" />

        <!-- Guarantee that user defined RunListeners will be running before any of the default listeners defined in this runner. -->

        <option name="instrumentation-arg" key="newRunListenerMode" value="true" />

        <!-- Kill background operations -->

        <option name="instrumentation-arg" key="kill-bg" value="true" />

        <!-- ProcLoadListener related arguments -->

        <!-- Wait for device last minute threshold to reach 3 with 2 minute timeout before starting the test run -->

        <option name="instrumentation-arg" key="procload-collector:per_run" value="true" />

        <option name="instrumentation-arg" key="proc-loadavg-threshold" value="3" />

        <option name="instrumentation-arg" key="proc-loadavg-timeout" value="120000" />

        <option name="instrumentation-arg" key="proc-loadavg-interval" value="10000" />

        <!-- PerfettoListener related arguments -->

        <option name="instrumentation-arg" key="perfetto_config_text_proto" value="true" />

        <option name="instrumentation-arg" key="perfetto_config_file" value="trace_config.textproto" />

    </test>

    <metrics_collector class="com.android.tradefed.device.metric.FilePullerLogCollector">

        <option name="directory-keys" value="/data/local/tmp/ImePerfTests" />

        <!-- Needed for pulling the collected trace config on to the host -->

        <option name="pull-pattern-keys" value="perfetto_file_path" />

    </metrics_collector>

</configuration>

## IMF performance tests

These tests are adaptation of Window Manager perf tests (apct-tests/perftests/windowmanager).

### Precondition

To reduce the variance of the test, if `perf-setup` (platform_testing/scripts/perf-setup)

is available, it is better to use the following instructions to lock CPU and GPU frequencies.

```

m perf-setup

PERF_SETUP_PATH=/data/local/tmp/perf-setup.sh

adb push $OUT/$PERF_SETUP_PATH $PERF_SETUP_PATH

adb shell chmod +x $PERF_SETUP_PATH

adb shell $PERF_SETUP_PATH

```

### Example to run

Use `atest`

```

atest ImePerfTests:ImePerfTest -- \

      --module-arg ImePerfTests:instrumentation-arg:profiling-iterations:=20

```

Note: `instrumentation-arg:kill-bg:=true` is already defined in the AndroidText.xml

Use `am instrument`

```

adb shell am instrument -w -r -e class android.inputmethod.ImePerfTest \

          -e listener android.inputmethod.ImePerfRunPrecondition \

          -e kill-bg true \

          com.android.perftests.inputmethod/androidx.test.runner.AndroidJUnitRunner

```

* `kill-bg` is optional.

Test arguments

 - kill-bg

   * boolean: Kill background process before running test.

 - profiling-iterations

   * int: Run the extra iterations with enabling method profiling.

 - profiling-sampling

   * int: The interval (0=trace each method, default is 10) of sample profiling in microseconds.

<?xml version="1.0" encoding="utf-8"?>

<!--

  ~ Copyright (C) 2020 The Android Open Source Project

  ~

  ~ Licensed under the Apache License, Version 2.0 (the "License");

  ~ you may not use this file except in compliance with the License.

  ~ You may obtain a copy of the License at

  ~

  ~      http://www.apache.org/licenses/LICENSE-2.0

  ~

  ~ Unless required by applicable law or agreed to in writing, software

  ~ distributed under the License is distributed on an "AS IS" BASIS,

  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  ~ See the License for the specific language governing permissions and

  ~ limitations under the License.

  -->

<!-- Configuration info for an input method -->

<input-method xmlns:android="http://schemas.android.com/apk/res/android" />