Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide a session test framework for JUnit 5 #1086

Merged
merged 2 commits into from
May 5, 2024

Conversation

HeikoKlare
Copy link
Contributor

@HeikoKlare HeikoKlare commented Jan 11, 2024

The existing implementation of session tests (including SessionTestRunner, SessionTestSuite and WorkspaceSessionTestSuite) relies on JUnit 3 functionality. Because of the changed way in which tests are set up in JUnit 5, they cannot be used to run session tests with JUnit 5. In addition the session test framework is currently overly complex, as it provides some functionality that is not used (anymore).

This commit introduces a new JUnit 5 extension, the SessionTestExtension, to be used for running test cases of a class in
separate Eclipse application sessions with JUnit 5. This extension intercepts test methods calls to start a separate Eclipse session in which the tests are executed. The results are evaluated in the intercepted method execution in way they were evaluated for existing JUnit-3-based session tests. Session that are expected to fail can be annotated with an added @SessionShouldFail annotation.

Functionality is demonstrated in a manually executed sample session test.

Functionality is demonstrated in a manually executed sample session test as well as by application to the session test in the runtime tests project. Since JUnit 5 test suites are not yet supported, the project is adapted to execute tests without suites.
-> resolved via eclipse-tycho/tycho#3358

In order to get the session test running with Tycho, an adaptation of the test application provided via PDE is necessary, because a faulty class loader is currently used for the test engines during remote execution.
-> resolved via eclipse-pde/eclipse.pde#1047

Contributes to:

Copy link
Contributor

github-actions bot commented Jan 11, 2024

Test Results

 1 722 files   1 722 suites   1h 25m 39s ⏱️
 3 950 tests  3 928 ✅  22 💤 0 ❌
12 447 runs  12 286 ✅ 161 💤 0 ❌

Results for commit ff6f7f4.

♻️ This comment has been updated with latest results.

@HeikoKlare HeikoKlare force-pushed the session-tests-junit5 branch from 7944711 to 0a04276 Compare January 11, 2024 18:19
@HeikoKlare HeikoKlare force-pushed the session-tests-junit5 branch from 0a04276 to 6bf2a85 Compare January 15, 2024 15:00
@HeikoKlare HeikoKlare force-pushed the session-tests-junit5 branch 2 times, most recently from 8ec3d62 to bdcdcbd Compare January 31, 2024 07:11
@HeikoKlare HeikoKlare force-pushed the session-tests-junit5 branch from bdcdcbd to f559a77 Compare February 8, 2024 12:01
@HeikoKlare HeikoKlare force-pushed the session-tests-junit5 branch from f559a77 to a241a50 Compare March 8, 2024 13:58
@HeikoKlare HeikoKlare changed the title [WiP] Provide a session test framework for JUnit 5 Provide a session test framework for JUnit 5 Mar 8, 2024
@HeikoKlare HeikoKlare force-pushed the session-tests-junit5 branch from a241a50 to 7657ba3 Compare March 8, 2024 13:59
@HeikoKlare HeikoKlare force-pushed the session-tests-junit5 branch from 7657ba3 to 39241ad Compare April 24, 2024 15:03
@HeikoKlare HeikoKlare marked this pull request as ready for review April 24, 2024 15:53
@HeikoKlare
Copy link
Contributor Author

The migration of session tests to JUnit 5 requires several dependencies to be added to org.eclipse.core.tests.harness, as they have to be provided to ConfigurationSessionTestSuite to be able to run with JUnit 5. I am not in favor of having all these dependencies in the test harness bundle, but since the only alternative I see would be a separate bundle for the ConfigurationSessionTestSuite and the test harness bundle is only used internally anway, I think that adding these dependencies is acceptable. If anyone objects or has a proposal for improvement, please let me know. Otherwise I would like to merge this soon to be able to proceed the migration away from JUnit 3.

@HeikoKlare HeikoKlare force-pushed the session-tests-junit5 branch 4 times, most recently from d75f53b to 0004a63 Compare April 30, 2024 14:45
@HeikoKlare HeikoKlare marked this pull request as draft May 2, 2024 12:28
@HeikoKlare
Copy link
Contributor Author

PR is not ready to be merged because of faulty JUnit test result aggregation. GitHub reports 102 removed tests, which is because (existing, JUnit-3-based) session tests are not processed correctly when executed with a JUnit 5 runner. The test methods are not assigned to the their test class but to the running test suite, and since many session test methods are simply named test1, test2 etc., they "overwrite" each other in the logs when assigned to the same test suite. This particularly applies to the AllSessionTests suite, e.g.:

AutomatedResourceTests org.eclipse.core.tests.resources.session.AllSessionTests - test1

This subsumes multiple executions of a test1 method of all session test classes in AllSessionTests.

HeikoKlare added 2 commits May 3, 2024 12:16
The existing implementation of session tests (including
SessionTestRunner, SessionTestSuite and WorkspaceSessionTestSuite)
relies on JUnit 3 functionality. Because of the changed way in which
tests are set up in JUnit 5, they cannot be used to run session tests
with JUnit 5. In addition the session test framework is currently overly
complex, as it provides some functionality that is not used (anymore).

This commit introduces a new JUnit 5 extension, the
SessionTestExtension, to be used for running test cases of a class in
separate Eclipse application sessions with JUnit 5. This extension
intercepts test methods calls to start a separate Eclipse session in
which the tests are executed. The results are evaluated in the
intercepted method execution in way they were evaluated for existing
JUnit-3-based session tests. Session that are expected to fail can be
annotated with an added @SessionShouldFail annotation.

Functionality is demonstrated in a manually executed sample session
test.
@HeikoKlare HeikoKlare force-pushed the session-tests-junit5 branch from 0004a63 to ff6f7f4 Compare May 3, 2024 10:16
@HeikoKlare
Copy link
Contributor Author

PR is not ready to be merged because of faulty JUnit test result aggregation. GitHub reports 102 removed tests, which is because (existing, JUnit-3-based) session tests are not processed correctly when executed with a JUnit 5 runner. The test methods are not assigned to the their test class but to the running test suite, and since many session test methods are simply named test1, test2 etc., they "overwrite" each other in the logs when assigned to the same test suite.

Has been fixed via #1334 and #1335.

@HeikoKlare HeikoKlare marked this pull request as ready for review May 3, 2024 12:07
@HeikoKlare
Copy link
Contributor Author

This PR particularly affects the ConfigurationSessionTest class, which is why I checked all users of this class in the Eclipse SDK. I found all other users of that class to be in the Equinox repository. I executed those tests to validate that they all still run successfully.

image

@HeikoKlare HeikoKlare merged commit 692c8fa into eclipse-platform:master May 5, 2024
16 checks passed
@HeikoKlare HeikoKlare deleted the session-tests-junit5 branch May 5, 2024 18:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants