copy: add --progress-interval for CI-compatible progress output #2870
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| package main | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "io" | ||
| "os" | ||
| "time" | ||
|
|
||
| units "github.com/docker/go-units" | ||
| "go.podman.io/image/v5/types" | ||
| "golang.org/x/term" | ||
| ) | ||
|
|
||
| func runProgressConsumer(ch <-chan types.ProgressProperties, interval time.Duration, out io.Writer) { | ||
| type blobState struct { | ||
| total int64 | ||
| } | ||
| blobs := map[string]*blobState{} | ||
|
|
||
| for props := range ch { | ||
| dig := props.Artifact.Digest.Encoded() | ||
|
Contributor
There was a problem hiding this comment.
|
||
|
|
||
| switch props.Event { | ||
| case types.ProgressEventNewArtifact: | ||
| blobs[dig] = &blobState{total: props.Artifact.Size} | ||
|
|
||
| case types.ProgressEventRead: | ||
| b := blobs[dig] | ||
| bytesPerSec := float64(props.OffsetUpdate) / interval.Seconds() | ||
|
Contributor
There was a problem hiding this comment. ??? |
||
| totalStr := "?" | ||
| if b != nil && b.total > 0 { | ||
| totalStr = units.BytesSize(float64(b.total)) | ||
| } | ||
| // TODO: Make this prettier. | ||
| fmt.Fprintf(out, "%s %s %s / %s (%.1f MB/s)\n", | ||
| time.Now().UTC().Format(time.RFC3339), dig[:12], units.BytesSize(float64(props.Offset)), totalStr, bytesPerSec/1e6) | ||
| case types.ProgressEventDone: | ||
| if b, ok := blobs[dig]; ok { | ||
| fmt.Fprintf(out, "%s %s done (%s)\n", | ||
| time.Now().UTC().Format(time.RFC3339), | ||
| dig[:12], | ||
| units.BytesSize(float64(b.total)), | ||
| ) | ||
| delete(blobs, dig) | ||
| } | ||
| case types.ProgressEventSkipped: | ||
| delete(blobs, dig) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func resolveProgressInterval(explicit time.Duration) time.Duration { | ||
| if explicit != 0 { | ||
| return explicit | ||
| } | ||
| if !term.IsTerminal(int(os.Stderr.Fd())) { | ||
| return 30 * time.Second | ||
| } | ||
| return 0 // Suppress for TTY | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| package main | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "strings" | ||
| "testing" | ||
| "time" | ||
|
|
||
| digest "github.com/opencontainers/go-digest" | ||
| "github.com/stretchr/testify/assert" | ||
| "go.podman.io/image/v5/types" | ||
| ) | ||
|
|
||
| func TestProgressConsumerDone(t *testing.T) { | ||
| ch := make(chan types.ProgressProperties, 8) | ||
| var out bytes.Buffer | ||
|
|
||
| fakeDigest := digest.FromString("test-blob") | ||
| fakeSize := int64(1024 * 1024 * 10) // 10 MB | ||
|
|
||
| ch <- types.ProgressProperties{ | ||
| Event: types.ProgressEventNewArtifact, | ||
| Artifact: types.BlobInfo{Digest: fakeDigest, Size: fakeSize}, | ||
| } | ||
| ch <- types.ProgressProperties{ | ||
| Event: types.ProgressEventRead, | ||
| Artifact: types.BlobInfo{ | ||
| Digest: fakeDigest, | ||
| Size: fakeSize, | ||
| }, | ||
| Offset: uint64(fakeSize / 2), | ||
| OffsetUpdate: uint64(fakeSize / 2), | ||
| } | ||
| ch <- types.ProgressProperties{ | ||
| Event: types.ProgressEventDone, | ||
| Artifact: types.BlobInfo{ | ||
| Digest: fakeDigest, | ||
| Size: fakeSize, | ||
| }, | ||
| Offset: uint64(fakeSize), | ||
| } | ||
| close(ch) // simulate close on copy finish | ||
|
|
||
| runProgressConsumer(ch, 30*time.Second, &out) | ||
|
|
||
| output := out.String() | ||
|
|
||
| assert.Contains(t, output, "done") | ||
| assert.Contains(t, output, fakeDigest.Encoded()[:12]) | ||
| assert.Equal(t, 2, strings.Count(output, "\n"), "expected 2 lines: one read, one Done") | ||
| assert.Contains(t, output, "5MiB", "progress line should show current offset, not total") | ||
| } | ||
|
|
||
| func TestProgressConsumerSkipped(t *testing.T) { | ||
| ch := make(chan types.ProgressProperties, 4) | ||
| var out bytes.Buffer | ||
|
|
||
| fakeDigest := digest.FromString("cached-blob") | ||
|
|
||
| ch <- types.ProgressProperties{ | ||
| Event: types.ProgressEventNewArtifact, | ||
| Artifact: types.BlobInfo{ | ||
| Digest: fakeDigest, | ||
| Size: 1024, | ||
| }, | ||
| } | ||
| ch <- types.ProgressProperties{ | ||
| Event: types.ProgressEventSkipped, | ||
| Artifact: types.BlobInfo{Digest: fakeDigest}, | ||
| } | ||
| close(ch) | ||
|
|
||
| runProgressConsumer(ch, 30*time.Second, &out) | ||
|
|
||
| assert.Empty(t, out.String(), "skipped blobs should produce no output") | ||
| } | ||
|
|
||
| func TestProgressConsumerUnknownSize(t *testing.T) { | ||
| ch := make(chan types.ProgressProperties, 4) | ||
| var out bytes.Buffer | ||
|
|
||
| fakeDigest := digest.FromString("mystery-blob") | ||
|
|
||
| ch <- types.ProgressProperties{ | ||
| Event: types.ProgressEventNewArtifact, | ||
| Artifact: types.BlobInfo{ | ||
| Digest: fakeDigest, | ||
| Size: -1, | ||
| }, | ||
| } | ||
| ch <- types.ProgressProperties{ | ||
| Event: types.ProgressEventRead, | ||
| Artifact: types.BlobInfo{ | ||
| Digest: fakeDigest, | ||
| Size: -1, | ||
| }, | ||
| Offset: 512, | ||
| OffsetUpdate: 512, | ||
| } | ||
| close(ch) | ||
|
|
||
| runProgressConsumer(ch, 30*time.Second, &out) | ||
|
|
||
| assert.Contains(t, out.String(), "?", "unknown size should render as '?'") | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don’t see where
stderrfigures in this logic at all. Is that just due toresolveProgressIntervaldeciding based on that?ReportWritercontains quite a bit of other information, not just blob progress, so completely turning it off is not great.