by.stub.cli.CommandLineInterpreter Maven / Gradle / Ivy

Go to download
/*
A Java-based HTTP stub server

Copyright (C) 2012 Alexander Zagniotov, Isa Goksu and Eric Mrak

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see .
 */

package by.stub.cli;

import by.stub.annotations.CoberturaIgnore;
import by.stub.utils.JarUtils;
import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.CommandLineParser;
import org.apache.commons.cli.HelpFormatter;
import org.apache.commons.cli.Option;
import org.apache.commons.cli.OptionBuilder;
import org.apache.commons.cli.Options;
import org.apache.commons.cli.ParseException;
import org.apache.commons.cli.PosixParser;

import java.io.PrintWriter;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;

import static by.stub.utils.FileUtils.BR;

public final class CommandLineInterpreter {

   public static final List PROVIDED_OPTIONS = Collections.synchronizedList(new LinkedList());
   public static final String OPTION_ADDRESS = "location";
   public static final String OPTION_CLIENTPORT = "stubs";
   public static final String OPTION_TLSPORT = "tls";
   public static final String OPTION_ADMINPORT = "admin";
   public static final String OPTION_CONFIG = "data";
   public static final String OPTION_KEYSTORE = "keystore";
   public static final String OPTION_KEYPASS = "password";
   public static final String OPTION_MUTE = "mute";
   public static final String OPTION_WATCH = "watch";
   public static final String OPTION_HELP = "help";
   public static final String OPTION_VERSION = "version";
   public static final String OPTION_DEBUG = "debug";
   public static final String OPTION_DISABLE_ADMIN = "disable_admin_portal";
   public static final String OPTION_DISABLE_SSL = "disable_ssl";

   private static final CommandLineParser POSIX_PARSER = new PosixParser();
   private static final Options OPTIONS = new Options();
   private CommandLine line;

   static {
      OPTIONS.addOption("l", OPTION_ADDRESS, true, "Hostname at which to bind stubby.");
      OPTIONS.addOption("s", OPTION_CLIENTPORT, true, "Port for stub portal. Defaults to 8882.");
      OPTIONS.addOption("a", OPTION_ADMINPORT, true, "Port for admin portal. Defaults to 8889.");
      OPTIONS.addOption("t", OPTION_TLSPORT, true, "Port for TLS connection. Defaults to 7443.");
      OPTIONS.addOption("d", OPTION_CONFIG, true, "Data file to pre-load endpoints. Valid YAML 1.1 expected.");
      OPTIONS.addOption("k", OPTION_KEYSTORE, true, "Keystore file for custom TLS. By default TLS is enabled using internal keystore.");
      OPTIONS.addOption("p", OPTION_KEYPASS, true, "Password for the provided keystore file.");
      OPTIONS.addOption("h", OPTION_HELP, false, "This help text.");
      OPTIONS.addOption("m", OPTION_MUTE, false, "Mute console output.");
      OPTIONS.addOption("v", OPTION_VERSION, false, "Prints out to console stubby version.");
      OPTIONS.addOption("o", OPTION_DEBUG, false, "Dumps raw HTTP request to the console (if console is not muted!).");
      OPTIONS.addOption("da", OPTION_DISABLE_ADMIN, false, "Does not start Admin portal");
      OPTIONS.addOption("ds", OPTION_DISABLE_SSL, false, "Does not enable SSL connections");
      @SuppressWarnings("static-access")
      Option watch =
         OptionBuilder
            .withDescription("Periodically scans for changes in last modification date of the main YAML and referenced external files (if any). The flag can accept an optional arg value which is the watch scan time in milliseconds. If milliseconds is not provided, the watch scans every 100ms. If last modification date changed since the last scan period, the stub configuration is reloaded")
            .withLongOpt(OPTION_WATCH)
            .hasOptionalArg()
            .create("w");
      OPTIONS.addOption(watch);
   }


   public void parseCommandLine(final String[] args) throws ParseException {
      line = POSIX_PARSER.parse(OPTIONS, args);
   }

   /**
    * Checks if console output has been muted
    *
    * @return true if the user disabled output to console using command line arg
    */
   public boolean isMute() {
      return line.hasOption(OPTION_MUTE);
   }

   /**
    * Checks if data YAML was provided
    *
    * @return true if the user provided stub data as YAML file with using command line arg
    */
   public boolean isYamlProvided() {
      return line.hasOption(OPTION_CONFIG);
   }

   /**
    * Checks if help option was provided
    *
    * @return true if the user has provided 'help' command line arg
    */
   public boolean isHelp() {
      return line.hasOption(OPTION_HELP);
   }

   /**
    * Checks if version option was provided
    *
    * @return true if the user has provided 'version' command line arg
    */
   public boolean isVersion() {
      return line.hasOption(OPTION_VERSION);
   }

   /**
    * Checks if debug option was provided
    *
    * @return true if the user has provided 'debug' command line arg
    */
   public boolean isDebug() {
      return line.hasOption(OPTION_DEBUG);
   }

   /**
    * Prints 'help' message which describes available command line arguments
    */
   public void printHelp() {
      final HelpFormatter formatter = new HelpFormatter();
      final String command = String.format("%sjava -jar stubby4j-x.x.xx.jar", BR);
      formatter.printHelp(command, OPTIONS, true);
   }

   /**
    * Prints current stubby4j version to the console
    */
   @CoberturaIgnore
   public void printVersion() {
      final HelpFormatter formatter = new HelpFormatter();
      PrintWriter pw = new PrintWriter(System.out);
      formatter.printWrapped(pw, HelpFormatter.DEFAULT_WIDTH, JarUtils.readManifestImplementationVersion());
      pw.flush();
   }


   /**
    * Identifies what command line arguments that have been passed by user are matching available options
    *
    * @return a map of passed command line arguments where key is the name of the argument
    */
   @SuppressWarnings("unchecked")
   public Map getCommandlineParams() {

      final Option[] options = line.getOptions();

      return new HashMap() {{
         for (final Option option : options) {
            put(option.getLongOpt(), option.getValue());
         }
         PROVIDED_OPTIONS.addAll(new LinkedList(this.entrySet()));
      }};
   }
}