From 0cf00db75087a4ab6c51d4d2a3bc4d2ae547840e Mon Sep 17 00:00:00 2001 From: Robin Roth Date: Tue, 2 May 2017 18:33:02 +0200 Subject: [PATCH] Make git module pep8 compliant (#24196) --- lib/ansible/modules/source_control/git.py | 124 +++++++++++++--------- test/sanity/pep8/legacy-files.txt | 1 - 2 files changed, 75 insertions(+), 50 deletions(-) diff --git a/lib/ansible/modules/source_control/git.py b/lib/ansible/modules/source_control/git.py index e36ca2a3d5cc41..c4099d856db88c 100644 --- a/lib/ansible/modules/source_control/git.py +++ b/lib/ansible/modules/source_control/git.py @@ -286,7 +286,7 @@ def head_splitter(headfile, remote, module=None, fail_on_error=False): rawdata = rawdata.replace('refs/remotes/%s' % remote, '', 1) refparts = rawdata.split(' ') newref = refparts[-1] - nrefparts = newref.split('/',2) + nrefparts = newref.split('/', 2) res = nrefparts[-1].rstrip('\n') except: if fail_on_error and module: @@ -301,11 +301,11 @@ def unfrackgitpath(path): # copied from ansible.utils.path return os.path.normpath(os.path.realpath(os.path.expanduser(os.path.expandvars(path)))) -def get_submodule_update_params(module, git_path, cwd): - #or: git submodule [--quiet] update [--init] [-N|--no-fetch] - #[-f|--force] [--rebase] [--reference ] [--merge] - #[--recursive] [--] [...] +def get_submodule_update_params(module, git_path, cwd): + # or: git submodule [--quiet] update [--init] [-N|--no-fetch] + # [-f|--force] [--rebase] [--reference ] [--merge] + # [--recursive] [--] [...] params = [] @@ -318,9 +318,9 @@ def get_submodule_update_params(module, git_path, cwd): if 'git submodule [--quiet] update ' in line: update_line = line if update_line: - update_line = update_line.replace('[','') - update_line = update_line.replace(']','') - update_line = update_line.replace('|',' ') + update_line = update_line.replace('[', '') + update_line = update_line.replace(']', '') + update_line = update_line.replace('|', ' ') parts = shlex.split(update_line) for part in parts: if part.startswith('--'): @@ -329,12 +329,13 @@ def get_submodule_update_params(module, git_path, cwd): return params + def write_ssh_wrapper(): module_dir = get_module_path() try: # make sure we have full permission to the module_dir, which # may not be the case if we're sudo'ing to a non-root user - if os.access(module_dir, os.W_OK|os.R_OK|os.X_OK): + if os.access(module_dir, os.W_OK | os.R_OK | os.X_OK): fd, wrapper_path = tempfile.mkstemp(prefix=module_dir + '/') else: raise OSError @@ -360,6 +361,7 @@ def write_ssh_wrapper(): os.chmod(wrapper_path, st.st_mode | stat.S_IEXEC) return wrapper_path + def set_git_ssh(ssh_wrapper, key_file, ssh_opts): if os.environ.get("GIT_SSH"): @@ -378,6 +380,7 @@ def set_git_ssh(ssh_wrapper, key_file, ssh_opts): if ssh_opts: os.environ["GIT_SSH_OPTS"] = ssh_opts + def get_version(module, git_path, dest, ref="HEAD"): ''' samples the version of the git repo ''' @@ -386,11 +389,16 @@ def get_version(module, git_path, dest, ref="HEAD"): sha = to_native(stdout).rstrip('\n') return sha + def get_submodule_versions(git_path, module, dest, version='HEAD'): cmd = [git_path, 'submodule', 'foreach', git_path, 'rev-parse', version] (rc, out, err) = module.run_command(cmd, cwd=dest) if rc != 0: - module.fail_json(msg='Unable to determine hashes of submodules', stdout=out, stderr=err, rc=rc) + module.fail_json( + msg='Unable to determine hashes of submodules', + stdout=out, + stderr=err, + rc=rc) submodules = {} subm_name = None for line in out.splitlines(): @@ -408,6 +416,7 @@ def get_submodule_versions(git_path, module, dest, version='HEAD'): return submodules + def clone(git_path, module, repo, dest, remote, depth, version, bare, reference, refspec, verify_commit): ''' makes a new git repo if it does not already exist ''' @@ -417,18 +426,18 @@ def clone(git_path, module, repo, dest, remote, depth, version, bare, os.makedirs(dest_dirname) except: pass - cmd = [ git_path, 'clone' ] + cmd = [git_path, 'clone'] if bare: cmd.append('--bare') else: - cmd.extend([ '--origin', remote ]) + cmd.extend(['--origin', remote]) if depth: if version == 'HEAD' or refspec: - cmd.extend([ '--depth', str(depth) ]) + cmd.extend(['--depth', str(depth)]) elif is_remote_branch(git_path, module, dest, repo, version) \ or is_remote_tag(git_path, module, dest, repo, version): - cmd.extend([ '--depth', str(depth) ]) + cmd.extend(['--depth', str(depth)]) cmd.extend(['--branch', version]) else: # only use depth if the remote object is branch or tag (i.e. fetchable) @@ -436,8 +445,8 @@ def clone(git_path, module, repo, dest, remote, depth, version, bare, "Shallow clones are only available for " "HEAD, branches, tags or in combination with refspec.") if reference: - cmd.extend([ '--reference', str(reference) ]) - cmd.extend([ repo, dest ]) + cmd.extend(['--reference', str(reference)]) + cmd.extend([repo, dest]) module.run_command(cmd, check_rc=True, cwd=dest_dirname) if bare: if remote != 'origin': @@ -446,13 +455,14 @@ def clone(git_path, module, repo, dest, remote, depth, version, bare, if refspec: cmd = [git_path, 'fetch'] if depth: - cmd.extend([ '--depth', str(depth) ]) + cmd.extend(['--depth', str(depth)]) cmd.extend([remote, refspec]) module.run_command(cmd, check_rc=True, cwd=dest) if verify_commit: verify_commit_sign(git_path, module, dest, version) + def has_local_mods(module, git_path, dest, bare): if bare: return False @@ -464,6 +474,7 @@ def has_local_mods(module, git_path, dest, bare): return len(lines) > 0 + def reset(git_path, module, dest): ''' Resets the index and working tree to HEAD. @@ -473,10 +484,11 @@ def reset(git_path, module, dest): cmd = "%s reset --hard HEAD" % (git_path,) return module.run_command(cmd, check_rc=True, cwd=dest) + def get_diff(module, git_path, dest, repo, remote, depth, bare, before, after): ''' Return the difference between 2 versions ''' if before is None: - return { 'prepared': '>> Newly checked out %s' % after } + return {'prepared': '>> Newly checked out %s' % after} elif before != after: # Ensure we have the object we are referring to during git diff ! git_version_used = git_version(git_path, module) @@ -484,15 +496,16 @@ def get_diff(module, git_path, dest, repo, remote, depth, bare, before, after): cmd = '%s diff %s %s' % (git_path, before, after) (rc, out, err) = module.run_command(cmd, cwd=dest) if rc == 0 and out: - return { 'prepared': out } + return {'prepared': out} elif rc == 0: - return { 'prepared': '>> No visual differences between %s and %s' % (before, after) } + return {'prepared': '>> No visual differences between %s and %s' % (before, after)} elif err: - return { 'prepared': '>> Failed to get proper diff between %s and %s:\n>> %s' % (before, after, err) } + return {'prepared': '>> Failed to get proper diff between %s and %s:\n>> %s' % (before, after, err)} else: - return { 'prepared': '>> Failed to get proper diff between %s and %s' % (before, after) } + return {'prepared': '>> Failed to get proper diff between %s and %s' % (before, after)} return {} + def get_remote_head(git_path, module, dest, version, remote, bare): cloning = False cwd = None @@ -535,6 +548,7 @@ def get_remote_head(git_path, module, dest, version, remote, bare): rev = out.split()[0] return rev + def is_remote_tag(git_path, module, dest, remote, version): cmd = '%s ls-remote %s -t refs/tags/%s' % (git_path, remote, version) (rc, out, err) = module.run_command(cmd, check_rc=True, cwd=dest) @@ -543,6 +557,7 @@ def is_remote_tag(git_path, module, dest, remote, version): else: return False + def get_branches(git_path, module, dest): branches = [] cmd = '%s branch --no-color -a' % (git_path,) @@ -554,6 +569,7 @@ def get_branches(git_path, module, dest): branches.append(line.strip()) return branches + def get_tags(git_path, module, dest): tags = [] cmd = '%s tag' % (git_path,) @@ -565,6 +581,7 @@ def get_tags(git_path, module, dest): tags.append(line.strip()) return tags + def is_remote_branch(git_path, module, dest, remote, version): cmd = '%s ls-remote %s -h refs/heads/%s' % (git_path, remote, version) (rc, out, err) = module.run_command(cmd, check_rc=True, cwd=dest) @@ -573,6 +590,7 @@ def is_remote_branch(git_path, module, dest, remote, version): else: return False + def is_local_branch(git_path, module, dest, branch): branches = get_branches(git_path, module, dest) lbranch = '%s' % branch @@ -583,6 +601,7 @@ def is_local_branch(git_path, module, dest, branch): else: return False + def is_not_a_branch(git_path, module, dest): branches = get_branches(git_path, module, dest) for branch in branches: @@ -590,6 +609,7 @@ def is_not_a_branch(git_path, module, dest): return True return False + def get_head_branch(git_path, module, dest, remote, bare=False): ''' Determine what branch HEAD is associated with. This is partly @@ -632,6 +652,7 @@ def get_head_branch(git_path, module, dest, remote, bare=False): branch = head_splitter(headfile, remote, module=module, fail_on_error=True) return branch + def get_remote_url(git_path, module, dest, remote): '''Return URL of remote source for repo.''' command = [git_path, 'ls-remote', '--get-url', remote] @@ -642,6 +663,7 @@ def get_remote_url(git_path, module, dest, remote): return None return to_native(out).rstrip('\n') + def set_remote_url(git_path, module, repo, dest, remote): ''' updates repo from remote sources ''' # Return if remote URL isn't changing. @@ -659,6 +681,7 @@ def set_remote_url(git_path, module, repo, dest, remote): # for Git versions prior to 1.7.5 that lack required functionality. return remote_url is not None + def fetch(git_path, module, repo, dest, version, remote, depth, bare, refspec, git_version_used): ''' updates repo from remote sources ''' set_remote_url(git_path, module, repo, dest, remote) @@ -686,7 +709,7 @@ def fetch(git_path, module, repo, dest, version, remote, depth, bare, refspec, g else: refspecs.append(version) elif is_remote_tag(git_path, module, dest, repo, version): - refspecs.append('+refs/tags/'+version+':refs/tags/'+version) + refspecs.append('+refs/tags/' + version + ':refs/tags/' + version) if refspecs: # if refspecs is empty, i.e. version is neither heads nor tags # assume it is a version hash @@ -713,11 +736,12 @@ def fetch(git_path, module, repo, dest, version, remote, depth, bare, refspec, g commands.append((fetch_str, fetch_cmd + refspecs)) - for (label,command) in commands: - (rc,out,err) = module.run_command(command, cwd=dest) + for (label, command) in commands: + (rc, out, err) = module.run_command(command, cwd=dest) if rc != 0: module.fail_json(msg="Failed to %s: %s %s" % (label, out, err), cmd=command) + def submodules_fetch(git_path, module, remote, track_submodules, dest): changed = False @@ -754,10 +778,9 @@ def submodules_fetch(git_path, module, remote, track_submodules, dest): if track_submodules: # Compare against submodule HEAD - ### FIXME: determine this from .gitmodules + # FIXME: determine this from .gitmodules version = 'master' - after = get_submodule_versions(git_path, module, dest, '%s/%s' - % (remote, version)) + after = get_submodule_versions(git_path, module, dest, '%s/%s' % (remote, version)) if begin != after: changed = True else: @@ -772,6 +795,7 @@ def submodules_fetch(git_path, module, remote, track_submodules, dest): break return changed + def submodule_update(git_path, module, dest, track_submodules, force=False): ''' init and update any submodules ''' @@ -781,12 +805,12 @@ def submodule_update(git_path, module, dest, track_submodules, force=False): # skip submodule commands if .gitmodules is not present if not os.path.exists(os.path.join(dest, '.gitmodules')): return (0, '', '') - cmd = [ git_path, 'submodule', 'sync' ] + cmd = [git_path, 'submodule', 'sync'] (rc, out, err) = module.run_command(cmd, check_rc=True, cwd=dest) if 'remote' in params and track_submodules: - cmd = [ git_path, 'submodule', 'update', '--init', '--recursive' ,'--remote' ] + cmd = [git_path, 'submodule', 'update', '--init', '--recursive', '--remote'] else: - cmd = [ git_path, 'submodule', 'update', '--init', '--recursive' ] + cmd = [git_path, 'submodule', 'update', '--init', '--recursive'] if force: cmd.append('--force') (rc, out, err) = module.run_command(cmd, cwd=dest) @@ -794,6 +818,7 @@ def submodule_update(git_path, module, dest, track_submodules, force=False): module.fail_json(msg="Failed to init/update submodules: %s" % out + err) return (rc, out, err) + def set_remote_branch(git_path, module, dest, remote, version, depth): """set refs for the remote branch version @@ -808,6 +833,7 @@ def set_remote_branch(git_path, module, dest, remote, version, depth): if rc != 0: module.fail_json(msg="Failed to fetch branch from remote: %s" % version, stdout=out, stderr=err, rc=rc) + def switch_version(git_path, module, dest, remote, version, verify_commit, depth): cmd = '' if version == 'HEAD': @@ -830,8 +856,7 @@ def switch_version(git_path, module, dest, remote, version, verify_commit, depth else: (rc, out, err) = module.run_command("%s checkout --force %s" % (git_path, version), cwd=dest) if rc != 0: - module.fail_json(msg="Failed to checkout branch %s" % version, - stdout=out, stderr=err, rc=rc) + module.fail_json(msg="Failed to checkout branch %s" % version, stdout=out, stderr=err, rc=rc) cmd = "%s reset --hard %s/%s" % (git_path, remote, version) else: cmd = "%s checkout --force %s" % (git_path, version) @@ -867,7 +892,8 @@ def git_version(git_path, module): cmd = "%s --version" % git_path (rc, out, err) = module.run_command(cmd) if rc != 0: - # one could fail_json here, but the version info is not that important, so let's try to fail only on actual git commands + # one could fail_json here, but the version info is not that important, + # so let's try to fail only on actual git commands return None rematch = re.search('git version (.*)$', to_native(out)) if not rematch: @@ -879,7 +905,7 @@ def git_version(git_path, module): def main(): module = AnsibleModule( - argument_spec = dict( + argument_spec=dict( dest=dict(type='path'), repo=dict(required=True, aliases=['name']), version=dict(default='HEAD'), @@ -903,24 +929,24 @@ def main(): supports_check_mode=True ) - dest = module.params['dest'] - repo = module.params['repo'] - version = module.params['version'] - remote = module.params['remote'] - refspec = module.params['refspec'] - force = module.params['force'] - depth = module.params['depth'] - update = module.params['update'] + dest = module.params['dest'] + repo = module.params['repo'] + version = module.params['version'] + remote = module.params['remote'] + refspec = module.params['refspec'] + force = module.params['force'] + depth = module.params['depth'] + update = module.params['update'] allow_clone = module.params['clone'] - bare = module.params['bare'] + bare = module.params['bare'] verify_commit = module.params['verify_commit'] reference = module.params['reference'] - git_path = module.params['executable'] or module.get_bin_path('git', True) - key_file = module.params['key_file'] - ssh_opts = module.params['ssh_opts'] - umask = module.params['umask'] + git_path = module.params['executable'] or module.get_bin_path('git', True) + key_file = module.params['key_file'] + ssh_opts = module.params['ssh_opts'] + umask = module.params['umask'] - result = dict(changed = False, warnings=list()) + result = dict(changed=False, warnings=list()) # evaluate and set the umask before doing anything else if umask is not None: diff --git a/test/sanity/pep8/legacy-files.txt b/test/sanity/pep8/legacy-files.txt index 6da7723c54cec5..5f5af91fb17190 100644 --- a/test/sanity/pep8/legacy-files.txt +++ b/test/sanity/pep8/legacy-files.txt @@ -679,7 +679,6 @@ lib/ansible/modules/remote_management/hpilo/hponcfg.py lib/ansible/modules/remote_management/stacki/stacki_host.py lib/ansible/modules/remote_management/wakeonlan.py lib/ansible/modules/source_control/bzr.py -lib/ansible/modules/source_control/git.py lib/ansible/modules/source_control/github_hooks.py lib/ansible/modules/source_control/gitlab_group.py lib/ansible/modules/source_control/gitlab_project.py