openstack/oslo.config
Code Issues Proposed changes

Unit tests to illustrate positional argument bug

Browse Source 
This patch does not provide a fix, but instead serves to illustrate
several use cases where positional arguments do not behave correctly on
the CLI.

Change-Id: Ibdb05066b95a285f6618c861eb4d38465dbf0d02
Related-Bug: 1676989
This commit is contained in:
Dolph Mathews 2017-03-28 19:48:48 +00:00 committed by Stephen Finucane
parent 7625e9531c
commit b5f76a2ce8
1 changed files with 111 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

112
oslo_config/tests/test_cfg.py
View File

@ -893,15 +893,125 @@ class PositionalTestCase(BaseTestCase):
def test_positional_bool(self):
self.assertRaises(ValueError, cfg.BoolOpt, 'foo', positional=True)
def test_required_positional_opt(self):
def test_required_positional_opt_defined(self):
self.conf.register_cli_opt(
cfg.StrOpt('foo', required=True, positional=True))
self.useFixture(fixtures.MonkeyPatch('sys.stdout', moves.StringIO()))
self.assertRaises(SystemExit, self.conf, ['--help'])
self.assertIn(' foo\n', sys.stdout.getvalue())
self.conf(['bar'])
self.assertTrue(hasattr(self.conf, 'foo'))
self.assertEqual('bar', self.conf.foo)
def test_required_positional_opt_undefined(self):
self.conf.register_cli_opt(
cfg.StrOpt('foo', required=True, positional=True))
self.useFixture(fixtures.MonkeyPatch('sys.stdout', moves.StringIO()))
self.assertRaises(SystemExit, self.conf, ['--help'])
self.assertIn(' foo\n', sys.stdout.getvalue())
self.assertRaises(cfg.RequiredOptError, self.conf, [])
def test_optional_positional_opt_defined(self):
self.conf.register_cli_opt(
cfg.StrOpt('foo', required=False, positional=True))
self.useFixture(fixtures.MonkeyPatch('sys.stdout', moves.StringIO()))
self.assertRaises(SystemExit, self.conf, ['--help'])
# FIXME(dolphm): Due to bug 1676989, this argument appears as a
# required argument in the CLI help. Instead, the following
# commented-out code should work:
# self.assertIn(' [foo]\n', sys.stdout.getvalue())
self.assertIn(' foo\n', sys.stdout.getvalue())
self.conf(['bar'])
self.assertTrue(hasattr(self.conf, 'foo'))
self.assertEqual('bar', self.conf.foo)
def test_optional_positional_opt_undefined(self):
self.conf.register_cli_opt(
cfg.StrOpt('foo', required=False, positional=True))
self.useFixture(fixtures.MonkeyPatch('sys.stdout', moves.StringIO()))
self.assertRaises(SystemExit, self.conf, ['--help'])
# FIXME(dolphm): Due to bug 1676989, this argument appears as a
# required argument in the CLI help. Instead, the following
# commented-out code should work:
# self.assertIn(' [foo]\n', sys.stdout.getvalue())
self.assertIn(' foo\n', sys.stdout.getvalue())
self.conf([])
self.assertTrue(hasattr(self.conf, 'foo'))
self.assertIsNone(self.conf.foo)
def test_optional_positional_hyphenated_opt_defined(self):
self.conf.register_cli_opt(
cfg.StrOpt('foo-bar', required=False, positional=True))
self.useFixture(fixtures.MonkeyPatch('sys.stdout', moves.StringIO()))
self.assertRaises(SystemExit, self.conf, ['--help'])
# FIXME(dolphm): Due to bug 1676989, this argument appears as a
# required argument in the CLI help. Instead, the following
# commented-out code should work:
# self.assertIn(' [foo-bar]\n', sys.stdout.getvalue())
self.assertIn(' foo-bar\n', sys.stdout.getvalue())
self.conf(['baz'])
self.assertTrue(hasattr(self.conf, 'foo_bar'))
# FIXME(dolphm): Due to bug 1676989, this argument cannot be retrieved
# by oslo_config.cfg. Instead, the following commented-out code should
# work:
# self.assertEqual('baz', self.conf.foo_bar)
self.assertIsNone(self.conf.foo_bar)
def test_optional_positional_hyphenated_opt_undefined(self):
self.conf.register_cli_opt(
cfg.StrOpt('foo-bar', required=False, positional=True))
self.useFixture(fixtures.MonkeyPatch('sys.stdout', moves.StringIO()))
self.assertRaises(SystemExit, self.conf, ['--help'])
# FIXME(dolphm): Due to bug 1676989, this argument appears as a
# required argument in the CLI help. Instead, the following
# commented-out code should work:
# self.assertIn(' [foo-bar]\n', sys.stdout.getvalue())
self.assertIn(' foo-bar\n', sys.stdout.getvalue())
self.conf([])
self.assertTrue(hasattr(self.conf, 'foo_bar'))
self.assertIsNone(self.conf.foo_bar)
def test_required_positional_hyphenated_opt_defined(self):
self.conf.register_cli_opt(
cfg.StrOpt('foo-bar', required=True, positional=True))
self.useFixture(fixtures.MonkeyPatch('sys.stdout', moves.StringIO()))
self.assertRaises(SystemExit, self.conf, ['--help'])
self.assertIn(' foo-bar\n', sys.stdout.getvalue())
# FIXME(dolphm): Due to bug 1676989, this mistakenly raises an
# exception, even though the option is clearly defined. Instead, the
# following commented out lines should work:
# self.conf(['baz'])
# self.assertTrue(hasattr(self.conf, 'foo_bar'))
# self.assertEqual('baz', self.conf.foo_bar)
self.assertRaises(cfg.RequiredOptError, self.conf, ['baz'])
def test_required_positional_hyphenated_opt_undefined(self):
self.conf.register_cli_opt(
cfg.StrOpt('foo-bar', required=True, positional=True))
self.useFixture(fixtures.MonkeyPatch('sys.stdout', moves.StringIO()))
self.assertRaises(SystemExit, self.conf, ['--help'])
self.assertIn(' foo-bar\n', sys.stdout.getvalue())
self.assertRaises(cfg.RequiredOptError, self.conf, [])
def test_missing_required_cli_opt(self):
self.conf.register_cli_opt(
cfg.StrOpt('foo', required=True, positional=True))