mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-23 21:30:22 -07:00
Relocating extras into lib/ansible/modules/ after merge
This commit is contained in:
James Cammarata
Matt Clay
parent
c65ba07d2c
commit
011ea55a8f
596 changed files with 0 additions and 266 deletions
202
lib/ansible/modules/files/patch.py
Normal file
202
lib/ansible/modules/files/patch.py
Normal file
|
|
@ -0,0 +1,202 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# (c) 2012, Luis Alberto Perez Lazaro <luisperlazaro@gmail.com>
|
||||
# (c) 2015, Jakub Jirutka <jakub@jirutka.cz>
|
||||
#
|
||||
# This file is part of Ansible
|
||||
#
|
||||
# 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/>.
|
||||
|
||||
ANSIBLE_METADATA = {'status': ['stableinterface'],
|
||||
'supported_by': 'community',
|
||||
'version': '1.0'}
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: patch
|
||||
author:
|
||||
- "Jakub Jirutka (@jirutka)"
|
||||
- "Luis Alberto Perez Lazaro (@luisperlaz)"
|
||||
version_added: 1.9
|
||||
description:
|
||||
- Apply patch files using the GNU patch tool.
|
||||
short_description: Apply patch files using the GNU patch tool.
|
||||
options:
|
||||
basedir:
|
||||
description:
|
||||
- Path of a base directory in which the patch file will be applied.
|
||||
May be ommitted when C(dest) option is specified, otherwise required.
|
||||
required: false
|
||||
dest:
|
||||
description:
|
||||
- Path of the file on the remote machine to be patched.
|
||||
- The names of the files to be patched are usually taken from the patch
|
||||
file, but if there's just one file to be patched it can specified with
|
||||
this option.
|
||||
required: false
|
||||
aliases: [ "originalfile" ]
|
||||
src:
|
||||
description:
|
||||
- Path of the patch file as accepted by the GNU patch tool. If
|
||||
C(remote_src) is 'no', the patch source file is looked up from the
|
||||
module's "files" directory.
|
||||
required: true
|
||||
aliases: [ "patchfile" ]
|
||||
remote_src:
|
||||
description:
|
||||
- If C(no), it will search for src at originating/master machine, if C(yes) it will
|
||||
go to the remote/target machine for the src. Default is C(no).
|
||||
choices: [ "yes", "no" ]
|
||||
required: false
|
||||
default: "no"
|
||||
strip:
|
||||
description:
|
||||
- Number that indicates the smallest prefix containing leading slashes
|
||||
that will be stripped from each file name found in the patch file.
|
||||
For more information see the strip parameter of the GNU patch tool.
|
||||
required: false
|
||||
type: "int"
|
||||
default: "0"
|
||||
backup:
|
||||
version_added: "2.0"
|
||||
description:
|
||||
- passes --backup --version-control=numbered to patch,
|
||||
producing numbered backup copies
|
||||
choices: [ 'yes', 'no' ]
|
||||
default: 'no'
|
||||
binary:
|
||||
version_added: "2.0"
|
||||
description:
|
||||
- Setting to C(yes) will disable patch's heuristic for transforming CRLF
|
||||
line endings into LF. Line endings of src and dest must match. If set to
|
||||
C(no), patch will replace CRLF in src files on POSIX.
|
||||
required: false
|
||||
type: "bool"
|
||||
default: "no"
|
||||
note:
|
||||
- This module requires GNU I(patch) utility to be installed on the remote host.
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: apply patch to one file
|
||||
patch: >
|
||||
src=/tmp/index.html.patch
|
||||
dest=/var/www/index.html
|
||||
|
||||
- name: apply patch to multiple files under basedir
|
||||
patch: >
|
||||
src=/tmp/customize.patch
|
||||
basedir=/var/www
|
||||
strip=1
|
||||
'''
|
||||
|
||||
import os
|
||||
from os import path, R_OK, W_OK
|
||||
|
||||
|
||||
class PatchError(Exception):
|
||||
pass
|
||||
|
||||
|
||||
def is_already_applied(patch_func, patch_file, basedir, dest_file=None, binary=False, strip=0):
|
||||
opts = ['--quiet', '--reverse', '--forward', '--dry-run',
|
||||
"--strip=%s" % strip, "--directory='%s'" % basedir,
|
||||
"--input='%s'" % patch_file]
|
||||
if binary:
|
||||
opts.append('--binary')
|
||||
if dest_file:
|
||||
opts.append("'%s'" % dest_file)
|
||||
|
||||
(rc, _, _) = patch_func(opts)
|
||||
return rc == 0
|
||||
|
||||
|
||||
def apply_patch(patch_func, patch_file, basedir, dest_file=None, binary=False, strip=0, dry_run=False, backup=False):
|
||||
opts = ['--quiet', '--forward', '--batch', '--reject-file=-',
|
||||
"--strip=%s" % strip, "--directory='%s'" % basedir,
|
||||
"--input='%s'" % patch_file]
|
||||
if dry_run:
|
||||
opts.append('--dry-run')
|
||||
if binary:
|
||||
opts.append('--binary')
|
||||
if dest_file:
|
||||
opts.append("'%s'" % dest_file)
|
||||
if backup:
|
||||
opts.append('--backup --version-control=numbered')
|
||||
|
||||
(rc, out, err) = patch_func(opts)
|
||||
if rc != 0:
|
||||
msg = err or out
|
||||
raise PatchError(msg)
|
||||
|
||||
|
||||
def main():
|
||||
module = AnsibleModule(
|
||||
argument_spec={
|
||||
'src': {'required': True, 'aliases': ['patchfile']},
|
||||
'dest': {'aliases': ['originalfile']},
|
||||
'basedir': {},
|
||||
'strip': {'default': 0, 'type': 'int'},
|
||||
'remote_src': {'default': False, 'type': 'bool'},
|
||||
# NB: for 'backup' parameter, semantics is slightly different from standard
|
||||
# since patch will create numbered copies, not strftime("%Y-%m-%d@%H:%M:%S~")
|
||||
'backup': {'default': False, 'type': 'bool'},
|
||||
'binary': {'default': False, 'type': 'bool'},
|
||||
},
|
||||
required_one_of=[['dest', 'basedir']],
|
||||
supports_check_mode=True
|
||||
)
|
||||
|
||||
# Create type object as namespace for module params
|
||||
p = type('Params', (), module.params)
|
||||
|
||||
p.src = os.path.expanduser(p.src)
|
||||
if not os.access(p.src, R_OK):
|
||||
module.fail_json(msg="src %s doesn't exist or not readable" % (p.src))
|
||||
|
||||
if p.dest and not os.access(p.dest, W_OK):
|
||||
module.fail_json(msg="dest %s doesn't exist or not writable" % (p.dest))
|
||||
|
||||
if p.basedir and not path.exists(p.basedir):
|
||||
module.fail_json(msg="basedir %s doesn't exist" % (p.basedir))
|
||||
|
||||
if not p.basedir:
|
||||
p.basedir = path.dirname(p.dest)
|
||||
|
||||
patch_bin = module.get_bin_path('patch')
|
||||
if patch_bin is None:
|
||||
module.fail_json(msg="patch command not found")
|
||||
patch_func = lambda opts: module.run_command("%s %s" % (patch_bin, ' '.join(opts)))
|
||||
|
||||
# patch need an absolute file name
|
||||
p.src = os.path.abspath(p.src)
|
||||
|
||||
changed = False
|
||||
if not is_already_applied(patch_func, p.src, p.basedir, dest_file=p.dest, binary=p.binary, strip=p.strip):
|
||||
try:
|
||||
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 )
|
||||
changed = True
|
||||
except PatchError:
|
||||
e = get_exception()
|
||||
module.fail_json(msg=str(e))
|
||||
|
||||
module.exit_json(changed=changed)
|
||||
|
||||
# import module snippets
|
||||
from ansible.module_utils.basic import *
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Loading…
Add table
Add a link
Reference in a new issue