refactor (jkube-kit) : Move Dockerfile opinionated ImageConfig logic from ConfigHelper.initImageConfiguration to a dedicated generator
#2802
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
Eclipse JKube CI ReportStarted new GH workflow run for #2802 (2024-04-11T11:41:57Z) ⚙️ JKube E2E Tests (8645730604)
|
rohanKanojia
force-pushed
the
pr/simple-dockerfile-generator
branch
from
5d14f29 to
451c7e2
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #2802 +/- ##
=============================================
+ Coverage 59.36% 70.63% +11.27%
- Complexity 4586 5030 +444
=============================================
Files 500 488 -12
Lines 21211 19504 -1707
Branches 2830 2512 -318
=============================================
+ Hits 12591 13776 +1185
+ Misses 7370 4497 -2873
+ Partials 1250 1231 -19 ☔ View full report in Codecov by Sentry. |
rohanKanojia
force-pushed
the
pr/simple-dockerfile-generator
branch
from
451c7e2 to
76fb24c
Compare
rohanKanojia
force-pushed
the
pr/simple-dockerfile-generator
branch
2 times, most recently
from
ce63991 to
637543e
Compare
18 tasks
rohanKanojia
force-pushed
the
pr/simple-dockerfile-generator
branch
2 times, most recently
from
57a6e31 to
e5b283f
Compare
18 tasks
rohanKanojia
force-pushed
the
pr/simple-dockerfile-generator
branch
from
e5b283f to
b3ff84a
Compare
18 tasks
|
I recall we might have discussed this a few weeks ago. |
|
@manusa : I had added a test in SimpleDockerFileGeneratorTest to verify that generator doesn't modify existing ImageConfiguration when they have been altered by any other generator. Shall I add an additional test to assert the order of generators in the default profile? |
rohanKanojia
force-pushed
the
pr/simple-dockerfile-generator
branch
from
b3ff84a to
b5d9de6
Compare
|
I've added tests verifying the generators execution order in the default profile in b5d9de6 . Please check if it's in line with your expectations. |
…from `ConfigHelper.initImageConfiguration` to a dedicated generator + ConfigHelper modifies the provided set of ImageConfigurations when it detects a `Dockerfile` in project root directory. This is actually a feature called Simple Dockerfile Mode. However, this mutation of ImageConfiguration from within `initImageConfiguration` does not look appropriate. It can be moved to a dedicated generator that will get activated when `Dockerfile` is present in project base directory. + Add a new generator SimpleDockerfileGenerator, it adds a simple ImageConfiguration with Dockerfile configured in build and adds it to existing set of ImageConfigurations. + Remove check from BaseGenerator to skip generation if it's simple Dockerfile mode Move it to SimpleDockerfileGenerator.isApplicable instead Signed-off-by: Rohan Kumar <rohaan@redhat.com>
rohanKanojia
force-pushed
the
pr/simple-dockerfile-generator
branch
from
b5d9de6 to
e4e0d12
Compare
sunix
reviewed
Apr 4, 2024
...e/src/main/java/org/eclipse/jkube/generator/dockerfile/simple/SimpleDockerfileGenerator.java
Show resolved
Hide resolved
rohanKanojia
force-pushed
the
pr/simple-dockerfile-generator
branch
2 times, most recently
from
d7e629e to
7832a28
Compare
sunix
reviewed
Apr 5, 2024
| List<Generator> generatorList = createUsableGeneratorList(generatorContext); | ||
|
|
||
| // Then | ||
| Assertions.assertThat(generatorList) |
There was a problem hiding this comment.
for readability purpose, could you make Assertions.assertThat statically imported ?
sunix
reviewed
Apr 5, 2024
| <dependency> | ||
| <groupId>org.junit.jupiter</groupId> | ||
| <artifactId>junit-jupiter-engine</artifactId> | ||
| <scope>test</scope> |
There was a problem hiding this comment.
I would keep the scope declaration consistent:
- either you don't declare them and assume it is coming from the dependencyManagement
- either you declare them everywhere (also for org.assertj)
sunix
reviewed
Apr 5, 2024
...n-plugin/plugin/src/test/java/org/eclipse/jkube/maven/plugin/mojo/develop/WatchMojoTest.java
Show resolved
Hide resolved
rohanKanojia
force-pushed
the
pr/simple-dockerfile-generator
branch
from
7832a28 to
7d5736b
Compare
sunix
reviewed
Apr 8, 2024
| // Then | ||
| assertThat(generatorList) | ||
| .hasSize(12) | ||
| .satisfies(g -> Assertions.assertThat(g.get(0)).isInstanceOf(SimpleDockerfileGenerator.class)) |
There was a problem hiding this comment.
Same here, would be nice to have static imports for Assertions.assertThat
There was a problem hiding this comment.
Sorry, let me fix it.
sunix
approved these changes
Apr 8, 2024
rohanKanojia
force-pushed
the
pr/simple-dockerfile-generator
branch
2 times, most recently
from
c58247b to
5e7a97c
Compare
This works, however is extremely brittle and hard to maintain (which probably defeats the purpose). The idea is to create a test that ensures the behavior (not sure how since I haven't dug into the code), test should fail in the event of a modification in the generator order (default profile). |
|
@manusa There is a Shall I try adding log verifications for this instead? |
If the check consists in checking the generator print order, then that's mostly the same of what we have now. |
Signed-off-by: Rohan Kumar <rohaan@redhat.com>
rohanKanojia
force-pushed
the
pr/simple-dockerfile-generator
branch
from
5e7a97c to
4b3172c
Compare
manusa
reviewed
Apr 11, 2024
Comment on lines
76
to
79
|
|
||
| @Test | ||
| @DisplayName("when Dockerfile present in project base directory, then generate opinionated ImageConfiguration for Dockerfile") | ||
| void simpleDockerfileModeWorksAsExpected(@TempDir File temporaryFolder) throws IOException { |
There was a problem hiding this comment.
These tests (task + Mojo) work, but they aren't exactly where they should actually be.
I'll try to give take it for a spin and see if we can make this easier.
manusa
force-pushed
the
pr/simple-dockerfile-generator
branch
3 times, most recently
from
df1b6e2 to
9e037e5
Compare
Signed-off-by: Marc Nuri <marc@marcnuri.com>
manusa
force-pushed
the
pr/simple-dockerfile-generator
branch
from
9e037e5 to
8aca467
Compare
|
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.
Description
Dockerfilein project root directory. This is actually a feature called Simple Dockerfile Mode. However, this mutation of ImageConfiguration from withininitImageConfigurationdoes not look appropriate. It can be moved to a dedicated generator that will get activated whenDockerfileis present in project base directory.We also need to adjust the documentation for adding this new generator. I'll do that in a follow up PR.
Type of change
test, version modification, documentation, etc.)
Checklist