ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-26 22:51:23 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

add state parameter to patch module (#33692)

Browse source 
* add state parameter to patch module

* add "version_added" to state parameter docu

* fix state parameter call

* change version_added to 2.6
This commit is contained in:
markusbloch 2018-05-12 10:58:12 +02:00 • committed by ansibot
commit a199c9b04f
1 changed files with 22 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

27
lib/ansible/modules/files/patch.py
View file

@ -42,6 +42,12 @@ options:
module's I(files) directory. module's I(files) directory.
required: true required: true
aliases: [ patchfile ] aliases: [ patchfile ]
state:
version_added: "2.6"
description:
- Whether the patch should be applied or reverted.
choices: [ absent, present ]
default: present
remote_src: remote_src:
description: description:
- If C(no), it will search for src at originating/master machine, if C(yes) it will - If C(no), it will search for src at originating/master machine, if C(yes) it will
@ -84,6 +90,12 @@ EXAMPLES = r'''
src: /tmp/customize.patch src: /tmp/customize.patch
basedir: /var/www basedir: /var/www
strip: 1 strip: 1
- name: Revert patch to one file
patch:
src: /tmp/index.html.patch
dest: /var/www/index.html
state: absent
''' '''
import os import os
@ -96,20 +108,22 @@ class PatchError(Exception):
pass pass
def is_already_applied(patch_func, patch_file, basedir, dest_file=None, binary=False, strip=0): def is_already_applied(patch_func, patch_file, basedir, dest_file=None, binary=False, strip=0, state='present'):
opts = ['--quiet', '--reverse', '--forward', '--dry-run', opts = ['--quiet', '--forward', '--dry-run',
"--strip=%s" % strip, "--directory='%s'" % basedir, "--strip=%s" % strip, "--directory='%s'" % basedir,
"--input='%s'" % patch_file] "--input='%s'" % patch_file]
if binary: if binary:
opts.append('--binary') opts.append('--binary')
if dest_file: if dest_file:
opts.append("'%s'" % dest_file) opts.append("'%s'" % dest_file)
if state == 'present':
opts.append('--reverse')
(rc, _, _) = patch_func(opts) (rc, _, _) = patch_func(opts)
return rc == 0 return rc == 0
def apply_patch(patch_func, patch_file, basedir, dest_file=None, binary=False, strip=0, dry_run=False, backup=False): def apply_patch(patch_func, patch_file, basedir, dest_file=None, binary=False, strip=0, dry_run=False, backup=False, state='present'):
opts = ['--quiet', '--forward', '--batch', '--reject-file=-', opts = ['--quiet', '--forward', '--batch', '--reject-file=-',
"--strip=%s" % strip, "--directory='%s'" % basedir, "--strip=%s" % strip, "--directory='%s'" % basedir,
"--input='%s'" % patch_file] "--input='%s'" % patch_file]
@ -121,6 +135,8 @@ def apply_patch(patch_func, patch_file, basedir, dest_file=None, binary=False, s
opts.append("'%s'" % dest_file) opts.append("'%s'" % dest_file)
if backup: if backup:
opts.append('--backup --version-control=numbered') opts.append('--backup --version-control=numbered')
if state == 'absent':
opts.append('--reverse')
(rc, out, err) = patch_func(opts) (rc, out, err) = patch_func(opts)
if rc != 0: if rc != 0:
@ -140,6 +156,7 @@ def main():
# since patch will create numbered copies, not strftime("%Y-%m-%d@%H:%M:%S~") # since patch will create numbered copies, not strftime("%Y-%m-%d@%H:%M:%S~")
backup=dict(type='bool', default=False), backup=dict(type='bool', default=False),
binary=dict(type='bool', default=False), binary=dict(type='bool', default=False),
state=dict(type='str', default='present', choices=['absent', 'present']),
), ),
required_one_of=[['dest', 'basedir']], required_one_of=[['dest', 'basedir']],
supports_check_mode=True, supports_check_mode=True,
@ -171,10 +188,10 @@ def main():
p.src = os.path.abspath(p.src) p.src = os.path.abspath(p.src)
changed = False changed = False
if not is_already_applied(patch_func, p.src, p.basedir, dest_file=p.dest, binary=p.binary, strip=p.strip): if not is_already_applied(patch_func, p.src, p.basedir, dest_file=p.dest, binary=p.binary, strip=p.strip, state=p.state):
try: try:
apply_patch(patch_func, p.src, p.basedir, dest_file=p.dest, binary=p.binary, strip=p.strip, apply_patch(patch_func, p.src, p.basedir, dest_file=p.dest, binary=p.binary, strip=p.strip,
dry_run=module.check_mode, backup=p.backup) dry_run=module.check_mode, backup=p.backup, state=p.state)
changed = True changed = True
except PatchError as e: except PatchError as e:
module.fail_json(msg=to_native(e), exception=format_exc()) module.fail_json(msg=to_native(e), exception=format_exc())