Add testcase results

[hannaeko]

Purpose

Make test case available in test result.

Context

Related PR: zonemaster/zonemaster-gui#341
Depends on: zonemaster/zonemaster-engine#1144

Changes

• Add a testcase field in the object of the results array containing test case ids.
• Add a testcase_descriptions to map test case ids to the translated test case descriptions.

How to test this PR

% ./script/zmb --server http://127.0.0.1:5000 get_test_results --test-id <testid> --lang en | jq .result.testcase_descriptions

{
  "ZONE08": "MX is not an alias",
  "SYNTAX05": "Misuse of '@' character in the SOA RNAME field",
  "NAMESERVER06": "NS can be resolved",
  "DELEGATION03": "No truncation of referrals",
  "SYNTAX06": "No illegal characters in the SOA RNAME field",
  "CONSISTENCY03": "SOA timers consistency",
  "DNSSEC15": "Existence of CDS and CDNSKEY",
  "DELEGATION01": "Minimum number of name servers",
  "DELEGATION04": "Name server is authoritative",
  // ...
}

[marc-vanderwal]

Looks good to me.

[matsduf]

Looks fine.

[matsduf]

I created an update to zonemaster/zonemaster-engine#1144 with translated test case descriptions. It works to get the them translated in GUI and in zmb, but there is some coding issue. The PO file is in UTF-8, but when the descriptions are presented they are taken to be some 8 bit character set and character encoding:

zmb --server http://127.0.0.1:5000 get_test_results --test-id 452b0009a1322298 --lang sv | jq
(...)
      {
        "testcase": "ADDRESS02",
        "message": "Bakåtuppslagning (PTR) finns för varje namnserveradress.\n",
        "level": "INFO",
        "module": "ADDRESS"
      },
(...)
      "ADDRESS02": "Bakåtuppslagning (PTR) finns för varje namnserveradress.",
(...)

In the PO file the msgid for both the message and the test case description are identical. Note the corrupted "å" and "ö".

[matsduf]

API.pm should also be updated.

[hannaeko]

It works to get the them translated in GUI and in zmb, but there is some coding issue.

Oh I'll look into it, thanks for having tested that.

API.pm should also be updated.

Documentation is planned.

[hannaeko]

It works to get the them translated in GUI and in zmb, but there is some coding issue.

This is fixed.

[hannaeko]

API.pm should also be updated.

done.

[matsduf]

@blacksponge, is this PR still a draft?

[hannaeko]

is this PR still a draft?

No I marked it ready for review.

[matsduf]

Just two minor comments, else ready to approve.

[tgreenx]

LGTM