Adding apk module

lib/ansible/modules/extras/packaging/os/apk.py

@@ -0,0 +1,196 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# (c) 2015, Kevin Brebanov <https://github.com/kbrebanov>
+# Based on pacman (Afterburn <http://github.com/afterburn>, Aaron Bull Schaefer <aaron@elasticdog.com>)
+# and apt (Matthew Williams <matthew@flowroute.com>>) modules.
+#
+# This module is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This software is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this software.  If not, see <http://www.gnu.org/licenses/>.
+
+DOCUMENTATION = '''
+---
+module: apk
+short_description: Manages apk packages
+description:
+  - Manages I(apk) packages for Alpine Linux.
+options:
+  name:
+    description:
+      - A package name, like C(foo).
+    required: false
+    default: null
+  state:
+    description:
+      - Indicates the desired package state.
+      - C(present) ensures the package is present.
+      - C(absent) ensures the package is absent.
+      - C(latest) ensures the package is present and the latest version.
+    required: false
+    default: present
+    choices: [ "present", "absent", "latest" ]
+  update_cache:
+    description:
+      - Update repository indexes. Can be run with other steps or on it's own. 
+    required: false
+    default: no
+    choices: [ "yes", "no" ]
+  upgrade:
+    description:
+      - Upgrade all installed packages to their latest version.
+    required: false
+    default: no
+    choices: [ "yes", "no" ]
+'''
+
+EXAMPLES = '''
+# Update repositories and install "foo" package
+- apk: name=foo update_cache=yes
+
+# Remove "foo" package
+- apk: name=foo state=absent
+
+# Install the package "foo"
+- apk: name=foo state=present
+
+# Update repositories and update package "foo" to latest version
+- apk: name=foo state=latest update_cache=yes
+
+# Update all installed packages to the latest versions
+- apk: upgrade=yes
+
+# Update repositories as a separate step
+- apk: update_cache=yes
+'''
+
+import os
+import re
+
+APK_PATH="/sbin/apk"
+
+def update_package_db(module):
+    cmd = "apk update"
+    rc, stdout, stderr = module.run_command(cmd, check_rc=False)
+    if rc == 0:
+        return True
+    else:
+        module.fail_json(msg="could not update package db")
+
+def query_package(module, name):
+    cmd = "apk -v info --installed %s" % (name)
+    rc, stdout, stderr = module.run_command(cmd, check_rc=False)
+    if rc == 0:
+        return True
+    else:
+        return False
+
+def query_latest(module, name):
+    cmd = "apk version %s" % (name)
+    rc, stdout, stderr = module.run_command(cmd, check_rc=False)
+    search_pattern = "(%s)-[\d\.\w]+-[\d\w]+\s+(.)\s+[\d\.\w]+-[\d\w]+\s+" % (name)
+    match = re.search(search_pattern, stdout)
+    if match and match.group(2) == "<":
+        return False
+    return True
+
+def upgrade_packages(module):
+    if module.check_mode:
+        cmd = "apk upgrade --simulate"
+    else:
+        cmd = "apk upgrade"
+    rc, stdout, stderr = module.run_command(cmd, check_rc=False)
+    if rc != 0:
+        module.fail_json(msg="failed to upgrade packages")
+    if re.search('^OK', stdout):
+        module.exit_json(changed=False, msg="packages already upgraded")
+    module.exit_json(changed=True, msg="upgraded packages")
+
+def install_package(module, name, state):
+    upgrade = False
+    installed = query_package(module, name)
+    latest = query_latest(module, name)
+    if state == 'latest' and not latest:
+        upgrade = True
+    if installed and not upgrade:
+        module.exit_json(changed=False, msg="package already installed")
+    if upgrade:
+        if module.check_mode:
+            cmd = "apk add --upgrade --simulate %s" % (name)
+        else:
+            cmd = "apk add --upgrade %s" % (name)
+    else:
+        if module.check_mode:
+            cmd = "apk add --simulate %s" % (name)
+        else:
+            cmd = "apk add %s" % (name)
+    rc, stdout, stderr = module.run_command(cmd, check_rc=False)
+    if rc != 0:
+        module.fail_json(msg="failed to install %s" % (name))
+    module.exit_json(changed=True, msg="installed %s package" % (name))
+
+def remove_package(module, name):
+    installed = query_package(module, name)
+    if not installed:
+        module.exit_json(changed=False, msg="package already removed")
+    if module.check_mode:
+        cmd = "apk del --purge --simulate %s" % (name)
+    else:
+        cmd = "apk del --purge %s" % (name)
+    rc, stdout, stderr = module.run_command(cmd, check_rc=False)
+    if rc != 0:
+        module.fail_json(msg="failed to remove %s" % (name))
+    module.exit_json(changed=True, msg="removed %s package" % (name))
+
+# ==========================================
+# Main control flow.
+
+def main():
+    module = AnsibleModule(
+        argument_spec = dict(
+            state = dict(default='present', choices=['present', 'installed', 'absent', 'removed', 'latest']),
+            name = dict(type='str'),
+            update_cache = dict(default='no', choices=BOOLEANS, type='bool'),
+            upgrade = dict(default='no', choices=BOOLEANS, type='bool'),
+        ),
+        required_one_of = [['name', 'update_cache', 'upgrade']],
+        supports_check_mode = True
+    )
+
+    if not os.path.exists(APK_PATH):
+        module.fail_json(msg="cannot find apk, looking for %s" % (APK_PATH))
+
+    p = module.params
+
+    # normalize the state parameter
+    if p['state'] in ['present', 'installed']:
+        p['state'] = 'present'
+    if p['state'] in ['absent', 'removed']:
+        p['state'] = 'absent'
+
+    if p['update_cache']:
+        update_package_db(module)
+        if not p['name']:
+            module.exit_json(changed=True, msg='updated repository indexes')
+
+    if p['upgrade']:
+        upgrade_packages(module)
+
+    if p['state'] in ['present', 'latest']:
+        install_package(module, p['name'], p['state'])
+    elif p['state'] == 'absent':
+        remove_package(module, p['name'])
+
+# Import module snippets.
+from ansible.module_utils.basic import *
+if __name__ == '__main__':
+    main()