Expand --count option

[tgreenx]

Purpose

This PR proposes an update to the --count option.

Context

N/A

Changes

• Add a count of each message tag for each severity level
• Dynamically format the table as to support translated strings (e.g. headers and levels)

How to test this PR

Run any test with the --count option. Check that the formatting is done correctly.
Output:

$ zonemaster-cli --count --raw --no-ipv6 --test basic02 afnic.fr


 Level  Number of log entries
======  =====================
  INFO                      2
 DEBUG                     53
DEBUG2                    178
DEBUG3                     65

 Level            Message tag   Count
======  =====================   =====
  INFO  B02_AUTH_RESPONSE_SOA       1
  INFO         GLOBAL_VERSION       1
 DEBUG     DEPENDENCY_VERSION       9
 DEBUG         EXTERNAL_QUERY      30
 DEBUG           IPV4_ENABLED       4
 DEBUG          IPV6_DISABLED       4
 DEBUG             MODULE_END       1
 DEBUG         MODULE_VERSION       1
 DEBUG             START_TIME       1
 DEBUG          TEST_CASE_END       1
 DEBUG        TEST_CASE_START       1
 DEBUG            TEST_TARGET       1
DEBUG2          CACHE_CREATED       7
DEBUG2           IPV6_BLOCKED      28
DEBUG2            IS_REDIRECT      14
DEBUG2             NS_CREATED      38
DEBUG2                  QUERY      35
DEBUG2          RECURSE_QUERY      56
DEBUG3          CACHED_RETURN      35
DEBUG3      EXTERNAL_RESPONSE      30

Also run it with the --json option, and check that the output is correct:

$ zonemaster-cli --count --json --raw --no-ipv6 --test basic02 afnic.fr | jq
{
  "count": {
    "by_level": {
      "DEBUG": 53,
      "DEBUG2": 178,
      "DEBUG3": 65,
      "INFO": 2
    },
    "by_message_tag": {
      "DEBUG": {
        "DEPENDENCY_VERSION": 9,
        "EXTERNAL_QUERY": 30,
        "IPV4_ENABLED": 4,
        "IPV6_DISABLED": 4,
        "MODULE_END": 1,
        "MODULE_VERSION": 1,
        "START_TIME": 1,
        "TEST_CASE_END": 1,
        "TEST_CASE_START": 1,
        "TEST_TARGET": 1
      },
      "DEBUG2": {
        "CACHE_CREATED": 7,
        "IPV6_BLOCKED": 28,
        "IS_REDIRECT": 14,
        "NS_CREATED": 38,
        "QUERY": 35,
        "RECURSE_QUERY": 56
      },
      "DEBUG3": {
        "CACHED_RETURN": 35,
        "EXTERNAL_RESPONSE": 30
      },
      "INFO": {
        "B02_AUTH_RESPONSE_SOA": 1,
        "GLOBAL_VERSION": 1
      }
    }
  },
  "results": []
}

[tgreenx]

@mattias-p @matsduf @marc-vanderwal please review.

[mattias-p]

Neat feature. Maybe add a unit test to make sure it continues to work in future releases?

It is OK as is.

[tgreenx]

@matsduf @mattias-p Rebased on latest develop, and addressed review comments (see 5ee387e). Please re-review.

[marc-vanderwal]

Release testing done on Rocky Linux 9.

When the system locale is set to French, there is a small inconsistency in how the table is formatted. The first table has DEBUG translated as DEBOGUE, but not the second one.

This is the output I get on my system:

$ zonemaster-cli --count --raw --no-ipv6 --test basic02 afnic.fr


 Niveau Number of log entries
======= =====================
   INFO                     2
DEBOGUE                    53
 DEBUG2                   178
 DEBUG3                    65

 Niveau           Message tag   Count
======= =====================   =====
   INFO B02_AUTH_RESPONSE_SOA       1
   INFO        GLOBAL_VERSION       1
  DEBUG    DEPENDENCY_VERSION       9
  DEBUG        EXTERNAL_QUERY      30
  DEBUG          IPV4_ENABLED       4
  DEBUG         IPV6_DISABLED       4
  DEBUG            MODULE_END       1
  DEBUG        MODULE_VERSION       1
  DEBUG            START_TIME       1
  DEBUG         TEST_CASE_END       1
  DEBUG       TEST_CASE_START       1
  DEBUG           TEST_TARGET       1
 DEBUG2         CACHE_CREATED       7
 DEBUG2          IPV6_BLOCKED      28
 DEBUG2           IS_REDIRECT      14
 DEBUG2            NS_CREATED      38
 DEBUG2                 QUERY      35
 DEBUG2         RECURSE_QUERY      56
 DEBUG3         CACHED_RETURN      35
 DEBUG3     EXTERNAL_RESPONSE      30