nolar / kopf / 32

87%

main: 0%

push

travis-ci

Store compact JSON in annotations for better presentation in kubectl

Improve how the annotations look like in `kubectl` yaml-format: as one line,
not wrapped at arbitrary spaces, making it difficult to read and debug.

It will still be wrapped at spaces in the handler's progress field, e.g. message
(which contains error/exception messages), but this happens not so often.

The behaviour of the operators during the switch is not affected: they only
compare and operate on the actual values, not their string representation.
Mass-recoding is not expected either: the existing fields will be compacted
only on the next occasion when they are written for any other reason.

Note: this is the same as `kubectl` itself stores its own annotation.

Compare the output of a command during a sample operator run:

```
kubectl get -o yaml -f examples/obj.yaml
```

Before:

```
apiVersion: zalando.org/v1
kind: KopfExample
metadata:
  annotations:
    kopf.zalando.org/last-handled-configuration: '{"spec":{"duration":"1m","field":"value","items":["item1","item2"],"x":600},"metadata":{"labels":{"somelabel":"somevalue"},"annotations":{"someannotation":"somevalue"}}}'
    kopf.zalando.org/update: '{"started": "2020-08-22T19:38:36.850462", "delayed":
      "2020-08-22T19:38:37.277965", "retries": 4, "success": false, "failure": false,
      "message": "None", "subrefs": ["update/s1", "update/s2", "update/s2/z1", "update/s2/z2",
      "update/s3", "update/s4", "update/s4/z1", "update/s4/z2"]}'
    kopf.zalando.org/update.s1: '{"started": "2020-08-22T19:38:36.851463", "stopped":
      "2020-08-22T19:38:36.853665", "retries": 1, "success": true, "failure": false}'
    kopf.zalando.org/update.s2: '{"started": "2020-08-22T19:38:36.851542", "stopped":
      "2020-08-22T19:38:37.134753", "retries": 2, "success": true, "failure": false,
      "subrefs": ["update/s2/z1", "update/s2/z2"]}'
    kopf.zalando.org/update.s2.z1: '{"started": "2020-08-22T19:38:36.997186", "stopped":
      "20... (continued)

921 of 1177 branches covered (78.25%)

Branch coverage included in aggregate %.

3326 of 3845 relevant lines covered (86.5%)

8.6 hits per line