[Antctl] Add an output formatter to better display multi-line string responses. #3589

Atish-iaf · 2022-04-06T11:04:19Z

Current output formatters (table, json, and yaml) of Antctl are
not good at displaying multi-line string responses.

Add a new output formatter raw whose output is similar to
fmt.Print(responseString) to better display multi-line string responses.

Fixes #3426

Signed-off-by: Kumar Atish atish.iaf@gmail.com

codecov-commenter · 2022-04-06T12:26:58Z

Codecov Report

Merging #3589 (848940a) into main (af9ee6a) will decrease coverage by 13.58%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##             main    #3589       +/-   ##
===========================================
- Coverage   61.75%   48.17%   -13.59%     
===========================================
  Files         294      265       -29     
  Lines       43631    39664     -3967     
===========================================
- Hits        26946    19109     -7837     
- Misses      14445    18713     +4268     
+ Partials     2240     1842      -398

Flag	Coverage Δ
e2e-tests	`41.27% <ø> (?)`
integration-tests	`35.22% <ø> (?)`
kind-e2e-tests	`32.40% <ø> (-12.41%)`	⬇️
unit-tests	`?`

Impacted Files	Coverage Δ
pkg/controller/networkpolicy/endpoint_querier.go	`4.58% <0.00%> (-88.08%)`	⬇️
pkg/controller/ipam/validate.go	`0.00% <0.00%> (-79.79%)`	⬇️
pkg/cni/client.go	`0.00% <0.00%> (-77.78%)`	⬇️
pkg/controller/ipam/antrea_ipam_controller.go	`0.00% <0.00%> (-76.42%)`	⬇️
pkg/controller/externalippool/validate.go	`0.00% <0.00%> (-75.87%)`	⬇️
pkg/apiserver/handlers/featuregates/handler.go	`1.63% <0.00%> (-73.78%)`	⬇️
.../registry/networkpolicy/clustergroupmember/rest.go	`11.11% <0.00%> (-73.62%)`	⬇️
pkg/controller/networkpolicy/clustergroup.go	`3.50% <0.00%> (-73.57%)`	⬇️
pkg/controller/networkpolicy/crd_utils.go	`19.13% <0.00%> (-73.46%)`	⬇️
.../certificatesigningrequest/approving_controller.go	`0.00% <0.00%> (-73.41%)`	⬇️
... and 167 more

xliuxu · 2022-04-06T12:42:43Z

pkg/antctl/command_definition.go

+	jsonFormatter      formatterType = "json"
+	yamlFormatter      formatterType = "yaml"
+	tableFormatter     formatterType = "table"
+	rawStringFormatter formatterType = "rawString"


I think it would be more user-friendly to name it raw or rawstring

Changed to raw

pkg/antctl/output/output.go

jianjuns

Do we have an example of such multi-line output, with a comparison of "raw" and other format?

Atish-iaf · 2022-04-06T17:59:42Z

Do we have an example of such multi-line output, with a comparison of "raw" and other format?

Currently we don't have any antctl command whose output include multiple-line string responses.
You can find example in the issue #3426 . Also i changed output of an antctl command for testing purpose.

root@minikube:/# antctl trace-packet
|
  Hello
  World
   Project Antrea
root@minikube:/# antctl trace-packet -o yaml
|
  Hello
  World
   Project Antrea
root@minikube:/# antctl trace-packet -o json
"Hello\nWorld\n Project Antrea\n"
root@minikube:/# antctl trace-packet -o raw
Hello
World
 Project Antrea

jianjuns · 2022-04-06T18:16:41Z

Thanks for the examples. The proposal looks good to me.

xliuxu

LGTM

dreamtalen

LGTM, thanks atish working on this.
Could maintainers help merge this PR? This will help me develop another patch described in issue #3426. Thanks!

luolanzone · 2022-07-04T02:52:02Z

Hi @tnqn @jianjuns Could you help to check this PR and move forward? thanks.

jianjuns · 2022-07-06T00:54:22Z

/test-all

tnqn

help message needs update, otherwise people don't know the format is available:

# ./bin/antctl-linux get controllerinfo -h
Print Antrea controller's basic information including version, deployment, NetworkPolicy controller, ControllerConditions, etc.

Usage:
  antctl-linux get controllerinfo [flags]

Aliases:
  controllerinfo, controllerinfos, ci

Examples:
  Get the controllerinfo
  $ antctl-linux get controllerinfo


Flags:
  -h, --help            help for controllerinfo
  -o, --output string   output format: json|table|yaml (default "table")

The commit message seems to talk about something unrelated to this change:

Added a new output formatter called "raw" whose output is similar to fmt.Print(responseString) which directly lets user redirect the output into a file and apply it afterwards.

What does "directly lets user redirect the output into a file and apply it afterwards" mean?

Commit message body should be wrapped at 72 chars, otherwise git log doesn't look neat:

commit 66f06522e756d37f70cf2b1d0f18d5ff944e6f27 (HEAD -> main)
Author: Kumar Atish <atish.iaf@gmail.com>
Date:   Wed Apr 6 16:27:24 2022 +0530

    Add an output format to better display multi-line string responses.

    Current output formatters (table, json, and yaml) of Antctl are not good at displaying multi-line string responses.
    Added a new output formatter called "raw" whose output is similar to fmt.Print(responseString) which directly lets user redirect the output into a file and apply it afterwards.

    Fixes #3426

    Signed-off-by: Kumar Atish <atish.iaf@gmail.com>

commit af9ee6ada8a597fc136298b73e02f3da163ed20d (origin/main, origin/HEAD)
Author: Quan Tian <qtian@vmware.com>
Date:   Wed Jul 6 22:35:52 2022 +0800

    Fix egress e2e test (#3953)

    The verification was wrong, which lead to false positive.

    Besides, DeleteSNATRule should only call iptables or ip6tables based on
    the protocol of SNAT IP, otherwise it would fail and lead to retries.

    Signed-off-by: Quan Tian <qtian@vmware.com>

commit 6e8aaac2d4fa8d679b72745783ad1b263d3e3a0e
Author: Lan <luola@vmware.com>
Date:   Wed Jul 6 22:33:00 2022 +0800

    Fix integration data on codecov (#3955)

    1. The crd path is changed, so fix the path in MC integration test.
    2. Change the codecov caller parameters

    Signed-off-by: Lan Luo <luola@vmware.com>

Current output formatters (table, json, and yaml) of Antctl are not good at displaying multi-line string responses. Add a new output formatter `raw` whose output is similar to fmt.Print(responseString) to better display multi-line string responses. Fixes antrea-io#3426 Signed-off-by: Kumar Atish <atish.iaf@gmail.com>

jianjuns · 2022-07-06T16:59:16Z

/test-all

Atish-iaf force-pushed the antctl_multi_line_string branch from 82dcd99 to ea0bae8 Compare April 6, 2022 11:08

xliuxu reviewed Apr 6, 2022

View reviewed changes

Atish-iaf force-pushed the antctl_multi_line_string branch from ea0bae8 to 7f8cce2 Compare April 6, 2022 12:56

Atish-iaf marked this pull request as ready for review April 6, 2022 12:59

luolanzone reviewed Apr 6, 2022

View reviewed changes

pkg/antctl/output/output.go Show resolved Hide resolved

jianjuns reviewed Apr 6, 2022

View reviewed changes

xliuxu previously approved these changes Apr 28, 2022

View reviewed changes

dreamtalen previously approved these changes May 10, 2022

View reviewed changes

jianjuns previously approved these changes Jul 5, 2022

View reviewed changes

tnqn reviewed Jul 6, 2022

View reviewed changes

Atish-iaf dismissed stale reviews from jianjuns, dreamtalen, and xliuxu via 848940a July 6, 2022 16:56

Atish-iaf force-pushed the antctl_multi_line_string branch from 7f8cce2 to 848940a Compare July 6, 2022 16:56

jianjuns approved these changes Jul 6, 2022

View reviewed changes

Atish-iaf changed the title ~~[Antctl] Add an output format to better display multi-line string responses.~~ [Antctl] Add an output formatter to better display multi-line string responses. Jul 6, 2022

Atish-iaf requested a review from tnqn July 6, 2022 17:01

jianjuns merged commit acddced into antrea-io:main Jul 6, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Antctl] Add an output formatter to better display multi-line string responses. #3589

[Antctl] Add an output formatter to better display multi-line string responses. #3589

Atish-iaf commented Apr 6, 2022 •

edited

Loading

codecov-commenter commented Apr 6, 2022 •

edited

Loading

xliuxu Apr 6, 2022

Atish-iaf Apr 6, 2022

jianjuns left a comment

Atish-iaf commented Apr 6, 2022

jianjuns commented Apr 6, 2022

xliuxu left a comment

dreamtalen left a comment

luolanzone commented Jul 4, 2022

jianjuns commented Jul 6, 2022

tnqn left a comment

jianjuns commented Jul 6, 2022

[Antctl] Add an output formatter to better display multi-line string responses. #3589

[Antctl] Add an output formatter to better display multi-line string responses. #3589

Conversation

Atish-iaf commented Apr 6, 2022 • edited Loading

codecov-commenter commented Apr 6, 2022 • edited Loading

Codecov Report

xliuxu Apr 6, 2022

Choose a reason for hiding this comment

Atish-iaf Apr 6, 2022

Choose a reason for hiding this comment

jianjuns left a comment

Choose a reason for hiding this comment

Atish-iaf commented Apr 6, 2022

jianjuns commented Apr 6, 2022

xliuxu left a comment

Choose a reason for hiding this comment

dreamtalen left a comment

Choose a reason for hiding this comment

luolanzone commented Jul 4, 2022

jianjuns commented Jul 6, 2022

tnqn left a comment

Choose a reason for hiding this comment

jianjuns commented Jul 6, 2022

Atish-iaf commented Apr 6, 2022 •

edited

Loading

codecov-commenter commented Apr 6, 2022 •

edited

Loading