Known failures

[thesunshade]

Use case:

If there is going to be a main set of tests that is part of the build script, it would be ideal if known failures were especially indicated. That way if a test fails and the developer wants to delay solving the problem, they can create a github issue and mark it as a known failure. Perhaps something like:

[[test-case]]
description = "Find volpage:SN ii 4"
known-failure = "See https://github.com/suttacentral/search-test/issues/3"
selected-languages = ["en", "pli"]
query = "volpage:SN ii 4"
expected.suttaplex = "sn12.3"

Would give this result:

KNOWN ERROR   1259ms Find volpage:SN ii 4
  See https://github.com/suttacentral/search-test/issues/3
  Could not parse JSON response: error decoding response body: data did not match any variant of untagged enum Hit at line 1 column 494

0 passed, 0 failed, 0 error, 1 known error

[khemarato]

We could even make it explicitly a GitHub Issue url field:

known-issue-link = "https://github.com/suttacentral/suttacentral/issues/2997"

This would allow eventual integration into the GitHub API (i.e. if the test fails again in the future, automatically reopen the issue, etc)