[V6] Add some report-status and send-pack tests #1536
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
There was a problem hiding this comment.
Pull Request Overview
This PR adds new tests for the report-status feature in the SendPack routine and improves error messaging in pktline parsing while introducing typed errors for report-status failures.
- Added tests for buildUpdateRequests covering various capability combinations.
- Introduced UnpackStatusErr and CommandStatusErr types for more informative error messages.
- Updated error messages in pktline write/read functions and hex length parsing for clarity.
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| plumbing/transport/build_update_requests_test.go | New test cases to validate capabilities for report-status, progress, atomic, and agent. |
| plumbing/protocol/packp/sideband/demux.go | Added check for empty pktline content with an explicit error. |
| plumbing/protocol/packp/report_status_test.go | Extended tests to cover failed command status errors and unpack with failed commands. |
| plumbing/protocol/packp/report_status.go | Refactored error message generation using new error types for unpack/command status errors. |
| plumbing/format/pktline/pktline.go | Updated Writef and Read functions to leverage new fmt.Appendf syntax and improved error text. |
| plumbing/format/pktline/length.go | Changed error messages for hex decoding related to pktline length. |
| plumbing/format/pktline/common.go | Minimal change in import structure. |
| internal/transport/test/receive_pack.go | Removed outdated test assertions tied to report-status in the SendPack tests. |
| if err == io.ErrUnexpectedEOF { | ||
| return Err, ErrInvalidPktLen | ||
| if errors.Is(err, io.ErrUnexpectedEOF) { | ||
| return Err, fmt.Errorf("%w: short pkt-line %q", ErrInvalidPktLen, len(p[:LenSize])) |
There was a problem hiding this comment.
The use of %q to format an integer (the length) may be confusing. Consider using a format specifier appropriate for integers (e.g., %d or %04x) to improve clarity in the error message.
Suggested change
| return Err, fmt.Errorf("%w: short pkt-line %q", ErrInvalidPktLen, len(p[:LenSize])) | |
| return Err, fmt.Errorf("%w: short pkt-line %d", ErrInvalidPktLen, len(p[:LenSize])) |
Copilot uses AI. Check for mistakes.
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.
This adds a new few tests for
report-statusduring theSendPackroutine. It also adds more informativepktlineerror messages, and typedreport-statuserrors.