feat: add yamlfmt support

added pre-commit check to catch shellcheck and yamlfmt errors
added pre-commit install and uninstall tasks to Makefile
added yamlfmt script and config to format and verify yaml files

Signed-off-by: ehila <ehila@redhat.com>

Author: eggfoobar

.yamlfmt

@@ -0,0 +1,7 @@
+formatter:
+  type: basic
+  include_document_start: true
+  trim_trailing_whitespace: true
+  retain_line_breaks_single: true
+  scan_folded_as_literal: true
+output_format: line

Makefile

@@ -1,3 +1,20 @@
 
 shellcheck:
-	@./hack/shellcheck.sh
+	@./hack/shellcheck.sh
+
+yamlfmt:
+	@./hack/yamlfmt.sh
+
+verify:
+	VALIDATE_ONLY=true $(MAKE) shellcheck
+	VALIDATE_ONLY=true $(MAKE) yamlfmt
+
+install-pre-commit:
+	@echo "Installing pre-commit hook..."
+	@ln -sf ../../hack/pre-commit .git/hooks/pre-commit
+	@echo "Pre-commit hook installed successfully!"
+
+uninstall-pre-commit:
+	@echo "Uninstalling pre-commit hook..."
+	@rm -f .git/hooks/pre-commit
+	@echo "Pre-commit hook uninstalled successfully!"

deploy/openshift-clusters/clean.yml

@@ -1,3 +1,4 @@
+---
 - hosts: metal_machine
   roles:
     - dev-scripts/clean

deploy/openshift-clusters/collections/requirements.yml

@@ -8,8 +8,8 @@ collections:
   - name: kubernetes.core
     version: ">=2.4.0"
   - name: containers.podman
-    version: ">=1.10.0" 
+    version: ">=1.10.0"
   - name: ansible.posix
     version: ">=2.0"
   - name: community.general
-    version: ">=5.0.0"
+    version: ">=5.0.0"

deploy/openshift-clusters/init-host.yml

@@ -10,10 +10,10 @@
   # --- Variable Definitions ---
   vars_files:
     - vars/init-host.yml
-    - vars/init-host.yml.local  # Optional override file (ignored by git)
+    - vars/init-host.yml.local # Optional override file (ignored by git)
 
   vars:
-    # Additional variables can be defined here or overridden via command line
+  # Additional variables can be defined here or overridden via command line
 
   # --- Pre-flight Checks ---
   pre_tasks:
@@ -47,7 +47,7 @@
       register: rhsm_key_prompt
       delegate_to: localhost
       run_once: true
-      when: 
+      when:
         - not rhsm_already_registered
         - interactive_mode | bool
         - rhsm_activation_key is not defined
@@ -233,7 +233,7 @@
   post_tasks:
     - name: Host initialization completed
       ansible.builtin.debug:
-        msg: |
+        msg: |-
           Host initialization completed successfully:
           - Hostname set to: {{ hostname_prefix }}
           - User '{{ init_user }}' configured with sudo access

deploy/openshift-clusters/kcli-install.yml

@@ -11,13 +11,13 @@
   collections:
     - community.libvirt
     - kubernetes.core
-  
+
   # --- Variable Definitions ---
   vars:
     # Default to non-interactive mode to prevent prompts during automated runs
     # Set interactive_mode: true to enable prompts for manual execution
     interactive_mode: false
-    
+
     # Default topology is fencing (can be overridden to 'arbiter' if needed, not supported at the moment)
     # This default ensures no prompt is triggered when interactive_mode is false
     topology: fencing
@@ -85,34 +85,34 @@
     - vars/main.yml
 
   tasks:
-  # Setup proxy access as a separate step after cluster deployment
-  - name: Setup proxy access
-    include_role:
-      name: proxy-setup
-    vars:
-      kubeconfig_path: "{{ ansible_user_dir }}/.kcli/clusters/{{ test_cluster_name }}/auth/kubeconfig"
-      kubeadmin_password_path: "{{ ansible_user_dir }}/.kcli/clusters/{{ test_cluster_name }}/auth/kubeadmin-password"
-
-  - name: Update inventory with cluster VMs
-    include_tasks: roles/common/tasks/update-cluster-inventory.yml
-
-  # Configure stonith fencing after cluster installation
-  - name: Configure Redfish BMC simulation for fencing topology
-    shell: ansible-playbook kcli-redfish.yml -i {{ inventory_file | default('inventory.ini') }}
-    args:
-      chdir: "{{ playbook_dir }}"
-    delegate_to: localhost
-    run_once: true
-    when: topology == "fencing"
-
-  - name: "Final verification message"
-    ansible.builtin.debug:
-      msg: |
-        Installation tasks have completed for {{ topology }} topology.
-        
-        Next steps:
-        1. Source the proxy environment from anywhere:
-           source {{ playbook_dir }}/proxy.env
-           (or from openshift-clusters directory: source proxy.env)
-        2. Verify cluster access: oc get nodes
-        3. Access the cluster console if needed
+    # Setup proxy access as a separate step after cluster deployment
+    - name: Setup proxy access
+      include_role:
+        name: proxy-setup
+      vars:
+        kubeconfig_path: "{{ ansible_user_dir }}/.kcli/clusters/{{ test_cluster_name }}/auth/kubeconfig"
+        kubeadmin_password_path: "{{ ansible_user_dir }}/.kcli/clusters/{{ test_cluster_name }}/auth/kubeadmin-password"
+
+    - name: Update inventory with cluster VMs
+      include_tasks: roles/common/tasks/update-cluster-inventory.yml
+
+    # Configure stonith fencing after cluster installation
+    - name: Configure Redfish BMC simulation for fencing topology
+      shell: ansible-playbook kcli-redfish.yml -i {{ inventory_file | default('inventory.ini') }}
+      args:
+        chdir: "{{ playbook_dir }}"
+      delegate_to: localhost
+      run_once: true
+      when: topology == "fencing"
+
+    - name: "Final verification message"
+      ansible.builtin.debug:
+        msg: |-
+          Installation tasks have completed for {{ topology }} topology.
+
+          Next steps:
+          1. Source the proxy environment from anywhere:
+             source {{ playbook_dir }}/proxy.env
+             (or from openshift-clusters directory: source proxy.env)
+          2. Verify cluster access: oc get nodes
+          3. Access the cluster console if needed

deploy/openshift-clusters/kcli-redfish.yml

@@ -58,7 +58,7 @@
             - name: Proxy environment configuration used
               debug:
                 msg: |
-                 
+
                   Using proxy.env file for cluster access configuration.
                   Proxy settings have been applied to the kcli-redfish role.
 
@@ -69,10 +69,10 @@
             - name: No proxy environment detected
               debug:
                 msg: |
-                 
+
                   proxy.env file not found. Assuming direct cluster access.
                   The kcli-redfish role will run without proxy configuration.
-                  
+
                   Note: Ensure your current environment has:
                   - Valid KUBECONFIG environment variable or ~/.kube/config
                   - Direct network access to the OpenShift cluster API
@@ -87,15 +87,15 @@
       rescue:
         - name: Handle kcli-redfish configuration errors
           debug:
-            msg: |
+            msg: |-
               An error occurred while running kcli-redfish configuration.
               Error details: {{ ansible_failed_result.msg | default('Unknown error') }}
-              
+
               Common issues:
               1. Ensure cluster is deployed with kcli and fencing topology
               2. Verify ksushy BMC simulator is running on the hypervisor
               3. Check that kcli clusters are running: kcli list cluster
               4. Verify you're running this on the correct inventory host (hypervisor)
-              
+
               You can override auto-detection with explicit variables:
-              ansible-playbook kcli-redfish.yml -e "test_cluster_name=your-cluster" 
+              ansible-playbook kcli-redfish.yml -e "test_cluster_name=your-cluster"

deploy/openshift-clusters/redeploy.yml

@@ -1,3 +1,4 @@
+---
 - hosts: metal_machine
   gather_facts: no
   force_handlers: yes
@@ -36,7 +37,7 @@
              - Recovers from incomplete/failed deployment state
 
           3. COMPLETE REBUILD (different topology):
-             - Two-node with fencing ↔ Two-node with arbiter  
+             - Two-node with fencing ↔ Two-node with arbiter
              - Uses make realclean + full installation from scratch
              - Slower but guarantees clean state with correct topology
 
@@ -81,7 +82,7 @@
           REASON: Cluster topology change detected
           NOTE: Ensures completely clean state but takes longest time
           {% elif clean_needed | bool %}
-          STRATEGY: Clean deployment (make clean + full install)  
+          STRATEGY: Clean deployment (make clean + full install)
           REASON: Previous deployment incomplete or status unknown
           NOTE: Recovers from incomplete state, faster than complete rebuild
           {% else %}
@@ -97,7 +98,7 @@
         prompt: |-
           Please verify the information above is correct. Press Enter to proceed with:
           {% if vm_cleanup_needed | bool %}COMPLETE REBUILD
-          {% elif clean_needed | bool %}CLEAN DEPLOYMENT  
+          {% elif clean_needed | bool %}CLEAN DEPLOYMENT
           {% else %}FAST REDEPLOY
           {% endif %}
       delegate_to: localhost
@@ -123,14 +124,14 @@
         chdir: "{{ dev_scripts_path }}"
         target: clean
       register: clean_result
-      when: 
+      when:
         - clean_needed | bool
-        - not (vm_cleanup_needed | bool)  # Don't clean if we already did realclean
+        - not (vm_cleanup_needed | bool) # Don't clean if we already did realclean
 
     - name: Display clean completion
       ansible.builtin.debug:
         msg: "Clean completed - ready for fresh installation to recover from incomplete state"
-      when: 
+      when:
         - clean_needed | bool
         - not (vm_cleanup_needed | bool)
 
@@ -141,5 +142,4 @@
   post_tasks:
     - name: Update inventory with cluster VMs
       include_tasks: roles/common/tasks/update-cluster-inventory.yml
-
-  # Cluster state management is now handled by the install-dev role
+      # Cluster state management is now handled by the install-dev role

deploy/openshift-clusters/redfish.yml

@@ -56,7 +56,7 @@
             - name: Proxy environment configuration used
               debug:
                 msg: |
-                 
+
                   Using proxy.env file for cluster access configuration.
                   Proxy settings have been applied to the redfish role.
 
@@ -67,10 +67,10 @@
             - name: No proxy environment detected
               debug:
                 msg: |
-                 
+
                   proxy.env file not found. Assuming direct cluster access.
                   The redfish role will run without proxy configuration.
-                  
+
                   Note: Ensure your current environment has:
                   - Valid KUBECONFIG environment variable or ~/.kube/config
                   - Direct network access to the OpenShift cluster API
@@ -84,9 +84,9 @@
       rescue:
         - name: Handle redfish configuration errors
           debug:
-            msg: |
+            msg: |-
               An error occurred while running redfish configuration.
               Error details: {{ ansible_failed_result.msg | default('Unknown error') }}
-              
+
               You can try running manually:
-              source proxy.env && ansible-playbook -i localhost, roles/redfish/tasks/main.yml 
+              source proxy.env && ansible-playbook -i localhost, roles/redfish/tasks/main.yml

deploy/openshift-clusters/roles/common/tasks/cluster-state.yml

@@ -37,7 +37,7 @@
     force: yes
   delegate_to: localhost
   run_once: true
-  when: 
+  when:
     - ansible_check_mode == false
     - cluster_state_phase is defined and cluster_state_phase == 'deploying'
 
@@ -71,7 +71,7 @@
     force: yes
   delegate_to: localhost
   run_once: true
-  when: 
+  when:
     - ansible_check_mode == false
     - cluster_state_phase is defined and cluster_state_phase == 'deployed'
 
@@ -106,7 +106,7 @@
     force: yes
   delegate_to: localhost
   run_once: true
-  when: 
+  when:
     - install_dev_mode is defined and install_dev_mode == 'redeploy'
     - ansible_check_mode == false
     - cluster_state_phase is defined and cluster_state_phase == 'deployed'
@@ -120,6 +120,6 @@
       - Status: DEPLOYED (cluster successfully redeployed)
       - Redeployed at: {{ now(utc=True).isoformat() }}
   run_once: true
-  when: 
+  when:
     - install_dev_mode is defined and install_dev_mode == 'redeploy'
-    - cluster_state_phase is defined and cluster_state_phase == 'deployed'
+    - cluster_state_phase is defined and cluster_state_phase == 'deployed'