Add description for tests

[HuijingHei]

Based on coreos/coreos-assembler#3425

[cgwalters]

Looks good to me.

[mike-nguyen]

Overall looks good to me. I noticed that sometimes description: > was used on multi-line descriptions. Should we use that for all multi-line descriptions or not? For non-external tests (tests in coreos-assembler mantle kola) the concept of > doesn't exist.

The resulting json output from using > results in a newline character before the description text. Example below:

[
  "ext.config.files.check-symlink",
  "Verify /etc release symlinks are valid.\nSee\n- https://bugzilla.redhat.com/show_bug.cgi?id=2068148\n- https://github.com/openshift/os/pull/815"
]
[
  "ext.config.files.console-config",
  "\nVerify that the kargs and grub.cfg commands specified in \nplatforms.json have been properly applied to the image. \nAlso check cosa correctly translated platforms.yaml to  \nplatforms.json, by spot-checking certain expected values\nin platforms.json.\n"
]

I don't know if that will ultimately make any difference when we try to import into Polarion.

[HuijingHei]

I don't know if that will ultimately make any difference when we try to import into Polarion.

Agree that it looks ugly for human reading as many \n.
It will look normal if using =SUBSTITUTE(<E2>,"\n",CHAR(10)) to convert \n to real new line in google sheet before importing into Polarion.

[jlebon]

This is really great!

[HuijingHei]

I noticed that sometimes description: > was used on multi-line descriptions. Should we use that for all multi-line descriptions or not? For non-external tests (tests in coreos-assembler mantle kola) the concept of > doesn't exist.

SGTM. I will try to drop description: >. Thanks for the suggestion.

[HuijingHei]

Done for the updates, thanks all for the review and suggestions.

[mike-nguyen]

LGTM

[jlebon]

I didn't re-review the full diff in detail, but the interdiff looks good. Nice work @HuijingHei!