mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Added --skip-tags option to ansible-playbook.
This commit is contained in:
parent
fb869e58ee
commit
04349ec362
2 changed files with 51 additions and 23 deletions
|
@ -65,6 +65,8 @@ def main(args):
|
||||||
help="set additional key=value variables from the CLI")
|
help="set additional key=value variables from the CLI")
|
||||||
parser.add_option('-t', '--tags', dest='tags', default='all',
|
parser.add_option('-t', '--tags', dest='tags', default='all',
|
||||||
help="only run plays and tasks tagged with these values")
|
help="only run plays and tasks tagged with these values")
|
||||||
|
parser.add_option('--skip-tags', dest='skip_tags',
|
||||||
|
help="only run plays and tasks whose tags do not match these values")
|
||||||
parser.add_option('--syntax-check', dest='syntax', action='store_true',
|
parser.add_option('--syntax-check', dest='syntax', action='store_true',
|
||||||
help="perform a syntax check on the playbook, but do not execute it")
|
help="perform a syntax check on the playbook, but do not execute it")
|
||||||
parser.add_option('--list-tasks', dest='listtasks', action='store_true',
|
parser.add_option('--list-tasks', dest='listtasks', action='store_true',
|
||||||
|
@ -97,6 +99,9 @@ def main(args):
|
||||||
else:
|
else:
|
||||||
extra_vars = utils.parse_kv(options.extra_vars)
|
extra_vars = utils.parse_kv(options.extra_vars)
|
||||||
only_tags = options.tags.split(",")
|
only_tags = options.tags.split(",")
|
||||||
|
skip_tags = options.skip_tags
|
||||||
|
if options.skip_tags is not None:
|
||||||
|
skip_tags = options.skip_tags.split(",")
|
||||||
|
|
||||||
for playbook in args:
|
for playbook in args:
|
||||||
if not os.path.exists(playbook):
|
if not os.path.exists(playbook):
|
||||||
|
@ -136,6 +141,7 @@ def main(args):
|
||||||
extra_vars=extra_vars,
|
extra_vars=extra_vars,
|
||||||
private_key_file=options.private_key_file,
|
private_key_file=options.private_key_file,
|
||||||
only_tags=only_tags,
|
only_tags=only_tags,
|
||||||
|
skip_tags=skip_tags,
|
||||||
check=options.check,
|
check=options.check,
|
||||||
diff=options.diff
|
diff=options.diff
|
||||||
)
|
)
|
||||||
|
@ -156,13 +162,20 @@ def main(args):
|
||||||
print ' %s' % host
|
print ' %s' % host
|
||||||
if options.listtasks:
|
if options.listtasks:
|
||||||
matched_tags, unmatched_tags = play.compare_tags(pb.only_tags)
|
matched_tags, unmatched_tags = play.compare_tags(pb.only_tags)
|
||||||
|
|
||||||
|
# Remove skipped tasks
|
||||||
|
matched_tags = matched_tags - set(pb.skip_tags)
|
||||||
|
|
||||||
unmatched_tags.discard('all')
|
unmatched_tags.discard('all')
|
||||||
unknown_tags = set(pb.only_tags) - (matched_tags | unmatched_tags)
|
unknown_tags = ((set(pb.only_tags) | set(pb.skip_tags)) -
|
||||||
|
(matched_tags | unmatched_tags))
|
||||||
|
|
||||||
if unknown_tags:
|
if unknown_tags:
|
||||||
continue
|
continue
|
||||||
print ' play #%d (%s): task count=%d' % (playnum, label, len(play.tasks()))
|
print ' play #%d (%s): task count=%d' % (playnum, label, len(play.tasks()))
|
||||||
for task in play.tasks():
|
for task in play.tasks():
|
||||||
if set(task.tags).intersection(pb.only_tags):
|
if (set(task.tags).intersection(pb.only_tags) and not
|
||||||
|
set(task.tags).intersection(pb.skip_tags)):
|
||||||
if getattr(task, 'name', None) is not None:
|
if getattr(task, 'name', None) is not None:
|
||||||
# meta tasks have no names
|
# meta tasks have no names
|
||||||
print ' %s' % task.name
|
print ' %s' % task.name
|
||||||
|
|
|
@ -63,6 +63,7 @@ class PlayBook(object):
|
||||||
sudo_user = C.DEFAULT_SUDO_USER,
|
sudo_user = C.DEFAULT_SUDO_USER,
|
||||||
extra_vars = None,
|
extra_vars = None,
|
||||||
only_tags = None,
|
only_tags = None,
|
||||||
|
skip_tags = None,
|
||||||
subset = C.DEFAULT_SUBSET,
|
subset = C.DEFAULT_SUBSET,
|
||||||
inventory = None,
|
inventory = None,
|
||||||
check = False,
|
check = False,
|
||||||
|
@ -97,6 +98,8 @@ class PlayBook(object):
|
||||||
extra_vars = {}
|
extra_vars = {}
|
||||||
if only_tags is None:
|
if only_tags is None:
|
||||||
only_tags = [ 'all' ]
|
only_tags = [ 'all' ]
|
||||||
|
if skip_tags is None:
|
||||||
|
skip_tags = []
|
||||||
|
|
||||||
self.check = check
|
self.check = check
|
||||||
self.diff = diff
|
self.diff = diff
|
||||||
|
@ -117,6 +120,7 @@ class PlayBook(object):
|
||||||
self.global_vars = {}
|
self.global_vars = {}
|
||||||
self.private_key_file = private_key_file
|
self.private_key_file = private_key_file
|
||||||
self.only_tags = only_tags
|
self.only_tags = only_tags
|
||||||
|
self.skip_tags = skip_tags
|
||||||
self.any_errors_fatal = any_errors_fatal
|
self.any_errors_fatal = any_errors_fatal
|
||||||
|
|
||||||
self.callbacks.playbook = self
|
self.callbacks.playbook = self
|
||||||
|
@ -221,6 +225,9 @@ class PlayBook(object):
|
||||||
matched_tags_all = matched_tags_all | matched_tags
|
matched_tags_all = matched_tags_all | matched_tags
|
||||||
unmatched_tags_all = unmatched_tags_all | unmatched_tags
|
unmatched_tags_all = unmatched_tags_all | unmatched_tags
|
||||||
|
|
||||||
|
# Remove tasks we wish to skip
|
||||||
|
matched_tags = matched_tags - set(self.skip_tags)
|
||||||
|
|
||||||
# if we have matched_tags, the play must be run.
|
# if we have matched_tags, the play must be run.
|
||||||
# if the play contains no tasks, assume we just want to gather facts
|
# if the play contains no tasks, assume we just want to gather facts
|
||||||
# in this case there are actually 3 meta tasks (handler flushes) not 0
|
# in this case there are actually 3 meta tasks (handler flushes) not 0
|
||||||
|
@ -228,9 +235,11 @@ class PlayBook(object):
|
||||||
if (len(matched_tags) > 0 or len(play.tasks()) == 3):
|
if (len(matched_tags) > 0 or len(play.tasks()) == 3):
|
||||||
plays.append(play)
|
plays.append(play)
|
||||||
|
|
||||||
# if the playbook is invoked with --tags that don't exist at all in the playbooks
|
# if the playbook is invoked with --tags or --skip-tags that don't
|
||||||
# then we need to raise an error so that the user can correct the arguments.
|
# exist at all in the playbooks then we need to raise an error so that
|
||||||
unknown_tags = set(self.only_tags) - (matched_tags_all | unmatched_tags_all)
|
# the user can correct the arguments.
|
||||||
|
unknown_tags = ((set(self.only_tags) | set(self.skip_tags)) -
|
||||||
|
(matched_tags_all | unmatched_tags_all))
|
||||||
unknown_tags.discard('all')
|
unknown_tags.discard('all')
|
||||||
|
|
||||||
if len(unknown_tags) > 0:
|
if len(unknown_tags) > 0:
|
||||||
|
@ -530,11 +539,17 @@ class PlayBook(object):
|
||||||
for x in self.only_tags:
|
for x in self.only_tags:
|
||||||
|
|
||||||
for y in task.tags:
|
for y in task.tags:
|
||||||
if (x==y):
|
if x == y:
|
||||||
should_run = True
|
should_run = True
|
||||||
break
|
break
|
||||||
|
|
||||||
|
# Check for tags that we need to skip
|
||||||
if should_run:
|
if should_run:
|
||||||
|
if any(x in task.tags for x in self.skip_tags):
|
||||||
|
should_run = False
|
||||||
|
|
||||||
|
if should_run:
|
||||||
|
|
||||||
if not self._run_task(play, task, False):
|
if not self._run_task(play, task, False):
|
||||||
# whether no hosts matched is fatal or not depends if it was on the initial step.
|
# whether no hosts matched is fatal or not depends if it was on the initial step.
|
||||||
# if we got exactly no hosts on the first step (setup!) then the host group
|
# if we got exactly no hosts on the first step (setup!) then the host group
|
||||||
|
|
Loading…
Reference in a new issue