Added program arguments and parametrized some options

Author: fergarrui

README.md

@@ -9,14 +9,35 @@ and jump where it is necessary in a quick and graphical way.
 
 # Usage
 
-Right now, the debugger is very simple:
+Version 0.0.4 and earlier (this will be removed when 0.0.5 is released):
 
 ```
 edebugger-1.0-SNAPSHOT.jar <solidity source file> <node URL> <transaction hash>
 ```
-For example:
+
+Version 0.0.5 (current snapshot in master):
+
+```
+edebugger-<VERSION>-SNAPSHOT.jar <OPTIONS>
+Options category 'mandatory':
+  --node [-n] (a string; default: "")
+    The node where the transaction was run. It must support debug_traceTransaction
+  --source-file [-f] (a string; default: "")
+    The source file of the contract the transaction is executed against
+  --transaction-hash [-t] (a string; default: "")
+    Transaction hash to debug
+
+Options category 'optional':
+  --d3-memory [-m] (a string; default: "537395200")
+    D3 graph memory. If the graph is too large, you may want to increase this value (by multiplying it)
+  --[no]only-trace [-o] (a boolean; default: "false")
+    Exclude opcodes that are not executed in the transaction.
+    This may help if the graph is too large and/or the opcodes not executed are not important
+```
+
+Example:
 ```
-java -jar edebugger-1.0-SNAPSHOT.jar ~/tests/Program.sol http://127.0.0.1:8545 0x0c971feb820d2bca26c3e7a0a27b5015694d9ec8ea0169935ff7168a63da3f6f
+java -jar edebugger-<VERSION>.jar -f ~/tests/Program.sol -n http://127.0.0.1:8545 -t 0x0c971feb820d2bca26c3e7a0a27b5015694d9ec8ea0169935ff7168a63da3f6f
 ```
 
 # Download
@@ -47,7 +68,7 @@ There are already tools that allow you to debug Ethereum transactions (Solidity)
 
 For now there are many limitations since this is a very early release of the debugger
 
-* The control flow graph is drawn from the static bytecode, so there can be nodes without edges, a symbolic execution would be needed. Maybe will be added in future releases
+* The control flow graph is drawn from the static bytecode, so there can be nodes without all edges, a symbolic execution would be needed. Maybe will be added in future releases
 * Transactions executed in the runtime bytecode are supported (for example, the constructor execution of a contract cannot be debugged right now)
 * You must provide a node URL that supports `debug_traceTransaction`, like Geth or Ganache, therefore, Infura is not supported
 * It only supports Solidity for now, but planning to make it more modular to support different languages (if the compiler gives source mappings)

pom.xml

@@ -14,6 +14,7 @@
         <apache.http.client.version>4.5.5</apache.http.client.version>
         <junit.version>4.12</junit.version>
         <velocity.version>1.7</velocity.version>
+        <google.options.version>1.0.0</google.options.version>
         <mvn.assembly.plugin.version>3.1.0</mvn.assembly.plugin.version>
         <jar.cli>edebugger-${version}</jar.cli>
     </properties>
@@ -39,6 +40,11 @@
             <artifactId>velocity</artifactId>
             <version>${velocity.version}</version>
         </dependency>
+        <dependency>
+            <groupId>com.github.pcj</groupId>
+            <artifactId>google-options</artifactId>
+            <version>${google.options.version}</version>
+        </dependency>
         <dependency>
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>

src/main/java/net/nandgr/debugger/Arguments.java

@@ -0,0 +1,65 @@
+package net.nandgr.debugger;
+
+import com.google.devtools.common.options.Option;
+import com.google.devtools.common.options.OptionsBase;
+import com.google.devtools.common.options.OptionsParser;
+import java.io.File;
+import java.util.Collections;
+
+public class Arguments extends OptionsBase {
+
+    @Option(
+        name = "source-file",
+        abbrev = 'f',
+        help = "The source file of the contract the transaction is executed against",
+        category = "mandatory",
+        defaultValue = ""
+    )
+    public String sourceFile;
+
+    @Option(
+        name = "node",
+        abbrev = 'n',
+        help = "The node where the transaction was run. It must support debug_traceTransaction",
+        category = "mandatory",
+        defaultValue = ""
+    )
+    public String nodeUrl;
+
+    @Option(
+        name = "transaction-hash",
+        abbrev = 't',
+        help = "Transaction hash to debug",
+        category = "mandatory",
+        defaultValue = ""
+    )
+    public String transactionHash;
+
+    @Option(
+        name = "d3-memory",
+        abbrev = 'm',
+        help = "D3 graph memory. If the graph is too large, you may want to increase this value (by multiplying it)",
+        category = "optional",
+        defaultValue = "537395200"
+    )
+    public String d3totalMemory;
+
+    @Option(
+            name = "only-trace",
+            abbrev = 'o',
+            help = "Exclude opcodes that are not executed in the transaction when creating the graph. " +
+                    "This may help if the graph is too large and the opcodes not executed are not important",
+            category = "optional",
+            defaultValue = "false"
+    )
+    public boolean onlyTraceOpcodes;
+
+    public void validate(OptionsParser parser) {
+        if (sourceFile.isEmpty() || nodeUrl.isEmpty() || transactionHash.isEmpty()) {
+            String execName = new File(Main.class.getProtectionDomain().getCodeSource().getLocation().getPath()).getName();
+            System.out.println("Help: java -jar " + execName + " <OPTIONS>" + System.lineSeparator());
+            System.out.println(parser.describeOptions(Collections.<String, String>emptyMap(), OptionsParser.HelpVerbosity.LONG));
+            System.exit(0);
+        }
+    }
+}

src/main/java/net/nandgr/debugger/Main.java

@@ -1,49 +1,33 @@
 package net.nandgr.debugger;
 
+import com.google.devtools.common.options.OptionsParser;
 import net.nandgr.debugger.report.Report;
 import net.nandgr.debugger.report.ReportException;
-import net.nandgr.debugger.solc.Solc;
 import net.nandgr.debugger.transformers.ContractObject;
 import net.nandgr.debugger.transformers.SolidityTransformer;
 import net.nandgr.debugger.transformers.TransformException;
 import net.nandgr.debugger.transformers.Transformer;
-import java.io.File;
 import java.util.List;
 
 public class Main {
 
-    public static void main(String[] args){
+    public static Arguments arguments;
 
-        if(args.length < 3) {
-            String execName = new File(Main.class.getProtectionDomain()
-                    .getCodeSource()
-                    .getLocation()
-                    .getPath())
-                    .getName();
-            System.out.println("Help: java -jar " + execName + " <solidity source file> <node URL> <transaction hash>");
-            System.exit(0);
-        }
+    public static void main(String[] args){
 
-        String sourceCodeFile = args[0];
-        String nodeUrl = args[1];
-        String txHash = args[2];
-
-        if (!Solc.checkSolcInClasspath()) {
-            System.out.println("solc was not found in classpath");
-            System.exit(0);
-        }
+        parseArguments(args);
 
         // for now only solidity is supported
-        Transformer solidityTransformer = new SolidityTransformer(nodeUrl, txHash);
+        Transformer solidityTransformer = new SolidityTransformer(arguments.nodeUrl, arguments.transactionHash);
         List<ContractObject> contracts = null;
         try {
-            contracts = solidityTransformer.loadContracts(sourceCodeFile);
+            contracts = solidityTransformer.loadContracts(arguments.sourceFile);
         } catch (TransformException e) {
             e.printStackTrace();
             System.exit(0);
         }
 
-        Report report = new Report(contracts, txHash);
+        Report report = new Report(contracts, arguments.transactionHash);
         String reportName = null;
         try {
             reportName = report.createReport();
@@ -54,4 +38,11 @@ public static void main(String[] args){
         }
         System.out.println("Debug file created at: " + reportName);
     }
+
+    private static void parseArguments(String[] args) {
+        OptionsParser optionsParser = OptionsParser.newOptionsParser(Arguments.class);
+        optionsParser.parseAndExitUponError(args);
+        arguments = optionsParser.getOptions(Arguments.class);
+        arguments.validate(optionsParser);
+    }
 }

src/main/java/net/nandgr/debugger/cfg/graphviz/GraphVizCreator.java

@@ -1,5 +1,6 @@
 package net.nandgr.debugger.cfg.graphviz;
 
+import net.nandgr.debugger.Main;
 import net.nandgr.debugger.cfg.beans.BytecodeChunk;
 import net.nandgr.debugger.cfg.beans.OpcodeSource;
 import net.nandgr.debugger.node.response.json.DebugTraceTransactionLog;
@@ -26,21 +27,36 @@ public String buildStringGraph() {
         for (BytecodeChunk bytecodeChunk : chunks.values()) {
             String coloredNode = "";
             OpcodeSource firstOpcode = bytecodeChunk.getOpcodes().get(0);
+            if (Main.arguments.onlyTraceOpcodes && !trace.containsKey(firstOpcode.getOffset())) {
+                continue;
+            }
             if (trace.containsKey(firstOpcode.getOffset())) {
                 coloredNode = " fontcolor=\"red\" ";
             }
             sb.append(bytecodeChunk.getId()).append("[").append(coloredNode).append("label=").append(buildLabel(bytecodeChunk)).append("]").append(System.lineSeparator());
-            if (bytecodeChunk.getBranchA() != null) {
+
+            if (checkIfAppendBranch(bytecodeChunk.getBranchA())) {
                 sb.append(bytecodeChunk.getId()).append("->").append(bytecodeChunk.getBranchA().getId()).append("[color=\"#12cc12\"];").append(System.lineSeparator());
             }
-            if (bytecodeChunk.getBranchB() != null) {
+            if (checkIfAppendBranch(bytecodeChunk.getBranchB())) {
                 sb.append(bytecodeChunk.getId()).append("->").append(bytecodeChunk.getBranchB().getId()).append("[color=\"#12cc12\"];").append(System.lineSeparator());
             }
         }
         sb.append("}");
         return sb.toString();
     }
 
+    private boolean checkIfAppendBranch(BytecodeChunk branch) {
+        if (branch == null) {
+            return false;
+        }
+        if (!Main.arguments.onlyTraceOpcodes) {
+            return true;
+        }
+        OpcodeSource firstOpcode = branch.getOpcodes().get(0);
+        return trace.containsKey(firstOpcode.getOffset());
+    }
+
     private String buildLabel(BytecodeChunk bytecodeChunk) {
         StringBuilder sb= new StringBuilder("< <TABLE BORDER=\"0\" CELLBORDER=\"1\" CELLSPACING=\"0\" CELLPADDING=\"4\">").append(System.lineSeparator());
         for (OpcodeSource opcodeSource : bytecodeChunk.getOpcodes()) {

src/main/java/net/nandgr/debugger/report/Report.java

@@ -1,5 +1,6 @@
 package net.nandgr.debugger.report;
 
+import net.nandgr.debugger.Main;
 import net.nandgr.debugger.transformers.ContractObject;
 import org.apache.velocity.Template;
 import org.apache.velocity.VelocityContext;
@@ -46,6 +47,7 @@ public String createReport() throws ReportException {
         VelocityContext velocityContext = new VelocityContext();
         velocityContext.put("contracts", contracts);
         velocityContext.put("txHash", txHash);
+        velocityContext.put("d3memory", Main.arguments.d3totalMemory);
         StringWriter stringWriter = new StringWriter();
         template.merge(velocityContext, stringWriter);
         try {

src/main/java/net/nandgr/debugger/transformers/SolidityTransformer.java

@@ -32,6 +32,10 @@ public class SolidityTransformer implements Transformer {
     public SolidityTransformer(String nodeUrl, String txHash) {
         this.nodeUrl = nodeUrl;
         this.txHash = txHash;
+        if (!Solc.checkSolcInClasspath()) {
+            System.out.println("solc was not found in classpath");
+            System.exit(0);
+        }
     }
 
     @Override

src/main/resources/template/graph_template.html

@@ -155,7 +155,7 @@
     `;
 
     window["graphviz-$contract.contractName"] = d3.select("#graph-$contract.contractName").graphviz();
-    window["graphviz-$contract.contractName"].totalMemory(537395200);
+    window["graphviz-$contract.contractName"].totalMemory($d3memory);
 #end
 
     function render(dotSrc, gViz, contractName) {