Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit f75e0a05 authored by Kohsuke Yatoh's avatar Kohsuke Yatoh
Browse files

Take screenshot on failure. 

ScreenCaptureRule is inspired by ScreenshotTestRule [1], but does not
require additional permissions as ScreenCaptureRule uses Shell
permission.

[1] https://cs.android.com/android/platform/superproject/+/master:cts/tests/tests/systemui/src/android/systemui/cts/ScreenshotTestRule.java

Bug: 227712564
Bug: 227424350
Test: atest InputMethodStressTest
Change-Id: I8569cb09a430540ac3f932e36bc80800312e7865
parent 9074b73e

tests/InputMethodStressTest/AndroidTest.xml

+6 −0
Original line number Diff line number Diff line
@@ -31,4 +31,10 @@ 
    <test class="com.android.tradefed.testtype.AndroidJUnitTest">

        <option name="package" value="com.android.inputmethod.stresstest" />

    </test>



    <!-- Collect the files in the dump directory for debugging -->

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

        <option name="directory-keys" value="/sdcard/InputMethodStressTest/" />

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

    </metrics_collector>

</configuration>

tests/InputMethodStressTest/src/com/android/inputmethod/stresstest/AutoShowTest.java

+4 −0
Original line number Diff line number Diff line
@@ -48,6 +48,10 @@ public final class AutoShowTest { 
    @Rule

    public UnlockScreenRule mUnlockScreenRule = new UnlockScreenRule();



    @Rule

    public ScreenCaptureRule mScreenCaptureRule =

            new ScreenCaptureRule("/sdcard/InputMethodStressTest");



    @Test

    public void autoShow() {

        Instrumentation instrumentation = InstrumentationRegistry.getInstrumentation();

tests/InputMethodStressTest/src/com/android/inputmethod/stresstest/ImeOpenCloseStressTest.java

+4 −0
Original line number Diff line number Diff line
@@ -55,6 +55,10 @@ public final class ImeOpenCloseStressTest { 
    @Rule

    public UnlockScreenRule mUnlockScreenRule = new UnlockScreenRule();



    @Rule

    public ScreenCaptureRule mScreenCaptureRule =

            new ScreenCaptureRule("/sdcard/InputMethodStressTest");



    @Test

    public void test() {

        Instrumentation instrumentation = InstrumentationRegistry.getInstrumentation();

tests/InputMethodStressTest/src/com/android/inputmethod/stresstest/NotificationTest.java

+4 −0
Original line number Diff line number Diff line
@@ -75,6 +75,10 @@ public final class NotificationTest { 
    @Rule

    public UnlockScreenRule mUnlockScreenRule = new UnlockScreenRule();



    @Rule

    public ScreenCaptureRule mScreenCaptureRule =

            new ScreenCaptureRule("/sdcard/InputMethodStressTest");



    private Context mContext;

    private NotificationManager mNotificationManager;

    private UiDevice mUiDevice;

tests/InputMethodStressTest/src/com/android/inputmethod/stresstest/ScreenCaptureRule.java

0 → 100644
+69 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2022 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 com.android.inputmethod.stresstest;



import com.android.compatibility.common.util.SystemUtil;



import org.junit.rules.TestWatcher;

import org.junit.runner.Description;



import java.text.SimpleDateFormat;

import java.util.Date;



/**

 * Takes a screenshot when the test fails.

 *

 * <p>Use {@link com.android.tradefed.device.metric.FilePullerLogCollector} to collect screenshots

 * taken.

 * For example, in AndroidTest.xml:

 * <code>

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

 *         <option name="directory-keys" value="/sdcard/MyTest/" />

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

 *     </metrics_collector>

 * </code>

 * in MyTest.java:

 * <code>

 *     @Rule

 *     public ScreenCaptureRule mScreenCaptureRule = new ScreenCaptureRule("/sdcard/MyTest");

 * </code>

 */

public class ScreenCaptureRule extends TestWatcher {



    private static final String TAG = "ScreenCaptureRule";



    private final String mOutDir;



    public ScreenCaptureRule(String outDir) {

        mOutDir = outDir;

    }



    @Override

    protected void failed(Throwable e, Description description) {

        super.failed(e, description);

        String time = new SimpleDateFormat("yyyyMMdd-HHmmss").format(new Date());

        String fileName = "screenshot-" + time + ".png";

        capture(fileName);

    }



    /** Take a screenshot. */

    public void capture(String fileName) {

        SystemUtil.runCommandAndPrintOnLogcat(TAG, String.format("mkdir -p %s", mOutDir));

        SystemUtil.runCommandAndPrintOnLogcat(TAG,

                String.format("screencap %s/%s", mOutDir, fileName));

    }

}