Merge pull request #116 from marcelmamula/issue101

sap_hypervisor_node_preconfigure: Fix ansible-lint errors from issue 101

Author: marcelmamula

.ansible-lint

@@ -5,11 +5,10 @@ exclude_paths:
   - .ansible/
   - .cache/
   - .github/
-  #- docs/
+  - docs/
   - changelogs/  # Changelog files are missing '---' required in normal yml files.
   - roles/sap_vm_preconfigure  # Role is WIP
-  # TODO: Remove when ansible-lint issues are resolved (Issue #101).
-  - roles/sap_hypervisor_node_preconfigure
+  - roles/sap_vm_verify  # Role is WIP
 
 enable_list:
   - yaml
@@ -25,10 +24,15 @@ skip_list:
   - schema
   # Allow templating inside name because it creates more detailed output:
   - name[template]
-  - yaml[comments]
-  - yaml[line-length]
+  # Allow command tasks without defining changed_when
   - no-changed-when
-  - no-tabs
+  # Allow tasks that could be replaced by handlers
   - no-handler
+  # Disable jinja formatting check
   - jinja[spacing]
-  - var-naming[no-jinja]
+
+  # Disabled skips, because they are not not required now.
+  # - yaml[comments]
+  # - yaml[line-length]
+  # - no-tabs
+  # - var-naming[no-jinja]

roles/sap_hypervisor_node_preconfigure/.ansible-lint

@@ -1,4 +1,5 @@
 ---
 
-# ibmpower_phyp, redhat_ocp_virt, redhat_rhel_kvm, vmware_vsphere
-sap_hypervisor_node_preconfigure_platform:
+# Define which hypervisor platform to use (String).
+# Available options: redhat_ocp_virt, redhat_rhel_kvm
+sap_hypervisor_node_preconfigure_platform: ''

roles/sap_hypervisor_node_preconfigure/defaults/main.yml

@@ -1,3 +1,5 @@
 ---
 - name: Hypervisor node preconfigure - Include Handler Tasks for {{ sap_hypervisor_node_preconfigure_platform }}
-  ansible.builtin.import_tasks: "platform/{{ sap_hypervisor_node_preconfigure_platform }}/main.yml"
+  ansible.builtin.include_tasks:
+    file: "platform/{{ sap_hypervisor_node_preconfigure_platform }}/main.yml"
+  when: (role_path ~ '/handlers/platform/' ~ sap_hypervisor_node_preconfigure_platform ~ '/main.yml') is file

roles/sap_hypervisor_node_preconfigure/handlers/main.yml

@@ -1,6 +1,21 @@
 ---
+- name: Assert that the variable 'sap_hypervisor_node_preconfigure_platform' is defined and valid
+  ansible.builtin.assert:
+    that:
+      - sap_hypervisor_node_preconfigure_platform is defined
+      - sap_hypervisor_node_preconfigure_platform is string
+      - sap_hypervisor_node_preconfigure_platform | trim | length > 0
+      - sap_hypervisor_node_preconfigure_platform in ['redhat_ocp_virt', 'redhat_rhel_kvm']
+    fail_msg: |
+      The variable 'sap_hypervisor_node_preconfigure_platform' is undefined or invalid.
+      Available options: redhat_ocp_virt, redhat_rhel_kvm
+
 - name: SAP certified hypervisor node preconfigure - Include Vars for {{ sap_hypervisor_node_preconfigure_platform }}
-  ansible.builtin.include_vars: "platform_defaults_{{ sap_hypervisor_node_preconfigure_platform }}.yml"
+  ansible.builtin.include_vars:
+    file: "platform_defaults_{{ sap_hypervisor_node_preconfigure_platform }}.yml"
+  when: (role_path ~ '/vars/platform_defaults_' ~ sap_hypervisor_node_preconfigure_platform ~ '.yml') is file
 
 - name: SAP certified hypervisor node preconfigure - Include Tasks for {{ sap_hypervisor_node_preconfigure_platform }}
-  ansible.builtin.include_tasks: "platform/{{ sap_hypervisor_node_preconfigure_platform }}/main.yml"
+  ansible.builtin.include_tasks:
+    file: "platform/{{ sap_hypervisor_node_preconfigure_platform }}/main.yml"
+  when: (role_path ~ '/tasks/platform/' ~ sap_hypervisor_node_preconfigure_platform ~ '/main.yml') is file

roles/sap_hypervisor_node_preconfigure/tasks/main.yml

@@ -1,5 +1,5 @@
 ---
-- name: Wait for worker MachineConfigPool to start updating
+- name: Wait for worker MachineConfigPool to start updating  # noqa: ignore-errors
   kubernetes.core.k8s_info:
     api_version: machineconfiguration.openshift.io/v1
     kind: MachineConfigPool

roles/sap_hypervisor_node_preconfigure/tasks/platform/redhat_ocp_virt/cluster/wait-mcp-finished-updating.yml

@@ -45,7 +45,7 @@
     __sap_hypervisor_node_preconfigure_register_worker_memory_gib:
       "{{ (__sap_hypervisor_node_preconfigure_register_nodes[0]['status']['capacity']['memory'] | replace('Ki', '') | int / 1048576) }}"
 
-- name: Check if host has minimal amount of memory (96GiB)
+- name: Check if host has minimal amount of memory (96GiB)  # noqa: ignore-errors
   ansible.builtin.assert:
     that: __sap_hypervisor_node_preconfigure_register_worker_memory_gib | int >= 96
     fail_msg: "Not enough memory on node {{ __sap_hypervisor_node_preconfigure_register_worker_name }}"

roles/sap_hypervisor_node_preconfigure/tasks/platform/redhat_ocp_virt/main.yml

@@ -56,7 +56,7 @@
   vars:
     install_plan_name: "{{ __sap_hypervisor_node_preconfigure_register_cnv_subscription_install_plan_name.stdout }}"
   block:
-    - name: Get Install Plan details
+    - name: Get Install Plan details  # noqa: ignore-errors
       kubernetes.core.k8s_info:
         api_version: operators.coreos.com/v1alpha1
         kind: InstallPlan
@@ -73,7 +73,7 @@
         msg: "Install Plan is not Complete after the specified wait period."
       when: __sap_hypervisor_node_preconfigure_register_wait_for_installplan.resources[0].status.phase != "Complete"
 
-- name: Wait and check for pod with label name hyperconverged-cluster-webhook under "{{ sap_hypervisor_node_preconfigure_ocpv_namespace }}" namespace
+- name: Wait and check for pod with label name hyperconverged-cluster-webhook under the namespace "{{ sap_hypervisor_node_preconfigure_ocpv_namespace }}"
   kubernetes.core.k8s_info:
     kind: Pod
     namespace: "{{ sap_hypervisor_node_preconfigure_ocpv_namespace }}"
@@ -84,7 +84,7 @@
   delay: 60
   until: hco_webhook_pod.resources | selectattr('status.phase', 'equalto', 'Running') | list | length == hco_webhook_pod.resources | length
 
-- name: Wait and check for pod with name hco-webhook under "{{ sap_hypervisor_node_preconfigure_ocpv_namespace }}" namespace
+- name: Wait and check for pod with name hco-webhook under the namespace "{{ sap_hypervisor_node_preconfigure_ocpv_namespace }}"
   kubernetes.core.k8s_info:
     kind: Pod
     namespace: "{{ sap_hypervisor_node_preconfigure_ocpv_namespace }}"
@@ -95,7 +95,7 @@
   delay: 60
   until: __sap_hypervisor_node_preconfigure_register_hco_webhook_pod.resources | selectattr('status.phase', 'equalto', 'Running') | list | length == __sap_hypervisor_node_preconfigure_register_hco_webhook_pod.resources | length
 
-- name: Wait and check if hco-webhook-service exists in "{{ sap_hypervisor_node_preconfigure_ocpv_namespace }}" namespace
+- name: Wait and check if hco-webhook-service exists in the namespace "{{ sap_hypervisor_node_preconfigure_ocpv_namespace }}"
   kubernetes.core.k8s_info:
     kind: Service
     namespace: "{{ sap_hypervisor_node_preconfigure_ocpv_namespace }}"

roles/sap_hypervisor_node_preconfigure/tasks/platform/redhat_ocp_virt/operators/install-cnv-operator.yml

@@ -100,7 +100,7 @@
   delay: 10
   until: nmstate_status.resources | length > 0
 
-- name: Wait and check for pod with label name nmstate-webhook under "{{ sap_hypervisor_node_preconfigure_nmstate_namespace }}" namespace
+- name: Wait and check for pod with label name nmstate-webhook under the namespace "{{ sap_hypervisor_node_preconfigure_nmstate_namespace }}"
   kubernetes.core.k8s_info:
     kind: Pod
     namespace: "{{ sap_hypervisor_node_preconfigure_nmstate_namespace }}"

roles/sap_hypervisor_node_preconfigure/tasks/platform/redhat_ocp_virt/operators/install-nmstate-operator.yml

@@ -47,7 +47,7 @@
   delay: 10
   until: subscription_status.resources[0].status.installplan.name is defined
 
-- name: Wait for InstallPlan to complete for SR-IOV
+- name: Wait for InstallPlan to complete for SR-IOV  # noqa: ignore-errors
   kubernetes.core.k8s_info:
     api_version: operators.coreos.com/v1alpha1
     kind: InstallPlan
@@ -56,7 +56,7 @@
   register: installplan_status
   retries: 30
   delay: 10
-  ignore_errors: yes
+  ignore_errors: true
   until: installplan_status.resources[0].status.phase == "Complete"
 
 - name: Verify SR-IOV Operator is running
@@ -70,14 +70,14 @@
   delay: 10
   until: operatorgroup_status.resources
 
-- name: Check if SriovOperatorConfig exists
+- name: Check if SriovOperatorConfig exists  # noqa: ignore-errors
   kubernetes.core.k8s_info:
     api_version: sriovnetwork.openshift.io/v1
     kind: SriovOperatorConfig
     name: default
     namespace: openshift-sriov-network-operator
   register: sriov_operator_config_status
-  ignore_errors: yes
+  ignore_errors: true
 
 - name: Enable unsupported NICs for SR-IOV usage if the resource exists
   kubernetes.core.k8s: