org.junitpioneer.jupiter.CartesianEnumArgumentsProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of junit-pioneer Show documentation
JUnit 5 Extension Pack
There is a newer version: 2.3.0
/*
 * Copyright 2016-2022 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;

import static java.util.Arrays.stream;
import static java.util.stream.Collectors.toSet;

import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.util.EnumSet;
import java.util.List;
import java.util.Set;
import java.util.stream.IntStream;
import java.util.stream.Stream;

import org.junit.jupiter.api.extension.ExtensionContext;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.ArgumentsProvider;
import org.junit.jupiter.params.provider.ArgumentsSource;
import org.junit.platform.commons.PreconditionViolationException;
import org.junitpioneer.internal.PioneerAnnotationUtils;

/**
 * This is basically an enhanced copy of Jupiter's {@code EnumArgumentsProvider},
 * except it does NOT support {@code @ParameterizedTest} and consumes a {@code Parameter}
 * instead of an annotation.
 *
 * @deprecated scheduled to be removed in 2.0
 */
@Deprecated
class CartesianEnumArgumentsProvider implements CartesianAnnotationConsumer, ArgumentsProvider { //NOSONAR deprecated interface use will be removed in later release

	private CartesianEnumSource enumSource;

	@Override
	public void accept(CartesianEnumSource enumSource) {
		this.enumSource = enumSource;
	}

	@Override
	public Stream provideArguments(ExtensionContext context) {
		Set> constants = getEnumConstants(context);
		CartesianEnumSource.Mode mode = enumSource.mode();
		String[] declaredConstantNames = enumSource.names();
		if (declaredConstantNames.length > 0) {
			Set uniqueNames = stream(declaredConstantNames).collect(toSet());

			if (uniqueNames.size() != declaredConstantNames.length)
				throw new PreconditionViolationException("Duplicate enum constant name(s) found in " + enumSource);

			mode.validate(enumSource, constants, uniqueNames);
			constants.removeIf(constant -> !mode.select(constant, uniqueNames));
		}
		return constants.stream().map(Arguments::of);
	}

	private > Set getEnumConstants(ExtensionContext context) {
		Class enumClass = determineEnumClass(context);
		return EnumSet.allOf(enumClass);
	}

	@SuppressWarnings({ "unchecked", "rawtypes" })
	private > Class determineEnumClass(ExtensionContext context) {
		Class enumClass = enumSource.value();
		if (enumClass.equals(NullEnum.class)) {
			Method method = context.getRequiredTestMethod();
			Class[] parameterTypes = method.getParameterTypes();

			if (parameterTypes.length <= 0)
				throw new PreconditionViolationException(
					"Test method must declare at least one parameter: " + method.toGenericString());

			Class parameterType = parameterTypes[determineParameterTypeIndex(method)];

			if (!Enum.class.isAssignableFrom(parameterType))
				throw new PreconditionViolationException(String
						.format(
							"Parameter of type %s must reference an Enum type (alternatively, use the annotation's 'value' attribute to specify the type explicitly): %s",
							parameterType, method.toGenericString()));

			enumClass = parameterType;
		}
		return enumClass;
	}

	private int determineParameterTypeIndex(Method method) {
		List argumentSources = PioneerAnnotationUtils
				.findAnnotatedAnnotations(method, ArgumentsSource.class);

		return IntStream
				.range(0, argumentSources.size())
				.filter(i -> enumSource == argumentSources.get(i))
				.findFirst()
				.orElseThrow(() -> new PreconditionViolationException("CartesianEnumSource annotation not found"));
	}

}