Merge pull request #4167 from tima/rsync3

synchronization module take 3

lib/ansible/runner/action_plugins/synchronize.py

+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# (c) 2012-2013, Timothy Appnel <tim@appnel.com>
+#
+# Ansible 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.
+#
+# Ansible 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 Ansible.  If not, see <http://www.gnu.org/licenses/>.
+
+import os.path
+
+from ansible import utils
+from ansible.runner.return_data import ReturnData
+import ansible.utils.template as template
+
+class ActionModule(object):
+
+    def __init__(self, runner):
+        self.runner = runner
+
+    def _process_origin(self, host, path, user):
+
+        if not host in ['127.0.0.1', 'localhost']:
+            return '%s@%s:%s' % (user, host, path)
+        else:
+            return path
+
+    def setup(self, module_name, inject):
+        ''' Always default to localhost as delegate if None defined '''
+        if inject['delegate_to'] is None:
+            inject['delegate_to'] = '127.0.0.1'
+            inject['ansible_connection'] = 'local'
+            # If sudo is active, disable from the connection set self.sudo to True.
+            if self.runner.sudo:
+                self.runner.sudo = False
+
+    def run(self, conn, tmp, module_name, module_args, 
+        inject, complex_args=None, **kwargs):
+
+        ''' generates params and passes them on to the rsync module '''
+
+        # load up options
+
+        options = {}
+        if complex_args:
+            options.update(complex_args)
+        options.update(utils.parse_kv(module_args))
+
+        src = options.get('src', None)
+        dest = options.get('dest', None)
+
+        src = template.template(self.runner.basedir, src, inject)
+        dest = template.template(self.runner.basedir, dest, inject)
+
+        try:
+            options['local_rsync_path'] = inject['ansible_rsync_path']
+        except KeyError:
+            pass
+
+        # from the perspective of the rsync call the delegate is the localhost
+        src_host = '127.0.0.1'
+        dest_host = inject.get('ansible_ssh_host', inject['inventory_hostname'])
+
+        # edge case: explicit delegate and dest_host are the same
+        if dest_host == inject['delegate_to']:
+            dest_host = '127.0.0.1'
+
+        if options.get('mode', 'push') == 'pull':
+            (dest_host, src_host) = (src_host, dest_host)
+        if not dest_host is src_host:
+            user = inject.get('ansible_ssh_user',
+                              self.runner.remote_user)
+            private_key = inject.get('ansible_ssh_private_key_file', self.runner.private_key_file)
+            if not private_key is None:
+                options['private_key'] = private_key
+            src = self._process_origin(src_host, src, user)
+            dest = self._process_origin(dest_host, dest, user)
+
+        options['src'] = src
+        options['dest'] = dest
+        if 'mode' in options:
+            del options['mode']
+
+        rsync_path = options.get('rsync_path', None)
+        if not rsync_path and self.runner.sudo:
+            rsync_path = 'sudo rsync'
+
+        # make sure rsync path is quoted.
+        if rsync_path:
+            options['rsync_path'] = '"' + rsync_path + '"'
+
+        self.runner.module_args = ' '.join(['%s=%s' % (k, v) for (k,
+                v) in options.items()])
+        return self.runner._execute_module(conn, tmp, 'synchronize',
+                self.runner.module_args, inject=inject)
+

library/files/synchronize

+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# (c) 2012-2013, Timothy Appnel <tim@appnel.com>
+#
+# Ansible 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.
+#
+# Ansible 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 Ansible.  If not, see <http://www.gnu.org/licenses/>.
+
+import subprocess
+
+DOCUMENTATION = '''
+---
+module: synchronize
+version_added: "1.4"
+short_description: Uses rsync to make synchronizing file paths in your playbooks quick and easy.
+description:
+    - This is a wrapper around rsync. Of course you could just use the command action to call rsync yourself, but you also have to add a fair number of boilerplate options and host facts. You still may need to call rsync directly via C(command) or C(shell) depending on your use case. The synchronize action is meant to do common things with C(rsync) easily. It does not provide access to the full power of rsync, but does make most invocations easier to follow.
+options:
+  src:
+    description:
+      - Path on the source machine that will be synchronized to the destination; The path can be absolute or relative.
+    required: true
+  dest:
+    description:
+      - Path on the destination machine that will be synchronized from the source; The path can be absolute or relative.
+    required: true
+  mode:
+    description:
+      - Specify the direction of the synchroniztion. In push mode the localhost or delgate is the  source; In pull mode the remote host in context is the source.
+    required: false
+    choices: [ 'push', 'pull' ]
+    default: 'push'
+  archive:
+    description:
+      - Mirrors the rsync archive flag, enables recursive, links, perms, times, owner, group flags and -D.
+    choices: [ 'yes', 'no' ]
+    default: 'yes'
+    required: false
+  delete:
+    description:
+      - Delete files that don't exist (after transfer, not before) in the C(src) path.
+    choices: [ 'yes', 'no' ]
+    default: 'no'
+    required: false
+  dirs:
+    description:
+      - Transfer directories without recursing
+    choices: [ 'yes', 'no' ]
+    default: 'no'
+    required: false
+  recursive:
+    description:
+      - Recurse into directories.
+    choices: [ 'yes', 'no' ]
+    default: the value of the archive option
+    required: false
+  links:
+    description:
+      - Copy symlinks as symlinks.
+    choices: [ 'yes', 'no' ]
+    default: the value of the archive option
+    required: false
+  perms:
+    description:
+      - Preserve permissions.
+    choices: [ 'yes', 'no' ]
+    default: the value of the archive option
+    required: false
+  times:
+    description:
+      - Preserve modification times
+    choices: [ 'yes', 'no' ]
+    default: the value of the archive option
+    required: false
+  owner:
+    description:
+      - Preserve owner (super user only)
+    choices: [ 'yes', 'no' ]
+    default: the value of the archive option
+    required: false
+  group:
+    description:
+      - Preserve group
+    choices: [ 'yes', 'no' ]
+    default: the value of the archive option
+    required: false
+  rsync_path:
+    description:
+      - Specify the rsync command to run on the remote machine. See C(--rsync-path) on the rsync man page.
+    required: false
+author: Timothy Appnel
+'''
+
+EXAMPLES = '''
+# Synchronization of src on the control machine to dest on the remote hosts
+synchronize: src=some/relative/path dest=/some/absolute/path
+
+# Synchronization without any --archive options enabled
+synchronize: src=some/relative/path dest=/some/absolute/path archive=no
+
+# Synchronization with --archive options enabled except for --recursive
+synchronize: src=some/relative/path dest=/some/absolute/path recursive=no
+
+# Synchronization without --archive options enabled except use --links
+synchronize: src=some/relative/path dest=/some/absolute/path archive=no links=yes
+
+# Synchronization of two paths both on the control machine
+local_action: synchronize src=some/relative/path dest=/some/absolute/path
+
+# Synchronization of src on the inventory host to the dest on the localhost in
+pull mode
+synchronize: mode=pull src=some/relative/path dest=/some/absolute/path
+
+# Synchronization of src on delegate host to dest on the current inventory host
+synchronize: >
+    src=some/relative/path dest=/some/absolute/path
+    delegate_to: delegate.host
+
+# Synchronize and delete files in dest on the remote host that are not found in src of localhost.
+synchronize: src=some/relative/path dest=/some/absolute/path delete=yes
+
+# Synchronize using an alternate rsync command
+synchronize: src=some/relative/path dest=/some/absolute/path rsync_path="sudo rsync"
+'''
+
+
+def main():
+    module = AnsibleModule(
+        argument_spec = dict(
+            src = dict(required=True),
+            dest = dict(required=True),
+            delete = dict(default='no', type='bool'),
+            private_key = dict(default=None),
+            rsync_path = dict(default=None),
+            archive = dict(default='yes', type='bool'),
+            dirs  = dict(default='no', type='bool'),
+            recursive = dict(type='bool'),
+            links = dict(type='bool'),
+            perms = dict(type='bool'),
+            times = dict(type='bool'),
+            owner = dict(type='bool'),
+            group = dict(type='bool'),
+        ),
+        supports_check_mode = True
+    )
+
+    source = module.params['src']
+    dest = module.params['dest']
+    delete = module.params['delete']
+    private_key = module.params['private_key']
+    rsync_path = module.params['rsync_path']
+    rsync = module.params.get('local_rsync_path', 'rsync')
+    archive = module.params['archive']
+    dirs = module.params['dirs']
+    # the default of these params depends on the value of archive
+    recursive = module.params['recursive']
+    links = module.params['links']
+    perms = module.params['perms']
+    times = module.params['times']
+    owner = module.params['owner']
+    group = module.params['group']
+
+    cmd = '%s --delay-updates --compress' % rsync
+    if module.check_mode:
+        cmd = cmd + ' --dry-run'
+    if delete:
+        cmd = cmd + ' --delete-after'
+    if archive:
+        cmd = cmd + ' --archive'
+        if recursive is False:
+            cmd = cmd + ' --no-recursive'
+        if links is False:
+            cmd = cmd + ' --no-links'
+        if perms is False:
+            cmd = cmd + ' --no-perms'
+        if times is False:
+            cmd = cmd + ' --no-times'
+        if owner is False:
+            cmd = cmd + ' --no-owner'
+        if group is False:
+            cmd = cmd + ' --no-group'
+    else:
+        if recursive is True:
+            cmd = cmd + ' --recursive'
+        if links is True:
+            cmd = cmd + ' --links'
+        if perms is True:
+            cmd = cmd + ' --perms'
+        if times is True:
+            cmd = cmd + ' --times'
+        if owner is True:
+            cmd = cmd + ' --owner'
+        if group is True:
+            cmd = cmd + ' --group'
+    if dirs:
+        cmd = cmd + ' --dirs'
+    if private_key is None:
+        private_key = ''
+    else:
+        private_key = '-i '+ private_key 
+    cmd = cmd + " --rsh '%s %s -o %s'" % ('ssh', private_key,
+                'StrictHostKeyChecking=no')  # need ssh param
+    if rsync_path:
+        cmd = cmd + " --rsync-path '%s'" %(rsync_path)
+    changed_marker = '<<CHANGED>>'
+    cmd = cmd + " --out-format='" + changed_marker + "%i %n%L'"
+    cmd = ' '.join([cmd, source, dest])
+    cmdstr = cmd
+    (rc, out, err) = module.run_command(cmd)
+    if rc:
+        return module.fail_json(msg=err, rc=rc, cmd=cmdstr)
+    else:
+        changed = changed_marker in out
+        return module.exit_json(changed=changed, msg=out.replace(changed_marker,''),
+                                rc=rc, cmd=cmdstr)
+
+# include magic from lib/ansible/module_common.py
+#<<INCLUDE_ANSIBLE_MODULE_COMMON>>
+
+main()
+