Thanks to visit codestin.com
Credit goes to github.com

Skip to content

fix(codersdk/healthsdk): update docs url path for health errors #16180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 17, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 30 additions & 5 deletions codersdk/healthsdk/healthsdk_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ func TestSummarize(t *testing.T) {
name string
br healthsdk.BaseReport
pfx string
docsURL string
expected []string
}{
{
Expand Down Expand Up @@ -93,9 +94,9 @@ func TestSummarize(t *testing.T) {
expected: []string{
"Error: testing",
"Warn: TEST01: testing one",
"See: https://coder.com/docs/admin/healthcheck#test01",
"See: https://coder.com/docs/admin/monitoring/health-check#test01",
"Warn: TEST02: testing two",
"See: https://coder.com/docs/admin/healthcheck#test02",
"See: https://coder.com/docs/admin/monitoring/health-check#test02",
},
},
{
Expand All @@ -117,16 +118,40 @@ func TestSummarize(t *testing.T) {
expected: []string{
"TEST: Error: testing",
"TEST: Warn: TEST01: testing one",
"See: https://coder.com/docs/admin/healthcheck#test01",
"See: https://coder.com/docs/admin/monitoring/health-check#test01",
"TEST: Warn: TEST02: testing two",
"See: https://coder.com/docs/admin/healthcheck#test02",
"See: https://coder.com/docs/admin/monitoring/health-check#test02",
},
},
{
name: "custom docs url",
br: healthsdk.BaseReport{
Error: ptr.Ref("testing"),
Warnings: []health.Message{
{
Code: "TEST01",
Message: "testing one",
},
{
Code: "TEST02",
Message: "testing two",
},
},
},
docsURL: "https://my.coder.internal/docs",
expected: []string{
"Error: testing",
"Warn: TEST01: testing one",
"See: https://my.coder.internal/docs/admin/monitoring/health-check#test01",
"Warn: TEST02: testing two",
"See: https://my.coder.internal/docs/admin/monitoring/health-check#test02",
},
},
} {
tt := tt
t.Run(tt.name, func(t *testing.T) {
t.Parallel()
actual := tt.br.Summarize(tt.pfx, "")
actual := tt.br.Summarize(tt.pfx, tt.docsURL)
if len(tt.expected) == 0 {
assert.Empty(t, actual)
return
Expand Down
Loading