Skip to content

feat: support progressed output in blob push and blob get#1113

Merged
qweeah merged 80 commits into
oras-project:mainfrom
qweeah:progress-bar-reader
Oct 13, 2023
Merged

feat: support progressed output in blob push and blob get#1113
qweeah merged 80 commits into
oras-project:mainfrom
qweeah:progress-bar-reader

Conversation

@qweeah

@qweeah qweeah commented Sep 11, 2023 •
edited
Loading

Copy link
Copy Markdown
Contributor

What this PR does / why we need it:
This PR introduces terminal output for certain oras commands.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #893

Please check the following list:

  • Does the affected code have corresponding tests, e.g. unit test, E2E test?
  • Does this change require a documentation update?
  • Does this introduce breaking changes that would require an announcement or bumping the major version?
  • Do all new files have an appropriate license header?

@codecov-commenter

codecov-commenter commented Sep 11, 2023 •
edited by codecov Bot
Loading

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 81.71021% with 77 lines in your changes missing coverage. Please review.

Project coverage is 80.78%. Comparing base (20c06d6) to head (edf7ab8).
Report is 238 commits behind head on main.

Files with missing lines Patch % Lines
cmd/oras/internal/display/progress/manager.go 78.48% 13 Missing and 4 partials ⚠️
cmd/oras/root/blob/fetch.go 62.22% 11 Missing and 6 partials ⚠️
cmd/oras/internal/display/track/reader.go 73.33% 8 Missing and 4 partials ⚠️
...as/internal/display/console/testutils/testutils.go 70.00% 6 Missing and 3 partials ⚠️
cmd/oras/root/blob/push.go 68.96% 6 Missing and 3 partials ⚠️
cmd/oras/internal/display/progress/status.go 95.08% 4 Missing and 2 partials ⚠️
...d/oras/internal/display/progress/humanize/bytes.go 80.95% 3 Missing and 1 partial ⚠️
cmd/oras/internal/display/console/console.go 91.42% 2 Missing and 1 partial ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1113      +/-   ##
==========================================
+ Coverage   80.06%   80.78%   +0.72%     
==========================================
  Files          57       64       +7     
  Lines        2994     3372     +378     
==========================================
+ Hits         2397     2724     +327     
- Misses        412      447      +35     
- Partials      185      201      +16

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@qweeah qweeah force-pushed the progress-bar-reader branch from 753b47e to 4c5e2f1 Compare September 12, 2023 07:06
@qweeah
feat: support progressed output in blob push and blob get
b088f2b 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah qweeah force-pushed the progress-bar-reader branch from 4c5e2f1 to b088f2b Compare September 12, 2023 07:06
qweeah added 11 commits September 19, 2023 08:20
@qweeah
add error when --debug is used with terminal output
e773471 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
bug fix
6044594 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
Merge branch 'main' into progress-bar-reader
b5d89dd
@qweeah
add test for console
6324b93 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
fix lint & pass tty to manager
f1077bd 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
Merge branch 'main' into progress-bar-reader
4c362f8
@qweeah
rename flag to disable tty
941188f 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
add test for blob push
c72ebe5 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
fix render racing
5fc75a8 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
fix race
a2d3f8c 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
add test for blob fetch
4a065fe 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah qweeah marked this pull request as ready for review September 21, 2023 08:28
shizhMSFT
shizhMSFT reviewed Sep 22, 2023
View reviewed changes
Comment thread cmd/oras/internal/display/console/console.go Outdated
Comment thread cmd/oras/internal/display/console/console.go Outdated
Comment thread cmd/oras/internal/display/console/console.go Outdated
Comment thread cmd/oras/internal/display/console/console.go Outdated
Comment thread cmd/oras/internal/display/console/console.go Outdated
Comment thread cmd/oras/internal/display/progress/manager.go Outdated
Comment thread cmd/oras/internal/display/progress/manager.go Outdated
Comment thread cmd/oras/internal/display/progress/mark.go Outdated
Comment thread cmd/oras/internal/display/progress/manager.go
@qweeah
resolve comment
00ca2fc 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
resolve comment
c85e809 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
resolve comment
997a63e 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
fix lint
144e907 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
refactor spinner mark
1b1f23c 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
refactor: improve manager and status
008a61d 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
add error for manager functions
95ad473 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
remove unnecessary lock
ed84a69 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
update reader naming
47ef494 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
qweeah added 2 commits October 9, 2023 05:59
@qweeah
bug fix
4f7ac01 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
reset render interval to 200ms
c47f967 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
shizhMSFT
shizhMSFT reviewed Oct 10, 2023
View reviewed changes
Comment thread cmd/oras/internal/display/progress/humanize.go
Comment thread cmd/oras/internal/display/progress/humanize.go Outdated
Comment thread cmd/oras/internal/display/progress/humanize.go Outdated
Comment thread cmd/oras/internal/display/progress/humanize.go
Comment thread cmd/oras/internal/display/console/testutils/testutils.go
Comment thread cmd/oras/internal/display/progress/status.go
Comment thread cmd/oras/internal/display/track/reader.go Outdated
Comment thread cmd/oras/internal/option/common.go Outdated
Comment thread cmd/oras/root/blob/fetch.go Outdated
Comment thread cmd/oras/root/blob/push.go Outdated
qweeah added 16 commits October 10, 2023 11:45
@qweeah
turn humanize into package
2489a61 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
bug fix
9e7daec 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
rename pts device
c4564fe 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
Merge remote-tracking branch 'origin_src/main' into progress-bar-reader
167adb1
@qweeah
reduce buffer size
6c324d1 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
fix typo
d4298c1 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
change switch to if-else
67574dd 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
bug fix
25d8935 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
change switch to if-else
c76c464 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
revert rendering
9403cca 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
reduce buffer size to 1
0741396 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
fix: enable pipe when output to stdout
c5ab1ee 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
fix display bug
6611186 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
revert change
e858d1a 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
fix bug
e4d4439 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
resolve comment
6f36708 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
shizhMSFT
shizhMSFT reviewed Oct 13, 2023
View reviewed changes
Comment thread cmd/oras/root/blob/push.go
Comment thread cmd/oras/internal/display/progress/status.go Outdated
Comment thread cmd/oras/root/blob/fetch.go Outdated
qweeah added 7 commits October 13, 2023 07:53
@qweeah
fix nit
45aad11 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
apply comment
9e7f876 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
resolve comments
57c29f2 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
udpate last render time
7c8b2d7 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
resolve comments
932c5d5 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
Merge remote-tracking branch 'origin_src/main' into progress-bar-reader
223eede
@qweeah
code clean
edf7ab8 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
shizhMSFT
shizhMSFT approved these changes Oct 13, 2023
View reviewed changes

@shizhMSFT shizhMSFT left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@qweeah qweeah merged commit f9bb6d8 into oras-project:main Oct 13, 2023
@qweeah qweeah mentioned this pull request Feb 1, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@FeynmanZhou FeynmanZhou FeynmanZhou left review comments

@shizhMSFT shizhMSFT shizhMSFT approved these changes

@sajayantony sajayantony Awaiting requested review from sajayantony sajayantony is a code owner

@SteveLasker SteveLasker Awaiting requested review from SteveLasker

@TerryHowe TerryHowe Awaiting requested review from TerryHowe TerryHowe is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Show progress bar when downloading or pushing content from/to a registry

4 participants

@qweeah @codecov-commenter @shizhMSFT @FeynmanZhou