Make --[no-]show-... options work with JSON output

[ghost]

Purpose

The CLI has several options to specify which field to display. Such options are not available when using JSON output --json or --json-stream. This PR make such options work with JSON output.

Context

#247 (comment)

Changes

• Make --[no-]show-... options work with JSON output
• Display translated message tag when passing --json and --json-translate

How to test this PR

Try several combinations using the --[no-]show-... and/or --[no-]time options and check that the fields are properly displayed or not. Also check that the combination --json --json-translate properly return the translated message.

$ zonemaster-cli --no-show-module --show-testcase --test connectivity --level INFO --json --json-translate afnic.fr | jq
[
  {
    "args": {
      "version": "v4.6.1"
    },
    "level": "INFO",
    "message": "Using version v4.6.1 of the Zonemaster engine.",
    "tag": "GLOBAL_VERSION"
  },
  {
    "args": {
      "asn_list": "2485,2486"
    },
    "level": "INFO",
    "message": "At least two IPv4 addresses of the authoritative nameservers are announce by different AS sets. A merged list of all AS: (2485,2486).",
    "tag": "IPV4_DIFFERENT_ASN"
  },
  {
    "args": {
      "asn_list": "2485,2486"
    },
    "level": "INFO",
    "message": "At least two IPv6 addresses of the authoritative nameservers are announce by different AS sets. A merged list of all AS: (2485,2486).",
    "tag": "IPV6_DIFFERENT_ASN"
  }
]

[matsduf]

Also see #247 (comment)

This is fine, but the documentation must be updated:

        --[no-]json-translate  Flag indicating if streaming JSON output
                               should include the translated message of the
                               tag or not.

What does --raw mean in combination with --json?

When --raw is given without --json then you get the tag and the arguments for that tag. Can you get the arguments here?

[ghost]

What does --raw mean in combination with --json?

--raw only applies to the message tag. --json --raw would mean "output the message tag without translating it into any human language".

When --raw is given without --json then you get the tag and the arguments for that tag. Can you get the arguments here?

I'm not sure I understand your question. Could you explain?

[tgreenx]

Also see #247 (comment)

This is fine, but the documentation must be updated:

        --[no-]json-translate  Flag indicating if streaming JSON output
                               should include the translated message of the
                               tag or not.

What does --raw mean in combination with --json?

When --raw is given without --json then you get the tag and the arguments for that tag. Can you get the arguments here?

As mentioned in the cited comment, --[no-]json-translate appears entirely redundant to --[no-]raw. Up until it gets removed, I agree that the documentation could use some detail when both are used. Right now, --[no-]raw has no effect when combined with --[no-]json. Also, --[no-]json-translate takes precedence over --[no-]raw.

Other than that LGTM, tested and works as described.

[ghost]

I've updated the documentation for --json-translate.

[matsduf]

When --raw is given without --json then you get the tag and the arguments for that tag. Can you get the arguments here?

I'm not sure I understand your question. Could you explain?

Forget my comment. Now it looks OK.

[matsduf]

This looks fine, but could --raw get more complete documentation, e.g.

	--[no-]raw     Flag indicating if output should be translated
	                       to human language or dumped raw. This flag is
                               ignored if --json or --json-stream has been given.

[ghost]

This looks fine, but could --raw get more complete documentation, e.g.

I'm not against it. However I'd like to share why I'd like not to add this to this PR:

• I want this PR to focus on the JSON implementation. Therefore, I think, this small change is outside of scope.
• I want this PR to avoid updating the documentation too much since I find it good. I use the documentation as a goal when updating the implementation.
• I'm planning in a follow-up PR to deprecate --[no-]json-translate and replace it with --[no-]raw.

[matsduf]

• I'm planning in a follow-up PR to deprecate --[no-]json-translate and replace it with --[no-]raw.

So you mean that --json-translate will be replaced by --no-raw and --no-json-translate by --raw?

If the end result is that it will be clear in the documentation what options that can be combined and not that I am fine with it.

[ghost]

So you mean that --json-translate will be replaced by --no-raw and --no-json-translate by --raw?

Yes. This is exactly what I intend to do.

[matsduf]

Requires additional PRs, but this part is fine.

[tgreenx]

v2023.1 Release testing

Basic testing:

• Options --[no-]show-... work with JSON output. --> OK
• Display translated message tag when passing --json and --json-translate. --> OK

Bugs:

• --no-json-translate (or --no-json_translate) does not work. Translated message is still shown, but it shouldn't. --> Fix option --[no-]json-translate #337

Observations:

• --json --no-raw (or just --json) includes the content of --raw (message tag and args) --> Acceptable but undocumented behavior.