Unflatmap community.general (#5461)

* Move files.

* Update imports and references.

* Move wrongly placed files.

* Reverse redirects, deprecate long → short name redirects.

* Simplify contribution guidelines for new modules.

* Rewrite BOTMETA.

* Add changelog fragment.

* Fix ignore.txt files.

plugins/modules/atomic_image.py

@@ -0,0 +1,170 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# Copyright Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+DOCUMENTATION = r'''
+---
+module: atomic_image
+short_description: Manage the container images on the atomic host platform
+description:
+    - Manage the container images on the atomic host platform.
+    - Allows to execute the commands specified by the RUN label in the container image when present.
+author:
+- Saravanan KR (@krsacme)
+notes:
+    - Host should support C(atomic) command.
+requirements:
+  - atomic
+  - python >= 2.6
+options:
+    backend:
+        description:
+          - Define the backend where the image is pulled.
+        choices: [ 'docker', 'ostree' ]
+        type: str
+    name:
+        description:
+          - Name of the container image.
+        required: true
+        type: str
+    state:
+        description:
+          - The state of the container image.
+          - The state C(latest) will ensure container image is upgraded to the latest version and forcefully restart container, if running.
+        choices: [ 'absent', 'latest', 'present' ]
+        default: 'latest'
+        type: str
+    started:
+        description:
+          - Start or Stop the container.
+        type: bool
+        default: true
+'''
+
+EXAMPLES = r'''
+- name: Execute the run command on rsyslog container image (atomic run rhel7/rsyslog)
+  community.general.atomic_image:
+    name: rhel7/rsyslog
+    state: latest
+
+- name: Pull busybox to the OSTree backend
+  community.general.atomic_image:
+    name: busybox
+    state: latest
+    backend: ostree
+'''
+
+RETURN = r'''
+msg:
+    description: The command standard output
+    returned: always
+    type: str
+    sample: 'Using default tag: latest ...'
+'''
+import traceback
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.common.text.converters import to_native
+
+
+def do_upgrade(module, image):
+    atomic_bin = module.get_bin_path('atomic')
+    args = [atomic_bin, 'update', '--force', image]
+    rc, out, err = module.run_command(args, check_rc=False)
+    if rc != 0:  # something went wrong emit the msg
+        module.fail_json(rc=rc, msg=err)
+    elif 'Image is up to date' in out:
+        return False
+
+    return True
+
+
+def core(module):
+    image = module.params['name']
+    state = module.params['state']
+    started = module.params['started']
+    backend = module.params['backend']
+    is_upgraded = False
+
+    module.run_command_environ_update = dict(LANG='C', LC_ALL='C', LC_MESSAGES='C')
+    atomic_bin = module.get_bin_path('atomic')
+    out = {}
+    err = {}
+    rc = 0
+
+    if backend:
+        if state == 'present' or state == 'latest':
+            args = [atomic_bin, 'pull', "--storage=%s" % backend, image]
+            rc, out, err = module.run_command(args, check_rc=False)
+            if rc < 0:
+                module.fail_json(rc=rc, msg=err)
+            else:
+                out_run = ""
+                if started:
+                    args = [atomic_bin, 'run', "--storage=%s" % backend, image]
+                    rc, out_run, err = module.run_command(args, check_rc=False)
+                    if rc < 0:
+                        module.fail_json(rc=rc, msg=err)
+
+                changed = "Extracting" in out or "Copying blob" in out
+                module.exit_json(msg=(out + out_run), changed=changed)
+        elif state == 'absent':
+            args = [atomic_bin, 'images', 'delete', "--storage=%s" % backend, image]
+            rc, out, err = module.run_command(args, check_rc=False)
+            if rc < 0:
+                module.fail_json(rc=rc, msg=err)
+            else:
+                changed = "Unable to find" not in out
+                module.exit_json(msg=out, changed=changed)
+        return
+
+    if state == 'present' or state == 'latest':
+        if state == 'latest':
+            is_upgraded = do_upgrade(module, image)
+
+        if started:
+            args = [atomic_bin, 'run', image]
+        else:
+            args = [atomic_bin, 'install', image]
+    elif state == 'absent':
+        args = [atomic_bin, 'uninstall', image]
+
+    rc, out, err = module.run_command(args, check_rc=False)
+
+    if rc < 0:
+        module.fail_json(rc=rc, msg=err)
+    elif rc == 1 and 'already present' in err:
+        module.exit_json(restult=err, changed=is_upgraded)
+    elif started and 'Container is running' in out:
+        module.exit_json(result=out, changed=is_upgraded)
+    else:
+        module.exit_json(msg=out, changed=True)
+
+
+def main():
+    module = AnsibleModule(
+        argument_spec=dict(
+            backend=dict(type='str', choices=['docker', 'ostree']),
+            name=dict(type='str', required=True),
+            state=dict(type='str', default='latest', choices=['absent', 'latest', 'present']),
+            started=dict(type='bool', default=True),
+        ),
+    )
+
+    # Verify that the platform supports atomic command
+    dummy = module.get_bin_path('atomic', required=True)
+
+    try:
+        core(module)
+    except Exception as e:
+        module.fail_json(msg=to_native(e), exception=traceback.format_exc())
+
+
+if __name__ == '__main__':
+    main()