All Downloads are FREE. Search and download functionalities are using the official Maven repository.
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.junitpioneer.jupiter.params.DisableIfArgumentExtension Maven / Gradle / Ivy
/*
* Copyright 2016-2023 the original author or authors.
*
* All rights reserved. This program and the accompanying materials are
* made available under the terms of the Eclipse Public License v2.0 which
* accompanies this distribution and is available at
*
* http://www.eclipse.org/legal/epl-v20.html
*/
package org.junitpioneer.jupiter.params;
import static java.lang.String.format;
import java.lang.reflect.Method;
import java.lang.reflect.Parameter;
import java.util.Arrays;
import java.util.List;
import java.util.function.Predicate;
import org.junit.jupiter.api.extension.ExtensionConfigurationException;
import org.junit.jupiter.api.extension.ExtensionContext;
import org.junit.jupiter.api.extension.InvocationInterceptor;
import org.junit.jupiter.api.extension.ParameterResolutionException;
import org.junit.jupiter.api.extension.ReflectiveInvocationContext;
import org.junit.platform.commons.support.AnnotationSupport;
import org.opentest4j.TestAbortedException;
class DisableIfArgumentExtension implements InvocationInterceptor {
@Override
public void interceptTestTemplateMethod(Invocation invocation,
ReflectiveInvocationContext invocationContext, ExtensionContext extensionContext) throws Throwable {
Method testMethod = extensionContext.getRequiredTestMethod();
List arguments = invocationContext.getArguments();
if (arguments.isEmpty())
throw new ExtensionConfigurationException(
format("Can't disable based on arguments, because method %s had no parameters.", testMethod.getName()));
checkRequiredAnnotations(testMethod);
// @formatter:off
AnnotationSupport
.findAnnotation(testMethod, DisableIfAllArguments.class)
.ifPresent(allParams -> {
verifyNonEmptyInputs(allParams);
ArgumentChecker.checkAll(arguments).matches(allParams.matches());
ArgumentChecker.checkAll(arguments).contains(allParams.contains());
});
AnnotationSupport
.findAnnotation(testMethod, DisableIfAnyArgument.class)
.ifPresent(anyParam -> {
verifyNonEmptyInputs(anyParam);
ArgumentChecker.checkAny(arguments).matches(anyParam.matches());
ArgumentChecker.checkAny(arguments).contains(anyParam.contains());
});
// @formatter:on
List annotations = AnnotationSupport
.findRepeatableAnnotations(testMethod, DisableIfArgument.class);
for (int i = 0; i < annotations.size(); i++) {
DisableIfArgument parameter = annotations.get(i);
verifyNonEmptyInputs(parameter);
Object argument = findArgument(testMethod, arguments, parameter, i);
ArgumentChecker.check(argument).matches(parameter.matches());
ArgumentChecker.check(argument).contains(parameter.contains());
}
invocation.proceed();
}
private static void checkRequiredAnnotations(Method testMethod) {
if (AnnotationSupport.findAnnotation(testMethod, DisableIfAnyArgument.class).isEmpty()
&& AnnotationSupport.findAnnotation(testMethod, DisableIfAllArguments.class).isEmpty()
&& AnnotationSupport.findRepeatableAnnotations(testMethod, DisableIfArgument.class).isEmpty()) {
throw new ExtensionConfigurationException(
"Required at least one of the following: @DisableIfArgument, @DisableIfAllArguments, @DisableIfAnyArgument but found none.");
}
}
private static void verifyNonEmptyInputs(DisableIfAllArguments annotation) {
if (annotation.contains().length > 0 == annotation.matches().length > 0)
throw invalidInputs(DisableIfAllArguments.class);
}
private static void verifyNonEmptyInputs(DisableIfAnyArgument annotation) {
if (annotation.contains().length > 0 == annotation.matches().length > 0)
throw invalidInputs(DisableIfAnyArgument.class);
}
private static void verifyNonEmptyInputs(DisableIfArgument annotation) {
if (annotation.contains().length > 0 == annotation.matches().length > 0)
throw invalidInputs(DisableIfArgument.class);
}
private static ExtensionConfigurationException invalidInputs(Class annotationClass) {
return new ExtensionConfigurationException(
format("%s requires that either `contains` or `matches` is set.", annotationClass.getSimpleName()));
}
private Object findArgument(Method testMethod, List arguments, DisableIfArgument annotation, int index) {
if (!annotation.name().isEmpty() && annotation.index() > -1)
throw new ExtensionConfigurationException(
"Using both name and index parameter targeting in a single @DisableIfArgument is not permitted.");
if (!annotation.name().isEmpty()) {
// get argument by name only works if information is present
if (testMethod.getParameters()[0].isNamePresent())
return findArgumentByName(testMethod, arguments, annotation.name());
else
throw new ParameterResolutionException(
format("%s: Could not resolve parameter by name (%s).", testMethod.getName(), annotation.name()));
}
// get argument by explicit index (if present)
if (annotation.index() > -1)
return findArgumentByIndex(arguments, annotation.index());
// get argument by annotation index (implicit)
return arguments.get(index);
}
private Object findArgumentByName(Method testMethod, List arguments, String name) {
return arguments.get(findParameterIndexFromName(testMethod, name));
}
private int findParameterIndexFromName(Method testMethod, String name) {
Parameter[] parameters = testMethod.getParameters();
for (int i = 0; i < parameters.length; i++)
if (parameters[i].getName().equals(name))
return i;
throw new ParameterResolutionException(
format("Could not find parameter named %s in test %s", name, testMethod));
}
private Object findArgumentByIndex(List arguments, int index) {
verifyValidIndex(arguments, index);
return arguments.get(index);
}
private void verifyValidIndex(List arguments, int index) {
if (index > arguments.size())
throw new ExtensionConfigurationException(
format("Annotation has invalid index [%s], should be less than %s", index, arguments.size()));
}
private static class ArgumentChecker {
private final List arguments;
private final boolean checkAny;
private ArgumentChecker(List arguments, boolean checkAny) {
this.arguments = arguments;
this.checkAny = checkAny;
}
static ArgumentChecker checkAll(List arguments) {
return new ArgumentChecker(arguments, false);
}
static ArgumentChecker checkAny(List arguments) {
return new ArgumentChecker(arguments, true);
}
static ArgumentChecker check(Object argument) {
return new ArgumentChecker(List.of(argument), true);
}
public void matches(String[] matches) {
Predicate check = argument -> Arrays.stream(matches).anyMatch(argument.toString()::matches);
if (checkAny)
matchAny(check);
else
matchAll(check);
}
private void matchAll(Predicate check) {
if (arguments.stream().allMatch(check))
throw new TestAbortedException(
"All arguments matched one or more regular expression(s) from the `matches` array.");
}
private void matchAny(Predicate check) {
if (arguments.stream().anyMatch(check))
throw new TestAbortedException(
"One or more arguments matched a regular expression from the `matches` array.");
}
public void contains(String[] contains) {
Predicate check = argument -> Arrays.stream(contains).anyMatch(argument.toString()::contains);
if (checkAny)
containsAny(check);
else
containsAll(check);
}
private void containsAll(Predicate check) {
if (arguments.stream().allMatch(check))
throw new TestAbortedException(
"All arguments contained one or more value(s) from the `contains` array.");
}
private void containsAny(Predicate check) {
if (arguments.stream().anyMatch(check))
throw new TestAbortedException("One or more arguments contained a value from the `contains` array.");
}
}
}
