Skip to content
This repository was archived by the owner on Nov 14, 2024. It is now read-only.

chore: improve text output for resource check #41

Merged
merged 2 commits into from
Sep 23, 2021
Merged

chore: improve text output for resource check #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4edd92d
chore: improve text output for resource check
jawnsy Sep 23, 2021
1874d4f
update unit tests
jawnsy Sep 23, 2021
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
24 changes: 16 additions & 8 deletions internal/checks/kube/resources.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import (
"context"
"fmt"

"golang.org/x/xerrors"
"k8s.io/apimachinery/pkg/runtime/schema"

"cdr.dev/coder-doctor/internal/api"
Expand Down Expand Up @@ -46,14 +45,23 @@ func (k *KubernetesChecker) CheckResources(_ context.Context) []*api.CheckResult
}

for versionReq := range k.reqs.ResourceRequirements {
if !resourcesAvailable[*versionReq] {
msg := fmt.Sprintf("missing required resource:%q group:%q version:%q", versionReq.Resource, versionReq.Group, versionReq.Version)
errResult := api.ErrorResult(checkName, msg, xerrors.New(msg))
results = append(results, errResult)
continue
result := &api.CheckResult{
Summary: checkName,
Details: map[string]interface{}{
"resource": versionReq.Resource,
"group": versionReq.Group,
"groupVersion": versionReq.Version,
},
}

if resourcesAvailable[*versionReq] {
result.Summary = fmt.Sprintf("Cluster supports %s resource %s", versionReq.Version, versionReq.Resource)
result.State = api.StatePassed
} else {
result.Summary = fmt.Sprintf("Cluster does not support %s resource %s", versionReq.Version, versionReq.Resource)
result.State = api.StateFailed
}
msg := fmt.Sprintf("found required resource:%q group:%q version:%q", versionReq.Resource, versionReq.Group, versionReq.Version)
results = append(results, api.PassResult(checkName, msg))
results = append(results, result)
}

return results
Expand Down
10 changes: 6 additions & 4 deletions internal/checks/kube/resources_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ func Test_KubernetesChecker_CheckResources(t *testing.T) {
F: func(t *testing.T, results []*api.CheckResult) {
assert.False(t, "results should not be empty", len(results) == 0)
for _, result := range results {
assert.False(t, result.Name+" should have a resource", len(result.Details["resource"].(string)) == 0)
assert.False(t, result.Name+" should have a groupVersion", len(result.Details["groupVersion"].(string)) == 0)
assert.Equal(t, result.Name+" should have no error", nil, result.Details["error"])
assert.Equal(t, result.Name+" should pass", api.StatePassed, result.State)
}
Expand All @@ -40,10 +42,10 @@ func Test_KubernetesChecker_CheckResources(t *testing.T) {
F: func(t *testing.T, results []*api.CheckResult) {
assert.False(t, "results should not be empty", len(results) == 0)
for _, result := range results {
resErr, ok := result.Details["error"].(error)
assert.True(t, result.Name+" should have an error", ok && resErr != nil)
assert.ErrorContains(t, result.Name+" should have an expected error", resErr, "missing required resource")
assert.True(t, result.Name+" should fail", result.State == api.StateFailed)
assert.False(t, result.Name+" should have a resource", len(result.Details["resource"].(string)) == 0)
assert.False(t, result.Name+" should have a groupVersion", len(result.Details["groupVersion"].(string)) == 0)
assert.Equal(t, result.Name+" should have no error", nil, result.Details["error"])
assert.Equal(t, result.Name+" should pass", api.StateFailed, result.State)
}
},
},
Expand Down