Improve checksum package and increase its test coverage
#593
Conversation
This file contains 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
cthulhu-rider
requested review from
roman-khimov,
smallhive and
carpawell
as code owners
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #593 +/- ##
==========================================
+ Coverage 39.47% 39.56% +0.08%
==========================================
Files 147 147
Lines 17494 17496 +2
==========================================
+ Hits 6906 6922 +16
+ Misses 10213 10198 -15
- Partials 375 376 +1 ☔ View full report in Codecov by Sentry. |
carpawell
reviewed
Jul 8, 2024
checksum/checksum.go
Outdated
| @@ -123,6 +119,7 @@ func Calculate(c *Checksum, t Type, v []byte) { | |||
| case TZ: | |||
| c.SetTillichZemor(tz.Sum(v)) | |||
| default: | |||
| panic(fmt.Errorf("unsupported checksum type %v", t)) | |||
There was a problem hiding this comment.
i am not sure it is good. we have discussed panics in SDK and i thought we do not use them anymore. if a wrong scheme must be (really?) noticed, i would prefer an error
There was a problem hiding this comment.
panics are better than hidden bugs. We discussed this for functions which return an error. I'll make NewFromData to return an error
done
There was a problem hiding this comment.
ok, i reopened this issue with some my thoughts: #390 (comment)
cthulhu-rider
force-pushed
the
checksum
branch
2 times, most recently
from
0a79ae2
to
101f214
Compare
carpawell
approved these changes
Jul 9, 2024
It teaches what a regular user should be freed from. Signed-off-by: Leonard Lyubich <[email protected]>
`Checksum` type instances are very lightweight, so setters do not provide much benefit while forcing user to explicitly declare a new var. It was also no convenient way to create an instance from stdlib `hash.Hash`. From now `Checksum` can be instantiated with less code using set of new constructors. Old functions are marked as deprecated. Refs #483. Signed-off-by: Leonard Lyubich <[email protected]>
Vary not only the value but also the type. Signed-off-by: Leonard Lyubich <[email protected]>
Previously, `Checksum.Type` method returned any unsupported value as zero. This led to a kind of value loss and the impossibility of forward compatibility - although at the type level it is possible. From now method returns underlying numeric value for unknown enum values. The stringer now also does not fallback. `Unknown` constant is no longer needed and deprecated. Signed-off-by: Leonard Lyubich <[email protected]>
Previously, protocol conversion method `Checksum.ReadFromV2` failed on any unsupported enum value. This didn't make much sense since type getter is provided, so callers can decide for themselves. From now method ignores checksum type. Signed-off-by: Leonard Lyubich <[email protected]>
Signed-off-by: Leonard Lyubich <[email protected]>
Signed-off-by: Leonard Lyubich <[email protected]>
Unlike SHA-256, this hash function is not so widely known. Signed-off-by: Leonard Lyubich <[email protected]>
resolved |
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.
No description provided.