io.knotx.junit5.KnotxBaseExtension Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of knotx-junit5 Show documentation

Testing Knot.x with JUnit 5

There is a newer version: 2.4.0

/*
 * Copyright (C) 2018 Knot.x 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 io.knotx.junit5;

import com.typesafe.config.Config;
import io.vertx.core.json.JsonObject;
import java.lang.reflect.Field;
import java.util.List;
import org.junit.jupiter.api.extension.ExtensionContext;
import org.junit.jupiter.api.extension.ExtensionContext.Namespace;
import org.junit.jupiter.api.extension.ExtensionContext.Store;
import org.junit.jupiter.api.extension.ParameterContext;

/** Common methods for JUnit 5 extension classes */
public abstract class KnotxBaseExtension {

  protected Class getType(ParameterContext parameterContext) {
    return parameterContext.getParameter().getType();
  }

  protected Store getStore(ExtensionContext extensionContext) {
    return extensionContext.getStore(Namespace.create(this.getClass(), extensionContext));
  }

  protected String getClassName(ExtensionContext extensionContext) {
    return extensionContext.getTestClass().orElseThrow(IllegalStateException::new).getName();
  }

  protected String getMethodName(ParameterContext parameterContext) {
    return parameterContext.getDeclaringExecutable().getName();
  }

  protected String getParameterName(ParameterContext parameterContext) {
    return parameterContext.getParameter().getName();
  }

  public void addToOverrides(Config config, List overrides, String forReference) {}

  protected String getClassFieldName(ExtensionContext context, Field field) {
    return getClassName(context) + field.getName();
  }

  protected String getClassFieldName(ExtensionContext context, String parameterName) {
    return getClassName(context) + parameterName;
  }

  protected String getClassMethodParameterName(ExtensionContext context,
      ParameterContext parameterContext) {
    return getClassName(context) + getMethodName(parameterContext) + getParameterName(
        parameterContext);
  }
}