ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-06-28 11:10:21 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

Merge pull request #5969 from risaacson/pull_5136

Browse source 
Updates for the unarchive module and action_plugin.
This commit is contained in:
Richard Isaacson 2014-02-12 10:10:25 -06:00
commit eb4a730933
7 changed files with 458 additions and 330 deletions
Download patch file Download diff file Expand all files Collapse all files

32
lib/ansible/runner/action_plugins/unarchive.py
View file

@ -28,11 +28,9 @@ from ansible.runner.return_data import ReturnData
import sys import sys
reload(sys) reload(sys)
sys.setdefaultencoding("utf8") sys.setdefaultencoding("utf8")
#import base64
#import stat
#import tempfile
import pipes import pipes
class ActionModule(object): class ActionModule(object):
TRANSFERS_FILES = True TRANSFERS_FILES = True
@ -50,30 +48,36 @@ class ActionModule(object):
options.update(utils.parse_kv(module_args)) options.update(utils.parse_kv(module_args))
source = options.get('src', None) source = options.get('src', None)
dest = options.get('dest', None) dest = options.get('dest', None)
copy = utils.boolean(options.get('copy', 'yes'))
if source is None or dest is None: if source is None or dest is None:
result=dict(failed=True, msg="src (or content) and dest are required") result = dict(failed=True, msg="src (or content) and dest are required")
return ReturnData(conn=conn, result=result) return ReturnData(conn=conn, result=result)
source = template.template(self.runner.basedir, source, inject) source = template.template(self.runner.basedir, source, inject)
if '_original_file' in inject: if copy:
source = utils.path_dwim_relative(inject['_original_file'], 'files', source, self.runner.basedir) if '_original_file' in inject:
else: source = utils.path_dwim_relative(inject['_original_file'], 'files', source, self.runner.basedir)
source = utils.path_dwim(self.runner.basedir, source) else:
source = utils.path_dwim(self.runner.basedir, source)
remote_md5 = self.runner._remote_md5(conn, tmp, dest) remote_md5 = self.runner._remote_md5(conn, tmp, dest)
if remote_md5 != '3': if remote_md5 != '3':
result = dict(failed=True, msg="dest must be an existing dir") result = dict(failed=True, msg="dest must be an existing dir")
return ReturnData(conn=conn, result=result) return ReturnData(conn=conn, result=result)
# transfer the file to a remote tmp location if copy:
tmp_src = tmp + 'source' # transfer the file to a remote tmp location
conn.put_file(source, tmp_src) tmp_src = tmp + 'source'
conn.put_file(source, tmp_src)
# handle diff mode client side # handle diff mode client side
# handle check mode client side # handle check mode client side
# fix file permissions when the copy is done as a different user # fix file permissions when the copy is done as a different user
if self.runner.sudo and self.runner.sudo_user != 'root': if copy:
self.runner._low_level_exec_command(conn, "chmod a+r %s" % tmp_src, tmp) if self.runner.sudo and self.runner.sudo_user != 'root':
module_args = "%s src=%s original_basename=%s" % (module_args, pipes.quote(tmp_src), pipes.quote(os.path.basename(source))) self.runner._low_level_exec_command(conn, "chmod a+r %s" % tmp_src, tmp)
module_args = "%s src=%s original_basename=%s" % (module_args, pipes.quote(tmp_src), pipes.quote(os.path.basename(source)))
else:
module_args = "%s original_basename=%s" % (module_args, pipes.quote(os.path.basename(source)))
return self.runner._execute_module(conn, tmp, 'unarchive', module_args, inject=inject, complex_args=complex_args) return self.runner._execute_module(conn, tmp, 'unarchive', module_args, inject=inject, complex_args=complex_args)

87
library/files/unarchive
View file

@ -37,6 +37,12 @@ options:
- Remote absolute path where the archive should be unpacked - Remote absolute path where the archive should be unpacked
required: true required: true
default: null 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 author: Dylan Martin
todo: todo:
- detect changed/unchanged for .zip files - detect changed/unchanged for .zip files
@ -59,35 +65,37 @@ EXAMPLES = '''
- unarchive: src=foo.tgz dest=/var/lib/foo - unarchive: src=foo.tgz dest=/var/lib/foo
''' '''
import os import os
# class to handle .zip files
class _zipfile(object):
def __init__(self,src,dest,module):
# class to handle .zip files
class ZipFile(object):
def __init__(self, src, dest, module):
self.src = src self.src = src
self.dest = dest self.dest = dest
self.module = module self.module = module
def is_unarchived(self): def is_unarchived(self):
return dict(bool = False) return dict(unarchived=False)
def unarchive(self): 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) 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): 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) rc, out, err = self.module.run_command(cmd)
if rc == 0: if rc == 0:
return True return True
return False return False
# class to handle gzipped tar files
class _tgzfile(object):
def __init__(self,src,dest,module): # class to handle gzipped tar files
class TgzFile(object):
def __init__(self, src, dest, module):
self.src = src self.src = src
self.dest = dest self.dest = dest
self.module = module self.module = module
@ -96,56 +104,62 @@ class _tgzfile(object):
def is_unarchived(self): def is_unarchived(self):
dirof = os.path.dirname(self.dest) dirof = os.path.dirname(self.dest)
destbase = os.path.basename(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) rc, out, err = self.module.run_command(cmd)
bool = (rc == 0) unarchived = (rc == 0)
return dict( bool = bool, rc = rc , out = out, err = err, cmd = cmd) return dict(unarchived=unarchived, rc=rc, out=out, err=err, cmd=cmd)
def unarchive(self): 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) 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): 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) rc, out, err = self.module.run_command(cmd)
if rc == 0: if rc == 0:
return True if len(out.splitlines(True)) > 0:
return True
return False return False
# class to handle tar files that aren't compressed # class to handle tar files that aren't compressed
class _tarfile(_tgzfile): class TarFile(TgzFile):
def __init__(self,src,dest,module): def __init__(self, src, dest, module):
self.src = src self.src = src
self.dest = dest self.dest = dest
self.module = module self.module = module
self.zipflag = '' self.zipflag = ''
# class to handle bzip2 compressed tar files # class to handle bzip2 compressed tar files
class _tarbzip(_tgzfile): class TarBzip(TgzFile):
def __init__(self,src,dest,module): def __init__(self, src, dest, module):
self.src = src self.src = src
self.dest = dest self.dest = dest
self.module = module self.module = module
self.zipflag = 'j' self.zipflag = 'j'
# class to handle xz compressed tar files # class to handle xz compressed tar files
class _tarxz(_tgzfile): class TarXz(TgzFile):
def __init__(self,src,dest,module): def __init__(self, src, dest, module):
self.src = src self.src = src
self.dest = dest self.dest = dest
self.module = module self.module = module
self.zipflag = 'J' self.zipflag = 'J'
# try handlers in order and return the one that works or bail if none work # 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] handlers = [TgzFile, ZipFile, TarFile, TarBzip, TarXz]
for handler in handlers: for handler in handlers:
obj = handler(src,dest,module) obj = handler(src, dest, module)
if obj.can_handle_archive(): if obj.can_handle_archive():
return obj return obj
raise RuntimeError('Failed to find handler to unarchive "%s"' % src) raise RuntimeError('Failed to find handler to unarchive "%s"' % src)
def main(): def main():
module = AnsibleModule( module = AnsibleModule(
# not checking because of daisy chain to file module # not checking because of daisy chain to file module
@ -153,40 +167,43 @@ def main():
src = dict(required=True), src = dict(required=True),
original_basename = dict(required=False), # used to handle 'dest is a directory' via template, a slight hack original_basename = dict(required=False), # used to handle 'dest is a directory' via template, a slight hack
dest = dict(required=True), dest = dict(required=True),
copy = dict(default=True, type='bool'),
), ),
add_file_common_args=True, add_file_common_args=True,
) )
src = os.path.expanduser(module.params['src']) src = os.path.expanduser(module.params['src'])
dest = os.path.expanduser(module.params['dest']) dest = os.path.expanduser(module.params['dest'])
copy = module.params['copy']
# did tar file arrive? # did tar file arrive?
if not os.path.exists(src): 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): 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)): if not os.path.exists(os.path.dirname(dest)):
module.fail_json(msg="Destination directory '%s' does not exist" % (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): if not os.access(os.path.dirname(dest), os.W_OK):
module.fail_json(msg="Destination '%s' not writable" % (os.path.dirname(dest))) 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? # do we need to do unpack?
namelist = ['bool','rc','out','err','cmd']
res_args['check_results'] = handler.is_unarchived() res_args['check_results'] = handler.is_unarchived()
if res_args['check_results']['bool']: if res_args['check_results']['unarchived']:
res_args['changed'] = False res_args['changed'] = False
module.exit_json(**res_args) module.exit_json(**res_args)
# do the unpack # do the unpack
try: try:
results = handler.unarchive() results = handler.unarchive()
#results = (src,dest,module)
except IOError: except IOError:
module.fail_json(msg="failed to unpack %s to %s" % (src, dest)) module.fail_json(msg="failed to unpack %s to %s" % (src, dest))

583
test/TestPlayBook.py
View file

@ -82,322 +82,322 @@ class TestCallbacks(object):
def on_no_hosts(self): def on_no_hosts(self):
pass pass
class TestPlaybook(unittest.TestCase): class TestPlaybook(unittest.TestCase):
def setUp(self): def setUp(self):
self.user = getpass.getuser() self.user = getpass.getuser()
self.cwd = os.getcwd() self.cwd = os.getcwd()
self.test_dir = os.path.join(self.cwd, 'test') self.test_dir = os.path.join(self.cwd, 'test')
self.stage_dir = self._prepare_stage_dir() self.stage_dir = self._prepare_stage_dir()
if os.path.exists('/tmp/ansible_test_data_copy.out'): if os.path.exists('/tmp/ansible_test_data_copy.out'):
os.unlink('/tmp/ansible_test_data_copy.out') os.unlink('/tmp/ansible_test_data_copy.out')
if os.path.exists('/tmp/ansible_test_data_template.out'): if os.path.exists('/tmp/ansible_test_data_template.out'):
os.unlink('/tmp/ansible_test_data_template.out') os.unlink('/tmp/ansible_test_data_template.out')
if os.path.exists('/tmp/ansible_test_messages.out'): if os.path.exists('/tmp/ansible_test_messages.out'):
os.unlink('/tmp/ansible_test_messages.out') os.unlink('/tmp/ansible_test_messages.out')
if os.path.exists('/tmp/ansible_test_role_messages.out'): if os.path.exists('/tmp/ansible_test_role_messages.out'):
os.unlink('/tmp/ansible_test_role_messages.out') os.unlink('/tmp/ansible_test_role_messages.out')
def _prepare_stage_dir(self): def _prepare_stage_dir(self):
stage_path = os.path.join(self.test_dir, 'test_data') stage_path = os.path.join(self.test_dir, 'test_data')
if os.path.exists(stage_path): if os.path.exists(stage_path):
shutil.rmtree(stage_path, ignore_errors=False) shutil.rmtree(stage_path, ignore_errors=False)
assert not os.path.exists(stage_path) assert not os.path.exists(stage_path)
os.makedirs(stage_path) os.makedirs(stage_path)
assert os.path.exists(stage_path) assert os.path.exists(stage_path)
return stage_path return stage_path
def _get_test_file(self, filename): def _get_test_file(self, filename):
# get a file inside the test input directory # get a file inside the test input directory
filename = os.path.join(self.test_dir, filename) filename = os.path.join(self.test_dir, filename)
assert os.path.exists(filename) assert os.path.exists(filename)
return filename return filename
def _get_stage_file(self, filename): def _get_stage_file(self, filename):
# get a file inside the test output directory # get a file inside the test output directory
filename = os.path.join(self.stage_dir, filename) filename = os.path.join(self.stage_dir, filename)
return filename return filename
def _run(self, test_playbook, host_list='test/ansible_hosts', def _run(self, test_playbook, host_list='test/ansible_hosts', extra_vars=None):
extra_vars=None): ''' run a module and get the localhost results '''
''' run a module and get the localhost results ''' # This ensures tests are independent of eachother
# This ensures tests are independent of eachother global EVENTS
global EVENTS ansible.playbook.SETUP_CACHE.clear()
ansible.playbook.SETUP_CACHE.clear() EVENTS = []
EVENTS = []
self.test_callbacks = TestCallbacks() self.test_callbacks = TestCallbacks()
self.playbook = ansible.playbook.PlayBook( self.playbook = ansible.playbook.PlayBook(
playbook = test_playbook, playbook = test_playbook,
host_list = host_list, host_list = host_list,
module_path = 'library/', module_path = 'library/',
forks = 1, forks = 1,
timeout = 5, timeout = 5,
remote_user = self.user, remote_user = self.user,
remote_pass = None, remote_pass = None,
extra_vars = extra_vars, extra_vars = extra_vars,
stats = ans_callbacks.AggregateStats(), stats = ans_callbacks.AggregateStats(),
callbacks = self.test_callbacks, callbacks = self.test_callbacks,
runner_callbacks = self.test_callbacks runner_callbacks = self.test_callbacks
) )
result = self.playbook.run() result = self.playbook.run()
return result return result
def test_playbook_vars(self): def test_playbook_vars(self):
test_callbacks = TestCallbacks() test_callbacks = TestCallbacks()
playbook = ansible.playbook.PlayBook( playbook = ansible.playbook.PlayBook(
playbook=os.path.join(self.test_dir, 'test_playbook_vars', 'playbook.yml'), playbook=os.path.join(self.test_dir, 'test_playbook_vars', 'playbook.yml'),
host_list='test/test_playbook_vars/hosts', host_list='test/test_playbook_vars/hosts',
stats=ans_callbacks.AggregateStats(), stats=ans_callbacks.AggregateStats(),
callbacks=test_callbacks, callbacks=test_callbacks,
runner_callbacks=test_callbacks runner_callbacks=test_callbacks
) )
playbook.run() playbook.run()
def _test_playbook_undefined_vars(self, playbook, fail_on_undefined): def _test_playbook_undefined_vars(self, playbook, fail_on_undefined):
# save DEFAULT_UNDEFINED_VAR_BEHAVIOR so we can restore it in the end of the test # save DEFAULT_UNDEFINED_VAR_BEHAVIOR so we can restore it in the end of the test
saved_undefined_var_behavior = C.DEFAULT_UNDEFINED_VAR_BEHAVIOR saved_undefined_var_behavior = C.DEFAULT_UNDEFINED_VAR_BEHAVIOR
C.DEFAULT_UNDEFINED_VAR_BEHAVIOR = fail_on_undefined C.DEFAULT_UNDEFINED_VAR_BEHAVIOR = fail_on_undefined
test_callbacks = TestCallbacks() test_callbacks = TestCallbacks()
playbook = ansible.playbook.PlayBook( playbook = ansible.playbook.PlayBook(
playbook=os.path.join(self.test_dir, 'test_playbook_undefined_vars', playbook), playbook=os.path.join(self.test_dir, 'test_playbook_undefined_vars', playbook),
host_list='test/test_playbook_undefined_vars/hosts', host_list='test/test_playbook_undefined_vars/hosts',
stats=ans_callbacks.AggregateStats(), stats=ans_callbacks.AggregateStats(),
callbacks=test_callbacks, callbacks=test_callbacks,
runner_callbacks=test_callbacks runner_callbacks=test_callbacks
) )
actual = playbook.run() actual = playbook.run()
C.DEFAULT_UNDEFINED_VAR_BEHAVIOR = saved_undefined_var_behavior C.DEFAULT_UNDEFINED_VAR_BEHAVIOR = saved_undefined_var_behavior
# if different, this will output to screen # if different, this will output to screen
print "**ACTUAL**" print "**ACTUAL**"
print utils.jsonify(actual, format=True) print utils.jsonify(actual, format=True)
expected = { expected = {
"localhost": { "localhost": {
"changed": 0, "changed": 0,
"failures": 0, "failures": 0,
"ok": int(not fail_on_undefined) + 1, "ok": int(not fail_on_undefined) + 1,
"skipped": 0, "skipped": 0,
"unreachable": int(fail_on_undefined) "unreachable": int(fail_on_undefined)
} }
} }
print "**EXPECTED**" print "**EXPECTED**"
print utils.jsonify(expected, format=True) print utils.jsonify(expected, format=True)
assert utils.jsonify(expected, format=True) == utils.jsonify(actual, format=True) assert utils.jsonify(expected, format=True) == utils.jsonify(actual, format=True)
#def test_playbook_undefined_vars1_ignore(self): #def test_playbook_undefined_vars1_ignore(self):
# self._test_playbook_undefined_vars('playbook1.yml', False) # self._test_playbook_undefined_vars('playbook1.yml', False)
#def test_playbook_undefined_vars1_fail(self): #def test_playbook_undefined_vars1_fail(self):
# self._test_playbook_undefined_vars('playbook1.yml', True) # self._test_playbook_undefined_vars('playbook1.yml', True)
#def test_playbook_undefined_vars2_ignore(self): #def test_playbook_undefined_vars2_ignore(self):
# self._test_playbook_undefined_vars('playbook2.yml', False) # self._test_playbook_undefined_vars('playbook2.yml', False)
#def test_playbook_undefined_vars2_fail(self): #def test_playbook_undefined_vars2_fail(self):
# self._test_playbook_undefined_vars('playbook2.yml', True) # self._test_playbook_undefined_vars('playbook2.yml', True)
def test_yaml_hosts_list(self): def test_yaml_hosts_list(self):
# Make sure playbooks support hosts: [host1, host2] # Make sure playbooks support hosts: [host1, host2]
# TODO: Actually run the play on more than one host # TODO: Actually run the play on more than one host
test_callbacks = TestCallbacks() test_callbacks = TestCallbacks()
playbook = ansible.playbook.PlayBook( playbook = ansible.playbook.PlayBook(
playbook=os.path.join(self.test_dir, 'hosts_list.yml'), playbook=os.path.join(self.test_dir, 'hosts_list.yml'),
host_list='test/ansible_hosts', host_list='test/ansible_hosts',
stats=ans_callbacks.AggregateStats(), stats=ans_callbacks.AggregateStats(),
callbacks=test_callbacks, callbacks=test_callbacks,
runner_callbacks=test_callbacks runner_callbacks=test_callbacks
) )
play = ansible.playbook.Play(playbook, playbook.playbook[0], os.getcwd()) play = ansible.playbook.Play(playbook, playbook.playbook[0], os.getcwd())
assert play.hosts == ';'.join(('host1', 'host2', 'host3')) assert play.hosts == ';'.join(('host1', 'host2', 'host3'))
def test_playbook_hash_replace(self): def test_playbook_hash_replace(self):
# save default hash behavior so we can restore it in the end of the test # save default hash behavior so we can restore it in the end of the test
saved_hash_behavior = C.DEFAULT_HASH_BEHAVIOUR saved_hash_behavior = C.DEFAULT_HASH_BEHAVIOUR
C.DEFAULT_HASH_BEHAVIOUR = "replace" C.DEFAULT_HASH_BEHAVIOUR = "replace"
test_callbacks = TestCallbacks() test_callbacks = TestCallbacks()
playbook = ansible.playbook.PlayBook( playbook = ansible.playbook.PlayBook(
playbook=os.path.join(self.test_dir, 'test_hash_behavior', 'playbook.yml'), playbook=os.path.join(self.test_dir, 'test_hash_behavior', 'playbook.yml'),
host_list='test/ansible_hosts', host_list='test/ansible_hosts',
stats=ans_callbacks.AggregateStats(), stats=ans_callbacks.AggregateStats(),
callbacks=test_callbacks, callbacks=test_callbacks,
runner_callbacks=test_callbacks runner_callbacks=test_callbacks
) )
playbook.run() playbook.run()
filename = '/tmp/ansible_test_messages.out' filename = '/tmp/ansible_test_messages.out'
expected_lines = [ expected_lines = [
"goodbye: Goodbye World!" "goodbye: Goodbye World!"
] ]
self._compare_file_output(filename, expected_lines) self._compare_file_output(filename, expected_lines)
filename = '/tmp/ansible_test_role_messages.out' filename = '/tmp/ansible_test_role_messages.out'
expected_lines = [ expected_lines = [
"inside_a_role: Indeed!" "inside_a_role: Indeed!"
] ]
self._compare_file_output(filename, expected_lines) self._compare_file_output(filename, expected_lines)
# restore default hash behavior # restore default hash behavior
C.DEFAULT_HASH_BEHAVIOUR = saved_hash_behavior C.DEFAULT_HASH_BEHAVIOUR = saved_hash_behavior
def test_playbook_hash_merge(self): def test_playbook_hash_merge(self):
# save default hash behavior so we can restore it in the end of the test # save default hash behavior so we can restore it in the end of the test
saved_hash_behavior = C.DEFAULT_HASH_BEHAVIOUR saved_hash_behavior = C.DEFAULT_HASH_BEHAVIOUR
C.DEFAULT_HASH_BEHAVIOUR = "merge" C.DEFAULT_HASH_BEHAVIOUR = "merge"
test_callbacks = TestCallbacks() test_callbacks = TestCallbacks()
playbook = ansible.playbook.PlayBook( playbook = ansible.playbook.PlayBook(
playbook=os.path.join(self.test_dir, 'test_hash_behavior', 'playbook.yml'), playbook=os.path.join(self.test_dir, 'test_hash_behavior', 'playbook.yml'),
host_list='test/ansible_hosts', host_list='test/ansible_hosts',
stats=ans_callbacks.AggregateStats(), stats=ans_callbacks.AggregateStats(),
callbacks=test_callbacks, callbacks=test_callbacks,
runner_callbacks=test_callbacks runner_callbacks=test_callbacks
) )
playbook.run() playbook.run()
filename = '/tmp/ansible_test_messages.out' filename = '/tmp/ansible_test_messages.out'
expected_lines = [ expected_lines = [
"goodbye: Goodbye World!", "goodbye: Goodbye World!",
"hello: Hello World!" "hello: Hello World!"
] ]
self._compare_file_output(filename, expected_lines) self._compare_file_output(filename, expected_lines)
filename = '/tmp/ansible_test_role_messages.out' filename = '/tmp/ansible_test_role_messages.out'
expected_lines = [ expected_lines = [
"goodbye: Goodbye World!", "goodbye: Goodbye World!",
"hello: Hello World!", "hello: Hello World!",
"inside_a_role: Indeed!" "inside_a_role: Indeed!"
] ]
self._compare_file_output(filename, expected_lines) self._compare_file_output(filename, expected_lines)
# restore default hash behavior # restore default hash behavior
C.DEFAULT_HASH_BEHAVIOUR = saved_hash_behavior C.DEFAULT_HASH_BEHAVIOUR = saved_hash_behavior
def test_playbook_ignore_errors(self): def test_playbook_ignore_errors(self):
test_callbacks = TestCallbacks() test_callbacks = TestCallbacks()
playbook = ansible.playbook.PlayBook( playbook = ansible.playbook.PlayBook(
playbook=os.path.join(self.test_dir, 'playbook-ignore-errors.yml'), playbook=os.path.join(self.test_dir, 'playbook-ignore-errors.yml'),
host_list='test/ansible_hosts', host_list='test/ansible_hosts',
stats=ans_callbacks.AggregateStats(), stats=ans_callbacks.AggregateStats(),
callbacks=test_callbacks, callbacks=test_callbacks,
runner_callbacks=test_callbacks runner_callbacks=test_callbacks
) )
actual = playbook.run() actual = playbook.run()
# if different, this will output to screen # if different, this will output to screen
print "**ACTUAL**" print "**ACTUAL**"
print utils.jsonify(actual, format=True) print utils.jsonify(actual, format=True)
expected = { expected = {
"localhost": { "localhost": {
"changed": 1, "changed": 1,
"failures": 1, "failures": 1,
"ok": 1, "ok": 1,
"skipped": 0, "skipped": 0,
"unreachable": 0 "unreachable": 0
} }
} }
print "**EXPECTED**" print "**EXPECTED**"
print utils.jsonify(expected, format=True) print utils.jsonify(expected, format=True)
assert utils.jsonify(expected, format=True) == utils.jsonify(actual,format=True) assert utils.jsonify(expected, format=True) == utils.jsonify(actual,format=True)
def test_playbook_changed_when(self): def test_playbook_changed_when(self):
test_callbacks = TestCallbacks() test_callbacks = TestCallbacks()
playbook = ansible.playbook.PlayBook( playbook = ansible.playbook.PlayBook(
playbook=os.path.join(self.test_dir, 'playbook-changed_when.yml'), playbook=os.path.join(self.test_dir, 'playbook-changed_when.yml'),
host_list='test/ansible_hosts', host_list='test/ansible_hosts',
stats=ans_callbacks.AggregateStats(), stats=ans_callbacks.AggregateStats(),
callbacks=test_callbacks, callbacks=test_callbacks,
runner_callbacks=test_callbacks runner_callbacks=test_callbacks
) )
actual = playbook.run() actual = playbook.run()
# if different, this will output to screen # if different, this will output to screen
print "**ACTUAL**" print "**ACTUAL**"
print utils.jsonify(actual, format=True) print utils.jsonify(actual, format=True)
expected = { expected = {
"localhost": { "localhost": {
"changed": 3, "changed": 3,
"failures": 0, "failures": 0,
"ok": 6, "ok": 6,
"skipped": 0, "skipped": 0,
"unreachable": 0 "unreachable": 0
} }
} }
print "**EXPECTED**" print "**EXPECTED**"
print utils.jsonify(expected, format=True) print utils.jsonify(expected, format=True)
assert utils.jsonify(expected, format=True) == utils.jsonify(actual,format=True) assert utils.jsonify(expected, format=True) == utils.jsonify(actual,format=True)
def test_playbook_failed_when(self): def test_playbook_failed_when(self):
test_callbacks = TestCallbacks() test_callbacks = TestCallbacks()
playbook = ansible.playbook.PlayBook( playbook = ansible.playbook.PlayBook(
playbook=os.path.join(self.test_dir, 'playbook-failed_when.yml'), playbook=os.path.join(self.test_dir, 'playbook-failed_when.yml'),
host_list='test/ansible_hosts', host_list='test/ansible_hosts',
stats=ans_callbacks.AggregateStats(), stats=ans_callbacks.AggregateStats(),
callbacks=test_callbacks, callbacks=test_callbacks,
runner_callbacks=test_callbacks runner_callbacks=test_callbacks
) )
actual = playbook.run() actual = playbook.run()
# if different, this will output to screen # if different, this will output to screen
print "**ACTUAL**" print "**ACTUAL**"
print utils.jsonify(actual, format=True) print utils.jsonify(actual, format=True)
expected = { expected = {
"localhost": { "localhost": {
"changed": 2, "changed": 2,
"failures": 1, "failures": 1,
"ok": 2, "ok": 2,
"skipped": 0, "skipped": 0,
"unreachable": 0 "unreachable": 0
} }
} }
print "**EXPECTED**" print "**EXPECTED**"
print utils.jsonify(expected, format=True) print utils.jsonify(expected, format=True)
assert utils.jsonify(expected, format=True) == utils.jsonify(actual,format=True) assert utils.jsonify(expected, format=True) == utils.jsonify(actual,format=True)
def test_playbook_always_run(self): def test_playbook_always_run(self):
test_callbacks = TestCallbacks() test_callbacks = TestCallbacks()
playbook = ansible.playbook.PlayBook( playbook = ansible.playbook.PlayBook(
playbook=os.path.join(self.test_dir, 'playbook-always-run.yml'), playbook=os.path.join(self.test_dir, 'playbook-always-run.yml'),
host_list='test/ansible_hosts', host_list='test/ansible_hosts',
stats=ans_callbacks.AggregateStats(), stats=ans_callbacks.AggregateStats(),
callbacks=test_callbacks, callbacks=test_callbacks,
runner_callbacks=test_callbacks, runner_callbacks=test_callbacks,
check=True check=True
) )
actual = playbook.run() actual = playbook.run()
# if different, this will output to screen # if different, this will output to screen
print "**ACTUAL**" print "**ACTUAL**"
print utils.jsonify(actual, format=True) print utils.jsonify(actual, format=True)
expected = { expected = {
"localhost": { "localhost": {
"changed": 4, "changed": 4,
"failures": 0, "failures": 0,
"ok": 4, "ok": 4,
"skipped": 8, "skipped": 8,
"unreachable": 0 "unreachable": 0
} }
} }
print "**EXPECTED**" print "**EXPECTED**"
print utils.jsonify(expected, format=True) print utils.jsonify(expected, format=True)
assert utils.jsonify(expected, format=True) == utils.jsonify(actual,format=True) assert utils.jsonify(expected, format=True) == utils.jsonify(actual,format=True)
def test_recursive_copy(self): def test_recursive_copy(self):
pb = 'test/playbook-recursive-copy.yml' pb = 'test/playbook-recursive-copy.yml'
actual = self._run(pb) actual = self._run(pb)
expected = { expected = {
"localhost": { "localhost": {
"changed": 65, "changed": 65,
"failures": 0, "failures": 0,
@ -405,21 +405,38 @@ class TestPlaybook(unittest.TestCase):
"skipped": 0, "skipped": 0,
"unreachable": 0 "unreachable": 0
} }
} }
assert utils.jsonify(expected, format=True) == utils.jsonify(actual,format=True) assert utils.jsonify(expected, format=True) == utils.jsonify(actual,format=True)
def _compare_file_output(self, filename, expected_lines): def test_unarchive(self):
actual_lines = [] pb = 'test/playbook-unarchive.yml'
with open(filename) as f: actual = self._run(pb)
actual_lines = [l.strip() for l in f.readlines()]
actual_lines = sorted(actual_lines)
print "**ACTUAL**" expected = {
print actual_lines "localhost": {
"changed": 29,
"failures": 0,
"ok": 33,
"skipped": 12,
"unreachable": 0
}
}
print "**EXPECTED**" assert utils.jsonify(expected, format=True) == utils.jsonify(actual,format=True)
print expected_lines
assert actual_lines == expected_lines
def _compare_file_output(self, filename, expected_lines):
actual_lines = []
with open(filename) as f:
actual_lines = [l.strip() for l in f.readlines()]
actual_lines = sorted(actual_lines)
print "**ACTUAL**"
print actual_lines
print "**EXPECTED**"
print expected_lines
assert actual_lines == expected_lines

90
test/playbook-unarchive.yml Normal file
View file

@ -0,0 +1,90 @@
---
# To run me manually, use: -i "localhost,"
- hosts: localhost
connection: local
gather_facts: no
vars:
- testdir: /tmp/ansible-unarchive
- filesdir: test_unarchive/files
tasks:
- name: "Simple tar unarchive."
command: rm -rf {{testdir}}
- file: state=directory dest={{testdir}}
- unarchive: src={{filesdir}}/test.tar dest={{testdir}}
register: res
- command: test -f {{testdir}}/foo
- fail: msg="Resource was expected to be changed."
when: not res|changed
- unarchive: src={{filesdir}}/test.tar dest={{testdir}}
register: res
- fail: msg="Resource was not expected to be changed."
when: res|changed
- name: "Simple tar.gz unarchive."
command: rm -rf {{testdir}}
- file: state=directory dest={{testdir}}
- unarchive: src={{filesdir}}/test.tar.gz dest={{testdir}}
register: res
- command: test -f {{testdir}}/foo
- fail: msg="Resource was expected to be changed."
when: not res|changed
- unarchive: src={{filesdir}}/test.tar.gz dest={{testdir}}
register: res
- fail: msg="Resource was not expected to be changed."
when: res|changed
- name: "Simple zip unarchive."
command: rm -rf {{testdir}}
- file: state=directory dest={{testdir}}
- unarchive: src={{filesdir}}/test.zip dest={{testdir}}
register: res
- command: test -f {{testdir}}/foo
- fail: msg="Resource was expected to be changed."
when: not res|changed
- unarchive: src={{filesdir}}/test.zip dest={{testdir}}
register: res
- fail: msg="Resource was expected to be changed."
when: not res|changed
- name: "Unarchive a local tar file."
command : rm -rf {{testdir}}
- file: state=directory dest={{testdir}}
- copy: src={{filesdir}}/test.tar dest={{testdir}}
- unarchive: src={{testdir}}/test.tar dest={{testdir}}
register: res
- command: test -f {{testdir}}/foo
- fail: msg="Resource was expected to be changed."
when: not res|changed
- unarchive: src={{testdir}}/test.tar dest={{testdir}}
register: res
- fail: msg="Resource was not expected to be changed."
when: res|changed
- name: "Unarchive a local tar.gz file."
command : rm -rf {{testdir}}
- file: state=directory dest={{testdir}}
- copy: src={{filesdir}}/test.tar.gz dest={{testdir}}
- unarchive: src={{testdir}}/test.tar.gz dest={{testdir}}
register: res
- command: test -f {{testdir}}/foo
- fail: msg="Resource was expected to be changed."
when: not res|changed
- unarchive: src={{testdir}}/test.tar.gz dest={{testdir}}
register: res
- fail: msg="Resource was not expected to be changed."
when: res|changed
- name: "Unarchive a local zip file."
command : rm -rf {{testdir}}
- file: state=directory dest={{testdir}}
- copy: src={{filesdir}}/test.zip dest={{testdir}}
- unarchive: src={{testdir}}/test.zip dest={{testdir}}
register: res
- command: test -f {{testdir}}/foo
- fail: msg="Resource was expected to be changed."
when: not res|changed
- unarchive: src={{testdir}}/test.zip dest={{testdir}}
register: res
- fail: msg="Resource was expected to be changed."
when: not res|changed

BIN
test/test_unarchive/files/test.tar Normal file
View file

Binary file not shown.

BIN
test/test_unarchive/files/test.tar.gz Normal file
View file

Binary file not shown.

BIN
test/test_unarchive/files/test.zip Normal file
View file

Binary file not shown.