-
Notifications
You must be signed in to change notification settings - Fork 522
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(helm): HelmService exposes Helm test functionality (3399)
feat (jkube-kit/helm) : HelmService exposes Helm test functionality Add `test` method in HelmService Signed-off-by: Rohan Kumar <[email protected]> --- review: helm test service Signed-off-by: Marc Nuri <[email protected]> Co-authored-by: Marc Nuri <[email protected]>
- Loading branch information
1 parent
d02162a
commit 47f9136
Showing
15 changed files
with
367 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
180 changes: 180 additions & 0 deletions
180
jkube-kit/helm/src/test/java/org/eclipse/jkube/kit/resource/helm/HelmServiceTestIT.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,180 @@ | ||
| /* | ||
| * Copyright (c) 2019 Red Hat, Inc. | ||
| * This program and the accompanying materials are made | ||
| * available under the terms of the Eclipse Public License 2.0 | ||
| * which is available at: | ||
| * | ||
| * https://www.eclipse.org/legal/epl-2.0/ | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| * | ||
| * Contributors: | ||
| * Red Hat, Inc. - initial API and implementation | ||
| */ | ||
| package org.eclipse.jkube.kit.resource.helm; | ||
|
|
||
| import io.fabric8.kubernetes.api.model.PodBuilder; | ||
| import io.fabric8.kubernetes.api.model.Secret; | ||
| import io.fabric8.kubernetes.api.model.SecretListBuilder; | ||
| import io.fabric8.kubernetes.client.KubernetesClient; | ||
| import io.fabric8.kubernetes.client.server.mock.KubernetesMixedDispatcher; | ||
| import io.fabric8.kubernetes.client.server.mock.KubernetesMockServer; | ||
| import io.fabric8.mockwebserver.Context; | ||
| import io.fabric8.mockwebserver.ServerRequest; | ||
| import io.fabric8.mockwebserver.ServerResponse; | ||
| import okhttp3.mockwebserver.MockWebServer; | ||
| import org.apache.commons.io.IOUtils; | ||
| 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.common.access.ClusterConfiguration; | ||
| import org.eclipse.jkube.kit.common.util.AsyncUtil; | ||
| import org.eclipse.jkube.kit.config.resource.ResourceServiceConfig; | ||
| import org.junit.jupiter.api.AfterEach; | ||
| import org.junit.jupiter.api.BeforeEach; | ||
| import org.junit.jupiter.api.DisplayName; | ||
| import org.junit.jupiter.api.Nested; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.api.io.TempDir; | ||
|
|
||
| import java.io.ByteArrayOutputStream; | ||
| import java.io.File; | ||
| import java.io.PrintStream; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.nio.file.Path; | ||
| import java.util.Collections; | ||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
| import java.util.Objects; | ||
| import java.util.Queue; | ||
| import java.util.concurrent.CompletableFuture; | ||
| import java.util.concurrent.TimeUnit; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static org.assertj.core.api.Assertions.assertThatIllegalStateException; | ||
| import static org.eclipse.jkube.kit.common.util.KubernetesMockServerUtil.prepareMockWebServerExpectationsForAggregatedDiscoveryEndpoints; | ||
|
|
||
| @DisplayName("HelmService.test") | ||
| class HelmServiceTestIT { | ||
| @TempDir | ||
| private Path tempDir; | ||
| private KubernetesMockServer server; | ||
| private KubernetesClient kubernetesClient; | ||
| private ByteArrayOutputStream logOutput; | ||
| private HelmService helmService; | ||
| private HelmConfig helmConfig; | ||
|
|
||
| @BeforeEach | ||
| void setUp() throws Exception { | ||
| final Map<ServerRequest, Queue<ServerResponse>> responses = new HashMap<>(); | ||
| server = new KubernetesMockServer(new Context(), new MockWebServer(), responses, new KubernetesMixedDispatcher(responses), true); | ||
| server.init(); | ||
| // Remove after https://github.com/fabric8io/kubernetes-client/issues/6062 is fixed | ||
| prepareMockWebServerExpectationsForAggregatedDiscoveryEndpoints(server); | ||
| kubernetesClient = server.createClient(); | ||
| logOutput = new ByteArrayOutputStream(); | ||
| final Path outputDir = tempDir.resolve("output"); | ||
| helmService = new HelmService(JKubeConfiguration.builder() | ||
| .project(JavaProject.builder() | ||
| .buildDirectory(tempDir.resolve("target").toFile()) | ||
| .build()) | ||
| .clusterConfiguration(ClusterConfiguration.from(kubernetesClient.getConfiguration()).build()) | ||
| .build(), ResourceServiceConfig.builder() | ||
| .resourceDirs(Collections.singletonList( | ||
| new File(Objects.requireNonNull(HelmServiceInstallIT.class.getResource("/it/helm-service-test/resources")).getFile()))) | ||
| .build(), new KitLogger.PrintStreamLogger(new PrintStream(logOutput))); | ||
| helmConfig = HelmConfig.builder() | ||
| .chart("helm-test") | ||
| .version("0.1.0") | ||
| .chartExtension("tgz") | ||
| .types(Collections.singletonList(HelmConfig.HelmType.KUBERNETES)) | ||
| .tarballOutputDir(outputDir.toFile().getAbsolutePath()) | ||
| .outputDir(outputDir.toString()) | ||
| .sourceDir(new File(Objects.requireNonNull(HelmServiceInstallIT.class.getResource("/it/sources")).toURI()).getAbsolutePath()) | ||
| .releaseName("test-project") | ||
| .disableOpenAPIValidation(true) | ||
| .build(); | ||
| } | ||
|
|
||
| @AfterEach | ||
| void stopKubernetesServer() { | ||
| kubernetesClient.close(); | ||
| server.destroy(); | ||
| } | ||
|
|
||
| @Nested | ||
| class WithChartInstalled { | ||
|
|
||
| @BeforeEach | ||
| void setUp() throws Exception { | ||
| // OpenAPI validation endpoints required by helm test | ||
| server.expect().get().withPath("/openapi/v3?timeout=32s") | ||
| .andReturn(200, IOUtils.toString(Objects.requireNonNull(HelmServiceTestIT.class.getResourceAsStream("/it/helm-service-test/kubernetes-openapi-v3-schema.json")), StandardCharsets.UTF_8)) | ||
| .always(); | ||
| server.expect().get().withPath("/openapi/v3/api/v1?timeout=32s") | ||
| .andReturn(200, IOUtils.toString(Objects.requireNonNull(HelmServiceTestIT.class.getResourceAsStream("/it/helm-service-test/kubernetes-openapi-v3-api-v1-schema-pod.json")), StandardCharsets.UTF_8)) | ||
| .always(); | ||
| // Chart is installed | ||
| helmService.generateHelmCharts(helmConfig); | ||
| helmService.install(helmConfig); | ||
| Secret secret = kubernetesClient.secrets().withName("sh.helm.release.v1.test-project.v1").get(); | ||
| server.expect().get().withPath("/api/v1/namespaces/test/secrets?labelSelector=name%3Dtest-project%2Cowner%3Dhelm") | ||
| .andReturn(200, new SecretListBuilder() | ||
| .addToItems(secret) | ||
| .build()) | ||
| .once(); | ||
| } | ||
|
|
||
| @Test | ||
| @DisplayName("when valid chart but test timeout too low, then throw exception") | ||
| void tooLowTimeout_thenThrowException() { | ||
| // Given | ||
| helmConfig.setTimeout(1); | ||
| // Then | ||
| assertThatIllegalStateException() | ||
| .isThrownBy(() -> helmService.test(helmConfig)) | ||
| .withMessageContaining("timed out waiting for the condition"); | ||
| } | ||
|
|
||
| @Test | ||
| @DisplayName("when valid chart release provided, then log test details after test completion") | ||
| void validChartRelease_thenLogChartTestDetails() { | ||
| // Given | ||
| CompletableFuture<Boolean> helmTest = AsyncUtil.async(() -> { | ||
| helmService.test(helmConfig); | ||
| return true; | ||
| }); | ||
| kubernetesClient.pods().withName("test-project-test-connection") | ||
| .waitUntilCondition(Objects::nonNull, 500, TimeUnit.MILLISECONDS); | ||
| // When | ||
| kubernetesClient.pods().withName("test-project-test-connection").editStatus(p -> new PodBuilder(p) | ||
| .editOrNewStatus() | ||
| .withPhase("Succeeded") | ||
| .endStatus() | ||
| .build()); | ||
| // Then | ||
| assertThat(helmTest).succeedsWithin(5, TimeUnit.SECONDS); | ||
| assertThat(logOutput) | ||
| .asString() | ||
| .containsSubsequence( | ||
| "[INFO] Testing Helm Chart helm-test 0.1.0", | ||
| "[INFO] [[W]]NAME: test-project", | ||
| "[INFO] [[W]]NAMESPACE: ", | ||
| "[INFO] [[W]]STATUS: deployed", | ||
| "[INFO] [[W]]REVISION: 1", | ||
| "[INFO] [[W]]Phase: Succeeded"); | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| @DisplayName("when unknown chart release provided, then throw exception") | ||
| void invalidChartRelease_thenLogChartTestDetails() { | ||
| // Given | ||
| helmConfig.setReleaseName("i-was-never-created"); | ||
| // When | ||
| assertThatIllegalStateException() | ||
| .isThrownBy(() -> helmService.test(helmConfig)) | ||
| .withMessageContaining("not found"); | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.