You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by fa...@apache.org on 2024/04/25 01:31:24 UTC

(flink) 02/03: [FLINK-29050][test-utils] Use JUnit5 to re-write AbstractTestBase, JavaProgramTestBase MultipleProgramsTestBase and tag the corresponding old implementation classes as deprecated

This is an automated email from the ASF dual-hosted git repository.

fanrui pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git

commit 29a045574efd498ba0cb760845a459928c722531
Author: Roc Marshal <fl...@126.com>
AuthorDate: Mon Jun 26 21:43:51 2023 +0800

    [FLINK-29050][test-utils] Use JUnit5 to re-write AbstractTestBase, JavaProgramTestBase MultipleProgramsTestBase and tag the corresponding old implementation classes as deprecated
---
 .../flink/test/junit5/MiniClusterExtension.java    |  20 ++++
 ...ctTestBaseJUnit4.java => AbstractTestBase.java} |  36 +++----
 .../flink/test/util/AbstractTestBaseJUnit4.java    |   3 +
 ...estBaseJUnit4.java => JavaProgramTestBase.java} | 106 ++++++---------------
 .../flink/test/util/JavaProgramTestBaseJUnit4.java |   3 +
 ...seJUnit4.java => MultipleProgramsTestBase.java} |  32 +++----
 .../test/util/MultipleProgramsTestBaseJUnit4.java  |   3 +
 7 files changed, 89 insertions(+), 114 deletions(-)

diff --git a/flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/junit5/MiniClusterExtension.java b/flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/junit5/MiniClusterExtension.java
index 14838736146..db95d8e9a63 100644
--- a/flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/junit5/MiniClusterExtension.java
+++ b/flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/junit5/MiniClusterExtension.java
@@ -145,6 +145,8 @@ public final class MiniClusterExtension
 
     private InternalMiniClusterExtension internalMiniClusterExtension;
 
+    private TestEnvironment executionEnvironment;
+
     public MiniClusterExtension() {
         this(
                 new MiniClusterResourceConfiguration.Builder()
@@ -248,6 +250,10 @@ public final class MiniClusterExtension
         }
     }
 
+    public TestEnvironment getTestEnvironment() {
+        return this.executionEnvironment;
+    }
+
     // Implementation
 
     private void registerEnv(InternalMiniClusterExtension internalMiniClusterExtension) {
@@ -263,6 +269,12 @@ public final class MiniClusterExtension
                 new TestEnvironment(
                         internalMiniClusterExtension.getMiniCluster(), defaultParallelism, false);
         executionEnvironment.setAsContext();
+        this.executionEnvironment =
+                new TestEnvironment(
+                        internalMiniClusterExtension.getMiniCluster(),
+                        internalMiniClusterExtension.getNumberSlots(),
+                        false);
+        this.executionEnvironment.setAsContext();
         TestStreamEnvironment.setAsContext(
                 internalMiniClusterExtension.getMiniCluster(), defaultParallelism);
     }
@@ -292,6 +304,14 @@ public final class MiniClusterExtension
         return internalMiniClusterExtension.getClientConfiguration();
     }
 
+    public Integer getNumberSlots() {
+        return internalMiniClusterExtension.getNumberSlots();
+    }
+
+    public boolean isRunning() {
+        return internalMiniClusterExtension.getMiniCluster().isRunning();
+    }
+
     private static class CloseableParameter<T extends AutoCloseable>
             implements ExtensionContext.Store.CloseableResource {
         private final T autoCloseable;
diff --git a/flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/util/AbstractTestBaseJUnit4.java b/flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/util/AbstractTestBase.java
similarity index 80%
copy from flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/util/AbstractTestBaseJUnit4.java
copy to flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/util/AbstractTestBase.java
index dc3dfa761d6..b428d2e984c 100644
--- a/flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/util/AbstractTestBaseJUnit4.java
+++ b/flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/util/AbstractTestBase.java
@@ -18,14 +18,16 @@
 
 package org.apache.flink.test.util;
 
+import org.apache.flink.client.program.MiniClusterClient;
 import org.apache.flink.runtime.client.JobStatusMessage;
 import org.apache.flink.runtime.testutils.MiniClusterResourceConfiguration;
+import org.apache.flink.test.junit5.InjectClusterClient;
+import org.apache.flink.test.junit5.MiniClusterExtension;
 import org.apache.flink.util.FileUtils;
-import org.apache.flink.util.TestLogger;
 
-import org.junit.After;
-import org.junit.ClassRule;
-import org.junit.rules.TemporaryFolder;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.extension.RegisterExtension;
+import org.junit.jupiter.api.io.TempDir;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -57,34 +59,34 @@ import java.io.IOException;
  *
  * </pre>
  */
-public abstract class AbstractTestBaseJUnit4 extends TestLogger {
+public abstract class AbstractTestBase {
 
-    private static final Logger LOG = LoggerFactory.getLogger(AbstractTestBaseJUnit4.class);
+    private static final Logger LOG = LoggerFactory.getLogger(AbstractTestBase.class);
 
     private static final int DEFAULT_PARALLELISM = 4;
 
-    @ClassRule
-    public static final MiniClusterWithClientResource MINI_CLUSTER_RESOURCE =
-            new MiniClusterWithClientResource(
+    @RegisterExtension
+    public static final MiniClusterExtension MINI_CLUSTER_EXTENSION =
+            new MiniClusterExtension(
                     new MiniClusterResourceConfiguration.Builder()
                             .setNumberTaskManagers(1)
                             .setNumberSlotsPerTaskManager(DEFAULT_PARALLELISM)
                             .build());
 
-    @ClassRule public static final TemporaryFolder TEMPORARY_FOLDER = new TemporaryFolder();
+    @TempDir protected File temporaryFolder;
 
-    @After
-    public final void cleanupRunningJobs() throws Exception {
-        if (!MINI_CLUSTER_RESOURCE.getMiniCluster().isRunning()) {
-            // do nothing if the MiniCluster is not running
+    @AfterEach
+    public final void cleanupRunningJobs(@InjectClusterClient MiniClusterClient clusterClient)
+            throws Exception {
+        if (!MINI_CLUSTER_EXTENSION.isRunning()) {
             LOG.warn("Mini cluster is not running after the test!");
             return;
         }
 
-        for (JobStatusMessage path : MINI_CLUSTER_RESOURCE.getClusterClient().listJobs().get()) {
+        for (JobStatusMessage path : clusterClient.listJobs().get()) {
             if (!path.getJobState().isTerminalState()) {
                 try {
-                    MINI_CLUSTER_RESOURCE.getClusterClient().cancel(path.getJobId()).get();
+                    clusterClient.cancel(path.getJobId()).get();
                 } catch (Exception ignored) {
                     // ignore exceptions when cancelling dangling jobs
                 }
@@ -117,6 +119,6 @@ public abstract class AbstractTestBaseJUnit4 extends TestLogger {
     }
 
     public File createAndRegisterTempFile(String fileName) throws IOException {
-        return new File(TEMPORARY_FOLDER.newFolder(), fileName);
+        return new File(temporaryFolder, fileName);
     }
 }
diff --git a/flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/util/AbstractTestBaseJUnit4.java b/flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/util/AbstractTestBaseJUnit4.java
index dc3dfa761d6..498a755a718 100644
--- a/flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/util/AbstractTestBaseJUnit4.java
+++ b/flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/util/AbstractTestBaseJUnit4.java
@@ -56,7 +56,10 @@ import java.io.IOException;
  *   }
  *
  * </pre>
+ *
+ * @deprecated Use {@link AbstractTestBase} instead.
  */
+@Deprecated
 public abstract class AbstractTestBaseJUnit4 extends TestLogger {
 
     private static final Logger LOG = LoggerFactory.getLogger(AbstractTestBaseJUnit4.class);
diff --git a/flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/util/JavaProgramTestBaseJUnit4.java b/flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/util/JavaProgramTestBase.java
similarity index 61%
copy from flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/util/JavaProgramTestBaseJUnit4.java
copy to flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/util/JavaProgramTestBase.java
index 491f7359ea7..b503d096729 100644
--- a/flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/util/JavaProgramTestBaseJUnit4.java
+++ b/flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/util/JavaProgramTestBase.java
@@ -21,8 +21,10 @@ package org.apache.flink.test.util;
 import org.apache.flink.api.common.JobExecutionResult;
 import org.apache.flink.api.java.ExecutionEnvironment;
 
-import org.junit.Assert;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.AssertionsForClassTypes.fail;
 
 /**
  * Base class for unit tests that run a single test with object reuse enabled/disabled and against
@@ -34,7 +36,7 @@ import org.junit.Test;
  * <p>To skip the execution against collection environments you have to override {@link
  * #skipCollectionExecution()}.
  */
-public abstract class JavaProgramTestBaseJUnit4 extends AbstractTestBaseJUnit4 {
+public abstract class JavaProgramTestBase extends AbstractTestBase {
 
     private JobExecutionResult latestExecutionResult;
 
@@ -53,7 +55,7 @@ public abstract class JavaProgramTestBaseJUnit4 extends AbstractTestBaseJUnit4 {
     }
 
     public int getParallelism() {
-        return isCollectionExecution ? 1 : MINI_CLUSTER_RESOURCE.getNumberSlots();
+        return isCollectionExecution ? 1 : MINI_CLUSTER_EXTENSION.getNumberSlots();
     }
 
     public JobExecutionResult getLatestExecutionResult() {
@@ -86,92 +88,52 @@ public abstract class JavaProgramTestBaseJUnit4 extends AbstractTestBaseJUnit4 {
     public void testJobWithObjectReuse() throws Exception {
         isCollectionExecution = false;
 
-        // pre-submit
-        try {
-            preSubmit();
-        } catch (Exception e) {
-            System.err.println(e.getMessage());
-            e.printStackTrace();
-            Assert.fail("Pre-submit work caused an error: " + e.getMessage());
-        }
+        preSubmit();
 
         // This only works because the underlying ExecutionEnvironment is a TestEnvironment
         // We should fix that we are able to get access to the latest execution result from a
         // different
         // execution environment and how the object reuse mode is enabled
-        TestEnvironment env = MINI_CLUSTER_RESOURCE.getTestEnvironment();
+        TestEnvironment env = MINI_CLUSTER_EXTENSION.getTestEnvironment();
         env.getConfig().enableObjectReuse();
 
         // Possibly run the test multiple times
+        executeProgramMultipleTimes(env);
+    }
+
+    private void executeProgramMultipleTimes(ExecutionEnvironment env) throws Exception {
         for (int i = 0; i < numberOfTestRepetitions; i++) {
-            // call the test program
             try {
                 testProgram();
                 this.latestExecutionResult = env.getLastJobExecutionResult();
             } catch (Exception e) {
                 System.err.println(e.getMessage());
                 e.printStackTrace();
-                Assert.fail("Error while calling the test program: " + e.getMessage());
+                fail("Error while calling the test program: " + e.getMessage());
             }
 
-            Assert.assertNotNull(
-                    "The test program never triggered an execution.", this.latestExecutionResult);
+            assertThat(this.latestExecutionResult)
+                    .as("The test program never triggered an execution.")
+                    .isNotNull();
         }
 
-        // post-submit
-        try {
-            postSubmit();
-        } catch (Exception e) {
-            System.err.println(e.getMessage());
-            e.printStackTrace();
-            Assert.fail("Post-submit work caused an error: " + e.getMessage());
-        }
+        postSubmit();
     }
 
     @Test
     public void testJobWithoutObjectReuse() throws Exception {
         isCollectionExecution = false;
-
-        // pre-submit
-        try {
-            preSubmit();
-        } catch (Exception e) {
-            System.err.println(e.getMessage());
-            e.printStackTrace();
-            Assert.fail("Pre-submit work caused an error: " + e.getMessage());
-        }
+        preSubmit();
 
         // This only works because the underlying ExecutionEnvironment is a TestEnvironment
         // We should fix that we are able to get access to the latest execution result from a
         // different
         // execution environment and how the object reuse mode is enabled
-        ExecutionEnvironment env = MINI_CLUSTER_RESOURCE.getTestEnvironment();
+        ExecutionEnvironment env = MINI_CLUSTER_EXTENSION.getTestEnvironment();
         env.getConfig().disableObjectReuse();
 
         // Possibly run the test multiple times
-        for (int i = 0; i < numberOfTestRepetitions; i++) {
-            // call the test program
-            try {
-                testProgram();
-                this.latestExecutionResult = env.getLastJobExecutionResult();
-            } catch (Exception e) {
-                System.err.println(e.getMessage());
-                e.printStackTrace();
-                Assert.fail("Error while calling the test program: " + e.getMessage());
-            }
-
-            Assert.assertNotNull(
-                    "The test program never triggered an execution.", this.latestExecutionResult);
-        }
-
-        // post-submit
-        try {
-            postSubmit();
-        } catch (Exception e) {
-            System.err.println(e.getMessage());
-            e.printStackTrace();
-            Assert.fail("Post-submit work caused an error: " + e.getMessage());
-        }
+        executeProgramMultipleTimes(env);
     }
 
     @Test
@@ -184,15 +146,7 @@ public abstract class JavaProgramTestBaseJUnit4 extends AbstractTestBaseJUnit4 {
 
         isCollectionExecution = true;
 
-        // pre-submit
-        try {
-            preSubmit();
-        } catch (Exception e) {
-            System.err.println(e.getMessage());
-            e.printStackTrace();
-            Assert.fail("Pre-submit work caused an error: " + e.getMessage());
-        }
-
+        preSubmit();
         // prepare the test environment
         CollectionTestEnvironment env = new CollectionTestEnvironment();
         env.setAsContext();
@@ -204,21 +158,15 @@ public abstract class JavaProgramTestBaseJUnit4 extends AbstractTestBaseJUnit4 {
         } catch (Exception e) {
             System.err.println(e.getMessage());
             e.printStackTrace();
-            Assert.fail("Error while calling the test program: " + e.getMessage());
+            fail("Error while calling the test program: " + e.getMessage());
         } finally {
-            MINI_CLUSTER_RESOURCE.getTestEnvironment().setAsContext();
+            MINI_CLUSTER_EXTENSION.getTestEnvironment().setAsContext();
         }
 
-        Assert.assertNotNull(
-                "The test program never triggered an execution.", this.latestExecutionResult);
+        assertThat(this.latestExecutionResult)
+                .as("The test program never triggered an execution.")
+                .isNotNull();
 
-        // post-submit
-        try {
-            postSubmit();
-        } catch (Exception e) {
-            System.err.println(e.getMessage());
-            e.printStackTrace();
-            Assert.fail("Post-submit work caused an error: " + e.getMessage());
-        }
+        postSubmit();
     }
 }
diff --git a/flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/util/JavaProgramTestBaseJUnit4.java b/flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/util/JavaProgramTestBaseJUnit4.java
index 491f7359ea7..98c888c6ad7 100644
--- a/flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/util/JavaProgramTestBaseJUnit4.java
+++ b/flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/util/JavaProgramTestBaseJUnit4.java
@@ -33,7 +33,10 @@ import org.junit.Test;
  *
  * <p>To skip the execution against collection environments you have to override {@link
  * #skipCollectionExecution()}.
+ *
+ * @deprecated Use {@link JavaProgramTestBase} instead.
  */
+@Deprecated
 public abstract class JavaProgramTestBaseJUnit4 extends AbstractTestBaseJUnit4 {
 
     private JobExecutionResult latestExecutionResult;
diff --git a/flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/util/MultipleProgramsTestBaseJUnit4.java b/flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/util/MultipleProgramsTestBase.java
similarity index 83%
copy from flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/util/MultipleProgramsTestBaseJUnit4.java
copy to flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/util/MultipleProgramsTestBase.java
index c0cda807171..19628a09b32 100644
--- a/flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/util/MultipleProgramsTestBaseJUnit4.java
+++ b/flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/util/MultipleProgramsTestBase.java
@@ -18,9 +18,11 @@
 
 package org.apache.flink.test.util;
 
-import org.junit.After;
-import org.junit.Before;
-import org.junit.runners.Parameterized;
+import org.apache.flink.testutils.junit.extensions.parameterized.Parameter;
+import org.apache.flink.testutils.junit.extensions.parameterized.Parameters;
+
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
 
 import java.util.Arrays;
 import java.util.Collection;
@@ -50,7 +52,7 @@ import java.util.Collection;
  *
  * }</pre>
  */
-public class MultipleProgramsTestBaseJUnit4 extends AbstractTestBaseJUnit4 {
+public class MultipleProgramsTestBase extends AbstractTestBase {
 
     /**
      * Enum that defines which execution environment to run the next test on: An embedded local
@@ -64,31 +66,27 @@ public class MultipleProgramsTestBaseJUnit4 extends AbstractTestBaseJUnit4 {
 
     // ------------------------------------------------------------------------
 
-    protected final TestExecutionMode mode;
-
-    public MultipleProgramsTestBaseJUnit4(TestExecutionMode mode) {
-        this.mode = mode;
-    }
+    @Parameter protected TestExecutionMode mode;
 
     // ------------------------------------------------------------------------
     //  Environment setup & teardown
     // ------------------------------------------------------------------------
 
-    @Before
+    @BeforeEach
     public void setupEnvironment() {
         TestEnvironment testEnvironment;
         switch (mode) {
             case CLUSTER:
                 // This only works because of the quirks we built in the TestEnvironment.
                 // We should refactor this in the future!!!
-                testEnvironment = MINI_CLUSTER_RESOURCE.getTestEnvironment();
+                testEnvironment = MINI_CLUSTER_EXTENSION.getTestEnvironment();
                 testEnvironment.getConfig().disableObjectReuse();
                 testEnvironment.setAsContext();
                 break;
             case CLUSTER_OBJECT_REUSE:
                 // This only works because of the quirks we built in the TestEnvironment.
                 // We should refactor this in the future!!!
-                testEnvironment = MINI_CLUSTER_RESOURCE.getTestEnvironment();
+                testEnvironment = MINI_CLUSTER_EXTENSION.getTestEnvironment();
                 testEnvironment.getConfig().enableObjectReuse();
                 testEnvironment.setAsContext();
                 break;
@@ -98,7 +96,7 @@ public class MultipleProgramsTestBaseJUnit4 extends AbstractTestBaseJUnit4 {
         }
     }
 
-    @After
+    @AfterEach
     public void teardownEnvironment() {
         switch (mode) {
             case CLUSTER:
@@ -115,10 +113,8 @@ public class MultipleProgramsTestBaseJUnit4 extends AbstractTestBaseJUnit4 {
     //  Parametrization lets the tests run in cluster and collection mode
     // ------------------------------------------------------------------------
 
-    @Parameterized.Parameters(name = "Execution mode = {0}")
-    public static Collection<Object[]> executionModes() {
-        return Arrays.asList(
-                new Object[] {TestExecutionMode.CLUSTER},
-                new Object[] {TestExecutionMode.COLLECTION});
+    @Parameters(name = "Execution mode = {0}")
+    public static Collection<TestExecutionMode> executionModes() {
+        return Arrays.asList(TestExecutionMode.CLUSTER, TestExecutionMode.COLLECTION);
     }
 }
diff --git a/flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/util/MultipleProgramsTestBaseJUnit4.java b/flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/util/MultipleProgramsTestBaseJUnit4.java
index c0cda807171..40eac84b8c6 100644
--- a/flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/util/MultipleProgramsTestBaseJUnit4.java
+++ b/flink-test-utils-parent/flink-test-utils/src/main/java/org/apache/flink/test/util/MultipleProgramsTestBaseJUnit4.java
@@ -49,7 +49,10 @@ import java.util.Collection;
  * }
  *
  * }</pre>
+ *
+ * @deprecated Use {@link MultipleProgramsTestBase} instead.
  */
+@Deprecated
 public class MultipleProgramsTestBaseJUnit4 extends AbstractTestBaseJUnit4 {
 
     /**