opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix broken links (#16179)

Browse Source 
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
Co-authored-by: Cian Johnston <cian@coder.com>
This commit is contained in:
Edward Angert
2025-01-17 13:18:48 -05:00
committed by GitHub
co-authored by EdwardAngert Cian Johnston
parent f34e6fd92c
commit 4f438e71cf
6 changed files with 46 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
codersdk/healthsdk/healthsdk_test.go
+36 -11
View File
@@ -41,22 +41,22 @@ func TestSummarize(t *testing.T) {
expected := []string{
"Access URL: Error: test error",
"Access URL: Warn: TEST: testing",
"See: https://coder.com/docs/admin/healthcheck#test",
"See: https://coder.com/docs/admin/monitoring/health-check#test",
"Database: Error: test error",
"Database: Warn: TEST: testing",
"See: https://coder.com/docs/admin/healthcheck#test",
"See: https://coder.com/docs/admin/monitoring/health-check#test",
"DERP: Error: test error",
"DERP: Warn: TEST: testing",
"See: https://coder.com/docs/admin/healthcheck#test",
"See: https://coder.com/docs/admin/monitoring/health-check#test",
"Provisioner Daemons: Error: test error",
"Provisioner Daemons: Warn: TEST: testing",
"See: https://coder.com/docs/admin/healthcheck#test",
"See: https://coder.com/docs/admin/monitoring/health-check#test",
"Websocket: Error: test error",
"Websocket: Warn: TEST: testing",
"See: https://coder.com/docs/admin/healthcheck#test",
"See: https://coder.com/docs/admin/monitoring/health-check#test",
"Workspace Proxies: Error: test error",
"Workspace Proxies: Warn: TEST: testing",
"See: https://coder.com/docs/admin/healthcheck#test",
"See: https://coder.com/docs/admin/monitoring/health-check#test",
}
actual := hr.Summarize("")
assert.Equal(t, expected, actual)
@@ -66,6 +66,7 @@ func TestSummarize(t *testing.T) {
name string
br healthsdk.BaseReport
pfx string
docsURL string
expected []string
}{
{
@@ -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",
},
},
{
@@ -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