Support output verbosity option for nodes status getter

weaviate · Dec 7, 2023 · 6b0a07a · 6b0a07a
1 parent fb0a48c
commit 6b0a07a
Show file tree

Hide file tree

Showing 12 changed files with 87 additions and 12 deletions.
diff --git a/src/main/java/io/weaviate/client/base/util/UrlEncoder.java b/src/main/java/io/weaviate/client/base/util/UrlEncoder.java
@@ -11,7 +11,7 @@ public class UrlEncoder {
   private UrlEncoder() {}
 
   public static String encodeQueryParam(String key, String value) {
-    return String.format("%s=%s", key, encode(StringUtils.trim(value)));
+    return String.format("%s=%s", encode(StringUtils.trim(key)), encode(StringUtils.trim(value)));
   }
 
   public static String encodePathParam(String value) {

diff --git a/src/main/java/io/weaviate/client/v1/cluster/api/NodesStatusGetter.java b/src/main/java/io/weaviate/client/v1/cluster/api/NodesStatusGetter.java
@@ -13,6 +13,7 @@
 public class NodesStatusGetter extends BaseClient<NodesStatusResponse> implements ClientResult<NodesStatusResponse> {
 
   private String className;
+  private String output;
 
   public NodesStatusGetter(HttpClient httpClient, Config config) {
     super(httpClient, config);
@@ -23,6 +24,11 @@ public NodesStatusGetter withClassName(String className) {
     return this;
   }
 
+  public NodesStatusGetter withOutput(String output) {
+    this.output = output;
+    return this;
+  }
+
   @Override
   public Result<NodesStatusResponse> run() {
     Response<NodesStatusResponse> resp = sendGetRequest(path(), NodesStatusResponse.class);
@@ -34,6 +40,9 @@ private String path() {
     if (StringUtils.isNotBlank(className)) {
       path = String.format("%s/%s", path, UrlEncoder.encodePathParam(className));
     }
+    if (StringUtils.isNotBlank(output)) {
+      path = String.format("%s?%s", path, UrlEncoder.encodeQueryParam("output", output));
+    }
     return path;
   }
 }
diff --git a/src/main/java/io/weaviate/client/v1/cluster/model/NodeStatusOutput.java b/src/main/java/io/weaviate/client/v1/cluster/model/NodeStatusOutput.java
@@ -0,0 +1,6 @@
+package io.weaviate.client.v1.cluster.model;
+
+public interface NodeStatusOutput {
+  String VERBOSE = "verbose";
+  String MINIMAL = "minimal";
+}
diff --git a/src/test/java/io/weaviate/integration/client/WeaviateVersion.java b/src/test/java/io/weaviate/integration/client/WeaviateVersion.java
@@ -3,9 +3,9 @@
 public class WeaviateVersion {
 
   // to be set according to weaviate docker image
-  public static final String EXPECTED_WEAVIATE_VERSION = "1.22.6";
+  public static final String EXPECTED_WEAVIATE_VERSION = "1.23.0-rc.0";
   // to be set according to weaviate docker image
-  public static final String EXPECTED_WEAVIATE_GIT_HASH = "ea13956";
+  public static final String EXPECTED_WEAVIATE_GIT_HASH = "977af56";
 
   private WeaviateVersion() {}
 }
diff --git a/src/test/java/io/weaviate/integration/client/cluster/ClientClusterTest.java b/src/test/java/io/weaviate/integration/client/cluster/ClientClusterTest.java
@@ -1,6 +1,7 @@
 package io.weaviate.integration.client.cluster;
 
 import io.weaviate.client.base.util.TriConsumer;
+import io.weaviate.client.v1.cluster.model.NodeStatusOutput;
 import org.junit.After;
 import org.junit.Before;
 import org.junit.ClassRule;
@@ -77,7 +78,7 @@ public void testClusterNodesEndpointWithData() {
     testGenerics.createTestSchemaAndData(client);
 
     // when
-    Result<NodesStatusResponse> result = client.cluster().nodesStatusGetter().run();
+    Result<NodesStatusResponse> result = client.cluster().nodesStatusGetter().withOutput(NodeStatusOutput.VERBOSE).run();
 
     // then
     assertThat(result).isNotNull();
@@ -167,4 +168,63 @@ public void shouldGetNodeStatusPerClass() {
     assertSingleNode.accept(resultSoup);
     assertCounts.accept(resultSoup.getResult().getNodes()[0], 1L, (long) soupIds.size());
   }
+
+  @Test
+  public void testClusterNodesEndpointWithDataWithOutputMinimal() {
+    // given
+    testGenerics.createTestSchemaAndData(client);
+
+    // when
+    Result<NodesStatusResponse> result = client.cluster().nodesStatusGetter().withOutput(NodeStatusOutput.MINIMAL).run();
+
+    // then
+    assertThat(result).isNotNull();
+    assertThat(result.hasErrors()).isFalse();
+
+    NodesStatusResponse nodes = result.getResult();
+    assertThat(nodes).isNotNull();
+    assertThat(nodes.getNodes()).hasSize(1);
+
+    NodesStatusResponse.NodeStatus nodeStatus = nodes.getNodes()[0];
+    assertThat(nodeStatus.getName()).isNotBlank();
+    assertThat(nodeStatus)
+      .returns(EXPECTED_WEAVIATE_VERSION, NodesStatusResponse.NodeStatus::getVersion)
+      .returns(EXPECTED_WEAVIATE_GIT_HASH, NodesStatusResponse.NodeStatus::getGitHash)
+      .returns(NodesStatusResponse.Status.HEALTHY, NodesStatusResponse.NodeStatus::getStatus)
+      .extracting(NodesStatusResponse.NodeStatus::getStats)
+      .returns(2L, NodesStatusResponse.Stats::getShardCount)
+      .returns(6L, NodesStatusResponse.Stats::getObjectCount);
+
+    assertThat(nodeStatus.getShards()).isNull();
+  }
+
+  @Test
+  public void testClusterNodesEndpointWithDataWithClassWithOutputMinimal() {
+    // given
+    testGenerics.createTestSchemaAndData(client);
+
+    // when
+    Result<NodesStatusResponse> result = client.cluster().nodesStatusGetter()
+      .withClassName("Soup").withOutput(NodeStatusOutput.MINIMAL).run();
+
+    // then
+    assertThat(result).isNotNull();
+    assertThat(result.hasErrors()).isFalse();
+
+    NodesStatusResponse nodes = result.getResult();
+    assertThat(nodes).isNotNull();
+    assertThat(nodes.getNodes()).hasSize(1);
+
+    NodesStatusResponse.NodeStatus nodeStatus = nodes.getNodes()[0];
+    assertThat(nodeStatus.getName()).isNotBlank();
+    assertThat(nodeStatus)
+      .returns(EXPECTED_WEAVIATE_VERSION, NodesStatusResponse.NodeStatus::getVersion)
+      .returns(EXPECTED_WEAVIATE_GIT_HASH, NodesStatusResponse.NodeStatus::getGitHash)
+      .returns(NodesStatusResponse.Status.HEALTHY, NodesStatusResponse.NodeStatus::getStatus)
+      .extracting(NodesStatusResponse.NodeStatus::getStats)
+      .returns(1L, NodesStatusResponse.Stats::getShardCount)
+      .returns(2L, NodesStatusResponse.Stats::getObjectCount);
+
+    assertThat(nodeStatus.getShards()).isNull();
+  }
 }
diff --git a/src/test/resources/docker-compose-azure.yaml b/src/test/resources/docker-compose-azure.yaml
@@ -10,7 +10,7 @@ services:
       - --scheme
       - http
       - --write-timeout=600s
-    image: semitechnologies/weaviate:preview-hnsw-bq-ea13956
+    image: semitechnologies/weaviate:1.23.0-rc.0
     restart: on-failure:0
     environment:
       PERSISTENCE_DATA_PATH: '/var/lib/weaviate'

diff --git a/src/test/resources/docker-compose-cluster.yaml b/src/test/resources/docker-compose-cluster.yaml
@@ -10,7 +10,7 @@ services:
       - --scheme
       - http
       - --write-timeout=600s
-    image: semitechnologies/weaviate:preview-hnsw-bq-ea13956
+    image: semitechnologies/weaviate:1.23.0-rc.0
     restart: on-failure:0
     environment:
       LOG_LEVEL: 'debug'
@@ -41,7 +41,7 @@ services:
       - '8088'
       - --scheme
       - http
-    image: semitechnologies/weaviate:preview-hnsw-bq-ea13956
+    image: semitechnologies/weaviate:1.23.0-rc.0
     restart: on-failure:0
     environment:
       LOG_LEVEL: 'debug'

diff --git a/src/test/resources/docker-compose-okta-cc.yaml b/src/test/resources/docker-compose-okta-cc.yaml
@@ -10,7 +10,7 @@ services:
       - --scheme
       - http
       - --write-timeout=600s
-    image: semitechnologies/weaviate:preview-hnsw-bq-ea13956
+    image: semitechnologies/weaviate:1.23.0-rc.0
     restart: on-failure:0
     environment:
       PERSISTENCE_DATA_PATH: '/var/lib/weaviate'

diff --git a/src/test/resources/docker-compose-okta-users.yaml b/src/test/resources/docker-compose-okta-users.yaml
@@ -10,7 +10,7 @@ services:
       - --scheme
       - http
       - --write-timeout=600s
-    image: semitechnologies/weaviate:preview-hnsw-bq-ea13956
+    image: semitechnologies/weaviate:1.23.0-rc.0
     restart: on-failure:0
     environment:
       PERSISTENCE_DATA_PATH: '/var/lib/weaviate'

diff --git a/src/test/resources/docker-compose-proxy.yaml b/src/test/resources/docker-compose-proxy.yaml
@@ -9,7 +9,7 @@ services:
     - '8080'
     - --scheme
     - http
-    image: semitechnologies/weaviate:preview-hnsw-bq-ea13956
+    image: semitechnologies/weaviate:1.23.0-rc.0
     restart: on-failure:0
     environment:
       LOG_LEVEL: "debug"

diff --git a/src/test/resources/docker-compose-test.yaml b/src/test/resources/docker-compose-test.yaml
@@ -9,7 +9,7 @@ services:
     - '8080'
     - --scheme
     - http
-    image: semitechnologies/weaviate:preview-hnsw-bq-ea13956
+    image: semitechnologies/weaviate:1.23.0-rc.0
     links:
       - "contextionary:contextionary"
     restart: on-failure:0

diff --git a/src/test/resources/docker-compose-wcs.yaml b/src/test/resources/docker-compose-wcs.yaml
@@ -10,7 +10,7 @@ services:
       - --scheme
       - http
       - --write-timeout=600s
-    image: semitechnologies/weaviate:preview-hnsw-bq-ea13956
+    image: semitechnologies/weaviate:1.23.0-rc.0
     restart: on-failure:0
     environment:
       PERSISTENCE_DATA_PATH: '/var/lib/weaviate'