rzo1 opened a new pull request, #431:
URL: https://github.com/apache/opennlp/pull/431
Thank you for contributing to Apache OpenNLP.
In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:
### For all changes:
- [x] Is there a JIRA ticket associated with this PR? Is it referenced
in the commit message?
- [x] Does your PR title start with OPENNLP-XXXX where XXXX is the JIRA
number you are trying to resolve? Pay particular attention to the hyphen "-"
character.
- [x]} Has your PR been rebased against the latest commit within the target
branch (typically master)?
- [x] Is your initial contribution a single, squashed commit?
### For code changes:
- [x] Have you ensured that the full suite of tests is executed via mvn
clean install at the root opennlp folder?
- [ ] Have you written or updated unit tests to verify your changes?
- [x] If adding new dependencies to the code, are these dependencies
licensed in a way that is compatible for inclusion under [ASF
2.0](http://www.apache.org/legal/resolved.html#category-a)?
- [ ] If applicable, have you updated the LICENSE file, including the main
LICENSE file in opennlp folder?
- [ ] If applicable, have you updated the NOTICE file, including the main
NOTICE file found in opennlp folder?
### For documentation related changes:
- [x] Have you ensured that format looks appropriate for the output in which
it is rendered?
### Note:
Please ensure that once the PR is submitted, you check GitHub Actions for
build issues and submit an update to your PR as soon as possible.
------------------------
# What does this PR do?
This PR migrates the current JUnit 4 tests towards JUnit 5.
To do so, I conducted the following steps:
- Automatically convert JUnit 4 via
https://github.com/junit-pioneer/convert-junit4-to-junit5 (sadly, it doesn't
guarantee formatting)
- Format the converted classes according to the OpenNLP style guide via the
provided IntelliJ Formatter rules.
- Manually adjust test cases, in which an automatic conversion wasn't
possible due to method signature ambiquity (mostly eps/delta for float/double
comparisions, String comparisions with messages).
- Replacement of `@TemporaryFolder` rules with `@TempDir` and related
compensation code.
After the conversion I run a `mvn clean install -Pjacoco`:
```bash
[INFO] Scanning for projects...
[INFO]
------------------------------------------------------------------------
[INFO] Reactor Build Order:
[INFO]
[INFO] Apache OpenNLP Reactor
[INFO] Apache OpenNLP Tools
[INFO] Apache OpenNLP UIMA Annotators
[INFO] Apache OpenNLP Brat Annotator
[INFO] Apache OpenNLP Morfologik Addon
[INFO] Apache OpenNLP Documentation
[INFO] Apache OpenNLP Distribution
[INFO] opennlp-dl
[INFO]
[INFO]
------------------------------------------------------------------------
[INFO] Building Apache OpenNLP Reactor 2.0.1-SNAPSHOT
[INFO]
------------------------------------------------------------------------
...
[INFO] --- maven-surefire-plugin:2.22.2:test (default-test) @ opennlp-tools
---
[INFO]
[INFO] -------------------------------------------------------
[INFO] T E S T S
[INFO] -------------------------------------------------------
...
[INFO] Results:
[INFO]
[WARNING] Tests run: 810, Failures: 0, Errors: 0, Skipped: 1
...
[INFO]
[INFO] --- maven-surefire-plugin:2.22.2:test (default-test) @ opennlp-uima
---
[INFO]
[INFO] -------------------------------------------------------
[INFO] T E S T S
[INFO] -------------------------------------------------------
...
[INFO] Results:
[INFO]
[INFO] Tests run: 3, Failures: 0, Errors: 0, Skipped: 0
...
[INFO] --- maven-surefire-plugin:2.22.2:test (default-test) @
opennlp-morfologik-addon ---
[INFO]
[INFO] -------------------------------------------------------
[INFO] T E S T S
[INFO] -------------------------------------------------------
...
[INFO] Results:
[INFO]
[INFO] Tests run: 7, Failures: 0, Errors: 0, Skipped: 0
...
[INFO] --- maven-surefire-plugin:2.22.2:test (default-test) @ opennlp-dl ---
[INFO]
[INFO] -------------------------------------------------------
[INFO] T E S T S
[INFO] -------------------------------------------------------
...
[INFO] Results:
[INFO]
[INFO] Tests run: 2, Failures: 0, Errors: 0, Skipped: 0
```
Maven discovers and executes 810 (tools) + 3 (uima) + 7 (morfologik) + 2
(dl) = 822 tests (+1 skipped) via JUnit 5, which is similar to the current
master, which uses JUnit 4.
# Additional Notes
I know that a huge PR is very difficult to review, so the question would be:
- Shall we go on a per (a) package basis or per (b) module basis to reduce
review burden?
Breaking down the changes wouldn't be that hard.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
