refactor: prevent BuildService API breakages

Signed-off-by: Marc Nuri <marc@marcnuri.com>
eclipse-jkube · Jan 27, 2022 · be8514f · be8514f
1 parent 8a5d906
commit be8514f
Show file tree

Hide file tree

Showing 14 changed files with 66 additions and 74 deletions.
diff --git a/...in/kubernetes/src/main/java/org/eclipse/jkube/gradle/plugin/task/KubernetesBuildTask.java b/...in/kubernetes/src/main/java/org/eclipse/jkube/gradle/plugin/task/KubernetesBuildTask.java
@@ -17,6 +17,7 @@
 
 import org.eclipse.jkube.gradle.plugin.KubernetesExtension;
 import org.eclipse.jkube.kit.build.service.docker.DockerServiceHub;
+import org.eclipse.jkube.kit.config.image.ImageConfiguration;
 import org.eclipse.jkube.kit.config.resource.RuntimeMode;
 import org.eclipse.jkube.kit.config.service.BuildServiceConfig;
 import org.eclipse.jkube.kit.config.service.JKubeServiceException;
@@ -61,7 +62,7 @@ public void run() {
               DOCKER_BUILD_TIMESTAMP),
           getBuildTimestamp(null, null, kubernetesExtension.javaProject.getBuildDirectory().getAbsolutePath(),
               DOCKER_BUILD_TIMESTAMP));
-      jKubeServiceHub.getBuildService().build(resolvedImages);
+      jKubeServiceHub.getBuildService().build(resolvedImages.toArray(new ImageConfiguration[0]));
     } catch (JKubeServiceException | IOException e) {
       kitLogger.error(e.getMessage());
       throw new GradleException(e.getMessage(), e);

diff --git a/...ubernetes/src/test/java/org/eclipse/jkube/gradle/plugin/task/KubernetesBuildTaskTest.java b/...ubernetes/src/test/java/org/eclipse/jkube/gradle/plugin/task/KubernetesBuildTaskTest.java
@@ -38,7 +38,6 @@
 import static org.assertj.core.api.AssertionsForInterfaceTypes.assertThat;
 import static org.junit.Assert.assertThrows;
 import static org.mockito.ArgumentMatchers.any;
-import static org.mockito.ArgumentMatchers.anyList;
 import static org.mockito.Mockito.doThrow;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.mockConstruction;
@@ -65,7 +64,7 @@ public void setUp() throws IOException {
     dockerBuildServiceMockedConstruction = mockConstruction(DockerBuildService.class, (mock, ctx) -> {
       when(mock.isApplicable()).thenReturn(isBuildServiceApplicable);
       if (isBuildError) {
-        doThrow(new JKubeServiceException("Exception during Build")).when(mock).build(anyList());
+        doThrow(new JKubeServiceException("Exception during Build")).when(mock).build(any());
       }
     });
     isBuildServiceApplicable = true;
@@ -95,7 +94,7 @@ public void runTask_withImageConfiguration_shouldRunBuild() throws JKubeServiceE
     // Then
     assertThat(buildTask.jKubeServiceHub.getBuildService()).isNotNull()
         .isInstanceOf(DockerBuildService.class);
-    verify(buildTask.jKubeServiceHub.getBuildService(), times(1)).build(anyList());
+    verify(buildTask.jKubeServiceHub.getBuildService(), times(1)).build(any());
   }
 
   @Test
@@ -139,6 +138,6 @@ public Property<Boolean> getSkipBuild() {
 
     // Then
     Assertions.assertThat(dockerBuildServiceMockedConstruction.constructed()).isEmpty();
-    verify(buildTask.jKubeServiceHub.getBuildService(), times(0)).build(anyList());
+    verify(buildTask.jKubeServiceHub.getBuildService(), times(0)).build(any());
   }
 }
diff --git a/.../openshift/src/test/java/org/eclipse/jkube/gradle/plugin/task/OpenShiftBuildTaskTest.java b/.../openshift/src/test/java/org/eclipse/jkube/gradle/plugin/task/OpenShiftBuildTaskTest.java
@@ -29,7 +29,7 @@
 import org.mockito.MockedConstruction;
 
 import static org.assertj.core.api.AssertionsForClassTypes.assertThat;
-import static org.mockito.ArgumentMatchers.anyList;
+import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.Mockito.mockConstruction;
 import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
@@ -75,7 +75,7 @@ public void runTask_withImageConfiguration_shouldRunBuild() throws JKubeServiceE
     // Then
     assertThat(buildTask.jKubeServiceHub.getBuildService()).isNotNull()
         .isInstanceOf(OpenshiftBuildService.class);
-    verify(buildTask.jKubeServiceHub.getBuildService(), times(1)).build(anyList());
+    verify(buildTask.jKubeServiceHub.getBuildService(), times(1)).build(any());
   }
 
 }
diff --git a/...service/src/main/java/org/eclipse/jkube/kit/config/service/AbstractImageBuildService.java b/...service/src/main/java/org/eclipse/jkube/kit/config/service/AbstractImageBuildService.java
@@ -15,23 +15,23 @@
 
 import org.eclipse.jkube.kit.config.image.ImageConfiguration;
 
-import java.util.Collection;
-
 public abstract class AbstractImageBuildService implements BuildService {
   private final JKubeServiceHub jKubeServiceHub;
 
   protected AbstractImageBuildService(JKubeServiceHub jKubeServiceHub) {
     this.jKubeServiceHub = jKubeServiceHub;
   }
 
+  protected abstract void buildSingleImage(ImageConfiguration imageConfiguration) throws JKubeServiceException;
+
   @Override
-  public void build(Collection<ImageConfiguration> imageConfigurations) throws JKubeServiceException {
+  public final void build(ImageConfiguration... imageConfigurations) throws JKubeServiceException {
     if (imageConfigurations != null) {
-      for (ImageConfiguration imageConfig : imageConfigurations) {
-        if (imageConfig.getBuildConfiguration() != null && imageConfig.getBuildConfiguration().getSkip()) {
-          jKubeServiceHub.getLog().info("%s : Skipped building", imageConfig.getDescription());
+      for (ImageConfiguration imageConfiguration : imageConfigurations) {
+        if (imageConfiguration.getBuildConfiguration() != null && imageConfiguration.getBuildConfiguration().getSkip()) {
+          jKubeServiceHub.getLog().info("%s : Skipped building", imageConfiguration.getDescription());
         } else {
-          build(imageConfig);
+          buildSingleImage(imageConfiguration);
         }
       }
     }

diff --git a/...e-kit/config/service/src/main/java/org/eclipse/jkube/kit/config/service/BuildService.java b/...e-kit/config/service/src/main/java/org/eclipse/jkube/kit/config/service/BuildService.java
@@ -31,20 +31,12 @@ public interface BuildService {
     boolean isApplicable();
 
     /**
-     * Builds the given images using the specified configuration.
+     * Build the given images using specified configuration
      *
-     * @param imageConfigs the image to build
+     * @param imageConfiguration {@link ImageConfiguration}(s) to build
      * @throws JKubeServiceException in case of any error while building image
      */
-    void build(Collection<ImageConfiguration> imageConfigs) throws JKubeServiceException;
-
-    /**
-     * Build the given image using specified configuration
-     *
-     * @param imageConfiguration single {@link ImageConfiguration} to build
-     * @throws JKubeServiceException in case of any error while building image
-     */
-    void build(ImageConfiguration imageConfiguration) throws JKubeServiceException;
+    void build(ImageConfiguration... imageConfiguration) throws JKubeServiceException;
 
     /**
      * Pushes to given image to specified Registry

diff --git a/...ice/src/main/java/org/eclipse/jkube/kit/config/service/kubernetes/DockerBuildService.java b/...ice/src/main/java/org/eclipse/jkube/kit/config/service/kubernetes/DockerBuildService.java
@@ -55,7 +55,7 @@ public boolean isApplicable() {
     }
 
     @Override
-    public void build(ImageConfiguration imageConfig) throws JKubeServiceException {
+    public void buildSingleImage(ImageConfiguration imageConfig) throws JKubeServiceException {
         try {
             dockerServices.getBuildService().buildImage(imageConfig, buildServiceConfig.getImagePullManager(), jKubeConfiguration);
 

diff --git a/...ervice/src/main/java/org/eclipse/jkube/kit/config/service/kubernetes/JibBuildService.java b/...ervice/src/main/java/org/eclipse/jkube/kit/config/service/kubernetes/JibBuildService.java
@@ -75,7 +75,7 @@ public boolean isApplicable() {
     }
 
     @Override
-    public void build(ImageConfiguration imageConfig) throws JKubeServiceException {
+    public void buildSingleImage(ImageConfiguration imageConfig) throws JKubeServiceException {
         try {
             log.info("[[B]]JIB[[B]] image build started");
             if (imageConfig.getBuildConfiguration().isDockerFileMode()) {

diff --git a/...e/src/main/java/org/eclipse/jkube/kit/config/service/openshift/OpenshiftBuildService.java b/...e/src/main/java/org/eclipse/jkube/kit/config/service/openshift/OpenshiftBuildService.java
@@ -123,7 +123,7 @@ public boolean isApplicable() {
     }
 
     @Override
-    public void build(ImageConfiguration imageConfig) throws JKubeServiceException {
+    public void buildSingleImage(ImageConfiguration imageConfig) throws JKubeServiceException {
         initClient();
         String buildName = null;
         try {

diff --git a/...src/test/java/org/eclipse/jkube/kit/config/service/kubernetes/DockerBuildServiceTest.java b/...src/test/java/org/eclipse/jkube/kit/config/service/kubernetes/DockerBuildServiceTest.java
@@ -13,28 +13,29 @@
  */
 package org.eclipse.jkube.kit.config.service.kubernetes;
 
-import org.eclipse.jkube.kit.config.image.build.BuildConfiguration;
-import org.eclipse.jkube.kit.config.image.ImageConfiguration;
+import java.io.IOException;
+import java.util.Collections;
+
 import org.eclipse.jkube.kit.build.service.docker.BuildService;
+import org.eclipse.jkube.kit.config.image.ImageConfiguration;
+import org.eclipse.jkube.kit.config.image.build.BuildConfiguration;
 import org.eclipse.jkube.kit.config.service.JKubeServiceException;
 import org.eclipse.jkube.kit.config.service.JKubeServiceHub;
+
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.mockito.Answers;
 import org.mockito.Mock;
 import org.mockito.junit.MockitoJUnitRunner;
 
-import java.io.IOException;
-import java.util.Collections;
-
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.Assert.assertThrows;
 import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.anyString;
 import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.ArgumentMatchers.isNull;
 import static org.mockito.Mockito.doThrow;
-import static org.mockito.ArgumentMatchers.anyString;
 import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
@@ -64,7 +65,7 @@ public void setUp() {
   @Test
   public void build_withValidConfiguration_shouldBuildAndTag() throws Exception {
     // When
-    new DockerBuildService(mockedJKubeServiceHub).build(Collections.singletonList(image));
+    new DockerBuildService(mockedJKubeServiceHub).build(image);
     // Then
     verify(mockedDockerBuildService, times(1))
         .buildImage(eq(image), any(), any());
@@ -83,7 +84,7 @@ public void build_withImageBuildConfigurationSkipEnabled_shouldNotBuildAndTag()
         .build();
 
     // When
-    new DockerBuildService(mockedJKubeServiceHub).build(Collections.singletonList(image));
+    new DockerBuildService(mockedJKubeServiceHub).build(image);
     // Then
     verify(mockedDockerBuildService, times(0))
         .buildImage(eq(image), any(), any());
@@ -97,7 +98,7 @@ public void build_withFailure_shouldThrowException() throws Exception {
     doThrow(new IOException("Mock IO error")).when(mockedDockerBuildService).buildImage(eq(image), any(), any());
     // When
     final JKubeServiceException result = assertThrows(JKubeServiceException.class, () ->
-        new DockerBuildService(mockedJKubeServiceHub).build(Collections.singletonList(image)));
+        new DockerBuildService(mockedJKubeServiceHub).build(image));
     // Then
     assertThat(result).hasMessage("Error while trying to build the image: Mock IO error");
   }

diff --git a/.../org/eclipse/jkube/kit/config/service/kubernetes/JibBuildServiceBuildIntegrationTest.java b/.../org/eclipse/jkube/kit/config/service/kubernetes/JibBuildServiceBuildIntegrationTest.java
@@ -95,7 +95,7 @@ public void build_dockerFileMode_shouldThrowException() {
         .build(imageConfiguration.getBuild().toBuilder().dockerFile("Dockerfile").build())
         .build();
     // When
-    final JKubeServiceException result = assertThrows(JKubeServiceException.class, () -> jibBuildService.build(Collections.singletonList(ic)));
+    final JKubeServiceException result = assertThrows(JKubeServiceException.class, () -> jibBuildService.build(ic));
     // Then
     assertThat(result).hasMessage("Error when building JIB image")
         .getCause().hasMessage("Dockerfile mode is not supported with JIB build strategy");
@@ -129,7 +129,7 @@ public void build_withLayersAndArtifact_shouldPerformJibBuild() throws Exception
             .build())
         .build();
     // When
-    jibBuildService.build(Collections.singletonList(ic));
+    jibBuildService.build(ic);
     // Then
     assertDockerFile()
         .hasContent("FROM busybox\n" +

diff --git a/...ce/src/test/java/org/eclipse/jkube/kit/config/service/kubernetes/JibBuildServiceTest.java b/...ce/src/test/java/org/eclipse/jkube/kit/config/service/kubernetes/JibBuildServiceTest.java
@@ -13,19 +13,26 @@
  */
 package org.eclipse.jkube.kit.config.service.kubernetes;
 
-import com.google.cloud.tools.jib.api.Credential;
+import java.io.File;
+import java.io.IOException;
+import java.nio.file.FileSystems;
+import java.nio.file.Files;
+import java.util.Collections;
+
 import org.eclipse.jkube.kit.build.api.auth.AuthConfig;
 import org.eclipse.jkube.kit.build.service.docker.auth.AuthConfigFactory;
+import org.eclipse.jkube.kit.common.JKubeConfiguration;
 import org.eclipse.jkube.kit.common.JavaProject;
 import org.eclipse.jkube.kit.common.KitLogger;
-import org.eclipse.jkube.kit.config.image.ImageConfiguration;
 import org.eclipse.jkube.kit.common.RegistryConfig;
-import org.eclipse.jkube.kit.common.JKubeConfiguration;
+import org.eclipse.jkube.kit.config.image.ImageConfiguration;
 import org.eclipse.jkube.kit.config.image.build.BuildConfiguration;
 import org.eclipse.jkube.kit.config.image.build.JKubeBuildStrategy;
 import org.eclipse.jkube.kit.config.service.JKubeServiceException;
 import org.eclipse.jkube.kit.config.service.JKubeServiceHub;
 import org.eclipse.jkube.kit.service.jib.JibServiceUtil;
+
+import com.google.cloud.tools.jib.api.Credential;
 import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
@@ -36,12 +43,6 @@
 import org.mockito.MockedStatic;
 import org.mockito.junit.MockitoJUnitRunner;
 
-import java.io.File;
-import java.io.IOException;
-import java.nio.file.FileSystems;
-import java.nio.file.Files;
-import java.util.Collections;
-
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotNull;
@@ -206,7 +207,7 @@ public void build_withImageBuildConfigurationSkipTrue_shouldNotBuildImage() thro
                 .build())
             .build();
         // When
-        new JibBuildService(mockedServiceHub).build(Collections.singletonList(imageConfiguration));
+        new JibBuildService(mockedServiceHub).build(imageConfiguration);
         // Then
         jibServiceUtilMockedStatic.verify(() -> JibServiceUtil.buildContainer(any(), any(), any()), times(0));
     }
@@ -229,4 +230,4 @@ private MockedConstruction<AuthConfigFactory> mockAuthConfig(boolean isPush) {
                     .build());
         });
     }
-}
+}
diff --git a/...c/test/java/org/eclipse/jkube/kit/config/service/openshift/OpenShiftBuildServiceTest.java b/...c/test/java/org/eclipse/jkube/kit/config/service/openshift/OpenShiftBuildServiceTest.java
@@ -27,7 +27,6 @@
 import org.mockito.junit.MockitoJUnitRunner;
 
 import java.io.IOException;
-import java.util.Collection;
 import java.util.Collections;
 
 import static org.assertj.core.api.Assertions.assertThat;
@@ -64,37 +63,37 @@ public void push_withDefaults_shouldLogWarning() throws JKubeServiceException {
   public void initClient_withNoOpenShift_shouldThrowException() {
     // Given
     //  @formatter:off
-    Collection<ImageConfiguration> imageConfigurations = Collections.singletonList(ImageConfiguration.builder()
+    ImageConfiguration imageConfiguration = ImageConfiguration.builder()
       .name("foo/bar:latest")
       .build(BuildConfiguration.builder()
         .from("baseimage:latest")
         .build())
-      .build());
+      .build();
     // @formatter:on
     OpenshiftBuildService openshiftBuildService = new OpenshiftBuildService(jKubeServiceHub);
 
     // When + Then
-    IllegalStateException illegalStateException = assertThrows(IllegalStateException.class, () -> openshiftBuildService.build(imageConfigurations));
+    IllegalStateException illegalStateException = assertThrows(IllegalStateException.class, () -> openshiftBuildService.build(imageConfiguration));
     assertThat(illegalStateException.getMessage())
         .isEqualTo("OpenShift platform has been specified but OpenShift has not been detected!");
   }
 
   @Test
   public void build_withImageBuildConfigurationSkipEnabled_shouldNotBuildImage() throws JKubeServiceException, IOException {
     // Given
-    Collection<ImageConfiguration> imageConfigurations = Collections.singletonList(ImageConfiguration.builder()
+    ImageConfiguration imageConfiguration = ImageConfiguration.builder()
         .name("foo/bar:latest")
         .build(BuildConfiguration.builder()
             .from("baseimage:latest")
             .skip(true)
             .build())
-        .build());
+        .build();
     ArchiveService mockedArchiveService = mock(ArchiveService.class, RETURNS_DEEP_STUBS);
     when(jKubeServiceHub.getDockerServiceHub().getArchiveService()).thenReturn(mockedArchiveService);
     OpenshiftBuildService openshiftBuildService = new OpenshiftBuildService(jKubeServiceHub);
 
     // When
-    openshiftBuildService.build(imageConfigurations);
+    openshiftBuildService.build(imageConfiguration);
 
     // Then
     verify(mockedArchiveService, times(0))