Log Docker Build Context Directory while building image in Simple Dockerfile mode #1192

rohanKanojia · 2022-01-05T12:48:34Z

Description

Add a log statement for Docker Build context directory when building a
docker image in Simple Dockerfile mode.

Related to #1055

Signed-off-by: Rohan Kumar rohaan@redhat.com

Type of change

Bug fix (non-breaking change which fixes an issue)
Feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change
Chore (non-breaking change which doesn't affect codebase;
test, version modification, documentation, etc.)

Checklist

I have read the contributing guidelines
I signed-off my commit with a user that has signed the Eclipse Contributor Agreement
I Added CHANGELOG entry
I have implemented unit tests to cover my changes
I have updated the documentation accordingly
No new bugs, code smells, etc. in SonarCloud report
I tested my code in Kubernetes
I tested my code in OpenShift

manusa · 2022-01-05T12:48:57Z

Eclipse JKube CI Report

Started new GH workflow run for #1192 (2022-01-31T10:17:04Z)

⚙️ JKube E2E Tests (1771910149)

codecov · 2022-01-05T13:06:15Z

Codecov Report

Merging #1192 (262b449) into master (fd859ce) will increase coverage by 0.00%.
The diff coverage is 53.84%.

@@            Coverage Diff            @@
##             master    #1192   +/-   ##
=========================================
  Coverage     50.15%   50.16%           
- Complexity     3698     3699    +1     
=========================================
  Files           457      457           
  Lines         20605    20607    +2     
  Branches       2805     2805           
=========================================
+ Hits          10334    10337    +3     
+ Misses         9187     9185    -2     
- Partials       1084     1085    +1

Impacted Files	Coverage Δ
...be/maven/plugin/mojo/build/AbstractDockerMojo.java	`18.62% <0.00%> (ø)`
...se/jkube/maven/plugin/mojo/build/ResourceMojo.java	`0.00% <0.00%> (ø)`
...se/jkube/gradle/plugin/task/AbstractJKubeTask.java	`88.75% <100.00%> (+0.14%)`	⬆️
.../kit/build/service/docker/helper/ConfigHelper.java	`57.69% <100.00%> (+0.54%)`	⬆️
...it/config/service/portforward/PortForwardTask.java	`64.00% <0.00%> (+4.00%)`	⬆️

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 fd859ce...262b449. Read the comment docs.

manusa · 2022-01-10T16:52:35Z

...ice/docker/src/main/java/org/eclipse/jkube/kit/build/service/docker/helper/ConfigHelper.java

@@ -181,7 +182,7 @@ private static void verifyImageNames(List<ImageConfiguration> ret) {
        }
    }

-    public static List<ImageConfiguration> initImageConfiguration(String apiVersion, Date buildTimeStamp, JavaProject javaProject, List<ImageConfiguration> images, ImageConfigResolver imageConfigResolver, KitLogger log, String filter, ConfigHelper.Customizer customizer) {
+    public static List<ImageConfiguration> initImageConfiguration(String apiVersion, Date buildTimeStamp, JavaProject javaProject, List<ImageConfiguration> images, ImageConfigResolver imageConfigResolver, KitLogger log, String filter, ConfigHelper.Customizer customizer, JKubeConfiguration jKubeConfiguration) {


Haven't checked the rest, but JKubeConfiguration should already contain the JavaProject instance (So replacing one with the other should do in this case).

manusa · 2022-01-10T17:02:57Z

...ice/docker/src/main/java/org/eclipse/jkube/kit/build/service/docker/helper/ConfigHelper.java

@@ -211,6 +212,7 @@ private static void verifyImageNames(List<ImageConfiguration> ret) {
            BuildConfiguration buildConfiguration = image.getBuildConfiguration();
            if (buildConfiguration != null &&  buildConfiguration.isDockerFileMode()) {
                log.info("Using Dockerfile: %s", buildConfiguration.getDockerFile().getAbsolutePath());
+                log.info("Using Docker Context Directory: %s", buildConfiguration.getAbsoluteContextDirPath(jKubeConfiguration.getSourceDirectory(), jKubeConfiguration.getBasedir().getAbsolutePath()));


Aren't these directories in JavaProject?

I remember in the early days these fields were scattered all around and we managed to reduce them to just the JKubeConfiguration and the JavaProject instances.
What's the issue in this case?

If the homonymous fields have the same purpose, one set should be deprecated. If not, the undocumented, should be. This way we would avoid situations like the current were there's confusion about what should be used

I can see jKubeConfiguration.getBaseDir() returns JavaProject's base directory. But I'm not able to find any sourceDirectory equivalent in JavaProject

Suggested change

log.info("Using Docker Context Directory: %s", buildConfiguration.getAbsoluteContextDirPath(jKubeConfiguration.getSourceDirectory(), jKubeConfiguration.getBasedir().getAbsolutePath()));

log.info("Using Docker context directory: %s", buildConfiguration.getAbsoluteContextDirPath(jKubeConfiguration.getSourceDirectory(), jKubeConfiguration.getBasedir().getAbsolutePath()));

I can see jKubeConfiguration.getBaseDir() returns JavaProject's base directory. But I'm not able to find any sourceDirectory equivalent in JavaProject

OK, so this one is not duplicate, it just retrieves javaProject.baseDirectory

However, outputDirectory is still defined in both places. We'll need to investigate and deprecate, rename or proper document them.

sunix · 2022-01-13T13:57:13Z

...docker/src/test/java/org/eclipse/jkube/kit/build/service/docker/helper/ConfigHelperTest.java


 public class ConfigHelperTest {
-  @Mocked


Why not using Mockito annotations ?

You'd need to run the test with MockitoJUnitRunner.class

These annotations were the ones provided by JMockit.

sunix · 2022-01-13T14:04:25Z

...lugin/src/test/java/org/eclipse/jkube/maven/plugin/mojo/build/OpenShiftResourceMojoTest.java

  private ImageConfigResolver mockedImageConfigResolver;

  private OpenshiftResourceMojo openShiftResourceMojo;

  @Before
-  public void setUp() throws IOException {
+  public void setUp() {
+    mockedClusterAccess = mock(ClusterAccess.class, RETURNS_DEEP_STUBS);


I feel like there are too many nested mocks here which may not be needed if you use RETURNS_DEEP_STUBS and or @InjectMocks. It makes this part hard to read (and maintain).

Thanks, you're right. I was able to remove unnecessary mocks for JKubeConfiguration class by using RETURNS_DEEP_STUBS

manusa · 2022-01-14T14:33:24Z

...docker/src/test/java/org/eclipse/jkube/kit/build/service/docker/helper/ConfigHelperTest.java

+  @Before
+  public void setUp() {
+    imageConfigResolver = mock(ImageConfigResolver.class, RETURNS_DEEP_STUBS);
+    logger = mock(KitLogger.class, RETURNS_DEEP_STUBS);


If we are not verifying any of the logged messages, SilentLogger is a good option for tests instead of using a mock.

Do you have some examples of using it? I'm not able to find any references to SilentLogger in this repository

manusa · 2022-01-25T13:54:19Z

...docker/src/test/java/org/eclipse/jkube/kit/build/service/docker/helper/ConfigHelperTest.java

+  @Before
+  public void setUp() {
+    imageConfigResolver = mock(ImageConfigResolver.class, RETURNS_DEEP_STUBS);
+    logger = mock(KitLogger.SilentLogger.class, RETURNS_DEEP_STUBS);


#1192 (comment)

The idea is not to mock the logger unless we need to verify something.

Suggested change

logger = mock(KitLogger.SilentLogger.class, RETURNS_DEEP_STUBS);

logger = new KitLogger.SilentLogger();

...aven-plugin/plugin/src/main/java/org/eclipse/jkube/maven/plugin/mojo/build/ResourceMojo.java

…kerfile mode Add a log statement for Docker Build context directory when building a docker image in Simple Dockerfile mode. Related to eclipse-jkube#1055 Signed-off-by: Rohan Kumar <rohaan@redhat.com>

sonarcloud · 2022-01-31T10:10:19Z

SonarCloud Quality Gate failed.

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

14.3% Coverage
0.0% Duplication

rohanKanojia marked this pull request as ready for review January 10, 2022 06:39

rohanKanojia requested review from sunix and manusa January 10, 2022 06:39

manusa reviewed Jan 10, 2022

View reviewed changes

rohanKanojia force-pushed the pr/log-contextdir-simpledockerfilemode branch 2 times, most recently from 929fb20 to 91e7aa7 Compare January 11, 2022 17:11

sunix reviewed Jan 13, 2022

View reviewed changes

manusa reviewed Jan 14, 2022

View reviewed changes

rohanKanojia force-pushed the pr/log-contextdir-simpledockerfilemode branch 2 times, most recently from b52c43d to d40505e Compare January 20, 2022 07:01

manusa reviewed Jan 25, 2022

View reviewed changes

rohanKanojia force-pushed the pr/log-contextdir-simpledockerfilemode branch from d40505e to 0509f31 Compare January 25, 2022 16:06

sunix approved these changes Jan 27, 2022

View reviewed changes

manusa added this to the 1.6.0 milestone Jan 31, 2022

manusa reviewed Jan 31, 2022

View reviewed changes

...aven-plugin/plugin/src/main/java/org/eclipse/jkube/maven/plugin/mojo/build/ResourceMojo.java Outdated Show resolved Hide resolved

Log Docker Build Context Directory while building image in Simple Doc…

262b449

…kerfile mode Add a log statement for Docker Build context directory when building a docker image in Simple Dockerfile mode. Related to eclipse-jkube#1055 Signed-off-by: Rohan Kumar <rohaan@redhat.com>

rohanKanojia force-pushed the pr/log-contextdir-simpledockerfilemode branch from 0509f31 to 262b449 Compare January 31, 2022 09:57

manusa approved these changes Jan 31, 2022

View reviewed changes

manusa merged commit dd26a36 into eclipse-jkube:master Jan 31, 2022

manusa added the changelog_missing label Jan 31, 2022

rohanKanojia deleted the pr/log-contextdir-simpledockerfilemode branch January 31, 2022 13:21

manusa removed the changelog_missing label Feb 3, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Log Docker Build Context Directory while building image in Simple Dockerfile mode #1192

Log Docker Build Context Directory while building image in Simple Dockerfile mode #1192

rohanKanojia commented Jan 5, 2022 •

edited by manusa

manusa commented Jan 5, 2022 •

edited

codecov bot commented Jan 5, 2022 •

edited

manusa Jan 10, 2022

manusa Jan 10, 2022

manusa Jan 10, 2022

rohanKanojia Jan 11, 2022

sunix Jan 13, 2022

manusa Jan 14, 2022

sunix Jan 13, 2022

manusa Jan 14, 2022

sunix Jan 13, 2022 •

edited

rohanKanojia Jan 19, 2022

manusa Jan 14, 2022

rohanKanojia Jan 19, 2022

manusa Jan 25, 2022

sonarcloud bot commented Jan 31, 2022

	log.info("Using Docker Context Directory: %s", buildConfiguration.getAbsoluteContextDirPath(jKubeConfiguration.getSourceDirectory(), jKubeConfiguration.getBasedir().getAbsolutePath()));
	log.info("Using Docker context directory: %s", buildConfiguration.getAbsoluteContextDirPath(jKubeConfiguration.getSourceDirectory(), jKubeConfiguration.getBasedir().getAbsolutePath()));

	logger = mock(KitLogger.SilentLogger.class, RETURNS_DEEP_STUBS);
	logger = new KitLogger.SilentLogger();

Log Docker Build Context Directory while building image in Simple Dockerfile mode #1192

Log Docker Build Context Directory while building image in Simple Dockerfile mode #1192

Conversation

rohanKanojia commented Jan 5, 2022 • edited by manusa

Description

Type of change

Checklist

manusa commented Jan 5, 2022 • edited

Eclipse JKube CI Report

codecov bot commented Jan 5, 2022 • edited

Codecov Report

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

sunix Jan 13, 2022 • edited

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

sonarcloud bot commented Jan 31, 2022

rohanKanojia commented Jan 5, 2022 •

edited by manusa

manusa commented Jan 5, 2022 •

edited

codecov bot commented Jan 5, 2022 •

edited

sunix Jan 13, 2022 •

edited