From fcab13a668acc0b1f810830c29276d9c9ca41ace Mon Sep 17 00:00:00 2001 From: Yadnyawalkya Tale <10824880+Yadnyawalkya@users.noreply.github.com> Date: Mon, 6 Nov 2017 13:00:33 +0000 Subject: [PATCH] PEP8 fixes: Ansible source_control module (#32323) * PEP8 fixes: Ansible source_control module * Some more cleanup changes * More cleanups * Fix copyright statement --- lib/ansible/modules/source_control/bzr.py | 46 +++++----- lib/ansible/modules/source_control/hg.py | 83 ++++++++----------- .../modules/source_control/subversion.py | 2 +- test/sanity/pep8/legacy-files.txt | 2 - 4 files changed, 57 insertions(+), 76 deletions(-) diff --git a/lib/ansible/modules/source_control/bzr.py b/lib/ansible/modules/source_control/bzr.py index e111abe4d4..74bb8980dc 100644 --- a/lib/ansible/modules/source_control/bzr.py +++ b/lib/ansible/modules/source_control/bzr.py @@ -1,58 +1,53 @@ #!/usr/bin/python # -*- coding: utf-8 -*- -# (c) 2013, André Paramés +# Copyright: (c) 2013, André Paramés # Based on the Git module by Michael DeHaan # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) from __future__ import absolute_import, division, print_function __metaclass__ = type - ANSIBLE_METADATA = {'metadata_version': '1.1', 'status': ['preview'], 'supported_by': 'community'} - DOCUMENTATION = u''' --- module: bzr -author: "André Paramés (@andreparames)" +author: +- André Paramés (@andreparames) version_added: "1.1" short_description: Deploy software (or files) from bzr branches description: - Manage I(bzr) branches to deploy files or software. options: name: - required: true - aliases: [ 'parent' ] description: - SSH or HTTP protocol address of the parent branch. + aliases: [ parent ] + required: yes dest: - required: true description: - Absolute path of where the branch should be cloned to. + required: yes version: - required: false - default: "head" description: - What version of the branch to clone. This can be the bzr revno or revid. + default: head force: - required: false - default: "no" - choices: [ 'yes', 'no' ] description: - If C(yes), any modified files in the working tree will be discarded. Before 1.9 the default - value was "yes". + value was C(yes). + type: bool + default: 'no' executable: - required: false - default: null - version_added: "1.4" description: - Path to bzr executable to use. If not supplied, the normal mechanism for resolving binary paths will be used. + version_added: '1.4' ''' EXAMPLES = ''' @@ -139,23 +134,24 @@ class Bzr(object): args_list = ["revert"] return self._command(args_list, check_rc=True, cwd=self.dest) + # =========================================== def main(): module = AnsibleModule( - argument_spec = dict( - dest=dict(required=True, type='path'), - name=dict(required=True, aliases=['parent']), - version=dict(default='head'), - force=dict(default='no', type='bool'), - executable=dict(default=None), + argument_spec=dict( + dest=dict(type='path', required=True), + name=dict(type='str', required=True, aliases=['parent']), + version=dict(type='str', default='head'), + force=dict(type='bool', default='no', type='bool'), + executable=dict(type='str'), ) ) - dest = module.params['dest'] - parent = module.params['name'] + dest = module.params['dest'] + parent = module.params['name'] version = module.params['version'] - force = module.params['force'] + force = module.params['force'] bzr_path = module.params['executable'] or module.get_bin_path('bzr', True) bzrconfig = os.path.join(dest, '.bzr', 'branch', 'branch.conf') diff --git a/lib/ansible/modules/source_control/hg.py b/lib/ansible/modules/source_control/hg.py index accf0740dd..c49f9d6cd7 100644 --- a/lib/ansible/modules/source_control/hg.py +++ b/lib/ansible/modules/source_control/hg.py @@ -1,24 +1,21 @@ #!/usr/bin/python -#-*- coding: utf-8 -*- +# -*- coding: utf-8 -*- -# (c) 2013, Yeukhon Wong -# (c) 2014, Nate Coraor -# +# Copyright: (c) 2013, Yeukhon Wong +# Copyright: (c) 2014, Nate Coraor # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) from __future__ import absolute_import, division, print_function __metaclass__ = type - ANSIBLE_METADATA = {'metadata_version': '1.1', 'status': ['preview'], 'supported_by': 'community'} - DOCUMENTATION = ''' --- module: hg -short_description: Manages Mercurial (hg) repositories. +short_description: Manages Mercurial (hg) repositories description: - Manages Mercurial (hg) repositories. Supports SSH, HTTP/S and local address. version_added: "1.0" @@ -27,76 +24,64 @@ options: repo: description: - The repository address. - required: true - default: null + required: yes aliases: [ name ] dest: description: - Absolute path of where the repository should be cloned to. This parameter is required, unless clone and update are set to no - required: true - default: null + required: yes revision: description: - Equivalent C(-r) option in hg command which could be the changeset, revision number, branch name or even tag. - required: false - default: null aliases: [ version ] force: description: - Discards uncommitted changes. Runs C(hg update -C). Prior to 1.9, the default was `yes`. - required: false - default: "no" - choices: [ "yes", "no" ] + type: bool + default: 'no' purge: description: - Deletes untracked files. Runs C(hg purge). - required: false - default: "no" - choices: [ "yes", "no" ] + type: bool + default: 'no' update: - required: false - default: "yes" - choices: [ "yes", "no" ] - version_added: "2.0" description: - If C(no), do not retrieve new revisions from the origin repository + type: bool + default: 'yes' + version_added: '2.0' clone: - required: false - default: "yes" - choices: [ "yes", "no" ] - version_added: "2.3" description: - If C(no), do not clone the repository if it does not exist locally. + type: bool + default: 'yes' + version_added: '2.3' executable: - required: false - default: null - version_added: "1.4" description: - Path to hg executable to use. If not supplied, the normal mechanism for resolving binary paths will be used. + version_added: '1.4' notes: - - "This module does not support push capability. See U(https://github.com/ansible/ansible/issues/31156)." + - This module does not support push capability. See U(https://github.com/ansible/ansible/issues/31156). - "If the task seems to be hanging, first verify remote host is in C(known_hosts). SSH will prompt user to authorize the first contact with a remote host. To avoid this prompt, one solution is to add the remote host public key in C(/etc/ssh/ssh_known_hosts) before calling the hg module, with the following command: ssh-keyscan remote_host.com >> /etc/ssh/ssh_known_hosts." -requirements: [ ] ''' EXAMPLES = ''' -# Ensure the current working copy is inside the stable branch and deletes untracked files if any. -- hg: +- name: Ensure the current working copy is inside the stable branch and deletes untracked files if any. + hg: repo: https://bitbucket.org/user/repo1 dest: /home/user/repo1 revision: stable purge: yes -# Example just get information about the repository whether or not it has -# already been cloned locally. -- hg: +- name: Get information about the repository whether or not it has already been cloned locally. + hg: repo: git://bitbucket.org/user/repo dest: /srv/checkout clone: no @@ -110,7 +95,6 @@ from ansible.module_utils._text import to_native class Hg(object): - def __init__(self, module, dest, repo, revision, hg_path): self.module = module self.dest = dest @@ -167,7 +151,7 @@ class Hg(object): self.module.fail_json(msg=err) after = self.has_local_mods() - if before != after and not after: # no more local modification + if before != after and not after: # no more local modification return True def purge(self): @@ -229,19 +213,20 @@ class Hg(object): return True return False + # =========================================== def main(): module = AnsibleModule( - argument_spec = dict( - repo = dict(required=True, aliases=['name']), - dest = dict(type='path'), - revision = dict(default=None, aliases=['version']), - force = dict(default='no', type='bool'), - purge = dict(default='no', type='bool'), - update = dict(default='yes', type='bool'), - clone = dict(default='yes', type='bool'), - executable = dict(default=None), + argument_spec=dict( + repo=dict(type='str', required=True, aliases=['name']), + dest=dict(type='path'), + revision=dict(type='str', default=None, aliases=['version']), + force=dict(type='bool', default=False), + purge=dict(type='bool', default=False), + update=dict(type='bool', default=True), + clone=dict(type='bool', default=True), + executable=dict(type='str', default=None), ), ) repo = module.params['repo'] @@ -304,7 +289,9 @@ def main(): after = hg.get_revision() if before != after or cleaned: changed = True + module.exit_json(before=before, after=after, changed=changed, cleaned=cleaned) + if __name__ == '__main__': main() diff --git a/lib/ansible/modules/source_control/subversion.py b/lib/ansible/modules/source_control/subversion.py index 8f43d7c7c2..3b2547d31b 100644 --- a/lib/ansible/modules/source_control/subversion.py +++ b/lib/ansible/modules/source_control/subversion.py @@ -272,7 +272,7 @@ def main(): module.fail_json(msg="ERROR: modified files exist in the repository.") svn.update() else: - module.fail_json(msg="ERROR: %s folder already exists, but its not a subversion repository." % (dest, )) + module.fail_json(msg="ERROR: %s folder already exists, but its not a subversion repository." % (dest,)) if export: module.exit_json(changed=True) diff --git a/test/sanity/pep8/legacy-files.txt b/test/sanity/pep8/legacy-files.txt index bceb65db4b..0f73047284 100644 --- a/test/sanity/pep8/legacy-files.txt +++ b/test/sanity/pep8/legacy-files.txt @@ -303,8 +303,6 @@ lib/ansible/modules/packaging/os/yum.py lib/ansible/modules/packaging/os/zypper.py lib/ansible/modules/packaging/os/zypper_repository.py lib/ansible/modules/remote_management/stacki/stacki_host.py -lib/ansible/modules/source_control/bzr.py -lib/ansible/modules/source_control/hg.py lib/ansible/modules/storage/infinidat/infini_export.py lib/ansible/modules/storage/infinidat/infini_export_client.py lib/ansible/modules/storage/infinidat/infini_fs.py