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

Remove unused test dependencies org.reflections & maven-rewrite #18798

Merged

Conversation

Philzen
Copy link
Contributor

@Philzen Philzen commented May 30, 2024

This PR:

  • removes dependency org.reflections
    …is not used anywhere
  • remove unused code and some minor optimizations for TestUtils
  • covers TestUtils.validatePomXmlFiles(List) with tests
    Yo, dawg, i heard you like tests, so i wrote some tests for your test helpers 😉 (well really it was to make sure the following step produced runtime behavior)
  • Reimplemented the method with Jackson XML mapper
    Although the RawPom.parse method implements tight checks by databinding to its own sophisticated pom POJO, it is really only the five assertions in TestUtils.validatePomXmlFiles(List) that we're after. rewrite-maven imports a whopping 73 MB onto the classpath with dozens of transitive dependencies having to be gulped by our IDEs – a little overkill just for a single test helper method.
  • Remove org.openrewrite:rewrite-maven and keep jackson-dataformat-xml explicitly (was a transitive dependency of rewrite-maven)
    NB: Open Rewrite (big fan here BTW) does not need to be included in the pom in order to use it – one can just use the "Maven command line" option tab on the recipe pages.

All in all, this brings down the number of total dependencies in the openapi-generator module from 143 to 105 🚀

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.6.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@Philzen Philzen marked this pull request as ready for review May 30, 2024 17:07
@Philzen Philzen requested a review from jimschubert as a code owner May 30, 2024 17:07
@Philzen Philzen force-pushed the remove-unused-test-dependencies branch from 52085e0 to 08d985a Compare May 30, 2024 23:38
@Philzen Philzen changed the title Remove unused test dependency org.reflections Remove unused test dependencies org.reflections & maven-rewrite May 30, 2024
@wing328
Copy link
Member

wing328 commented Jun 1, 2024

lgtm. thanks for the enhancement.

fyi @OpenAPITools/generator-core-team

@wing328 wing328 merged commit 66126a8 into OpenAPITools:master Jun 1, 2024
18 checks passed
@wing328 wing328 added this to the 7.7.0 milestone Jun 1, 2024
welshm pushed a commit to welshm/openapi-generator that referenced this pull request Jun 5, 2024
…penAPITools#18798)

* Specify exact relative path to parent pom.xml

* Remove org.reflections from the test stack

* Remove unused parameter

* Remove unused method

* Fix raw use of parameterized variable warning

* Use Files.readString instead of converting raw bytes

* Add test coverage for TestUtils.validatePomXmlFiles(List)

* Reimplement TestUtils.validatePomXmlFiles(List) with Jackson XML mapper

* Remove maven-rewrite dependency
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants