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

Add first test for gitops deployed opendatascience cluster #9

Merged
merged 1 commit into from
Nov 10, 2023
Merged
Show file tree
Hide file tree
Changes from all 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
36 changes: 31 additions & 5 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
<version>1.0-SNAPSHOT</version>

<properties>
<it.skip>true</it.skip>
<maven.compiler.source>17</maven.compiler.source>
<maven.compiler.target>17</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
Expand All @@ -20,6 +19,9 @@
<junit.jupiter.version>5.8.2</junit.jupiter.version>
<junit.platform.version>1.8.2</junit.platform.version>
<maven.surefire.version>3.2.2</maven.surefire.version>
<logback.version>1.4.11</logback.version>
<slf4j.version>2.0.9</slf4j.version>
<hamcrest.version>2.2</hamcrest.version>
</properties>

<repositories>
Expand Down Expand Up @@ -62,13 +64,11 @@
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-api</artifactId>
<version>${junit.jupiter.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-params</artifactId>
<version>${junit.jupiter.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.platform</groupId>
Expand Down Expand Up @@ -108,6 +108,24 @@
<artifactId>opendatahub-crds</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>org.hamcrest</groupId>
<artifactId>hamcrest</artifactId>
<scope>compile</scope>
<version>${hamcrest.version}</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<scope>runtime</scope>
<version>${logback.version}</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>${slf4j.version}</version>
<scope>compile</scope>
</dependency>
</dependencies>

<build>
Expand All @@ -118,6 +136,11 @@
<version>${maven.surefire.version}</version>
<configuration>
<test>UnitTests</test>
<properties>
<configurationParameters>
junit.jupiter.extensions.autodetection.enabled = true
</configurationParameters>
</properties>
</configuration>
</plugin>
<plugin>
Expand All @@ -141,8 +164,11 @@
<include>**/ST*.java</include>
<include>**/*ST.java</include>
</includes>
<skipITs>${it.skip}</skipITs>
<skipTests>${it.skip}</skipTests>
<properties>
<configurationParameters>
junit.jupiter.extensions.autodetection.enabled = true
</configurationParameters>
</properties>
</configuration>
</plugin>
</plugins>
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/io/odh/test/TestConstants.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
package io.odh.test;

public class TestConstants {
public static final String test = "test";
public static final String ODH_NAMESPACE = "opendatahub";
}
273 changes: 273 additions & 0 deletions src/main/java/io/odh/test/platform/KubeClient.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,273 @@
package io.odh.test.platform;

import io.fabric8.kubernetes.api.model.ConfigMap;
import io.fabric8.kubernetes.api.model.KubernetesResourceList;
import io.fabric8.kubernetes.api.model.LabelSelector;
import io.fabric8.kubernetes.api.model.Namespace;
import io.fabric8.kubernetes.api.model.Node;
import io.fabric8.kubernetes.api.model.Pod;
import io.fabric8.kubernetes.api.model.apps.Deployment;
import io.fabric8.kubernetes.api.model.apps.StatefulSet;
import io.fabric8.kubernetes.api.model.batch.v1.Job;
import io.fabric8.kubernetes.api.model.batch.v1.JobList;
import io.fabric8.kubernetes.api.model.batch.v1.JobStatus;
import io.fabric8.kubernetes.client.Config;
import io.fabric8.kubernetes.client.KubernetesClient;
import io.fabric8.kubernetes.client.KubernetesClientBuilder;
import io.fabric8.kubernetes.client.dsl.MixedOperation;
import io.fabric8.kubernetes.client.dsl.Resource;
import io.fabric8.kubernetes.client.dsl.RollableScalableResource;
import io.fabric8.openshift.client.OpenShiftClient;
import io.opendatahub.datasciencecluster.v1.DataScienceCluster;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.List;
import java.util.stream.Collectors;

public class KubeClient {
protected final KubernetesClient client;
protected String namespace;

private static final Logger LOGGER = LoggerFactory.getLogger(KubeClient.class);

public KubeClient(String namespace) {
LOGGER.debug("Creating client in namespace: {}", namespace);
Config config = Config.autoConfigure(System.getenv().getOrDefault("KUBE_CONTEXT", null));

this.client = new KubernetesClientBuilder()
.withConfig(config)
.build()
.adapt(OpenShiftClient.class);
this.namespace = namespace;
}

public KubeClient(Config config, String namespace) {
this.client = new KubernetesClientBuilder()
.withConfig(config)
.build()
.adapt(OpenShiftClient.class);
this.namespace = namespace;
}

public KubeClient(KubernetesClient client, String namespace) {
LOGGER.debug("Creating client in namespace: {}", namespace);
this.client = client;
this.namespace = namespace;
}

// ============================
// ---------> CLIENT <---------
// ============================

public KubernetesClient getClient() {
return client;
}

// ===============================
// ---------> NAMESPACE <---------
// ===============================

public KubeClient inNamespace(String namespace) {
LOGGER.debug("Using namespace: {}", namespace);
this.namespace = namespace;
return this;
}

public String getNamespace() {
return namespace;
}

public Namespace getNamespace(String namespace) {
return client.namespaces().withName(namespace).get();
}

public boolean namespaceExists(String namespace) {
return client.namespaces().list().getItems().stream().map(n -> n.getMetadata().getName())
.collect(Collectors.toList()).contains(namespace);
}

/**
* Gets namespace status
*/
public boolean getNamespaceStatus(String namespaceName) {
return client.namespaces().withName(namespaceName).isReady();
}

// ================================
// ---------> CONFIG MAP <---------
// ================================
public ConfigMap getConfigMap(String namespaceName, String configMapName) {
return client.configMaps().inNamespace(namespaceName).withName(configMapName).get();
}

public ConfigMap getConfigMap(String configMapName) {
return getConfigMap(namespace, configMapName);
}


public boolean getConfigMapStatus(String configMapName) {
return client.configMaps().inNamespace(getNamespace()).withName(configMapName).isReady();
}

// =========================
// ---------> POD <---------
// =========================
public List<Pod> listPods() {
return client.pods().inNamespace(namespace).list().getItems();
}

public List<Pod> listPods(String namespaceName) {
return client.pods().inNamespace(namespaceName).list().getItems();
}

/**
* Returns list of pods by prefix in pod name
* @param namespaceName Namespace name
* @param podNamePrefix prefix with which the name should begin
* @return List of pods
*/
public List<Pod> listPodsByPrefixInName(String namespaceName, String podNamePrefix) {
return listPods(namespaceName)
.stream().filter(p -> p.getMetadata().getName().startsWith(podNamePrefix))
.collect(Collectors.toList());
}

/**
* Gets pod
*/
public Pod getPod(String namespaceName, String name) {
return client.pods().inNamespace(namespaceName).withName(name).get();
}

public Pod getPod(String name) {
return getPod(namespace, name);
}

public String getLogs(String namespaceName, String podName) {
return client.pods().inNamespace(namespaceName).withName(podName).getLog();
}

// ==================================
// ---------> STATEFUL SET <---------
// ==================================

/**
* Gets stateful set
*/
public StatefulSet getStatefulSet(String namespaceName, String statefulSetName) {
return client.apps().statefulSets().inNamespace(namespaceName).withName(statefulSetName).get();
}

public StatefulSet getStatefulSet(String statefulSetName) {
return getStatefulSet(namespace, statefulSetName);
}

/**
* Gets stateful set
*/
public RollableScalableResource<StatefulSet> statefulSet(String namespaceName, String statefulSetName) {
return client.apps().statefulSets().inNamespace(namespaceName).withName(statefulSetName);
}

public RollableScalableResource<StatefulSet> statefulSet(String statefulSetName) {
return statefulSet(namespace, statefulSetName);
}
// ================================
// ---------> DEPLOYMENT <---------
// ================================

/**
* Gets deployment
*/

public Deployment getDeployment(String namespaceName, String deploymentName) {
return client.apps().deployments().inNamespace(namespaceName).withName(deploymentName).get();
}

public Deployment getDeployment(String deploymentName) {
return client.apps().deployments().inNamespace(namespace).withName(deploymentName).get();
}

public Deployment getDeploymentFromAnyNamespaces(String deploymentName) {
return client.apps().deployments().inAnyNamespace().list().getItems().stream().filter(
deployment -> deployment.getMetadata().getName().equals(deploymentName))
.findFirst()
.orElseThrow();
}

/**
* Gets deployment status
*/
public LabelSelector getDeploymentSelectors(String namespaceName, String deploymentName) {
return client.apps().deployments().inNamespace(namespaceName).withName(deploymentName).get().getSpec().getSelector();
}

// ==========================
// ---------> NODE <---------
// ==========================

public String getNodeAddress() {
return listNodes().get(0).getStatus().getAddresses().get(0).getAddress();
}

public List<Node> listNodes() {
return client.nodes().list().getItems();
}

public List<Node> listWorkerNodes() {
return listNodes().stream().filter(node -> node.getMetadata().getLabels().containsKey("node-role.kubernetes.io/worker")).collect(Collectors.toList());
}

public List<Node> listMasterNodes() {
return listNodes().stream().filter(node -> node.getMetadata().getLabels().containsKey("node-role.kubernetes.io/master")).collect(Collectors.toList());
}

// =========================
// ---------> JOB <---------
// =========================

public boolean jobExists(String jobName) {
return client.batch().v1().jobs().inNamespace(namespace).list().getItems().stream().anyMatch(j -> j.getMetadata().getName().startsWith(jobName));
}

public Job getJob(String jobName) {
return client.batch().v1().jobs().inNamespace(namespace).withName(jobName).get();
}

public boolean checkSucceededJobStatus(String jobName) {
return checkSucceededJobStatus(getNamespace(), jobName, 1);
}

public boolean checkSucceededJobStatus(String namespaceName, String jobName, int expectedSucceededPods) {
return getJobStatus(namespaceName, jobName).getSucceeded().equals(expectedSucceededPods);
}

public boolean checkFailedJobStatus(String namespaceName, String jobName, int expectedFailedPods) {
return getJobStatus(namespaceName, jobName).getFailed().equals(expectedFailedPods);
}

// Pods Statuses: 0 Running / 0 Succeeded / 1 Failed
public JobStatus getJobStatus(String namespaceName, String jobName) {
return client.batch().v1().jobs().inNamespace(namespaceName).withName(jobName).get().getStatus();
}

public JobStatus getJobStatus(String jobName) {
return getJobStatus(namespace, jobName);
}

public JobList getJobList() {
return client.batch().v1().jobs().inNamespace(namespace).list();
}

public List<Job> listJobs(String namePrefix) {
return client.batch().v1().jobs().inNamespace(getNamespace()).list().getItems().stream()
.filter(job -> job.getMetadata().getName().startsWith(namePrefix)).collect(Collectors.toList());
}

public MixedOperation<DataScienceCluster, KubernetesResourceList<DataScienceCluster>, Resource<DataScienceCluster>> dataScienceClusterClient() {
return client.resources(DataScienceCluster.class);
}

}

Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
/*
* Copyright Tealc authors.
* License: Apache License 2.0 (see the file LICENSE or http://apache.org/licenses/LICENSE-2.0.html).
*/
package io.odh.test.separator;

import org.junit.jupiter.api.extension.ExtensionContext;
import org.junit.jupiter.api.extension.ParameterContext;
import org.junit.jupiter.api.extension.ParameterResolutionException;
import org.junit.jupiter.api.extension.ParameterResolver;

public class ExtensionContextParameterResolver implements ParameterResolver {
@Override
public boolean supportsParameter(ParameterContext parameterContext, ExtensionContext extensionContext) throws ParameterResolutionException {
return parameterContext.getParameter().getType() == ExtensionContext.class;
}

@Override
public Object resolveParameter(ParameterContext parameterContext, ExtensionContext extensionContext) throws ParameterResolutionException {
return extensionContext;
}
}
Loading