1 /*
2  * Copyright (C) 2017 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.platform.test.helpers.listeners;
18 
19 import android.platform.test.helpers.IStandardAppHelper;
20 import android.support.annotation.Nullable;
21 import android.util.Log;
22 
23 import org.junit.rules.TestWatcher;
24 import org.junit.runner.Description;
25 
26 import java.io.IOException;
27 
28 /**
29  * A JUnit {@code TestWatcher} for collecting screenshots and UI XML files on test failure.
30  */
31 public class FailureTestWatcher extends TestWatcher {
32     private static final String LOG_TAG = FailureTestWatcher.class.getSimpleName();
33     private static final String SCREENSHOT_NAME_FORMAT = "%s_%s";
34 
35     @Nullable
36     private IStandardAppHelper mHelper;
37 
setHelper(IStandardAppHelper helper)38     public void setHelper (IStandardAppHelper helper) {
39         mHelper = helper;
40     }
41 
42     @Override
failed(Throwable e, Description description)43     protected void failed(Throwable e, Description description) {
44         try {
45             if (!mHelper.captureScreenshot(String.format(SCREENSHOT_NAME_FORMAT,
46                     description.getClassName(), description.getMethodName()))) {
47                 Log.e(LOG_TAG, "Failed to capture a screenshot for unknown reasons.");
48             }
49         } catch (IOException ioe) {
50             Log.e(LOG_TAG, "Failed to capture a screenshot.", ioe);
51         }
52     }
53 }
54