1 /*
2  * Copyright (C) 2023 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package android.tools.flicker.rules
18 
19 import android.platform.test.rule.ArtifactSaver
20 import android.tools.FLICKER_TAG
21 import android.tools.traces.parsers.DeviceDumpParser
22 import android.util.Log
23 import org.junit.rules.TestWatcher
24 import org.junit.runner.Description
25 
26 class ArtifactSaverRule : TestWatcher() {
27     private var handled = false
failednull28     override fun failed(e: Throwable, description: Description?) {
29         if (handled) {
30             return
31         }
32 
33         try {
34             if (DeviceDumpParser.lastWmTraceData.isNotEmpty()) {
35                 val fileName = getClassAndMethodName(description) + "lastWmTraceData.winscope"
36                 val file = ArtifactSaver.artifactFile(fileName)
37                 file.writeBytes(DeviceDumpParser.lastWmTraceData)
38             }
39 
40             if (DeviceDumpParser.lastLayersTraceData.isNotEmpty()) {
41                 val fileName = getClassAndMethodName(description) + "lastLayersTraceData.perfetto"
42                 val file = ArtifactSaver.artifactFile(fileName)
43                 file.writeBytes(DeviceDumpParser.lastLayersTraceData)
44             }
45         } catch (e: Exception) {
46             Log.e(FLICKER_TAG, "Failed to write last Winscope dumps on error", e)
47         }
48 
49         ArtifactSaver.onError(description, e)
50 
51         handled = true
52     }
53 
getClassAndMethodNamenull54     private fun getClassAndMethodName(description: Description?): String {
55         var suffix = description?.methodName
56         if (suffix == null) {
57             // Can happen when the description is from a ClassRule
58             suffix = "EntireClassExecution"
59         }
60         val testClass = description?.testClass
61 
62         // Can have null class if this is a synthetic suite
63         val className = if (testClass != null) testClass.simpleName else "SUITE"
64         return "$className.$suffix"
65     }
66 }
67