Included tests for internal/signalio/json.go #306
Conversation
- Included tests for internal/signalio/json.go - Removed un-necessary error check Signed-off-by: nathannaveen <[email protected]>
nathannaveen
force-pushed
the
nathan/feat/signalio/jsonTest
branch
from
ab4fffb
to
d523bf1
Compare
|
I have removed: criticality_score/internal/signalio/json.go Lines 54 to 57 in b148d93 I have replaced it with: I replaced this part because |
| type mockWriterJSON struct{} | ||
|
|
||
| func (m *mockWriterJSON) Write(p []byte) (n int, err error) { | ||
| return 0, nil | ||
| } |
There was a problem hiding this comment.
Use a bytes.Buffer to avoid needing to implement the io.Writer interface.
It also allows you to inspect what was written.
| signals []signal.Set | ||
| extra []Field | ||
| } | ||
| test := struct { |
There was a problem hiding this comment.
May I suggest restructuring these tests into the following the test functions as it isn't really clear what this function is trying to test:
- An end-to-end style test that:
- creates the writer with a
bytes.Buffer. - passes in test data for all the parameters.
- checks the output matches a JSON string (e.g.
want := "{...}").
- A test that checks a writer error with a
io.Writerimplementation that always returns an error (likeiotest.ErrReader, but an equivalent forio.Writerdoesn't exist). - (Optional) a test that exercises encoding errors.
These should ideally not contain the test struct building at the start as it isn't really necessary.
| return fmt.Errorf("failed to get map for namespace: %s", ns) | ||
| } | ||
| nsData := d.(map[string]any) | ||
| // we don't need to check for an error here (the above line) because d is always a map[string]any |
There was a problem hiding this comment.
Might be worth extending the comment to say that "if this fails in the future the assignment to nsData below will fail"
Signed-off-by: nathannaveen [email protected]