Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: remove ClusterAccess wrapper class #3200

Merged
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
import org.eclipse.jkube.kit.common.ResourceFileType;
import org.eclipse.jkube.kit.common.util.OpenshiftHelper;
import org.eclipse.jkube.kit.common.util.ResourceClassifier;
import org.eclipse.jkube.kit.config.access.ClusterConfiguration;
import org.eclipse.jkube.kit.common.access.ClusterConfiguration;
import org.eclipse.jkube.kit.config.image.ImageConfiguration;
import org.eclipse.jkube.kit.config.image.WatchMode;
import org.eclipse.jkube.kit.config.image.build.JKubeBuildStrategy;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@
import org.eclipse.jkube.kit.common.RegistryConfig;
import org.eclipse.jkube.kit.common.util.LazyBuilder;
import org.eclipse.jkube.kit.common.util.ResourceUtil;
import org.eclipse.jkube.kit.config.access.ClusterAccess;
import org.eclipse.jkube.kit.config.access.ClusterConfiguration;
import org.eclipse.jkube.kit.common.access.ClusterAccess;
import org.eclipse.jkube.kit.common.access.ClusterConfiguration;
import org.eclipse.jkube.kit.config.image.ImageConfiguration;
import org.eclipse.jkube.kit.config.resource.ResourceConfig;
import org.eclipse.jkube.kit.config.resource.ResourceServiceConfig;
Expand All @@ -57,7 +57,6 @@ public abstract class AbstractJKubeTask extends DefaultTask implements Kubernete

protected final KubernetesExtension kubernetesExtension;
protected KitLogger kitLogger;
protected ClusterAccess clusterAccess;
protected JKubeServiceHub jKubeServiceHub;
protected static final String DOCKER_BUILD_TIMESTAMP = "docker/build.timestamp";
protected List<ImageConfiguration> resolvedImages;
Expand All @@ -80,7 +79,6 @@ public final void runTask() {
protected void init() {
kubernetesExtension.javaProject = GradleUtil.convertGradleProject(getProject());
kitLogger = createLogger(null);
clusterAccess = new ClusterAccess(initClusterConfiguration());
jKubeServiceHub = initJKubeServiceHubBuilder().build();
kubernetesExtension.resources = updateResourceConfigNamespace(kubernetesExtension.getNamespaceOrNull(), kubernetesExtension.resources);
resolvedImages = resolveImages();
Expand Down Expand Up @@ -142,8 +140,8 @@ protected JKubeServiceHub.JKubeServiceHubBuilder initJKubeServiceHubBuilder() {
.registry(kubernetesExtension.getPushRegistryOrNull() != null ?
kubernetesExtension.getPushRegistryOrNull() : kubernetesExtension.getRegistryOrDefault())
.build())
.clusterConfiguration(initClusterConfiguration())
.build())
.clusterAccess(clusterAccess)
.offline(kubernetesExtension.getOfflineOrDefault())
.platformMode(kubernetesExtension.getRuntimeMode())
.resourceServiceConfig(initResourceServiceConfig())
Expand Down Expand Up @@ -176,7 +174,7 @@ protected GeneratorContext.GeneratorContextBuilder initGeneratorContextBuilder()
.prePackagePhase(false)
.useProjectClasspath(kubernetesExtension.getUseProjectClassPathOrDefault())
.sourceDirectory(kubernetesExtension.getBuildSourceDirectoryOrDefault())
.openshiftNamespace(StringUtils.isNotBlank(kubernetesExtension.getNamespaceOrNull()) ? kubernetesExtension.getNamespaceOrNull() : clusterAccess.getNamespace())
.openshiftNamespace(StringUtils.isNotBlank(kubernetesExtension.getNamespaceOrNull()) ? kubernetesExtension.getNamespaceOrNull() : new ClusterAccess(initClusterConfiguration()).getNamespace())
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we need ClusterAccess here?
Have you checked what ClusterAccess.getNamespace does?

.buildTimestamp(getBuildTimestamp(null, null, kubernetesExtension.javaProject.getBuildDirectory().getAbsolutePath(),
DOCKER_BUILD_TIMESTAMP))
.filter(kubernetesExtension.getFilterOrNull());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import io.fabric8.kubernetes.client.KubernetesClient;
import io.fabric8.kubernetes.client.KubernetesClientException;
import org.eclipse.jkube.gradle.plugin.KubernetesExtension;
import org.eclipse.jkube.kit.common.access.ClusterAccess;
import org.eclipse.jkube.kit.common.util.KubernetesHelper;
import org.eclipse.jkube.kit.common.util.OpenshiftHelper;
import org.eclipse.jkube.kit.config.service.ApplyService;
Expand Down Expand Up @@ -92,6 +93,6 @@ protected void configureApplyService() {
applyService.setRollingUpgradePreserveScale(kubernetesExtension.getRollingUpgradePreserveScaleOrDefault());
applyService.setRecreateMode(kubernetesExtension.getRecreateOrDefault());
applyService.setNamespace(kubernetesExtension.getNamespaceOrNull());
applyService.setFallbackNamespace(resolveFallbackNamespace(kubernetesExtension.resources, clusterAccess));
applyService.setFallbackNamespace(resolveFallbackNamespace(kubernetesExtension.resources, new ClusterAccess(initClusterConfiguration())));
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import org.eclipse.jkube.kit.build.core.GavLabel;
import org.eclipse.jkube.kit.build.service.docker.DockerServiceHub;
import org.eclipse.jkube.kit.build.service.docker.watch.WatchContext;
import org.eclipse.jkube.kit.common.access.ClusterAccess;
import org.eclipse.jkube.kit.common.util.KubernetesHelper;
import org.eclipse.jkube.kit.common.util.ResourceUtil;
import org.eclipse.jkube.kit.config.service.JKubeServiceHub;
Expand Down Expand Up @@ -58,6 +59,7 @@ public void run() {
try {
List<HasMetadata> resources = KubernetesHelper.loadResources(getManifest(kubernetesClient));
WatcherContext context = createWatcherContext();
ClusterAccess clusterAccess = new ClusterAccess(initClusterConfiguration());

WatcherManager.watch(resolvedImages,
applicableNamespace(null, kubernetesExtension.getNamespaceOrNull(), kubernetesExtension.resources, clusterAccess),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
import io.fabric8.openshift.client.OpenShiftClient;
import org.eclipse.jkube.gradle.plugin.KubernetesExtension;
import org.eclipse.jkube.gradle.plugin.TestKubernetesExtension;
import org.eclipse.jkube.kit.config.access.ClusterAccess;
import org.eclipse.jkube.kit.common.access.ClusterAccess;
import org.eclipse.jkube.kit.config.service.ApplyService;

import org.gradle.api.provider.Property;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

import org.eclipse.jkube.gradle.plugin.KubernetesExtension;
import org.eclipse.jkube.gradle.plugin.TestKubernetesExtension;
import org.eclipse.jkube.kit.config.access.ClusterAccess;
import org.eclipse.jkube.kit.common.access.ClusterAccess;
import org.eclipse.jkube.kit.config.resource.ResourceConfig;
import org.eclipse.jkube.kit.config.service.kubernetes.KubernetesUndeployService;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
import org.eclipse.jkube.kit.build.service.docker.DockerAccessFactory;
import org.eclipse.jkube.kit.build.service.docker.access.DockerAccess;
import org.eclipse.jkube.kit.common.util.KubernetesHelper;
import org.eclipse.jkube.kit.config.access.ClusterAccess;
import org.eclipse.jkube.kit.common.access.ClusterAccess;
import org.eclipse.jkube.kit.config.service.kubernetes.DockerBuildService;
import org.eclipse.jkube.watcher.api.WatcherManager;
import org.junit.jupiter.api.AfterEach;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

import org.eclipse.jkube.gradle.plugin.OpenShiftExtension;
import org.eclipse.jkube.gradle.plugin.TestOpenShiftExtension;
import org.eclipse.jkube.kit.config.access.ClusterAccess;
import org.eclipse.jkube.kit.common.access.ClusterAccess;
import org.eclipse.jkube.kit.config.service.ApplyService;

import io.fabric8.openshift.client.OpenShiftClient;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

import org.eclipse.jkube.gradle.plugin.OpenShiftExtension;
import org.eclipse.jkube.gradle.plugin.TestOpenShiftExtension;
import org.eclipse.jkube.kit.config.access.ClusterAccess;
import org.eclipse.jkube.kit.common.access.ClusterAccess;
import org.eclipse.jkube.kit.config.resource.ResourceConfig;
import org.eclipse.jkube.kit.config.service.openshift.OpenshiftUndeployService;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
import org.eclipse.jkube.gradle.plugin.OpenShiftExtension;
import org.eclipse.jkube.gradle.plugin.TestOpenShiftExtension;
import org.eclipse.jkube.kit.common.util.KubernetesHelper;
import org.eclipse.jkube.kit.config.access.ClusterAccess;
import org.eclipse.jkube.kit.common.access.ClusterAccess;
import org.eclipse.jkube.watcher.api.WatcherManager;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.NoArgsConstructor;
import org.eclipse.jkube.kit.common.access.ClusterConfiguration;

/**
* @author roland
Expand All @@ -38,6 +39,7 @@ public class JKubeConfiguration implements Serializable {
private static final long serialVersionUID = 7459084747241070651L;

private JavaProject project;
private ClusterConfiguration clusterConfiguration;
private String sourceDirectory;
private String outputDirectory;
private Map<String, String> buildArgs;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
* Contributors:
* Red Hat, Inc. - initial API and implementation
*/
package org.eclipse.jkube.kit.config.access;
package org.eclipse.jkube.kit.common.access;


import io.fabric8.kubernetes.client.Config;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,14 @@
* Contributors:
* Red Hat, Inc. - initial API and implementation
*/
package org.eclipse.jkube.kit.config.access;
package org.eclipse.jkube.kit.common.access;

import io.fabric8.kubernetes.api.model.NamedContext;
import io.fabric8.kubernetes.api.model.NamedContextBuilder;
import io.fabric8.kubernetes.client.Config;
import io.fabric8.kubernetes.client.ConfigBuilder;

import java.io.Serializable;
import java.lang.reflect.Field;
import java.util.Map;
import java.util.Optional;
Expand All @@ -32,9 +36,10 @@
@AllArgsConstructor
@NoArgsConstructor
@EqualsAndHashCode
public class ClusterConfiguration {
public class ClusterConfiguration implements Serializable {

private static final String PROPERTY_PREFIX = "jkube.";
private static final long serialVersionUID = 8756257530678486528L;

private String username;
private String password;
Expand All @@ -49,6 +54,7 @@ public class ClusterConfiguration {
private String clientKeyData;
private String clientKeyAlgo;
private String clientKeyPassphrase;
private String currentContext;
private String trustStoreFile;
private String trustStorePassphrase;
private String keyStoreFile;
Expand Down Expand Up @@ -134,6 +140,12 @@ public Config getConfig() {
configBuilder.withTrustCerts(this.trustCerts);
}

if (StringUtils.isNotBlank(this.currentContext)) {
configBuilder.withCurrentContext(new NamedContextBuilder()
.withName(this.currentContext)
.build());
}

return configBuilder.build();

}
Expand All @@ -153,6 +165,7 @@ public static ClusterConfigurationBuilder from(Config kubernetesConfig) {
.clientKeyData(kubernetesConfig.getClientKeyData())
.clientKeyAlgo(kubernetesConfig.getClientKeyAlgo())
.clientKeyPassphrase(kubernetesConfig.getClientKeyPassphrase())
.currentContext(Optional.ofNullable(kubernetesConfig.getCurrentContext()).map(NamedContext::getName).orElse(null))
.trustStoreFile(kubernetesConfig.getTrustStoreFile())
.trustStorePassphrase(kubernetesConfig.getTrustStorePassphrase())
.keyStoreFile(kubernetesConfig.getKeyStoreFile())
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
* Contributors:
* Red Hat, Inc. - initial API and implementation
*/
package org.eclipse.jkube.kit.config.access;
package org.eclipse.jkube.kit.common.access;

import io.fabric8.kubernetes.client.KubernetesClient;
import io.fabric8.kubernetes.client.server.mock.EnableKubernetesMockClient;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,9 @@
* Contributors:
* Red Hat, Inc. - initial API and implementation
*/
package org.eclipse.jkube.kit.config.access;
package org.eclipse.jkube.kit.common.access;

import io.fabric8.kubernetes.api.model.NamedContextBuilder;
import io.fabric8.kubernetes.client.Config;
import io.fabric8.kubernetes.client.ConfigBuilder;
import org.junit.jupiter.api.Test;
Expand All @@ -31,13 +32,15 @@ void should_load_configuration_from_properties() {
properties.put("jkube.password", "the pa$$w*rd");
properties.put("jkube.masterUrl", "https://example.com");
properties.put("jkube.corner-case", "corner");
properties.put("jkube.currentContext", "ctx1");
properties.put("manufactur8.jkube.corner-case", "cased");
// When
final Config config = ClusterConfiguration.from(properties).build().getConfig();
// Then
assertThat(config).isNotNull()
.hasFieldOrPropertyWithValue("username", "user name")
.hasFieldOrPropertyWithValue("password", "the pa$$w*rd")
.hasFieldOrPropertyWithValue("currentContext", new NamedContextBuilder().withName("ctx1").build())
.hasFieldOrPropertyWithValue("masterUrl", "https://example.com/");
}

Expand Down Expand Up @@ -104,6 +107,7 @@ void loadsConfigurationFromKubernetesConfig() {
.withClientKeyData("clientKeyData")
.withClientKeyAlgo("clientKeyAlgo")
.withClientKeyPassphrase("clientKeyPassphrase")
.withCurrentContext(new NamedContextBuilder().withName("ctx1").build())
.withTrustStoreFile("trustStoreFile")
.withTrustStorePassphrase("trustStorePassphrase")
.withKeyStoreFile("keyStoreFile")
Expand All @@ -126,6 +130,7 @@ void loadsConfigurationFromKubernetesConfig() {
.hasFieldOrPropertyWithValue("clientKeyData", "clientKeyData")
.hasFieldOrPropertyWithValue("clientKeyAlgo", "clientKeyAlgo")
.hasFieldOrPropertyWithValue("clientKeyPassphrase", "clientKeyPassphrase")
.hasFieldOrPropertyWithValue("currentContext", new NamedContextBuilder().withName("ctx1").build())
.hasFieldOrPropertyWithValue("trustStoreFile", "trustStoreFile")
.hasFieldOrPropertyWithValue("trustStorePassphrase", "trustStorePassphrase")
.hasFieldOrPropertyWithValue("keyStoreFile", "keyStoreFile")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,7 @@
import org.eclipse.jkube.kit.build.service.docker.DockerServiceHub;
import org.eclipse.jkube.kit.common.KitLogger;
import org.eclipse.jkube.kit.common.util.LazyBuilder;
import org.eclipse.jkube.kit.config.access.ClusterAccess;
import org.eclipse.jkube.kit.config.access.ClusterConfiguration;
import org.eclipse.jkube.kit.common.access.ClusterAccess;
import org.eclipse.jkube.kit.common.JKubeConfiguration;
import org.eclipse.jkube.kit.config.resource.ResourceService;
import org.eclipse.jkube.kit.config.resource.ResourceServiceConfig;
Expand All @@ -51,7 +50,6 @@ public class JKubeServiceHub implements Closeable {
private final BuildServiceConfig buildServiceConfig;
@Getter
private final ResourceServiceConfig resourceServiceConfig;
private final ClusterAccess clusterAccess;
@Getter
@Setter
private RuntimeMode platformMode;
Expand All @@ -70,12 +68,11 @@ public class JKubeServiceHub implements Closeable {

@Builder(toBuilder = true)
public JKubeServiceHub(
ClusterAccess clusterAccess, RuntimeMode platformMode, KitLogger log,
RuntimeMode platformMode, KitLogger log,
DockerServiceHub dockerServiceHub, JKubeConfiguration configuration,
BuildServiceConfig buildServiceConfig, ResourceServiceConfig resourceServiceConfig,
LazyBuilder<JKubeServiceHub, ResourceService> resourceService,
boolean offline) {
this.clusterAccess = clusterAccess;
this.platformMode = platformMode;
this.log = log;
this.dockerServiceHub = dockerServiceHub;
Expand Down Expand Up @@ -129,11 +126,7 @@ private ClusterAccess initClusterAccessIfNecessary() {
if (offline) {
throw new IllegalArgumentException("Connection to Cluster required. Please check if offline mode is set to false");
}
if (clusterAccess != null) {
return clusterAccess;
}
return new ClusterAccess(ClusterConfiguration.from(
System.getProperties(), configuration.getProject().getProperties()).build());
return new ClusterAccess(configuration.getClusterConfiguration());
}

public RuntimeMode getRuntimeMode() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
import org.eclipse.jkube.kit.common.KitLogger;
import org.eclipse.jkube.kit.common.util.KubernetesHelper;
import org.eclipse.jkube.kit.common.util.OpenshiftHelper;
import org.eclipse.jkube.kit.config.access.ClusterAccess;
import org.eclipse.jkube.kit.common.access.ClusterAccess;
import org.eclipse.jkube.kit.config.image.ImageName;

import io.fabric8.kubernetes.api.model.DeletionPropagation;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,7 @@
import io.fabric8.openshift.client.OpenShiftClient;
import org.eclipse.jkube.kit.common.JKubeConfiguration;
import org.eclipse.jkube.kit.common.KitLogger;
import org.eclipse.jkube.kit.config.access.ClusterAccess;
import org.eclipse.jkube.kit.config.access.ClusterConfiguration;
import org.eclipse.jkube.kit.common.access.ClusterConfiguration;
import org.eclipse.jkube.kit.config.resource.RuntimeMode;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.DisplayName;
Expand All @@ -63,7 +62,6 @@

@EnableKubernetesMockClient(crud = true)
class ApplyServiceCrudTest {

KubernetesMockServer kubernetesMockServer;
KubernetesClient kubernetesClient;
private KitLogger log;
Expand All @@ -76,9 +74,10 @@ void setUp() {
apiGroupList = new APIGroupList();
final JKubeServiceHub serviceHub = JKubeServiceHub.builder()
.log(log)
.configuration(JKubeConfiguration.builder().build())
.configuration(JKubeConfiguration.builder()
.clusterConfiguration(ClusterConfiguration.from(kubernetesClient.getConfiguration()).build())
.build())
.platformMode(RuntimeMode.KUBERNETES)
.clusterAccess(new ClusterAccess(ClusterConfiguration.from(kubernetesClient.getConfiguration()).build()))
.build();
applyService = serviceHub.getApplyService();
applyService.setNamespace("default");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,7 @@
import org.eclipse.jkube.kit.common.JKubeConfiguration;
import org.eclipse.jkube.kit.common.KitLogger;
import org.eclipse.jkube.kit.common.util.Serialization;
import org.eclipse.jkube.kit.config.access.ClusterAccess;
import org.eclipse.jkube.kit.config.access.ClusterConfiguration;
import org.eclipse.jkube.kit.common.access.ClusterConfiguration;
import org.eclipse.jkube.kit.config.resource.RuntimeMode;
import org.eclipse.jkube.kit.config.service.openshift.WebServerEventCollector;

Expand Down Expand Up @@ -72,7 +71,6 @@

@EnableKubernetesMockClient
class ApplyServiceTest {

KubernetesMockServer mockServer;
OpenShiftClient client;

Expand All @@ -82,9 +80,10 @@ class ApplyServiceTest {
void setUp() {
final JKubeServiceHub serviceHub = JKubeServiceHub.builder()
.log(new KitLogger.SilentLogger())
.configuration(JKubeConfiguration.builder().build())
.configuration(JKubeConfiguration.builder()
.clusterConfiguration(ClusterConfiguration.from(client.getConfiguration()).build())
.build())
.platformMode(RuntimeMode.KUBERNETES)
.clusterAccess(new ClusterAccess(ClusterConfiguration.from(client.getConfiguration()).build()))
.build();
applyService = serviceHub.getApplyService();
applyService.setNamespace("default");
Expand Down
Loading