commands/.../scorecard/test_definitions: add some godoc

Author: AlexNPavel

commands/operator-sdk/cmd/scorecard/test_definitions.go

@@ -25,6 +25,7 @@ import (
 
 // Struct definitions
 
+// ScorecardVars contains all necessary variables for running scorecard tests
 type ScorecardVars struct {
 	client        *client.Client
 	crObj         *unstructured.Unstructured
@@ -34,13 +35,14 @@ type ScorecardVars struct {
 	retryInterval int
 }
 
+// Score contains the number of earned points and maximum number of points
 type Score struct {
 	earnedPoints  int
 	maximumPoints int
 }
 
+// Test defines a scorecard test
 type Test struct {
-	testType    string
 	name        string
 	description string
 	// by having an array of scores, we can more easily add support for multiple CR
@@ -50,6 +52,7 @@ type Test struct {
 	run        func(*Test, ScorecardVars) error
 }
 
+// TestSuite defines a suite of scorecard tests
 type TestSuite struct {
 	name        string
 	description string

test/test-framework/deploy/namespace-init.yaml

@@ -2,6 +2,7 @@ apiVersion: v1
 kind: ServiceAccount
 metadata:
   name: memcached-operator
+
 ---
 apiVersion: rbac.authorization.k8s.io/v1
 kind: Role
@@ -36,6 +37,7 @@ rules:
   - '*'
   verbs:
   - '*'
+
 ---
 kind: RoleBinding
 apiVersion: rbac.authorization.k8s.io/v1
@@ -48,36 +50,41 @@ roleRef:
   kind: Role
   name: memcached-operator
   apiGroup: rbac.authorization.k8s.io
+
 ---
 apiVersion: apps/v1
 kind: Deployment
 metadata:
+  creationTimestamp: null
   name: memcached-operator
 spec:
   replicas: 1
   selector:
     matchLabels:
       name: memcached-operator
+  strategy: {}
   template:
     metadata:
+      creationTimestamp: null
       labels:
         name: memcached-operator
     spec:
-      serviceAccountName: memcached-operator
       containers:
-        - name: memcached-operator
-          # Replace this with the built image name
-          image: quay.io/coreos/operator-sdk-dev:test-framework-operator-runtime
-          ports:
-          - containerPort: 60000
-            name: metrics
-          command:
-          - memcached-operator
-          imagePullPolicy: Always
-          env:
-            - name: WATCH_NAMESPACE
-              valueFrom:
-                fieldRef:
-                  fieldPath: metadata.namespace
-            - name: OPERATOR_NAME
-              value: "memcached-operator"
+      - command:
+        - memcached-operator
+        env:
+        - name: WATCH_NAMESPACE
+          valueFrom:
+            fieldRef:
+              fieldPath: metadata.namespace
+        - name: OPERATOR_NAME
+          value: memcached-operator
+        image: quay.io/coreos/operator-sdk-dev:test-framework-operator-runtime
+        imagePullPolicy: Always
+        name: memcached-operator
+        ports:
+        - containerPort: 60000
+          name: metrics
+        resources: {}
+      serviceAccountName: memcached-operator
+status: {}