From fbb0e6499ac8212b26a7a23f9fe416e2c9fe6528 Mon Sep 17 00:00:00 2001 From: Michael Eischer Date: Sun, 12 Sep 2021 16:15:40 +0200 Subject: [PATCH] ui: consolidate backup ui in ui/backup package --- cmd/restic/cmd_backup.go | 11 +++--- .../ui/{json/backup.go => backup/json.go} | 34 ++++++++-------- internal/ui/{ => backup}/progress.go | 2 +- internal/ui/{backup.go => backup/text.go} | 39 ++++++++++--------- 4 files changed, 43 insertions(+), 43 deletions(-) rename internal/ui/{json/backup.go => backup/json.go} (84%) rename internal/ui/{ => backup}/progress.go (99%) rename internal/ui/{backup.go => backup/text.go} (78%) diff --git a/cmd/restic/cmd_backup.go b/cmd/restic/cmd_backup.go index 037b61103..ab9ee41f0 100644 --- a/cmd/restic/cmd_backup.go +++ b/cmd/restic/cmd_backup.go @@ -24,8 +24,7 @@ import ( "github.com/restic/restic/internal/repository" "github.com/restic/restic/internal/restic" "github.com/restic/restic/internal/textfile" - "github.com/restic/restic/internal/ui" - "github.com/restic/restic/internal/ui/json" + "github.com/restic/restic/internal/ui/backup" "github.com/restic/restic/internal/ui/termstatus" ) @@ -527,13 +526,13 @@ func runBackup(opts BackupOptions, gopts GlobalOptions, term *termstatus.Termina return err } - var progressPrinter ui.ProgressPrinter + var progressPrinter backup.ProgressPrinter if gopts.JSON { - progressPrinter = json.NewBackup(term, gopts.verbosity) + progressPrinter = backup.NewJSONProgress(term, gopts.verbosity) } else { - progressPrinter = ui.NewBackup(term, gopts.verbosity) + progressPrinter = backup.NewTextProgress(term, gopts.verbosity) } - progressReporter := ui.NewProgress(progressPrinter) + progressReporter := backup.NewProgress(progressPrinter) if opts.DryRun { repo.SetDryRun() diff --git a/internal/ui/json/backup.go b/internal/ui/backup/json.go similarity index 84% rename from internal/ui/json/backup.go rename to internal/ui/backup/json.go index 6c19089df..fcc200b2a 100644 --- a/internal/ui/json/backup.go +++ b/internal/ui/backup/json.go @@ -1,4 +1,4 @@ -package json +package backup import ( "bytes" @@ -13,8 +13,8 @@ import ( "github.com/restic/restic/internal/ui/termstatus" ) -// Backup reports progress for the `backup` command in JSON. -type Backup struct { +// JSONProgress reports progress for the `backup` command in JSON. +type JSONProgress struct { *ui.Message *ui.StdioWrapper @@ -23,11 +23,11 @@ type Backup struct { } // assert that Backup implements the ProgressPrinter interface -var _ ui.ProgressPrinter = &Backup{} +var _ ProgressPrinter = &JSONProgress{} -// NewBackup returns a new backup progress reporter. -func NewBackup(term *termstatus.Terminal, verbosity uint) *Backup { - return &Backup{ +// NewJSONProgress returns a new backup progress reporter. +func NewJSONProgress(term *termstatus.Terminal, verbosity uint) *JSONProgress { + return &JSONProgress{ Message: ui.NewMessage(term, verbosity), StdioWrapper: ui.NewStdioWrapper(term), term: term, @@ -44,16 +44,16 @@ func toJSONString(status interface{}) string { return buf.String() } -func (b *Backup) print(status interface{}) { +func (b *JSONProgress) print(status interface{}) { b.term.Print(toJSONString(status)) } -func (b *Backup) error(status interface{}) { +func (b *JSONProgress) error(status interface{}) { b.term.Error(toJSONString(status)) } -// update updates the status lines. -func (b *Backup) Update(total, processed ui.Counter, errors uint, currentFiles map[string]struct{}, start time.Time, secs uint64) { +// Update updates the status lines. +func (b *JSONProgress) Update(total, processed Counter, errors uint, currentFiles map[string]struct{}, start time.Time, secs uint64) { status := statusUpdate{ MessageType: "status", SecondsElapsed: uint64(time.Since(start) / time.Second), @@ -79,7 +79,7 @@ func (b *Backup) Update(total, processed ui.Counter, errors uint, currentFiles m // ScannerError is the error callback function for the scanner, it prints the // error in verbose mode and returns nil. -func (b *Backup) ScannerError(item string, fi os.FileInfo, err error) error { +func (b *JSONProgress) ScannerError(item string, fi os.FileInfo, err error) error { b.error(errorUpdate{ MessageType: "error", Error: err, @@ -90,7 +90,7 @@ func (b *Backup) ScannerError(item string, fi os.FileInfo, err error) error { } // Error is the error callback function for the archiver, it prints the error and returns nil. -func (b *Backup) Error(item string, fi os.FileInfo, err error) error { +func (b *JSONProgress) Error(item string, fi os.FileInfo, err error) error { b.error(errorUpdate{ MessageType: "error", Error: err, @@ -102,7 +102,7 @@ func (b *Backup) Error(item string, fi os.FileInfo, err error) error { // CompleteItem is the status callback function for the archiver when a // file/dir has been saved successfully. -func (b *Backup) CompleteItem(messageType, item string, previous, current *restic.Node, s archiver.ItemStats, d time.Duration) { +func (b *JSONProgress) CompleteItem(messageType, item string, previous, current *restic.Node, s archiver.ItemStats, d time.Duration) { if b.v < 2 { return } @@ -158,7 +158,7 @@ func (b *Backup) CompleteItem(messageType, item string, previous, current *resti } // ReportTotal sets the total stats up to now -func (b *Backup) ReportTotal(item string, start time.Time, s archiver.ScanStats) { +func (b *JSONProgress) ReportTotal(item string, start time.Time, s archiver.ScanStats) { if b.v >= 2 { b.print(verboseUpdate{ MessageType: "status", @@ -171,7 +171,7 @@ func (b *Backup) ReportTotal(item string, start time.Time, s archiver.ScanStats) } // Finish prints the finishing messages. -func (b *Backup) Finish(snapshotID restic.ID, start time.Time, summary *ui.Summary, dryRun bool) { +func (b *JSONProgress) Finish(snapshotID restic.ID, start time.Time, summary *Summary, dryRun bool) { b.print(summaryOutput{ MessageType: "summary", FilesNew: summary.Files.New, @@ -192,7 +192,7 @@ func (b *Backup) Finish(snapshotID restic.ID, start time.Time, summary *ui.Summa } // Reset no-op -func (b *Backup) Reset() { +func (b *JSONProgress) Reset() { } type statusUpdate struct { diff --git a/internal/ui/progress.go b/internal/ui/backup/progress.go similarity index 99% rename from internal/ui/progress.go rename to internal/ui/backup/progress.go index b0d2e8ed3..781ac289b 100644 --- a/internal/ui/progress.go +++ b/internal/ui/backup/progress.go @@ -1,4 +1,4 @@ -package ui +package backup import ( "context" diff --git a/internal/ui/backup.go b/internal/ui/backup/text.go similarity index 78% rename from internal/ui/backup.go rename to internal/ui/backup/text.go index 53bc2117e..998805865 100644 --- a/internal/ui/backup.go +++ b/internal/ui/backup/text.go @@ -1,4 +1,4 @@ -package ui +package backup import ( "fmt" @@ -8,31 +8,32 @@ import ( "github.com/restic/restic/internal/archiver" "github.com/restic/restic/internal/restic" + "github.com/restic/restic/internal/ui" "github.com/restic/restic/internal/ui/termstatus" ) -// Backup reports progress for the `backup` command. -type Backup struct { - *Message - *StdioWrapper +// TextProgress reports progress for the `backup` command. +type TextProgress struct { + *ui.Message + *ui.StdioWrapper term *termstatus.Terminal } // assert that Backup implements the ProgressPrinter interface -var _ ProgressPrinter = &Backup{} +var _ ProgressPrinter = &TextProgress{} -// NewBackup returns a new backup progress reporter. -func NewBackup(term *termstatus.Terminal, verbosity uint) *Backup { - return &Backup{ - Message: NewMessage(term, verbosity), - StdioWrapper: NewStdioWrapper(term), +// NewTextProgress returns a new backup progress reporter. +func NewTextProgress(term *termstatus.Terminal, verbosity uint) *TextProgress { + return &TextProgress{ + Message: ui.NewMessage(term, verbosity), + StdioWrapper: ui.NewStdioWrapper(term), term: term, } } -// update updates the status lines. -func (b *Backup) Update(total, processed Counter, errors uint, currentFiles map[string]struct{}, start time.Time, secs uint64) { +// Update updates the status lines. +func (b *TextProgress) Update(total, processed Counter, errors uint, currentFiles map[string]struct{}, start time.Time, secs uint64) { var status string if total.Files == 0 && total.Dirs == 0 { // no total count available yet @@ -74,13 +75,13 @@ func (b *Backup) Update(total, processed Counter, errors uint, currentFiles map[ // ScannerError is the error callback function for the scanner, it prints the // error in verbose mode and returns nil. -func (b *Backup) ScannerError(item string, fi os.FileInfo, err error) error { +func (b *TextProgress) ScannerError(item string, fi os.FileInfo, err error) error { b.V("scan: %v\n", err) return nil } // Error is the error callback function for the archiver, it prints the error and returns nil. -func (b *Backup) Error(item string, fi os.FileInfo, err error) error { +func (b *TextProgress) Error(item string, fi os.FileInfo, err error) error { b.E("error: %v\n", err) return nil } @@ -134,7 +135,7 @@ func formatBytes(c uint64) string { // CompleteItem is the status callback function for the archiver when a // file/dir has been saved successfully. -func (b *Backup) CompleteItem(messageType, item string, previous, current *restic.Node, s archiver.ItemStats, d time.Duration) { +func (b *TextProgress) CompleteItem(messageType, item string, previous, current *restic.Node, s archiver.ItemStats, d time.Duration) { switch messageType { case "dir new": b.VV("new %v, saved in %.3fs (%v added, %v metadata)", item, d.Seconds(), formatBytes(s.DataSize), formatBytes(s.TreeSize)) @@ -152,7 +153,7 @@ func (b *Backup) CompleteItem(messageType, item string, previous, current *resti } // ReportTotal sets the total stats up to now -func (b *Backup) ReportTotal(item string, start time.Time, s archiver.ScanStats) { +func (b *TextProgress) ReportTotal(item string, start time.Time, s archiver.ScanStats) { b.V("scan finished in %.3fs: %v files, %s", time.Since(start).Seconds(), s.Files, formatBytes(s.Bytes), @@ -160,14 +161,14 @@ func (b *Backup) ReportTotal(item string, start time.Time, s archiver.ScanStats) } // Reset status -func (b *Backup) Reset() { +func (b *TextProgress) Reset() { if b.term.CanUpdateStatus() { b.term.SetStatus([]string{""}) } } // Finish prints the finishing messages. -func (b *Backup) Finish(snapshotID restic.ID, start time.Time, summary *Summary, dryRun bool) { +func (b *TextProgress) Finish(snapshotID restic.ID, start time.Time, summary *Summary, dryRun bool) { b.P("\n") b.P("Files: %5d new, %5d changed, %5d unmodified\n", summary.Files.New, summary.Files.Changed, summary.Files.Unchanged) b.P("Dirs: %5d new, %5d changed, %5d unmodified\n", summary.Dirs.New, summary.Dirs.Changed, summary.Dirs.Unchanged)