Add HiveMQ export command for client details

build.gradle

@@ -38,7 +38,7 @@ apply plugin: 'com.palantir.graal'
 javadoc.options.encoding = 'UTF-8'
 
 group = 'com.hivemq'
-version = '1.2.0' + (Boolean.valueOf(System.getProperty("snapshot")) ? "-SNAPSHOT" : "")
+version = '4.4.0' + (Boolean.valueOf(System.getProperty("snapshot")) ? "-SNAPSHOT" : "")
 description = 'MQTT CLI is a tool that provides a feature rich command line interface for connecting, ' +
         'publishing, subscribing, unsubscribing and disconnecting ' +
         'various MQTT clients simultaneously and supports  MQTT 5.0 and MQTT 3.1.1 '
@@ -66,8 +66,10 @@ repositories {
 
 openApiGenerate {
     generatorName = "java"
-    inputSpec = "$rootDir/specs/HiveMQ-4.4.0-SNAPSHOT-OpenAPI-spec.yaml".toString()
+    inputSpec = "$rootDir/specs/HiveMQ-$project.version-OpenAPI-spec.yaml".toString()
     outputDir = "$buildDir/generated/openapi".toString()
+    apiPackage = "com.hivemq.cli.openapi.hivemq"
+    modelPackage = "com.hivemq.cli.openapi.hivemq"
     configOptions = [
             dateLibrary: "java8"
     ]
@@ -154,7 +156,7 @@ ext {
     substrateVmVersion = '19.2.0'
     junitJupiterVersion = '5.5.1'
     openCsvVersion = '5.2'
-    swaggerVersion = '1.5.24'
+    swaggerVersion = '1.6.2'
     findBugsVersion = '3.0.2'
     okHttpVersion = '3.14.7'
     gsonFireVersion = '1.8.4'
@@ -230,7 +232,7 @@ downloadLicenses {
 
 license {
     include "**/*.java"
-    exclude "**/org/openapitools/client/**"
+    exclude "**/com/hivemq/cli/openapi/**"
     header = file('HEADER')
 }
 

src/main/java/com/hivemq/cli/DefaultCLIProperties.java

@@ -18,9 +18,9 @@
 
 
 import com.hivemq.cli.converters.EnvVarToByteBufferConverter;
-import com.hivemq.cli.converters.PasswordFileToByteBufferConverter;
 import com.hivemq.cli.converters.FileToCertificateConverter;
 import com.hivemq.cli.converters.FileToPrivateKeyConverter;
+import com.hivemq.cli.converters.PasswordFileToByteBufferConverter;
 import com.hivemq.client.mqtt.MqttVersion;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;

src/main/java/com/hivemq/cli/MqttCLIMain.java

@@ -27,7 +27,6 @@
 
 import java.security.Security;
 import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.List;
 import java.util.Map;
 import java.util.concurrent.CompletableFuture;
@@ -59,14 +58,7 @@ public static void main(final String[] args) {
 
         Runtime.getRuntime().addShutdownHook(new DisconnectAllClientsTask());
 
-        int exitCode = 0;
-
-        if (args.length > 1 && args[0].equals("hivemq")) {
-            exitCode = MQTTCLI.hivemqCli().execute(Arrays.copyOfRange(args, 1, args.length));
-        }
-        else {
-            exitCode = commandLine.execute(args);
-        }
+        final int exitCode = commandLine.execute(args);
 
         System.exit(exitCode);
 

src/main/java/com/hivemq/cli/commands/AbstractCommonFlags.java

@@ -22,9 +22,9 @@
 import com.hivemq.cli.converters.ByteBufferConverter;
 import com.hivemq.cli.converters.DirectoryToCertificateCollectionConverter;
 import com.hivemq.cli.converters.EnvVarToByteBufferConverter;
-import com.hivemq.cli.converters.PasswordFileToByteBufferConverter;
 import com.hivemq.cli.converters.FileToCertificateConverter;
 import com.hivemq.cli.converters.FileToPrivateKeyConverter;
+import com.hivemq.cli.converters.PasswordFileToByteBufferConverter;
 import com.hivemq.cli.converters.UnsignedShortConverter;
 import com.hivemq.client.mqtt.MqttClientSslConfig;
 import com.hivemq.client.mqtt.MqttWebSocketConfig;

src/main/java/com/hivemq/cli/commands/cli/TestBrokerCommand.java

@@ -23,7 +23,13 @@
 import com.hivemq.cli.converters.MqttVersionConverter;
 import com.hivemq.cli.mqtt.test.Mqtt3FeatureTester;
 import com.hivemq.cli.mqtt.test.Mqtt5FeatureTester;
-import com.hivemq.cli.mqtt.test.results.*;
+import com.hivemq.cli.mqtt.test.results.AsciiCharsInClientIdTestResults;
+import com.hivemq.cli.mqtt.test.results.ClientIdLengthTestResults;
+import com.hivemq.cli.mqtt.test.results.PayloadTestResults;
+import com.hivemq.cli.mqtt.test.results.QosTestResult;
+import com.hivemq.cli.mqtt.test.results.SharedSubscriptionTestResult;
+import com.hivemq.cli.mqtt.test.results.TopicLengthTestResults;
+import com.hivemq.cli.mqtt.test.results.WildcardSubscriptionsTestResult;
 import com.hivemq.client.mqtt.MqttClientSslConfig;
 import com.hivemq.client.mqtt.MqttVersion;
 import com.hivemq.client.mqtt.datatypes.MqttQos;

src/main/java/com/hivemq/cli/commands/hivemq/HiveMQCLICommand.java

@@ -32,13 +32,15 @@
         versionProvider = MqttCLIMain.CLIVersionProvider.class)
 public class HiveMQCLICommand implements Callable<Integer> {
 
+    @CommandLine.Spec
+    CommandLine.Model.CommandSpec spec;
 
     @Inject
     public HiveMQCLICommand() { }
 
     @Override
     public Integer call() {
-        System.out.println(MqttCLIMain.MQTTCLI.hivemqCli().getUsageMessage());
+        System.out.println(spec.commandLine().getUsageMessage(spec.commandLine().getColorScheme()));
         return 0;
     }
 }

src/main/java/com/hivemq/cli/commands/hivemq/export/AbstractExportCommand.java

@@ -29,7 +29,7 @@ public enum OutputFormat {
         csv
     }
 
-    @CommandLine.Option(names = {"-url"}, defaultValue = "http://localhost:8888", description = "The url of the HiveMQ API endpoint (default http://localhost:8888)", order = 1)
+    @CommandLine.Option(names = {"-url"}, defaultValue = "http://localhost:8888", description = "The URL of the HiveMQ REST API endpoint (default http://localhost:8888)", order = 1)
     protected @NotNull String url;
 
     @CommandLine.Option(names = {"-f", "--file"}, description = "The file to write the output to (defaults to a timestamped file in the current working directory)", order = 2)
@@ -41,16 +41,16 @@ public enum OutputFormat {
     @CommandLine.Option(names = {"--format"}, defaultValue = "csv", description = "The export output format (default csv)", order = 4)
     protected @NotNull OutputFormat format;
 
-    @CommandLine.Option(names = {"--csvLineSeparator"}, defaultValue = "" + CSVWriter.DEFAULT_SEPARATOR, description = "An own defined line separator for the csv writing (default " + CSVWriter.DEFAULT_SEPARATOR + ")", order = 5)
-    public char csvLineSeparator;
+    @CommandLine.Option(names = {"--csvSeparator"}, defaultValue = "" + CSVWriter.DEFAULT_SEPARATOR, description = "The separator for csv export (default " + CSVWriter.DEFAULT_SEPARATOR + ")", order = 5)
+    public char csvSeparator;
 
-    @CommandLine.Option(names = {"--csvQuoteChar"}, defaultValue = "" + CSVWriter.DEFAULT_QUOTE_CHARACTER, description = "An own defined quote character for the csv writing (default " + CSVWriter.DEFAULT_QUOTE_CHARACTER + ")", order = 5)
+    @CommandLine.Option(names = {"--csvQuoteChar"}, defaultValue = "" + CSVWriter.DEFAULT_QUOTE_CHARACTER, description = "The quote character for CSV export (default " + CSVWriter.DEFAULT_QUOTE_CHARACTER + ")", order = 6)
     public char csvQuoteCharacter;
 
-    @CommandLine.Option(names = {"--csvEscChar"}, defaultValue = "" + CSVWriter.DEFAULT_ESCAPE_CHARACTER, description = "An own defined escape character for the csv writing (default " + CSVWriter.DEFAULT_ESCAPE_CHARACTER + ")", order = 5)
+    @CommandLine.Option(names = {"--csvEscChar"}, defaultValue = "" + CSVWriter.DEFAULT_ESCAPE_CHARACTER, description = "The escape character for CSV export (default " + CSVWriter.DEFAULT_ESCAPE_CHARACTER + ")", order = 7)
     public char csvEscapeChar;
 
-    @CommandLine.Option(names = {"--csvLineEndChar"}, defaultValue = CSVWriter.DEFAULT_LINE_END, description = "An own defined line end character for the csv writing (default \\n)", order = 5)
+    @CommandLine.Option(names = {"--csvLineEndChar"}, defaultValue = CSVWriter.DEFAULT_LINE_END, description = "The line-end character for CSV export (default \\n)", order = 8)
     public @NotNull String csvLineEndCharacter;
 
 

src/main/java/com/hivemq/cli/commands/hivemq/export/ExportCommand.java

@@ -24,7 +24,7 @@
 
 @CommandLine.Command(
         name = "export",
-        description = "Exports the specified details from a HiveMQ API endpoint",
+        description = "Exports the specified details from HiveMQ",
         synopsisHeading = "%n@|bold Usage:|@  ",
         descriptionHeading = "%n",
         optionListHeading = "%n@|bold Options:|@%n",

src/main/java/com/hivemq/cli/commands/hivemq/export/clients/ClientDetailsCsvWriterTask.java

@@ -16,33 +16,34 @@
  */
 package com.hivemq.cli.commands.hivemq.export.clients;
 
+import com.hivemq.cli.openapi.hivemq.CertificateInformation;
+import com.hivemq.cli.openapi.hivemq.ClientDetails;
+import com.hivemq.cli.openapi.hivemq.ClientRestrictions;
+import com.hivemq.cli.openapi.hivemq.ConnectionDetails;
+import com.hivemq.cli.openapi.hivemq.ProxyInformation;
+import com.hivemq.cli.openapi.hivemq.TLV;
+import com.hivemq.cli.openapi.hivemq.TlsInformation;
 import com.opencsv.CSVWriter;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
-import org.openapitools.client.model.CertificateInformation;
-import org.openapitools.client.model.ClientDetails;
-import org.openapitools.client.model.ClientRestrictions;
-import org.openapitools.client.model.ConnectionDetails;
-import org.openapitools.client.model.ProxyInformation;
-import org.openapitools.client.model.TLV;
-import org.openapitools.client.model.TlsInformation;
 
+import java.io.BufferedWriter;
 import java.io.File;
 import java.io.FileWriter;
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
 import java.util.List;
-import java.util.Queue;
+import java.util.concurrent.BlockingQueue;
 import java.util.concurrent.Callable;
-import java.util.concurrent.CompletionException;
 import java.util.concurrent.Future;
+import java.util.concurrent.TimeUnit;
 
 public class ClientDetailsCsvWriterTask implements Callable<Void> {
 
     public static final String[] EXPORT_CSV_HEADER = {
-            "ClientId",
-            "Connected",
+            "clientId",
+            "connected",
             "sessionExpiryInterval",
             "connectedAt",
             "messageQueueSize",
@@ -65,25 +66,26 @@ public class ClientDetailsCsvWriterTask implements Callable<Void> {
             "cleanStart",
             "cipherSuite",
             "tlsVersion",
-            "cert-commonName",
-            "cert-organization",
-            "cert-organizationalUnit",
-            "cert-serial",
-            "cert-validFrom",
-            "cert-validUntil",
-            "cert-country",
-            "cert-state"
+            "certificateCommonName",
+            "certificateOrganization",
+            "certificateOrganizationalUnit",
+            "certificateSerial",
+            "certificateValidFrom",
+            "certificateValidUntil",
+            "certificateCountry",
+            "certificateState"
     };
 
     final @NotNull Future<Void> clientDetailsFuture;
-    final @NotNull Queue<ClientDetails> clientDetailsQueue;
+    final @NotNull BlockingQueue<ClientDetails> clientDetailsQueue;
     final @NotNull File file;
     final @NotNull CSVWriter csvWriter;
+    final @NotNull BufferedWriter bufferedFileWriter;
 
     long writtenClientDetails = 0;
 
     public ClientDetailsCsvWriterTask(final @NotNull Future<Void> clientDetailsFuture,
-                                      final @NotNull Queue<ClientDetails> clientDetailsQueue,
+                                      final @NotNull BlockingQueue<ClientDetails> clientDetailsQueue,
                                       final @NotNull File file,
                                       final char lineSeparator,
                                       final char quoteCharacter,
@@ -92,8 +94,10 @@ public ClientDetailsCsvWriterTask(final @NotNull Future<Void> clientDetailsFutur
         this.clientDetailsFuture = clientDetailsFuture;
         this.clientDetailsQueue = clientDetailsQueue;
         this.file = file;
+        this.bufferedFileWriter = new BufferedWriter(new FileWriter(file, false));
+
         csvWriter = new CSVWriter(
-                new FileWriter(file, false),
+                bufferedFileWriter,
                 lineSeparator,
                 quoteCharacter,
                 escapeCharacter,
@@ -104,20 +108,29 @@ public ClientDetailsCsvWriterTask(final @NotNull Future<Void> clientDetailsFutur
     @Override
     public Void call() throws IOException, InterruptedException {
 
+        Runtime.getRuntime().addShutdownHook(new Thread(() -> {
+            try {
+                bufferedFileWriter.close();
+            } catch (IOException e) {
+                System.err.println("Interrupted before CSV could be written - CSV may be malformed");
+            }
+        }));
+
         writeHeader();
 
         while (!clientDetailsFuture.isDone() || !clientDetailsQueue.isEmpty()) {
 
-            while (!clientDetailsQueue.isEmpty()) {
-                final ClientDetails clientDetails = clientDetailsQueue.poll();
+            final ClientDetails clientDetails = clientDetailsQueue.poll(50, TimeUnit.MILLISECONDS);
+
+            if (clientDetails != null) {
                 writeRow(clientDetails);
                 writtenClientDetails += 1;
             }
 
-            csvWriter.flush();
-
-            Thread.sleep(50);
         }
+
+        csvWriter.close();
+
         return null;
     }
 
@@ -163,7 +176,7 @@ private void addConnectionDetails(List<String> row, ConnectionDetails connection
             if (password != null) {
                 row.add(new String(password, StandardCharsets.UTF_8));
             } else {
-                row.add(null);
+                row.add(null); // password
             }
 
             row.add(toCsvString(connectionDetails.getCleanStart()));
@@ -172,15 +185,15 @@ private void addConnectionDetails(List<String> row, ConnectionDetails connection
             addTlsInformation(row, tlsInformation);
         }
         else {
-            row.add(null);
+            row.add(null); // Ip
             addProxyInformation(row, null);
-            row.add(null);
-            row.add(null);
-            row.add(null);
-            row.add(null);
-            row.add(null);
-            row.add(null);
-            row.add(null);
+            row.add(null); // mqttVersion
+            row.add(null); // connectedListenerId
+            row.add(null); // connectedNodeId
+            row.add(null); // keepAlive
+            row.add(null); // username
+            row.add(null); // password
+            row.add(null); // cleanStart
             addTlsInformation(row, null);
         }
     }
@@ -195,8 +208,8 @@ private void addTlsInformation(List<String> row, TlsInformation tlsInformation)
             addCertificateInformation(row, certificateInformation);
         }
         else {
-            row.add(null);
-            row.add(null);
+            row.add(null); // cipherSuite
+            row.add(null); // tlsVersion
             addCertificateInformation(row, null);
         }
     }
@@ -213,14 +226,14 @@ private void addCertificateInformation(List<String> row, CertificateInformation
             row.add(toCsvString(certificateInformation.getState()));
         }
         else {
-            row.add(null);
-            row.add(null);
-            row.add(null);
-            row.add(null);
-            row.add(null);
-            row.add(null);
-            row.add(null);
-            row.add(null);
+            row.add(null); // certificateCommonName
+            row.add(null); // certificateOrganization
+            row.add(null); // certificateOrganizationalUnit
+            row.add(null); // certificateSerial
+            row.add(null); // certificateValidFrom
+            row.add(null); // certificateValidUntil
+            row.add(null); // certificateCountry
+            row.add(null); // certificateState
         }
     }
 
@@ -244,15 +257,15 @@ private void addProxyInformation(List<String> row, ProxyInformation proxyInforma
                     }
                 row.add(sb.toString());
             } else {
-                row.add(null);
+                row.add(null); // tlvs
             }
         }
         else {
-            row.add(null);
-            row.add(null);
-            row.add(null);
-            row.add(null);
-            row.add(null);
+            row.add(null); // sourceIp
+            row.add(null); // sourcePort
+            row.add(null); // destinationIp
+            row.add(null); // destinationPort
+            row.add(null); // tlvs
         }
     }
 
@@ -262,9 +275,9 @@ private void addRestrictions(List<String> row, ClientRestrictions restrictions)
             row.add(toCsvString(restrictions.getMaxQueueSize()));
             row.add(toCsvString(restrictions.getQueuedMessageStrategy()));
         } else {
-            row.add(null);
-            row.add(null);
-            row.add(null);
+            row.add(null); // maxMessageSize
+            row.add(null); // maxQueueSize
+            row.add(null); // queuedMessageStrategy
         }
     }