-
Notifications
You must be signed in to change notification settings - Fork 17
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
fix: maven-dependency-plugin configuration breaking downstream config #174
Merged
chingor13
merged 1 commit into
googleapis:master
from
BenWhitehead:fix-ignore-unused-javax-config
Jul 1, 2020
Merged
fix: maven-dependency-plugin configuration breaking downstream config #174
chingor13
merged 1 commit into
googleapis:master
from
BenWhitehead:fix-ignore-unused-javax-config
Jul 1, 2020
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When providing configuration to the maven-dependency-plugin, `ignoredUnusedDeclaredDependencies` is a `java.lang.String[]` but mavens xml handling allows multiple formats for providing a list of values (comma separated string, or sub elements each specifying a single value). It appears that when loading the config, the value of the configuration at a lower level is blindly pre-pended as a string rather than first parsing and merging the results. Below is the debug output of the resolved configuration using the existing config added in cd635ad, the output after this change and a diff of the two. Notice, in the left hand side of the diff the malformed xml. The change introduced in this commit switches from using the comma separated string representation, to using the sub element representation thereby allowing the config resolution to create a valid config. ###### Resolved config as of cd635ad ``` [DEBUG] Goal: org.apache.maven.plugins:maven-dependency-plugin:3.1.2:analyze (default-cli) [DEBUG] Style: Regular [DEBUG] Configuration: <?xml version="1.0" encoding="UTF-8"?> <configuration> <analyzer default-value="default">${analyzer}</analyzer> <baseDir default-value="${basedir}"/> <failOnWarning default-value="false">${failOnWarning}</failOnWarning> <ignoreNonCompile default-value="false">${ignoreNonCompile}</ignoreNonCompile> <ignoredUnusedDeclaredDependencies> <ignoredUnusedDeclaredDependency>com.google.http-client:google-http-client-jackson2</ignoredUnusedDeclaredDependency> <ignoredUnusedDeclaredDependency>com.google.oauth-client:google-oauth-client</ignoredUnusedDeclaredDependency> <ignoredUnusedDeclaredDependency>javax.annotation:javax.annotation-api</ignoredUnusedDeclaredDependency>javax.annotation:javax.annotation-api</ignoredUnusedDeclaredDependencies> <outputDirectory default-value="${project.build.directory}"/> <outputXML default-value="false">${outputXML}</outputXML> <project default-value="${project}"/> <scriptableFlag default-value="$$$%%%">${scriptableFlag}</scriptableFlag> <scriptableOutput default-value="false">${scriptableOutput}</scriptableOutput> <skip default-value="false">${mdep.analyze.skip}</skip> <verbose default-value="false">${verbose}</verbose> </configuration> ``` ###### Resolved config now ``` [DEBUG] Goal: org.apache.maven.plugins:maven-dependency-plugin:3.1.2:analyze (default-cli) [DEBUG] Style: Regular [DEBUG] Configuration: <?xml version="1.0" encoding="UTF-8"?> <configuration> <analyzer default-value="default">${analyzer}</analyzer> <baseDir default-value="${basedir}"/> <failOnWarning default-value="false">${failOnWarning}</failOnWarning> <ignoreNonCompile default-value="false">${ignoreNonCompile}</ignoreNonCompile> <ignoredUnusedDeclaredDependencies> <ignoredUnusedDeclaredDependency>com.google.http-client:google-http-client-jackson2</ignoredUnusedDeclaredDependency> <ignoredUnusedDeclaredDependency>com.google.oauth-client:google-oauth-client</ignoredUnusedDeclaredDependency> <ignoredUnusedDeclaredDependency>javax.annotation:javax.annotation-api</ignoredUnusedDeclaredDependency> </ignoredUnusedDeclaredDependencies> <outputDirectory default-value="${project.build.directory}"/> <outputXML default-value="false">${outputXML}</outputXML> <project default-value="${project}"/> <scriptableFlag default-value="$$$%%%">${scriptableFlag}</scriptableFlag> <scriptableOutput default-value="false">${scriptableOutput}</scriptableOutput> <skip default-value="false">${mdep.analyze.skip}</skip> <verbose default-value="false">${verbose}</verbose> </configuration> ``` ##### Diff between resolved configs ```diff 12c12,13 < <ignoredUnusedDeclaredDependency>javax.annotation:javax.annotation-api</ignoredUnusedDeclaredDependency>javax.annotation:javax.annotation-api</ignoredUnusedDeclaredDependencies> --- > <ignoredUnusedDeclaredDependency>javax.annotation:javax.annotation-api</ignoredUnusedDeclaredDependency> > </ignoredUnusedDeclaredDependencies> ```
1 task
chingor13
approved these changes
Jul 1, 2020
gcf-merge-on-green bot
pushed a commit
that referenced
this pull request
Jul 1, 2020
🤖 I have created a release \*beep\* \*boop\* --- ### [0.9.1](https://github.com/googleapis/java-shared-config/compare/v0.9.0...v0.9.1) (2020-07-01) ### Bug Fixes * maven-dependency-plugin configuration breaking downstream config ([#174](https://github.com/googleapis/java-shared-config/issues/174)) ([507217f](https://github.com/googleapis/java-shared-config/commit/507217fe509cd4f16eb50c8075ab43229238e08d)) ### Documentation * change Devsite output path to /java/docs/reference ([#176](https://github.com/googleapis/java-shared-config/issues/176)) ([8b98af5](https://github.com/googleapis/java-shared-config/commit/8b98af54bf503d97bb86b6d02a5c4301b39384e1)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please).
This was referenced Jan 4, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When providing configuration to the maven-dependency-plugin,
ignoredUnusedDeclaredDependencies
is ajava.lang.String[]
but mavens xmlhandling allows multiple formats for providing a list of values (comma
separated string, or sub elements each specifying a single value). It appears
that when loading the config, the value of the configuration at a lower level
is blindly pre-pended as a string rather than first parsing and merging the
results. Below is the debug output of the resolved configuration using the
existing config added in cd635ad, the output after this change and a diff of
the two. Notice, in the left hand side of the diff the malformed xml.
The change introduced in this commit switches from using the comma separated
string representation, to using the sub element representation thereby allowing
the config resolution to create a valid config.
Resolved config as of cd635ad
Resolved config now
Diff between resolved configs