BenchmarkReportTask.kt
/*
* Copyright 2019 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 androidx.benchmark.gradle
import java.io.File
import org.gradle.api.DefaultTask
import org.gradle.api.file.DirectoryProperty
import org.gradle.api.provider.Property
import org.gradle.api.tasks.Input
import org.gradle.api.tasks.OutputDirectory
import org.gradle.api.tasks.StopExecutionException
import org.gradle.api.tasks.TaskAction
import org.gradle.work.DisableCachingByDefault
@Suppress("UnstableApiUsage")
@DisableCachingByDefault(because = "Benchmark measurements are performed each task execution.")
abstract class BenchmarkReportTask : DefaultTask() {
init {
group = "Android"
description = "Run benchmarks found in the current project and output reports to the " +
"benchmark_reports folder under the project's build directory."
// This task should mirror the upToDate behavior of connectedAndroidTest as we always want
// this task to run after connectedAndroidTest is run to pull the most recent benchmark
// report data, even when tests are triggered multiple times in a row without source
// changes.
outputs.upToDateWhen { false }
}
@get:OutputDirectory
abstract val benchmarkReportDir: DirectoryProperty
@get:Input
abstract val adbPath: Property<String>
@TaskAction
fun exec() {
// Fetch reports from all available devices as the default behaviour of connectedAndroidTest
// is to run on all available devices.
getReportsForDevices(Adb(adbPath.get(), logger))
}
private fun getReportsForDevices(adb: Adb) {
val reportDir = benchmarkReportDir.asFile.get()
if (reportDir.exists()) {
reportDir.deleteRecursively()
}
reportDir.mkdirs()
val deviceIds = adb.execSync("devices -l").stdout
.split("\n")
.drop(1)
.filter { !it.contains("unauthorized") }
.map { it.split(Regex("\s+")).first().trim() }
.filter { !it.isBlank() }
for (deviceId in deviceIds) {
val dataDir = getReportDirForDevice(adb, deviceId)
if (dataDir.isBlank()) {
throw StopExecutionException("Failed to find benchmark report on device: $deviceId")
}
val outDir = File(reportDir, deviceId)
outDir.mkdirs()
getReportsForDevice(adb, outDir, dataDir, deviceId)
logger.info(
"Benchmark",
"Benchmark report files generated at ${reportDir.absolutePath}"
)
}
}
private fun getReportsForDevice(
adb: Adb,
benchmarkReportDir: File,
dataDir: String,
deviceId: String
) {
adb.execSync("shell ls $dataDir", deviceId)
.stdout
.split("\n")
.map { it.trim() }
.filter { it.matches(Regex(".*benchmarkData[.](?:xml|json)$")) }
.forEach {
val src = "$dataDir/$it"
adb.execSync("pull $src $benchmarkReportDir/$it", deviceId)
adb.execSync("shell rm $src", deviceId)
}
}
/**
* Query for test runner user's Download dir on shared public external storage via content
* provider APIs.
*
* This folder is typically accessed in Android code via
* Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_DOWNLOADS)
*/
private fun getReportDirForDevice(adb: Adb, deviceId: String): String {
val cmd = "shell content query --uri content://media/external/file --projection _data"
// With Android >= 10 `LIKE` is no longer supported when specifying a `WHERE` clause so we
// need to manually filter the output here.
// Note that stdout of the above command is of the form:
// Row: 0 _data=/storage/emulated
// Row: 1 _data=/storage/emulated/0
// Row: 2 _data=/storage/emulated/0/Music
// Row: 3 _data=/storage/emulated/0/Podcasts
// Row: 4 _data=/storage/emulated/0/Ringtones
// Row: 5 _data=/storage/emulated/0/Alarms
// Row: 5 _data=/storage/emulated/0/Download
// etc
// There are 2 filters: the first filters all the rows ending with `Download`, while
// the second excludes app-scoped shared external storage.
return adb.execSync(cmd, deviceId).stdout
.split("\n")
.filter { it.matches(regex = Regex(".*/Download")) }
.first { !it.matches(regex = Regex(".*files/Download")) }
.trim()
.split(Regex("\s+"))
.last()
.split("=")
.last()
.trim()
}
}