chore: improve text output for resource check (#41)

jawnsy · web-flow · commit 4c634c0de582 · 2021-09-23T06:31:17.000-07:00
* Remove the synthetic error and create a failed result manually
* Add the resource, group, and groupVersion in Details, so that
  it will be included in JSON output
diff --git a/internal/checks/kube/resources.go b/internal/checks/kube/resources.go
@@ -4,7 +4,6 @@ import (
 	"context"
 	"fmt"
 
-	"golang.org/x/xerrors"
 	"k8s.io/apimachinery/pkg/runtime/schema"
 
 	"cdr.dev/coder-doctor/internal/api"
@@ -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
diff --git a/internal/checks/kube/resources_test.go b/internal/checks/kube/resources_test.go
@@ -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)
 				}
@@ -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)
 				}
 			},
 		},
