ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

fixed issue with paths separator and others

Browse source 
finished  normalizing of path handling
removed overloaded '-p' from init_paths option, it is for role_paths
removed expand_tilde and get_opt methods as both were redundant, adjusted rest of code
updated tests to match
This commit is contained in:
Brian Coca 2017-06-15 14:32:37 -04:00
parent c426481b33
commit fedbf3666b
3 changed files with 21 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
lib/ansible/cli/__init__.py
View file

@ -276,14 +276,14 @@ class CLI(with_metaclass(ABCMeta, object)):
if op.forks < 1: if op.forks < 1:
self.parser.error("The number of processes (--forks) must be >= 1") self.parser.error("The number of processes (--forks) must be >= 1")
@staticmethod
def expand_tilde(option, opt, value, parser):
setattr(parser.values, option.dest, os.path.expanduser(value))
@staticmethod @staticmethod
def unfrack_paths(option, opt, value, parser): def unfrack_paths(option, opt, value, parser):
if isinstance(value, string_types): if isinstance(value, string_types):
setattr(parser.values, option.dest, [unfrackpath(x) for x in value.split(os.sep)]) setattr(parser.values, option.dest, [unfrackpath(x) for x in value.split(os.pathsep)])
elif isinstance(value, list):
setattr(parser.values, option.dest, [unfrackpath(x) for x in value])
else:
pass #FIXME: should we raise options error?
@staticmethod @staticmethod
def unfrack_path(option, opt, value, parser): def unfrack_path(option, opt, value, parser):
@ -312,7 +312,7 @@ class CLI(with_metaclass(ABCMeta, object)):
if module_opts: if module_opts:
parser.add_option('-M', '--module-path', dest='module_path', default=None, parser.add_option('-M', '--module-path', dest='module_path', default=None,
help="prepend path(s) to module library (default=%s)" % C.DEFAULT_MODULE_PATH, help="prepend path(s) to module library (default=%s)" % C.DEFAULT_MODULE_PATH,
action="callback", callback=CLI.expand_tilde, type=str) action="callback", callback=CLI.unfrack_path, type='str')
if runtask_opts: if runtask_opts:
parser.add_option('-e', '--extra-vars', dest="extra_vars", action="append", parser.add_option('-e', '--extra-vars', dest="extra_vars", action="append",
help="set additional variables as key=value or YAML/JSON", default=[]) help="set additional variables as key=value or YAML/JSON", default=[])

39
lib/ansible/cli/galaxy.py
View file

@ -79,11 +79,11 @@ class GalaxyCLI(CLI):
self.parser.set_usage("usage: %prog info [options] role_name[,version]") self.parser.set_usage("usage: %prog info [options] role_name[,version]")
elif self.action == "init": elif self.action == "init":
self.parser.set_usage("usage: %prog init [options] role_name") self.parser.set_usage("usage: %prog init [options] role_name")
self.parser.add_option('-p', '--init-path', dest='init_path', default="./", self.parser.add_option('--init-path', dest='init_path', default="./",
help='The path in which the skeleton role will be created. The default is the current working directory.') help='The path in which the skeleton role will be created. The default is the current working directory.')
self.parser.add_option('--container-enabled', dest='container_enabled', action='store_true', default=False, self.parser.add_option('--container-enabled', dest='container_enabled', action='store_true', default=False,
help='Initialize the skeleton role with default contents for a Container Enabled role.') help='Initialize the skeleton role with default contents for a Container Enabled role.')
self.parser.add_option('--role-skeleton', dest='role_skeleton', default=None, self.parser.add_option('--role-skeleton', dest='role_skeleton', default=C.GALAXY_ROLE_SKELETON,
help='The path to a role skeleton that the new role should be based upon.') help='The path to a role skeleton that the new role should be based upon.')
elif self.action == "install": elif self.action == "install":
self.parser.set_usage("usage: %prog install [options] [-r FILE | role_name(s)[,version] | scm+role_repo_url[,version] | tar_file(s)]") self.parser.set_usage("usage: %prog install [options] [-r FILE | role_name(s)[,version] | scm+role_repo_url[,version] | tar_file(s)]")
@ -119,7 +119,7 @@ class GalaxyCLI(CLI):
# callback will set the value to a list. # callback will set the value to a list.
self.parser.add_option('-p', '--roles-path', dest='roles_path', action="callback", callback=CLI.unfrack_paths, default=C.DEFAULT_ROLES_PATH, self.parser.add_option('-p', '--roles-path', dest='roles_path', action="callback", callback=CLI.unfrack_paths, default=C.DEFAULT_ROLES_PATH,
help='The path to the directory containing your roles. The default is the roles_path configured in your ansible.cfg' help='The path to the directory containing your roles. The default is the roles_path configured in your ansible.cfg'
'file (/etc/ansible/roles if not configured)', type="string") 'file (/etc/ansible/roles if not configured)', type='str')
if self.action in ("init", "install"): if self.action in ("init", "install"):
self.parser.add_option('-f', '--force', dest='force', action='store_true', default=False, help='Force overwriting an existing role') self.parser.add_option('-f', '--force', dest='force', action='store_true', default=False, help='Force overwriting an existing role')
@ -154,7 +154,7 @@ class GalaxyCLI(CLI):
Exits with the specified return code unless the Exits with the specified return code unless the
option --ignore-errors was specified option --ignore-errors was specified
""" """
if not self.get_opt("ignore_errors", False): if not self.options.ignore_errors:
raise AnsibleError('- you can use --ignore-errors to skip failed roles and finish processing the list.') raise AnsibleError('- you can use --ignore-errors to skip failed roles and finish processing the list.')
def _display_role_info(self, role_info): def _display_role_info(self, role_info):
@ -187,9 +187,9 @@ class GalaxyCLI(CLI):
creates the skeleton framework of a role that complies with the galaxy metadata format. creates the skeleton framework of a role that complies with the galaxy metadata format.
""" """
init_path = self.get_opt('init_path', './') init_path = self.options.init_path
force = self.get_opt('force', False) force = self.options.force
role_skeleton = self.get_opt('role_skeleton', C.GALAXY_ROLE_SKELETON) role_skeleton = self.options.role_skeleton
role_name = self.args.pop(0).strip() if self.args else None role_name = self.args.pop(0).strip() if self.args else None
if not role_name: if not role_name:
@ -263,7 +263,7 @@ class GalaxyCLI(CLI):
# the user needs to specify a role # the user needs to specify a role
raise AnsibleOptionsError("- you must specify a user/role name") raise AnsibleOptionsError("- you must specify a user/role name")
roles_path = self.get_opt("roles_path") roles_path = self.options.roles_path
data = '' data = ''
for role in self.args: for role in self.args:
@ -306,7 +306,7 @@ class GalaxyCLI(CLI):
uses the args list of roles to be installed, unless -f was specified. The list of roles uses the args list of roles to be installed, unless -f was specified. The list of roles
can be a name (which will be downloaded via the galaxy API and github), or it can be a local .tar.gz file. can be a name (which will be downloaded via the galaxy API and github), or it can be a local .tar.gz file.
""" """
role_file = self.get_opt("role_file", None) role_file = self.options.role_file
if len(self.args) == 0 and role_file is None: if len(self.args) == 0 and role_file is None:
# the user needs to specify one of either --role-file or specify a single user/role name # the user needs to specify one of either --role-file or specify a single user/role name
@ -315,8 +315,8 @@ class GalaxyCLI(CLI):
# using a role file is mutually exclusive of specifying the role name on the command line # using a role file is mutually exclusive of specifying the role name on the command line
raise AnsibleOptionsError("- please specify a user/role name, or a roles file, but not both") raise AnsibleOptionsError("- please specify a user/role name, or a roles file, but not both")
no_deps = self.get_opt("no_deps", False) no_deps = self.options.no_deps
force = self.get_opt('force', False) force = self.options.force
roles_left = [] roles_left = []
if role_file: if role_file:
@ -470,7 +470,7 @@ class GalaxyCLI(CLI):
display.display("- the role %s was not found" % name) display.display("- the role %s was not found" % name)
else: else:
# show all valid roles in the roles_path directory # show all valid roles in the roles_path directory
roles_path = self.get_opt('roles_path') roles_path = self.options.roles_path
for path in roles_path: for path in roles_path:
role_path = os.path.expanduser(path) role_path = os.path.expanduser(path)
if not os.path.exists(role_path): if not os.path.exists(role_path):
@ -671,18 +671,3 @@ class GalaxyCLI(CLI):
display.display(resp['status']) display.display(resp['status'])
return True return True
def get_opt(self, k, defval=""):
"""
Returns an option from an Optparse values instance.
"""
try:
data = getattr(self.options, k)
except:
return defval
# FIXME: Can this be removed if cli and/or constants ensures it's a
# list?
if k == "roles_path":
if os.pathsep in data:
data = data.split(os.pathsep)[0]
return data

6
test/units/cli/test_galaxy.py
View file

@ -134,7 +134,7 @@ class TestGalaxy(unittest.TestCase):
role_file = os.path.join(self.role_path, self.role_name) role_file = os.path.join(self.role_path, self.role_name)
# removing role # removing role
gc = GalaxyCLI(args=["remove", "-p", role_file, self.role_name]) gc = GalaxyCLI(args=["remove", "--init-path", role_file, self.role_name])
gc.parse() gc.parse()
gc.run() gc.run()
@ -292,7 +292,7 @@ class ValidRoleTests(object):
cls.role_name = role_name cls.role_name = role_name
# create role using default skeleton # create role using default skeleton
gc = GalaxyCLI(args=['init', '-c', '--offline'] + galaxy_args + ['-p', cls.test_dir, cls.role_name]) gc = GalaxyCLI(args=['init', '-c', '--offline'] + galaxy_args + ['--init-path', cls.test_dir, cls.role_name])
gc.parse() gc.parse()
gc.run() gc.run()
cls.gc = gc cls.gc = gc
@ -430,4 +430,4 @@ class TestGalaxyInitSkeleton(unittest.TestCase, ValidRoleTests):
self.assertTrue(os.path.exists(os.path.join(self.role_dir, 'templates_extra', 'templates.txt'))) self.assertTrue(os.path.exists(os.path.join(self.role_dir, 'templates_extra', 'templates.txt')))
def test_skeleton_option(self): def test_skeleton_option(self):
self.assertEquals(self.role_skeleton_path, self.gc.get_opt('role_skeleton'), msg='Skeleton path was not parsed properly from the command line') self.assertEquals(self.role_skeleton_path, self.gc.options.role_skeleton, msg='Skeleton path was not parsed properly from the command line')