fix: change type of ansible_pre_tasks and ansible_post_tasks to a list. (#588)

Issue #587

Author: msuthar-splunk

docs/advanced/default.yml.spec.md

@@ -10,13 +10,13 @@
 The following is the full spec file for a `default.yml` that controls how Splunk gets provisioned.
 
 ```
-ansible_post_tasks: <str>
-* Comma-separated list of paths or URLs to custom Ansible playbooks to run AFTER Splunk has been setup using the provided site.yml
-* Default: null
+ansible_post_tasks: <list>
+* list of paths or URLs to custom Ansible playbooks to run AFTER Splunk has been setup using the provided site.yml
+* Default: []
 
-ansible_pre_tasks: <str>
-* Comma-separated list of paths or URLs to custom Ansible playbooks to run BEFORE Splunk sets up using the provided site.yml
-* Default: null
+ansible_pre_tasks: <list>
+* list of paths or URLs to custom Ansible playbooks to run BEFORE Splunk sets up using the provided site.yml
+* Default: []
 
 ansible_environment: <dict>
 * Map of environment variables used only during the execution context of all the Ansible tasks. For more information, see https://docs.ansible.com/ansible/latest/user_guide/playbooks_environment.html

inventory/environ.py

@@ -411,12 +411,32 @@ def getLaunchConf(vars_scope):
         launch.update({k:v for k,v in [x.split("=", 1) for x in settings.split(",")]})
     vars_scope["splunk"]["launch"] = launch
 
+def ensureListValue(value, separator):
+    if isinstance(value, list):
+        return value
+    elif (not value) or (not value.strip()):
+        return []
+    else:
+        return splitAndStrip(value, separator)
+
+def splitAndStrip(value, separator):
+    if not value:
+        return []
+    return [x.strip() for x in value.split(separator)]
+
+def transformEnvironmentVariable(environmentVariableName, transform, default):
+    if environmentVariableName in os.environ:
+        return transform(os.environ.get(environmentVariableName))
+    else:
+        return default
+
 def getAnsibleContext(vars_scope):
     """
     Parse parameters that influence Ansible execution
     """
-    vars_scope["ansible_pre_tasks"] = os.environ.get("SPLUNK_ANSIBLE_PRE_TASKS", vars_scope.get("ansible_pre_tasks"))
-    vars_scope["ansible_post_tasks"] = os.environ.get("SPLUNK_ANSIBLE_POST_TASKS", vars_scope.get("ansible_post_tasks"))
+    stringSeparator = ","
+    vars_scope["ansible_pre_tasks"] = transformEnvironmentVariable("SPLUNK_ANSIBLE_PRE_TASKS", lambda v: splitAndStrip(v, stringSeparator), ensureListValue(vars_scope.get("ansible_pre_tasks"), stringSeparator))
+    vars_scope["ansible_post_tasks"] = transformEnvironmentVariable("SPLUNK_ANSIBLE_POST_TASKS", lambda v: splitAndStrip(v, stringSeparator), ensureListValue(vars_scope.get("ansible_post_tasks"), stringSeparator))
     vars_scope["ansible_environment"] = vars_scope.get("ansible_environment") or {}
     env = os.environ.get("SPLUNK_ANSIBLE_ENV")
     if env:

site.yml

@@ -8,13 +8,16 @@
 
     - block:
         - name: Execute pre-setup playbooks
+          loop: "{{ ansible_pre_tasks }}"
+          loop_control:
+            loop_var: ansible_pre_tasks_item
           include_tasks: execute_adhoc_plays.yml
           vars:
-            playbook: "{{ ansible_pre_tasks }}"
+            playbook: "{{ ansible_pre_tasks_item }}"
           when:
-            - ansible_pre_tasks is defined
-            - ansible_pre_tasks is not none
-            - ansible_pre_tasks is match("^(http|https|file)://.*")
+            - ansible_pre_tasks_item is defined
+            - ansible_pre_tasks_item is not none
+            - ansible_pre_tasks_item is match("^(http|https|file)://.*")
 
         - name: Provision role
           include_role:
@@ -23,13 +26,16 @@
             - splunk.role is defined
 
         - name: Execute post-setup playbooks
+          loop: "{{ ansible_post_tasks }}"
+          loop_control:
+            loop_var: ansible_post_tasks_item
           include_tasks: execute_adhoc_plays.yml
           vars:
-            playbook: "{{ ansible_post_tasks }}"
+            playbook: "{{ ansible_post_tasks_item }}"
           when:
-            - ansible_post_tasks is defined
-            - ansible_post_tasks is not none
-            - ansible_post_tasks is match("^(http|https|file)://.*")
+            - ansible_post_tasks_item is defined
+            - ansible_post_tasks_item is not none
+            - ansible_post_tasks_item is match("^(http|https|file)://.*")
 
         - name: Check all instances for required restarts
           include_tasks: ./roles/splunk_common/tasks/check_for_required_restarts.yml

tests/small/test_environ.py

@@ -307,31 +307,76 @@ def test_getLaunchConf(default_yml, os_env, output):
             environ.getLaunchConf(vars_scope)
     assert vars_scope["splunk"] == output
 
+@pytest.mark.parametrize(("value", "separator", "output"),
+            [
+                # Check null value
+                (None, ",", []),
+                # Check empty value
+                ("", ",", []),
+                # Check string value
+                ("a", ",", ["a"]),
+                # Check comma separated string value
+                ("a,b,c", ",", ["a", "b", "c"]),
+                # Check list value
+                (["a"], ",", ["a"]),
+                (["a", "b", "c"], ",", ["a", "b", "c"])
+            ]
+        )
+def test_ensureListValue(value, separator, output):
+    result = environ.ensureListValue(value, separator)
+    assert result == output
+
+@pytest.mark.parametrize(("value", "separator", "output"),
+            [
+                # Check null value
+                (None, ",", []),
+                # Check empty value
+                ("", ",", []),
+                # Check string value
+                ("a", ",", ["a"]),
+                # Check comma separated string value
+                ("a,b,c", ",", ["a", "b", "c"]),
+                # Check comma separated string value with whitespaces
+                (" a, b,c ", ",", ["a", "b", "c"]),
+            ]
+        )
+def test_splitAndStrip(value, separator, output):
+    result = environ.splitAndStrip(value, separator)
+    assert result == output
+
 @pytest.mark.parametrize(("default_yml", "os_env", "output"),
             [
                 # Check null parameters
-                ({}, {}, {"ansible_pre_tasks": None, "ansible_post_tasks": None, "ansible_environment": {}}),
+                ({}, {}, {"ansible_pre_tasks": [], "ansible_post_tasks": [], "ansible_environment": {}}),
                 # Check ansible_pre_tasks using defaults or env vars
-                ({"ansible_pre_tasks": ""}, {}, {"ansible_pre_tasks": "", "ansible_post_tasks": None, "ansible_environment": {}}),
-                ({"ansible_pre_tasks": "a"}, {}, {"ansible_pre_tasks": "a", "ansible_post_tasks": None, "ansible_environment": {}}),
-                ({"ansible_pre_tasks": "a,b,c"}, {}, {"ansible_pre_tasks": "a,b,c", "ansible_post_tasks": None, "ansible_environment": {}}),
-                ({}, {"SPLUNK_ANSIBLE_PRE_TASKS": "d"}, {"ansible_pre_tasks": "d", "ansible_post_tasks": None, "ansible_environment": {}}),
-                ({}, {"SPLUNK_ANSIBLE_PRE_TASKS": "e,f,g"}, {"ansible_pre_tasks": "e,f,g", "ansible_post_tasks": None, "ansible_environment": {}}),
-                ({"ansible_pre_tasks": "a,b,c"}, {"SPLUNK_ANSIBLE_PRE_TASKS": "e,f,g"}, {"ansible_pre_tasks": "e,f,g", "ansible_post_tasks": None, "ansible_environment": {}}),
+                ({"ansible_pre_tasks": ""}, {}, {"ansible_pre_tasks": [], "ansible_post_tasks": [], "ansible_environment": {}}),
+                ({"ansible_pre_tasks": None}, {}, {"ansible_pre_tasks": [], "ansible_post_tasks": [], "ansible_environment": {}}),
+                ({"ansible_pre_tasks": "a"}, {}, {"ansible_pre_tasks": ["a"], "ansible_post_tasks": [], "ansible_environment": {}}),
+                ({"ansible_pre_tasks": ["a"]}, {}, {"ansible_pre_tasks": ["a"], "ansible_post_tasks": [], "ansible_environment": {}}),
+                ({"ansible_pre_tasks": "a,b,c"}, {}, {"ansible_pre_tasks": ["a","b","c"], "ansible_post_tasks": [], "ansible_environment": {}}),
+                ({"ansible_pre_tasks": ["a","b","c"]}, {}, {"ansible_pre_tasks": ["a","b","c"], "ansible_post_tasks": [], "ansible_environment": {}}),
+                ({}, {"SPLUNK_ANSIBLE_PRE_TASKS": "d"}, {"ansible_pre_tasks": ["d"], "ansible_post_tasks": [], "ansible_environment": {}}),
+                ({}, {"SPLUNK_ANSIBLE_PRE_TASKS": "e,f,g"}, {"ansible_pre_tasks": ["e","f","g"], "ansible_post_tasks": [], "ansible_environment": {}}),
+                ({"ansible_pre_tasks": "a,b,c"}, {"SPLUNK_ANSIBLE_PRE_TASKS": "e,f,g"}, {"ansible_pre_tasks": ["e","f","g"], "ansible_post_tasks": [], "ansible_environment": {}}),
+                ({"ansible_pre_tasks": ["a","b","c"]}, {"SPLUNK_ANSIBLE_PRE_TASKS": "e,f,g"}, {"ansible_pre_tasks": ["e","f","g"], "ansible_post_tasks": [], "ansible_environment": {}}),
                 # Check ansible_post_tasks using defaults or env vars
-                ({"ansible_post_tasks": ""}, {}, {"ansible_pre_tasks": None, "ansible_post_tasks": "", "ansible_environment": {}}),
-                ({"ansible_post_tasks": "a"}, {}, {"ansible_pre_tasks": None, "ansible_post_tasks": "a", "ansible_environment": {}}),
-                ({"ansible_post_tasks": "a,b,c"}, {}, {"ansible_pre_tasks": None, "ansible_post_tasks": "a,b,c", "ansible_environment": {}}),
-                ({}, {"SPLUNK_ANSIBLE_POST_TASKS": "d"}, {"ansible_pre_tasks": None, "ansible_post_tasks": "d", "ansible_environment": {}}),
-                ({}, {"SPLUNK_ANSIBLE_POST_TASKS": "e,f,g"}, {"ansible_pre_tasks": None, "ansible_post_tasks": "e,f,g", "ansible_environment": {}}),
-                ({"ansible_post_tasks": "a,b,c"}, {"SPLUNK_ANSIBLE_POST_TASKS": "e,f,g"}, {"ansible_pre_tasks": None, "ansible_post_tasks": "e,f,g", "ansible_environment": {}}),
+                ({"ansible_post_tasks": ""}, {}, {"ansible_pre_tasks": [], "ansible_post_tasks": [], "ansible_environment": {}}),
+                ({"ansible_post_tasks": None}, {}, {"ansible_pre_tasks": [], "ansible_post_tasks": [], "ansible_environment": {}}),
+                ({"ansible_post_tasks": "a"}, {}, {"ansible_pre_tasks": [], "ansible_post_tasks": ["a"], "ansible_environment": {}}),
+                ({"ansible_post_tasks": ["a"]}, {}, {"ansible_pre_tasks": [], "ansible_post_tasks": ["a"], "ansible_environment": {}}),
+                ({"ansible_post_tasks": "a,b,c"}, {}, {"ansible_pre_tasks": [], "ansible_post_tasks": ["a","b","c"], "ansible_environment": {}}),
+                ({"ansible_post_tasks": ["a","b","c"]}, {}, {"ansible_pre_tasks": [], "ansible_post_tasks": ["a","b","c"], "ansible_environment": {}}),
+                ({}, {"SPLUNK_ANSIBLE_POST_TASKS": "d"}, {"ansible_pre_tasks": [], "ansible_post_tasks": ["d"], "ansible_environment": {}}),
+                ({}, {"SPLUNK_ANSIBLE_POST_TASKS": "e,f,g"}, {"ansible_pre_tasks": [], "ansible_post_tasks": ["e","f","g"], "ansible_environment": {}}),
+                ({"ansible_post_tasks": "a,b,c"}, {"SPLUNK_ANSIBLE_POST_TASKS": "e,f,g"}, {"ansible_pre_tasks": [], "ansible_post_tasks": ["e","f","g"], "ansible_environment": {}}),
+                ({"ansible_post_tasks": ["a","b","c"]}, {"SPLUNK_ANSIBLE_POST_TASKS": "e,f,g"}, {"ansible_pre_tasks": [], "ansible_post_tasks": ["e","f","g"], "ansible_environment": {}}),
                 # Check ansible_environment using defaults or env vars
-                ({"ansible_environment": None}, {}, {"ansible_pre_tasks": None, "ansible_post_tasks": None, "ansible_environment": {}}),
-                ({"ansible_environment": {"a": "b"}}, {}, {"ansible_pre_tasks": None, "ansible_post_tasks": None, "ansible_environment": {"a": "b"}}),
-                ({"ansible_environment": {"a": "b", "d": "e"}}, {}, {"ansible_pre_tasks": None, "ansible_post_tasks": None, "ansible_environment": {"a": "b", "d": "e"}}),
-                ({}, {"SPLUNK_ANSIBLE_ENV": "a=b"}, {"ansible_pre_tasks": None, "ansible_post_tasks": None, "ansible_environment": {"a": "b"}}),
-                ({}, {"SPLUNK_ANSIBLE_ENV": "a=b,x=y"}, {"ansible_pre_tasks": None, "ansible_post_tasks": None, "ansible_environment": {"a": "b", "x": "y"}}),
-                ({"ansible_environment": {"a": "c", "d": "e"}}, {"SPLUNK_ANSIBLE_ENV": "a=b,x=y"}, {"ansible_pre_tasks": None, "ansible_post_tasks": None, "ansible_environment": {"a": "b", "d": "e", "x": "y"}}),
+                ({"ansible_environment": None}, {}, {"ansible_pre_tasks": [], "ansible_post_tasks": [], "ansible_environment": {}}),
+                ({"ansible_environment": {"a": "b"}}, {}, {"ansible_pre_tasks": [], "ansible_post_tasks": [], "ansible_environment": {"a": "b"}}),
+                ({"ansible_environment": {"a": "b", "d": "e"}}, {}, {"ansible_pre_tasks": [], "ansible_post_tasks": [], "ansible_environment": {"a": "b", "d": "e"}}),
+                ({}, {"SPLUNK_ANSIBLE_ENV": "a=b"}, {"ansible_pre_tasks": [], "ansible_post_tasks": [], "ansible_environment": {"a": "b"}}),
+                ({}, {"SPLUNK_ANSIBLE_ENV": "a=b,x=y"}, {"ansible_pre_tasks": [], "ansible_post_tasks": [], "ansible_environment": {"a": "b", "x": "y"}}),
+                ({"ansible_environment": {"a": "c", "d": "e"}}, {"SPLUNK_ANSIBLE_ENV": "a=b,x=y"}, {"ansible_pre_tasks": [], "ansible_post_tasks": [], "ansible_environment": {"a": "b", "d": "e", "x": "y"}}),
             ]
         )
 def test_getAnsibleContext(default_yml, os_env, output):