fixed github issue 3821 for string shannon entropy test #3824
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
ahrav
approved these changes
Dec 30, 2024
pkg/detectors/falsepositives_test.go
Outdated
| @@ -173,7 +174,8 @@ func TestStringShannonEntropy(t *testing.T) { | |||
| } | |||
| for _, tt := range tests { | |||
| t.Run(tt.name, func(t *testing.T) { | |||
| if got := StringShannonEntropy(tt.args.input); got != tt.want { | |||
| got := roundToTwoDigits(StringShannonEntropy(tt.args.input)) | |||
There was a problem hiding this comment.
suggestion: I think we can rely on our testing package (testify) to handle most of the heavy lifting here.
Ex:
got := StringShannonEntropy(tt.args.input)
if len(tt.args.input) > 0 && tt.want != 0 {
assert.InEpsilon(t, tt.want, got, 0.1)
} else {
assert.Equal(t, tt.want, got)
}
There was a problem hiding this comment.
That's cool! I didn't know about InEpsilon. Thanks for sharing. I updated the PR.
There was a problem hiding this comment.
I only just learned about it last week too. 😅
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.
Description:
This issue fixes the issue #3821 by rounding the output of shannon entropy output to two digits to avoid unnecessary precision.
Checklist:
make test-community)?make lintthis requires golangci-lint)?