Add "--report file.html" flag to generate build report.

The report is rendered in Markdown and useful when using Leeway
in environments that doen't support log cutting. For example:
* Gitpod Workspaces
* CI systems other than Werft

Author: meysholdt

cmd/build.go

@@ -154,6 +154,7 @@ func init() {
 	buildCmd.Flags().String("serve", "", "After a successful build this starts a webserver on the given address serving the build result (e.g. --serve localhost:8080)")
 	buildCmd.Flags().String("save", "", "After a successful build this saves the build result as tar.gz file in the local filesystem (e.g. --save build-result.tar.gz)")
 	buildCmd.Flags().Bool("watch", false, "Watch source files and re-build on change")
+
 }
 
 func addBuildFlags(cmd *cobra.Command) {
@@ -172,7 +173,7 @@ func addBuildFlags(cmd *cobra.Command) {
 	cmd.Flags().UintP("max-concurrent-tasks", "j", uint(runtime.NumCPU()), "Limit the number of max concurrent build tasks - set to 0 to disable the limit")
 	cmd.Flags().String("coverage-output-path", "", "Output path where test coverage file will be copied after running tests")
 	cmd.Flags().StringToString("docker-build-options", nil, "Options passed to all 'docker build' commands")
-
+	cmd.Flags().String("report", "", "Generate a HTML report after the build has finished. (e.g. --report myreport.html)")
 }
 
 func getBuildOpts(cmd *cobra.Command) ([]leeway.BuildOption, *leeway.FilesystemCache) {
@@ -257,6 +258,14 @@ func getBuildOpts(cmd *cobra.Command) ([]leeway.BuildOption, *leeway.FilesystemC
 		reporter = leeway.NewConsoleReporter()
 	}
 
+	report, err := cmd.Flags().GetString("report")
+	if err != nil {
+		log.Fatal(err)
+	}
+	if report != "" {
+		reporter = leeway.NewHTMLReporter(reporter, report)
+	}
+
 	dontTest, err := cmd.Flags().GetBool("dont-test")
 	if err != nil {
 		log.Fatal(err)

pkg/leeway/reporter.go

@@ -8,8 +8,11 @@ import (
 	"strings"
 	"sync"
 	"text/tabwriter"
+	"text/template"
 	"time"
 
+	log "github.com/sirupsen/logrus"
+
 	"github.com/gookit/color"
 	"github.com/segmentio/textio"
 )
@@ -24,7 +27,7 @@ type Reporter interface {
 	// have been built.
 	BuildStarted(pkg *Package, status map[*Package]PackageBuildStatus)
 
-	// BuildFinished is called when the build of a package whcih was started by the user has finished.
+	// BuildFinished is called when the build of a package which was started by the user has finished.
 	// This is not the same as a dependency build finished (see PackageBuildFinished for that).
 	// The root package will also be passed into PackageBuildFinished once it's been built.
 	BuildFinished(pkg *Package, err error)
@@ -225,3 +228,148 @@ func (r *WerftReporter) PackageBuildFinished(pkg *Package, err error) {
 	}
 	fmt.Printf("[%s|%s] %s\n", pkg.FullName(), status, msg)
 }
+
+type PackageReport struct {
+	logs     strings.Builder
+	start    time.Time
+	duration time.Duration
+	status   PackageBuildStatus
+	err      error
+}
+
+func (r *PackageReport) StatusIcon() string {
+	if r.HasError() {
+		return "❌"
+	}
+	switch r.status {
+	case PackageBuilt:
+		return "✅"
+	case PackageBuilding:
+		return "🏃"
+	case PackageNotBuiltYet:
+		return "🔧"
+	default:
+		return "?"
+	}
+}
+
+func (r *PackageReport) HasError() bool {
+	return r.err != nil
+}
+
+func (r *PackageReport) DurationInSeconds() string {
+	return fmt.Sprintf("%.2fs", r.duration.Seconds())
+}
+
+func (r *PackageReport) Logs() string {
+	return strings.TrimSpace(r.logs.String())
+}
+
+func (r *PackageReport) Error() string {
+	return fmt.Sprintf("%s", r.err)
+}
+
+type HTMLReporter struct {
+	delegate    Reporter
+	filename    string
+	reports     map[string]*PackageReport
+	rootPackage *Package
+	mu          sync.RWMutex
+}
+
+func NewHTMLReporter(del Reporter, filename string) *HTMLReporter {
+	return &HTMLReporter{
+		delegate: del,
+		filename: filename,
+		reports:  make(map[string]*PackageReport),
+	}
+}
+
+func (r *HTMLReporter) getReport(pkg *Package) *PackageReport {
+	name := pkg.FullName()
+
+	r.mu.RLock()
+	rep, ok := r.reports[name]
+	r.mu.RUnlock()
+
+	if !ok {
+		r.mu.Lock()
+		rep, ok = r.reports[name]
+		if ok {
+			r.mu.Unlock()
+			return rep
+		}
+
+		rep = &PackageReport{status: PackageNotBuiltYet}
+		r.reports[name] = rep
+		r.mu.Unlock()
+	}
+
+	return rep
+}
+
+func (r *HTMLReporter) BuildStarted(pkg *Package, status map[*Package]PackageBuildStatus) {
+	r.rootPackage = pkg
+	r.delegate.BuildStarted(pkg, status)
+}
+
+func (r *HTMLReporter) BuildFinished(pkg *Package, err error) {
+	r.delegate.BuildFinished(pkg, err)
+	r.Report()
+}
+
+func (r *HTMLReporter) PackageBuildStarted(pkg *Package) {
+	r.delegate.PackageBuildStarted(pkg)
+	rep := r.getReport(pkg)
+	rep.start = time.Now()
+	rep.status = PackageBuilding
+}
+
+func (r *HTMLReporter) PackageBuildLog(pkg *Package, isErr bool, buf []byte) {
+	report := r.getReport(pkg)
+	report.logs.Write(buf)
+	r.delegate.PackageBuildLog(pkg, isErr, buf)
+}
+
+func (r *HTMLReporter) PackageBuildFinished(pkg *Package, err error) {
+	r.delegate.PackageBuildFinished(pkg, err)
+	rep := r.getReport(pkg)
+	rep.duration = time.Since(rep.start)
+	rep.status = PackageBuilt
+	rep.err = err
+}
+
+func (r *HTMLReporter) Report() {
+	vars := make(map[string]interface{})
+	vars["Name"] = r.filename
+	vars["Packages"] = r.reports
+	vars["RootPackage"] = r.rootPackage
+
+	tmplString := `
+<h1> Leeway build for <code>{{ .RootPackage.FullName }}</code></h1>
+{{ range $pkg, $report := .Packages }}
+<details{{ if $report.HasError }} open{{ end }}><summary> {{ $report.StatusIcon }} <b>{{ $pkg }}</b> - {{ $report.DurationInSeconds }}</summary>
+
+{{ if $report.HasError }}
+<pre>
+{{ $report.Error }}
+</pre>
+{{ end }}
+
+<pre>
+{{ $report.Logs }}
+</pre>
+
+</details>
+{{ end }}
+`
+	tmpl, _ := template.New("Report").Parse(strings.ReplaceAll(tmplString, "'", "`"))
+
+	file, _ := os.Create(r.filename)
+	defer file.Close()
+
+	err := tmpl.Execute(file, vars)
+	if err != nil {
+		log.WithError(err).Fatal("Can't render template")
+	}
+}