[MPH-183] Effective POM path to source #37

jjkester · 2021-11-01T19:52:27Z

The goal of MPH-183 is to print via which BOM(s) a dependency got in the effective POM.

Related MNG-7344 PR that introduces the necessary changes in the model: apache/maven#603

Method for retrieving the hierarchical data from the InputSource is loaded with reflection. This way there is no behavior change for Maven versions below 4.0.0-alpha-1 with the new version of the plugin.

Handle integration test gracefully when running on a version of Maven that does not support the introduced functionality

Following this checklist to help us incorporate your
contribution quickly and easily:

Make sure there is a JIRA issue filed
for the change (usually before you start working on it). Trivial changes like typos do not
require a JIRA issue. Your pull request should address just this issue, without
pulling in other changes.
Each commit in the pull request should have a meaningful subject line and body.
Format the pull request title like [MPH-XXX] - Fixes bug in ApproximateQuantiles,
where you replace MPH-XXX with the appropriate JIRA issue. Best practice
is to use the JIRA issue title in the pull request title and in the first line of the
commit message.
Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
Run mvn clean verify to make sure basic checks pass. A more thorough check will
be performed on your pull request automatically.
You have run the integration tests successfully (mvn -Prun-its clean verify).

If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.

To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

I hereby declare this contribution to be licenced under the Apache License Version 2.0, January 2004
In any other case, please file an Apache Individual Contributor License Agreement.

src/it/projects/effective-pom-with-bom/invoker.properties

src/it/projects/effective-pom-with-bom/test.properties

src/main/java/org/apache/maven/plugins/help/EffectivePomMojo.java

mthmulders

Looks good to me. Happy to see the unhappy paths (e.g. running older Maven versions) are handled gracefully.

Let's wait for a build of Maven Core that adds this feature (apache/maven#603) so we can test-drive this feature once more before merging.

… boms

hboutemy · 2024-04-01T17:31:58Z

src/main/java/org/apache/maven/plugins/help/DefaultInputLocationFormatter.java

+import org.codehaus.plexus.util.StringUtils;
+
+/**
+ * Maven 3.x-based implementation of {@link InputLocation.StringFormatter}.


it's not Maven 3, it"s "without import tracking", as I hope we'll have import tracking for Maven 3 too

Agreed, we should probably change the name of the class and edit the JDocs. We would like to backport it to Maven 3, but initially want to make it work for Maven 4 first without breaking other versions.

hboutemy · 2024-04-01T17:34:17Z

src/main/java/org/apache/maven/plugins/help/ImportedFromLocationFormatter.java

+        try {
+            InputLocation result = (InputLocation) getImportedFromMethod.invoke(location);
+
+            if (result == null && project != null) {


I don't get why we do all this: if the current location is not the result of an import, why are we trying to do something?

When there is an importedFrom on the current dependency we can simply return the result, if there is not an importedFrom on the current dependency we try to find a match in the dependencies of dependencyManagement

hboutemy · 2024-04-01T17:37:00Z

src/main/java/org/apache/maven/plugins/help/ImportedFromLocationFormatter.java

+            InputLocation result = (InputLocation) getImportedFromMethod.invoke(location);
+
+            if (result == null && project != null) {
+                for (Dependency dependency : project.getDependencyManagement().getDependencies()) {


MNG-7344 is not supposed to be limited to dependencyManagement import, but be able to work with imports done for example by Tiles Maven Plugin. Then iterating only on dependencyManagement is suspect

notice that this opens again the question of what is the purpose of trying to do something if there war no importFrom in location

I've no experience with the maven tiles plugin. If this results in the same model (which I assume it does) it probably would still work, we would have to test this though.

hboutemy · 2024-04-01T17:39:56Z

src/main/java/org/apache/maven/plugins/help/ImportedFromLocationFormatter.java

+ * Implementation of {@link InputLocation.StringFormatter}. Enhances the default implementation with support for
+ * following "references" (caused by e.g. dependency management imports).
+ */
+public class ImportedFromLocationFormatter extends InputLocation.StringFormatter {


if this class was only working on import tracking, and be injected in DefaultLocationFormatter if proper InputLocation API was found, this would IMHO clarify the purpose of this addition, that keeps using the initial location tracking

We thought it would make sense to separate the actual display logic from the logic on whether or not to use the correct formatter. We could change that but it would bundle more logic in to 1 bigger class?

hboutemy · 2024-04-01T21:15:38Z

src/main/java/org/apache/maven/plugins/help/ImportedFromLocationFormatter.java

+
+        while (importedFrom != null
+                && !source.toString().equals(importedFrom.getSource().toString())) {
+            p.append(" from ").append(importedFrom.getSource().getModelId());


we also need the line, to know where the import has been done: there may be multiple ones in a source

If I understand your comment correctly, we print the line in the return statement (line 67).
If we have a project like:

bom1 -> dependency x (line 12) ^ | bom2 -> import bom1 ^ | project -> import bom2

The output of the effective pom of this project's dependency shows bom1, line 12 from bom2

jjkester changed the title ~~Mph 183 effective pom path to source~~ [MPH-183] Effective POM path to source Nov 1, 2021

jjkester mentioned this pull request Nov 1, 2021

[MNG-7344] track dependencyManagement import location in effective Model for MPH-183 apache/maven#603

Open

10 tasks

jjkester force-pushed the MPH-183_effective-pom-path-to-source branch from 2333232 to 4391032 Compare November 1, 2021 20:07

mthmulders requested changes Nov 2, 2021

View reviewed changes

jjkester force-pushed the MPH-183_effective-pom-path-to-source branch from 4391032 to 307fd9a Compare November 2, 2021 17:17

jjkester requested a review from mthmulders November 2, 2021 19:35

mthmulders approved these changes Nov 2, 2021

View reviewed changes

mthmulders force-pushed the MPH-183_effective-pom-path-to-source branch from 307fd9a to e467844 Compare July 5, 2022 13:51

juulhobert force-pushed the MPH-183_effective-pom-path-to-source branch 6 times, most recently from e53cd78 to ac5b2ec Compare March 15, 2024 14:28

jjkester and others added 8 commits March 15, 2024 15:51

Integration test provided in ticket

7c67bc5

[MPH-183] Reflectively use enhanced formatting of InputLocations

2e8c367

[MNG-7344] Experimental implementation to show the resolution path of…

fa8f8e9

… boms

Test for InputLocationFormatterFactory

88e923f

Use all possible locations to determine imported from

5f0bebc

Tests for Maven4InputLocationFormatter

105c0e5

Fix line ending

0d03b43

Renamed class, formatter can be made functional with maven 3.x

3073624

juulhobert force-pushed the MPH-183_effective-pom-path-to-source branch from 5771163 to 3073624 Compare March 15, 2024 15:22

[MPH-183] Do not print same location twice and rename test methods

3f989f6

hboutemy requested changes Apr 1, 2024

View reviewed changes

hboutemy reviewed Apr 1, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[MPH-183] Effective POM path to source #37

[MPH-183] Effective POM path to source #37

jjkester commented Nov 1, 2021 •

edited by hboutemy

mthmulders left a comment

hboutemy Apr 1, 2024

Giovds Apr 12, 2024

hboutemy Apr 1, 2024

Giovds Apr 12, 2024

hboutemy Apr 1, 2024

Giovds Apr 12, 2024

hboutemy Apr 1, 2024

Giovds Apr 12, 2024

hboutemy Apr 1, 2024

Giovds Apr 12, 2024

[MPH-183] Effective POM path to source #37

Are you sure you want to change the base?

[MPH-183] Effective POM path to source #37

Conversation

jjkester commented Nov 1, 2021 • edited by hboutemy

mthmulders left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jjkester commented Nov 1, 2021 •

edited by hboutemy