KCIDB: Requiring IDs for test environments #KCIDB

Hi everyone,

To anyone involved/interested in contributing to KernelCI's KCIDB data and
code, I'd like to announce a small, but noticeable change to the schema to let
us develop result notifications further, and to move closer to reaching
developers with our data.

We'd like to start requiring unique IDs for test environments.

Test "environment" is an optional object within the test object. So far it has
only contained a "description" and a "misc" field.

We would like to start grouping tests by environments (hosts/VMs) they
executed in, on our dashboards and in e-mail notifications. To do that we need
a way to identify them, and that's where environment IDs come in.

The environment IDs would need to be in the same format as "builds" and
"tests" use in v3 schema, as well as "checkouts" are going to use in v4:
the origin name (e.g. "syzbot"), followed by a colon, followed by an
origin-unique ID.

The origin-unique ID can be whatever uniquely identifies the environment
inside the origin CI system. It could be just a straight hostname, or e.g. a
hashed hostname if you'd like to keep it secret.

E.g. a Red Hat test report could look like this:

     {
       "version": {
         "major": 4,
         "minor": 0
       },
       "tests": [
         {
           "build_id": "redhat:1071310",
           "id": "redhat:120299463",
           "origin": "redhat",
           "environment": {
             "id": "redhat:kernelci-1.s390.bos.redhat.com",
             "comment": "kernelci-1.s390.bos.redhat.com"
           },
           "path": "boot",
           "comment": "Boot test",
           "status": "PASS",
           "waived": false,
           "start_time": "2021-01-14T10:01:43+00:00",
           "duration": 161
         }
       ]
     }

Reports in v3 and older formats will have environment IDs generated
automatically by sha256-hashing a stable JSON representation of "environment"
objects, if any are present and are not empty. Empty "environment" objects
will be discarded. E.g. this v3 environment:

     "environment": {
       "description": "rk3288-veyron-jaq in lab-collabora",
       "misc": {
         "instance": "rk3288-veyron-jaq-cbg-1",
         "device": "rk3288-veyron-jaq",
         "mach": "rockchip",
         "lab": "lab-collabora"
       }
     }

will be upgraded to this v4 environment:

     "environment": {
         "id": "_:c04ecf73a79cf29bdd9140ad4f50172c8f9783ff51895c63afb6d8ad448a3f3e",
         "comment": "rk3288-veyron-jaq in lab-collabora"
         "misc": {
             "instance": "rk3288-veyron-jaq-cbg-1",
             "device": "rk3288-veyron-jaq",
             "mach": "rockchip",
             "lab": "lab-collabora",
         },
     }

The PR for the corresponding code change is up at:

     https://github.com/kernelci/kcidb-io/pull/20

Please don't hesitate to respond with any comments, objections, or
suggestions.

If there are no objections, I'll merge this change on Tuesday, Jan 19.

Nick