Standardize test format

Tool for standardizing Java tests.

Is capable of migrating from Javadoc based property specification to the @DisplayName specification and back.

Usage

Convert tests with @DisplayName to Javadoc:

python -m standardize_test_format --javadoc --naming preserve --only-displayname -i <REPOSITORY_PATH>

It it recommended that you do this with no unstaged changes, to more easily verify the result.

You may need to call your formatting tool afterwards, as the converter doesn't take formatting into account.

Dependencies

This project requires Python 3.8 or newer.

This project does not have any library requirements 😎

Contributing

Feel free to submit pull requests. Please follow the Code Conventions when doing so.

Testing

Testing requires the pytest library.

Run tests with the following command:

pytest test

Test coverage can be run using the pytest-cov extension:

pytest --cov=standardize_test_format test

License

MIT License

Copyright (c) 2025 Jon Michael Aanes

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.