src/com/android/tradefed/util/JUnit4TestFilter.java

/*
 * Copyright (C) 2016 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.tradefed.util;

import com.android.tradefed.log.LogUtil.CLog;

import org.junit.runner.Description;
import org.junit.runner.manipulation.Filter;

import java.io.File;
import java.util.List;

/**
 * Helper Class that provides the filtering for JUnit4 runner by extending the {@link Filter}.
 */
public class JUnit4TestFilter extends Filter {

    private TestFilterHelper mFilterHelper;
    private List<File> mJarFiles;

    public JUnit4TestFilter(TestFilterHelper filterHelper, List<File> extraJarFiles) {
        mFilterHelper = filterHelper;
        mJarFiles = extraJarFiles;
    }

    /**
     * Filter function deciding whether a test should run or not.
     */
    @Override
    public boolean shouldRun(Description description) {
        // If it's a suite, we check if at least one of the children can run, if yes then we run it
        if (description.isSuite()) {
            for (Description desc : description.getChildren()) {
                if (shouldRun(desc)) {
                    return true;
                }
            }
            // If no children can run, we don't run the suite
            CLog.d("No child of '%s' could run. skipping it.", description);
            return false;
        }
        return mFilterHelper.shouldRun(description, mJarFiles);
    }

    @Override
    public String describe() {
        return "This filter is based on annotations, regex filter, class and method name to decide "
                + "if a particular test should run.";
    }
}