Skip to content

Commit

Permalink
feat (jkube-kit) : Initial draft for JKube Actions Summary (#1033)
Browse files Browse the repository at this point in the history 
Add summary for jkube build actions in order to improve ux.

Signed-off-by: Rohan Kumar <rohaan@redhat.com>
  • Loading branch information
@rohanKanojia
rohanKanojia committed Aug 2, 2022
1 parent aa5f8b3 commit 5fc47fa
Show file tree
Hide file tree
Showing 58 changed files with 1,073 additions and 57 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Expand Up @@ -22,6 +22,7 @@ Usage:
```
### 1.9.0-SNAPSHOT
* Fix #777: `k8s:build` with Dockerfile throws `Connection reset by peer` error on old docker daemons
* Fix #1033: Print summary after jkube actions
* Fix #1279: Remove redundant log messages regarding plugin modes
* Fix #1361: VolumePermissionEnricher : Use `.spec.storageClassName` instead of annotation to set PersistentVolume class
* Fix #1411: Add support for adding additional ImageStreamTags in OpenShift S2I builds
Expand Down
1 change: 1 addition & 0 deletions gradle-plugin/doc/src/main/asciidoc/index.adoc
View file
Expand Up @@ -45,4 +45,5 @@ include::inc/_authentication.adoc[]

include::inc/_kind-filename-type-mapping.adoc[]

include::{kitdoc-path}/inc/_summary.adoc[]

11 changes: 10 additions & 1 deletion gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/AutoTLSIT.java
View file
Expand Up @@ -39,6 +39,15 @@ public void ocResource_whenRun_generatesOpenShiftManifestsWithExpectedTLSAnnotat
.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 Resource Files:")
.contains("Individual :")
.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("Aggregate : ")
.contains("build/classes/java/main/META-INF/jkube/openshift.yml")
.contains("SUCCESS");
}
}
29 changes: 27 additions & 2 deletions gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/ConfigMapIT.java
View file
Expand Up @@ -43,7 +43,19 @@ public void k8sResource_whenRun_generatesK8sManifestsContainingConfigMap() throw
.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("Generator Name : spring-boot")
.contains("Generated Resource Files:")
.contains("Individual :")
.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("Aggregate : ")
.contains("build/classes/java/main/META-INF/jkube/kubernetes.yml")
.contains("SUCCESS");
}

@Test
Expand All @@ -63,6 +75,19 @@ public void ocResource_whenRun_generatesOpenShiftManifestsContainingConfigMap()
.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("Generator Name : spring-boot")
.contains("Generated Resource Files:")
.contains("Individual :")
.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("Aggregate : ")
.contains("build/classes/java/main/META-INF/jkube/openshift.yml")
.contains("SUCCESS");
}
}
18 changes: 16 additions & 2 deletions gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/DebugModeIT.java
View file
Expand Up @@ -39,7 +39,14 @@ public void k8sResource_whenRun_generatesK8sManifests() throws IOException, Pars
.contains("Adding a default Deployment")
.contains("Adding revision history limit to 2")
.contains("Enabling debug on")
.contains("validating");
.contains("validating")
.contains("SUMMARY")
.contains("Generated Resource Files:")
.contains("Individual :")
.contains("build/classes/java/main/META-INF/jkube/kubernetes/debug-mode-deployment.yml")
.contains("Aggregate : ")
.contains("build/classes/java/main/META-INF/jkube/kubernetes.yml")
.contains("SUCCESS");
}

@Test
Expand All @@ -54,6 +61,13 @@ public void ocResource_whenRun_generatesK8sManifests() throws IOException, Parse
.contains("Adding a default Deployment")
.contains("Adding revision history limit to 2")
.contains("Enabling debug on")
.contains("validating");
.contains("validating")
.contains("SUMMARY")
.contains("Generated Resource Files:")
.contains("Individual :")
.contains("build/classes/java/main/META-INF/jkube/openshift/debug-mode-deploymentconfig.yml")
.contains("Aggregate : ")
.contains("build/classes/java/main/META-INF/jkube/openshift.yml")
.contains("SUCCESS");
}
}
18 changes: 16 additions & 2 deletions ...le-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/DefaultControllerIT.java
View file
Expand Up @@ -40,7 +40,14 @@ public void k8sResourceTask_whenRun_generatesK8sManifestWithDeployment() throws
.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 Resource Files:")
.contains("Individual :")
.contains("build/classes/java/main/META-INF/jkube/kubernetes/controller-deployment.yml")
.contains("Aggregate : ")
.contains("build/classes/java/main/META-INF/jkube/kubernetes.yml")
.contains("SUCCESS");
}

@Test
Expand All @@ -56,6 +63,13 @@ public void ocResourceTask_whenRun_generatesOpenShiftManifestWithDeploymentConfi
.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 Resource Files:")
.contains("Individual :")
.contains("build/classes/java/main/META-INF/jkube/openshift/controller-deploymentconfig.yml")
.contains("Aggregate : ")
.contains("build/classes/java/main/META-INF/jkube/openshift.yml")
.contains("SUCCESS");
}
}
35 changes: 32 additions & 3 deletions gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/DefaultMetadataIT.java
View file
Expand Up @@ -39,7 +39,16 @@ public void k8sResource_whenRun_generatesK8sManifestsWithExpectedLabelsAndAnnota
.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 Resource Files:")
.contains("Individual :")
.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("Aggregate : ")
.contains("build/classes/java/main/META-INF/jkube/kubernetes.yml")
.contains("SUCCESS");
}

@Test
Expand All @@ -56,7 +65,17 @@ public void k8sResource_whenRunWithReplicaSetConfiguredController_generatesK8sMa
.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 Resource Files:")
.contains("Individual :")
.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("Aggregate : ")
.contains("build/classes/java/main/META-INF/jkube/kubernetes.yml")
.contains("SUCCESS");
}

@Test
Expand All @@ -71,6 +90,16 @@ public void ocResource_whenRun_generatesK8sManifestsWithExpectedLabelsAndAnnotat
.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 Resource Files:")
.contains("Individual :")
.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("Aggregate : ")
.contains("build/classes/java/main/META-INF/jkube/openshift.yml")
.contains("SUCCESS");
}
}
20 changes: 18 additions & 2 deletions ...-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/DependencyResourcesIT.java
View file
Expand Up @@ -42,7 +42,15 @@ public void k8sResource_whenRun_generatesK8sManifestsIncludingDependencies() thr
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 Resource Files:")
.contains("Individual :")
.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("Aggregate : ")
.contains("build/classes/java/main/META-INF/jkube/kubernetes.yml")
.contains("SUCCESS");
}

@Test
Expand All @@ -59,6 +67,14 @@ public void k8sResource_whenRunWithReplicas_generatesK8sManifestsIncludingDepend
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 Resource Files:")
.contains("Individual :")
.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("Aggregate : ")
.contains("build/classes/java/main/META-INF/jkube/kubernetes.yml")
.contains("SUCCESS");
}
}
21 changes: 19 additions & 2 deletions gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/DockerfileSimpleIT.java
View file
Expand Up @@ -40,7 +40,15 @@ public void k8sResource_whenRun_generatesK8sManifests() throws IOException, Pars
.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 Resource Files:")
.contains("Individual :")
.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("Aggregate : ")
.contains("build/classes/java/main/META-INF/jkube/kubernetes.yml")
.contains("SUCCESS");
}

@Test
Expand All @@ -56,6 +64,15 @@ public void ocResource_whenRun_generatesOpenShiftManifests() throws IOException,
.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 Resource Files:")
.contains("Individual :")
.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("Aggregate : ")
.contains("build/classes/java/main/META-INF/jkube/openshift.yml")
.contains("SUCCESS");
}
}
18 changes: 16 additions & 2 deletions gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/FileSecretIT.java
View file
Expand Up @@ -37,7 +37,14 @@ public void k8sResource_whenRun_generatesK8sSecret() throws IOException, ParseEx
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 Resource Files:")
.contains("Individual :")
.contains("build/classes/java/main/META-INF/jkube/kubernetes/secret-file-secret.yml")
.contains("Aggregate : ")
.contains("build/classes/java/main/META-INF/jkube/kubernetes.yml")
.contains("SUCCESS");
}

@Test
Expand All @@ -50,6 +57,13 @@ public void ocResource_whenRun_generatesK8sSecret() throws IOException, ParseExc
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 Resource Files:")
.contains("Individual :")
.contains("build/classes/java/main/META-INF/jkube/openshift/secret-file-secret.yml")
.contains("Aggregate : ")
.contains("build/classes/java/main/META-INF/jkube/openshift.yml")
.contains("SUCCESS");
}
}
18 changes: 16 additions & 2 deletions gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/GitAnnotationsIT.java
View file
Expand Up @@ -38,7 +38,14 @@ public void k8sResource_whenRun_generatesK8sManifestsWithGitAnnotations() throws
.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 Resource Files:")
.contains("Individual :")
.contains("build/classes/java/main/META-INF/jkube/kubernetes/git-annotations-deployment.yml")
.contains("Aggregate : ")
.contains("build/classes/java/main/META-INF/jkube/kubernetes.yml")
.contains("SUCCESS");
}

@Test
Expand All @@ -52,6 +59,13 @@ public void ocResource_whenRun_generatesOpenShiftManifestsWithGitAnnotations() t
.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 Resource Files:")
.contains("Individual :")
.contains("build/classes/java/main/META-INF/jkube/openshift/git-annotations-deploymentconfig.yml")
.contains("Aggregate : ")
.contains("build/classes/java/main/META-INF/jkube/openshift.yml")
.contains("SUCCESS");
}
}
10 changes: 9 additions & 1 deletion gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/GroovyDSLImageIT.java
View file
Expand Up @@ -39,6 +39,14 @@ public void k8sResource_whenRun_generatesK8sManifests() throws IOException, Pars
.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 Resource Files:")
.contains("Individual :")
.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("Aggregate : ")
.contains("build/classes/java/main/META-INF/jkube/kubernetes.yml")
.contains("SUCCESS");
}
}
9 changes: 8 additions & 1 deletion ...e-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/ImageChangeTriggerIT.java
View file
Expand Up @@ -61,6 +61,13 @@ public void ocResource_whenRunWithProvidedArg_generatesDeploymentConfigWithNoIma
.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 Resource Files:")
.contains("Individual :")
.contains("build/classes/java/main/META-INF/jkube/openshift/imagechangetrigger-deploymentconfig.yml")
.contains("Aggregate : ")
.contains("build/classes/java/main/META-INF/jkube/openshift.yml")
.contains("SUCCESS");
}
}
18 changes: 16 additions & 2 deletions gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/ImagePullPolicyIT.java
View file
Expand Up @@ -68,7 +68,14 @@ public void k8sResource_whenRun_generatesK8sManifestsWithProjectLabels() throws
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 Resource Files:")
.contains("Individual :")
.contains("build/classes/java/main/META-INF/jkube/kubernetes/imagepullpolicy-deployment.yml")
.contains("Aggregate : ")
.contains("build/classes/java/main/META-INF/jkube/kubernetes.yml")
.contains("SUCCESS");
}

@Test
Expand All @@ -86,6 +93,13 @@ public void ocResource_whenRun_generatesOpenShiftManifestsWithProjectLabels() th
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 Resource Files:")
.contains("Individual :")
.contains("build/classes/java/main/META-INF/jkube/openshift/imagepullpolicy-deploymentconfig.yml")
.contains("Aggregate : ")
.contains("build/classes/java/main/META-INF/jkube/openshift.yml")
.contains("SUCCESS");
}
}
11 changes: 10 additions & 1 deletion gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/IngressIT.java
View file
Expand Up @@ -76,6 +76,15 @@ public void k8sResourceTask_whenRun_generatesK8sManifestWithIngress() throws IOE
.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 Resource Files:")
.contains("Individual :")
.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("Aggregate : ")
.contains("build/classes/java/main/META-INF/jkube/kubernetes.yml")
.contains("SUCCESS");
}
}

0 comments on commit 5fc47fa

Please sign in to comment.