added the possibility to copy template - not ready

plugins/action/virtualenv.py

@@ -6,18 +6,26 @@
 __metaclass__ = type
 
 import os
+import tempfile
+import shutil
+
+from ansible import constants as C
 from ansible.plugins.action import ActionBase
+from ansible.errors import AnsibleError, AnsibleFileNotFound, AnsibleAction, AnsibleActionFail
+from ansible.module_utils.common.text.converters import to_bytes, to_text
 from ansible.plugins.filter.core import to_json
-from ansible_collections.mafalb.ansible.plugins.filter.ansible import best_version
-from ansible_collections.mafalb.ansible.plugins.filter.ansible import (
-    pip_package_list as fix_package_list)
+from ansible.template import generate_ansible_template_vars, AnsibleEnvironment
+from ansible_collections.mafalb.ansible.plugins.filter.ansible import package_list
 from ansible.utils.display import Display
 
 display = Display()
 
 
 class ActionModule(ActionBase):
 
+    TRANSFERS_FILES = True
+    DEFAULT_NEWLINE_SEQUENCE = "\n"
+
     def python_info(self, executable, task_vars=None):
         module_args = {}
         module_args['executable'] = executable
@@ -28,6 +36,105 @@ def python_info(self, executable, task_vars=None):
                                              task_vars=task_vars)
         return module_return
 
+    def constraints(self, task_vars=None):
+
+        # assign to local vars for ease of use
+        source = self._task.args.get('src', None)
+        dest = self._task.args.get('dest', None)
+        state = self._task.args.get('state', None)
+        newline_sequence = self._task.args.get('newline_sequence', self.DEFAULT_NEWLINE_SEQUENCE)
+        output_encoding = self._task.args.get('output_encoding', 'utf-8') or 'utf-8'
+
+        wrong_sequences = ["\\n", "\\r", "\\r\\n"]
+        allowed_sequences = ["\n", "\r", "\r\n"]
+
+        # We need to convert unescaped sequences to proper escaped sequences for Jinja2
+        if newline_sequence in wrong_sequences:
+            newline_sequence = allowed_sequences[wrong_sequences.index(newline_sequence)]
+
+        try:
+            if state is not None:
+                raise AnsibleActionFail("'state' cannot be specified on a template")
+            if source is None or dest is None:
+                raise AnsibleActionFail("src and dest are required")
+            elif newline_sequence not in allowed_sequences:
+                raise AnsibleActionFail("newline_sequence needs to be one of: \n, \r or \r\n")
+            else:
+                try:
+                    source = self._find_needle('templates', source)
+                except AnsibleError as e:
+                    raise AnsibleActionFail(to_text(e))
+            # Get vault decrypted tmp file
+            try:
+                tmp_source = self._loader.get_real_file(source)
+            except AnsibleFileNotFound as e:
+                raise AnsibleActionFail("could not find src=%s, %s" % (source, to_text(e)))
+            b_tmp_source = to_bytes(tmp_source, errors='surrogate_or_strict')
+
+            # template the source data locally & get ready to transfer
+            try:
+                with open(b_tmp_source, 'rb') as f:
+                    try:
+                        template_data = to_text(f.read(), errors='surrogate_or_strict')
+                    except UnicodeError:
+                        raise AnsibleActionFail("Template source files must be utf-8 encoded")
+
+                searchpath = task_vars.get('ansible_search_path', [])
+                # add ansible 'template' vars
+                temp_vars = task_vars.copy()
+                # NOTE in the case of ANSIBLE_DEBUG=1 task_vars is VarsWithSources(MutableMapping)
+                # so | operator cannot be used as it can be used only on dicts
+                # https://peps.python.org/pep-0584/#what-about-mapping-and-mutablemapping
+                temp_vars.update(generate_ansible_template_vars(self._task.args.get('src', None), source, dest))
+
+                # force templar to use AnsibleEnvironment to prevent issues with native types
+                # https://github.com/ansible/ansible/issues/46169
+                templar = self._templar.copy_with_new_env(environment_class=AnsibleEnvironment,
+                                                          searchpath=searchpath,
+                                                          newline_sequence=newline_sequence,
+                                                          available_variables=temp_vars)
+                resultant = templar.do_template(template_data, preserve_trailing_newlines=True, escape_backslashes=False)
+            except AnsibleAction:
+                raise
+            except Exception as e:
+                raise AnsibleActionFail("%s: %s" % (type(e).__name__, to_text(e)))
+            finally:
+                self._loader.cleanup_tmp_file(b_tmp_source)
+
+            new_task = self._task.copy()
+            local_tempdir = tempfile.mkdtemp(dir=C.DEFAULT_LOCAL_TMP)
+
+            try:
+                result_file = os.path.join(local_tempdir, os.path.basename(source))
+                with open(to_bytes(result_file, errors='surrogate_or_strict'), 'wb') as f:
+                    f.write(to_bytes(resultant, encoding=output_encoding, errors='surrogate_or_strict'))
+
+                new_task.args.update(
+                    dict(
+                        src=result_file,
+                        dest=dest,
+                    ),
+                )
+                copy_action = self._shared_loader_obj.action_loader.get(
+                    'copy',
+                    task=new_task,
+                    connection=self._connection,
+                    play_context=self._play_context,
+                    loader=self._loader,
+                    templar=self._templar,
+                    shared_loader_obj=self._shared_loader_obj
+                )
+                copy_action.update(copy_action.run(task_vars=task_vars))
+            finally:
+                shutil.rmtree(to_bytes(local_tempdir, errors='surrogate_or_strict'))
+
+        except AnsibleAction as e:
+            copy_action.update(e.result)
+        finally:
+            self._remove_tmp_path(self._connection._shell.tmpdir)
+
+        return copy_action
+
     def run(self, tmp=None, task_vars=None):
 
         self._supports_check_mode = True
@@ -73,13 +180,14 @@ def run(self, tmp=None, task_vars=None):
         python_version = ret0['version']['majmin']
         display.v("Python version %s" % to_json(python_version))
 
-        fixed_packages = fix_package_list(packages, python_version)
-        display.v("Fixed packages %s" % to_json(fixed_packages))
-        module_args['name'] = fixed_packages
-
-        best_ansible_version = best_version(packages, python_version)
+        best_ansible_version = package_list(packages, python_version)
         display.v("Best ansible version %s" % to_json(best_ansible_version))
 
+        # template constraints files
+        #
+        if 'constraints' in module_args:
+            self.constraints(task_vars=task_vars)
+
         # install the packages
         ret2 = self._execute_module(module_name='pip', module_args=module_args, task_vars=task_vars)
         ret2['item'] = 'install_packages'
@@ -88,6 +196,9 @@ def run(self, tmp=None, task_vars=None):
 
         module_return = {}
         module_return['failed'] = ret2['failed']
+        module_return['ansible_version'] = best_ansible_version
+        module_return['python_version'] = python_version
+        module_return['packages'] = packages
         if 'changed' in ret2:
             module_return['changed'] = ret2['changed']
         module_return['results'] = [ret0, ret1, ret2]

tests/integration/targets/action_virtualenv/tasks/main.yml

@@ -17,7 +17,7 @@
       mafalb.ansible.virtualenv:
         virtualenv: ~/.virtualenvs/virtualenv-test1
         name:
-          - _ansible
+          - ansible-core
           - selinux
 
     - name: Assertions | check mode
@@ -37,7 +37,7 @@
       mafalb.ansible.virtualenv:
         virtualenv: ~/.virtualenvs/virtualenv-test1
         name:
-          - _ansible
+          - ansible-core
           - selinux
 
     - name: Debug _result
@@ -61,7 +61,7 @@
       mafalb.ansible.virtualenv:
         virtualenv: ~/.virtualenvs/virtualenv-test1
         name:
-          - _ansible
+          - ansible-core
           - selinux
 
     - name: Assertions | Idempotence