Updating deprecation variable check to use a module for cleaner output and use run_once to limit to one host. Add flag to skip dep check if desired

roles/openshift_sanitize_inventory/action_plugins/check_deprecated.py

@@ -0,0 +1,36 @@
+"""
+Ansible action plugin to check for usage of deprecated variables in Openshift Ansible inventory files.
+"""
+
+from ansible.plugins.action import ActionBase
+
+
+# pylint: disable=too-few-public-methods
+class ActionModule(ActionBase):
+    """Action plugin to execute deprecated var checks."""
+
+    def run(self, tmp=None, task_vars=None):
+        result = super(ActionModule, self).run(tmp, task_vars)
+
+        # pylint: disable=line-too-long
+        deprecation_header = "[DEPRECATION WARNING]: The following are deprecated variables and will be no longer be used in the next minor release. Please update your inventory accordingly."
+
+        facts = self._task.args.get('facts', [])
+        dep_var_list = self._task.args.get('vars', [])
+        dep_header = self._task.args.get('header', deprecation_header)
+
+        deprecation_message = "No deprecations found"
+        is_changed = False
+
+        for param in dep_var_list:
+            if param in facts:
+                if not is_changed:
+                    deprecation_message = dep_header
+                    is_changed = True
+
+                deprecation_message = deprecation_message + "\n\t" + param
+
+        result['changed'] = is_changed
+        result['msg'] = deprecation_message
+
+        return result

roles/openshift_sanitize_inventory/tasks/deprecations.yml

@@ -1,21 +1,20 @@
 ---
 
 - name: Check for usage of deprecated variables
-  set_fact:
-    __deprecation_message: "{{ __deprecation_message | default( __deprecation_header ) }} \n\t{{ item }}"
-  when:
-  - hostvars[inventory_hostname][item] is defined
-  with_items: "{{ __warn_deprecated_vars }}"
+  check_deprecated:
+    facts: "{{ hostvars[inventory_hostname] }}"
+    vars: "{{ __warn_deprecated_vars }}"
+    header: "{{ __deprecation_header }}"
+  register: dep_check
 
 - block:
-  - debug: msg="{{__deprecation_message}}"
-  - run_once: true
-    set_stats:
+  - debug: msg="{{ dep_check.msg }}"
+  - set_stats:
       data:
         installer_phase_initialize:
-          message: "{{ __deprecation_message }}"
+          message: "{{ dep_check.msg }}"
   when:
-  - __deprecation_message | default ('') | length > 0
+  - dep_check.changed
 
 # for with_fileglob Ansible resolves the path relative to the roles/<rolename>/files directory
 - name: Assign deprecated variables to correct counterparts

roles/openshift_sanitize_inventory/tasks/main.yml

@@ -2,6 +2,7 @@
 # We should print out deprecations prior to any failures so that if a play does fail for other reasons
 # the user would also be aware of any deprecated variables they should note to adjust
 - include_tasks: deprecations.yml
+  when: not ( openshift_skip_deprecation_check | default(false) ) | bool
 
 - name: Standardize on latest variable names
   set_fact: