chore(health): adding health check tests

[Jacobbrewer1]

Describe your changes

This pull request includes several changes to the health check system to improve context handling, error handling, and testing. The most important changes include adding context checks, improving error handling for invalid statuses, and enhancing the test coverage.

Context Handling Improvements:

• health/check.go: Added a check to ensure ctx is not nil and set it to context.Background() if it is. [1] [2]
• health/checker.go: Added a check to ensure ctx is not nil and set it to context.Background() if it is.

Error Handling Enhancements:

• health/check.go: Added validation to ensure statusErr.Status is valid, setting it to StatusUnknown if it is not.
• health/status.go: Modified MarshalJSON to return an error for invalid statuses.

Test Coverage Enhancements:

• health/check_test.go: Added new tests for no timeout and no parent context scenarios.
• health/checker_test.go: Added new tests for status errors and no parent context scenarios. [1] [2]
• health/result_test.go: Added a new test to ensure addDetail initializes the details map if it is nil.
• health/status_test.go: Added a new test to validate error handling in MarshalJSON for invalid statuses.

Code Simplification:

• health/result.go: Changed Details map to use pointers to Result to simplify memory management. [1] [2] [3]
• health/time.go: Renamed Timestamp to timestamp to follow Go naming conventions for unexported variables.

Documentation:

• health/check_options.go: Added documentation for WithNoCheckTimeout function.

[Copilot]

Copilot reviewed 11 out of 11 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (2)

health/status_test.go:54

• When testing invalid statuses, the error message should indicate that an error is expected rather than stating 'should not return an error'. Consider updating the message to accurately reflect the expected behavior.

require.Equal(t, tt.wantErr, err, "MarshalJSON() should not return an error")

health/checker_test.go:76

• The error message is misleading: while the expected HTTP status is ServiceUnavailable, the message indicates 200 OK. Please update the message to accurately reflect the expected status code.

require.Equal(t, http.StatusServiceUnavailable, rec.Code, "Handler() should return a 200 OK status code")

[Copilot]

Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.

[Copilot]

Copilot reviewed 11 out of 11 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (2)

health/status_test.go:46

• Verify that the error message produced by MarshalJSON for an invalid status exactly matches the expected error message in the test. If the Status type's String() method returns a numeric value (e.g. "999") rather than "invalid", adjust either the test or the error formatting accordingly.

wantErr: errors.New("invalid is not a valid status"),

health/response.go:1

• Ensure that the removal of the health/response.go file does not leave any dangling references elsewhere in the codebase, which could lead to runtime issues.

package health

[github-actions]

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.