zentol commented on a change in pull request #18847: URL: https://github.com/apache/flink/pull/18847#discussion_r810945289
########## File path: flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/util/MiniClusterExtension.java ########## @@ -0,0 +1,340 @@ +/* + * 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.test.util; + +import org.apache.flink.annotation.Experimental; +import org.apache.flink.api.java.ExecutionEnvironment; +import org.apache.flink.client.program.ClusterClient; +import org.apache.flink.client.program.MiniClusterClient; +import org.apache.flink.client.program.rest.RestClusterClient; +import org.apache.flink.configuration.UnmodifiableConfiguration; +import org.apache.flink.runtime.minicluster.MiniCluster; +import org.apache.flink.runtime.testutils.MiniClusterResource; +import org.apache.flink.runtime.testutils.MiniClusterResourceConfiguration; +import org.apache.flink.streaming.api.environment.StreamExecutionEnvironment; +import org.apache.flink.streaming.util.TestStreamEnvironment; + +import org.junit.jupiter.api.TestFactory; +import org.junit.jupiter.api.extension.AfterAllCallback; +import org.junit.jupiter.api.extension.AfterEachCallback; +import org.junit.jupiter.api.extension.BeforeAllCallback; +import org.junit.jupiter.api.extension.BeforeEachCallback; +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.params.ParameterizedTest; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; +import java.net.URI; + +/** + * Starts a Flink {@link MiniCluster} and registers the respective {@link ExecutionEnvironment} and + * {@link StreamExecutionEnvironment} in the correct thread local environment. + * + * <p>Example usage: + * + * <pre>{@code + * @ExtendWith(MiniClusterExtension.class) + * class MyTest { + * @Test + * public void myTest() { + * ExecutionEnvironment execEnv = ExecutionEnvironment.getExecutionEnvironment(); + * } + * } + * }</pre> + * + * <p>Or to tune the {@link MiniCluster} parameters: + * + * <pre>{@code + * class MyTest { + * + * @RegisterExtension + * public static final MiniClusterExtension MINI_CLUSTER_RESOURCE = + * new MiniClusterExtension( + * new MiniClusterResourceConfiguration.Builder() + * .setNumberTaskManagers(1) + * .setConfiguration(new Configuration()) + * .build()); + * + * @Test + * public void myTest() { + * ExecutionEnvironment execEnv = ExecutionEnvironment.getExecutionEnvironment(); + * } + * } + * }</pre> + * + * <p>You can use parameter injection with the annotations {@link InjectMiniCluster}, {@link + * InjectClusterClient}, {@link InjectClusterRESTAddress}, {@link InjectClusterClientConfiguration}: + * + * <pre>{@code + * class MyTest { + * + * @RegisterExtension + * public static final MiniClusterExtension MINI_CLUSTER_RESOURCE = + * new MiniClusterExtension( + * new MiniClusterResourceConfiguration.Builder() + * .setNumberTaskManagers(1) + * .setConfiguration(new Configuration()) + * .build()); + * + * @Test + * public void myTest(@InjectMiniCluster MiniCluster miniCluster) { + * // Use miniCluster + * } + * + * @Test + * public void myTest(@InjectClusterClient ClusterClient<?> clusterClient) { + * // clusterClient here is an instance of MiniClusterClient + * } + * + * @Test + * public void myTest(@InjectClusterClient RestClusterClient<?> restClusterClient) { + * // Using RestClusterClient as parameter type will force the creation of a RestClusterClient, + * // rather than MiniClusterClient + * } + * } + * }</pre> + * + * <p>You can use it both with programmatic and declarative extension annotations. Check <a + * href="https://junit.org/junit5/docs/snapshot/user-guide/#extensions-registration>JUnit 5 docs</a> + * for more details. + * + * <p>This extension by default creates one {@link MiniCluster} per test class. If you need one + * instance of {@link MiniCluster} per test, we suggest you to instantiate it manually in your test + * code. + * + * <p>This extension works correctly with parallel tests and with parametrized tests, but it doesn't + * work when combining {@link TestFactory} and parallel tests, because of <a + * href="https://github.com/junit-team/junit5/issues/378";>some limitations</a>. Use {@link + * ParameterizedTest} instead. + */ +@Experimental +public class MiniClusterExtension + implements BeforeAllCallback, + BeforeEachCallback, + AfterEachCallback, + AfterAllCallback, + ParameterResolver { + + private static final ExtensionContext.Namespace NAMESPACE = + ExtensionContext.Namespace.create(MiniClusterExtension.class); + + private static final String CLUSTER_REST_CLIENT = "clusterRestClient"; + private static final String MINI_CLUSTER_CLIENT = "miniClusterClient"; + + /** + * Annotate a test method parameter with this annotation to inject the {@link MiniCluster} + * instance. + */ + @Target(ElementType.PARAMETER) + @Retention(RetentionPolicy.RUNTIME) + @Experimental + public @interface InjectMiniCluster {} + + /** + * Annotate a test method parameter with this annotation to inject the {@link ClusterClient} or + * the {@link RestClusterClient} instance. + */ + @Target(ElementType.PARAMETER) + @Retention(RetentionPolicy.RUNTIME) + @Experimental + public @interface InjectClusterClient {} Review comment: Having them as inner classes makes them surprisingly noisy (even more so if we had some in the InternalMiniClusterExtension). -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
