feat (jkube-kit) : Initial draft for JKube Actions Summary (#1033)

CHANGELOG.md

@@ -21,6 +21,7 @@ Usage:
 ./scripts/extract-changelog-for-version.sh 1.3.37 5
 ```
 ### 1.12-SNAPSHOT
+* Fix #1033: Print summary after jkube actions
 * Fix #1273: Deprecate `jkube.io` annotation prefix in favor of `jkube.eclipse.org` for JKubeAnnotations
 
 ### 1.11.0 (2023-02-16)

gradle-plugin/doc/src/main/asciidoc/index.adoc

@@ -47,4 +47,5 @@ include::{kitdoc-path}/inc/plugins/_jkube_plugins.adoc[]
 
 include::inc/_kind-filename-type-mapping.adoc[]
 
+include::{kitdoc-path}/inc/_summary.adoc[]
 

gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/AutoTLSIT.java

@@ -39,6 +39,13 @@ void ocResource_whenRun_generatesOpenShiftManifestsWithExpectedTLSAnnotationsAnd
         .contains("Adding a default Deployment")
         .contains("Adding revision history limit to 2")
         .contains("Using first mentioned service port")
-        .contains("validating");
+        .contains("validating")
+        .contains("SUMMARY")
+        .contains("Generated resources:")
+        .contains("build/classes/java/main/META-INF/jkube/openshift/autotls-service.yml")
+        .contains("build/classes/java/main/META-INF/jkube/openshift/autotls-route.yml")
+        .contains("build/classes/java/main/META-INF/jkube/openshift/autotls-deploymentconfig.yml")
+        .contains("build/classes/java/main/META-INF/jkube/openshift.yml")
+        .contains("SUCCESS");
   }
 }

gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/ConfigMapIT.java

@@ -43,7 +43,17 @@ void k8sResource_whenRun_generatesK8sManifestsContainingConfigMap() throws IOExc
         .contains("jkube-healthcheck-spring-boot: Adding readiness probe on port 8080")
         .contains("jkube-healthcheck-spring-boot: Adding liveness probe on port 8080")
         .contains("jkube-service-discovery: Using first mentioned service port '8080' ")
-        .contains("jkube-revision-history: Adding revision history limit to 2");
+        .contains("jkube-revision-history: Adding revision history limit to 2")
+        .contains("SUMMARY")
+        .contains("Generators applied: [spring-boot]")
+        .contains("Generated resources:")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes/configmap-service.yml")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes/configmap-deployment.yml")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes/jkube-annotation-directory-configmap.yml")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes/jkube-annotation-file-configmap.yml")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes/jkube-gradle-sample-config-map-configmap.yml")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes.yml")
+        .contains("SUCCESS");
   }
 
   @Test
@@ -63,6 +73,17 @@ void ocResource_whenRun_generatesOpenShiftManifestsContainingConfigMap() throws
         .contains("jkube-healthcheck-spring-boot: Adding readiness probe on port 8080")
         .contains("jkube-healthcheck-spring-boot: Adding liveness probe on port 8080")
         .contains("jkube-service-discovery: Using first mentioned service port '8080' ")
-        .contains("jkube-revision-history: Adding revision history limit to 2");
+        .contains("jkube-revision-history: Adding revision history limit to 2")
+        .contains("SUMMARY")
+        .contains("Generators applied: [spring-boot]")
+        .contains("Generated resources:")
+        .contains("build/classes/java/main/META-INF/jkube/openshift/configmap-service.yml")
+        .contains("build/classes/java/main/META-INF/jkube/openshift/configmap-route.yml")
+        .contains("build/classes/java/main/META-INF/jkube/openshift/jkube-annotation-directory-configmap.yml")
+        .contains("build/classes/java/main/META-INF/jkube/openshift/jkube-annotation-file-configmap.yml")
+        .contains("build/classes/java/main/META-INF/jkube/openshift/jkube-gradle-sample-config-map-configmap.yml")
+        .contains("build/classes/java/main/META-INF/jkube/openshift/configmap-deploymentconfig.yml")
+        .contains("build/classes/java/main/META-INF/jkube/openshift.yml")
+        .contains("SUCCESS");
   }
 }

gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/DebugModeIT.java

@@ -40,7 +40,12 @@ void k8sResource_whenRun_generatesK8sManifests() throws IOException, ParseExcept
         .contains("Adding a default Deployment")
         .contains("Adding revision history limit to 2")
         .contains("Enabling debug on")
-        .contains("validating");
+        .contains("validating")
+        .contains("SUMMARY")
+        .contains("Generated resources:")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes/debug-mode-deployment.yml")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes.yml")
+        .contains("SUCCESS");
   }
 
   @Test
@@ -55,6 +60,11 @@ void ocResource_whenRun_generatesK8sManifests() throws IOException, ParseExcepti
         .contains("Adding a default Deployment")
         .contains("Adding revision history limit to 2")
         .contains("Enabling debug on")
-        .contains("validating");
+        .contains("validating")
+        .contains("SUMMARY")
+        .contains("Generated resources:")
+        .contains("build/classes/java/main/META-INF/jkube/openshift/debug-mode-deploymentconfig.yml")
+        .contains("build/classes/java/main/META-INF/jkube/openshift.yml")
+        .contains("SUCCESS");
   }
 }

gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/DefaultControllerIT.java

@@ -40,7 +40,12 @@ void k8sResourceTask_whenRun_generatesK8sManifestWithDeployment() throws IOExcep
         .contains("Using resource templates from")
         .contains("Adding a default Deployment")
         .contains("Adding revision history limit to 2")
-        .contains("validating");
+        .contains("validating")
+        .contains("SUMMARY")
+        .contains("Generated resources:")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes/controller-deployment.yml")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes.yml")
+        .contains("SUCCESS");
   }
 
   @Test
@@ -56,6 +61,11 @@ void ocResourceTask_whenRun_generatesOpenShiftManifestWithDeploymentConfig() thr
         .contains("Using resource templates from")
         .contains("Adding a default Deployment")
         .contains("Adding revision history limit to 2")
-        .contains("validating");
+        .contains("validating")
+        .contains("SUMMARY")
+        .contains("Generated resources:")
+        .contains("build/classes/java/main/META-INF/jkube/openshift/controller-deploymentconfig.yml")
+        .contains("build/classes/java/main/META-INF/jkube/openshift.yml")
+        .contains("SUCCESS");
   }
 }

gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/DefaultMetadataIT.java

@@ -39,7 +39,14 @@ void k8sResource_whenRun_generatesK8sManifestsWithExpectedLabelsAndAnnotations()
         .contains("Adding a default Deployment")
         .contains("Adding revision history limit to 2")
         .contains("Using first mentioned service port")
-        .contains("validating");
+        .contains("validating")
+        .contains("SUMMARY")
+        .contains("Generated resources:")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes/metadata-deployment.yml")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes/metadata-service.yml")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes/test-serviceaccount-serviceaccount.yml")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes.yml")
+        .contains("SUCCESS");
   }
 
   @Test
@@ -56,7 +63,15 @@ void k8sResource_whenRunWithReplicaSetConfiguredController_generatesK8sManifests
         .contains("Adding a default ReplicaSet")
         .contains("Adding revision history limit to 2")
         .contains("Using first mentioned service port")
-        .contains("validating");
+        .contains("validating")
+        .contains("SUMMARY")
+        .contains("Generated resources:")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes/metadata-deployment.yml")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes/metadata-replicaset.yml")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes/metadata-service.yml")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes/test-serviceaccount-serviceaccount.yml")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes.yml")
+        .contains("SUCCESS");
   }
 
   @Test
@@ -71,6 +86,14 @@ void ocResource_whenRun_generatesK8sManifestsWithExpectedLabelsAndAnnotations()
         .contains("Adding a default Deployment")
         .contains("Adding revision history limit to 2")
         .contains("Using first mentioned service port")
-        .contains("validating");
+        .contains("validating")
+        .contains("SUMMARY")
+        .contains("Generated resources:")
+        .contains("build/classes/java/main/META-INF/jkube/openshift/metadata-deploymentconfig.yml")
+        .contains("build/classes/java/main/META-INF/jkube/openshift/metadata-route.yml")
+        .contains("build/classes/java/main/META-INF/jkube/openshift/metadata-service.yml")
+        .contains("build/classes/java/main/META-INF/jkube/openshift/test-serviceaccount-serviceaccount.yml")
+        .contains("build/classes/java/main/META-INF/jkube/openshift.yml")
+        .contains("SUCCESS");
   }
 }

gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/DependencyResourcesIT.java

@@ -42,7 +42,13 @@ void k8sResource_whenRun_generatesK8sManifestsIncludingDependencies() throws IOE
     assertThat(result).extracting(BuildResult::getOutput).asString()
         .contains("Using resource templates from")
         .contains("Adding revision history limit to 2")
-        .contains("validating");
+        .contains("validating")
+        .contains("SUMMARY")
+        .contains("Generated resources:")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes/example-deployment.yml")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes/web-replicaset.yml")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes.yml")
+        .contains("SUCCESS");
   }
 
   @Test
@@ -59,6 +65,12 @@ void k8sResource_whenRunWithReplicas_generatesK8sManifestsIncludingDependencies(
     assertThat(result).extracting(BuildResult::getOutput).asString()
         .contains("Using resource templates from")
         .contains("Adding revision history limit to 2")
-        .contains("validating");
+        .contains("validating")
+        .contains("SUMMARY")
+        .contains("Generated resources:")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes/example-deployment.yml")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes/web-replicaset.yml")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes.yml")
+        .contains("SUCCESS");
   }
 }

gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/DockerfileSimpleIT.java

@@ -40,7 +40,13 @@ void k8sResource_whenRun_generatesK8sManifests() throws IOException, ParseExcept
       .contains("Adding a default Deployment")
       .contains("Adding revision history limit to 2")
       .contains("Using first mentioned service port")
-      .contains("validating");
+      .contains("validating")
+      .contains("SUMMARY")
+      .contains("Generated resources:")
+      .contains("build/classes/java/main/META-INF/jkube/kubernetes/dockerfile-simple-deployment.yml")
+      .contains("build/classes/java/main/META-INF/jkube/kubernetes/dockerfile-simple-service.yml")
+      .contains("build/classes/java/main/META-INF/jkube/kubernetes.yml")
+      .contains("SUCCESS");
   }
 
   @Test
@@ -56,6 +62,13 @@ void ocResource_whenRun_generatesOpenShiftManifests() throws IOException, ParseE
       .contains("Converting Deployment to DeploymentConfig")
       .contains("Adding revision history limit to 2")
       .contains("Using first mentioned service port")
-      .contains("validating");
+      .contains("validating")
+      .contains("SUMMARY")
+      .contains("Generated resources:")
+      .contains("build/classes/java/main/META-INF/jkube/openshift/dockerfile-simple-deploymentconfig.yml")
+      .contains("build/classes/java/main/META-INF/jkube/openshift/dockerfile-simple-route.yml")
+      .contains("build/classes/java/main/META-INF/jkube/openshift/dockerfile-simple-service.yml")
+      .contains("build/classes/java/main/META-INF/jkube/openshift.yml")
+      .contains("SUCCESS");
   }
 }

gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/FileSecretIT.java

@@ -37,7 +37,12 @@ void k8sResource_whenRun_generatesK8sSecret() throws IOException, ParseException
     assertThat(result).extracting(BuildResult::getOutput).asString()
         .contains("Using resource templates from")
         .contains("Adding revision history limit to 2")
-        .contains("validating");
+        .contains("validating")
+        .contains("SUMMARY")
+        .contains("Generated resources:")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes/secret-file-secret.yml")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes.yml")
+        .contains("SUCCESS");
   }
 
   @Test
@@ -50,6 +55,11 @@ void ocResource_whenRun_generatesK8sSecret() throws IOException, ParseException
     assertThat(result).extracting(BuildResult::getOutput).asString()
         .contains("Using resource templates from")
         .contains("Adding revision history limit to 2")
-        .contains("validating");
+        .contains("validating")
+        .contains("SUMMARY")
+        .contains("Generated resources:")
+        .contains("build/classes/java/main/META-INF/jkube/openshift/secret-file-secret.yml")
+        .contains("build/classes/java/main/META-INF/jkube/openshift.yml")
+        .contains("SUCCESS");
   }
 }

gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/GitAnnotationsIT.java

@@ -38,7 +38,12 @@ void k8sResource_whenRun_generatesK8sManifestsWithGitAnnotations() throws IOExce
         .contains("Using resource templates from")
         .contains("Adding a default Deployment")
         .contains("Adding revision history limit to 2")
-        .contains("validating");
+        .contains("validating")
+        .contains("SUMMARY")
+        .contains("Generated resources:")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes/git-annotations-deployment.yml")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes.yml")
+        .contains("SUCCESS");
   }
 
   @Test
@@ -52,6 +57,11 @@ void ocResource_whenRun_generatesOpenShiftManifestsWithGitAnnotations() throws I
         .contains("Using resource templates from")
         .contains("Adding a default Deployment")
         .contains("Adding revision history limit to 2")
-        .contains("validating");
+        .contains("validating")
+        .contains("SUMMARY")
+        .contains("Generated resources:")
+        .contains("build/classes/java/main/META-INF/jkube/openshift/git-annotations-deploymentconfig.yml")
+        .contains("build/classes/java/main/META-INF/jkube/openshift.yml")
+        .contains("SUCCESS");
   }
 }

gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/GroovyDSLImageIT.java

@@ -39,6 +39,12 @@ void k8sResource_whenRun_generatesK8sManifests() throws IOException, ParseExcept
       .contains("Adding a default Deployment")
       .contains("Adding revision history limit to 2")
       .contains("Using first mentioned service port")
-      .contains("validating");
+      .contains("validating")
+      .contains("SUMMARY")
+      .contains("Generated resources:")
+      .contains("build/classes/java/main/META-INF/jkube/kubernetes/groovy-dsl-image-deployment.yml")
+      .contains("build/classes/java/main/META-INF/jkube/kubernetes/groovy-dsl-image-service.yml")
+      .contains("build/classes/java/main/META-INF/jkube/kubernetes.yml")
+      .contains("SUCCESS");
   }
 }

gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/ImageChangeTriggerIT.java

@@ -48,6 +48,11 @@ void ocResource_whenRunWithProvidedArg_generatesDeploymentConfigWithNoImageChang
         .contains("Using resource templates from")
         .contains("Adding a default Deployment")
         .contains("Adding revision history limit to 2")
-        .contains("validating");
+        .contains("validating")
+        .contains("SUMMARY")
+        .contains("Generated resources:")
+        .contains("build/classes/java/main/META-INF/jkube/openshift/imagechangetrigger-deploymentconfig.yml")
+        .contains("build/classes/java/main/META-INF/jkube/openshift.yml")
+        .contains("SUCCESS");
   }
 }

gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/ImagePullPolicyIT.java

@@ -62,7 +62,12 @@ void k8sResource_whenRun_generatesK8sManifestsWithProjectLabels(String expectedD
     assertThat(result).extracting(BuildResult::getOutput).asString()
         .contains("Using resource templates from")
         .contains("Adding revision history limit to 2")
-        .contains("validating");
+        .contains("validating")
+        .contains("SUMMARY")
+        .contains("Generated resources:")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes/imagepullpolicy-deployment.yml")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes.yml")
+        .contains("SUCCESS");
   }
 
   @ParameterizedTest(name = "resource task with {1} ")
@@ -81,6 +86,11 @@ void ocResource_whenRun_generatesOpenShiftManifestsWithProjectLabels(String expe
     assertThat(result).extracting(BuildResult::getOutput).asString()
         .contains("Using resource templates from")
         .contains("Adding revision history limit to 2")
-        .contains("validating");
+        .contains("validating")
+        .contains("SUMMARY")
+        .contains("Generated resources:")
+        .contains("build/classes/java/main/META-INF/jkube/openshift/imagepullpolicy-deploymentconfig.yml")
+        .contains("build/classes/java/main/META-INF/jkube/openshift.yml")
+        .contains("SUCCESS");
   }
 }

gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/IngressIT.java

@@ -60,6 +60,13 @@ void k8sResourceTask_whenRun_generatesK8sManifestWithIngress(String profileName,
         .contains("Using resource templates from")
         .contains("Adding a default Deployment")
         .contains("Adding revision history limit to 2")
-        .contains("validating");
+        .contains("validating")
+        .contains("SUMMARY")
+        .contains("Generated resources:")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes/ingress-deployment.yml")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes/ingress-ingress.yml")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes/ingress-service.yml")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes.yml")
+        .contains("SUCCESS");
   }
 }

gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/JavaOptionsEnvMergeIT.java

@@ -38,7 +38,12 @@ void k8sResource_whenRun_thenGeneratedManifestShouldHaveMergedEnvVariables() thr
         .contains("Using resource templates from")
         .contains("Adding a default Deployment")
         .contains("Adding revision history limit to 2")
-        .contains("validating");
+        .contains("validating")
+        .contains("SUMMARY")
+        .contains("Generated resources:")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes/java-options-env-merge-deployment.yml")
+        .contains("build/classes/java/main/META-INF/jkube/kubernetes.yml")
+        .contains("SUCCESS");
   }
 
   @Test
@@ -52,6 +57,11 @@ void ocResource_whenRun_thenGeneratedManifestShouldHaveMergedEnvVariables() thro
         .contains("Using resource templates from")
         .contains("Adding a default Deployment")
         .contains("Adding revision history limit to 2")
-        .contains("validating");
+        .contains("validating")
+        .contains("SUMMARY")
+        .contains("Generated resources:")
+        .contains("build/classes/java/main/META-INF/jkube/openshift/java-options-env-merge-deploymentconfig.yml")
+        .contains("build/classes/java/main/META-INF/jkube/openshift.yml")
+        .contains("SUCCESS");
   }
 }