Skip to content

fix: add missing continue token when build cluster list call #3930

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Feb 19, 2025
+172 −0
Merged

fix: add missing continue token when build cluster list call #3930

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8f6cf9b
fix: add missing continue token when build cluster list call
cyrilcsr Feb 19, 2025
ed4df76
test: add UT for ListOptions usage in building list calls
cyrilcsr Feb 19, 2025
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
1 change: 1 addition & 0 deletions util/src/main/java/io/kubernetes/client/util/generic/GenericKubernetesApi.java
View file
Original file line number Diff line number Diff line change
@@ -579,6 +579,7 @@ private CallBuilder makeClusterListCallBuilder(final ListOptions listOptions) {
adaptListCall(
customObjectsApi.getApiClient(),
customObjectsApi.listClusterCustomObject( this.apiGroup, this.apiVersion, this.resourcePlural)
._continue(listOptions.getContinue())
.fieldSelector(listOptions.getFieldSelector())
.labelSelector(listOptions.getLabelSelector())
.limit(listOptions.getLimit())
171 changes: 171 additions & 0 deletions util/src/test/java/io/kubernetes/client/util/generic/GenericKubernetesListApiTest.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,171 @@
package io.kubernetes.client.util.generic;

import static com.github.tomakehurst.wiremock.client.WireMock.*;
import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.wireMockConfig;
import static org.assertj.core.api.Assertions.assertThat;

import com.github.tomakehurst.wiremock.junit5.WireMockExtension;
import io.kubernetes.client.openapi.ApiClient;
import io.kubernetes.client.openapi.JSON;
import io.kubernetes.client.openapi.models.V1Job;
import io.kubernetes.client.openapi.models.V1JobList;
import io.kubernetes.client.openapi.models.V1ListMeta;
import io.kubernetes.client.util.ClientBuilder;
import io.kubernetes.client.util.generic.options.ListOptions;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;

class GenericKubernetesListApiTest {
@RegisterExtension
static WireMockExtension apiServer =
WireMockExtension.newInstance().options(wireMockConfig().dynamicPort()).build();

private GenericKubernetesApi<V1Job, V1JobList> jobClient;

@BeforeEach
void setup() {
ApiClient apiClient =
new ClientBuilder().setBasePath("http://localhost:" + apiServer.getPort()).build();
jobClient =
new GenericKubernetesApi<>(V1Job.class, V1JobList.class, "batch", "v1", "jobs", apiClient);
}

@Test
void listNamespacedJobWithAllListOptionsSet() {
V1JobList jobList = new V1JobList().kind("PartialObjectMetadataList").metadata(new V1ListMeta());

ListOptions listOptions = new ListOptions()
._continue("continue-token")
.fieldSelector("metadata.name=foo")
.labelSelector("app=web")
.limit(10)
.resourceVersion("12345")
.timeoutSeconds(30)
.isPartialObjectMetadataListRequest(true);

apiServer.stubFor(
get(urlPathEqualTo("/apis/batch/v1/namespaces/default/jobs"))
.withHeader(
"Accept",
equalTo("application/json;as=PartialObjectMetadataList;g=meta.k8s.io;v=v1,application/json"))
.withQueryParam("continue", equalTo("continue-token"))
.withQueryParam("fieldSelector", equalTo("metadata.name=foo"))
.withQueryParam("labelSelector", equalTo("app=web"))
.withQueryParam("limit", equalTo("10"))
.withQueryParam("resourceVersion", equalTo("12345"))
.withQueryParam("timeoutSeconds", equalTo("30"))
.willReturn(aResponse().withStatus(200).withBody(JSON.serialize(jobList))));

KubernetesApiResponse<V1JobList> response = jobClient.list("default", listOptions);

assertThat(response.isSuccess()).isTrue();
assertThat(response.getObject()).isEqualTo(jobList);
assertThat(response.getStatus()).isNull();

apiServer.verify(
getRequestedFor(urlPathEqualTo("/apis/batch/v1/namespaces/default/jobs"))
.withHeader(
"Accept",
equalTo("application/json;as=PartialObjectMetadataList;g=meta.k8s.io;v=v1,application/json"))
.withQueryParam("continue", equalTo("continue-token"))
.withQueryParam("fieldSelector", equalTo("metadata.name=foo"))
.withQueryParam("labelSelector", equalTo("app=web"))
.withQueryParam("limit", equalTo("10"))
.withQueryParam("resourceVersion", equalTo("12345"))
.withQueryParam("timeoutSeconds", equalTo("30")));
}

@Test
void listNamespacedJobWithNoListOptionsSet() {
V1JobList jobList = new V1JobList().kind("JobList").metadata(new V1ListMeta());

apiServer.stubFor(
get(urlPathEqualTo("/apis/batch/v1/namespaces/default/jobs"))
.willReturn(aResponse().withStatus(200).withBody(JSON.serialize(jobList))));

KubernetesApiResponse<V1JobList> response = jobClient.list("default", new ListOptions());

assertThat(response.isSuccess()).isTrue();
assertThat(response.getObject()).isEqualTo(jobList);
assertThat(response.getStatus()).isNull();

apiServer.verify(
getRequestedFor(urlPathEqualTo("/apis/batch/v1/namespaces/default/jobs"))
.withQueryParam("continue", absent())
.withQueryParam("fieldSelector", absent())
.withQueryParam("labelSelector", absent())
.withQueryParam("limit", absent())
.withQueryParam("resourceVersion", absent())
.withQueryParam("timeoutSeconds", absent()));
}

@Test
void listClusterJobWithAllListOptionsSet() {
V1JobList jobList = new V1JobList().kind("PartialObjectMetadataList").metadata(new V1ListMeta());

ListOptions listOptions = new ListOptions()
._continue("continue-token")
.fieldSelector("metadata.name=foo")
.labelSelector("app=web")
.limit(10)
.resourceVersion("12345")
.timeoutSeconds(30)
.isPartialObjectMetadataListRequest(true);

apiServer.stubFor(
get(urlPathEqualTo("/apis/batch/v1/jobs"))
.withHeader(
"Accept",
equalTo("application/json;as=PartialObjectMetadataList;g=meta.k8s.io;v=v1,application/json"))
.withQueryParam("continue", equalTo("continue-token"))
.withQueryParam("fieldSelector", equalTo("metadata.name=foo"))
.withQueryParam("labelSelector", equalTo("app=web"))
.withQueryParam("limit", equalTo("10"))
.withQueryParam("resourceVersion", equalTo("12345"))
.withQueryParam("timeoutSeconds", equalTo("30"))
.willReturn(aResponse().withStatus(200).withBody(JSON.serialize(jobList))));

KubernetesApiResponse<V1JobList> response = jobClient.list(listOptions);

assertThat(response.isSuccess()).isTrue();
assertThat(response.getObject()).isEqualTo(jobList);
assertThat(response.getStatus()).isNull();

apiServer.verify(
getRequestedFor(urlPathEqualTo("/apis/batch/v1/jobs"))
.withHeader(
"Accept",
equalTo("application/json;as=PartialObjectMetadataList;g=meta.k8s.io;v=v1,application/json"))
.withQueryParam("continue", equalTo("continue-token"))
.withQueryParam("fieldSelector", equalTo("metadata.name=foo"))
.withQueryParam("labelSelector", equalTo("app=web"))
.withQueryParam("limit", equalTo("10"))
.withQueryParam("resourceVersion", equalTo("12345"))
.withQueryParam("timeoutSeconds", equalTo("30")));
}

@Test
void listClusterJobWithNoListOptionsSet() {
V1JobList jobList = new V1JobList().kind("JobList").metadata(new V1ListMeta());

apiServer.stubFor(
get(urlPathEqualTo("/apis/batch/v1/jobs"))
.willReturn(aResponse().withStatus(200).withBody(JSON.serialize(jobList))));

KubernetesApiResponse<V1JobList> response = jobClient.list(new ListOptions());

assertThat(response.isSuccess()).isTrue();
assertThat(response.getObject()).isEqualTo(jobList);
assertThat(response.getStatus()).isNull();

apiServer.verify(
getRequestedFor(urlPathEqualTo("/apis/batch/v1/jobs"))
.withQueryParam("continue", absent())
.withQueryParam("fieldSelector", absent())
.withQueryParam("labelSelector", absent())
.withQueryParam("limit", absent())
.withQueryParam("resourceVersion", absent())
.withQueryParam("timeoutSeconds", absent()));
}
}