Support parameterized tests at class-level with JUnit5 #9161

GianlucaPrincipini · 2023-11-26T10:19:17Z

Feature Request / Improvement

Closes #9210
The goal is to switch all imports to JUni5 imports and to use AssertJ-style assertions.

Since in Junit5 there is no way to parameterize a full test class yet (junit-team/junit5#878),
ParameterizedTestExtension extension class and Parameters / Parameter have been introduced.

lisirrx · 2023-11-28T13:06:48Z

I wonder if this workaround is good enough.
I'm working on #9073 which also encountered the same question.
And there are too many different tests depend on a base TableTestBase which has a constructor with a param that used for class level parameterizing. Many of these test classes also have their own class level parameterizing. 😂 It is very hard to extend these tests by dividing to 2 version

Maybe we need to discuss a plan to deal with this situation.

@nastra Could you like to help us by providing some suggestions?

nastra · 2023-11-28T20:45:18Z

parquet/src/test/java/org/apache/iceberg/parquet/TestDictionaryRowGroupFilter.java

-@RunWith(Parameterized.class)
-public class TestDictionaryRowGroupFilter {
+/**
+ * At time of development there's no out of the box way to implement a Parameterized BeforeEach in Junit5. 


I don't think we actually want to create multiple classes for each parameter. I think it would make sense to check how easy/complicated it is to support class-level parameterization with JUnit5 as I know that's not supported by default

maybe worth exploring whether junit-team/junit5#3157 (comment) would fit here by using a CustomParameterResolver

Hi @lisirrx @nastra , I met the same problem when I tried to solve #9079. Can we refer to Flink here, introduce a ParameterizedTestExtension?

If you agree with me, I'd like to create a PR to do this.

@wanglijie95 @nastra, ParameterizedTestExtension introduced in 4d381f8.
I put it in an util test package, but I think the best idea should be to move these utils in a shared module. Is it better to open a new issue to address it?

I personally think it is. Put it into a shared module so that it can be used in multiple modules. Besides, I think it's better to add a reference in the ParameterizedTestExtension's doc to indicate it was inspired from Apache Flink. WDYT?

I'd also like to hear @nastra 's thoughts.

+1, I think a shared module is better.
BTW, I will check if this approach fits the iceberg-core module.

CC: @cgpoh, you might be interested in this

lisirrx · 2023-12-04T06:14:15Z

parquet/src/test/java/org/apache/iceberg/parquet/TestDictionaryRowGroupFilter.java

  public void createInputFile() throws IOException {
-    File parquetFile = temp.newFile();


I encounter the same case in iceberg-core. I step into the newFile function and find it create a temp file with prefix junit, using File.createTempFile. May be we can use the File.createTempFile directly in our code here?

please check other code that was migrated to JUnit5 to see how this was handled

nastra · 2023-12-04T07:51:26Z

parquet/src/test/java/org/apache/iceberg/parquet/TestDictionaryRowGroupFilter.java

@@ -18,37 +18,13 @@
 */
 package org.apache.iceberg.parquet;

-import static org.apache.iceberg.avro.AvroSchemaUtil.convert;


these shouldn't change

Solved in 833e9bf.

nastra · 2023-12-04T11:08:45Z

@GianlucaPrincipini can you please run ./gradlew spotlessApply to fix the formatting?

nastra · 2023-12-04T12:25:44Z

parquet/src/test/java/org/apache/iceberg/utils/ParameterizedTestExtension.java

+ *
+ * <p>When use this extension, all tests must be annotated by {@link TestTemplate}.
+ */
+public class ParameterizedTestExtension implements TestTemplateInvocationContextProvider {


this should probably go into the tests under iceberg-api

Solved in 833e9bf

nastra · 2023-12-04T12:26:13Z

parquet/src/test/java/org/apache/iceberg/utils/ParameterizedTestExtension.java

+        } catch (Exception e) {
+            throw new IllegalStateException("Failed to invoke parameter provider", e);
+        }
+        assert parameterValues != null;


this should be Preconditions.checkState(..)

Solved in 653fec1

nastra · 2023-12-04T12:26:58Z

parquet/src/test/java/org/apache/iceberg/parquet/TestDictionaryRowGroupFilter.java

-import org.junit.runners.Parameterized;
-
-@RunWith(Parameterized.class)
+import org.junit.jupiter.api.Assumptions;


please use the AssertJ assumtions

Solved in 833e9bf

nastra · 2023-12-04T12:27:20Z

parquet/src/test/java/org/apache/iceberg/parquet/TestDictionaryRowGroupFilter.java

  }
+
+  @TempDir
+  public Path temp;


can be private

Solved in 6bfb542

…umptions

nastra · 2023-12-05T08:15:36Z

@GianlucaPrincipini I would probably rename this PR so that it directly addresses #9210 (because that's what it is doing here). We might also want to convert a few more parameterized tests to using this, just to make sure we're not missing anything

GianlucaPrincipini · 2023-12-05T21:38:10Z

@nastra, sounds ok to me. I will work on migrating some other class in the next few days

api/src/test/java/org/apache/iceberg/ParameterizedTestExtension.java

nastra · 2023-12-11T16:32:28Z

api/src/test/java/org/apache/iceberg/TestHelpers.java

+   * @param containedInMessage A String that should be contained by the thrown exception's message
+   * @param callable A Callable that is expected to throw the exception
+   */
+  public static void assertThrows(


why is this being added here? It looks like this is from AssertHelpers, which is deprecated. That being said, please revert changes against this file

I found that those were some duplicate assertThrow in parquet test utils package. I moved these duplicates in 833e9bf without noticing the deprecated ones. I fixed that in ea33322

api/src/test/java/org/apache/iceberg/ParameterizedTestExtension.java

nastra · 2023-12-12T08:14:50Z

api/src/test/java/org/apache/iceberg/ParameterizedTestExtension.java

+import java.util.List;
+import java.util.function.Function;
+import java.util.stream.Stream;
+import org.assertj.core.util.Preconditions;


this is actually the wrong import. Should be org.apache.iceberg.relocated.com.google.common.base.Preconditions

nastra · 2023-12-12T08:17:56Z

data/src/test/java/org/apache/iceberg/data/GenericAppenderHelper.java

  public GenericAppenderHelper(
-      Table table, FileFormat fileFormat, TemporaryFolder tmp, Configuration conf) {
+      Table table, FileFormat fileFormat, TemporaryFolder tmp, Configuration conf)


let's roll back these changes and focus only on adding the ParameterizedTestExtension and converting TestDictRowGroupFilter

nastra · 2023-12-12T08:19:59Z

@GianlucaPrincipini this PR now contains unfortunately more changes than I anticipated, so I would suggest to focus only on adding the ParameterizedTestExtension and converting TestDictRowGroupFilter. All the other changes can then be done in a separate PR.
Also there are a few checkstyle violations, so would be good to fix those as well.

Make sure to run ./gradlew clean build -x test -x integrationTest and ./gradlew spotlessApply locally.

…n.java Co-authored-by: Eduard Tudenhoefner <etudenhoefner@gmail.com>

nastra · 2023-12-13T07:50:13Z

@GianlucaPrincipini the PR still contains more changes than necessary. The scope of this PR is to add the parameterized test extensions and the conversion of TestDictRowGroupFilter. Can you please revert the changes in all the other files? Those can be done in a separate PR once this PR is merged

parquet/src/test/java/org/apache/iceberg/parquet/TestDictionaryRowGroupFilter.java

nastra · 2023-12-15T07:10:10Z

@Fokko @pvary could you review this one please? Once this is merged we can use it for #9185

pvary · 2023-12-15T15:38:52Z

parquet/src/test/java/org/apache/iceberg/parquet/TestDictionaryRowGroupFilter.java

-        NullPointerException.class,
-        "Cannot create expression literal from null",
-        () -> notStartsWith("col", null));
+    Assertions.assertThatThrownBy(() -> equal("col", null))


nit: Could we do a static import for this?

)

GianlucaPrincipini added 3 commits November 26, 2023 10:08

Migrate TestDictionaryRowGroupFilter

c71981c

Add some comments in TestDictionaryRowGroupFilter

f0d3c2b

Add change comment in TestDictionaryRowGroupFilter abstract class

b240d39

github-actions bot added the parquet label Nov 26, 2023

Restore final modifier in writerVersion

9cae9fc

nastra reviewed Nov 28, 2023

View reviewed changes

Add parameterized test extension for parquet parameterized tests

4d381f8

lisirrx reviewed Dec 4, 2023

View reviewed changes

nastra reviewed Dec 4, 2023

View reviewed changes

nastra mentioned this pull request Dec 4, 2023

Add JUnit5-equivalent of class-level parameterized tests #9210

Closed

pvary mentioned this pull request Dec 4, 2023

Flink 1.17: Create JUnit5 version of TestFlinkScan #9185

Merged

GianlucaPrincipini added 5 commits December 4, 2023 22:27

Use Preconditions.checkState instead of assert

653fec1

Tempdir is now private

6bfb542

Move parameterized test extension and utils in iceberg-api

f4f040a

Move TestHelpers from iceberg-parquet to iceberg-api, use assertj ass…

833e9bf

…umptions

Run spotlessApply

2fb4dc9

github-actions bot added API build labels Dec 4, 2023

lisirrx mentioned this pull request Dec 5, 2023

Core: Create JUnit5 version of TableTestBase #9217

Closed

nastra changed the title ~~iceberg-parquet: Switch tests to JUnit5 + AssertJ-style assertions~~ Add JUnit5-equivalent of class-level parameterized tests Dec 6, 2023

nastra changed the title ~~Add JUnit5-equivalent of class-level parameterized tests~~ Support parameterized tests at class-level with JUnit5 Dec 6, 2023

nastra reviewed Dec 7, 2023

View reviewed changes

api/src/test/java/org/apache/iceberg/ParameterizedTestExtension.java Show resolved Hide resolved

nastra reviewed Dec 11, 2023

View reviewed changes

GianlucaPrincipini added 4 commits December 11, 2023 22:11

Remove assertThrows in favor of Assertions.assertThatThrownBy

ea33322

Add newlines

5217c6c

Change license and set references to Flink code

d4dc6c7

Fix formatting

4ecdf80

nastra reviewed Dec 12, 2023

View reviewed changes

api/src/test/java/org/apache/iceberg/ParameterizedTestExtension.java Outdated Show resolved Hide resolved

nastra reviewed Dec 12, 2023

View reviewed changes

GianlucaPrincipini and others added 2 commits December 12, 2023 22:30

Update api/src/test/java/org/apache/iceberg/ParameterizedTestExtensio…

5d051c5

…n.java Co-authored-by: Eduard Tudenhoefner <etudenhoefner@gmail.com>

Revert non-related commits

7dd8885

github-actions bot removed the MR label Dec 12, 2023

GianlucaPrincipini added 2 commits December 12, 2023 22:38

Fix Preconditions import

39d0837

Fix checkstyle violations

eaf4c6d

Revert changes other than TestDictionaryRowGroupFilter

245e411

GianlucaPrincipini commented Dec 13, 2023

View reviewed changes

parquet/src/test/java/org/apache/iceberg/parquet/TestDictionaryRowGroupFilter.java Outdated Show resolved Hide resolved

FANNG1 mentioned this pull request Dec 14, 2023

[Improvement] Reduce Iceberg's test class files apache/gravitino#740

Closed

nastra requested a review from pvary December 15, 2023 07:08

nastra requested a review from Fokko December 15, 2023 15:28

pvary reviewed Dec 15, 2023

View reviewed changes

pvary approved these changes Dec 15, 2023

View reviewed changes

static import

d2cd285

nastra merged commit 892e47c into apache:main Dec 19, 2023
42 checks passed

nastra mentioned this pull request Dec 20, 2023

Spark 3:5 Migrate tests to JUnit5 in source directory #9342

Merged

1 task

lisirrx pushed a commit to lisirrx/iceberg that referenced this pull request Jan 4, 2024

API: Support parameterized tests at class-level with JUnit5 (apache#9161

d8d1e5e

)

geruh pushed a commit to geruh/iceberg that referenced this pull request Jan 26, 2024

API: Support parameterized tests at class-level with JUnit5 (apache#9161

55a8f04

)

rodmeneses added a commit to rodmeneses/iceberg that referenced this pull request Feb 19, 2024

API: Support parameterized tests at class-level with JUnit5 (apache#9161

f023f0c

)

devangjhabakh pushed a commit to cdouglas/iceberg that referenced this pull request Apr 22, 2024

API: Support parameterized tests at class-level with JUnit5 (apache#9161

ed1cb0b

)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support parameterized tests at class-level with JUnit5 #9161

Support parameterized tests at class-level with JUnit5 #9161

GianlucaPrincipini commented Nov 26, 2023 •

edited

Loading

lisirrx commented Nov 28, 2023

nastra Nov 28, 2023

nastra Nov 28, 2023 •

edited

Loading

wanglijie95 Nov 30, 2023

GianlucaPrincipini Nov 30, 2023

wanglijie95 Dec 1, 2023

lisirrx Dec 2, 2023

pvary Dec 4, 2023

lisirrx Dec 4, 2023

nastra Dec 4, 2023

nastra Dec 4, 2023

GianlucaPrincipini Dec 4, 2023

nastra commented Dec 4, 2023

nastra Dec 4, 2023

GianlucaPrincipini Dec 4, 2023

nastra Dec 4, 2023

GianlucaPrincipini Dec 4, 2023

nastra Dec 4, 2023

GianlucaPrincipini Dec 4, 2023

nastra Dec 4, 2023

GianlucaPrincipini Dec 4, 2023

nastra commented Dec 5, 2023

GianlucaPrincipini commented Dec 5, 2023

nastra Dec 11, 2023 •

edited

Loading

GianlucaPrincipini Dec 11, 2023

nastra Dec 12, 2023

nastra Dec 12, 2023 •

edited

Loading

nastra commented Dec 12, 2023 •

edited

Loading

nastra commented Dec 13, 2023

nastra commented Dec 15, 2023

pvary Dec 15, 2023

		public void createInputFile() throws IOException {
		File parquetFile = temp.newFile();

Support parameterized tests at class-level with JUnit5 #9161

Support parameterized tests at class-level with JUnit5 #9161

Conversation

GianlucaPrincipini commented Nov 26, 2023 • edited Loading

Feature Request / Improvement

lisirrx commented Nov 28, 2023

Choose a reason for hiding this comment

nastra Nov 28, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nastra commented Dec 4, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nastra commented Dec 5, 2023

GianlucaPrincipini commented Dec 5, 2023

nastra Dec 11, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nastra Dec 12, 2023 • edited Loading

Choose a reason for hiding this comment

nastra commented Dec 12, 2023 • edited Loading

nastra commented Dec 13, 2023

nastra commented Dec 15, 2023

Choose a reason for hiding this comment

GianlucaPrincipini commented Nov 26, 2023 •

edited

Loading

nastra Nov 28, 2023 •

edited

Loading

nastra Dec 11, 2023 •

edited

Loading

nastra Dec 12, 2023 •

edited

Loading

nastra commented Dec 12, 2023 •

edited

Loading