Merge pull request #432 from nextcloud/read-vars-for-occ-args

Allow occ based modules to consume ansible vars for their common arguments

Author: aalaesar

plugins/action/run_occ.py

@@ -12,12 +12,30 @@ class ActionModule(ActionBase):
     def run(self, tmp=None, task_vars=None):
         del tmp  # tmp no longer has any effect
         new_module_args = copy.deepcopy(self._task.args)
-        new_module_args["nextcloud_path"] = self._task.args.get(
-            "nextcloud_path", os.getenv("NEXTCLOUD_PATH")
+
+        # missing occ common arguments fallback
+        # argument value precedence: args > task_vars > environment
+        nextcloud_path = (
+            self._task.args.get("nextcloud_path")
+            or task_vars.get("nextcloud_path")
+            or os.getenv("NEXTCLOUD_PATH")
         )
-        if not new_module_args["nextcloud_path"]:
+        if nextcloud_path:
+            new_module_args["nextcloud_path"] = nextcloud_path
+        elif "nextcloud_path" in new_module_args:
             del new_module_args["nextcloud_path"]
 
+        # argument value precedence: args > task_vars > environment > default
+        php_runtime = (
+            self._task.args.get("php_runtime")
+            or task_vars.get("nextcloud_php_runtime")
+            or os.getenv("NEXTCLOUD_PHP_RUNTIME")
+        )
+        if php_runtime:
+            new_module_args["php_runtime"] = php_runtime
+        elif "php_runtime" in new_module_args:
+            del new_module_args["php_runtime"]
+
         return self._execute_module(
             module_name=self._task.action,
             module_args=new_module_args,

plugins/doc_fragments/occ_common_options.py

@@ -31,7 +31,8 @@ class ModuleDocFragment(object):
   nextcloud_path:
     description:
       - Specify the nextcloud instance's location in the host.
-      - Rollback to NEXTCLOUD_PATH environment variable on the ansible host
+      - If not specified, the module will attempt to use the `nextcloud_path` var if it exists.
+      - In last resort, read the `NEXTCLOUD_PATH` environment variable on the ansible host.
     type: str
     aliases:
       - path
@@ -43,6 +44,8 @@ class ModuleDocFragment(object):
     description:
       - Specify the php runtime used to run the occ tool.
       - Can be an absolute or relative path if the runtime is available in the remote host PATH.
+      - If not specified, the module will attempt to use the `nextcloud_php_runtime` var if it exists,
+        then the `NEXTCLOUD_PHP_RUNTIME` environment variable on the ansible host.
     type: str
     default: php
     aliases: