SNOW-1693588 Upgrade to JUnit5 #1909

sfc-gh-astachowski · 2024-10-04T08:58:38Z

Overview

SNOW-1693588 upgraded all tests to junit5. There are a lot of changes, but most are of following types:

Changed imports to junit5
Changed annotations to their 1:1 counterparts ( @Before to @BeforeEach, @BeforeClass to @BeforeAll etc.)
Changed parametrisation from junit4 style (class level) to junit5 style (method level)
Changed temporary folders from junit4 style to junit5 style (@Rule to @TempDir)
Changed conditional enable/disable annotations to junit5 style

Pre-review self checklist

PR branch is updated with all the changes from master branch
The code is correctly formatted (run mvn -P check-style validate)
New public API is not unnecessary exposed (run mvn verify and inspect target/japicmp/japicmp.html)
The pull request name is prefixed with SNOW-XXXX:
Code is in compliance with internal logging requirements

sfc-gh-dprzybysz · 2024-10-09T08:23:53Z

parent-pom.xml

@@ -59,7 +59,8 @@
    <jna.version>5.13.0</jna.version>
    <joda.time.version>2.8.1</joda.time.version>
    <json.smart.version>2.4.9</json.smart.version>
-    <junit.version>4.13.2</junit.version>
+    <junit.version>5.11.1</junit.version>
+    <junit4.version>4.13.2</junit4.version>


in parent pom we don't neet junit4 anymore?

sfc-gh-dprzybysz · 2024-10-09T08:24:15Z

parent-pom.xml

      <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
-        <version>${junit.version}</version>
+        <version>${junit4.version}</version>


can we remove junit 4?

sfc-gh-dprzybysz · 2024-10-09T08:24:44Z

parent-pom.xml

@@ -257,10 +258,28 @@
        <artifactId>opencensus-api</artifactId>
        <version>${opencensus.version}</version>
      </dependency>
+      <dependency>
+        <groupId>org.junit.jupiter</groupId>
+        <artifactId>junit-jupiter-api</artifactId>


we are chaning the library - please start the security review for the new artifacts if not started

sfc-gh-dprzybysz · 2024-10-09T08:26:33Z

src/test/java/net/snowflake/client/ConditionalIgnoreRule.java

@@ -26,6 +26,7 @@
 import org.junit.runners.model.FrameworkMethod;
 import org.junit.runners.model.Statement;

+@Deprecated


we need to keep the depracated methods for the old driver tests? it's not our API so can we remove it even now?

We probably could. I recently noticed that some of their static methods are being used in assumptions, so I'll investigate what can be done about this (worst case we can extract the static methods to a util class)

src/test/java/net/snowflake/client/annotations/DontRunOnGithubActions.java

sfc-gh-dprzybysz · 2024-10-09T09:18:31Z

src/test/java/net/snowflake/client/jdbc/structuredtypes/ResultSetStructuredTypesLatestIT.java

@@ -39,81 +38,67 @@
 import net.snowflake.client.jdbc.structuredtypes.sqldata.NullableFieldsSqlData;
 import net.snowflake.client.jdbc.structuredtypes.sqldata.SimpleClass;
 import net.snowflake.client.jdbc.structuredtypes.sqldata.StringClass;
-import org.junit.After;
+import net.snowflake.client.providers.FormatProvider;
 import org.junit.Assume;


what about Assume usage? should we replace it with junit 5 equivalent?

Indeed we should, good catch

sfc-gh-dprzybysz · 2024-10-09T09:22:41Z

src/test/java/net/snowflake/client/providers/BooleanProvider.java

@@ -0,0 +1,13 @@
+package net.snowflake.client.providers;


Please add missing copyright header to the new files

sfc-gh-dprzybysz · 2024-10-09T09:23:05Z

src/test/java/net/snowflake/client/providers/FormatProvider.java

+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.ArgumentsProvider;
+
+public class FormatProvider implements ArgumentsProvider {


Let's rename to ResultFormatProvider

sfc-gh-dprzybysz · 2024-10-09T09:25:13Z

src/test/java/net/snowflake/client/providers/SimpleFormatProvider.java

+import org.junit.jupiter.api.extension.ExtensionContext;
+import org.junit.jupiter.params.provider.Arguments;
+
+public class SimpleFormatProvider extends SnowflakeArgumentsProvider {


I thought that it simple format for data time :) - can we rename this class to SimpleResultFormatProvider?

sfc-gh-dprzybysz · 2024-10-09T09:26:24Z

src/test/java/net/snowflake/client/providers/TimezoneProvider.java

+
+  @Override
+  protected List<Arguments> rawArguments(ExtensionContext context) {
+    return timeZones.subList(0, length);


we need length to just copy the list? cannot we just keep unmodifiable list in this class?

The idea here was to allow for some tests to easily get just a few of this. There were some long running tests that were originally running with 3-4 timezones only, and I decided not to double their execution time. Having said that, this is not useful when using it directly in the @ArgumentsSource annotation, only when using the cartesianProduct util

# Conflicts: # src/test/java/net/snowflake/client/jdbc/ClientMemoryLimitParallelIT.java # src/test/java/net/snowflake/client/jdbc/ConnectionIT.java # src/test/java/net/snowflake/client/jdbc/ConnectionLatestIT.java # src/test/java/net/snowflake/client/jdbc/DatabaseMetaDataIT.java # src/test/java/net/snowflake/client/jdbc/DatabaseMetaDataLatestIT.java # src/test/java/net/snowflake/client/jdbc/DatabaseMetaDataResultsetIT.java # src/test/java/net/snowflake/client/jdbc/MultiStatementLatestIT.java # src/test/java/net/snowflake/client/jdbc/OpenGroupCLIFuncIT.java # src/test/java/net/snowflake/client/jdbc/PreparedMultiStmtArrowIT.java # src/test/java/net/snowflake/client/jdbc/PreparedMultiStmtIT.java # src/test/java/net/snowflake/client/jdbc/SnowflakeDriverLatestIT.java # src/test/java/net/snowflake/client/jdbc/SnowflakeUtilTest.java # src/test/java/net/snowflake/client/jdbc/StreamLatestIT.java

…rization

…h tests were previously changed to being parameterized.

… parameterized

Initial upgrade

8956d3f

sfc-gh-astachowski requested a review from a team as a code owner October 4, 2024 08:58

sfc-gh-astachowski added 8 commits October 4, 2024 11:01

Formatting fix

fe34193

Formatting fix

4788157

Removed extra dependencies

ed62767

Changed temporary directories

c219985

Add explicit dependency on junit4

17c51ad

Add test scope to junit4

50ba1ca

Pom fix

c6db3ef

Added junit5 to test only pom

63eaf4b

sfc-gh-dprzybysz reviewed Oct 9, 2024

View reviewed changes

sfc-gh-astachowski added 19 commits October 9, 2024 15:41

Added junit5 engine and migrated Assumptions

3dd6e40

Formatting

8a503d5

Attempt to fix dependencies

9d71987

Attempt to fix dependencies

84a8c34

Removed junit4 entirely

4c72889

Formatting

af01a07

Fixed FIPS folder

7461ef5

Further fixes to FIPS

f5d91f4

Fixed package names

8dbb729

Changed to static imports

5e7a55e

Changed categories to tags

62864ef

Formatting

1a1b111

Added test suites (expected to fail on old driver at the moment)

b8add67

Fips fix

39d8383

Added dependencies for local testing

158dc3b

Merge with master

b18e508

Formatting

c418979

Added explicit junit4 dependency

bf3b1d0

sfc-gh-astachowski added 23 commits October 29, 2024 10:18

Removed test category from pom

b593608

Added explicit surefire provider

68805e9

Changed prepared statement tests to parameterized

335828e

Formatting

5f578b2

Merge master

4899819

Formatting

31023c4

Refactored result set serializable tests from inheritance to paramete…

4a97907

…rization

Refactored callable statement tests to avoid running a test twice

73ce0fd

Fixed assertions of array equality

704f86f

Changed asserting a properties value to setting and reverting it

c9b15df

Removed a class to avoid duplicating tests with parent class, in whic…

6295d2c

…h tests were previously changed to being parameterized.

Formatting

239f71c

Script changes

f8156ee

Added restoring static values in Session Util Test

aa592b1

Added restoring static values in Trust Manager Test

cabb3af

Ignore GCP test on Github Actions

b5f811c

Fixed testing script

e045c7e

Fixed testing script

37b6d16

Added closing input streams to Arrow Result Set IT

4d99bf7

Removed Result Set Arrow IT, as it's parent class has previously been…

52252f2

… parameterized

Temporarily disabled potentially problematic test

e9001e0

Formatting

ac43895

Temporarily disabled failing test

3d0a3b3

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

SNOW-1693588 Upgrade to JUnit5 #1909

SNOW-1693588 Upgrade to JUnit5 #1909

sfc-gh-astachowski commented Oct 4, 2024 •

edited

Loading

sfc-gh-dprzybysz Oct 9, 2024

sfc-gh-dprzybysz Oct 9, 2024

sfc-gh-dprzybysz Oct 9, 2024

sfc-gh-dprzybysz Oct 9, 2024

sfc-gh-astachowski Oct 9, 2024

sfc-gh-dprzybysz Oct 9, 2024

sfc-gh-astachowski Oct 9, 2024

sfc-gh-dprzybysz Oct 9, 2024

sfc-gh-dprzybysz Oct 9, 2024

sfc-gh-dprzybysz Oct 9, 2024

sfc-gh-dprzybysz Oct 9, 2024

sfc-gh-astachowski Oct 9, 2024

SNOW-1693588 Upgrade to JUnit5 #1909

Are you sure you want to change the base?

SNOW-1693588 Upgrade to JUnit5 #1909

Conversation

sfc-gh-astachowski commented Oct 4, 2024 • edited Loading

Overview

Pre-review self checklist

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sfc-gh-astachowski commented Oct 4, 2024 •

edited

Loading