chore(ux): improve copy error message #1773
Merged
Conversation
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
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
2ce7602 to
fc78ff8
Compare
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1773 +/- ##
==========================================
+ Coverage 85.43% 85.54% +0.11%
==========================================
Files 137 137
Lines 5966 5993 +27
==========================================
+ Hits 5097 5127 +30
+ Misses 618 615 -3
Partials 251 251 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
qweeah
reviewed
Jul 11, 2025
qweeah
reviewed
Jul 11, 2025
qweeah
reviewed
Jul 11, 2025
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
3e8f0f1 to
028e13b
Compare
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
This reverts commit bbd116c. Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
This reverts commit df2dd33. Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
qweeah
approved these changes
Jul 14, 2025
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
There was a problem hiding this comment.
Pull Request Overview
This PR improves error messages across multiple ORAS commands to provide clearer and more user-friendly feedback. The changes focus on optimizing error message formatting for oras cp, registry error responses, and path traversal errors.
Key changes include:
- Improved error message prefixes for copy operations to specify source/destination registry context
- Removed the "recognizable error message not found:" prefix from registry error responses
- Enhanced path traversal error messages with clearer user guidance
Reviewed Changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| cmd/oras/internal/errors/errors.go | Replaces TrimErrResp with ReportErrResp and adds UnwrapCopyError function |
| cmd/oras/internal/option/target.go | Updates error handling method from Modify to ModifyError with improved logic |
| cmd/oras/internal/option/remote.go | Updates method name and uses new ReportErrResp function |
| cmd/oras/internal/option/binary_target.go | Adds comprehensive copy error handling with specific prefixes |
| cmd/oras/root/pull.go | Enhances path traversal error with user-friendly recommendation |
| cmd/oras/root/push.go | Unwraps copy errors to remove unnecessary context |
| cmd/oras/root/cp.go | Preserves copy error context for proper prefix processing |
| cmd/oras/root/attach.go | Unwraps copy errors to remove unnecessary context |
| test/e2e/internal/utils/const.go | Removes EmptyBodyPrefix constant |
| test/e2e/suite/command/resolve.go | Updates test to remove empty body prefix |
| test/e2e/suite/command/cp.go | Updates test expectations for new error format |
| test/e2e/suite/auth/auth.go | Restructures tests and adds new test for modified error prefix |
| cmd/oras/internal/option/target_test.go | Updates all test method names from Modify to ModifyError |
| cmd/oras/internal/option/binary_target_test.go | Adds comprehensive tests for copy error handling |
| cmd/oras/internal/errors/errors_test.go | Adds tests for new ReportErrResp and UnwrapCopyError functions |
Comments suppressed due to low confidence (2)
test/e2e/suite/auth/auth.go:37
- The removal of the copy command test from this location should be verified to ensure equivalent test coverage exists elsewhere. The copy command appears to be covered by the new test below, but this should be confirmed.
RunWithoutLogin("attach", ZOTHost+"/repo:tag", "-a", "test=true", "--artifact-type", "doc/example", "--registry-config", authConfigPath)
test/e2e/suite/auth/auth.go:63
- The removal of push and pull commands from the invalid credentials test reduces test coverage. These commands should be tested elsewhere or the removal should be justified.
RunWithInvalidCreds("attach", ZOTHost+"/repo:tag", "-a", "test=true", "--artifact-type", "doc/example")
This was referenced Aug 7, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What this PR does / why we need it:
oras cpBefore:
After
oras loginandoras lsBefore:
After ("recognizable error message not found" is removed):
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 #1469
Please check the following list: