Fix event update logic for Kubernetes source

[pkosiec]

Description

Changes proposed in this pull request:

• Fix event update logic for Kubernetes source
  • when updateSetting.fields are provided, ensure there's a diff between these fields.
  • when there's no updateSetting.fields config, route all update events.
  • if includeDiff is true, print diff as a part of the message.
• Fix diff:
  • ensure it doesn't stop on first error
  • ensure we diff between empty property values (as something might be added/removed)
• Revert breaking changes in messages API extracted to Revert API changes for api.Message #1124

This bug was related to changes in our event dispatching system when extracting Kubernetes events to a separate plugin. An event was qualified to dispatch even if it didn't contain changes for the updateSetting.Fields.

This regression was introduced in 1.0.0.

Testing

Run Botkube from this PR with the following config:

communications:
  "default-group":
    socketSlack:
      enabled: true
      appToken: "xapp-"
      botToken: "xoxb-"
      channels:
        "default":
          name: botkube-demo
          bindings:
            executors:
              - k8s-default-tools
            sources:
              - k8s-all-events
plugins:
  cacheDir: /tmp
  repositories:
    botkube:
      url: http://localhost:3000/botkube.yaml

go run test/helpers/plugin_server.go
make build-plugins-single
export KUBECONFIG="..."
export BOTKUBE_SETTINGS_LOG_LEVEL=debug                     
export BOTKUBE_PLUGINS_CACHE__DIR="/tmp/plugins"
export BOTKUBE_SETTINGS_KUBECONFIG=$KUBECONFIG
export BOTKUBE_CONFIG_PATHS="$(pwd)/helm/botkube/values.yaml,$(pwd)/comm_config.yaml"
export LOG_LEVEL_SOURCE_BOTKUBE_KUBERNETES="debug"
go run ./cmd/botkube/main.go

Apply sample resource, e.g. STS:
k apply sts.yaml

apiVersion: apps/v1
kind: StatefulSet
metadata:
  name: web
spec:
  selector:
    matchLabels:
      app: nginx # has to match .spec.template.metadata.labels
  serviceName: "nginx"
  replicas: 3 # by default is 1
  minReadySeconds: 10 # by default is 0
  template:
    metadata:
      labels:
        app: nginx # has to match .spec.selector.matchLabels
    spec:
      terminationGracePeriodSeconds: 10
      containers:
      - name: nginx
        image: registry.k8s.io/nginx-slim:0.8
        ports:
        - containerPort: 80
          name: web
        volumeMounts:
        - name: www
          mountPath: /usr/share/nginx/html
  volumeClaimTemplates:
  - metadata:
      name: www
    spec:
      accessModes: [ "ReadWriteOnce" ]
      storageClassName: "my-storage-class"
      resources:
        requests:
          storage: 1Gi

Edit the resource:

k edit sts web

The following fields will trigger an update event:

                - spec.template.spec.containers[*].image
                - status.readyReplicas

So you can try multiple different edits to see if they trigger the updates.

For previous Botkube, any update of such STS would trigger an event.

Related issue(s)

Resolves #1081

[huseyinbabal]

Works as expected 👍