Added Utils unit tests - envelope and crypto #103
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
Effi-S
commented
Aug 7, 2025
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive unit tests for two utility modules - envelope wrapper and crypto - while adding nil checks for improved error handling. The changes enhance test coverage for cryptographic key serialization/parsing functions and envelope wrapping/unwrapping operations.
- Added nil input validation to crypto functions with corresponding error messages
- Created comprehensive test suites covering both valid and invalid input scenarios
- Refactored envelope wrapper to separate payload wrapping from full envelope wrapping
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| utils/signature/sigtest/crypto_test.go | New comprehensive test suite for crypto functions with edge cases |
| utils/signature/sigtest/crypto.go | Added nil check for signing key serialization |
| utils/serialization/envelope_wrapper_test.go | New test suite for envelope operations with error scenarios |
| utils/serialization/envelope_wrapper.go | Added nil header validation and refactored envelope wrapping |
| } | ||
|
|
||
| // WrapEnvelope wraps a payload with its header and returns an envelope. | ||
| func WrapEnvelope(data []byte, header *common.Header) []byte { |
There was a problem hiding this comment.
minor:
Suggested change
| func WrapEnvelope(data []byte, header *common.Header) []byte { | |
| func WrapEnvelope(serializedPayload []byte, header *common.Header) []byte { |
Comment on lines
+59
to
+65
| header := &common.Header{ | ||
| ChannelHeader: []byte("not-a-channel-header"), | ||
| } | ||
| payload := &common.Payload{ | ||
| Header: header, | ||
| Data: []byte("some data"), | ||
| } |
There was a problem hiding this comment.
Suggested change
| header := &common.Header{ | |
| ChannelHeader: []byte("not-a-channel-header"), | |
| } | |
| payload := &common.Payload{ | |
| Header: header, | |
| Data: []byte("some data"), | |
| } | |
| payload := &common.Payload{ | |
| Header: &common.Header{ | |
| ChannelHeader: []byte("not-a-channel-header"), | |
| }, | |
| Data: []byte("some data"), | |
| } |
| }, | ||
|
|
||
| // { | ||
| // // TODO: find an invalid example? |
Comment on lines
67
to
71
| defer func() { | ||
| if r := recover(); r != nil { | ||
| t.Errorf("SerializeSigningKey() panics: %v", r) | ||
| } | ||
| }() |
| } | ||
| } | ||
|
|
||
| func TestSerializeSigningKey(t *testing.T) { |
There was a problem hiding this comment.
major: missing t.Parallel()
Comment on lines
+35
to
+37
| if key == nil { | ||
| return nil, errors.New("key is nil") | ||
| } |
There was a problem hiding this comment.
major: Also add this check to SerializeVerificationKey()
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func TestSerializeVerificationKey(t *testing.T) { |
There was a problem hiding this comment.
I suggest merging both tests (verification and serialization) and covering all test cases (including errors).
Signed-off-by: Effi-S <effi.szt@gmail.com>
Signed-off-by: Effi-S <effi.szt@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Effi-S <57197982+Effi-S@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Effi-S <57197982+Effi-S@users.noreply.github.com>
Signed-off-by: Effi-S <effi.szt@gmail.com>
…ad2a514477b29d5e1229160034bc7345b03b2f539e5de01746 Signed-off-by: Effi-S <effi.szt@gmail.com>
Effi-S
force-pushed
the
utils-unit-test2
branch
from
7e6c2fc to
914f0f8
Compare
Signed-off-by: Effi-S <effi.szt@gmail.com>
Signed-off-by: Effi-S <effi.szt@gmail.com>
…ializeAndParseSigningKey Signed-off-by: Effi-S <effi.szt@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Type of change
Description
envelope: nil checks + unit tests + minor refactorcrypto: nil checka + unit testsRelated issues