Merge pull request #1695 from AkihiroSuda/vz-progressbar

vz: show progressbar during converting qcow2 to raw

Author: AkihiroSuda

pkg/downloader/downloader.go

@@ -12,18 +12,24 @@ import (
 	"path"
 	"path/filepath"
 	"strings"
-	"time"
 
 	"github.com/cheggaaa/pb/v3"
 	"github.com/containerd/continuity/fs"
 	"github.com/lima-vm/lima/pkg/localpathutil"
-	"github.com/mattn/go-isatty"
+	"github.com/lima-vm/lima/pkg/progressbar"
 	"github.com/opencontainers/go-digest"
 	"github.com/sirupsen/logrus"
 )
 
+// HideProgress is used only for testing
 var HideProgress bool
 
+// hideBar is used only for testing
+func hideBar(bar *pb.ProgressBar) {
+	bar.Set(pb.ReturnSymbol, "")
+	bar.SetTemplateString("")
+}
+
 type Status = string
 
 const (
@@ -320,10 +326,13 @@ func decompressLocal(dst, src, ext string, description string) error {
 	if err != nil {
 		return err
 	}
-	bar, err := createBar(st.Size())
+	bar, err := progressbar.New(st.Size())
 	if err != nil {
 		return err
 	}
+	if HideProgress {
+		hideBar(bar)
+	}
 
 	in, err := os.Open(src)
 	if err != nil {
@@ -384,30 +393,6 @@ func validateLocalFileDigest(localPath string, expectedDigest digest.Digest) err
 	return nil
 }
 
-func createBar(size int64) (*pb.ProgressBar, error) {
-	bar := pb.New64(size)
-
-	bar.Set(pb.Bytes, true)
-	if isatty.IsTerminal(os.Stdout.Fd()) || isatty.IsCygwinTerminal(os.Stdout.Fd()) {
-		bar.SetTemplateString(`{{counters . }} {{bar . | green }} {{percent .}} {{speed . "%s/s"}}`)
-		bar.SetRefreshRate(200 * time.Millisecond)
-	} else if HideProgress {
-		bar.Set(pb.ReturnSymbol, "")
-		bar.SetTemplateString("")
-	} else {
-		bar.Set(pb.Terminal, false)
-		bar.Set(pb.ReturnSymbol, "\n")
-		bar.SetTemplateString(`{{counters . }} ({{percent .}}) {{speed . "%s/s"}}`)
-		bar.SetRefreshRate(5 * time.Second)
-	}
-	bar.SetWidth(80)
-	if err := bar.Err(); err != nil {
-		return nil, err
-	}
-
-	return bar, nil
-}
-
 func downloadHTTP(localPath, url string, description string, expectedDigest digest.Digest) error {
 	if localPath == "" {
 		return fmt.Errorf("downloadHTTP: got empty localPath")
@@ -431,10 +416,13 @@ func downloadHTTP(localPath, url string, description string, expectedDigest dige
 	if resp.StatusCode != http.StatusOK {
 		return fmt.Errorf("expected HTTP status %d, got %s", http.StatusOK, resp.Status)
 	}
-	bar, err := createBar(resp.ContentLength)
+	bar, err := progressbar.New(resp.ContentLength)
 	if err != nil {
 		return err
 	}
+	if HideProgress {
+		hideBar(bar)
+	}
 
 	writers := []io.Writer{fileWriter}
 	var digester digest.Digester

pkg/nativeimgutil/nativeimgutil.go

@@ -10,10 +10,12 @@ import (
 	"path/filepath"
 
 	"github.com/containerd/continuity/fs"
+	"github.com/docker/go-units"
 	"github.com/lima-vm/go-qcow2reader"
 	"github.com/lima-vm/go-qcow2reader/image/qcow2"
 	"github.com/lima-vm/go-qcow2reader/image/raw"
 	"github.com/lima-vm/lima/pkg/osutil"
+	"github.com/lima-vm/lima/pkg/progressbar"
 	"github.com/sirupsen/logrus"
 )
 
@@ -33,6 +35,7 @@ func ConvertToRaw(source, dest string, size *int64, allowSourceWithBackingFile b
 	if size != nil && *size < srcImg.Size() {
 		return fmt.Errorf("specified size %d is smaller than the original image size (%d) of %q", *size, srcImg.Size(), source)
 	}
+	logrus.Infof("Converting %q (%s) to a raw disk %q", source, srcImg.Type(), dest)
 	switch t := srcImg.Type(); t {
 	case raw.Type:
 		if err = srcF.Close(); err != nil {
@@ -67,13 +70,21 @@ func ConvertToRaw(source, dest string, size *int64, allowSourceWithBackingFile b
 
 	// Copy
 	srcImgR := io.NewSectionReader(srcImg, 0, srcImg.Size())
+	bar, err := progressbar.New(srcImg.Size())
+	if err != nil {
+		return err
+	}
 	const bufSize = 1024 * 1024
-	if copied, err := copySparse(destTmpF, srcImgR, bufSize); err != nil {
+	bar.Start()
+	copied, err := copySparse(destTmpF, bar.NewProxyReader(srcImgR), bufSize)
+	bar.Finish()
+	if err != nil {
 		return fmt.Errorf("failed to call copySparse(), bufSize=%d, copied=%d: %w", bufSize, copied, err)
 	}
 
 	// Resize
 	if size != nil {
+		logrus.Infof("Expanding to %s", units.BytesSize(float64(*size)))
 		if err = MakeSparse(destTmpF, *size); err != nil {
 			return err
 		}
@@ -97,6 +108,7 @@ func convertRawToRaw(source, dest string, size *int64) error {
 		}
 	}
 	if size != nil {
+		logrus.Infof("Expanding to %s", units.BytesSize(float64(*size)))
 		destF, err := os.OpenFile(dest, os.O_RDWR, 0644)
 		if err != nil {
 			return err

pkg/progressbar/progressbar.go

@@ -0,0 +1,30 @@
+package progressbar
+
+import (
+	"os"
+	"time"
+
+	"github.com/cheggaaa/pb/v3"
+	"github.com/mattn/go-isatty"
+)
+
+func New(size int64) (*pb.ProgressBar, error) {
+	bar := pb.New64(size)
+
+	bar.Set(pb.Bytes, true)
+	if isatty.IsTerminal(os.Stdout.Fd()) || isatty.IsCygwinTerminal(os.Stdout.Fd()) {
+		bar.SetTemplateString(`{{counters . }} {{bar . | green }} {{percent .}} {{speed . "%s/s"}}`)
+		bar.SetRefreshRate(200 * time.Millisecond)
+	} else {
+		bar.Set(pb.Terminal, false)
+		bar.Set(pb.ReturnSymbol, "\n")
+		bar.SetTemplateString(`{{counters . }} ({{percent .}}) {{speed . "%s/s"}}`)
+		bar.SetRefreshRate(5 * time.Second)
+	}
+	bar.SetWidth(80)
+	if err := bar.Err(); err != nil {
+		return nil, err
+	}
+
+	return bar, nil
+}

pkg/vz/disk.go

@@ -12,7 +12,6 @@ import (
 	"github.com/lima-vm/lima/pkg/iso9660util"
 	"github.com/lima-vm/lima/pkg/nativeimgutil"
 	"github.com/lima-vm/lima/pkg/store/filenames"
-	"github.com/sirupsen/logrus"
 )
 
 func EnsureDisk(driver *driver.BaseDriver) error {
@@ -58,9 +57,8 @@ func EnsureDisk(driver *driver.BaseDriver) error {
 		}
 		return diffDiskF.Close()
 	}
-	logrus.Infof("Converting %q to a raw disk %q (size=%d)", baseDisk, diffDisk, diskSize)
 	if err = nativeimgutil.ConvertToRaw(baseDisk, diffDisk, &diskSize, false); err != nil {
-		return fmt.Errorf("failed to convert %q to a raw disk %q (size=%d): %w", baseDisk, diffDisk, diskSize, err)
+		return fmt.Errorf("failed to convert %q to a raw disk %q: %w", baseDisk, diffDisk, err)
 	}
 	return err
 }