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

Add dependency now works with empty maven projects #4006

Merged
merged 1 commit into from
Mar 12, 2024

Conversation

ammachado
Copy link
Contributor

What's changed?

AddDependency now works with empty maven projects

What's your motivation?

Refactor Spring Boot Starters

Anything in particular you'd like reviewers to focus on?

No

Anyone you would like to review specifically?

No

Have you considered any alternatives or workarounds?

N/A

Any additional context

N/A

Checklist

  • I've added unit tests to cover both positive and negative cases
  • I've read and applied the recipe conventions and best practices
  • I've used the IntelliJ IDEA auto-formatter on affected files

@timtebeek
Copy link
Contributor

Thanks for getting this started @ammachado ; I went over the changes but have a slight concern about what this change would mean when running against projects at scale, and would like to get your perspective on this before we merge.

Consider that we have a platform that allows folks to run migration recipes at scale, against an entire organization. Up to now folks are able to run for instance a Micronaut, Quarkus, or Spring migration against the entire organization, and not see any changes in projects without any Java classes, even if onlyIfUsing was empty (which is hopefully rare, and questionable).

With this change folks would start to see dependencies added where they were not added before in in-house starters or parent pom.xml files. I'm afraid that might surprise them in a negative way, or would need some compensating actions or documentation. What's your thought on this?

I'm wondering if we for instance might want to add an option that explicitly enables adding dependencies to projects without any Java classes, as it's presumably rare. But at the same time: not using onlyIfUsing should be rare as well, so I'm a bit on the fence here.

@sambsnyd sambsnyd merged commit 2967dcf into main Mar 12, 2024
1 check passed
@sambsnyd sambsnyd deleted the add-dep-to-empty-pom branch March 12, 2024 23:11
motu55 pushed a commit to motu55/rewrite that referenced this pull request Mar 14, 2024
sambsnyd added a commit that referenced this pull request Apr 1, 2024
…ti module maven projects (#4074)

* fix find maven dependencies for multi module maven projects

* revert to see if build is succesfull

* Defensive copy in addClasspathEntry so that it won't attempt to add an element to a read-only list

* Make `JavaParser.Builder#addClasspathEntry()` public

* Basic JSP support (#4075)

* Improve `UsesField`

* Improve `UsesField` a bit more

* Fix RenameVariable for variables referenced through type casts (#4082)

* Fix RenameVariable for variables referenced through type casts

* Add unit test

* Be explicit about null handling and types

---------

Co-authored-by: Tim te Beek <[email protected]>

* Java version equality should not be based on id.

Plugins create a JavaVersion per source set, but if they have the same fields excluding id they should be considered equal.

* `MethodMatcher`: Improve construction time performance

Avoid expensive regular expressions for simple and common cases.

* `MethodMatcher`: Optimize performance of common argument matching

* `XPathMatcher`: Implement attribute value conditions like `/a[@b='c']` (#4084)

Fixes: #4083

* Fix class cast exception in MarkIndividualDependency

* Add table and version matcher to Maven FindProperties (#4085)

The valuePattern allows use as DevCenter measurement, while the table enables custom visualizations. Target use is the `<jenkins.version>` used in Jenkins plugins.

* ensuring connection timeouts get wrapped by MavenDownloadingException (#4081)

* ensuring connection timeouts get wrapped by MavenDownloadingException

* polish

* removed a condition which I believe no longer made sense, and was causing tests to fail with latest changes

* Apply suggestions from code review

* adjusting so that IOExceptions can get caught and wrapped into MavenDownloadingException

* clarifying checked exception types for `sendRequest` and related methods

---------

Co-authored-by: Tim te Beek <[email protected]>

* HasMiniumJavaVersion

* Remove explicit `Properties.File#getContent()` method

While indeed the LST should not be modified by modifying a `List` returned by a getter, it is also not right for a getter to return a new list every time (e.g. by wrapping an internal field using `Collections.unmodifiableList()`.

This commit removes the explicit getter and wither and instead has these generated by Lombok. Further, the initial contents, as populated by the parser, are now wrapped using `Collections.unmodifiableList()` to avoid any situations, where the contents are directly modified.

* Add dependency now works with empty maven projects (#4006)

* Printable Recipe Datatables  (#4087)

* Added method to export datatable information as csv to RecipeRun class

* Wrapped column value in quotes to escape commas in value

* Refactored streams to iterative loops. Log exceptions through Execution Context error handler

* Added formatCsv method. Added logic to ensure directories exist before creating files

* Refactored export logic to be more testable. Added test for csv printing logic

* Failing test cases for Quarkus version matching using `metadataPattern`s

* Add another test case.

* Get the new tests passing

* License headers

* Optimize `JavaParser.Builder#addClasspathEntry()`

* Allow null argument to CommitMessage.message()

* Fix precondition application in UpgradeDependencyVersion.

I'm a bit confused as to how this recipe succeeded before I made this change. The whole visitor, not just the precondition, was wrapped in Preconditions.or().

* Refresh resolved dependencies if possible

---------

Co-authored-by: U808771 <[email protected]>
Co-authored-by: Sam Snyder <[email protected]>
Co-authored-by: Knut Wannheden <[email protected]>
Co-authored-by: Jonathan Schnéider <[email protected]>
Co-authored-by: René Grob <[email protected]>
Co-authored-by: Tim te Beek <[email protected]>
Co-authored-by: Nick McKinney <[email protected]>
Co-authored-by: Adriano Machado <[email protected]>
Co-authored-by: Ryan Hudson <[email protected]>
sambsnyd added a commit that referenced this pull request Apr 29, 2024
…ti module maven projects (#4074)

* fix find maven dependencies for multi module maven projects

* revert to see if build is succesfull

* Defensive copy in addClasspathEntry so that it won't attempt to add an element to a read-only list

* Make `JavaParser.Builder#addClasspathEntry()` public

* Basic JSP support (#4075)

* Improve `UsesField`

* Improve `UsesField` a bit more

* Fix RenameVariable for variables referenced through type casts (#4082)

* Fix RenameVariable for variables referenced through type casts

* Add unit test

* Be explicit about null handling and types

---------

Co-authored-by: Tim te Beek <[email protected]>

* Java version equality should not be based on id.

Plugins create a JavaVersion per source set, but if they have the same fields excluding id they should be considered equal.

* `MethodMatcher`: Improve construction time performance

Avoid expensive regular expressions for simple and common cases.

* `MethodMatcher`: Optimize performance of common argument matching

* `XPathMatcher`: Implement attribute value conditions like `/a[@b='c']` (#4084)

Fixes: #4083

* Fix class cast exception in MarkIndividualDependency

* Add table and version matcher to Maven FindProperties (#4085)

The valuePattern allows use as DevCenter measurement, while the table enables custom visualizations. Target use is the `<jenkins.version>` used in Jenkins plugins.

* ensuring connection timeouts get wrapped by MavenDownloadingException (#4081)

* ensuring connection timeouts get wrapped by MavenDownloadingException

* polish

* removed a condition which I believe no longer made sense, and was causing tests to fail with latest changes

* Apply suggestions from code review

* adjusting so that IOExceptions can get caught and wrapped into MavenDownloadingException

* clarifying checked exception types for `sendRequest` and related methods

---------

Co-authored-by: Tim te Beek <[email protected]>

* HasMiniumJavaVersion

* Remove explicit `Properties.File#getContent()` method

While indeed the LST should not be modified by modifying a `List` returned by a getter, it is also not right for a getter to return a new list every time (e.g. by wrapping an internal field using `Collections.unmodifiableList()`.

This commit removes the explicit getter and wither and instead has these generated by Lombok. Further, the initial contents, as populated by the parser, are now wrapped using `Collections.unmodifiableList()` to avoid any situations, where the contents are directly modified.

* Add dependency now works with empty maven projects (#4006)

* Printable Recipe Datatables  (#4087)

* Added method to export datatable information as csv to RecipeRun class

* Wrapped column value in quotes to escape commas in value

* Refactored streams to iterative loops. Log exceptions through Execution Context error handler

* Added formatCsv method. Added logic to ensure directories exist before creating files

* Refactored export logic to be more testable. Added test for csv printing logic

* Failing test cases for Quarkus version matching using `metadataPattern`s

* Add another test case.

* Get the new tests passing

* License headers

* Optimize `JavaParser.Builder#addClasspathEntry()`

* Allow null argument to CommitMessage.message()

* Fix precondition application in UpgradeDependencyVersion.

I'm a bit confused as to how this recipe succeeded before I made this change. The whole visitor, not just the precondition, was wrapped in Preconditions.or().

* Refresh resolved dependencies if possible

---------

Co-authored-by: U808771 <[email protected]>
Co-authored-by: Sam Snyder <[email protected]>
Co-authored-by: Knut Wannheden <[email protected]>
Co-authored-by: Jonathan Schnéider <[email protected]>
Co-authored-by: René Grob <[email protected]>
Co-authored-by: Tim te Beek <[email protected]>
Co-authored-by: Nick McKinney <[email protected]>
Co-authored-by: Adriano Machado <[email protected]>
Co-authored-by: Ryan Hudson <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants