#5 Allow printing report to a JSON file

.gitignore

@@ -6,6 +6,8 @@ target
 .project
 .classpath
 .settings
+# IDEA generated
+.idea
 # Release plugin
 release.properties
 # TestNG within Eclipse.

README.md

@@ -36,6 +36,25 @@ have to define the following `.mvn/extensions.xml` file:
 
 The download from Maven Central will be done by Maven itself.
 
+This extension allows printing the report to a JSON file instead of the stdout. To enable this you  
+simply have to set the property `<maven-buildtime-profiler.output>` with value `json`  
+under `<properties>` section in your project's pom.
+
+Additionally, you can set the property `<maven-buildtime-profiler.directory>` to indicate  
+the destination folder of the `report.json` file:
+
+```xml
+  <properties>
+    <maven-buildtime-profiler>json</maven-buildtime-profiler>
+    <maven-buildtime-profiler.output>${maven-buildtime-profiler}</maven-buildtime-profiler.output>
+    <maven-buildtime-profiler.directory>ignore/</maven-buildtime-profiler.directory>
+  </properties>
+```
+
+<small>Note that in this example we can also set the output mode adding `-Dmaven-buildtime-profiler=stdout`</small> to the maven command.
+
+Also, if somehow you don't want to export the profiling result you can set `<maven-buildtime-profiler.output>` to `none`.
+
 Here's an example of what the output will look like:
 
 ```

pom.xml

@@ -60,6 +60,11 @@
         </exclusion>
       </exclusions>
     </dependency>
+    <dependency>
+      <groupId>org.json</groupId>
+      <artifactId>json</artifactId>
+      <version>20190722</version>
+    </dependency>
     <dependency>
       <groupId>org.testng</groupId>
       <artifactId>testng</artifactId>
@@ -194,6 +199,14 @@
           </execution>
         </executions>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-compiler-plugin</artifactId>
+        <configuration>
+          <source>8</source>
+          <target>8</target>
+        </configuration>
+      </plugin>
 
     </plugins>
   </build>

src/main/java/com/soebes/maven/extensions/BuildTimeProfiler.java

@@ -19,6 +19,9 @@
  * under the License.
  */
 
+import java.io.File;
+import java.io.FileWriter;
+import java.io.IOException;
 import java.util.Collections;
 import java.util.LinkedList;
 import java.util.List;
@@ -37,6 +40,7 @@
 import org.apache.maven.project.MavenProject;
 import org.eclipse.aether.RepositoryEvent;
 import org.eclipse.aether.RepositoryEvent.EventType;
+import org.json.JSONObject;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -85,6 +89,8 @@ public class BuildTimeProfiler
 
     private final ProjectTimer forkProject;
 
+    private final Execution execution;
+
     public BuildTimeProfiler()
     {
         LOGGER.debug( "LifeCycleProfiler ctor called." );
@@ -103,7 +109,7 @@ public BuildTimeProfiler()
         this.metadataInstallTimer = new MetadataInstallTimer();
         this.forkTimer = new ForkTimer();
         this.forkProject = new ProjectTimer();
-
+        this.execution = new Execution();
     }
 
     @Override
@@ -387,10 +393,50 @@ private void executionRequestEventHandler( MavenExecutionRequest event )
         // event.getUserProperties().put( "revision", "1.2.3-SNAPSHOT" );
         // event.getSystemProperties().put( "revision", "1.2.3-SNAPSHOT" );
         // Can we do something more useful here?
+        this.execution.setExecutionRequest(event);
         LOGGER.debug( "MBTP: executionRequestEventHandler: {}", event.getExecutionListener() );
     }
 
     private void executionResultEventHandler( MavenExecutionResult event )
+    {
+        String OUTPUT_PROPERTY = "maven-buildtime-profiler.directory";
+        String output = System.getProperty(OUTPUT_PROPERTY, event.getProject().getProperties().containsKey(OUTPUT_PROPERTY)
+            ? event.getProject().getProperties().getProperty(OUTPUT_PROPERTY) : "stdout");
+        String filename = null;
+        String body = null;
+
+            switch (output.toLowerCase())
+            {
+                case "json":
+                    body = toJSON().toString();
+                    filename = "report.json";
+                    break;
+                case "none":
+                    break;
+                case "stdout":
+                default:
+                    report(event);
+            }
+
+            if (filename != null && body != null)
+            {
+                String DIRECTORY_PROPERTY = "maven-buildtime-profiler.directory";
+                String directory = System.getProperty(DIRECTORY_PROPERTY, event.getProject().getProperties().containsKey(DIRECTORY_PROPERTY)
+                    ? event.getProject().getProperties().getProperty(DIRECTORY_PROPERTY) : "target/");
+                File dest = new File(directory, filename);
+
+                try (FileWriter file = new FileWriter(dest))
+                {
+                    file.write(body);
+                }
+                catch (IOException e)
+                {
+                    LOGGER.warn("Couldn't write to file at {}: {}", dest, e.getMessage());
+                }
+            }
+    }
+
+    private void report(MavenExecutionResult event)
     {
         orderLifeCycleOnPreparedOrder( lifeCyclePhases );
 
@@ -445,7 +491,7 @@ private void executionResultEventHandler( MavenExecutionResult event )
                 for ( Entry<ProjectMojo, SystemTime> pluginInPhase : plugisInPhase.entrySet() )
                 {
                     LOGGER.info( "{} ms: {}", String.format( "%8d", pluginInPhase.getValue().getElapsedTime() ),
-                                 pluginInPhase.getKey().getMojo().getFullId() );
+                        pluginInPhase.getKey().getMojo().getFullId() );
                 }
 
             }
@@ -471,6 +517,28 @@ private void executionResultEventHandler( MavenExecutionResult event )
         forkProject.report();
     }
 
+    private JSONObject toJSON()
+    {
+        JSONObject jsonObject = new JSONObject();
+
+        jsonObject.put("discovery-time", discoveryTimer.getTime());
+        jsonObject.put("build", mojoTimer.toJSON());
+        jsonObject.put("goals", goalTimer.toJSON());
+        jsonObject.put("install", installTimer.toJSON());
+        jsonObject.put("download", downloadTimer.toJSON());
+        jsonObject.put("deploy", deployTimer.toJSON());
+        JSONObject metadata = new JSONObject();
+        metadata.put("install", metadataInstallTimer.toJSON());
+        metadata.put("download", metadataDownloadTimer.toJSON());
+        metadata.put("deployment", metadataDeploymentTimer.toJSON());
+        jsonObject.put("metadata", metadata);
+        jsonObject.put("fork-time", forkTimer.getTime());
+        jsonObject.put("fork-project", forkProject.toJSON());
+        jsonObject.put("maven-execution", execution.toJSON());
+
+        return jsonObject;
+    }
+
     private ProjectKey mavenProjectToProjectKey( MavenProject project )
     {
         return new ProjectKey( project.getGroupId(), project.getArtifactId(), project.getVersion() );

src/main/java/com/soebes/maven/extensions/DiscoveryTimer.java

@@ -52,4 +52,8 @@ public void report()
         LOGGER.info( "------------------------------------------------------------------------" );
     }
 
+    public long getTime()
+    {
+        return this.time.getElapsedTime();
+    }
 }

src/main/java/com/soebes/maven/extensions/Execution.java

@@ -0,0 +1,81 @@
+package com.soebes.maven.extensions;
+
+import org.apache.maven.execution.MavenExecutionRequest;
+import org.json.JSONArray;
+import org.json.JSONObject;
+
+public class Execution
+{
+
+  private MavenExecutionRequest execution;
+
+  private String command;
+
+  public Execution()
+  {
+
+  }
+
+  public Execution(MavenExecutionRequest executionRequest)
+  {
+    setExecutionRequest(executionRequest);
+  }
+
+  public void setExecutionRequest(MavenExecutionRequest executionRequest)
+  {
+    this.execution = executionRequest;
+    // initCommand();
+  }
+
+  private void initCommand() {
+    StringBuilder cmd = new StringBuilder("mvn");
+
+    if (this.execution.isUpdateSnapshots())
+    {
+      cmd.append(" ").append("-U");
+    }
+
+    if (!this.execution.isRecursive())
+    {
+      cmd.append(" ").append("-N");
+    }
+
+    this.execution.getActiveProfiles()
+        .forEach(profile -> cmd.append(" -P").append(profile));
+
+    this.execution.getUserProperties()
+        .keySet()
+        .forEach(prop -> cmd.append(" -D").append(prop.toString()));
+
+    this.execution.getGoals().forEach(goal -> cmd.append(" ").append(goal));
+
+    this.command = cmd.toString();
+  }
+
+  public JSONObject toJSON()
+  {
+    JSONObject execution = new JSONObject();
+
+    JSONArray goals = new JSONArray();
+    goals.put(this.execution.getGoals());
+
+    JSONObject userProperties = new JSONObject();
+    this.execution.getUserProperties()
+        .keySet()
+        .forEach(key -> userProperties.put((String) key, this.execution.getUserProperties().get(key)));
+
+    JSONArray selectedProjects = new JSONArray();
+    selectedProjects.put(this.execution.getSelectedProjects());
+
+    JSONArray profiles = new JSONArray();
+    this.execution.getActiveProfiles().forEach(profiles::put);
+
+    execution.put("goals", goals);
+    execution.put("user-properties", userProperties);
+    execution.put("selected-projects", selectedProjects);
+    execution.put("active-profiles", profiles);
+    // execution.put("command", this.command);
+
+    return execution;
+  }
+}

src/main/java/com/soebes/maven/extensions/ForkTimer.java

@@ -53,4 +53,7 @@ public void report()
         LOGGER.info( "ForkTime: {}", this.time.getElapsedTime() );
     }
 
+    public long getTime() {
+        return this.time.getElapsedTime();
+    }
 }

src/main/java/com/soebes/maven/extensions/GoalTimer.java

@@ -7,6 +7,7 @@
 import org.apache.maven.execution.ExecutionEvent;
 import org.apache.maven.plugin.MojoExecution;
 import org.apache.maven.project.MavenProject;
+import org.json.JSONObject;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -66,4 +67,16 @@ public void report()
                          item.getKey().getId() );
         }
     }
+
+    public JSONObject toJSON()
+    {
+        JSONObject jsonObject = new JSONObject();
+
+        for ( Entry<ProjectGoal, SystemTime> item : this.timerEvents.entrySet() )
+        {
+            jsonObject.put(item.getKey().getId(), item.getValue().getElapsedTime());
+        }
+
+        return jsonObject;
+    }
 }

src/main/java/com/soebes/maven/extensions/MojoTimer.java

@@ -27,6 +27,7 @@
 import org.apache.maven.execution.ExecutionEvent;
 import org.apache.maven.plugin.MojoExecution;
 import org.apache.maven.project.MavenProject;
+import org.json.JSONObject;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -142,4 +143,54 @@ public void report()
             LOGGER.info( "{} : {}", item.getKey().getId(), item.getValue().getElapsedTime() );
         }
     }
+
+    public JSONObject toJSON()
+    {
+        JSONObject jsonObject = new JSONObject();
+        JSONObject projectObject = new JSONObject();
+        JSONObject phaseObject = new JSONObject();
+        JSONObject pluginsObject = new JSONObject();
+
+        long totalTime = 0;
+
+        for ( Entry<ProjectMojo, SystemTime> item : this.timerEvents.entrySet() )
+        {
+            String artifactId = item.getKey().getProject().getArtifactId();
+            String phase = item.getKey().getMojo().getPhase();
+            String plugin = item.getKey().getMojo().getFullId();
+            long time = item.getValue().getElapsedTime();
+
+            // Projects section
+
+            JSONObject artifactObject = projectObject.has(artifactId) ? projectObject.getJSONObject(artifactId) : new JSONObject();
+
+            artifactObject.put(phase, artifactObject.has(phase) ? (long) artifactObject.get(phase) + time : time);
+            projectObject.put(artifactId, artifactObject);
+
+            // Phases section
+
+            phaseObject.put(phase, phaseObject.has(phase) ? (long) phaseObject.get(phase) + time : time);
+
+            // Plugins section
+
+            if (!pluginsObject.has(phase))
+                pluginsObject.put(phase, new JSONObject());
+
+            long pluginResult = ((JSONObject) pluginsObject.get(phase)).has(plugin) ?
+                (long) ((JSONObject) pluginsObject.get(phase)).get(plugin) : 0;
+
+            pluginResult += time;
+
+            ((JSONObject) pluginsObject.get(phase)).put(plugin, pluginResult);
+
+            totalTime += time;
+        }
+
+        jsonObject.put("projects", projectObject);
+        jsonObject.put("phases", phaseObject);
+        jsonObject.put("plugins", pluginsObject);
+        jsonObject.put("time", totalTime);
+
+        return jsonObject;
+    }
 }

src/main/java/com/soebes/maven/extensions/ProjectTimer.java

@@ -25,6 +25,7 @@
 
 import org.apache.maven.execution.ExecutionEvent;
 import org.apache.maven.project.MavenProject;
+import org.json.JSONObject;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -80,4 +81,16 @@ public void report()
             LOGGER.info( "ProjectTimer: {} : {}", item.getKey(), item.getValue().getElapsedTime() );
         }
     }
+
+    public JSONObject toJSON()
+    {
+        JSONObject jsonObject = new JSONObject();
+
+        for ( Entry<String, SystemTime> item : this.timerEvents.entrySet() )
+        {
+            jsonObject.put(item.getKey(), item.getValue().getElapsedTime());
+        }
+
+        return jsonObject;
+    }
 }