Merge pull request #2586 from bcoca/new_validate

Added 'validate' feature to copy and template modules,
reviewable/pr18780/r1
Michael DeHaan 12 years ago
commit 6887b4b983

15
copy

@ -64,7 +64,12 @@ options:
choices: [ "yes", "no" ] choices: [ "yes", "no" ]
default: "yes" default: "yes"
aliases: [ "thirsty" ] aliases: [ "thirsty" ]
others: validate:
description:
- validation to run before copying into place
required: false
default: ""
version_added: "1.2"
others: others:
description: description:
- all arguments accepted by the M(file) module also work here - all arguments accepted by the M(file) module also work here
@ -74,6 +79,8 @@ examples:
description: "Example from Ansible Playbooks" description: "Example from Ansible Playbooks"
- code: "copy: src=/mine/ntp.conf dest=/etc/ntp.conf owner=root group=root mode=644 backup=yes" - code: "copy: src=/mine/ntp.conf dest=/etc/ntp.conf owner=root group=root mode=644 backup=yes"
description: "Copy a new C(ntp.conf) file into place, backing up the original if it differs from the copied version" description: "Copy a new C(ntp.conf) file into place, backing up the original if it differs from the copied version"
- code: "copy: src=/mine/sudoers dest=/etc/sudoers validate='visudo -c %s'
description: "Copy a new C(sudoers) file into place, after passing validation with visudo"
author: Michael DeHaan author: Michael DeHaan
notes: notes:
- The "copy" module can't be used to recursively copy directory structures to the target machine. Please see the - The "copy" module can't be used to recursively copy directory structures to the target machine. Please see the
@ -91,6 +98,7 @@ def main():
dest = dict(required=True), dest = dict(required=True),
backup = dict(default=False, type='bool'), backup = dict(default=False, type='bool'),
force = dict(default=True, aliases=['thirsty'], type='bool'), force = dict(default=True, aliases=['thirsty'], type='bool'),
validate = dict(required=False, type='str'),
), ),
add_file_common_args=True, add_file_common_args=True,
) )
@ -100,6 +108,7 @@ def main():
backup = module.params['backup'] backup = module.params['backup']
force = module.params['force'] force = module.params['force']
original_basename = module.params.get('original_basename',None) original_basename = module.params.get('original_basename',None)
validate = module.params.get('validate',None)
if not os.path.exists(src): if not os.path.exists(src):
module.fail_json(msg="Source %s failed to transfer" % (src)) module.fail_json(msg="Source %s failed to transfer" % (src))
@ -139,6 +148,10 @@ def main():
# might be an issue with exceeding path length # might be an issue with exceeding path length
dest_tmp = "%s.%s.%s.tmp" % (dest,os.getpid(),time.time()) dest_tmp = "%s.%s.%s.tmp" % (dest,os.getpid(),time.time())
shutil.copyfile(src, dest_tmp) shutil.copyfile(src, dest_tmp)
if validate:
(rc,out,err) = module.run_command(validate % dest_tmp)
if rc != 0:
module.fail_json(msg="failed to validate: rc:%s error:%s" % (rc,err))
module.atomic_replace(dest_tmp, dest) module.atomic_replace(dest_tmp, dest)
except shutil.Error: except shutil.Error:
module.fail_json(msg="failed to copy: %s and %s are the same" % (src, dest)) module.fail_json(msg="failed to copy: %s and %s are the same" % (src, dest))

@ -140,7 +140,8 @@ def main():
state = dict(choices=['file','directory','link','absent'], default='file'), state = dict(choices=['file','directory','link','absent'], default='file'),
path = dict(aliases=['dest', 'name'], required=True), path = dict(aliases=['dest', 'name'], required=True),
recurse = dict(default='no', type='bool'), recurse = dict(default='no', type='bool'),
diff_peek = dict(default=None) diff_peek = dict(default=None),
validate = dict(required=False, default=None),
), ),
add_file_common_args=True, add_file_common_args=True,
supports_check_mode=True supports_check_mode=True

@ -35,6 +35,12 @@ options:
required: false required: false
choices: [ "yes", "no" ] choices: [ "yes", "no" ]
default: "no" default: "no"
validate:
description:
- validation to run before copying into place
required: false
default: ""
version_added: "1.2"
others: others:
description: description:
- all arguments accepted by the M(file) module also work here - all arguments accepted by the M(file) module also work here
@ -42,6 +48,8 @@ options:
examples: examples:
- code: "template: src=/mytemplates/foo.j2 dest=/etc/file.conf owner=bin group=wheel mode=0644" - code: "template: src=/mytemplates/foo.j2 dest=/etc/file.conf owner=bin group=wheel mode=0644"
description: "Example from Ansible Playbooks" description: "Example from Ansible Playbooks"
- code: "action: temlpate src=/mine/sudoers dest=/etc/sudoers validate='visudo -c %s'"
description: "Copy a new C(sudoers) file into place, after passing validation with visudo"
notes: notes:
- Since Ansible version 0.9, templates are loaded with C(trim_blocks=True). - Since Ansible version 0.9, templates are loaded with C(trim_blocks=True).
- 'You can override jinja2 settings by adding a special header to template file. - 'You can override jinja2 settings by adding a special header to template file.

Loading…
Cancel
Save