Skip to content

chore: make error of non-existed source OCI layout more readable#1176

Merged
sajayantony merged 7 commits into
oras-project:mainfrom
qweeah:improve-error
Nov 10, 2023
Merged

chore: make error of non-existed source OCI layout more readable#1176
sajayantony merged 7 commits into
oras-project:mainfrom
qweeah:improve-error

Conversation

@qweeah

@qweeah qweeah commented Nov 6, 2023 •
edited
Loading

Copy link
Copy Markdown
Contributor

What this PR does / why we need it:
This PR improves error message for OCI layout.

  • If the provided path doesn't exist

    • Before:
    ➜  oras cp --from-oci-layout foo:bar localhost:5000/test:copied
Error: stat foo: no such file or directory
    • After:
    ➜  oras cp --from-oci-layout foo:bar localhost:5000/test:copied
Error: invalid path in "foo:bar": stat foo: no such file or directory

  • If the provided path is a file but not a tarfile

    • Before:
    ➜  oras cp --from-oci-layout foo:bar localhost:5000/test:copied
Error: unexpected EOF
    • After:
    ➜  oras cp --from-oci-layout foo:bar localhost:5000/test:copied
Error: file "foo" is not a valid tarball: unexpected EOF

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 #1156

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 Nov 6, 2023 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

Merging #1176 (aafb5c0) into main (ceb3b00) will decrease coverage by 0.18%.
The diff coverage is 0.00%.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

@@            Coverage Diff             @@
##             main    #1176      +/-   ##
==========================================
- Coverage   80.05%   79.87%   -0.18%     
==========================================
  Files          65       65              
  Lines        3564     3572       +8     
==========================================
  Hits         2853     2853              
- Misses        495      503       +8     
  Partials      216      216
Files Coverage Δ
cmd/oras/internal/option/target.go 78.30% <0.00%> (-6.40%) ⬇️

shizhMSFT
shizhMSFT reviewed Nov 6, 2023
View reviewed changes
Comment thread cmd/oras/internal/option/target.go Outdated
qweeah added 4 commits November 7, 2023 05:09
@qweeah
chore: make error of non-existed source OCI layout more readable
6474917 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
rephrase
84d2f20 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
rephrase
91a4897 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
handle invalid tarball
6867eff 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
shizhMSFT
shizhMSFT reviewed Nov 8, 2023
View reviewed changes
Comment thread cmd/oras/internal/option/target.go Outdated
Comment thread cmd/oras/internal/option/target.go Outdated
Comment thread cmd/oras/internal/option/target.go Outdated
Comment thread cmd/oras/internal/option/target.go Outdated
Comment thread cmd/oras/internal/option/target.go Outdated
qweeah added 2 commits November 9, 2023 02:22
@qweeah
Merge branch 'main' into improve-error
5bb9ce5
@qweeah
resolve comment
aafb5c0 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
TerryHowe
TerryHowe approved these changes Nov 9, 2023
View reviewed changes

@TerryHowe TerryHowe left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

/lgtm

shizhMSFT
shizhMSFT approved these changes Nov 10, 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

@sajayantony sajayantony merged commit 787d573 into oras-project:main Nov 10, 2023
@qweeah qweeah mentioned this pull request Feb 1, 2024
Merged
FeynmanZhou pushed a commit to FeynmanZhou/oras that referenced this pull request May 11, 2024
@qweeah @sajayantony @FeynmanZhou
chore: make error of non-existed source OCI layout more readable (ora…
29d3888 
…s-project#1176)

Signed-off-by: Billy Zha <jinzha1@microsoft.com>
Co-authored-by: Sajay Antony <sajaya@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@TerryHowe TerryHowe TerryHowe approved these changes

@sajayantony sajayantony sajayantony approved these changes

@shizhMSFT shizhMSFT shizhMSFT approved these changes

@SteveLasker SteveLasker Awaiting requested review from SteveLasker

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

add reference details to output errors

5 participants

@qweeah @codecov-commenter @TerryHowe @sajayantony @shizhMSFT