From 006eb579e5dd9c52a146ed56d1c6aadb6d271cb2 Mon Sep 17 00:00:00 2001
From: Jan Horstmann <horstmann@osism.tech>
Date: Thu, 7 Nov 2024 10:24:45 +0100
Subject: [PATCH] Add tests for whether mixin output is checked-in

With the proposed workflow mixin output is generated offline and
checked into version control for direct usage.
A test is added to check whether the generated rules and dashboards
match the checked-in version.
Additionally a check for the shellscript generating the mixins is added.

Signed-off-by: Jan Horstmann <horstmann@osism.tech>
---
 .../mixin-ouput-ensure-git-checkin.yml        | 38 +++++++++++++++++++
 .zuul.yaml                                    | 16 +++++---
 2 files changed, 49 insertions(+), 5 deletions(-)
 create mode 100644 .src/playbooks/mixin-ouput-ensure-git-checkin.yml

diff --git a/.src/playbooks/mixin-ouput-ensure-git-checkin.yml b/.src/playbooks/mixin-ouput-ensure-git-checkin.yml
new file mode 100644
index 0000000..55eaad1
--- /dev/null
+++ b/.src/playbooks/mixin-ouput-ensure-git-checkin.yml
@@ -0,0 +1,38 @@
+---
+- name: Run check-shell-syntax
+  connection: local
+  hosts: localhost
+  #hosts: all
+  vars:
+    zuul:
+      project:
+        src_dir: ../..
+  tasks:
+    - name: Build monitoring-mixin container
+      containers.podman.podman_image:
+        name: mixin-builder
+        path: "./{{ zuul.project.src_dir }}/.src"
+        build:
+          file: "./{{ zuul.project.src_dir }}/.src/Containerfile"
+    - name: Install monitoring-mixin dependencies
+      containers.podman.podman_container:
+        command: jb install
+        <<: &mixin_container_options
+          name: mixin-builder
+          image: localhost/mixin-builder
+          detach: false
+          volume:
+            - "./{{ zuul.project.src_dir }}:/srv"
+          rm: true
+    - name: Render monitoring-mixin rules / dashboards
+      containers.podman.podman_container:
+        <<: *mixin_container_options
+    - name: Check difference between git and generated rules / dashboards
+      ansible.builtin.command:
+        argv:
+          - /usr/bin/git
+          - diff
+          - --exit-code
+      register: git_diff
+      changed_when: false
+      failed_when: git_diff.rc != 0
diff --git a/.zuul.yaml b/.zuul.yaml
index 11b9930..494c733 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -1,13 +1,19 @@
 ---
+- job:
+    name: mixin-ouput-ensure-git-checkin
+    description: Check for differences between monitoring-mixin output and checked in rules/dashboards
+    run: .src/playbooks/mixin-ouput-ensure-git-checkin.yml
 - project:
     default-branch: main
     merge-mode: squash-merge
     check:
-      jobs:
+      jobs: &jobs
         - yamllint
+        - check-shell-syntax:
+            files: ^\.src/files/mixins.sh$
+        - mixin-ouput-ensure-git-checkin:
+            files: ^\.src/.*$
     gate:
-      jobs:
-        - yamllint
+      jobs: *jobs
     periodic-daily:
-      jobs:
-        - yamllint
+      jobs: *jobs