Adding delayed reporter which can send the whole build as one request

angles-java-core/src/main/java/com/github/angleshq/angles/AnglesDelayedReporter.java

@@ -0,0 +1,80 @@
+package com.github.angleshq.angles;
+
+import com.github.angleshq.angles.api.exceptions.AnglesServerException;
+import com.github.angleshq.angles.api.models.build.Artifact;
+import com.github.angleshq.angles.api.models.build.Build;
+import com.github.angleshq.angles.api.models.build.CreateBuild;
+import com.github.angleshq.angles.api.models.screenshot.Screenshot;
+import com.github.angleshq.angles.api.models.screenshot.ScreenshotDetails;
+import org.apache.commons.lang3.SerializationUtils;
+
+import java.io.IOException;
+import java.util.Arrays;
+import java.util.List;
+
+public class AnglesDelayedReporter extends AnglesReporter implements AnglesReporterInterface {
+
+    protected InheritableThreadLocal<CreateBuild> currentCreateBuildRequest = new InheritableThreadLocal<>();
+
+    public AnglesDelayedReporter(String baseUrl) {
+        super(baseUrl);
+    }
+
+    public void startBuild(String name, String environmentName, String teamName, String componentName, String phase) {
+        if (currentCreateBuildRequest.get() != null) {
+            return;
+        }
+        CreateBuild createBuild = createBuild(name, environmentName, teamName, componentName, phase);
+        currentCreateBuildRequest.set(createBuild);
+    }
+
+    /**
+     * This method will save the store build
+     */
+    @Override
+    public void saveBuild() {
+        try {
+            Build build = buildRequests.create(this.currentCreateBuildRequest.get());
+            System.out.println(build.getId() + ": " + build.toString());
+        }  catch (IOException | AnglesServerException exception) {
+            throw new Error("Unable to save build due to [" + exception.getMessage() + "]");
+        }
+    }
+
+    @Override
+    public void storeArtifacts(Artifact[] artifacts) {
+        this.currentCreateBuildRequest.get().setArtifacts(Arrays.asList(artifacts));
+    }
+
+    @Override
+    public void startSuite(String suiteName) {
+        super.startSuite(suiteName);
+        this.currentCreateBuildRequest.get().addSuite(this.currentSuite.get());
+    }
+
+    @Override
+    public void startTest(String suiteName, String testName, String feature, List<String> tags) {
+        super.startTest(suiteName, testName, feature, tags);
+    }
+
+    /**
+     * Delayed reporter does not support screenshots.
+     * @param details
+     * @return
+     */
+    public Screenshot storeScreenshot(ScreenshotDetails details) {
+        Screenshot screenshot = new Screenshot();
+        screenshot.setId(null);
+        return screenshot;
+    }
+
+    @Override
+    public void saveTest() {
+        // do nothing.
+        if (currentExecution.get() != null) {
+            this.currentSuite.get().getExecutions().add(SerializationUtils.clone(this.currentExecution.get()));
+            currentExecution.set(null);
+        }
+    }
+
+}

angles-java-core/src/main/java/com/github/angleshq/angles/AnglesReporter.java

@@ -5,6 +5,7 @@
 import com.github.angleshq.angles.api.models.build.Artifact;
 import com.github.angleshq.angles.api.models.build.Build;
 import com.github.angleshq.angles.api.models.build.CreateBuild;
+import com.github.angleshq.angles.api.models.build.Suite;
 import com.github.angleshq.angles.api.models.execution.Action;
 import com.github.angleshq.angles.api.models.execution.CreateExecution;
 import com.github.angleshq.angles.api.models.execution.Step;
@@ -15,30 +16,28 @@
 import com.github.angleshq.angles.api.requests.*;
 
 import java.io.IOException;
-import java.util.Date;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
+import java.util.*;
 
 import static org.apache.commons.lang3.StringUtils.isBlank;
 
 public class AnglesReporter implements AnglesReporterInterface {
 
     public static final String DEFAULT_ACTION_NAME = "Test Details";
     public static final String EMPTY_REPORTER_NAME = "empty";
+
     private static Map<String, AnglesReporterInterface> reporterMap = new HashMap<>();
     private static boolean enabled = true;
-    private String baseUrl;
-    private BuildRequests buildRequests;
+    private static boolean delayedReporting = true;
+
+    protected String baseUrl;
+    protected BuildRequests buildRequests;
     private ExecutionRequests executionRequests;
-    private EnvironmentRequests environmentRequests;
-    private TeamRequests teamRequests;
     private ScreenshotRequests screenshotRequests;
 
-    private InheritableThreadLocal<Build> currentBuild = new InheritableThreadLocal<>();
-    private InheritableThreadLocal<CreateExecution> currentExecution = new InheritableThreadLocal<>();
-    private InheritableThreadLocal<Action> currentAction = new InheritableThreadLocal<>();
-    private ThreadLocal<Action> setUpAction = new InheritableThreadLocal<>();
+    protected InheritableThreadLocal<Build> currentBuild = new InheritableThreadLocal<>();
+    protected InheritableThreadLocal<CreateExecution> currentExecution = new InheritableThreadLocal<>();
+    protected InheritableThreadLocal<Action> currentAction = new InheritableThreadLocal<>();
+    protected InheritableThreadLocal<Suite> currentSuite = new InheritableThreadLocal<>();
 
     public static AnglesReporterInterface getInstance(String url) {
         // if angles is disabled, return the empty reporter
@@ -51,29 +50,23 @@ public static AnglesReporterInterface getInstance(String url) {
 
         // if not disabled then return the reporter.
         if (!AnglesReporter.reporterMap.containsKey(url)) {
-            AnglesReporter.reporterMap.put(url, new AnglesReporter(url));
+            if (delayedReporting) {
+                AnglesReporter.reporterMap.put(url, new AnglesDelayedReporter(url));
+            } else {
+                AnglesReporter.reporterMap.put(url, new AnglesReporter(url));
+            }
         }
         return AnglesReporter.reporterMap.get(url);
     }
 
-    private AnglesReporter(String url) {
+    protected AnglesReporter(String url) {
         this.baseUrl = url;
         buildRequests = new BuildRequests(baseUrl);
         executionRequests = new ExecutionRequests(baseUrl);
-        environmentRequests = new EnvironmentRequests(baseUrl);
-        teamRequests = new TeamRequests(baseUrl);
         screenshotRequests = new ScreenshotRequests(baseUrl);
     }
 
-
-    public synchronized void startBuild(String name, String environmentName, String teamName, String componentName) {
-        startBuild(name, environmentName, teamName, componentName, null);
-    }
-
-    public synchronized void startBuild(String name, String environmentName, String teamName, String componentName, String phase) {
-        if (currentBuild.get() != null) {
-            return;
-        }
+    protected CreateBuild createBuild(String name, String environmentName, String teamName, String componentName, String phase) {
         CreateBuild createBuild = new CreateBuild();
         createBuild.setName(name);
         createBuild.setEnvironment(environmentName);
@@ -82,7 +75,43 @@ public synchronized void startBuild(String name, String environmentName, String
         createBuild.setStart(new Date());
         if (!isBlank(phase))
             createBuild.setPhase(phase);
+        return createBuild;
+    }
 
+    protected CreateExecution createExecution(String suiteName, String testName, String feature, List<String> tags) {
+        CreateExecution createExecution = new CreateExecution();
+        createExecution.setStart(new Date());
+        if (currentBuild.get() != null)
+            createExecution.setBuild(currentBuild.get().getId());
+        createExecution.setTitle(testName);
+        createExecution.setSuite(suiteName);
+        createExecution.setFeature(feature);
+        createExecution.setTags(tags);
+        return createExecution;
+    }
+
+    protected Suite createSuite(String suiteName) {
+        Suite suite = new Suite();
+        suite.setName(suiteName);
+        CreateExecution setupExecution = createExecution("Suite Setup", suiteName, null, null);
+        this.currentExecution.set(setupExecution);
+        suite.setSetup(setupExecution);
+        return suite;
+    }
+
+    public synchronized void startBuild(String name, String environmentName, String teamName, String componentName) {
+        startBuild(name, environmentName, teamName, componentName, null);
+    }
+
+    public void saveBuild() {
+        // do nothing;
+    }
+
+    public synchronized void startBuild(String name, String environmentName, String teamName, String componentName, String phase) {
+        if (currentBuild.get() != null) {
+            return;
+        }
+        CreateBuild createBuild = createBuild(name, environmentName, teamName, componentName, phase);
         try {
             currentBuild.set(buildRequests.create(createBuild));
         } catch (IOException | AnglesServerException exception) {
@@ -91,13 +120,19 @@ public synchronized void startBuild(String name, String environmentName, String
     }
 
     public synchronized void storeArtifacts(Artifact[] artifacts) {
-        try {
-            currentBuild.set(buildRequests.artifacts(currentBuild.get().getId(), artifacts));
-        } catch (IOException | AnglesServerException exception) {
-            throw new Error("Unable to store build artifacts due to [" + exception.getMessage() + "]");
+        if (currentBuild.get().getArtifacts().size() == 0) {
+            try {
+                currentBuild.set(buildRequests.artifacts(currentBuild.get().getId(), artifacts));
+            } catch (IOException | AnglesServerException exception) {
+                throw new Error("Unable to store build artifacts due to [" + exception.getMessage() + "]");
+            }
         }
     }
 
+    public void startSuite(String suiteName) {
+        this.currentSuite.set(createSuite(suiteName));
+    }
+
     public void startTest(String suiteName, String testName) {
         startTest(suiteName, testName, null, null);
     }
@@ -110,20 +145,11 @@ public void startTest(String suiteName, String testName, String feature) {
         startTest(suiteName, testName, feature, null);
     }
 
-    public void startTest(String suiteName, String testName, String feature, List<String> tags) {
-        CreateExecution createExecution = new CreateExecution();
-        createExecution.setStart(new Date());
-        createExecution.setBuild(currentBuild.get().getId());
-        createExecution.setTitle(testName);
-        createExecution.setSuite(suiteName);
-        createExecution.setFeature(feature);
-        createExecution.setTags(tags);
-        currentExecution.set(createExecution);
-        if (setUpAction.get() != null) {
-            // TODO: handle suite setup
-            // currentExecution.get().addAction(setUpAction.get());
-            setUpAction.set(null);
+    public synchronized void startTest(String suiteName, String testName, String feature, List<String> tags) {
+        if (this.currentSuite.get() == null) {
+            startSuite(suiteName);
         }
+        currentExecution.set(createExecution(suiteName, testName, feature, tags));
         currentAction.set(null);
     }
 
@@ -146,7 +172,13 @@ public void storePlatformDetails(Platform... platform) {
 
     public void startAction(String description) {
         this.currentAction.set(new Action(description));
-        this.currentExecution.get().getActions().add(this.currentAction.get());
+        if (currentExecution.get() == null) {
+            if (this.currentSuite.get() != null) {
+                this.currentSuite.get().getSetup().addAction(this.currentAction.get());
+            }
+        } else {
+            this.currentExecution.get().getActions().add(this.currentAction.get());
+        }
     }
 
     public void debug(String debug) {
@@ -193,7 +225,7 @@ private void addStep(String name, String expected, String actual, String info, S
         addStep(name, expected, actual, info, status, null);
     }
 
-    private void addStep(String name, String expected, String actual, String info, StepStatus status, String screenshotId) {
+    protected void addStep(String name, String expected, String actual, String info, StepStatus status, String screenshotId) {
         Step step = new Step();
         step.setTimestamp(new Date());
         step.setStatus(status);
@@ -204,20 +236,12 @@ private void addStep(String name, String expected, String actual, String info, S
         if (screenshotId !=null) {
             step.setScreenshot(screenshotId);
         }
-        // scenarios, 1. pre logs, 2. no action
-        if (currentExecution.get() == null) {
-            // test hasn't started yet (or maybe it has finished).
-            if (setUpAction.get() == null) {
-                this.setUpAction.set(new Action("Test-Setup"));
-            }
-            setUpAction.get().addStep(step);
-        } else {
-            // test has started
-            if (currentAction.get() == null) {
-                startAction(DEFAULT_ACTION_NAME);
-            }
-            currentAction.get().addStep(step);
+
+        // test has started
+        if (currentAction.get() == null) {
+            startAction(DEFAULT_ACTION_NAME);
         }
+        currentAction.get().addStep(step);
     }
 
     public Screenshot storeScreenshot(ScreenshotDetails details) {
@@ -272,4 +296,19 @@ public static boolean isEnabled() {
         return AnglesReporter.enabled;
     }
 
+    /**
+     * By setting this variable the Angles client will only send a single request to store the build (when saveBuild
+     * is called). This is useful for e.g. Unit tests who don't want to be delayed by the additional before/after tests
+     * calls to Angles.
+     *
+     * @param delayedReporting
+     */
+    public static void setDelayedReporting(boolean delayedReporting) {
+        AnglesReporter.delayedReporting = delayedReporting;
+    }
+
+    public static boolean isDelayedReporting() {
+        return delayedReporting;
+    }
+
 }

angles-java-core/src/main/java/com/github/angleshq/angles/AnglesReporterEmpty.java

@@ -22,10 +22,20 @@ public void startBuild(String name, String environmentName, String teamName, Str
         // do nothing
     }
 
+    @Override
+    public void saveBuild() {
+        // do nothing
+    }
+
     public void storeArtifacts(Artifact[] artifacts) {
         // do nothing
     }
 
+    @Override
+    public void startSuite(String suiteName) {
+        // do nothing
+    }
+
     public void startTest(String suiteName, String testName) {
         // do nothing
     }

angles-java-core/src/main/java/com/github/angleshq/angles/AnglesReporterInterface.java

@@ -14,8 +14,12 @@ public interface AnglesReporterInterface {
 
     void startBuild(String name, String environmentName, String teamName, String componentName, String phaseName);
 
+    void saveBuild();
+
     void storeArtifacts(Artifact[] artifacts);
 
+    void startSuite(String suiteName);
+
     void startTest(String suiteName, String testName);
 
     void updateTestName(String testName);

angles-java-core/src/main/java/com/github/angleshq/angles/api/models/Platform.java

@@ -4,8 +4,10 @@
 import lombok.NoArgsConstructor;
 import lombok.Setter;
 
+import java.io.Serializable;
+
 @Setter @Getter @NoArgsConstructor
-public class Platform {
+public class Platform implements Serializable {
 
     private String platformName;
     private String platformVersion;