snapper + client/status: snapshotting reports

daemon/snapper/snapper.go

@@ -26,12 +26,14 @@ const (
 	SnapError
 )
 
+// All fields protected by Snapper.mtx
 type snapProgress struct {
 	state SnapState
 
 	// SnapStarted, SnapDone, SnapError
-	name    string
-	startAt time.Time
+	name     string
+	startAt  time.Time
+	hookPlan *hooks.Plan
 
 	// SnapDone
 	doneAt time.Time
@@ -61,7 +63,7 @@ type Snapper struct {
 	lastInvocation time.Time
 
 	// valid for state Snapshotting
-	plan map[*zfs.DatasetPath]snapProgress
+	plan map[*zfs.DatasetPath]*snapProgress
 
 	// valid for state SyncUp and Waiting
 	sleepUntil time.Time
@@ -234,19 +236,20 @@ func plan(a args, u updater) state {
 		return onErr(err, u)
 	}
 
-	plan := make(map[*zfs.DatasetPath]snapProgress, len(fss))
+	plan := make(map[*zfs.DatasetPath]*snapProgress, len(fss))
 	for _, fs := range fss {
-		plan[fs] = snapProgress{state: SnapPending}
+		plan[fs] = &snapProgress{state: SnapPending}
 	}
 	return u(func(s *Snapper) {
 		s.state = Snapshotting
 		s.plan = plan
+		s.err = nil
 	}).sf()
 }
 
 func snapshot(a args, u updater) state {
 
-	var plan map[*zfs.DatasetPath]snapProgress
+	var plan map[*zfs.DatasetPath]*snapProgress
 	u(func(snapper *Snapper) {
 		plan = snapper.plan
 	})
@@ -266,14 +269,6 @@ func snapshot(a args, u updater) state {
 			WithField("fs", fs.ToString()).
 			WithField("snap", snapname)
 
-		u(func(snapper *Snapper) {
-			progress.name = snapname
-			progress.startAt = time.Now()
-			progress.state = SnapStarted
-		})
-
-		var doneAt time.Time
-
 		hookEnvExtra := hooks.Env{
 			hooks.EnvFS:       fs.ToString(),
 			hooks.EnvSnapshot: snapname,
@@ -285,7 +280,6 @@ func snapshot(a args, u updater) state {
 			if err != nil {
 				l.WithError(err).Error("cannot create snapshot")
 			}
-			doneAt = time.Now()
 			return
 		})
 
@@ -312,6 +306,12 @@ func snapshot(a args, u updater) state {
 				goto updateFSState
 			}
 		}
+		u(func(snapper *Snapper) {
+			progress.name = snapname
+			progress.startAt = time.Now()
+			progress.hookPlan = plan
+			progress.state = SnapStarted
+		})
 		{
 			l := hooks.GetLogger(a.ctx).WithField("fs", fs.ToString()).WithField("snap", snapname)
 			l.WithField("report", plan.Report().String()).Debug("begin run job plan")
@@ -328,7 +328,7 @@ func snapshot(a args, u updater) state {
 	updateFSState:
 		anyFsHadErr = anyFsHadErr || fsHadErr
 		u(func(snapper *Snapper) {
-			progress.doneAt = doneAt
+			progress.doneAt = time.Now()
 			progress.state = SnapDone
 			if fsHadErr {
 				progress.state = SnapError
@@ -364,6 +364,7 @@ func snapshot(a args, u updater) state {
 			snapper.err = errors.New("one or more snapshots could not be created, check logs for details")
 		} else {
 			snapper.state = Waiting
+			snapper.err = nil
 		}
 	}).sf()
 }

daemon/snapper/snapper_all.go

@@ -24,6 +24,14 @@ func (s *PeriodicOrManual) Run(ctx context.Context, wakeUpCommon chan<- struct{}
 	}
 }
 
+// Returns nil if manual
+func (s *PeriodicOrManual) Report() *Report {
+	if s.s != nil {
+		return s.s.Report()
+	}
+	return nil
+}
+
 func FromConfig(g *config.Global, fsf *filters.DatasetMapFilter, in config.SnapshottingEnum) (*PeriodicOrManual, error) {
 	switch v := in.Ret.(type) {
 	case *config.SnapshottingPeriodic:

daemon/snapper/snapper_report.go

@@ -0,0 +1,118 @@
+package snapper
+
+import (
+	"fmt"
+	"sort"
+	"strings"
+	"time"
+
+	"github.com/zrepl/zrepl/daemon/hooks"
+)
+
+type Report struct {
+	State State
+	// valid in state SyncUp and Waiting
+	SleepUntil time.Time
+	// valid in state Err
+	Error string
+	// valid in state Snapshotting
+	Progress []*ReportFilesystem
+}
+
+type ReportFilesystem struct {
+	Path  string
+	State SnapState
+
+	// Valid in SnapStarted and later
+	SnapName      string
+	StartAt       time.Time
+	Hooks         string
+	HooksHadError bool
+
+	// Valid in SnapDone | SnapError
+	DoneAt time.Time
+}
+
+func errOrEmptyString(e error) string {
+	if e != nil {
+		return e.Error()
+	}
+	return ""
+}
+
+func (s *Snapper) Report() *Report {
+	s.mtx.Lock()
+	defer s.mtx.Unlock()
+
+	pReps := make([]*ReportFilesystem, 0, len(s.plan))
+	for fs, p := range s.plan {
+		var hooksStr string
+		var hooksHadError bool
+		if p.hookPlan != nil {
+			hr := p.hookPlan.Report()
+			// FIXME: technically this belongs into client
+			// but we can't serialize hooks.Step ATM
+			rightPad := func(str string, length int, pad string) string {
+				if len(str) > length {
+					return str[:length]
+				}
+				return str + strings.Repeat(pad, length-len(str))
+			}
+			hooksHadError = hr.HadError()
+			rows := make([][]string, len(hr))
+			const numCols = 4
+			lens := make([]int, numCols)
+			for i, e := range hr {
+				rows[i] = make([]string, numCols)
+				rows[i][0] = fmt.Sprintf("%d", i+1)
+				rows[i][1] = e.Status.String()
+				runTime := "..."
+				if e.Status != hooks.StepPending {
+					runTime = e.End.Sub(e.Begin).Round(time.Millisecond).String()
+				}
+				rows[i][2] = runTime
+				rows[i][3] = ""
+				if e.Report != nil {
+					rows[i][3] = e.Report.String()
+				}
+				for j, col := range lens {
+					if len(rows[i][j]) > col {
+						lens[j] = len(rows[i][j])
+					}
+				}
+			}
+			rowsFlat := make([]string, len(hr))
+			for i, r := range rows {
+				colsPadded := make([]string, len(r))
+				for j, c := range r[:len(r)-1] {
+					colsPadded[j] = rightPad(c, lens[j], " ")
+				}
+				colsPadded[len(r)-1] = r[len(r)-1]
+				rowsFlat[i] = strings.Join(colsPadded, " ")
+			}
+			hooksStr = strings.Join(rowsFlat, "\n")
+		}
+		pReps = append(pReps, &ReportFilesystem{
+			Path:          fs.ToString(),
+			State:         p.state,
+			SnapName:      p.name,
+			StartAt:       p.startAt,
+			DoneAt:        p.doneAt,
+			Hooks:         hooksStr,
+			HooksHadError: hooksHadError,
+		})
+	}
+
+	sort.Slice(pReps, func(i, j int) bool {
+		return strings.Compare(pReps[i].Path, pReps[j].Path) == -1
+	})
+
+	r := &Report{
+		State:      s.state,
+		SleepUntil: s.sleepUntil,
+		Error:      errOrEmptyString(s.err),
+		Progress:   pReps,
+	}
+
+	return r
+}