restic/internal/ui/restore/progressformatter_test.go

package restore

import (
	"testing"
	"time"

	"github.com/restic/restic/internal/test"
)

type printerTraceEntry struct {
	filesFinished, filesTotal, allBytesWritten, allBytesTotal uint64

	duration   time.Duration
	isFinished bool
}

type printerTrace []printerTraceEntry

type mockPrinter struct {
	trace printerTrace
}

const mockFinishDuration = 42 * time.Second

func (p *mockPrinter) Update(filesFinished, filesTotal, allBytesWritten, allBytesTotal uint64, duration time.Duration) {
	p.trace = append(p.trace, printerTraceEntry{filesFinished, filesTotal, allBytesWritten, allBytesTotal, duration, false})
}
func (p *mockPrinter) Finish(filesFinished, filesTotal, allBytesWritten, allBytesTotal uint64, _ time.Duration) {
	p.trace = append(p.trace, printerTraceEntry{filesFinished, filesTotal, allBytesWritten, allBytesTotal, mockFinishDuration, true})
}

func testProgress(fn func(progress *Progress) bool) printerTrace {
	printer := &mockPrinter{}
	progress := NewProgress(printer, 0)
	final := fn(progress)
	progress.update(0, final)
	trace := append(printerTrace{}, printer.trace...)
	// cleanup to avoid goroutine leak, but copy trace first
	progress.Finish()
	return trace
}

func TestNew(t *testing.T) {
	result := testProgress(func(progress *Progress) bool {
		return false
	})
	test.Equals(t, printerTrace{
		printerTraceEntry{0, 0, 0, 0, 0, false},
	}, result)
}

func TestAddFile(t *testing.T) {
	fileSize := uint64(100)

	result := testProgress(func(progress *Progress) bool {
		progress.AddFile(fileSize)
		return false
	})
	test.Equals(t, printerTrace{
		printerTraceEntry{0, 1, 0, fileSize, 0, false},
	}, result)
}

func TestFirstProgressOnAFile(t *testing.T) {
	expectedBytesWritten := uint64(5)
	expectedBytesTotal := uint64(100)

	result := testProgress(func(progress *Progress) bool {
		progress.AddFile(expectedBytesTotal)
		progress.AddProgress("test", expectedBytesWritten, expectedBytesTotal)
		return false
	})
	test.Equals(t, printerTrace{
		printerTraceEntry{0, 1, expectedBytesWritten, expectedBytesTotal, 0, false},
	}, result)
}

func TestLastProgressOnAFile(t *testing.T) {
	fileSize := uint64(100)

	result := testProgress(func(progress *Progress) bool {
		progress.AddFile(fileSize)
		progress.AddProgress("test", 30, fileSize)
		progress.AddProgress("test", 35, fileSize)
		progress.AddProgress("test", 35, fileSize)
		return false
	})
	test.Equals(t, printerTrace{
		printerTraceEntry{1, 1, fileSize, fileSize, 0, false},
	}, result)
}

func TestLastProgressOnLastFile(t *testing.T) {
	fileSize := uint64(100)

	result := testProgress(func(progress *Progress) bool {
		progress.AddFile(fileSize)
		progress.AddFile(50)
		progress.AddProgress("test1", 50, 50)
		progress.AddProgress("test2", 50, fileSize)
		progress.AddProgress("test2", 50, fileSize)
		return false
	})
	test.Equals(t, printerTrace{
		printerTraceEntry{2, 2, 50 + fileSize, 50 + fileSize, 0, false},
	}, result)
}

func TestSummaryOnSuccess(t *testing.T) {
	fileSize := uint64(100)

	result := testProgress(func(progress *Progress) bool {
		progress.AddFile(fileSize)
		progress.AddFile(50)
		progress.AddProgress("test1", 50, 50)
		progress.AddProgress("test2", fileSize, fileSize)
		return true
	})
	test.Equals(t, printerTrace{
		printerTraceEntry{2, 2, 50 + fileSize, 50 + fileSize, mockFinishDuration, true},
	}, result)
}

func TestSummaryOnErrors(t *testing.T) {
	fileSize := uint64(100)

	result := testProgress(func(progress *Progress) bool {
		progress.AddFile(fileSize)
		progress.AddFile(50)
		progress.AddProgress("test1", 50, 50)
		progress.AddProgress("test2", fileSize/2, fileSize)
		return true
	})
	test.Equals(t, printerTrace{
		printerTraceEntry{1, 2, 50 + fileSize/2, 50 + fileSize, mockFinishDuration, true},
	}, result)
}

type mockTerm struct {
	output []string
}

func (m *mockTerm) Print(line string) {
	m.output = append(m.output, line)
}

func (m *mockTerm) SetStatus(lines []string) {
	m.output = append([]string{}, lines...)
}

func TestPrintUpdate(t *testing.T) {
	term := &mockTerm{}
	printer := NewProgressPrinter(term)
	printer.Update(3, 11, 29, 47, 5*time.Second)
	test.Equals(t, []string{"[0:05] 61.70%  3 files 29 B, total 11 files 47 B"}, term.output)
}

func TestPrintSummaryOnSuccess(t *testing.T) {
	term := &mockTerm{}
	printer := NewProgressPrinter(term)
	printer.Finish(11, 11, 47, 47, 5*time.Second)
	test.Equals(t, []string{"Summary: Restored 11 Files (47 B) in 0:05"}, term.output)
}

func TestPrintSummaryOnErrors(t *testing.T) {
	term := &mockTerm{}
	printer := NewProgressPrinter(term)
	printer.Finish(3, 11, 29, 47, 5*time.Second)
	test.Equals(t, []string{"Summary: Restored 3 / 11 Files (29 B / 47 B) in 0:05"}, term.output)
}