io.vertx.ext.unit.junit.VertxUnitRunnerWithParameters Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vertx-unit Show documentation
There is a newer version: 5.0.0.CR3
package io.vertx.ext.unit.junit;

import org.junit.runner.notification.RunNotifier;
import org.junit.runners.Parameterized;
import org.junit.runners.model.FrameworkField;
import org.junit.runners.model.FrameworkMethod;
import org.junit.runners.model.InitializationError;
import org.junit.runners.model.Statement;
import org.junit.runners.parameterized.TestWithParameters;

import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
import java.util.List;

/**
 * @author Julien Viet
 */
public class VertxUnitRunnerWithParameters extends VertxUnitRunner {

  private final Object[] parameters;

  private final String name;

  protected VertxUnitRunnerWithParameters(TestWithParameters test) throws InitializationError {
    super(test.getTestClass().getJavaClass());
    parameters = test.getParameters().toArray(
        new Object[test.getParameters().size()]);
    name = test.getName();
  }

  @Override
  public Object createTest() throws Exception {
    if (fieldsAreAnnotated()) {
      return createTestUsingFieldInjection();
    } else {
      return createTestUsingConstructorInjection();
    }
  }

  private Object createTestUsingConstructorInjection() throws Exception {
    return getTestClass().getOnlyConstructor().newInstance(parameters);
  }

  private Object createTestUsingFieldInjection() throws Exception {
    List annotatedFieldsByParameter = getAnnotatedFieldsByParameter();
    if (annotatedFieldsByParameter.size() != parameters.length) {
      throw new Exception(
          "Wrong number of parameters and @Parameter fields."
              + " @Parameter fields counted: "
              + annotatedFieldsByParameter.size()
              + ", available parameters: " + parameters.length
              + ".");
    }
    Object testClassInstance = getTestClass().getJavaClass().newInstance();
    for (FrameworkField each : annotatedFieldsByParameter) {
      Field field = each.getField();
      Parameterized.Parameter annotation = field.getAnnotation(Parameterized.Parameter.class);
      int index = annotation.value();
      try {
        field.set(testClassInstance, parameters[index]);
      } catch (IllegalArgumentException iare) {
        throw new Exception(getTestClass().getName()
            + ": Trying to set " + field.getName()
            + " with the value " + parameters[index]
            + " that is not the right type ("
            + parameters[index].getClass().getSimpleName()
            + " instead of " + field.getType().getSimpleName()
            + ").", iare);
      }
    }
    return testClassInstance;
  }

  @Override
  protected String getName() {
    return name;
  }

  @Override
  protected String testName(FrameworkMethod method) {
    return method.getName() + getName();
  }

  @Override
  protected void validateConstructor(List errors) {
    validateOnlyOneConstructor(errors);
    if (fieldsAreAnnotated()) {
      validateZeroArgConstructor(errors);
    }
  }

  @Override
  protected void validateFields(List errors) {
    super.validateFields(errors);
    if (fieldsAreAnnotated()) {
      List annotatedFieldsByParameter = getAnnotatedFieldsByParameter();
      int[] usedIndices = new int[annotatedFieldsByParameter.size()];
      for (FrameworkField each : annotatedFieldsByParameter) {
        int index = each.getField().getAnnotation(Parameterized.Parameter.class)
            .value();
        if (index < 0 || index > annotatedFieldsByParameter.size() - 1) {
          errors.add(new Exception("Invalid @Parameter value: "
              + index + ". @Parameter fields counted: "
              + annotatedFieldsByParameter.size()
              + ". Please use an index between 0 and "
              + (annotatedFieldsByParameter.size() - 1) + "."));
        } else {
          usedIndices[index]++;
        }
      }
      for (int index = 0; index < usedIndices.length; index++) {
        int numberOfUse = usedIndices[index];
        if (numberOfUse == 0) {
          errors.add(new Exception("@Parameter(" + index
              + ") is never used."));
        } else if (numberOfUse > 1) {
          errors.add(new Exception("@Parameter(" + index
              + ") is used more than once (" + numberOfUse + ")."));
        }
      }
    }
  }

  @Override
  protected Statement classBlock(RunNotifier notifier) {
    return childrenInvoker(notifier);
  }

  @Override
  protected Annotation[] getRunnerAnnotations() {
    return new Annotation[0];
  }

  private List getAnnotatedFieldsByParameter() {
    return getTestClass().getAnnotatedFields(Parameterized.Parameter.class);
  }

  private boolean fieldsAreAnnotated() {
    return !getAnnotatedFieldsByParameter().isEmpty();
  }
}