Merge "Move the _tag module from OSC to osc-lib"
This commit is contained in:
Zuul
Gerrit Code Review
commit
8315e5015c
|
|
@ -0,0 +1,171 @@
|
|||
# Copyright 2019 Red Hat, Inc. All rights reserved.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||
# not use this file except in compliance with the License. You may obtain
|
||||
# a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||
# License for the specific language governing permissions and limitations
|
||||
# under the License.
|
||||
|
||||
import argparse
|
||||
import mock
|
||||
|
||||
from osc_lib.tests import utils as test_utils
|
||||
from osc_lib.utils import tags
|
||||
|
||||
|
||||
class TestTags(test_utils.TestCase):
|
||||
|
||||
def test_add_tag_filtering_option_to_parser(self):
|
||||
parser = argparse.ArgumentParser()
|
||||
tags.add_tag_filtering_option_to_parser(parser, 'test')
|
||||
|
||||
parsed_args = parser.parse_args(['--tags', 'tag1,tag2',
|
||||
'--any-tags', 'tag4',
|
||||
'--not-tags', 'tag5',
|
||||
'--not-any-tags', 'tag6'])
|
||||
|
||||
actual = getattr(parsed_args, 'tags', [])
|
||||
expected = ['tag1', 'tag2']
|
||||
self.assertItemsEqual(expected, actual)
|
||||
|
||||
actual = getattr(parsed_args, 'any_tags', [])
|
||||
expected = ['tag4']
|
||||
self.assertItemsEqual(expected, actual)
|
||||
|
||||
actual = getattr(parsed_args, 'not_tags', [])
|
||||
expected = ['tag5']
|
||||
self.assertItemsEqual(expected, actual)
|
||||
|
||||
actual = getattr(parsed_args, 'not_any_tags', [])
|
||||
expected = ['tag6']
|
||||
self.assertItemsEqual(expected, actual)
|
||||
|
||||
def test_get_tag_filtering_args(self):
|
||||
parser = argparse.ArgumentParser()
|
||||
tags.add_tag_filtering_option_to_parser(parser, 'test')
|
||||
|
||||
parsed_args = parser.parse_args(['--tags', 'tag1,tag2',
|
||||
'--any-tags', 'tag4',
|
||||
'--not-tags', 'tag5',
|
||||
'--not-any-tags', 'tag6'])
|
||||
expected = {'tags': 'tag1,tag2', 'any_tags': 'tag4',
|
||||
'not_tags': 'tag5', 'not_any_tags': 'tag6'}
|
||||
args = {}
|
||||
tags.get_tag_filtering_args(parsed_args, args)
|
||||
self.assertEqual(expected, args)
|
||||
|
||||
def test_add_tag_option_to_parser_for_create(self):
|
||||
parser = argparse.ArgumentParser()
|
||||
tags.add_tag_option_to_parser_for_create(parser, 'test')
|
||||
|
||||
# Test that --tag and --no-tag are mutually exclusive
|
||||
self.assertRaises(SystemExit, parser.parse_args,
|
||||
['--tag', 'tag1', '--no-tag'])
|
||||
|
||||
parsed_args = parser.parse_args(['--tag', 'tag1'])
|
||||
actual = getattr(parsed_args, 'tags', [])
|
||||
expected = ['tag1']
|
||||
self.assertItemsEqual(expected, actual)
|
||||
|
||||
parsed_args = parser.parse_args(['--no-tag'])
|
||||
actual = getattr(parsed_args, 'no-tag', [])
|
||||
expected = []
|
||||
self.assertItemsEqual(expected, actual)
|
||||
|
||||
def test_add_tag_option_to_parser_for_set(self):
|
||||
parser = argparse.ArgumentParser()
|
||||
tags.add_tag_option_to_parser_for_set(parser, 'test')
|
||||
|
||||
parsed_args = parser.parse_args(['--tag', 'tag1'])
|
||||
actual = getattr(parsed_args, 'tags', [])
|
||||
expected = ['tag1']
|
||||
self.assertItemsEqual(expected, actual)
|
||||
|
||||
parsed_args = parser.parse_args(['--no-tag'])
|
||||
actual = getattr(parsed_args, 'no-tag', [])
|
||||
expected = []
|
||||
self.assertItemsEqual(expected, actual)
|
||||
|
||||
def test_add_tag_option_to_parser_for_unset(self):
|
||||
parser = argparse.ArgumentParser()
|
||||
tags.add_tag_option_to_parser_for_unset(parser, 'test')
|
||||
|
||||
# Test that --tag and --all-tag are mutually exclusive
|
||||
self.assertRaises(SystemExit, parser.parse_args,
|
||||
['--tag', 'tag1', '--all-tag'])
|
||||
|
||||
parsed_args = parser.parse_args(['--tag', 'tag1'])
|
||||
actual = getattr(parsed_args, 'tags', [])
|
||||
expected = ['tag1']
|
||||
self.assertItemsEqual(expected, actual)
|
||||
|
||||
parsed_args = parser.parse_args(['--all-tag'])
|
||||
actual = getattr(parsed_args, 'all-tag', [])
|
||||
expected = []
|
||||
self.assertItemsEqual(expected, actual)
|
||||
|
||||
def test_update_tags_for_set(self):
|
||||
mock_client = mock.MagicMock()
|
||||
mock_obj = mock.MagicMock()
|
||||
mock_parsed_args = mock.MagicMock()
|
||||
|
||||
# no-tag True path
|
||||
mock_parsed_args.no_tag = True
|
||||
mock_parsed_args.tags = ['tag1']
|
||||
mock_obj.tags = None
|
||||
tags.update_tags_for_set(mock_client, mock_obj, mock_parsed_args)
|
||||
mock_client.set_tags.assert_called_once_with(
|
||||
mock_obj, list(mock_parsed_args.tags))
|
||||
|
||||
# no-tag False path
|
||||
mock_client.set_tags.reset_mock()
|
||||
mock_parsed_args.no_tag = False
|
||||
mock_parsed_args.tags = ['tag1']
|
||||
mock_obj.tags = ['tag2']
|
||||
expected_list = ['tag1', 'tag2']
|
||||
tags.update_tags_for_set(mock_client, mock_obj, mock_parsed_args)
|
||||
mock_client.set_tags.assert_called_once_with(
|
||||
mock_obj, expected_list)
|
||||
|
||||
# no new tags path
|
||||
mock_client.set_tags.reset_mock()
|
||||
mock_parsed_args.no_tag = False
|
||||
mock_parsed_args.tags = None
|
||||
mock_obj.tags = ['tag2']
|
||||
tags.update_tags_for_set(mock_client, mock_obj, mock_parsed_args)
|
||||
mock_client.set_tags.assert_not_called()
|
||||
|
||||
def test_update_tags_for_unset(self):
|
||||
mock_client = mock.MagicMock()
|
||||
mock_obj = mock.MagicMock()
|
||||
mock_parsed_args = mock.MagicMock()
|
||||
|
||||
# No new tags
|
||||
mock_obj.tags = ['tag1']
|
||||
mock_parsed_args.all_tag = False
|
||||
mock_parsed_args.tags = None
|
||||
tags.update_tags_for_unset(mock_client, mock_obj, mock_parsed_args)
|
||||
mock_client.set_tags.assert_not_called()
|
||||
|
||||
# Clear all tags
|
||||
mock_obj.tags = ['tag1']
|
||||
mock_parsed_args.all_tag = True
|
||||
mock_parsed_args.tags = None
|
||||
tags.update_tags_for_unset(mock_client, mock_obj, mock_parsed_args)
|
||||
mock_client.set_tags.assert_called_once_with(
|
||||
mock_obj, [])
|
||||
|
||||
# Remove one tag
|
||||
mock_client.set_tags.reset_mock()
|
||||
mock_obj.tags = ['tag1', 'tag2']
|
||||
mock_parsed_args.all_tag = False
|
||||
mock_parsed_args.tags = ['tag2']
|
||||
tags.update_tags_for_unset(mock_client, mock_obj, mock_parsed_args)
|
||||
mock_client.set_tags.assert_called_once_with(
|
||||
mock_obj, ['tag1'])
|
||||
|
|
@ -0,0 +1,174 @@
|
|||
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||
# not use this file except in compliance with the License. You may obtain
|
||||
# a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||
# License for the specific language governing permissions and limitations
|
||||
# under the License.
|
||||
#
|
||||
|
||||
import argparse
|
||||
|
||||
from osc_lib.i18n import _
|
||||
|
||||
|
||||
class _CommaListAction(argparse.Action):
|
||||
|
||||
def __call__(self, parser, namespace, values, option_string=None):
|
||||
setattr(namespace, self.dest, values.split(','))
|
||||
|
||||
|
||||
def add_tag_filtering_option_to_parser(parser, resource_name):
|
||||
"""Add tag filtering options to a parser.
|
||||
|
||||
:param parser: argparse.Argument parser object.
|
||||
:param resource_name: Description of the object being filtered.
|
||||
"""
|
||||
parser.add_argument(
|
||||
'--tags',
|
||||
metavar='<tag>[,<tag>,...]',
|
||||
action=_CommaListAction,
|
||||
help=_('List %s which have all given tag(s) '
|
||||
'(Comma-separated list of tags)') % resource_name
|
||||
)
|
||||
parser.add_argument(
|
||||
'--any-tags',
|
||||
metavar='<tag>[,<tag>,...]',
|
||||
action=_CommaListAction,
|
||||
help=_('List %s which have any given tag(s) '
|
||||
'(Comma-separated list of tags)') % resource_name
|
||||
)
|
||||
parser.add_argument(
|
||||
'--not-tags',
|
||||
metavar='<tag>[,<tag>,...]',
|
||||
action=_CommaListAction,
|
||||
help=_('Exclude %s which have all given tag(s) '
|
||||
'(Comma-separated list of tags)') % resource_name
|
||||
)
|
||||
parser.add_argument(
|
||||
'--not-any-tags',
|
||||
metavar='<tag>[,<tag>,...]',
|
||||
action=_CommaListAction,
|
||||
help=_('Exclude %s which have any given tag(s) '
|
||||
'(Comma-separated list of tags)') % resource_name
|
||||
)
|
||||
|
||||
|
||||
def get_tag_filtering_args(parsed_args, args):
|
||||
"""Adds the tag arguments to an args list.
|
||||
|
||||
Intended to be used to append the tags to an argument list that will be
|
||||
used for service client.
|
||||
|
||||
:param parsed_args: Parsed argument object returned by argparse parse_args.
|
||||
:param args: The argument list to add tags to.
|
||||
"""
|
||||
if parsed_args.tags:
|
||||
args['tags'] = ','.join(parsed_args.tags)
|
||||
if parsed_args.any_tags:
|
||||
args['any_tags'] = ','.join(parsed_args.any_tags)
|
||||
if parsed_args.not_tags:
|
||||
args['not_tags'] = ','.join(parsed_args.not_tags)
|
||||
if parsed_args.not_any_tags:
|
||||
args['not_any_tags'] = ','.join(parsed_args.not_any_tags)
|
||||
|
||||
|
||||
def add_tag_option_to_parser_for_create(parser, resource_name):
|
||||
"""Add tag options to a parser for create commands.
|
||||
|
||||
:param parser: argparse.Argument parser object.
|
||||
:param resource_name: Description of the object being filtered.
|
||||
"""
|
||||
tag_group = parser.add_mutually_exclusive_group()
|
||||
tag_group.add_argument(
|
||||
'--tag',
|
||||
action='append',
|
||||
dest='tags',
|
||||
metavar='<tag>',
|
||||
help=_("Tag to be added to the %s "
|
||||
"(repeat option to set multiple tags)") % resource_name
|
||||
)
|
||||
tag_group.add_argument(
|
||||
'--no-tag',
|
||||
action='store_true',
|
||||
help=_("No tags associated with the %s") % resource_name
|
||||
)
|
||||
|
||||
|
||||
def add_tag_option_to_parser_for_set(parser, resource_name):
|
||||
"""Add tag options to a parser for set commands.
|
||||
|
||||
:param parser: argparse.Argument parser object.
|
||||
:param resource_name: Description of the object being filtered.
|
||||
"""
|
||||
parser.add_argument(
|
||||
'--tag',
|
||||
action='append',
|
||||
dest='tags',
|
||||
metavar='<tag>',
|
||||
help=_("Tag to be added to the %s "
|
||||
"(repeat option to set multiple tags)") % resource_name
|
||||
)
|
||||
parser.add_argument(
|
||||
'--no-tag',
|
||||
action='store_true',
|
||||
help=_("Clear tags associated with the %s. Specify both "
|
||||
"--tag and --no-tag to overwrite current tags") % resource_name
|
||||
)
|
||||
|
||||
|
||||
def add_tag_option_to_parser_for_unset(parser, resource_name):
|
||||
"""Add tag options to a parser for set commands.
|
||||
|
||||
:param parser: argparse.Argument parser object.
|
||||
:param resource_name: Description of the object being filtered.
|
||||
"""
|
||||
tag_group = parser.add_mutually_exclusive_group()
|
||||
tag_group.add_argument(
|
||||
'--tag',
|
||||
action='append',
|
||||
dest='tags',
|
||||
metavar='<tag>',
|
||||
help=_("Tag to be removed from the %s "
|
||||
"(repeat option to remove multiple tags)") % resource_name)
|
||||
tag_group.add_argument(
|
||||
'--all-tag',
|
||||
action='store_true',
|
||||
help=_("Clear all tags associated with the %s") % resource_name)
|
||||
|
||||
|
||||
def update_tags_for_set(client, obj, parsed_args):
|
||||
"""Set the tags on an object.
|
||||
|
||||
:param client: The service client to use setting the tags.
|
||||
:param obj: The object (Resource) to set the tags on.
|
||||
:param parsed_args: Parsed argument object returned by argparse parse_args.
|
||||
"""
|
||||
if parsed_args.no_tag:
|
||||
tags = set()
|
||||
else:
|
||||
tags = set(obj.tags or [])
|
||||
if parsed_args.tags:
|
||||
tags |= set(parsed_args.tags)
|
||||
if set(obj.tags or []) != tags:
|
||||
client.set_tags(obj, sorted(list(tags)))
|
||||
|
||||
|
||||
def update_tags_for_unset(client, obj, parsed_args):
|
||||
"""Unset the tags on an object.
|
||||
|
||||
:param client: The service client to use unsetting the tags.
|
||||
:param obj: The object (Resource) to unset the tags on.
|
||||
:param parsed_args: Parsed argument object returned by argparse parse_args.
|
||||
"""
|
||||
tags = set(obj.tags)
|
||||
if parsed_args.all_tag:
|
||||
tags = set()
|
||||
if parsed_args.tags:
|
||||
tags -= set(parsed_args.tags)
|
||||
if set(obj.tags) != tags:
|
||||
client.set_tags(obj, sorted(list(tags)))
|
||||
Loading…
Reference in New Issue