Changes in the debug file, formats and showing PUSH argument

Author: fergarrui

pom.xml

@@ -14,6 +14,8 @@
         <apache.http.client.version>4.5.5</apache.http.client.version>
         <junit.version>4.12</junit.version>
         <velocity.version>1.7</velocity.version>
+        <mvn.assembly.plugin.version>3.1.0</mvn.assembly.plugin.version>
+        <jar.cli>edebugger-${version}</jar.cli>
     </properties>
 
     <dependencies>
@@ -56,6 +58,32 @@
                     <target>${java.version}</target>
                 </configuration>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-assembly-plugin</artifactId>
+                <version>${mvn.assembly.plugin.version}</version>
+                <configuration>
+                    <descriptorRefs>
+                        <descriptorRef>jar-with-dependencies</descriptorRef>
+                    </descriptorRefs>
+                    <finalName>${jar.cli}</finalName>
+                    <appendAssemblyId>false</appendAssemblyId>
+                    <archive>
+                        <manifest>
+                            <mainClass>net.nandgr.debugger.Main</mainClass>
+                        </manifest>
+                    </archive>
+                </configuration>
+                <executions>
+                    <execution>
+                        <id>make-assembly</id>
+                        <phase>package</phase>
+                        <goals>
+                            <goal>single</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
         </plugins>
     </build>
 

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

@@ -17,7 +17,6 @@
 import net.nandgr.debugger.solc.solcjson.SolcOutput;
 import net.nandgr.debugger.trace.TraceService;
 import net.nandgr.debugger.trace.response.json.DebugTraceTransactionLog;
-
 import java.io.File;
 import java.io.IOException;
 import java.nio.file.Files;
@@ -29,10 +28,20 @@
 public class Main {
 
     public static void main(String[] args){
-        // Will be parameters
-        String nodeUrl = "http://127.0.0.1:8545";
-        String txHash = "0xc296ffe00b37d7740f22f2227f39b210a4928756f9472a37cab61951cf9fbffa";
-        String solidityFile = "/home/nando/ethereum/temp/Impl.sol";
+
+        if(args.length < 3) {
+            String execName = new File(Main.class.getProtectionDomain()
+                    .getCodeSource()
+                    .getLocation()
+                    .getPath())
+                    .getName();
+            System.out.println("Help: " + execName + " <solidity source file> <node URL> <transaction hash>");
+            System.exit(0);
+        }
+
+        String solidityFile = args[0];
+        String nodeUrl = args[1];
+        String txHash = args[2];
 
         ObjectMapper objectMapper = new ObjectMapper();
 
@@ -103,13 +112,15 @@ public static void main(String[] args){
         GraphVizCreator graphVizCreator = new GraphVizCreator(runtimeChunks, traceData);
         String graph = graphVizCreator.buildStringGraph();
 
-        Report report = new Report(sourceCode, traceMapJson, graph);
+        Report report = new Report(sourceCode, traceMapJson, graph, solidityFile, txHash);
+        String reportName = null;
         try {
-            report.createReport();
+            reportName = report.createReport();
         } catch (ReportException e) {
             System.out.println("Failed when creating report");
             e.printStackTrace();
             System.exit(0);
         }
+        System.out.println("Debug file created at: " + reportName);
     }
 }

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

@@ -43,11 +43,15 @@ 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()) {
             String id = opcodeSource.getOffset() + "#" + opcodeSource.getBegin() + "#" + opcodeSource.getEnd();
-            sb.append("<TR><TD ID=\"").append(id).append("#offset\" HREF=\" \">")
-                    .append(opcodeSource.getOffset())
-                    .append("</TD><TD ID=\"").append(id).append("#instr\" HREF=\" \">")
-                    .append(opcodeSource.getOpcode())
-                    .append("</TD></TR>").append(System.lineSeparator());
+            sb.append("<TR><TD ID=\"").append(id).append("#offset\" HREF=\" \">0x")
+            .append(String.format("%04X", opcodeSource.getOffset()))
+            .append("</TD><TD ID=\"").append(id).append("#instr\" HREF=\" \">")
+            .append(opcodeSource.getOpcode())
+            .append("</TD>");
+            if (opcodeSource.getParameter() != null) {
+                sb.append("<TD>0x").append(opcodeSource.getParameter().toString(16)).append("</TD>");
+            }
+            sb.append("</TR>").append(System.lineSeparator());
         }
         sb.append("</TABLE> >").append(System.lineSeparator());
         return sb.toString();

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

@@ -7,25 +7,33 @@
 import java.io.IOException;
 import java.io.StringWriter;
 import java.nio.file.Files;
+import java.security.SecureRandom;
 import java.util.Properties;
 
 public class Report {
 
-    private static final String REPORT_FILE_NAME = "debug.html";
     private static final String TEMPLATE_FILE = "template/graph_template.html";
+    private static final String CHARS = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
+    private static SecureRandom random = new SecureRandom();
+
 
     private final String source;
     private final String trace;
     private final String graph;
+    private final String fileName;
+    private final String txHash;
 
-    public Report(String source, String trace, String graph) {
+    public Report(String source, String trace, String graph, String fileName, String txHash) {
         this.source = source;
         this.trace = trace;
         this.graph = graph;
+        this.fileName = fileName;
+        this.txHash = txHash;
     }
 
-    public void createReport() throws ReportException {
-        File debugFile = new File(REPORT_FILE_NAME);
+    public String createReport() throws ReportException {
+        String reportFileName = "debug-" + randomSuffix(6) + ".html";
+        File debugFile = new File(reportFileName);
         try {
             if (!debugFile.createNewFile()) {
                 throw new ReportException("Report file cannot be created");
@@ -44,12 +52,22 @@ public void createReport() throws ReportException {
         velocityContext.put("trace", trace);
         velocityContext.put("graph", graph);
         velocityContext.put("source", source);
+        velocityContext.put("fileName", fileName);
+        velocityContext.put("txHash", txHash);
         StringWriter stringWriter = new StringWriter();
         template.merge(velocityContext, stringWriter);
         try {
             Files.write(debugFile.toPath(), stringWriter.toString().getBytes());
         } catch (IOException e) {
             throw new ReportException("Failed when writing into report file", e);
         }
+        return reportFileName;
+    }
+
+    private static String randomSuffix(int len) {
+        StringBuilder sb = new StringBuilder( len );
+        for( int i = 0; i < len; i++ )
+            sb.append( CHARS.charAt( random.nextInt(CHARS.length()) ) );
+        return sb.toString();
     }
 }

src/main/resources/template/graph_template.html

@@ -10,6 +10,9 @@
 <script src="https://unpkg.com/[email protected]/build/d3-graphviz.js"></script>
 
 <style>
+h4 {
+    margin: 1px;
+}
 #parent {
     position:absolute;
     height:100%;
@@ -306,8 +309,9 @@
     }
 
 }
-</script>
 
+</script>
+<h4>Source: $fileName - Tx Hash: $txHash</h4>
 <div id="parent">
     <div id="editor">
         <div id="aceEditor">$source</div>