yuchengxin commented on code in PR #20145: URL: https://github.com/apache/flink/pull/20145#discussion_r917228844
########## flink-test-utils-parent/flink-test-utils-junit/src/main/java/org/apache/flink/testutils/junit/extensions/parameterized/ParameterizedTestExtension.java: ########## @@ -0,0 +1,250 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 org.apache.flink.testutils.junit.extensions.parameterized; + +import org.junit.jupiter.api.TestTemplate; +import org.junit.jupiter.api.extension.BeforeEachCallback; +import org.junit.jupiter.api.extension.Extension; +import org.junit.jupiter.api.extension.ExtensionContext; +import org.junit.jupiter.api.extension.ParameterContext; +import org.junit.jupiter.api.extension.ParameterResolutionException; +import org.junit.jupiter.api.extension.ParameterResolver; +import org.junit.jupiter.api.extension.TestTemplateInvocationContext; +import org.junit.jupiter.api.extension.TestTemplateInvocationContextProvider; +import org.junit.platform.commons.support.AnnotationSupport; +import org.junit.platform.commons.support.HierarchyTraversalMode; +import org.junit.runners.Parameterized; + +import java.lang.reflect.Field; +import java.lang.reflect.Method; +import java.text.MessageFormat; +import java.util.Arrays; +import java.util.Collection; +import java.util.Collections; +import java.util.List; +import java.util.function.Function; +import java.util.stream.Stream; + +/** + * This extension is used to implement parameterized tests for Junit 5 to replace {@link + * Parameterized}. + * + * <p>When use this extension, all tests must be annotated by {@link TestTemplate}. + */ +public class ParameterizedTestExtension implements TestTemplateInvocationContextProvider { + + private static final ExtensionContext.Namespace NAMESPACE = + ExtensionContext.Namespace.create("parameterized"); + private static final String PARAMETERS_STORE_KEY = "parameters"; + private static final String PARAMETER_FIELD_STORE_KEY_PREFIX = "parameterField_"; + + @Override + public boolean supportsTestTemplate(ExtensionContext context) { + return true; + } + + @Override + public Stream<TestTemplateInvocationContext> provideTestTemplateInvocationContexts( + ExtensionContext context) { + + // Search method annotated with @Parameters + final List<Method> parameterProviders = + AnnotationSupport.findAnnotatedMethods( + context.getRequiredTestClass(), + Parameters.class, + HierarchyTraversalMode.TOP_DOWN); + if (parameterProviders.isEmpty()) { + throw new IllegalStateException("Cannot find any parameter provider"); + } + if (parameterProviders.size() > 1) { + throw new IllegalStateException("Multiple parameter providers are found"); + } + + // Get potential test name + String testNameTemplate = parameterProviders.get(0).getAnnotation(Parameters.class).name(); + + // Get parameter values + final Object parameterValues; + try { + parameterValues = parameterProviders.get(0).invoke(null); + context.getStore(NAMESPACE).put(PARAMETERS_STORE_KEY, parameterValues); + } catch (Exception e) { + throw new IllegalStateException("Failed to invoke parameter provider", e); + } + assert parameterValues != null; + + // Parameter values could be Object[][] + if (parameterValues instanceof Object[][]) { + Object[][] typedParameterValues = (Object[][]) parameterValues; + return createContextForParameters( + Arrays.stream(typedParameterValues), testNameTemplate, context); + } + + // or a Collection + if (parameterValues instanceof Collection) { + final Collection<?> typedParameterValues = (Collection<?>) parameterValues; + final Stream<Object[]> parameterValueStream = + typedParameterValues.stream() + .map( + (Function<Object, Object[]>) + parameterValue -> { + if (parameterValue instanceof Object[]) { + return (Object[]) parameterValue; + } else { + return new Object[] {parameterValue}; + } + }); + return createContextForParameters(parameterValueStream, testNameTemplate, context); + } + + throw new IllegalStateException( + String.format( + "Return type of @Parameters annotated method \"%s\" should be either Object[][] or Collection", + parameterProviders.get(0))); + } + + private static class FieldInjectingInvocationContext implements TestTemplateInvocationContext { + + private final String testNameTemplate; + private final Object[] parameterValues; + + public FieldInjectingInvocationContext(String testNameTemplate, Object[] parameterValues) { + this.testNameTemplate = testNameTemplate; + this.parameterValues = parameterValues; + } + + @Override + public String getDisplayName(int invocationIndex) { + if (testNameTemplate.equals("{index}")) { Review Comment: I have set this magic string to a private static variable -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@flink.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
