-
Notifications
You must be signed in to change notification settings - Fork 303
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.
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
Add report utils for gke-diagnoser to support json output #2020
Merged
k8s-ci-robot
merged 1 commit into
kubernetes:master
from
ruixiansong:gke-diagnoser-report
Apr 21, 2023
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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,70 @@ | ||
/* | ||
Copyright 2023 The Kubernetes 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 util | ||
|
||
import ( | ||
"encoding/json" | ||
) | ||
|
||
const ( | ||
// Passed is the constant value for the Result field of a passed check | ||
Passed string = "PASSED" | ||
// Failed is the constant value for the Result field of a failed check | ||
Failed string = "FAILED" | ||
// Skipped is the constant value for the Result field of a skipped check | ||
Skipped string = "SKIPPED" | ||
) | ||
|
||
const ( | ||
//JSONOutput is the constant value for output type JSON | ||
JSONOutput string = "json" | ||
) | ||
|
||
// Report represents the final output of the analyzer | ||
type Report struct { | ||
Resources []*Resource `json:"resources"` | ||
} | ||
|
||
// Resource represents the a resource of the cluster and all the checks done on it | ||
type Resource struct { | ||
Kind string `json:"kind"` | ||
Namespace string `json:"namespace"` | ||
Name string `json:"name"` | ||
Checks []*Check `json:"checks"` | ||
} | ||
|
||
// Check represents the result of a check | ||
type Check struct { | ||
Name string `json:"name"` | ||
Message string `json:"message"` | ||
Result string `json:"result"` | ||
} | ||
|
||
func JsonReport(report *Report) (string, error) { | ||
jsonRaw, err := json.MarshalIndent(report, "", " ") | ||
if err != nil { | ||
return "", err | ||
} | ||
return string(jsonRaw), nil | ||
} | ||
|
||
// SupportedOutputs returns a string list of output formats supported by this package | ||
func SupportedOutputs() []string { | ||
return []string{ | ||
JSONOutput, | ||
} | ||
} |
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.
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.
How is this used?
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.
This will be used by a flag checker to check whether a format is supported.