- using explicit CLI parsing

- extended ServiceConfig to support unlimited defaults - parametrized dependency versions in pom

Author: keinproblem

sampling-message-client/src/main/java/de/dhbw/ravensburg/verteiltesysteme/client/CommandLineClient.java

@@ -276,7 +276,6 @@ private void deleteSamplingMessage(CommandLine commandLine, SamplingMessageGrpc.
  * @param errorMessage Message to be displayed on the console during the program shutdown
  */
  private void exitWithError(String errorMessage) {
- log.debug("ParsingError: ", errorMessage);
  log.error(errorMessage);
  helpFormatter.printHelp("sampling-message-client", options);
  System.exit(1);

sampling-message-server/pom.xml

@@ -20,7 +20,8 @@
  <io.grpc.version>1.12.0</io.grpc.version>
  <org.apache.logging.log4j.version>2.11.0</org.apache.logging.log4j.version>
  <org.projectlombok.version>1.16.20</org.projectlombok.version>
- <org.mapstruct.version>1.2.0.Final</org.mapstruct.version>
+ <commons-cli.version>1.4</commons-cli.version>
+ <org.testng.version>6.14.3</org.testng.version>
  </properties>
 
  <build>
@@ -120,17 +121,14 @@
  <dependency>
  <groupId>commons-cli</groupId>
  <artifactId>commons-cli</artifactId>
- <version>1.4</version>
+ <version>${commons-cli.version}</version>
  </dependency>
-
-
  <dependency>
  <groupId>org.testng</groupId>
  <artifactId>testng</artifactId>
- <version>6.14.3</version>
+ <version>${org.testng.version}</version>
  <scope>test</scope>
  </dependency>
-
  <dependency>
  <groupId>de.dhbw.ravensburg.verteiltesysteme</groupId>
  <artifactId>sampling-message-proto</artifactId>

sampling-message-server/src/it/java/de/dhbw/ravensburg/verteiltesysteme/server/SamplingMessageServerIT.java

@@ -18,10 +18,10 @@ public class SamplingMessageServerIT {
 
  final Integer testingPort = 8888;
  ServiceEndpoint serviceEndpoint;
- final Integer maxSamplingMessageNameLength = 20;
- final Integer maxSamplingMessageContentLength = 20;
- final Integer maxSamplingMessageCount = 20;
- ServiceConfig serviceConfig = new ServiceConfig(maxSamplingMessageNameLength, maxSamplingMessageContentLength, maxSamplingMessageCount, testingPort);
+ final int maxSamplingMessageNameLength = 20;
+ final int maxSamplingMessageContentLength = 20;
+ final int maxSamplingMessageCount = 20;
+ ServiceConfig serviceConfig = new ServiceConfig((long) maxSamplingMessageNameLength, (long) maxSamplingMessageContentLength, (long) maxSamplingMessageCount, testingPort);
  SamplingMessageGrpc.SamplingMessageBlockingStub samplingMessageBlockingStub;
 
  private static SamplingMessageGrpcService.CreateSamplingMessageRequest createSamplingMessageRequest(String name, long duration) {

sampling-message-server/src/main/java/de/dhbw/ravensburg/verteiltesysteme/server/Main.java

@@ -1,7 +1,10 @@
 package de.dhbw.ravensburg.verteiltesysteme.server;
 
 import de.dhbw.ravensburg.verteiltesysteme.server.service.ServiceConfig;
+import de.dhbw.ravensburg.verteiltesysteme.server.util.ServerCommandLineParser;
 import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.cli.HelpFormatter;
+import org.apache.commons.cli.ParseException;
 
 /**
  * Class providing the application entry point.
@@ -16,13 +19,24 @@ public class Main {
  * @param args CLI arguments
  */
  public static void main(String[] args) {
-
- final ServiceConfig serviceConfig = new ServiceConfig(255, 32, 32, 8080);
+ final ServiceConfig serviceConfig;
+ try {
+ serviceConfig = ServerCommandLineParser.fromCliArgs(args);
+ } catch (ParseException e) {
+ e.printStackTrace();
+ log.debug("ParsingError: ", e.getMessage());
+ log.error(e.getMessage());
+ new HelpFormatter().printHelp("sampling-message-client", ServerCommandLineParser.defaultOptions());
+ System.exit(1);
+ //dead code to satisfy for debugger
+ return;
+ }
+ //final ServiceConfig serviceConfig = new ServiceConfig(255, 32, 32, 8080);
 
  final ServiceEndpoint serviceEndpoint = new ServiceEndpoint(serviceConfig);
 
  /*
- Graceful shutdown on shutdown hook
+ Register graceful shutdown hook
  */
  Runtime.getRuntime().addShutdownHook(new Thread(() -> {
  log.info("Shutting Hook received.");

sampling-message-server/src/main/java/de/dhbw/ravensburg/verteiltesysteme/server/ServiceEndpoint.java

@@ -33,6 +33,7 @@ public class ServiceEndpoint {
  public ServiceEndpoint(final ServiceConfig serviceConfig) {
  log.info("Preparing Service Endpoint");
  this.serviceConfig = serviceConfig;
+ log.info(String.format("Using following config: %s", serviceConfig.toString()));
 
  final DatabaseAccessObject databaseAccessObject = new DatabaseAccessObjectImpl(new FakePersistence<>());
  final InputValidator inputValidator = new InputValidator(this.serviceConfig);

sampling-message-server/src/main/java/de/dhbw/ravensburg/verteiltesysteme/server/service/InputValidator.java

@@ -18,14 +18,23 @@ public InputValidator(final ServiceConfig serviceConfig) {
  }
 
  public boolean isInvalidMessageName(final String messageName) {
+ if (this.serviceConfig.isUnlimitedMessageNameSize())
+ return true;
+
  return (messageName == null || messageName.length() > this.serviceConfig.getMaximumSamplingMessageNameSize()); // messageName.isEmpty());
  }
 
  public boolean isInvalidMessageContent(final String messageContent) {
+ if (this.serviceConfig.isUnlimitedMessageContentSize())
+ return true;
+
  return (messageContent == null || messageContent.length() > this.serviceConfig.getMaximumSamplingMessageContentSize()); // messageContent.isEmpty();
  }
 
  public boolean isMessageCountExceeded(final Long totalMessageCount) {
+ if (this.serviceConfig.isUnlimitedMessageCount())
+ return true;
+
  return totalMessageCount >= serviceConfig.getMaximumSamplingMessageContentSize();
  }
 
@@ -34,7 +43,7 @@ public boolean isValid(@NonNull final Instant creationTime, @NonNull final Durat
  return Instant.now().minus(lifetime).isBefore(creationTime);
  }
 
- public int getCurrentSamplingMaximumMessageCount() {
+ public long getCurrentSamplingMaximumMessageCount() {
  return this.serviceConfig.getMaximumSamplingMessageCount();
  }
 }

sampling-message-server/src/main/java/de/dhbw/ravensburg/verteiltesysteme/server/service/ServiceConfig.java

@@ -14,20 +14,60 @@
 @AllArgsConstructor
 public class ServiceConfig {
 
- public static final Integer DEFAULT_MAXIMUM_SAMPLING_MESSAGE_NAME_SIZE = 32;
- public static final Integer DEFAULT_MAXIMUM_SAMPLING_MESSAGE_CONTENT_SIZE = 256;
- public static final Integer DEFAULT_MAXIMUM_SAMPLING_MESSAGE_COUNT = 32;
+ public static final Long DEFAULT_MAXIMUM_SAMPLING_MESSAGE_NAME_SIZE = -1L;
+ public static final Long DEFAULT_MAXIMUM_SAMPLING_MESSAGE_CONTENT_SIZE = -1L;
+ public static final Long DEFAULT_MAXIMUM_SAMPLING_MESSAGE_COUNT = -1L;
  public static final Integer DEFAULT_SERVICE_ENDPOINT_PORT = 8088;
- private final Integer maximumSamplingMessageNameSize;
- private final Integer maximumSamplingMessageContentSize;
- private final Integer maximumSamplingMessageCount;
+ private final Long maximumSamplingMessageNameSize;
+ private final Long maximumSamplingMessageContentSize;
+ private final Long maximumSamplingMessageCount;
  private final Integer serviceEndpointListeningPort;
 
+ /**
+ * Default constructor with unlimited size limits and default port
+ */
  public ServiceConfig() {
  this.maximumSamplingMessageNameSize = DEFAULT_MAXIMUM_SAMPLING_MESSAGE_NAME_SIZE;
  this.maximumSamplingMessageContentSize = DEFAULT_MAXIMUM_SAMPLING_MESSAGE_CONTENT_SIZE;
  this.maximumSamplingMessageCount = DEFAULT_MAXIMUM_SAMPLING_MESSAGE_COUNT;
 
  this.serviceEndpointListeningPort = DEFAULT_SERVICE_ENDPOINT_PORT;
  }
+
+ /**
+ * Check if unlimited sampling message name length was configured
+ *
+ * @return true if unlimited
+ */
+ public boolean isUnlimitedMessageNameSize() {
+ return this.maximumSamplingMessageNameSize < 0;
+ }
+
+ /**
+ * Check if unlimited sampling message content length was configured
+ *
+ * @return true if unlimited
+ */
+ public boolean isUnlimitedMessageContentSize() {
+ return this.maximumSamplingMessageContentSize < 0;
+ }
+
+ /**
+ * Check if unlimited sampling message count was configured
+ *
+ * @return true if unlimited
+ */
+ public boolean isUnlimitedMessageCount() {
+ return this.maximumSamplingMessageCount < 0;
+ }
+
+
+ /**
+ * Check if default was was configured
+ *
+ * @return true if default port
+ */
+ public boolean isDefaultPort() {
+ return this.serviceEndpointListeningPort.equals(DEFAULT_SERVICE_ENDPOINT_PORT);
+ }
 }

sampling-message-server/src/main/java/de/dhbw/ravensburg/verteiltesysteme/server/util/ServerCommandLineParser.java

@@ -0,0 +1,68 @@
+package de.dhbw.ravensburg.verteiltesysteme.server.util;
+
+import de.dhbw.ravensburg.verteiltesysteme.server.service.ServiceConfig;
+import org.apache.commons.cli.*;
+
+/**
+ * Utility class for CLI related stuff
+ */
+public class ServerCommandLineParser {
+
+ /**
+ * Provides default Command Line Options
+ *
+ * @return Options object containing the defaults
+ */
+ public static Options defaultOptions() {
+ final Options options = new Options();
+
+ options.addOption(Option.builder("p")
+ .longOpt("port")
+ .hasArg(true)
+ .required(false)
+ .desc("local TCP Server Port - default is 8080")
+ .build());
+
+ options.addOption(Option.builder("cl")
+ .longOpt("content-length")
+ .hasArg(true)
+ .required(false)
+ .desc("maximum length of a message's content - default is unlimited")
+ .build());
+
+ options.addOption(Option.builder("nl")
+ .longOpt("name-length")
+ .hasArg(true)
+ .required(false)
+ .desc("maximum length of a message's name - default is unlimited")
+ .build());
+
+ options.addOption(Option.builder("mc")
+ .longOpt("message-count")
+ .hasArg(true)
+ .required(false)
+ .desc("maximum number of messages the server can hold - default is unlimited")
+ .build());
+
+ return options;
+ }
+
+ /**
+ * Produce a {@link ServiceConfig} from a raw command line args String[]
+ *
+ * @param args Command lines as provided in main method
+ * @return appropriate service configuration object
+ * @throws ParseException if parsing
+ */
+ public static ServiceConfig fromCliArgs(final String[] args) throws ParseException {
+ final CommandLineParser serverCommandLineParser = new DefaultParser();
+ final CommandLine commandLine = serverCommandLineParser.parse(defaultOptions(), args);
+
+ final Long maxNameLength = commandLine.hasOption("name-length") ? Long.valueOf(commandLine.getOptionValue("name-length")) : ServiceConfig.DEFAULT_MAXIMUM_SAMPLING_MESSAGE_NAME_SIZE;
+ final Long maxContentLength = commandLine.hasOption("content-length") ? Long.valueOf(commandLine.getOptionValue("content-length")) : ServiceConfig.DEFAULT_MAXIMUM_SAMPLING_MESSAGE_CONTENT_SIZE;
+ final Long maxMessageCount = commandLine.hasOption("content-length") ? Long.valueOf(commandLine.getOptionValue("content-length")) : ServiceConfig.DEFAULT_MAXIMUM_SAMPLING_MESSAGE_COUNT;
+ final Integer serverPort = commandLine.hasOption("content-length") ? Integer.valueOf(commandLine.getOptionValue("content-length")) : ServiceConfig.DEFAULT_SERVICE_ENDPOINT_PORT;
+
+ return new ServiceConfig(maxNameLength, maxContentLength, maxMessageCount, serverPort);
+ }
+}