jib-layer-filter-extension-maven: optionally create separate layers for dependencies from parent POM #76

stefanocke · 2021-02-21T17:57:52Z

I would like to achieve the following:

determine the dependencies (including transitive) that come from the parent pom
put them into one or more separate layers

The idea is that the parent pom defines the "company / project standard" which rarely changes.
While the existing jib-layer-filter-extension-maven is already quite useful, it would be still quite cumbersome to write globs for all direct and transitive dependencies.
For example, think about having some Spring Boot starters in the parent pom for all your microservice, but some other Spring Boot starters are optional and only used by specific microservices. You not only would need quite exact globs for the Spring Boot starters then, but also for their manyfold transitive dependencies.

See also GoogleContainerTools/jib#3036 which is required for this pull request to work.

to support better error handling

injection of extensions shows how to use dependency injection in an extension

And formatting and logging.

codecov · 2021-02-21T17:59:44Z

Codecov Report

❗ No coverage uploaded for pull request base (master@e9968f7). Click here to learn what that means.
The diff coverage is n/a.

@@            Coverage Diff            @@
##             master      #76   +/-   ##
=========================================
  Coverage          ?   84.89%           
  Complexity        ?      154           
=========================================
  Files             ?       14           
  Lines             ?      629           
  Branches          ?       71           
=========================================
  Hits              ?      534           
  Misses            ?       83           
  Partials          ?       12

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e9968f7...ce81a92. Read the comment docs.

chanseokoh

Thank a lot for this! I did a quick scan on this and added comments about some technical stuff. I will continue to look into the PR.

...ain/java/com/google/cloud/tools/jib/maven/extension/layerfilter/JibLayerFilterExtension.java

...java/com/google/cloud/tools/jib/maven/extension/layerfilter/JibLayerFilterExtensionTest.java

...ain/java/com/google/cloud/tools/jib/maven/extension/layerfilter/JibLayerFilterExtension.java

...java/com/google/cloud/tools/jib/maven/extension/layerfilter/JibLayerFilterExtensionTest.java

...ain/java/com/google/cloud/tools/jib/maven/extension/layerfilter/JibLayerFilterExtension.java

stefanocke · 2021-02-23T20:03:59Z

@chanseokoh , thank you for your detailed review. I will walk through it in the very next days.

...aven/src/main/java/com/google/cloud/tools/jib/maven/extension/layerfilter/Configuration.java

...ain/java/com/google/cloud/tools/jib/maven/extension/layerfilter/JibLayerFilterExtension.java

...java/com/google/cloud/tools/jib/maven/extension/layerfilter/JibLayerFilterExtensionTest.java

...ain/java/com/google/cloud/tools/jib/maven/extension/layerfilter/JibLayerFilterExtension.java

still open for further consideration.

stefanocke · 2021-02-26T13:07:50Z

Reminder to myself: When resolving parent dependencies, active profiles have to be considered.

... Okay, this does already work, since the active profiles come form the MavenProject. And in the parent project, that is passed into the DependencyResoultionRequest, the activeProfiles are set.

to not depend on "app/libs", which is connfigurable in jib

use source file name for matching instead of filename from extraction path

Especially on the Artifact side that means that the filename is not "constructed" anymore by the extension. We make no assumption about the structure of the source file name or path. The only assumption that is left is, that Maven will resolve to the same file path, if the same artifact coordinates are resolved multiple times within a build / session.

chanseokoh

LGTM in general. Only some minor comments.

...ain/java/com/google/cloud/tools/jib/maven/extension/layerfilter/JibLayerFilterExtension.java

...java/com/google/cloud/tools/jib/maven/extension/layerfilter/JibLayerFilterExtensionTest.java

chanseokoh

LGTM. Thanks for this awesome contribution!

I will merge this later this week to give you some time for any last-minute changes, just in case.

stefanocke · 2021-03-04T07:51:15Z

That sounds great. Thank you for supporting this PR and helping to improve it.

chanseokoh · 2021-03-04T15:06:42Z

You're welcome. Just asking: are you interested in updating the "Writing Your Own Extensions" doc in a separate PR to add the new JSR350 / Sisu approach (while leaving the JDK service locator method for now)?

stefanocke · 2021-03-04T16:48:00Z

Yes, I think I should do this. Will try in the next days.

chanseokoh · 2021-03-04T19:34:11Z

Thanks!

GoogleContainerTools/jib#3036 and GoogleContainerTools#76

…eating parent dependency layers in jib-layer-filter-extension-maven (#81) * Documentation for GoogleContainerTools/jib#3036 and #76 * Update README.md Co-authored-by: Chanseok Oh <chanseok@google.com>

stefanocke added 7 commits February 7, 2021 18:17

Moving parent dependencies to separate layers - first draft

d9652b5

Maps of dependencies instead of Sets

c111c7b

to support better error handling

GoogleContainerTools/jib#3036 support

dc5432f

injection of extensions shows how to use dependency injection in an extension

configuration for createParentLayers

71b9235

And formatting and logging.

some tests

ad046f3

some more tests

fae9473

googleJavaFormat

e30bb5c

google-cla bot added the cla: yes label Feb 21, 2021

stefanocke marked this pull request as draft February 21, 2021 18:01

stefanocke changed the title ~~Optionally create separate layers for dependencies from parent POM~~ jib-layer-filter-extension-maven: optionally create separate layers for dependencies from parent POM Feb 21, 2021

chanseokoh reviewed Feb 23, 2021

View reviewed changes

...ain/java/com/google/cloud/tools/jib/maven/extension/layerfilter/JibLayerFilterExtension.java Outdated Show resolved Hide resolved

chanseokoh reviewed Feb 23, 2021

View reviewed changes

...ain/java/com/google/cloud/tools/jib/maven/extension/layerfilter/JibLayerFilterExtension.java Outdated Show resolved Hide resolved

...ain/java/com/google/cloud/tools/jib/maven/extension/layerfilter/JibLayerFilterExtension.java Outdated Show resolved Hide resolved

stefanocke added 2 commits February 26, 2021 12:59

Review, first part

56ad6b8

Review: fixed all remaining minor issues. Left the more interesting ones

9cc0eea

still open for further consideration.

stefanocke added 4 commits February 26, 2021 15:02

getBaseVersion instead of getVersion

7067528

match filename instead of complete extraction path

469cd36

to not depend on "app/libs", which is connfigurable in jib

log potential matches when parent dependency not found

1a5d321

use source file name for matching instead of filename from extraction path

stefanocke marked this pull request as ready for review February 27, 2021 12:05

chanseokoh reviewed Mar 2, 2021

View reviewed changes

Review: some minor issues

ce81a92

chanseokoh approved these changes Mar 3, 2021

View reviewed changes

chanseokoh merged commit 250b7b5 into GoogleContainerTools:master Mar 4, 2021

stefanocke added a commit to stefanocke/jib-extensions that referenced this pull request Mar 6, 2021

Documentation for

6eea55d

GoogleContainerTools/jib#3036 and GoogleContainerTools#76

stefanocke added a commit to stefanocke/jib-extensions that referenced this pull request Mar 6, 2021

Documentation for

2b575df

GoogleContainerTools/jib#3036 and GoogleContainerTools#76

stefanocke added a commit to stefanocke/jib-extensions that referenced this pull request Mar 6, 2021

Documentation for

1681381

GoogleContainerTools/jib#3036 and GoogleContainerTools#76

stefanocke mentioned this pull request Mar 6, 2021

Documentation for dependency injection in Maven extensions and for creating parent dependency layers in jib-layer-filter-extension-maven #81

Merged

chanseokoh mentioned this pull request Apr 9, 2021

Jib layer filter extension maven release v0.2.0 #89

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

jib-layer-filter-extension-maven: optionally create separate layers for dependencies from parent POM #76

jib-layer-filter-extension-maven: optionally create separate layers for dependencies from parent POM #76

stefanocke commented Feb 21, 2021 •

edited

Loading

codecov bot commented Feb 21, 2021 •

edited

Loading

chanseokoh left a comment

stefanocke commented Feb 23, 2021

stefanocke commented Feb 26, 2021 •

edited

Loading

chanseokoh left a comment

chanseokoh left a comment

stefanocke commented Mar 4, 2021

chanseokoh commented Mar 4, 2021

stefanocke commented Mar 4, 2021

chanseokoh commented Mar 4, 2021

jib-layer-filter-extension-maven: optionally create separate layers for dependencies from parent POM #76

jib-layer-filter-extension-maven: optionally create separate layers for dependencies from parent POM #76

Conversation

stefanocke commented Feb 21, 2021 • edited Loading

codecov bot commented Feb 21, 2021 • edited Loading

Codecov Report

chanseokoh left a comment

Choose a reason for hiding this comment

stefanocke commented Feb 23, 2021

stefanocke commented Feb 26, 2021 • edited Loading

chanseokoh left a comment

Choose a reason for hiding this comment

chanseokoh left a comment

Choose a reason for hiding this comment

stefanocke commented Mar 4, 2021

chanseokoh commented Mar 4, 2021

stefanocke commented Mar 4, 2021

chanseokoh commented Mar 4, 2021

stefanocke commented Feb 21, 2021 •

edited

Loading

codecov bot commented Feb 21, 2021 •

edited

Loading

stefanocke commented Feb 26, 2021 •

edited

Loading