Adding support for OpenBSD syspatch (#55561)

* Initial commit

* Fixing issue where applying always returned changed status

* Adding return variables: reboot_needed, rc, stderr, stdout, warnings

lib/ansible/modules/system/syspatch.py

@@ -0,0 +1,169 @@
+#!/usr/bin/python
+
+# Copyright: (c) 2019, Andrew Klaus <andrewklaus@gmail.com>
+# 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)
+__metaclass__ = type
+
+ANSIBLE_METADATA = {
+    'metadata_version': '1.1',
+    'status': ['preview'],
+    'supported_by': 'community'
+}
+
+DOCUMENTATION = '''
+---
+module: syspatch
+
+short_description: Manage OpenBSD system patches
+
+version_added: "2.9"
+
+description:
+    - "Manage OpenBSD system patches using syspatch"
+
+options:
+    apply:
+        description:
+            - Apply all available system patches
+        default: False
+        required: false
+    revert:
+        description:
+            - Revert system patches
+        required: false
+        type: str
+        choices: [ all, one ]
+
+author:
+    - Andrew Klaus (@precurse)
+'''
+
+EXAMPLES = '''
+- name: Apply all available system patches
+  syspatch:
+    apply: true
+
+- name: Revert last patch
+  syspatch:
+    revert: one
+
+- name: Revert all patches
+  syspatch:
+    revert: all
+'''
+
+RETURN = r'''
+rc:
+  description: The command return code (0 means success)
+  returned: always
+  type: int
+stdout:
+  description: syspatch standard output
+  returned: always
+  type: str
+  sample: "001_rip6cksum"
+stderr:
+  description: syspatch standard error
+  returned: always
+  type: str
+  sample: "syspatch: need root privileges"
+reboot_needed:
+  description: Whether or not a reboot is required after an update
+  returned: always
+  type: bool
+  sample: True
+'''
+
+from ansible.module_utils.basic import AnsibleModule
+
+
+def run_module():
+    # define available arguments/parameters a user can pass to the module
+    module_args = dict(
+        apply=dict(type='bool', default=False),
+        revert=dict(type='str', choices=['all', 'one'])
+    )
+
+    module = AnsibleModule(
+        argument_spec=module_args,
+        supports_check_mode=True,
+        required_one_of=[['apply', 'revert']]
+    )
+
+    result = syspatch_run(module)
+
+    module.exit_json(**result)
+
+
+def syspatch_run(module):
+    cmd = ['/usr/sbin/syspatch']
+    changed = False
+    reboot_needed = False
+    warnings = []
+
+    # Setup command flags
+    if module.params['revert']:
+        check_flag = ['-l']
+
+        if module.params['revert'] == 'all':
+            run_flag = ['-R']
+        else:
+            run_flag = ['-r']
+    elif module.params['apply']:
+        check_flag = ['-c']
+        run_flag = []
+
+    # Run check command
+    rc, out, err = module.run_command(cmd + check_flag)
+
+    if rc != 0:
+        module.fail_json(msg="Command %s failed rc=%d, out=%s, err=%s" % (cmd, rc, out, err))
+
+    if len(out) > 0:
+        # Changes pending
+        change_pending = True
+    else:
+        # No changes pending
+        change_pending = False
+
+    if module.check_mode:
+        changed = change_pending
+    elif change_pending:
+        rc, out, err = module.run_command(cmd + run_flag)
+
+        # Workaround syspatch ln bug:
+        # http://openbsd-archive.7691.n7.nabble.com/Warning-applying-latest-syspatch-td354250.html
+        if rc != 0 and err != 'ln: /usr/X11R6/bin/X: No such file or directory\n':
+            module.fail_json(msg="Command %s failed rc=%d, out=%s, err=%s" % (cmd, rc, out, err))
+        elif out.lower().find('create unique kernel'):
+            # Kernel update applied
+            reboot_needed = True
+        elif out.lower().find('syspatch updated itself'):
+            warnings.append['Syspatch was updated. Please run syspatch again.']
+
+        # If no stdout, then warn user
+        if len(out) > 0:
+            warnings.append['syspatch had suggested changes, but stdout was empty.']
+
+        changed = True
+    else:
+        changed = False
+
+    return dict(
+        changed=changed,
+        reboot_needed=reboot_needed,
+        rc=rc,
+        stderr=err,
+        stdout=out,
+        warnings=warnings
+    )
+
+
+def main():
+    run_module()
+
+
+if __name__ == '__main__':
+    main()