[cli] Fix output format of string by pulsar-admin command (apache#11878)

* Fix output format of list of strings by pulsar-admin command * Fix test code * Fix docs
mfleming · Oct 25, 2021 · 7037c5e · 7037c5e
1 parent 9137e6b
commit 7037c5e
Show file tree

Hide file tree

Showing 13 changed files with 66 additions and 28 deletions.
diff --git a/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CliCommand.java b/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CliCommand.java
@@ -188,7 +188,11 @@ <K,V> void print(Map<K,V> items) {
 
     <T> void print(T item) {
         try {
-            System.out.println(writer.writeValueAsString(item));
+            if (item instanceof String) {
+                System.out.println(item);
+            } else {
+                System.out.println(writer.writeValueAsString(item));
+            }
         } catch (Exception e) {
             throw new RuntimeException(e);
         }

diff --git a/pulsar-client-tools/src/test/java/org/apache/pulsar/admin/cli/TestCmdTopics.java b/pulsar-client-tools/src/test/java/org/apache/pulsar/admin/cli/TestCmdTopics.java
@@ -18,8 +18,19 @@
  */
 package org.apache.pulsar.admin.cli;
 
+import static org.mockito.Mockito.any;
+import static org.mockito.Mockito.anyString;
+import static org.mockito.Mockito.doReturn;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+import com.google.common.collect.Lists;
+import java.io.ByteArrayOutputStream;
+import java.io.PrintStream;
 import java.util.ArrayList;
 import java.util.List;
+import org.apache.pulsar.client.admin.PulsarAdmin;
+import org.apache.pulsar.client.admin.Topics;
 import org.apache.pulsar.client.impl.MessageIdImpl;
 import org.apache.pulsar.common.policies.data.ManagedLedgerInternalStats.LedgerInfo;
 import org.testng.Assert;
@@ -54,4 +65,27 @@ public void testFindFirstLedgerWithinThreshold() throws Exception {
         Assert.assertEquals(CmdTopics.findFirstLedgerWithinThreshold(ledgers, 5000),
                             new MessageIdImpl(1, 0, -1));
     }
+
+    @Test
+    public void testListCmd() throws Exception {
+        List<String> topicList = Lists.newArrayList("persistent://public/default/t1", "persistent://public/default/t2",
+                "persistent://public/default/t3");
+
+        Topics topics = mock(Topics.class);
+        doReturn(topicList).when(topics).getList(anyString(), any());
+
+        PulsarAdmin admin = mock(PulsarAdmin.class);
+        when(admin.topics()).thenReturn(topics);
+
+        CmdTopics cmd = new CmdTopics(() -> admin);
+
+        PrintStream defaultSystemOut = System.out;
+        try (ByteArrayOutputStream out = new ByteArrayOutputStream(); PrintStream ps = new PrintStream(out)) {
+            System.setOut(ps);
+            cmd.run("list public/default".split("\\s+"));
+            Assert.assertEquals(out.toString(), String.join("\n", topicList) + "\n");
+        } finally {
+            System.setOut(defaultSystemOut);
+        }
+    }
 }
diff --git a/site2/docs/io-quickstart.md b/site2/docs/io-quickstart.md
@@ -558,7 +558,7 @@ This sink connector runs as a Pulsar Function and writes the messages produced i
 The sink has been created successfully if the following message appears.
 
 ```bash
-"Created successfully"
+Created successfully
 ```
 
 ### Inspect a JDBC sink
@@ -682,7 +682,7 @@ $ bin/pulsar-admin sinks stop \
 The sink instance has been stopped successfully if the following message disappears.
 
 ```bash
-"Stopped successfully"
+Stopped successfully
 ```
 
 ### Restart a JDBC sink
@@ -704,7 +704,7 @@ $ bin/pulsar-admin sinks restart \
 The sink instance has been started successfully if the following message disappears.
 
 ```bash
-"Started successfully"
+Started successfully
 ```
 
 > #### Tip
@@ -735,7 +735,7 @@ $ bin/pulsar-admin sinks update \
 The sink connector has been updated successfully if the following message disappears.
 
 ```bash
-"Updated successfully"
+Updated successfully
 ```
 
 This example double-checks the information.
@@ -794,7 +794,7 @@ $ bin/pulsar-admin sinks delete \
 The sink connector has been deleted successfully if the following message appears.
 
 ```text
-"Deleted successfully"
+Deleted successfully
 ```
 
 This example double-checks the status of the sink connector.

diff --git a/...s/integration/src/test/java/org/apache/pulsar/tests/integration/cli/FunctionsCLITest.java b/...s/integration/src/test/java/org/apache/pulsar/tests/integration/cli/FunctionsCLITest.java
@@ -54,7 +54,7 @@ public String uploadFunction() throws Exception {
         };
         ContainerExecResult output = pulsarCluster.getAnyWorker().execCmd(commands);
         assertEquals(0, output.getExitCode());
-        assertTrue(output.getStdout().contains("\"Uploaded successfully\""));
+        assertTrue(output.getStdout().contains("Uploaded successfully"));
         return bkPkgPath;
     }
 
@@ -77,7 +77,7 @@ public void testUploadDownload() throws Exception {
         WorkerContainer container = pulsarCluster.getAnyWorker();
         ContainerExecResult output = container.execCmd(commands);
         assertEquals(0, output.getExitCode());
-        assertTrue(output.getStdout().contains("\"Downloaded successfully\""));
+        assertTrue(output.getStdout().contains("Downloaded successfully"));
         String[] diffCommand = {
             "diff",
             PulsarCluster.ADMIN_SCRIPT,

diff --git a/...tion/src/test/java/org/apache/pulsar/tests/integration/functions/PulsarFunctionsTest.java b/...tion/src/test/java/org/apache/pulsar/tests/integration/functions/PulsarFunctionsTest.java
@@ -272,7 +272,7 @@ public void testWindowFunction(String type, String[] expectedResults) throws Exc
         };
 
         ContainerExecResult containerExecResult = pulsarCluster.getAnyWorker().execCmd(commands);
-        assertTrue(containerExecResult.getStdout().contains("\"Created successfully\""));
+        assertTrue(containerExecResult.getStdout().contains("Created successfully"));
 
         // get function info
         getFunctionInfoSuccess(functionName);
@@ -848,7 +848,7 @@ private <T> void submitFunction(Runtime runtime,
         };
         ContainerExecResult result = pulsarCluster.getAnyWorker().execCmd(
                 commands);
-        assertTrue(result.getStdout().contains("\"Created successfully\""));
+        assertTrue(result.getStdout().contains("Created successfully"));
 
         if (StringUtils.isNotEmpty(inputTopicName)) {
             ensureSubscriptionCreated(
@@ -869,7 +869,7 @@ private void updateFunctionParallelism(String functionName, int parallelism) thr
         };
         ContainerExecResult result = pulsarCluster.getAnyWorker().execCmd(
                 commands);
-        assertTrue(result.getStdout().contains("\"Updated successfully\""));
+        assertTrue(result.getStdout().contains("Updated successfully"));
     }
 
     protected <T> void submitFunction(Runtime runtime,
@@ -912,7 +912,7 @@ protected <T> void submitFunction(Runtime runtime,
         };
         ContainerExecResult result = pulsarCluster.getAnyWorker().execCmd(
                 commands);
-        assertTrue(result.getStdout().contains("\"Created successfully\""));
+        assertTrue(result.getStdout().contains("Created successfully"));
     }
 
     private <T> void ensureSubscriptionCreated(String inputTopicName,
@@ -1514,7 +1514,7 @@ private void submitJavaLoggingFunction(String inputTopicName,
         };
         ContainerExecResult result = pulsarCluster.getAnyWorker().execCmd(
                 commands);
-        assertTrue(result.getStdout().contains("\"Created successfully\""));
+        assertTrue(result.getStdout().contains("Created successfully"));
 
         ensureSubscriptionCreated(inputTopicName, String.format("public/default/%s", functionName), schema);
     }

diff --git a/...egration/src/test/java/org/apache/pulsar/tests/integration/functions/PulsarStateTest.java b/...egration/src/test/java/org/apache/pulsar/tests/integration/functions/PulsarStateTest.java
@@ -199,7 +199,7 @@ private void submitSourceConnector(String sourceName,
         log.info("Run command : {}", StringUtils.join(commands, ' '));
         ContainerExecResult result = container.execCmd(commands);
         assertTrue(
-                result.getStdout().contains("\"Created successfully\""),
+                result.getStdout().contains("Created successfully"),
                 result.getStdout());
     }
 
@@ -218,7 +218,7 @@ private void submitSinkConnector(String sinkName,
         log.info("Run command : {}", StringUtils.join(commands, ' '));
         ContainerExecResult result = container.execCmd(commands);
         assertTrue(
-                result.getStdout().contains("\"Created successfully\""),
+                result.getStdout().contains("Created successfully"),
                 result.getStdout());
     }
 
@@ -267,7 +267,7 @@ private <T> void submitFunction(Runtime runtime,
         };
         ContainerExecResult result = container.execCmd(
             commands);
-        assertTrue(result.getStdout().contains("\"Created successfully\""));
+        assertTrue(result.getStdout().contains("Created successfully"));
 
         ensureSubscriptionCreated(inputTopicName, String.format("public/default/%s", functionName), inputTopicSchema);
     }

diff --git a/...ion/src/test/java/org/apache/pulsar/tests/integration/io/PulsarGenericObjectSinkTest.java b/...ion/src/test/java/org/apache/pulsar/tests/integration/io/PulsarGenericObjectSinkTest.java
@@ -270,7 +270,7 @@ private void submitSinkConnector(String sinkName,
         log.info("Run command : {}", StringUtils.join(commands, ' '));
         ContainerExecResult result = container.execCmd(commands);
         assertTrue(
-                result.getStdout().contains("\"Created successfully\""),
+                result.getStdout().contains("Created successfully"),
                 result.getStdout());
     }
 

diff --git a/...ration/src/test/java/org/apache/pulsar/tests/integration/io/sinks/PulsarIOSinkRunner.java b/...ration/src/test/java/org/apache/pulsar/tests/integration/io/sinks/PulsarIOSinkRunner.java
@@ -173,7 +173,7 @@ protected void submitSinkConnector(@SuppressWarnings("rawtypes") SinkTester test
         log.info("Run command : {}", StringUtils.join(commands, ' '));
         ContainerExecResult result = pulsarCluster.getAnyWorker().execCmd(commands);
         assertTrue(
-            result.getStdout().contains("\"Created successfully\""),
+            result.getStdout().contains("Created successfully"),
             result.getStdout());
     }
 
@@ -212,7 +212,7 @@ protected void updateSinkConnector(@SuppressWarnings("rawtypes") SinkTester test
         log.info("Run command : {}", StringUtils.join(commands, ' '));
         ContainerExecResult result = pulsarCluster.getAnyWorker().execCmd(commands);
         assertTrue(
-                result.getStdout().contains("\"Updated successfully\""),
+                result.getStdout().contains("Updated successfully"),
                 result.getStdout());
     }
 
@@ -450,4 +450,4 @@ protected Map<String, String> produceSchemaDeleteMessagesToInputTopic(String inp
         }
         return kvs;
     }
-}
+}
diff --git a/...ion/src/test/java/org/apache/pulsar/tests/integration/io/sources/AvroKafkaSourceTest.java b/...ion/src/test/java/org/apache/pulsar/tests/integration/io/sources/AvroKafkaSourceTest.java
@@ -328,7 +328,7 @@ protected void submitSourceConnector(String tenant,
         log.info("Run command : {}", StringUtils.join(commands, ' '));
         ContainerExecResult result = pulsarCluster.getAnyWorker().execCmd(commands);
         assertTrue(
-                result.getStdout().contains("\"Created successfully\""),
+                result.getStdout().contains("Created successfully"),
                 result.getStdout());
     }
 

diff --git a/...gration/src/test/java/org/apache/pulsar/tests/integration/io/sources/BatchSourceTest.java b/...gration/src/test/java/org/apache/pulsar/tests/integration/io/sources/BatchSourceTest.java
@@ -118,7 +118,7 @@ private void submitSourceConnector(String sourceName,
         log.info("Run command : {}", StringUtils.join(commands, ' '));
         ContainerExecResult result = container.execCmd(commands);
         assertTrue(
-            result.getStdout().contains("\"Created successfully\""),
+            result.getStdout().contains("Created successfully"),
             result.getStdout());
     }
 
@@ -224,4 +224,4 @@ private static void getSourceInfoNotFound(StandaloneContainer container, String
         }
     }
 
-}
+}
diff --git a/...src/test/java/org/apache/pulsar/tests/integration/io/sources/GenericRecordSourceTest.java b/...src/test/java/org/apache/pulsar/tests/integration/io/sources/GenericRecordSourceTest.java
@@ -116,7 +116,7 @@ private void submitSourceConnector(String sourceName,
         log.info("Run command : {}", StringUtils.join(commands, ' '));
         ContainerExecResult result = container.execCmd(commands);
         assertTrue(
-            result.getStdout().contains("\"Created successfully\""),
+            result.getStdout().contains("Created successfully"),
             result.getStdout());
     }
 
@@ -255,4 +255,4 @@ private static void getSourceInfoNotFound(StandaloneContainer container, String
         }
     }
 
-}
+}
diff --git a/...on/src/test/java/org/apache/pulsar/tests/integration/io/sources/PulsarIOSourceRunner.java b/...on/src/test/java/org/apache/pulsar/tests/integration/io/sources/PulsarIOSourceRunner.java
@@ -137,7 +137,7 @@ protected void submitSourceConnector(SourceTester tester,
         log.info("Run command : {}", StringUtils.join(commands, ' '));
         ContainerExecResult result = pulsarCluster.getAnyWorker().execCmd(commands);
         assertTrue(
-            result.getStdout().contains("\"Created successfully\""),
+            result.getStdout().contains("Created successfully"),
             result.getStdout());
     }
 
@@ -162,7 +162,7 @@ protected void updateSourceConnector(SourceTester tester,
         log.info("Run command : {}", StringUtils.join(commands, ' '));
         ContainerExecResult result = pulsarCluster.getAnyWorker().execCmd(commands);
         assertTrue(
-                result.getStdout().contains("\"Updated successfully\""),
+                result.getStdout().contains("Updated successfully"),
                 result.getStdout());
     }
 

diff --git a/...rc/test/java/org/apache/pulsar/tests/integration/io/sources/PulsarSourcePropertyTest.java b/...rc/test/java/org/apache/pulsar/tests/integration/io/sources/PulsarSourcePropertyTest.java
@@ -104,7 +104,7 @@ private void submitSourceConnector(String sourceName,
         log.info("Run command : {}", StringUtils.join(commands, ' '));
         ContainerExecResult result = container.execCmd(commands);
         assertTrue(
-                result.getStdout().contains("\"Created successfully\""),
+                result.getStdout().contains("Created successfully"),
                 result.getStdout());
     }