# Copyright 2012-2013 OpenStack Foundation # # 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.cli import parseractions from osc_lib.test import base class TestKeyValueAction(base.TestCase): def setUp(self): super().setUp() self.parser = argparse.ArgumentParser() # Set up our typical usage self.parser.add_argument( '--property', metavar='', action=parseractions.KeyValueAction, default={'green': '20%', 'format': '#rgb'}, help='Property to store for this volume ' '(repeat option to set multiple properties)', ) def test_good_values(self): results = self.parser.parse_args( [ '--property', 'red=', '--property', 'green=100%', '--property', 'blue=50%', ] ) actual = getattr(results, 'property', {}) # All should pass through unmolested expect = {'red': '', 'green': '100%', 'blue': '50%', 'format': '#rgb'} self.assertEqual(expect, actual) def test_error_values(self): data_list = [ [ '--property', 'red', ], [ '--property', '=', ], [ '--property', '=red', ], ] for data in data_list: self.assertRaises(SystemExit, self.parser.parse_args, data) class TestKeyValueAppendAction(base.TestCase): def setUp(self): super().setUp() self.parser = argparse.ArgumentParser() # Set up our typical usage self.parser.add_argument( '--hint', metavar='', action=parseractions.KeyValueAppendAction, help='Arbitrary key/value pairs to be sent to the scheduler for ' 'custom use', ) def test_good_values(self): print(self.parser._get_optional_actions()) results = self.parser.parse_args( [ '--hint', 'same_host=a0cf03a5-d921-4877-bb5c-86d26cf818e1', '--hint', 'same_host=8c19174f-4220-44f0-824a-cd1eeef10287', '--hint', 'query=[>=,$free_ram_mb,1024]', ] ) actual = getattr(results, 'hint', {}) expect = { 'same_host': [ 'a0cf03a5-d921-4877-bb5c-86d26cf818e1', '8c19174f-4220-44f0-824a-cd1eeef10287', ], 'query': [ '[>=,$free_ram_mb,1024]', ], } self.assertEqual(expect, actual) def test_error_values(self): data_list = [ [ '--hint', 'red', ], [ '--hint', '=', ], [ '--hint', '=red', ], ] for data in data_list: self.assertRaises(SystemExit, self.parser.parse_args, data) class TestMultiKeyValueAction(base.TestCase): def setUp(self): super().setUp() self.parser = argparse.ArgumentParser() # Set up our typical usage self.parser.add_argument( '--test', metavar='req1=xxx,req2=yyy', action=parseractions.MultiKeyValueAction, dest='test', default=None, required_keys=['req1', 'req2'], optional_keys=['opt1', 'opt2'], help='Test', ) def test_good_values(self): results = self.parser.parse_args( [ '--test', 'req1=aaa,req2=bbb', '--test', 'req1=,req2=', ] ) actual = getattr(results, 'test', []) expect = [ {'req1': 'aaa', 'req2': 'bbb'}, {'req1': '', 'req2': ''}, ] self.assertCountEqual(expect, actual) def test_empty_required_optional(self): self.parser.add_argument( '--test-empty', metavar='req1=xxx,req2=yyy', action=parseractions.MultiKeyValueAction, dest='test_empty', default=None, required_keys=[], optional_keys=[], help='Test', ) results = self.parser.parse_args( [ '--test-empty', 'req1=aaa,req2=bbb', '--test-empty', 'req1=,req2=', ] ) actual = getattr(results, 'test_empty', []) expect = [ {'req1': 'aaa', 'req2': 'bbb'}, {'req1': '', 'req2': ''}, ] self.assertCountEqual(expect, actual) def test_error_values_with_comma(self): data_list = [ [ '--test', 'mmm,nnn=zzz', ], [ '--test', 'nnn=zzz,=', ], [ '--test', 'nnn=zzz,=zzz', ], ] for data in data_list: self.assertRaises(SystemExit, self.parser.parse_args, data) def test_error_values_without_comma(self): self.assertRaises( SystemExit, self.parser.parse_args, [ '--test', 'mmmnnn', ], ) def test_missing_key(self): self.assertRaises( SystemExit, self.parser.parse_args, [ '--test', 'req2=ddd', ], ) def test_invalid_key(self): self.assertRaises( SystemExit, self.parser.parse_args, [ '--test', 'req1=aaa,req2=bbb,aaa=req1', ], ) def test_required_keys_not_list(self): self.assertRaises( TypeError, self.parser.add_argument, '--test-required-dict', metavar='req1=xxx,req2=yyy', action=parseractions.MultiKeyValueAction, dest='test_required_dict', default=None, required_keys={'aaa': 'bbb'}, optional_keys=['opt1', 'opt2'], help='Test', ) def test_optional_keys_not_list(self): self.assertRaises( TypeError, self.parser.add_argument, '--test-optional-dict', metavar='req1=xxx,req2=yyy', action=parseractions.MultiKeyValueAction, dest='test_optional_dict', default=None, required_keys=['req1', 'req2'], optional_keys={'aaa': 'bbb'}, help='Test', ) class TestMultiKeyValueCommaAction(base.TestCase): def setUp(self): super().setUp() self.parser = argparse.ArgumentParser() # Typical usage self.parser.add_argument( '--test', metavar='req1=xxx,yyy', action=parseractions.MultiKeyValueCommaAction, dest='test', default=None, required_keys=['req1'], optional_keys=['opt2'], help='Test', ) def test_mkvca_required(self): results = self.parser.parse_args( [ '--test', 'req1=aaa,bbb', ] ) actual = getattr(results, 'test', []) expect = [ {'req1': 'aaa,bbb'}, ] self.assertCountEqual(expect, actual) results = self.parser.parse_args( [ '--test', 'req1=', ] ) actual = getattr(results, 'test', []) expect = [ {'req1': ''}, ] self.assertCountEqual(expect, actual) results = self.parser.parse_args( [ '--test', 'req1=aaa,bbb', '--test', 'req1=', ] ) actual = getattr(results, 'test', []) expect = [ {'req1': 'aaa,bbb'}, {'req1': ''}, ] self.assertCountEqual(expect, actual) def test_mkvca_optional(self): results = self.parser.parse_args( [ '--test', 'req1=aaa,bbb', ] ) actual = getattr(results, 'test', []) expect = [ {'req1': 'aaa,bbb'}, ] self.assertCountEqual(expect, actual) results = self.parser.parse_args( [ '--test', 'req1=aaa,bbb', '--test', 'req1=,opt2=ccc', ] ) actual = getattr(results, 'test', []) expect = [ {'req1': 'aaa,bbb'}, {'req1': '', 'opt2': 'ccc'}, ] self.assertCountEqual(expect, actual) self.assertRaises( SystemExit, self.parser.parse_args, [ '--test', 'req1=aaa,bbb', '--test', 'opt2=ccc', ], ) def test_mkvca_multiples(self): results = self.parser.parse_args( [ '--test', 'req1=aaa,bbb,opt2=ccc', ] ) actual = getattr(results, 'test', []) expect = [ { 'req1': 'aaa,bbb', 'opt2': 'ccc', } ] self.assertCountEqual(expect, actual) def test_mkvca_no_required_optional(self): self.parser.add_argument( '--test-empty', metavar='req1=xxx,yyy', action=parseractions.MultiKeyValueCommaAction, dest='test_empty', default=None, required_keys=[], optional_keys=[], help='Test', ) results = self.parser.parse_args( [ '--test-empty', 'req1=aaa,bbb', ] ) actual = getattr(results, 'test_empty', []) expect = [ {'req1': 'aaa,bbb'}, ] self.assertCountEqual(expect, actual) results = self.parser.parse_args( [ '--test-empty', 'xyz=aaa,bbb', ] ) actual = getattr(results, 'test_empty', []) expect = [ {'xyz': 'aaa,bbb'}, ] self.assertCountEqual(expect, actual) def test_mkvca_invalid_key(self): self.assertRaises( SystemExit, self.parser.parse_args, ['--test', 'req1=aaa,bbb='], ) self.assertRaises( SystemExit, self.parser.parse_args, ['--test', 'nnn=aaa'], ) def test_mkvca_value_no_key(self): self.assertRaises( SystemExit, self.parser.parse_args, ['--test', 'req1=aaa,=bbb'], ) self.assertRaises( SystemExit, self.parser.parse_args, ['--test', '=nnn'], ) self.assertRaises( SystemExit, self.parser.parse_args, ['--test', 'nnn'], ) def test_mkvca_required_keys_not_list(self): self.assertRaises( TypeError, self.parser.add_argument, '--test-required-dict', metavar='req1=xxx', action=parseractions.MultiKeyValueCommaAction, dest='test_required_dict', default=None, required_keys={'aaa': 'bbb'}, optional_keys=['opt1', 'opt2'], help='Test', ) def test_mkvca_optional_keys_not_list(self): self.assertRaises( TypeError, self.parser.add_argument, '--test-optional-dict', metavar='req1=xxx', action=parseractions.MultiKeyValueCommaAction, dest='test_optional_dict', default=None, required_keys=['req1', 'req2'], optional_keys={'aaa': 'bbb'}, help='Test', ) class TestNonNegativeAction(base.TestCase): def setUp(self): super().setUp() self.parser = argparse.ArgumentParser() # Set up our typical usage self.parser.add_argument( '--foo', metavar='', type=int, action=parseractions.NonNegativeAction, ) def test_negative_values(self): self.assertRaises( SystemExit, self.parser.parse_args, "--foo -1".split(), ) def test_zero_values(self): results = self.parser.parse_args('--foo 0'.split()) actual = getattr(results, 'foo', None) self.assertEqual(actual, 0) def test_positive_values(self): results = self.parser.parse_args('--foo 1'.split()) actual = getattr(results, 'foo', None) self.assertEqual(actual, 1)