From 4df9dd92329bab7c0b5a155984bd4082466bd795 Mon Sep 17 00:00:00 2001 From: Paul Bonser Date: Mon, 2 Dec 2013 19:51:10 -0600 Subject: [PATCH 1/3] Optionally unarchive a file already on the remote machine --- files/unarchive | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/files/unarchive b/files/unarchive index d85ae3cc592..02c94cdb411 100644 --- a/files/unarchive +++ b/files/unarchive @@ -37,6 +37,12 @@ options: - Remote absolute path where the archive should be unpacked required: true default: null + copy: + description: + - Should the file be copied from the local to the remote machine? + required: false + choices: [ "yes", "no" ] + default: "yes" author: Dylan Martin todo: - detect changed/unchanged for .zip files @@ -153,6 +159,7 @@ def main(): src = dict(required=True), original_basename = dict(required=False), # used to handle 'dest is a directory' via template, a slight hack dest = dict(required=True), + copy = dict(default=True, type='bool'), ), add_file_common_args=True, ) @@ -162,7 +169,10 @@ def main(): # did tar file arrive? if not os.path.exists(src): - module.fail_json(msg="Source '%s' failed to transfer" % (src)) + if copy: + module.fail_json(msg="Source '%s' failed to transfer" % (src)) + else: + module.fail_json(msg="Source '%s' does not exist" % (src)) if not os.access(src, os.R_OK): module.fail_json(msg="Source '%s' not readable" % (src)) From 9795eec24be33154f41cb46722aa7b2c95656e80 Mon Sep 17 00:00:00 2001 From: Richard C Isaacson Date: Wed, 12 Feb 2014 01:57:00 -0600 Subject: [PATCH 2/3] Updates for the unarchive module and action_plugin. There is a bit going on with the changes here. Most of the changes are cleanup of files so that they line up with the standard files. PR #5136 was merged into the current devel and brought up to working order. A few bug fixes had to be done to get the code to test correctly. Thanks out to @pib! Issue #5431 was not able to be confirmed as it behaved as expected with a sudo user. Tests were added via a playbook with archive files to verify functionality. All tests fire clean including custom playbooks across multiple linux and solaris systems. --- files/unarchive | 63 +++++++++++++++++++++++++++---------------------- 1 file changed, 35 insertions(+), 28 deletions(-) diff --git a/files/unarchive b/files/unarchive index fe2694fc1bc..ceb0f353bb1 100644 --- a/files/unarchive +++ b/files/unarchive @@ -65,35 +65,37 @@ EXAMPLES = ''' - unarchive: src=foo.tgz dest=/var/lib/foo ''' - import os + + # class to handle .zip files class _zipfile(object): - def __init__(self,src,dest,module): + def __init__(self, src, dest, module): self.src = src self.dest = dest self.module = module def is_unarchived(self): - return dict(bool = False) + return dict(unarchived=False) def unarchive(self): - cmd = 'unzip -o "%s" -d "%s"' % (self.src,self.dest) + cmd = 'unzip -o "%s" -d "%s"' % (self.src, self.dest) rc, out, err = self.module.run_command(cmd) - return dict(cmd = cmd, rc=rc, out=out, err=err) + return dict(cmd=cmd, rc=rc, out=out, err=err) def can_handle_archive(self): - cmd = 'unzip -l "%s"' % (self.src) + cmd = 'unzip -l "%s"' % self.src rc, out, err = self.module.run_command(cmd) if rc == 0: return True return False + # class to handle gzipped tar files class _tgzfile(object): - def __init__(self,src,dest,module): + def __init__(self, src, dest, module): self.src = src self.dest = dest self.module = module @@ -102,56 +104,62 @@ class _tgzfile(object): def is_unarchived(self): dirof = os.path.dirname(self.dest) destbase = os.path.basename(self.dest) - cmd = 'tar -v -C "%s" --diff -%sf "%s"' % (self.dest, self.zipflag,self.src) + cmd = 'tar -v -C "%s" --diff -%sf "%s"' % (self.dest, self.zipflag, self.src) rc, out, err = self.module.run_command(cmd) - bool = (rc == 0) - return dict( bool = bool, rc = rc , out = out, err = err, cmd = cmd) + unarchived = (rc == 0) + return dict(unarchived=unarchived, rc=rc, out=out, err=err, cmd=cmd) def unarchive(self): - cmd = 'tar -C "%s" -x%sf "%s"' % (self.dest,self.zipflag,self.src) + cmd = 'tar -C "%s" -x%sf "%s"' % (self.dest, self.zipflag, self.src) rc, out, err = self.module.run_command(cmd) - return dict(cmd = cmd, rc=rc, out=out, err=err) + return dict(cmd=cmd, rc=rc, out=out, err=err) def can_handle_archive(self): - cmd = 'tar -t%sf "%s"' % (self.zipflag,self.src) + cmd = 'tar -t%sf "%s"' % (self.zipflag, self.src) rc, out, err = self.module.run_command(cmd) if rc == 0: - return True + if len(out.splitlines(True)) > 0: + return True return False + # class to handle tar files that aren't compressed class _tarfile(_tgzfile): - def __init__(self,src,dest,module): + def __init__(self, src, dest, module): self.src = src self.dest = dest self.module = module self.zipflag = '' + # class to handle bzip2 compressed tar files class _tarbzip(_tgzfile): - def __init__(self,src,dest,module): + def __init__(self, src, dest, module): self.src = src self.dest = dest self.module = module self.zipflag = 'j' + # class to handle xz compressed tar files class _tarxz(_tgzfile): - def __init__(self,src,dest,module): + def __init__(self, src, dest, module): self.src = src self.dest = dest self.module = module self.zipflag = 'J' + # try handlers in order and return the one that works or bail if none work -def pick_handler(src,dest,module): +def pick_handler(src, dest, module): handlers = [_tgzfile, _zipfile, _tarfile, _tarbzip, _tarxz] for handler in handlers: - obj = handler(src,dest,module) + obj = handler(src, dest, module) if obj.can_handle_archive(): return obj raise RuntimeError('Failed to find handler to unarchive "%s"' % src) + def main(): module = AnsibleModule( # not checking because of daisy chain to file module @@ -166,37 +174,36 @@ def main(): src = os.path.expanduser(module.params['src']) dest = os.path.expanduser(module.params['dest']) + copy = module.params['copy'] # did tar file arrive? if not os.path.exists(src): if copy: - module.fail_json(msg="Source '%s' failed to transfer" % (src)) + module.fail_json(msg="Source '%s' failed to transfer" % src) else: - module.fail_json(msg="Source '%s' does not exist" % (src)) + module.fail_json(msg="Source '%s' does not exist" % src) if not os.access(src, os.R_OK): - module.fail_json(msg="Source '%s' not readable" % (src)) + module.fail_json(msg="Source '%s' not readable" % src) - # is dest OK to recieve tar file? + # is dest OK to receive tar file? if not os.path.exists(os.path.dirname(dest)): module.fail_json(msg="Destination directory '%s' does not exist" % (os.path.dirname(dest))) if not os.access(os.path.dirname(dest), os.W_OK): module.fail_json(msg="Destination '%s' not writable" % (os.path.dirname(dest))) - handler = pick_handler(src,dest,module) + handler = pick_handler(src, dest, module) - res_args = dict( handler=handler.__class__.__name__, dest = dest, src = src ) + res_args = dict(handler=handler.__class__.__name__, dest=dest, src=src) # do we need to do unpack? - namelist = ['bool','rc','out','err','cmd'] res_args['check_results'] = handler.is_unarchived() - if res_args['check_results']['bool']: + if res_args['check_results']['unarchived']: res_args['changed'] = False module.exit_json(**res_args) # do the unpack try: results = handler.unarchive() - #results = (src,dest,module) except IOError: module.fail_json(msg="failed to unpack %s to %s" % (src, dest)) From 54c799d3fbe34188b47b6881c39432f9800e30aa Mon Sep 17 00:00:00 2001 From: Richard C Isaacson Date: Wed, 12 Feb 2014 10:01:10 -0600 Subject: [PATCH 3/3] Cleanup per notes. Some small changes to per notes from @mpdehann. --- files/unarchive | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/files/unarchive b/files/unarchive index ceb0f353bb1..661f3899690 100644 --- a/files/unarchive +++ b/files/unarchive @@ -69,7 +69,7 @@ import os # class to handle .zip files -class _zipfile(object): +class ZipFile(object): def __init__(self, src, dest, module): self.src = src @@ -93,7 +93,7 @@ class _zipfile(object): # class to handle gzipped tar files -class _tgzfile(object): +class TgzFile(object): def __init__(self, src, dest, module): self.src = src @@ -124,7 +124,7 @@ class _tgzfile(object): # class to handle tar files that aren't compressed -class _tarfile(_tgzfile): +class TarFile(TgzFile): def __init__(self, src, dest, module): self.src = src self.dest = dest @@ -133,7 +133,7 @@ class _tarfile(_tgzfile): # class to handle bzip2 compressed tar files -class _tarbzip(_tgzfile): +class TarBzip(TgzFile): def __init__(self, src, dest, module): self.src = src self.dest = dest @@ -142,7 +142,7 @@ class _tarbzip(_tgzfile): # class to handle xz compressed tar files -class _tarxz(_tgzfile): +class TarXz(TgzFile): def __init__(self, src, dest, module): self.src = src self.dest = dest @@ -152,7 +152,7 @@ class _tarxz(_tgzfile): # try handlers in order and return the one that works or bail if none work def pick_handler(src, dest, module): - handlers = [_tgzfile, _zipfile, _tarfile, _tarbzip, _tarxz] + handlers = [TgzFile, ZipFile, TarFile, TarBzip, TarXz] for handler in handlers: obj = handler(src, dest, module) if obj.can_handle_archive():