Merge pull request #4606 from bladehan1/feature/help

feat(command): show help message

Author: zhang0125

common/src/main/java/org/tron/common/parameter/CommonParameter.java

@@ -25,57 +25,65 @@ public class CommonParameter {
   public static CommonParameter PARAMETER = new CommonParameter();
   @Setter
   public static boolean ENERGY_LIMIT_HARD_FORK = false;
-  @Parameter(names = {"-c", "--config"}, description = "Config File")
+  @Parameter(names = {"-c", "--config"}, description = "Config file (default:config.conf)")
   public String shellConfFileName = "";
   @Getter
-  @Parameter(names = {"-d", "--output-directory"}, description = "Directory")
+  @Parameter(names = {"-d", "--output-directory"},
+      description = "Data directory for the databases (default:output-directory)")
   public String outputDirectory = "output-directory";
   @Getter
-  @Parameter(names = {"--log-config"})
+  @Parameter(names = {"--log-config"}, description = "Logback config file")
   public String logbackPath = "";
   @Getter
-  @Parameter(names = {"-h", "--help"}, help = true, description = "HELP message")
+  @Parameter(names = {"-h", "--help"}, help = true, description = "Show help message")
   public boolean help = false;
   @Getter
   @Setter
-  @Parameter(names = {"-w", "--witness"})
+  @Parameter(names = {"-w", "--witness"}, description = "Is witness node")
   public boolean witness = false;
   @Getter
   @Setter
-  @Parameter(names = {"--support-constant"})
+  @Parameter(names = {"--support-constant"}, description = "Support constant calling for TVM. " +
+      "(defalut: false)")
   public boolean supportConstant = false;
   @Getter
   @Setter
-  @Parameter(names = {"--max-energy-limit-for-constant"})
+  @Parameter(names = {"--max-energy-limit-for-constant"}, description = "Max energy limit for " +
+      "constant calling. (default: 100,000,000)")
   public long maxEnergyLimitForConstant = 100_000_000L;
   @Getter
   @Setter
-  @Parameter(names = {"--lru-cache-size"})
+  @Parameter(names = {"--lru-cache-size"}, description = "Max LRU size for caching bytecode and " +
+      "result of JUMPDEST analysis. (default: 500)")
   public int lruCacheSize = 500;
   @Getter
   @Setter
-  @Parameter(names = {"--debug"})
+  @Parameter(names = {"--debug"}, description = "Switch for TVM debug mode. In debug model, TVM " +
+      "will not check for timeout. (default: false)")
   public boolean debug = false;
   @Getter
   @Setter
-  @Parameter(names = {"--min-time-ratio"})
+  @Parameter(names = {"--min-time-ratio"}, description = "Maximum CPU tolerance when executing " +
+      "non-timeout transactions while synchronizing blocks. (default: 5.0)")
   public double minTimeRatio = 0.0;
   @Getter
   @Setter
-  @Parameter(names = {"--max-time-ratio"})
+  @Parameter(names = {"--max-time-ratio"}, description = "Maximum CPU tolerance when executing " +
+      "timeout transactions while synchronizing blocks. (default: 0.0)")
   public double maxTimeRatio = calcMaxTimeRatio();
   @Getter
   @Setter
   @Parameter(names = {"--long-running-time"})
   public int longRunningTime = 10;
   @Getter
   @Setter
-  @Parameter(names = {"--max-connect-number"})
+  @Parameter(names = {"--max-connect-number"}, description = "Http server max connect number " +
+      "(default:50)")
   public int maxHttpConnectNumber = 50;
   @Getter
   @Parameter(description = "--seed-nodes")
   public List<String> seedNodes = new ArrayList<>();
-  @Parameter(names = {"-p", "--private-key"}, description = "private-key")
+  @Parameter(names = {"-p", "--private-key"}, description = "Witness private key")
   public String privateKey = "";
   @Parameter(names = {"--witness-address"}, description = "witness-address")
   public String witnessAddress = "";
@@ -92,8 +100,8 @@ public class CommonParameter {
       "--storage-db-synchronous"},
       description = "Storage db is synchronous or not.(true or false)")
   public String storageDbSynchronous = "";
-  @Parameter(names = {"--contract-parse-enable"},
-      description = "enable contract parses in java-tron or not.(true or false)")
+  @Parameter(names = {"--contract-parse-enable"}, description = "Switch for contract parses in " +
+      "java-tron. (default: true)")
   public String contractParseEnable = "";
   @Parameter(names = {"--storage-index-directory"},
       description = "Storage index directory")
@@ -162,7 +170,8 @@ public class CommonParameter {
   public long nodeP2pPingInterval;
   @Getter
   @Setter
-  @Parameter(names = {"--save-internaltx"})
+  @Parameter(names = {"--save-internaltx"}, description = "Save internal transactions generated " +
+      "during TVM execution, such as create, call, suicide and so on. (default: false)")
   public boolean saveInternalTx;
   @Getter
   @Setter
@@ -342,12 +351,12 @@ public class CommonParameter {
   public long blockNumForEnergyLimit;
   @Getter
   @Setter
-  @Parameter(names = {"--es"})
+  @Parameter(names = {"--es"}, description = "Start event subscribe server")
   public boolean eventSubscribe = false;
   @Getter
   @Setter
   public long trxExpirationTimeInMilliseconds; // (ms)
-  @Parameter(names = {"-v", "--version"}, description = "output code version", help = true)
+  @Parameter(names = {"-v", "--version"}, description = "Output code version", help = true)
   public boolean version;
   @Getter
   @Setter

framework/src/main/java/org/tron/core/config/args/Args.java

@@ -7,6 +7,8 @@
 import static org.tron.core.config.Parameter.ChainConstant.MAX_ACTIVE_WITNESS_NUM;
 
 import com.beust.jcommander.JCommander;
+import com.beust.jcommander.ParameterDescription;
+import com.google.common.base.Strings;
 import com.typesafe.config.Config;
 import com.typesafe.config.ConfigObject;
 import io.grpc.internal.GrpcUtil;
@@ -22,9 +24,13 @@
 import java.nio.file.Paths;
 import java.text.ParseException;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Collections;
+import java.util.HashMap;
 import java.util.HashSet;
+import java.util.LinkedHashMap;
 import java.util.List;
+import java.util.Map;
 import java.util.Objects;
 import java.util.Optional;
 import java.util.Properties;
@@ -230,6 +236,95 @@ private static void printVersion() {
     JCommander.getConsole().println("Code : " + Version.VERSION_CODE);
   }
 
+  public static void printHelp(JCommander jCommander) {
+    List<ParameterDescription> parameterDescriptionList = jCommander.getParameters();
+    Map<String, ParameterDescription> stringParameterDescriptionMap = new HashMap<>();
+    for (ParameterDescription parameterDescription : parameterDescriptionList) {
+      String parameterName = parameterDescription.getParameterized().getName();
+      stringParameterDescriptionMap.put(parameterName, parameterDescription);
+    }
+
+    StringBuilder helpStr = new StringBuilder();
+    helpStr.append("Name:\n\tFullNode - the java-tron command line interface\n");
+    String programName = Strings.isNullOrEmpty(jCommander.getProgramName()) ? "FullNode.jar" :
+        jCommander.getProgramName();
+    helpStr.append(String.format("%nUsage: java -jar %s [options] [seedNode <seedNode> ...]%n",
+        programName));
+    helpStr.append(String.format("%nVERSION: %n%s-%s%n", Version.getVersion(),
+        getCommitIdAbbrev()));
+
+    Map<String, String[]> groupOptionListMap = Args.getOptionGroup();
+    for (Map.Entry<String, String[]> entry : groupOptionListMap.entrySet()) {
+      String group = entry.getKey();
+      helpStr.append(String.format("%n%s OPTIONS:%n", group.toUpperCase()));
+      int optionMaxLength = Arrays.stream(entry.getValue()).mapToInt(p -> {
+        ParameterDescription tmpParameterDescription = stringParameterDescriptionMap.get(p);
+        if (tmpParameterDescription == null) {
+          return 1;
+        }
+        return tmpParameterDescription.getNames().length();
+      }).max().orElse(1);
+
+      for (String option : groupOptionListMap.get(group)) {
+        ParameterDescription parameterDescription = stringParameterDescriptionMap.get(option);
+        if (parameterDescription == null) {
+          logger.warn("Miss option:{}", option);
+          continue;
+        }
+        String tmpOptionDesc = String.format("%s\t\t\t%s%n",
+            Strings.padEnd(parameterDescription.getNames(), optionMaxLength, ' '),
+            upperFirst(parameterDescription.getDescription()));
+        helpStr.append(tmpOptionDesc);
+      }
+    }
+    JCommander.getConsole().println(helpStr.toString());
+  }
+
+  public static String upperFirst(String name) {
+    if (name.length() <= 1) {
+      return name;
+    }
+    name = name.substring(0, 1).toUpperCase() + name.substring(1);
+    return name;
+  }
+
+  private static String getCommitIdAbbrev() {
+    Properties properties = new Properties();
+    try {
+      InputStream in = Thread.currentThread()
+          .getContextClassLoader().getResourceAsStream("git.properties");
+      properties.load(in);
+    } catch (IOException e) {
+      logger.warn("Load resource failed,git.properties {}", e.getMessage());
+    }
+    return properties.getProperty("git.commit.id.abbrev");
+  }
+
+  private static Map<String, String[]> getOptionGroup() {
+    String[] tronOption = new String[] {"version", "help", "shellConfFileName", "logbackPath",
+        "eventSubscribe"};
+    String[] dbOption = new String[] {"outputDirectory"};
+    String[] witnessOption = new String[] {"witness", "privateKey"};
+    String[] vmOption = new String[] {"debug"};
+
+    Map<String, String[]> optionGroupMap = new LinkedHashMap<>();
+    optionGroupMap.put("tron", tronOption);
+    optionGroupMap.put("db", dbOption);
+    optionGroupMap.put("witness", witnessOption);
+    optionGroupMap.put("virtual machine", vmOption);
+
+    for (String[] optionList : optionGroupMap.values()) {
+      for (String option : optionList) {
+        try {
+          CommonParameter.class.getField(option);
+        } catch (NoSuchFieldException e) {
+          logger.warn("NoSuchFieldException:{},{}", option, e.getMessage());
+        }
+      }
+    }
+    return optionGroupMap;
+  }
+
   /**
    * set parameters.
    */

framework/src/main/java/org/tron/program/FullNode.java

@@ -2,6 +2,7 @@
 
 import ch.qos.logback.classic.LoggerContext;
 import ch.qos.logback.classic.joran.JoranConfigurator;
+import com.beust.jcommander.JCommander;
 import java.io.File;
 import lombok.extern.slf4j.Slf4j;
 import org.slf4j.LoggerFactory;
@@ -58,7 +59,9 @@ public static void main(String[] args) {
     load(parameter.getLogbackPath());
 
     if (parameter.isHelp()) {
-      logger.info("Here is the help message.");
+      JCommander jCommander = JCommander.newBuilder().addObject(Args.PARAMETER).build();
+      jCommander.parse(args);
+      Args.printHelp(jCommander);
       return;
     }