-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
scorecard.go
341 lines (322 loc) · 11.2 KB
/
scorecard.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
// Copyright 2019 The Operator-SDK Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package scorecard
import (
"context"
"encoding/json"
"errors"
"fmt"
"io/ioutil"
"os"
"github.com/operator-framework/operator-sdk/internal/pkg/scaffold"
k8sInternal "github.com/operator-framework/operator-sdk/internal/util/k8sutil"
"github.com/operator-framework/operator-sdk/internal/util/projutil"
"github.com/operator-framework/operator-sdk/internal/util/yamlutil"
"github.com/ghodss/yaml"
olmapiv1alpha1 "github.com/operator-framework/operator-lifecycle-manager/pkg/api/apis/operators/v1alpha1"
olminstall "github.com/operator-framework/operator-lifecycle-manager/pkg/controller/install"
log "github.com/sirupsen/logrus"
"github.com/spf13/cobra"
"github.com/spf13/viper"
v1 "k8s.io/api/core/v1"
extscheme "k8s.io/apiextensions-apiserver/pkg/client/clientset/clientset/scheme"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/serializer"
"k8s.io/client-go/discovery/cached"
"k8s.io/client-go/kubernetes"
cgoscheme "k8s.io/client-go/kubernetes/scheme"
"k8s.io/client-go/rest"
"k8s.io/client-go/restmapper"
"sigs.k8s.io/controller-runtime/pkg/client"
)
const (
ConfigOpt = "config"
NamespaceOpt = "namespace"
KubeconfigOpt = "kubeconfig"
InitTimeoutOpt = "init-timeout"
OlmDeployedOpt = "olm-deployed"
CSVPathOpt = "csv-path"
BasicTestsOpt = "basic-tests"
OLMTestsOpt = "olm-tests"
TenantTestsOpt = "good-tenant-tests"
NamespacedManifestOpt = "namespaced-manifest"
GlobalManifestOpt = "global-manifest"
CRManifestOpt = "cr-manifest"
ProxyImageOpt = "proxy-image"
ProxyPullPolicyOpt = "proxy-pull-policy"
CRDsDirOpt = "crds-dir"
VerboseOpt = "verbose"
)
const (
basicOperator = "Basic Operator"
olmIntegration = "OLM Integration"
goodTenant = "Good Tenant"
)
var (
kubeconfig *rest.Config
dynamicDecoder runtime.Decoder
runtimeClient client.Client
restMapper *restmapper.DeferredDiscoveryRESTMapper
deploymentName string
proxyPodGlobal *v1.Pod
cleanupFns []cleanupFn
)
const (
scorecardPodName = "operator-scorecard-test"
scorecardContainerName = "scorecard-proxy"
)
func ScorecardTests(cmd *cobra.Command, args []string) error {
if err := initConfig(); err != nil {
return err
}
if err := validateScorecardFlags(); err != nil {
return err
}
cmd.SilenceUsage = true
defer func() {
if err := cleanupScorecard(); err != nil {
log.Errorf("Failed to clenup resources: (%v)", err)
}
}()
var (
tmpNamespaceVar string
err error
)
kubeconfig, tmpNamespaceVar, err = k8sInternal.GetKubeconfigAndNamespace(viper.GetString(KubeconfigOpt))
if err != nil {
return fmt.Errorf("failed to build the kubeconfig: %v", err)
}
if viper.GetString(NamespaceOpt) == "" {
viper.Set(NamespaceOpt, tmpNamespaceVar)
}
scheme := runtime.NewScheme()
// scheme for client go
if err := cgoscheme.AddToScheme(scheme); err != nil {
return fmt.Errorf("failed to add client-go scheme to client: (%v)", err)
}
// api extensions scheme (CRDs)
if err := extscheme.AddToScheme(scheme); err != nil {
return fmt.Errorf("failed to add failed to add extensions api scheme to client: (%v)", err)
}
// olm api (CS
if err := olmapiv1alpha1.AddToScheme(scheme); err != nil {
return fmt.Errorf("failed to add failed to add oml api scheme (CSVs) to client: (%v)", err)
}
dynamicDecoder = serializer.NewCodecFactory(scheme).UniversalDeserializer()
// if a user creates a new CRD, we need to be able to reset the rest mapper
// temporary kubeclient to get a cached discovery
kubeclient, err := kubernetes.NewForConfig(kubeconfig)
if err != nil {
return fmt.Errorf("failed to get a kubeclient: %v", err)
}
cachedDiscoveryClient := cached.NewMemCacheClient(kubeclient.Discovery())
restMapper = restmapper.NewDeferredDiscoveryRESTMapper(cachedDiscoveryClient)
restMapper.Reset()
runtimeClient, _ = client.New(kubeconfig, client.Options{Scheme: scheme, Mapper: restMapper})
csv := &olmapiv1alpha1.ClusterServiceVersion{}
if viper.GetBool(OLMTestsOpt) {
yamlSpec, err := ioutil.ReadFile(viper.GetString(CSVPathOpt))
if err != nil {
return fmt.Errorf("failed to read csv: %v", err)
}
if err = yaml.Unmarshal(yamlSpec, csv); err != nil {
return fmt.Errorf("error getting ClusterServiceVersion: %v", err)
}
}
// Extract operator manifests from the CSV if olm-deployed is set.
if viper.GetBool(OlmDeployedOpt) {
// Get deploymentName from the deployment manifest within the CSV.
strat, err := (&olminstall.StrategyResolver{}).UnmarshalStrategy(csv.Spec.InstallStrategy)
if err != nil {
return err
}
stratDep, ok := strat.(*olminstall.StrategyDetailsDeployment)
if !ok {
return fmt.Errorf("expected StrategyDetailsDeployment, got strategy of type %T", strat)
}
deploymentName = stratDep.DeploymentSpecs[0].Name
// Get the proxy pod, which should have been created with the CSV.
proxyPodGlobal, err = getPodFromDeployment(deploymentName, viper.GetString(NamespaceOpt))
if err != nil {
return err
}
// Create a temporary CR manifest from metadata if one is not provided.
crJSONStr, ok := csv.ObjectMeta.Annotations["alm-examples"]
if ok && viper.GetString(CRManifestOpt) == "" {
var crs []interface{}
if err = json.Unmarshal([]byte(crJSONStr), &crs); err != nil {
return err
}
// TODO: run scorecard against all CR's in CSV.
cr := crs[0]
crJSONBytes, err := json.Marshal(cr)
if err != nil {
return err
}
crYAMLBytes, err := yaml.JSONToYAML(crJSONBytes)
if err != nil {
return err
}
crFile, err := ioutil.TempFile("", "cr.yaml")
if err != nil {
return err
}
if _, err := crFile.Write(crYAMLBytes); err != nil {
return err
}
viper.Set(CRManifestOpt, crFile.Name())
defer func() {
err := os.Remove(viper.GetString(CRManifestOpt))
if err != nil {
log.Errorf("Could not delete temporary CR manifest file: (%v)", err)
}
}()
}
} else {
// If no namespaced manifest path is given, combine
// deploy/{service_account,role.yaml,role_binding,operator}.yaml.
if viper.GetString(NamespacedManifestOpt) == "" {
file, err := yamlutil.GenerateCombinedNamespacedManifest(scaffold.DeployDir)
if err != nil {
return err
}
viper.Set(NamespacedManifestOpt, file.Name())
defer func() {
err := os.Remove(viper.GetString(NamespacedManifestOpt))
if err != nil {
log.Errorf("Could not delete temporary namespace manifest file: (%v)", err)
}
}()
}
// If no global manifest is given, combine all CRD's in the given CRD's dir.
if viper.GetString(GlobalManifestOpt) == "" {
gMan, err := yamlutil.GenerateCombinedGlobalManifest(viper.GetString(CRDsDirOpt))
if err != nil {
return err
}
viper.Set(GlobalManifestOpt, gMan.Name())
defer func() {
err := os.Remove(viper.GetString(GlobalManifestOpt))
if err != nil {
log.Errorf("Could not delete global manifest file: (%v)", err)
}
}()
}
if err := createFromYAMLFile(viper.GetString(GlobalManifestOpt)); err != nil {
return fmt.Errorf("failed to create global resources: %v", err)
}
if err := createFromYAMLFile(viper.GetString(NamespacedManifestOpt)); err != nil {
return fmt.Errorf("failed to create namespaced resources: %v", err)
}
}
if err := createFromYAMLFile(viper.GetString(CRManifestOpt)); err != nil {
return fmt.Errorf("failed to create cr resource: %v", err)
}
obj, err := yamlToUnstructured(viper.GetString(CRManifestOpt))
if err != nil {
return fmt.Errorf("failed to decode custom resource manifest into object: %s", err)
}
if err := waitUntilCRStatusExists(obj); err != nil {
return fmt.Errorf("failed waiting to check if CR status exists: %v", err)
}
var suites []*TestSuite
// Run tests.
if viper.GetBool(BasicTestsOpt) {
conf := BasicTestConfig{
Client: runtimeClient,
CR: obj,
ProxyPod: proxyPodGlobal,
}
basicTests := NewBasicTestSuite(conf)
basicTests.Run(context.TODO())
suites = append(suites, basicTests)
}
if viper.GetBool(OLMTestsOpt) {
conf := OLMTestConfig{
Client: runtimeClient,
CR: obj,
CSV: csv,
CRDsDir: viper.GetString(CRDsDirOpt),
ProxyPod: proxyPodGlobal,
}
olmTests := NewOLMTestSuite(conf)
olmTests.Run(context.TODO())
suites = append(suites, olmTests)
}
totalScore := 0.0
for _, suite := range suites {
fmt.Printf("%s:\n", suite.GetName())
for _, result := range suite.TestResults {
fmt.Printf("\t%s: %d/%d\n", result.Test.GetName(), result.EarnedPoints, result.MaximumPoints)
}
totalScore += float64(suite.TotalScore())
}
totalScore = totalScore / float64(len(suites))
fmt.Printf("\nTotal Score: %.0f%%\n", totalScore)
// Print suggestions
for _, suite := range suites {
for _, result := range suite.TestResults {
for _, suggestion := range result.Suggestions {
// 33 is yellow (specifically, the same shade of yellow that logrus uses for warnings)
fmt.Printf("\x1b[%dmSUGGESTION:\x1b[0m %s\n", 33, suggestion)
}
}
}
// Print errors
for _, suite := range suites {
for _, result := range suite.TestResults {
for _, err := range result.Errors {
// 31 is red (specifically, the same shade of red that logrus uses for errors)
fmt.Printf("\x1b[%dmERROR:\x1b[0m %s\n", 31, err)
}
}
}
return nil
}
func initConfig() error {
// viper/cobra already has flags parsed at this point; we can check if a config file flag is set
if viper.GetString(ConfigOpt) != "" {
// Use config file from the flag.
viper.SetConfigFile(viper.GetString(ConfigOpt))
} else {
viper.AddConfigPath(projutil.MustGetwd())
// using SetConfigName allows users to use a .yaml, .json, or .toml file
viper.SetConfigName(".osdk-scorecard")
}
if err := viper.ReadInConfig(); err == nil {
log.Info("Using config file: ", viper.ConfigFileUsed())
} else {
log.Warn("Could not load config file; using flags")
}
return nil
}
func validateScorecardFlags() error {
if !viper.GetBool(OlmDeployedOpt) && viper.GetString(CRManifestOpt) == "" {
return errors.New("cr-manifest config option must be set")
}
if !viper.GetBool(BasicTestsOpt) && !viper.GetBool(OLMTestsOpt) {
return errors.New("at least one test type must be set")
}
if viper.GetBool(OLMTestsOpt) && viper.GetString(CSVPathOpt) == "" {
return fmt.Errorf("csv-path must be set if olm-tests is enabled")
}
if viper.GetBool(OlmDeployedOpt) && viper.GetString(CSVPathOpt) == "" {
return fmt.Errorf("csv-path must be set if olm-deployed is enabled")
}
pullPolicy := viper.GetString(ProxyPullPolicyOpt)
if pullPolicy != "Always" && pullPolicy != "Never" && pullPolicy != "PullIfNotPresent" {
return fmt.Errorf("invalid proxy pull policy: (%s); valid values: Always, Never, PullIfNotPresent", pullPolicy)
}
return nil
}