Skip to content

Commit

Permalink
feat (jkube-kit) : Initial draft for JKube Actions Summary (eclipse-j…
Browse files Browse the repository at this point in the history 
…kube#1033)

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 Mar 1, 2023
1 parent fed7f07 commit 22868b0
Show file tree
Hide file tree
Showing 134 changed files with 1,703 additions and 90 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Expand Up @@ -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)
Expand Down
1 change: 1 addition & 0 deletions gradle-plugin/doc/src/main/asciidoc/index.adoc
View file
Expand Up @@ -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[]

9 changes: 8 additions & 1 deletion gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/AutoTLSIT.java
View file
Expand Up @@ -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");
}
}
25 changes: 23 additions & 2 deletions gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/ConfigMapIT.java
View file
Expand Up @@ -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
Expand All @@ -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");
}
}
14 changes: 12 additions & 2 deletions gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/DebugModeIT.java
View file
Expand Up @@ -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
Expand All @@ -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");
}
}
14 changes: 12 additions & 2 deletions ...le-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/DefaultControllerIT.java
View file
Expand Up @@ -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
Expand All @@ -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");
}
}
29 changes: 26 additions & 3 deletions gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/DefaultMetadataIT.java
View file
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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");
}
}
16 changes: 14 additions & 2 deletions ...-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/DependencyResourcesIT.java
View file
Expand Up @@ -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
Expand All @@ -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");
}
}
17 changes: 15 additions & 2 deletions gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/DockerfileSimpleIT.java
View file
Expand Up @@ -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
Expand All @@ -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");
}
}
14 changes: 12 additions & 2 deletions gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/FileSecretIT.java
View file
Expand Up @@ -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
Expand All @@ -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");
}
}
14 changes: 12 additions & 2 deletions gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/GitAnnotationsIT.java
View file
Expand Up @@ -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
Expand All @@ -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");
}
}
8 changes: 7 additions & 1 deletion gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/GroovyDSLImageIT.java
View file
Expand Up @@ -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");
}
}
7 changes: 6 additions & 1 deletion ...e-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/ImageChangeTriggerIT.java
View file
Expand Up @@ -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");
}
}
14 changes: 12 additions & 2 deletions gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/ImagePullPolicyIT.java
View file
Expand Up @@ -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} ")
Expand All @@ -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");
}
}
9 changes: 8 additions & 1 deletion gradle-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/IngressIT.java
View file
Expand Up @@ -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");
}
}
14 changes: 12 additions & 2 deletions ...-plugin/it/src/test/java/org/eclipse/jkube/gradle/plugin/tests/JavaOptionsEnvMergeIT.java
View file
Expand Up @@ -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
Expand All @@ -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");
}
}

0 comments on commit 22868b0

Please sign in to comment.