-
{{$pkg}} {{len $summary.RunIDs}} Runs {{if $summary.ErrorRunIDs}}({{len $summary.ErrorRunIDs}} erred){{end}}
+
{{$pkg}} {{len $summary.RunIDs}} Runs {{if $summary.RunningRunIDs}}({{len $summary.RunningRunIDs}} running){{end}} {{if $summary.ErrorRunIDs}}({{len $summary.ErrorRunIDs}} erred){{end}}
+
+ {{if or $summary.RunningRunIDs $summary.ErrorRunIDs}}
+
Runs
+
+ {{if $summary.RunningRunIDs}}
+
+ {{end}}
+ {{if $summary.ErrorRunIDs}}
+
+ {{end}}
+
+ {{end}}
Tests
diff --git a/http/templates/shared/package_run_summary_bar.html b/http/templates/shared/package_run_summary_bar.html
index 324a207..f2dc993 100644
--- a/http/templates/shared/package_run_summary_bar.html
+++ b/http/templates/shared/package_run_summary_bar.html
@@ -1,5 +1,16 @@
{{ define "package_run_summary_bar" }}
+{{ $state := summaryState . }}
+{{ if eq $state "results" }}
+{{ else if eq $state "errored" }}
+
+{{ else if eq $state "running" }}
+
+{{ else if eq $state "active" }}
+
+{{ else }}
+
+{{ end }}
{{ end }}
diff --git a/http/templates/shared/package_run_summary_tooltip.html b/http/templates/shared/package_run_summary_tooltip.html
index a7ab192..a441ebc 100644
--- a/http/templates/shared/package_run_summary_tooltip.html
+++ b/http/templates/shared/package_run_summary_tooltip.html
@@ -4,7 +4,7 @@
Runs
-
Total: {{ len .RunIDs }} {{ if len .ErrorRunIDs }}({{ len .ErrorRunIDs }} erred){{ end }}
+
Total: {{ len .RunIDs }} {{ if len .RunningRunIDs }}({{ len .RunningRunIDs }} running){{ end }} {{ if len .ErrorRunIDs }}({{ len .ErrorRunIDs }} erred){{ end }}
diff --git a/http/templates/shared/run_summary_month.html b/http/templates/shared/run_summary_month.html
index d2da1a7..8bb382c 100644
--- a/http/templates/shared/run_summary_month.html
+++ b/http/templates/shared/run_summary_month.html
@@ -4,7 +4,7 @@
Runs
-
Total: {{ .NumRuns }} {{ if .NumErrorRuns }}({{ .NumErrorRuns }} erred){{ end }}
+
Total: {{ .NumRuns }} {{ if .NumRunningRuns }}({{ .NumRunningRuns }} running){{ end }} {{ if .NumErrorRuns }}({{ .NumErrorRuns }} erred){{ end }}
@@ -25,9 +25,20 @@
{{ end }}
{{ define "run_summary_month_bar" }}
+{{ $state := summaryState . }}
+{{ if eq $state "results" }}
+{{ else if eq $state "errored" }}
+
+{{ else if eq $state "running" }}
+
+{{ else if eq $state "active" }}
+
+{{ else }}
+
+{{ end }}
{{ end }}
{{ define "run_summary_month" }}
diff --git a/http/ui_test.go b/http/ui_test.go
new file mode 100644
index 0000000..19ff953
--- /dev/null
+++ b/http/ui_test.go
@@ -0,0 +1,136 @@
+package http
+
+import (
+ "fmt"
+ "io"
+ "net/http"
+ "net/http/httptest"
+ "strings"
+ "testing"
+ "time"
+
+ "github.com/digitalocean/tester"
+ "github.com/digitalocean/tester/db"
+ "github.com/google/uuid"
+ "github.com/stretchr/testify/assert"
+ "github.com/stretchr/testify/require"
+ "go.uber.org/mock/gomock"
+)
+
+// uiTestSummaries builds one bucket per summaryState for package "pkg".
+func uiTestSummaries(begin time.Time, window time.Duration) []*tester.RunSummary {
+ newPkg := func() *tester.PackageSummary {
+ return &tester.PackageSummary{
+ Package: "pkg",
+ PassedTests: map[string][]uuid.UUID{},
+ FailedTests: map[string][]uuid.UUID{},
+ SkippedTests: map[string][]uuid.UUID{},
+ }
+ }
+
+ results := newPkg()
+ results.RunIDs = []uuid.UUID{uuid.New()}
+ results.PassedTests["TestA"] = []uuid.UUID{uuid.New()}
+ results.FailedTests["TestB"] = []uuid.UUID{uuid.New()}
+
+ running := newPkg()
+ running.RunIDs = []uuid.UUID{uuid.New()}
+ running.RunningRunIDs = running.RunIDs
+
+ errored := newPkg()
+ errored.ErrorRunIDs = []uuid.UUID{uuid.New()}
+
+ active := newPkg()
+ active.RunIDs = []uuid.UUID{uuid.New()}
+
+ var summaries []*tester.RunSummary
+ for i, ps := range []*tester.PackageSummary{results, running, errored, active, nil} {
+ s := &tester.RunSummary{
+ Time: begin.Add(time.Duration(i) * window),
+ Duration: window,
+ PackageSummary: map[string]*tester.PackageSummary{},
+ }
+ if ps != nil {
+ s.PackageSummary["pkg"] = ps
+ }
+ summaries = append(summaries, s)
+ }
+ return summaries
+}
+
+func TestSummaryState(t *testing.T) {
+ summaries := uiTestSummaries(time.Now(), time.Minute)
+ assert.Equal(t, "results", summaryState(summaries[0].PackageSummary["pkg"]))
+ assert.Equal(t, "running", summaryState(summaries[1].PackageSummary["pkg"]))
+ assert.Equal(t, "errored", summaryState(summaries[2].PackageSummary["pkg"]))
+ assert.Equal(t, "active", summaryState(summaries[3].PackageSummary["pkg"]))
+ assert.Equal(t, "empty", summaryState(summaries[4].PackageSummary["pkg"]), "missing package is a nil *PackageSummary")
+ assert.Equal(t, "empty", summaryState(summaries[4]))
+ assert.Equal(t, "results", summaryState(summaries[0]))
+ assert.Equal(t, "running", summaryState(summaries[1]))
+ assert.Equal(t, "empty", summaryState((*tester.RunSummary)(nil)))
+
+ // Errored takes precedence over running when there are no results.
+ both := &tester.PackageSummary{
+ RunIDs: []uuid.UUID{uuid.New()}, RunningRunIDs: []uuid.UUID{uuid.New()}, ErrorRunIDs: []uuid.UUID{uuid.New()},
+ }
+ assert.Equal(t, "errored", summaryState(both))
+}
+
+func TestUI_RendersRunSummaryStates(t *testing.T) {
+ ctrl := gomock.NewController(t)
+ defer ctrl.Finish()
+
+ mockDB := db.NewMockDB(ctrl)
+ packages := []*tester.Package{{Name: "pkg"}}
+ ui := NewUIHandler(mockDB, packages)
+ ts := httptest.NewServer(ui)
+ defer ts.Close()
+
+ begin := time.Now().Truncate(5 * time.Minute).Add(-time.Hour)
+ summaries := uiTestSummaries(begin, 5*time.Minute)
+
+ get := func(path string) (int, string) {
+ resp, err := ts.Client().Get(ts.URL + path)
+ require.NoError(t, err)
+ defer resp.Body.Close()
+ body, err := io.ReadAll(resp.Body)
+ require.NoError(t, err)
+ return resp.StatusCode, string(body)
+ }
+
+ t.Run("dashboard", func(t *testing.T) {
+ // The dashboard loads the hour, day and month strips in parallel.
+ mockDB.EXPECT().ListRunSummariesInRange(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).Return(summaries, nil).Times(3)
+
+ status, body := get("/")
+ require.Equal(t, http.StatusOK, status, body)
+ assert.Contains(t, body, `class="summary-running"`)
+ assert.Contains(t, body, `class="summary-active"`)
+ assert.Contains(t, body, "1 running")
+ assert.Contains(t, body, "1 erred")
+ assert.Contains(t, body, "bg-success")
+ })
+
+ t.Run("run_summary", func(t *testing.T) {
+ mockDB.EXPECT().
+ ListRunSummariesInRange(gomock.Any(), gomock.Any(), gomock.Any(), 5*time.Minute).
+ Return(summaries[1:2], nil)
+
+ status, body := get(fmt.Sprintf("/run_summary?package=pkg&begin=%d&window=300", begin.Unix()))
+ require.Equal(t, http.StatusOK, status, body)
+ assert.Contains(t, body, "1 Runs (1 running)")
+ assert.Contains(t, body, "/runs/"+summaries[1].PackageSummary["pkg"].RunningRunIDs[0].String())
+ assert.Equal(t, 1, strings.Count(body, `class="badge bg-info rounded-pill"`))
+ })
+
+ t.Run("run_summary errored", func(t *testing.T) {
+ mockDB.EXPECT().
+ ListRunSummariesInRange(gomock.Any(), gomock.Any(), gomock.Any(), 5*time.Minute).
+ Return(summaries[2:3], nil)
+
+ status, body := get(fmt.Sprintf("/run_summary?package=pkg&begin=%d&window=300", begin.Unix()))
+ require.Equal(t, http.StatusOK, status, body)
+ assert.Contains(t, body, "/runs/"+summaries[2].PackageSummary["pkg"].ErrorRunIDs[0].String())
+ })
+}
diff --git a/types.go b/types.go
index b858db1..2920165 100644
--- a/types.go
+++ b/types.go
@@ -103,6 +103,13 @@ func (o *Option) String() string {
return fmt.Sprintf("-%s=%s", o.Name, o.Value)
}
+// RunSummary aggregates the runs and test results that fall in the time
+// bucket [Time, Time+Duration), grouped by package.
+//
+// A run is attributed to every bucket it was executing in, from started_at to
+// finished_at (or now, if it is still running), so a long run shows up in
+// several consecutive buckets. Its test results are only counted in the bucket
+// it started in.
type RunSummary struct {
Time time.Time
Duration time.Duration
@@ -112,7 +119,7 @@ type RunSummary struct {
func (s *RunSummary) NumRuns() int {
var total int
for _, pkgSummary := range s.PackageSummary {
- total += len(pkgSummary.RunIDs)
+ total += pkgSummary.NumRuns()
}
return total
}
@@ -120,7 +127,15 @@ func (s *RunSummary) NumRuns() int {
func (s *RunSummary) NumErrorRuns() int {
var total int
for _, pkgSummary := range s.PackageSummary {
- total += len(pkgSummary.ErrorRunIDs)
+ total += pkgSummary.NumErrorRuns()
+ }
+ return total
+}
+
+func (s *RunSummary) NumRunningRuns() int {
+ var total int
+ for _, pkgSummary := range s.PackageSummary {
+ total += pkgSummary.NumRunningRuns()
}
return total
}
@@ -175,13 +190,34 @@ func (s *RunSummary) NumTotalTests() int {
return passed + failed + skipped
}
+// PackageSummary is the per-package part of a RunSummary.
+//
+// RunIDs holds every run of the package that did not error and was executing
+// at some point during the bucket; RunningRunIDs is the subset of those that
+// has not finished yet. ErrorRunIDs holds the runs that errored; they are
+// disjoint from RunIDs and their tests are not counted. The test maps are
+// keyed by test name and only contain tests of runs that started in this
+// bucket.
type PackageSummary struct {
- Package string
- RunIDs []uuid.UUID
- ErrorRunIDs []uuid.UUID
- PassedTests map[string][]uuid.UUID
- FailedTests map[string][]uuid.UUID
- SkippedTests map[string][]uuid.UUID
+ Package string
+ RunIDs []uuid.UUID
+ RunningRunIDs []uuid.UUID
+ ErrorRunIDs []uuid.UUID
+ PassedTests map[string][]uuid.UUID
+ FailedTests map[string][]uuid.UUID
+ SkippedTests map[string][]uuid.UUID
+}
+
+func (s *PackageSummary) NumRuns() int {
+ return len(s.RunIDs)
+}
+
+func (s *PackageSummary) NumErrorRuns() int {
+ return len(s.ErrorRunIDs)
+}
+
+func (s *PackageSummary) NumRunningRuns() int {
+ return len(s.RunningRunIDs)
}
func (s *PackageSummary) NumPassedTests() int {