V1alpha2 api - scorecard output changes for v1alpha2 version #1995
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| // 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 ( | ||
| "encoding/json" | ||
| "fmt" | ||
| schelpers "github.com/operator-framework/operator-sdk/internal/pkg/scorecard/helpers" | ||
| scapi "github.com/operator-framework/operator-sdk/pkg/apis/scorecard" | ||
| scapiv1alpha1 "github.com/operator-framework/operator-sdk/pkg/apis/scorecard/v1alpha1" | ||
| "io/ioutil" | ||
| ) | ||
|
|
||
| func printPluginOutputs(version string, pluginOutputs []scapiv1alpha1.ScorecardOutput) error { | ||
|
|
||
| var list scapi.ScorecardFormatter | ||
| var err error | ||
| list, err = combinePluginOutput(pluginOutputs) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if schelpers.IsV1alpha2(version) { | ||
| list = scapi.ConvertScorecardOutputV1ToV2(list.(scapiv1alpha1.ScorecardOutput)) | ||
| } | ||
|
|
||
| // produce text output | ||
| if scViper.GetString(OutputFormatOpt) == TextOutputFormat { | ||
|
There was a problem hiding this comment. Nit: This is out of scope for this PR, but I'm not a huge fan of the global variables used throughout scorecard (e.g. In a follow-on, I think it would be worth it to refactor things so that viper is used only in the There was a problem hiding this comment. agreed, I could write up a new Jira story for refactoring that. There was a problem hiding this comment. There was a problem hiding this comment. https://jira.coreos.com/browse/OSDK-587 |
||
| output, err := list.MarshalText() | ||
| if err != nil { | ||
| return err | ||
| } | ||
| fmt.Printf("%s\n", output) | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| // produce json output | ||
| if scViper.GetString(OutputFormatOpt) == JSONOutputFormat { | ||
| bytes, err := json.MarshalIndent(list, "", " ") | ||
| if err != nil { | ||
| return err | ||
| } | ||
| fmt.Printf("%s\n", string(bytes)) | ||
| return nil | ||
|
|
||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func combinePluginOutput(pluginOutputs []scapiv1alpha1.ScorecardOutput) (scapiv1alpha1.ScorecardOutput, error) { | ||
| output := scapiv1alpha1.ScorecardOutput{} | ||
| output.Results = make([]scapiv1alpha1.ScorecardSuiteResult, 0) | ||
| for _, v := range pluginOutputs { | ||
| for _, r := range v.Results { | ||
| output.Results = append(output.Results, r) | ||
| } | ||
| } | ||
|
|
||
| if scViper.GetString(OutputFormatOpt) == JSONOutputFormat { | ||
| log, err := ioutil.ReadAll(logReadWriter) | ||
| if err != nil { | ||
| return output, fmt.Errorf("failed to read log buffer: %v", err) | ||
| } | ||
| output.Log = string(log) | ||
| } | ||
|
|
||
| return output, nil | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I checked that k8s uses the nomenclature
--experimental-xfor this kind of impl. WDYT about we adopted the same? As for example--experimental-versionThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that's meant more for enabling or configuring experimental features. In this case, this will control core features of the scorecard (output formats, support for external plugins, exit code handling, label selection, etc.).
So I think we should leave
--versionas the flag name.