forked from androidx/androidx
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add support for trace processor queries
Fixes:194808912 Test: ./gradlew benchmark:benchmark-macro:cC Additionally, changes test previously only checking file size to also validate trace contents. This revealed an issue that trace sections weren't captured immediately after starting the trace, which is currently worked around with a Thread.sleep(). Additionally, adds 'FileLinkingRule' internal test API for more easy trace and file diagnostic issues, by enabling files produced by tests (especially traces) to be easily reported to Studio as links. Change-Id: I4c05e1bd0749c8d7aad7b36bff877916d2a6a9aa
- Loading branch information
1 parent
46ff029
commit 869b9bb
Showing
5 changed files
with
281 additions
and
38 deletions.
There are no files selected for viewing
120 changes: 120 additions & 0 deletions
120
benchmark/benchmark-macro/src/androidTest/java/androidx/benchmark/macro/FileLinkingRule.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| /* | ||
| * Copyright 2021 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.macro | ||
|
|
||
| import androidx.benchmark.InstrumentationResults | ||
| import androidx.benchmark.Outputs | ||
| import androidx.benchmark.macro.perfetto.UiState | ||
| import androidx.benchmark.macro.perfetto.appendUiState | ||
| import org.junit.rules.RuleChain | ||
| import org.junit.rules.TestRule | ||
| import org.junit.runner.Description | ||
| import org.junit.runners.model.Statement | ||
| import java.io.File | ||
|
|
||
| /** | ||
| * Rule to enable linking files and traces to Studio UI for macrobench correctness tests. | ||
| * | ||
| * Filepaths are registered, and reported, but files are not created by this class, that should | ||
| * be handled by the test. Ensure you don't clean up the file - it needs to persist to be copied | ||
| * over by Studio. | ||
| */ | ||
| class FileLinkingRule : TestRule { | ||
| private lateinit var currentDescription: Description | ||
| private var summaryString = "" | ||
|
|
||
| private fun createReportedFilePath( | ||
| label: String, | ||
| @Suppress("SameParameterValue") extension: String, | ||
| ): String { | ||
| // remove parens / brackets, as it confuses linking | ||
| val methodLabel = currentDescription.toUniqueName() | ||
| .replace("(", "_") | ||
| .replace(")", "_") | ||
| .replace("[", "_") | ||
| .replace("]", "_") | ||
|
|
||
| val file = File( | ||
| Outputs.dirUsableByAppAndShell, | ||
| "${label}_${Outputs.dateToFileName()}.$extension" | ||
| ) | ||
| val absolutePath: String = file.absolutePath | ||
| val relativePath = Outputs.relativePathFor(absolutePath) | ||
|
|
||
| summaryString += "$methodLabel [$label](file://$relativePath)\n" | ||
| return absolutePath | ||
| } | ||
|
|
||
| /** | ||
| * Map of trace abs path -> process to highlight. | ||
| * | ||
| * After trace is complete (at end of test), we write a UI state packet to it, so trace UI | ||
| * can highlight/select the relevant process. | ||
| */ | ||
| private val traceToPackageMap = mutableMapOf<String, String>() | ||
|
|
||
| fun createReportedTracePath( | ||
| packageName: String, | ||
| label: String = "trace" | ||
| ): String { | ||
| val absolutePath = createReportedFilePath(label, "perfetto-trace") | ||
| traceToPackageMap[absolutePath] = packageName | ||
| return absolutePath | ||
| } | ||
|
|
||
| override fun apply(base: Statement, description: Description): Statement { | ||
| return RuleChain | ||
| .outerRule(::applyInternal) | ||
| .apply(base, description) | ||
| } | ||
|
|
||
| private fun applyInternal(base: Statement, description: Description) = object : Statement() { | ||
| override fun evaluate() { | ||
| require(Outputs.outputDirectory == Outputs.dirUsableByAppAndShell) { | ||
| "FileLinkingRule may only be used when outputDirectory == dirUsableByAppAndShell" | ||
| } | ||
|
|
||
| currentDescription = description | ||
| try { | ||
| base.evaluate() | ||
| } finally { | ||
| flush() | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private fun flush() { | ||
| traceToPackageMap.forEach { entry -> | ||
| File(entry.key).apply { | ||
| if (exists()) { | ||
| appendUiState( | ||
| UiState(null, null, entry.value) | ||
| ) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| InstrumentationResults.instrumentationReport { | ||
| ideSummaryRecord( | ||
| summaryV1 = "", // not supported | ||
| summaryV2 = summaryString.trim() | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| private fun Description.toUniqueName() = testClass.simpleName + "_" + methodName | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
34 changes: 34 additions & 0 deletions
34
benchmark/benchmark-macro/src/androidTest/java/androidx/benchmark/macro/Packages.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| /* | ||
| * Copyright 2021 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.macro | ||
|
|
||
| object Packages { | ||
| /** | ||
| * Separate target app. | ||
| * | ||
| * Use this app/package if it's necessary to kill/compile target process. | ||
| */ | ||
| const val TARGET = | ||
| "androidx.benchmark.integration.macrobenchmark.target" | ||
|
|
||
| /** | ||
| * This test app - this process. | ||
| * | ||
| * Preferably use this app/package if not killing/compiling target. | ||
| */ | ||
| const val TEST = "androidx.benchmark.macro.test" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.