Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

internal/pkg/scorecard: access CRManifestOpt correctly with --olm-deployed #1565

Merged
merged 4 commits into from
Jun 19, 2019
Merged

internal/pkg/scorecard: access CRManifestOpt correctly with --olm-deployed #1565

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
28fe4bc
internal/pkg/scorecard/scorecard.go: use viper.GetStringSlice() for g…
estroz Jun 17, 2019
72a9f44
log message if more than once CR is present
estroz Jun 18, 2019
5d8ecbb
Merge branch 'master' into scorecard-consistent-cr-access
estroz Jun 18, 2019
5e34a11
CHANGELOG.md: update with scorecard cr-manifests bug fix
estroz Jun 18, 2019
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
69 changes: 38 additions & 31 deletions internal/pkg/scorecard/scorecard.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"io/ioutil"
Expand All @@ -34,6 +33,7 @@ import (
"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"
"github.com/pkg/errors"
"github.com/sirupsen/logrus"
"github.com/spf13/cobra"
"github.com/spf13/viper"
Expand Down Expand Up @@ -171,37 +171,44 @@ func runTests() ([]scapiv1alpha1.ScorecardOutput, error) {
return nil, 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 nil, err
}
// TODO: run scorecard against all CR's in CSV.
cr := crs[0]
crJSONBytes, err := json.Marshal(cr)
if err != nil {
return nil, err
}
crYAMLBytes, err := yaml.JSONToYAML(crJSONBytes)
if err != nil {
return nil, err
}
crFile, err := ioutil.TempFile("", "cr.yaml")
if err != nil {
return nil, err
}
if _, err := crFile.Write(crYAMLBytes); err != nil {
return nil, err
}
viper.Set(CRManifestOpt, crFile.Name())
defer func() {
err := os.Remove(viper.GetString(CRManifestOpt))
if len(viper.GetStringSlice(CRManifestOpt)) == 0 {
// Create a temporary CR manifest from metadata if one is not provided.
if crJSONStr, ok := csv.ObjectMeta.Annotations["alm-examples"]; ok {
var crs []interface{}
if err = json.Unmarshal([]byte(crJSONStr), &crs); err != nil {
return nil, err
}
// TODO: run scorecard against all CR's in CSV.
cr := crs[0]
crJSONBytes, err := json.Marshal(cr)
if err != nil {
log.Errorf("Could not delete temporary CR manifest file: (%v)", err)
return nil, err
}
}()
crYAMLBytes, err := yaml.JSONToYAML(crJSONBytes)
if err != nil {
return nil, err
}
crFile, err := ioutil.TempFile("", "*.cr.yaml")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is the file *.cr.yaml now?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The temp file names were in an annoying format before 😁. This format uses .cr.yaml as a file extension.

if err != nil {
return nil, err
}
if _, err := crFile.Write(crYAMLBytes); err != nil {
return nil, err
}
viper.Set(CRManifestOpt, []string{crFile.Name()})
defer func() {
for _, f := range viper.GetStringSlice(CRManifestOpt) {
if err := os.Remove(f); err != nil {
log.Errorf("Could not delete temporary CR manifest file: (%v)", err)
}
}
}()
} else {
return nil, errors.New("cr-manifest config option must be set if CSV has no metadata.annotations['alm-examples']")
}
} else {
// TODO: run scorecard against all CR's in CSV.
viper.Set(CRManifestOpt, []string{viper.GetStringSlice(CRManifestOpt)[0]})
}

} else {
Expand Down Expand Up @@ -486,7 +493,7 @@ func configureLogger() error {
}

func validateScorecardFlags() error {
if !viper.GetBool(OlmDeployedOpt) && viper.GetStringSlice(CRManifestOpt) == nil {
if !viper.GetBool(OlmDeployedOpt) && len(viper.GetStringSlice(CRManifestOpt)) == 0 {
return errors.New("cr-manifest config option must be set")
}
if !viper.GetBool(BasicTestsOpt) && !viper.GetBool(OLMTestsOpt) {
Expand Down