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 (@Test annotation, Assumptions, Assertions)
- Note: junit5 assertions take error message as last argument instead of first, causing a lot of changes.
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). This means in most cases, that any constructors with arguments have been removed and the arguments are instead passed directly to the tests.
- As a con, this means some @BeforeClass annotations could not be translated to junit5, as the fields they depend on no longer exist. As a result, in those cases relevant functions are now called at the beginning of each test. (Could be remedied later I believe)
Changed temporary folders from junit4 style to junit5 style (@Rule to @TempDir)
- Moved several input/output streams to try-with-resources statements (while seemingly unrelated, leaving them open was causing some issues with @TempDir on windows)
Changed conditional enable/disable annotations to junit5 style
- Moved static functions from deleted Conditional ignore rules to new AssumptionUtils class
Changed from junit4 @Category annotations to junit5 @Tag
No longer asserting throws with annotations, using assertThrows instead.
In many tests added logic to restore system properties after test execution (required now, because junit5 runs tests in different order than junit4, revealing errors like this).

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

parent-pom.xml

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

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

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

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

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

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

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

# 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

…s test

sfc-gh-astachowski · 2024-11-12T11:04:18Z

src/test/java/net/snowflake/client/jdbc/CallableStatementITBase.java

+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+
+public class CallableStatementITBase extends BaseJDBCTest {


This has been created to remove inheritance between CallableStatementIT and CallableStatementLatestIT in order to avoid duplicating tests.

sfc-gh-astachowski · 2024-11-12T11:18:47Z

src/test/java/net/snowflake/client/jdbc/DellBoomiCloudIT.java

@@ -25,6 +27,7 @@ public void setup() {
  }

  @Test
+  @Disabled


This test has serious isolation problems, and as far as I can tell was never actually ran. To be fixed later

let's add an issue for such problems and mark the tests with TODO comment with JIRA ID

sfc-gh-astachowski · 2024-11-12T11:29:38Z

src/test/java/net/snowflake/client/jdbc/PreparedStatement1IT.java

+import org.junit.jupiter.params.provider.ArgumentsSource;
+
+// @Category(TestCategoryStatement.class)
+@Tag(TestTags.STATEMENT)
 public class PreparedStatement1IT extends PreparedStatement0IT {


This class combines previous PreparedStatement1IT and PreparedStatementArrow1IT

sfc-gh-astachowski · 2024-11-12T11:32:38Z

src/test/java/net/snowflake/client/jdbc/PreparedStatement1LatestIT.java


 /**
 * PreparedStatement integration tests for the latest JDBC driver. This doesn't work for the oldest
 * supported driver. Revisit this tests whenever bumping up the oldest supported driver to examine
 * if the tests still are not applicable. If it is applicable, move tests to PreparedStatement1IT so
 * that both the latest and oldest supported driver run the tests.
 */
-@Category(TestCategoryStatement.class)
+// @Category(TestCategoryStatement.class)
+@Tag(TestTags.STATEMENT)
 public class PreparedStatement1LatestIT extends PreparedStatement0IT {


This class combines previous PreparedStatement1LatestIT and PreparedStatementArrow1LatestIT

sfc-gh-astachowski · 2024-11-12T11:33:38Z

src/test/java/net/snowflake/client/jdbc/PreparedStatement2IT.java

+import org.junit.jupiter.params.provider.ArgumentsSource;
+
+// @Category(TestCategoryStatement.class)
+@Tag(TestTags.STATEMENT)
 public class PreparedStatement2IT extends PreparedStatement0IT {


This class combines previous PreparedStatement2IT and PreparedStatementArrow2IT

sfc-gh-astachowski · 2024-11-12T13:27:32Z

src/test/java/net/snowflake/client/jdbc/ResultSetIT.java


 /** Test ResultSet */
-@Category(TestCategoryResultSet.class)
+// @Category(TestCategoryResultSet.class)
+@Tag(TestTags.RESULT_SET)
 public class ResultSetIT extends ResultSet0IT {


This now combines old ResultSetIT and ResultSetArrowIT

sfc-gh-astachowski · 2024-11-12T13:55:11Z

src/test/java/net/snowflake/client/jdbc/SnowflakeResultSetSerializableIT.java


 /** SnowflakeResultSetSerializable tests */
-@Category(TestCategoryResultSet.class)
+// @Category(TestCategoryResultSet.class)
+@Tag(TestTags.RESULT_SET)
 public class SnowflakeResultSetSerializableIT extends BaseJDBCTest {


This now handles both json and arrow tests

sfc-gh-dprzybysz · 2024-11-14T11:26:39Z

FIPS/pom.xml

+              <dependency>
+                <groupId>org.apache.maven.surefire</groupId>
+                <artifactId>surefire-junit-platform</artifactId>
+                <version>3.5.1</version>


let's add version to the properties - here and in other places in poms

sfc-gh-dprzybysz · 2024-11-14T11:29:01Z

ci/container/test_component.sh

        $MVNW_EXE -DjenkinsIT \
            -Djava.io.tmpdir=$WORKSPACE \
            -Djacoco.skip.instrument=false \
-            -DtestCategory=net.snowflake.client.category.$c \
+            -Dtest="$JDBC_TEST_CATEGORY" \


should we change the property name to JDBC_TEST_SUITES?
here and in other scripts?

Sure, I'll do that

sfc-gh-dprzybysz · 2024-11-14T11:33:04Z

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

+@Retention(RetentionPolicy.RUNTIME)
+@EnabledIfEnvironmentVariable(named = "SNOWFLAKE_TEST_ACCOUNT", matches = "testaccount")
+@DisabledIfEnvironmentVariable(named = "GITHUB_ACTIONS", matches = ".*")
+public @interface RunOnTestaccount {}


let's rename - run on test account not on github actions

sfc-gh-dprzybysz · 2024-11-14T11:34:23Z

src/test/java/net/snowflake/client/config/SFConnectionConfigParserTest.java

@@ -87,7 +86,7 @@ public void testThrowErrorWhenWrongPermissionsForConnectionConfigurationFile()
    File tokenFile = new File(Paths.get(tempPath.toString(), "token").toUri());
    prepareConnectionConfigurationTomlFile(
        Collections.singletonMap("token_file_path", tokenFile.toString()), false, false);
-    assumeFalse(RunningNotOnLinuxMac.isNotRunningOnLinuxMac());
+    assumeFalse(AssumptionUtils.isNotRunningOnLinuxMac());


can we replace the assumptions (here and in other places) with annotations?

I can investigate this, for now it is recreating 1:1 original behaviour. I think this can be addressed in a later PR

sfc-gh-dprzybysz · 2024-11-14T11:36:47Z

src/test/java/net/snowflake/client/core/IncidentUtilLatestIT.java


-@Category(TestCategoryCore.class)
+// @Category(TestCategoryCore.class)


let's remove categories annotations instead of commenting in all places

sfc-gh-dprzybysz · 2024-11-14T11:39:41Z

src/test/java/net/snowflake/client/core/OCSPCacheServerTest.java

  }

-  @Test
-  public void shouldChooseOcspCacheServerUrls() {
+  // @Parameterized.Parameters(


let's remove unnecessary comments

sfc-gh-dprzybysz · 2024-11-14T11:42:24Z

src/test/java/net/snowflake/client/jdbc/BaseWiremockTest.java

-import static org.junit.Assume.assumeNoException;
-import static org.junit.Assume.assumeTrue;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+// import static org.junit.jupiter.api.Assumptions.assumeNoException;


let's removed unnecessary code

sfc-gh-dprzybysz · 2024-11-14T11:49:55Z

src/test/java/net/snowflake/client/jdbc/DatabaseMetaDataLatestIT.java

            }

            try (ResultSet resultSet =
                databaseMetaData.getCrossReference(null, null, null, null, null, null)) {
-              assertThat(getSizeOfResultSet(resultSet), greaterThanOrEqualTo(2));
+              MatcherAssert.assertThat(getSizeOfResultSet(resultSet), greaterThanOrEqualTo(2));


can we import static MatcherAssert.assertThat?

sfc-gh-dprzybysz · 2024-11-14T12:24:57Z

src/test/java/net/snowflake/client/jdbc/ResultSetVectorLatestIT.java

@@ -164,7 +162,7 @@ public void testGetVectorViaGetStringIsEqualToTheGetObject() throws SQLException
        assertTrue(resultSet.next());
        assertGetObjectAndGetStringBeTheSame(resultSet, "[-1,5]", 1);
        String floatArrayRepresentation =
-            "json".equals(queryResultFormat)
+            "JSON".equals(queryResultFormat)


you can use equals ignore case

sfc-gh-dprzybysz · 2024-11-14T12:27:18Z

src/test/java/net/snowflake/client/jdbc/SnowflakeDriverLatestIT.java

@@ -1471,14 +1491,63 @@ public void testNoSpaceLeftOnDeviceException() throws SQLException {
  }

  @Test
-  @ConditionalIgnoreRule.ConditionalIgnore(condition = RunningOnGithubAction.class)
+  @Disabled // ignored until SNOW-1616480 is resolved


let's add a TODO to comment

# Conflicts: # parent-pom.xml

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 17 commits November 7, 2024 15:40

Removed unit tests from tests excluded from build

200fbb0

Reverted dependency version change

c6a1656

Added unit tests back to exclude from compilation list for old driver…

eed2726

…s test

Removed Core and Unit tests from old drivers tests

bdd0142

Changed a dependency

45a9394

Changed a dependency

f1299ed

Changed a dependency

2a94a10

Changed windows testing script to run multiple suites at once

fce902c

Restored old test names

9c4e457

Added copyright headers

70fbd2a

Removed empty file

a59bec7

Removed old ignore conditions and test categories

5729e22

Changed imports to assumptionUtil

49bfc08

Added missing copyright header

6f28e2e

Renamed format providers to result format providers

6f9ae50

Changed test annotation from junit4 to junit5

d35574f

Moved throw assertions to relevant lines

8fb4e63

sfc-gh-astachowski commented Nov 12, 2024

View reviewed changes

Added don't run on Github annotation

cb2239a

sfc-gh-dprzybysz reviewed Nov 14, 2024

View reviewed changes

sfc-gh-astachowski added 10 commits November 14, 2024 14:02

Merge branch 'master' into SNOW-1693588-upgrade-to-junit5

afaf5d6

# Conflicts: # parent-pom.xml

Added system properties in build

2e33f77

Temporary disable test

5aafdf2

Temporary disable tests

9197cd3

Script fix

dd672e0

Added TODO

994b956

Re-enabled to test

e63c961

Formatting

cca23d8

Disabled test with ticket attached

fa966fb

Switched from failsafe to surefire

8058d8e

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-astachowski Nov 12, 2024

sfc-gh-astachowski Nov 12, 2024

sfc-gh-dprzybysz Nov 14, 2024

sfc-gh-astachowski Nov 12, 2024

sfc-gh-astachowski Nov 12, 2024

sfc-gh-astachowski Nov 12, 2024

sfc-gh-astachowski Nov 12, 2024

sfc-gh-astachowski Nov 12, 2024

sfc-gh-dprzybysz Nov 14, 2024

sfc-gh-astachowski Nov 14, 2024

sfc-gh-dprzybysz Nov 14, 2024

sfc-gh-astachowski Nov 14, 2024

sfc-gh-dprzybysz Nov 14, 2024

sfc-gh-dprzybysz Nov 14, 2024

sfc-gh-astachowski Nov 14, 2024

sfc-gh-dprzybysz Nov 14, 2024

sfc-gh-dprzybysz Nov 14, 2024

sfc-gh-dprzybysz Nov 14, 2024

sfc-gh-dprzybysz Nov 14, 2024

sfc-gh-dprzybysz Nov 14, 2024

sfc-gh-dprzybysz Nov 14, 2024


		@Category(TestCategoryCore.class)
		// @Category(TestCategoryCore.class)

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

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