com.tngtech.junit.dataprovider.DataProviderInvocationContextProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of junit-jupiter-dataprovider Show documentation
A TestNG like dataprovider runner for JUnit Jupiter which is feature comparable to JUnit4 dataprovider.
The newest version!
/*
 * Copyright 2019 TNG Technology Consulting GmbH
 *
 * 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 com.tngtech.junit.dataprovider;

import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.util.stream.Stream;

import org.junit.jupiter.api.extension.ExtensionContext;
import org.junit.jupiter.api.extension.TestTemplateInvocationContext;

import com.tngtech.junit.dataprovider.convert.ConverterContext;
import com.tngtech.junit.dataprovider.convert.DataConverter;

/**
 * Abstract class which provides the default implementation for creating a custom dataprovider annotation that provides
 * the data directly within itself.
 *
 * @param  annotation type used to check support of this extension and create the invocation contexts
 *
 * @see DataProvider#value()
 * @see DataProviderExtension
 */
public abstract class DataProviderInvocationContextProvider
        extends AbstractDataProviderInvocationContextProvider {

    protected DataProviderInvocationContextProvider(Class annotationClass,
            DataConverter dataConverter) {
        super(annotationClass, dataConverter);
    }

    protected DataProviderInvocationContextProvider(Class annotationClass) {
        super(annotationClass);
    }

    @Override
    protected Stream provideInvocationContexts(ExtensionContext extensionContext,
            TEST_ANNOTATION testAnnotation) {
        Method testMethod = extensionContext.getRequiredTestMethod();
        return convertData(testMethod, getData(testAnnotation), getConverterContext(testAnnotation))
                .map(d -> new DataProviderInvocationContext(testMethod, d, getDisplayNameContext(testAnnotation)));
    }

    /**
     * @param annotation on the test method which is providing the test data; never {@code null}
     * @return the test data to be converted and used with the annotated test method; never {@code null}
     */
    protected abstract Object getData(TEST_ANNOTATION annotation);

    /**
     * @param annotation on the test method which is providing the converter context; never {@code null}
     * @return the converter context used to convert the data to be used with the annotated test method; never
     *         {@code null}
     */
    protected abstract ConverterContext getConverterContext(TEST_ANNOTATION annotation);

    /**
     * @param annotation on the test method which is used to determine the display name context; never {@code null}
     * @return the display name context used to create the display name of the test method; never {@code null}
     *
     * @see #getDefaultPlaceholders()
     */
    protected abstract DisplayNameContext getDisplayNameContext(TEST_ANNOTATION annotation);
}