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

Jump to bottom

Add report utils for gke-diagnoser to support json output #2020

Merged
merged 1 commit into from
Apr 21, 2023
Merged

Add report utils for gke-diagnoser to support json output #2020

merged 1 commit into from
Apr 21, 2023

Conversation

songrx1997
Copy link
Contributor

@songrx1997 songrx1997 commented Mar 16, 2023 •
edited
Loading

Add report structs for gke-diagnoser CLI
Add json utils for the output report

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 16, 2023
@k8s-ci-robot
Copy link
Contributor

Hi @songrx1997. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Mar 16, 2023
@songrx1997
Copy link
Contributor Author

/assign @swetharepakula
/assign @bowei

@bowei
Copy link
Member

bowei commented Mar 20, 2023

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 20, 2023
bowei
bowei reviewed Mar 20, 2023
View reviewed changes
cmd/gke-diagnoser/app/util/report.go Outdated

// Resource represents the a resource of the cluster and all the checks done on it
type Resource struct {
Type string `json:"type"`
Copy link
Member

Choose a reason for hiding this comment

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

This is called Kind in Kubernetes not Type

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated, thanks!

bowei
bowei reviewed Mar 20, 2023
View reviewed changes
cmd/gke-diagnoser/app/util/report.go Outdated
type Check struct {
Name string `json:"name"`
Msg string `json:"msg"`
Res string `json:"res"`
Copy link
Member

Choose a reason for hiding this comment

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

Please don't use abbreviations unless there is a good reason. This makes it hard to read and understand.

Message

Resource

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated, thanks!

bowei
bowei reviewed Mar 20, 2023
View reviewed changes
cmd/gke-diagnoser/app/util/report.go Outdated
Res string `json:"res"`
}

func JsonReport(report Report) string {
Copy link
Member

Choose a reason for hiding this comment

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

report should be a pointer (report *Report)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated, thanks!

bowei
bowei reviewed Mar 20, 2023
View reviewed changes
cmd/gke-diagnoser/app/util/report.go Outdated
func JsonReport(report Report) string {
jsonRaw, err := json.MarshalIndent(report, "", " ")
if err != nil {
fmt.Fprintf(os.Stderr, "Error Marshalling JSON: %s\n", jsonRaw)
Copy link
Member

Choose a reason for hiding this comment

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

Is this how we are handling errors?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changed this to return an error and let the caller handle it.

bowei
bowei reviewed Mar 20, 2023
View reviewed changes
cmd/gke-diagnoser/app/util/report.go
}

// SupportedOutputs returns a string list of output formats supposed by this package
func SupportedOutputs() []string {
Copy link
Member

Choose a reason for hiding this comment

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

How is this used?

Copy link
Contributor Author

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.

@bowei
Copy link
Member

bowei commented Mar 20, 2023

/hold

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 20, 2023
@songrx1997 songrx1997 force-pushed the gke-diagnoser-report branch 3 times, most recently from bb14b6e to 405b663 Compare March 20, 2023 23:02
swetharepakula
swetharepakula reviewed Apr 21, 2023
View reviewed changes
Copy link
Member

@swetharepakula swetharepakula left a comment

Choose a reason for hiding this comment

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

/approve
/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 21, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: songrx1997, swetharepakula

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 21, 2023
@swetharepakula
Copy link
Member

/hold cancel

As the original comments have been addressed, removing the hold

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Apr 21, 2023
@k8s-ci-robot k8s-ci-robot merged commit 2953063 into kubernetes:master Apr 21, 2023
@songrx1997 songrx1997 deleted the gke-diagnoser-report branch May 2, 2023 19:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bowei bowei bowei left review comments

@swetharepakula swetharepakula swetharepakula left review comments

@aojea aojea Awaiting requested review from aojea

@prameshj prameshj Awaiting requested review from prameshj

Assignees

@bowei bowei

@swetharepakula swetharepakula

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@songrx1997 @k8s-ci-robot @bowei @swetharepakula