/*
 * Copyright (C) 2015 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 androidx.test.internal.runner.junit3;

import android.util.Log;
import androidx.test.internal.util.AndroidRunnerParams;
import junit.framework.Test;
import junit.framework.TestSuite;
import org.junit.internal.builders.SuiteMethodBuilder;
import org.junit.internal.runners.SuiteMethod;
import org.junit.runner.Runner;
import org.junit.runners.model.RunnerBuilder;

/**
 * A {@link RunnerBuilder} that properly injects Android constructs into classes with suite()
 * methods.
 */
public class AndroidSuiteBuilder extends SuiteMethodBuilder {

  private static final String LOG_TAG = "AndroidSuiteBuilder";
  private final boolean ignoreSuiteMethods;
  private final long perTestTimeout;

  /**
   * @param runnerParams {@link AndroidRunnerParams} that stores common runner parameters
   * @deprecated use {@link AndroidSuiteBuilder()}
   */
  @Deprecated
  public AndroidSuiteBuilder(AndroidRunnerParams runnerParams) {
    this(runnerParams.isIgnoreSuiteMethods(), runnerParams.getPerTestTimeout());
  }

  public AndroidSuiteBuilder(boolean ignoreSuiteMethods, long perTestTimeout) {
    this.ignoreSuiteMethods = ignoreSuiteMethods;
    this.perTestTimeout = perTestTimeout;
  }

  @Override
  public Runner runnerForClass(Class<?> testClass) throws Throwable {
    if (ignoreSuiteMethods) {
      return null;
    }
    try {
      if (hasSuiteMethod(testClass)) {
        Test t = SuiteMethod.testFromSuiteMethod(testClass);
        if (!(t instanceof TestSuite)) {
          // this should not be possible
          throw new IllegalArgumentException(
              testClass.getName() + "#suite() did not return a TestSuite");
        }
        return new JUnit38ClassRunner(new AndroidTestSuite((TestSuite) t, perTestTimeout));
      }
    } catch (Throwable e) {
      // log error message including stack trace before throwing to help with debugging.
      Log.e(LOG_TAG, "Error constructing runner", e);
      throw e;
    }
    return null;
  }
}