common/device-side/util/src/com/android/compatibility/common/util/OnFailureRule.java

/*
 * Copyright (C) 2018 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.compatibility.common.util;

import android.util.Log;

import org.junit.rules.TestRule;
import org.junit.runner.Description;
import org.junit.runners.model.Statement;

/**
 * Custom JUnit4 rule that provides a callback upon test failures.
 */
public abstract class OnFailureRule implements TestRule {
    private String mLogTag = "OnFailureRule";

    public OnFailureRule() {
    }

    public OnFailureRule(String logTag) {
        mLogTag = logTag;
    }

    @Override
    public Statement apply(Statement base, Description description) {
        return new Statement() {

            @Override
            public void evaluate() throws Throwable {
                try {
                    base.evaluate();
                } catch (Throwable t) {
                    Log.e(mLogTag, "Test failed: description=" +  description + "\nThrowable=" + t);
                    onTestFailure(base, description, t);
                    throw t;
                }
            }
        };
    }

    protected abstract void onTestFailure(Statement base, Description description, Throwable t);
}