org.junitpioneer.jupiter.CartesianProductTest Maven / Gradle / Ivy
/*
* 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.stream.Collectors.toList;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.stream.Stream;
import java.util.stream.StreamSupport;
import org.junit.jupiter.api.TestTemplate;
import org.junit.jupiter.api.extension.ExtendWith;
/**
* {@code @CartesianProductTest} is a JUnit Jupiter extension that marks
* a test to be executed with all possible input combinations.
*
* Methods annotated with this annotation should not be annotated with {@code Test}.
*
*
* This annotation is somewhat similar to {@code @ParameterizedTest}, as in it also takes
* arguments and can run the same test multiple times. With {@code @CartesianProductTest} you
* don't specify the test cases themselves. though. Instead you specify possible values for
* each test method parameter (see @{@link CartesianValueSource}) and the extension runs the
* method with each possible combination.
*
*
* You can specify a custom Display Name for the tests ran by {@code @CartesianProductTest}.
* By default it's [{index}] {arguments}.
*
*
* For more details and examples, see
* the documentation on @CartesianProductTest.
*
* @see org.junitpioneer.jupiter.CartesianValueSource
*
* @deprecated has been superseded by CartesianTest, scheduled to be removed in 2.0
* @since 1.0
*/
@TestTemplate
@ExtendWith(CartesianProductTestExtension.class)
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Deprecated
public @interface CartesianProductTest {
/**
* The display name to be used for individual invocations of the
* parameterized test; never blank or consisting solely of whitespace.
*
*
* Defaults to {@link org.junit.jupiter.params.ParameterizedTest#DEFAULT_DISPLAY_NAME}.
*
*
* Supported placeholders:
*
* - {@link org.junit.jupiter.params.ParameterizedTest#DISPLAY_NAME_PLACEHOLDER}
* - {@link org.junit.jupiter.params.ParameterizedTest#INDEX_PLACEHOLDER}
* - {@link org.junit.jupiter.params.ParameterizedTest#ARGUMENTS_PLACEHOLDER}
* - {0}, {1}, etc.: an individual argument (0-based)
*
* For the latter, you may use {@link java.text.MessageFormat} patterns
* to customize formatting.
*
*
* @see java.text.MessageFormat
* @see org.junit.jupiter.params.ParameterizedTest#name()
*/
String name() default "[{index}] {arguments}";
/**
* Specifies {@code String} values for all inputs simultaneously.
*/
String[] value() default {};
/**
* Specifies the name of the method that supplies the {@code Sets} for the test.
*/
String factory() default "";
/**
* Class for defining sets to a {@code CartesianProductTest} execution.
*
* @since 1.0
* @deprecated CartesianProductTest has been superseded by CartesianTest, scheduled to be removed in 2.0
*/
@Deprecated
class Sets {
private final List> sets = new ArrayList<>(); //NOSONAR
// recreate default constructor to prevent compiler warning
public Sets() {
}
/**
* Creates a single set of distinct objects (according to
* {@link Object#equals(Object)}) for a CartesianProductTest
* from the passed objects.
*
* @param entries the objects we want to include in a single set
* @return the {@code Sets} object, for fluent set definitions
*/
public Sets add(Object... entries) {
return addAll(Arrays.stream(entries));
}
/**
* Creates a single set of distinct objects (according to
* {@link Object#equals(Object)}) for a CartesianProductTest
* from the elements of the passed {@link Iterable}.
*
* @param entries the objects we want to include in a single set
* @return the {@code Sets} object, for fluent set definitions
*/
public Sets addAll(Iterable entries) {
return addAll(StreamSupport.stream(entries.spliterator(), false));
}
/**
* Creates a single set of distinct objects (according to
* {@link Object#equals(Object)}) for a CartesianProductTest
* from the elements of the passed {@link java.util.Collection}.
*
* The passed argument does not have to be an instance of {@link java.util.Set}.
*
* @param entries the objects we want to include in a single set
* @return the {@code Sets} object, for fluent set definitions
*/
public Sets addAll(Collection entries) {
return addAll(entries.stream());
}
/**
* Creates a single set of distinct objects (according to
* {@link Object#equals(Object)}) for a CartesianProductTest
* from the elements of the passed {@link java.util.stream.Stream}.
*
* @param entries the objects we want to include in a single set
* @return the {@code Sets} object, for fluent set definitions
*/
public Sets addAll(Stream entries) {
sets.add(entries.distinct().collect(toList()));
return this;
}
List> getSets() { //NOSONAR
return sets;
}
}
}