Adding MediaProjection Functional Flicker Test Scenarios

//

// 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.

//

package {

    // See: http://go/android-license-faq

    // A large-scale-change added 'default_applicable_licenses' to import

    // all of the 'license_kinds' from "frameworks_base_license"

    // to get the below license kinds:

    //   SPDX-license-identifier-Apache-2.0

    default_applicable_licenses: ["frameworks_base_license"],

}

android_test {

    name: "WMShellFlickerTestsMediaProjection",

    defaults: ["WMShellFlickerTestsDefault"],

    manifest: "AndroidManifest.xml",

    test_config_template: "AndroidTestTemplate.xml",

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

    static_libs: [

        "WMShellFlickerTestsBase",

        "WMShellScenariosMediaProjection",

        "WMShellTestUtils",

    ],

    data: ["trace_config/*"],

}

<!--

  ~ Copyright (C) 2023 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"

          xmlns:tools="http://schemas.android.com/tools"

          package="com.android.wm.shell.flicker">

    <uses-sdk android:minSdkVersion="29" android:targetSdkVersion="29"/>

    <!-- Read and write traces from external storage -->

    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />

    <!-- Allow the test to write directly to /sdcard/ -->

    <uses-permission android:name="android.permission.MANAGE_EXTERNAL_STORAGE" />

    <!-- Write secure settings -->

    <uses-permission android:name="android.permission.WRITE_SECURE_SETTINGS" />

    <!-- Capture screen contents -->

    <uses-permission android:name="android.permission.ACCESS_SURFACE_FLINGER" />

    <!-- Enable / Disable tracing !-->

    <uses-permission android:name="android.permission.DUMP" />

    <!-- Run layers trace -->

    <uses-permission android:name="android.permission.HARDWARE_TEST"/>

    <!-- Capture screen recording -->

    <uses-permission android:name="android.permission.CAPTURE_VIDEO_OUTPUT"/>

    <!-- Workaround grant runtime permission exception from b/152733071 -->

    <uses-permission android:name="android.permission.PACKAGE_USAGE_STATS"/>

    <uses-permission android:name="android.permission.READ_LOGS"/>

    <!-- Force-stop test apps -->

    <uses-permission android:name="android.permission.FORCE_STOP_PACKAGES"/>

    <!-- Control test app's media session -->

    <uses-permission android:name="android.permission.MEDIA_CONTENT_CONTROL"/>

    <!-- ATM.removeRootTasksWithActivityTypes() -->

    <uses-permission android:name="android.permission.MANAGE_ACTIVITY_TASKS" />

    <!-- Enable bubble notification-->

    <uses-permission android:name="android.permission.STATUS_BAR_SERVICE" />

    <!-- Allow the test to connect to perfetto trace processor -->

    <uses-permission android:name="android.permission.INTERNET"/>

    <uses-permission android:name="android.permission.READ_COMPAT_CHANGE_CONFIG" />

    <uses-permission android:name="android.permission.MANAGE_MEDIA_PROJECTION" />

    <!-- Allow the test to write directly to /sdcard/ and connect to trace processor -->

    <application android:requestLegacyExternalStorage="true"

                 android:networkSecurityConfig="@xml/network_security_config"

                 android:largeHeap="true">

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

        <service android:name=".NotificationListener"

                 android:exported="true"

                 android:label="WMShellTestsNotificationListenerService"

                 android:permission="android.permission.BIND_NOTIFICATION_LISTENER_SERVICE">

            <intent-filter>

                <action android:name="android.service.notification.NotificationListenerService" />

            </intent-filter>

        </service>

        <service android:name="com.android.wm.shell.flicker.utils.MediaProjectionService"

            android:foregroundServiceType="mediaProjection"

            android:label="WMShellTestsMediaProjectionService"

            android:enabled="true">

        </service>

        <!-- (b/197936012) Remove startup provider due to test timeout issue -->

        <provider

            android:name="androidx.startup.InitializationProvider"

            android:authorities="${applicationId}.androidx-startup"

            tools:node="remove" />

    </application>

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

                     android:targetPackage="com.android.wm.shell.flicker"

                     android:label="WindowManager Shell Flicker Tests">

    </instrumentation>

</manifest>

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

<!--

  ~ Copyright (C) 2023 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 WindowManager Shell Flicker Tests {MODULE}">

    <option name="test-tag" value="FlickerTests"/>

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

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

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

        <!-- disable DeprecatedTargetSdk warning -->

        <option name="run-command" value="setprop debug.wm.disable_deprecated_target_sdk_dialog 1"/>

        <!-- keeps the screen on during tests -->

        <option name="screen-always-on" value="on"/>

        <!-- prevents the phone from restarting -->

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

        <!-- set WM tracing verbose level to all -->

        <option name="run-command" value="cmd window tracing level all"/>

        <!-- set WM tracing to frame (avoid incomplete states) -->

        <option name="run-command" value="cmd window tracing frame"/>

        <!-- disable betterbug as it's log collection dialogues cause flakes in e2e tests -->

        <option name="run-command" value="pm disable com.google.android.internal.betterbug"/>

        <!-- ensure lock screen mode is swipe -->

        <option name="run-command" value="locksettings set-disabled false"/>

        <!-- restart launcher to activate TAPL -->

        <option name="run-command"

                value="setprop ro.test_harness 1 ; am force-stop com.google.android.apps.nexuslauncher"/>

        <!-- Increase trace size: 20mb for WM and 80mb for SF -->

        <option name="run-command" value="cmd window tracing size 20480"/>

        <option name="run-command" value="su root service call SurfaceFlinger 1029 i32 81920"/>

    </target_preparer>

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

        <option name="test-user-token" value="%TEST_USER%"/>

        <option name="run-command" value="rm -rf /data/user/%TEST_USER%/files/*"/>

        <option name="run-command" value="settings put secure show_ime_with_hard_keyboard 1"/>

        <option name="run-command" value="settings put system show_touches 1"/>

        <option name="run-command" value="settings put system pointer_location 1"/>

        <option name="teardown-command"

                value="settings delete secure show_ime_with_hard_keyboard"/>

        <option name="teardown-command" value="settings delete system show_touches"/>

        <option name="teardown-command" value="settings delete system pointer_location"/>

        <option name="teardown-command"

                value="cmd overlay enable com.android.internal.systemui.navbar.gestural"/>

    </target_preparer>

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

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

        <option name="test-file-name" value="{MODULE}.apk"/>

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

    </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.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.textproto" value="/sdcard/sample.textproto"/>

    </target_preparer>

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

        <option name="package" value="{PACKAGE}"/>

        <option name="shell-timeout" value="6600s"/>

        <option name="test-timeout" value="6000s"/>

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

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

        <!-- 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"

        />

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

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

    </test>

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

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

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

        <option name="directory-keys"

                value="/data/user/0/com.android.wm.shell.flicker/files"/>

        <option name="collect-on-run-ended-only" value="true"/>

        <option name="clean-up" value="true"/>

    </metrics_collector>

</configuration>

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

<!--

  ~ Copyright (C) 2023 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.

  -->

<network-security-config>

    <domain-config cleartextTrafficPermitted="true">

        <domain includeSubdomains="true">localhost</domain>

    </domain-config>

</network-security-config>

# Copyright (C) 2023 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.

# proto-message: TraceConfig

# Enable periodic flushing of the trace buffer into the output file.

write_into_file: true

# Writes the userspace buffer into the file every 1s.

file_write_period_ms: 2500

# See b/126487238 - we need to guarantee ordering of events.

flush_period_ms: 30000

# The trace buffers needs to be big enough to hold |file_write_period_ms| of

# trace data. The trace buffer sizing depends on the number of trace categories

# enabled and the device activity.

# RSS events

buffers: {

  size_kb: 63488

  fill_policy: RING_BUFFER

}

data_sources {

  config {

    name: "linux.process_stats"

    target_buffer: 0

    # polled per-process memory counters and process/thread names.

    # If you don't want the polled counters, remove the "process_stats_config"

    # section, but keep the data source itself as it still provides on-demand

    # thread/process naming for ftrace data below.

    process_stats_config {

      scan_all_processes_on_start: true

    }

  }

}

data_sources: {

  config {

    name: "linux.ftrace"

    ftrace_config {

      ftrace_events: "ftrace/print"

      ftrace_events: "task/task_newtask"

      ftrace_events: "task/task_rename"

      atrace_categories: "ss"

      atrace_categories: "wm"

      atrace_categories: "am"

      atrace_categories: "aidl"

      atrace_categories: "input"

      atrace_categories: "binder_driver"

      atrace_categories: "sched_process_exit"

      atrace_apps: "com.android.server.wm.flicker.testapp"

      atrace_apps: "com.android.systemui"

      atrace_apps: "com.android.wm.shell.flicker.service"

      atrace_apps: "com.google.android.apps.nexuslauncher"

    }

  }

}