org.junitpioneer.jupiter.params.RangeSourceArgumentsProvider 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
The newest version!
/*
 * 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 java.lang.annotation.Annotation;
import java.lang.reflect.AnnotatedElement;
import java.lang.reflect.Parameter;
import java.util.List;
import java.util.Spliterator;
import java.util.Spliterators;
import java.util.stream.Stream;
import java.util.stream.StreamSupport;

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.junitpioneer.internal.PioneerAnnotationUtils;
import org.junitpioneer.jupiter.cartesian.CartesianParameterArgumentsProvider;

/**
 * Provides a range of {@link Number}s, as defined by an annotation which is its {@link ArgumentsSource}.
 * Such an annotation should have the following properties:
 *
 * 
 *     {@code from} a primitive value for the "start" of the range.
 *     {@code to} a primitive value for the "end" of the range. {@code to} must have the same type as {@code from}.
 *     {@code step} a primitive value for the difference between each two values of the range.
 *     {@code closed} a {@code boolean} value describing if the range includes the last value (closed), or not (open).
 * 
 *
 * @see IntRangeSource
 * @see ShortRangeSource
 * @see LongRangeSource
 * @see ByteRangeSource
 * @see DoubleRangeSource
 * @see FloatRangeSource
 */
class RangeSourceArgumentsProvider>
		implements ArgumentsProvider, CartesianParameterArgumentsProvider { //NOSONAR deprecated interface use will be removed in later release

	// Once the CartesianAnnotationConsumer is removed we can make this provider stateless.
	private Annotation argumentsSource;

	@Override
	public Stream provideArguments(ExtensionContext context, Parameter parameter) throws Exception {
		initArgumentsSource(parameter);
		return provideArguments(argumentsSource);
	}

	@Override
	public Stream provideArguments(ExtensionContext context) throws Exception {
		// argumentSource is present if fed through the CartesianAnnotationConsumer interface
		if (argumentsSource == null)
			// since it's a method annotation, the element will always be present
			initArgumentsSource(context.getRequiredTestMethod());

		return provideArguments(argumentsSource).map(Arguments::of);
	}

	@SuppressWarnings({ "unchecked", "rawtypes" })
	private Stream provideArguments(Annotation argumentsSource) throws Exception {
		Class argumentsSourceClass = argumentsSource.annotationType();
		Class rangeClass = argumentsSourceClass.getAnnotation(RangeClass.class).value();

		Range range = (Range) rangeClass.getConstructors()[0].newInstance(argumentsSource);
		range.validate();
		return asStream(range);
	}

	private void initArgumentsSource(AnnotatedElement element) {
		List argumentsSources = PioneerAnnotationUtils
				.findAnnotatedAnnotations(element, ArgumentsSource.class);

		if (argumentsSources.size() != 1) {
			String message = String
					.format("Expected exactly one annotation to provide an ArgumentSource, found %d.",
						argumentsSources.size());
			throw new IllegalArgumentException(message);
		}

		argumentsSource = argumentsSources.get(0);
	}

	private Stream asStream(Range range) {
		return StreamSupport.stream(Spliterators.spliteratorUnknownSize(range, Spliterator.ORDERED), false);
	}

}