Update podman_container_exec

Signed-off-by: nishipy <[email protected]>

Author: nishipy

plugins/modules/podman_container_exec.py

@@ -3,18 +3,10 @@
 
 # Copyright (c) 2023, Takuya Nishimura <@nishipy>
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-from __future__ import (absolute_import, division, print_function)
-from ansible_collections.containers.podman.plugins.module_utils.podman.common import compare_systemd_file_content
-import json
-from ansible.module_utils.basic import AnsibleModule
-from ansible.module_utils._text import to_bytes, to_native, to_text
-from ansible.module_utils.six import string_types
-import shlex
-import os
+from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
-
-DOCUMENTATION = '''
+DOCUMENTATION = r'''
 module: podman_container_exec
 author:
   - Takuya Nishimura (@nishipy)
@@ -30,12 +22,12 @@
   command:
     description:
       - The command to run in the container.
-      - One of the O(command) or O(args) is required.
+      - One of the I(command) or I(args) is required.
     type: str
   argv:
     description:
       - Passes the command as a list rather than a string.
-      - One of the O(command) or O(args) is required.
+      - One of the I(command) or I(args) is required.
     type: list
     elements: str
   detach:
@@ -73,40 +65,71 @@
   - See L(the Podman documentation,https://docs.podman.io/en/latest/markdown/podman-exec.1.html) for details of podman-exec(1).
 '''
 
-EXAMPLES = '''
-To Be Added.
+EXAMPLES = r'''
+- name: Execute a command with workdir
+    containers.podman.podman_container_exec:
+    name: ubi8
+    command: "cat redhat-release"
+    workdir: /etc
+
+- name: Execute a command with a list of args and enviroment variables
+    containers.podman.podman_container_exec:
+    name: test_container
+    argv:
+        - /bin/sh
+        - -c
+        - echo $HELLO $BYE
+    env:
+        HELLO: hello world
+        BYE: goodbye world
+
+- name: Execute command in background by using detach
+    containers.podman.podman_container_exec:
+    name: detach_container
+    command: "cat redhat-release"
+    detach: true
 '''
 
-RETURN = '''
+RETURN = r'''
 stdout:
   type: str
-  returned: success and O(detach=false)
+  returned: success
   description:
-	- The standard output of the command executed in the container.
+  - The standard output of the command executed in the container.
 stderr:
   type: str
-  returned: success and O(detach=false)
+  returned: success
   description:
-	- The standard output of the command executed in the container.
+  - The standard output of the command executed in the container.
 rc:
   type: int
-  returned: success and O(detach=false)
+  returned: success
+  sample: 0
   description:
-	- The exit code of the command executed in the container.
+  - The exit code of the command executed in the container.
 exec_id:
   type: str
-  returned: success and O(detach=true)
+  returned: success and I(detach=true)
   sample: f99002e34c1087fd1aa08d5027e455bf7c2d6b74f019069acf6462a96ddf2a47
   description:
-	- The ID of the exec session.
+  - The ID of the exec session.
 '''
 
+import shlex
+from ansible.module_utils.six import string_types
+from ansible.module_utils._text import to_text
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.containers.podman.plugins.module_utils.podman.common import run_podman_command
 
-def container_exec(module: AnsibleModule):
-    exec_command = ['podman', 'container', 'exec']
-    # always returns as changed
+
+def run_container_exec(module: AnsibleModule) -> dict:
+    '''
+    Execute podman-container-exec for the given options
+    '''
+    exec_with_args = ['container', 'exec']
+    # podman_container_exec always returns changed=true
     changed = True
-    command_options = []
+    exec_options = []
 
     name = module.params['name']
     argv = module.params['argv']
@@ -122,7 +145,7 @@ def container_exec(module: AnsibleModule):
         argv = shlex.split(command)
 
     if detach:
-        command_options.append('--detach')
+        exec_options.append('--detach')
 
     if env is not None:
         for key, value in env.items():
@@ -131,39 +154,43 @@ def container_exec(module: AnsibleModule):
                     msg="Specify string value %s on the env field" % (value))
 
             to_text(value, errors='surrogate_or_strict')
-            command_options += ['--env',
-                                '%s="%s"' % (key, value)]
+            exec_options += ['--env',
+                             '%s="%s"' % (key, value)]
 
     if privileged:
-        command_options.append('--privileged')
+        exec_options.append('--privileged')
 
     if tty:
-        command_options.append('--tty')
+        exec_options.append('--tty')
 
     if user is not None:
-        command_options += ['--user',
-                            to_text(user, errors='surrogate_or_strict')]
+        exec_options += ['--user',
+                         to_text(user, errors='surrogate_or_strict')]
 
     if workdir is not None:
-        command_options += ['--workdir',
-                            to_text(workdir, errors='surrogate_or_strict')]
+        exec_options += ['--workdir',
+                         to_text(workdir, errors='surrogate_or_strict')]
+
+    exec_options.append(name)
+    exec_options.extend(argv)
 
-    command_options.append(name)
-    command_options.extend(argv)
+    exec_with_args.extend(exec_options)
 
-    exec_command.extend(command_options)
-    exec_command_str = ' '.join(exec_command)
-    rc, stdout, stderr = module.run_command(exec_command_str)
+    rc, stdout, stderr = run_podman_command(
+        module=module, executable='podman', args=exec_with_args)
 
     result = {
         'changed': changed,
-        'podman_command': command_options,
+        'podman_command': exec_options,
         'rc': rc,
         'stdout': stdout,
         'stderr': stderr,
     }
 
-    module.exit_json(**result)
+    if detach:
+        result['exec_id'] = stdout.replace('\n', '')
+
+    return result
 
 
 def main():
@@ -211,7 +238,8 @@ def main():
         required_one_of=[('argv', 'command')],
     )
 
-    container_exec(module)
+    result = run_container_exec(module)
+    module.exit_json(**result)
 
 
 if __name__ == '__main__':