add ability to view build reports (#35)

* add ability to view build reports

* no need to export apiResp

* move newline, less verbose string cast

Author: Max Siegieda

build.go

@@ -1,7 +1,11 @@
 package reco
 
 import (
+	"bytes"
+	"encoding/json"
+	"errors"
 	"io"
+	"strings"
 	"time"
 
 	"github.com/ReconfigureIO/reco/logger"
@@ -11,6 +15,12 @@ import (
 
 var _ Job = &buildJob{}
 
+// BuildReporter can return build reports.
+type BuildReporter interface {
+	// Report returns a formatted JSON build report.
+	Report(id string) (string, error)
+}
+
 type buildJob struct {
 	*clientImpl
 }
@@ -119,3 +129,45 @@ func (b buildJob) List(filter M) (printer.Table, error) {
 func (b buildJob) Log(id string, writer io.Writer) error {
 	return b.clientImpl.logJob("build", id)
 }
+
+type buildReport struct {
+	Report string `json:"report"`
+}
+
+func (b buildJob) Report(id string) (string, error) {
+	var req = b.apiRequest(endpoints.builds.Report())
+	req.param("id", id)
+	resp, err := req.Do("GET", nil)
+	if err != nil {
+		return "", err
+	}
+	switch resp.StatusCode {
+	case 404:
+		return "", errors.New("Report not found")
+	case 204:
+		return "", errors.New("No report generated. Reports are only generated for COMPLETED builds")
+	case 200:
+		break
+	default:
+		return "", errors.New("Unknown error occured")
+	}
+
+	var apiResp struct {
+		Value struct {
+			Report string `json:"report"`
+		} `json:"value"`
+	}
+	err = json.NewDecoder(resp.Body).Decode(&apiResp)
+	if err != nil {
+		return "", err
+	}
+
+	validJSONReport := strings.Replace(apiResp.Value.Report, "\\", "", -1)
+	var prettyJSONReport bytes.Buffer
+	err = json.Indent(&prettyJSONReport, []byte(validJSONReport), "", "\t")
+	if err != nil {
+		return "", err
+	}
+
+	return prettyJSONReport.String(), nil
+}

cmd/build.go

@@ -45,6 +45,14 @@ var (
 		},
 	}
 
+	buildCmdReport = &cobra.Command{
+		Use:     fmt.Sprintf("report [build_ID]"),
+		Aliases: []string{"reports"},
+		Short:   fmt.Sprintf("View reports for a completed build"),
+		Long:    fmt.Sprintf("View reports for a completed build, containing area and resource utilisation figures."),
+		Run:     openReport,
+	}
+
 	buildLogPreRun = func(cmd *cobra.Command, args []string) {
 		if len(args) == 0 {
 			exitWithError("ID required")
@@ -82,6 +90,7 @@ func init() {
 	buildCmd.AddCommand(buildCmdLog)
 	buildCmd.AddCommand(buildCmdStop)
 	buildCmd.AddCommand(buildCmdStart)
+	buildCmd.AddCommand(buildCmdReport)
 	buildCmd.PersistentFlags().StringVar(&project, "project", project, "Project to use. If unset, the active project is used")
 
 	RootCmd.AddCommand(buildCmd)
@@ -145,3 +154,16 @@ func hasMain(dir string) bool {
 	}
 	return foundMain
 }
+
+func openReport(_ *cobra.Command, args []string) {
+	if len(args) != 1 {
+		exitWithError("ID required")
+	}
+
+	report, err := tool.Build().(reco.BuildReporter).Report(args[0])
+	if err != nil {
+		exitWithError(err)
+	}
+
+	logger.Std.Printf("Build Report: %s", report)
+}

request.go

@@ -47,6 +47,11 @@ func (p Endpoint) Graph() string {
 	return p.Append("{id}", "graph")
 }
 
+// Report returns report endpoint.
+func (p Endpoint) Report() string {
+	return p.Append("{id}", "reports")
+}
+
 var (
 	endpoints = struct {
 		builds, deployments, projects, simulations, graphs, users Endpoint