def test_mutually_exclusive_dest(self):
"""Mutually exclusive group name derived from 'dest'."""
opts = [
# if *any* arg in the same mutually_exclusive group says
# required=True, then at least one value in that mutex group
# will be required
config.Option('--more',
mutually_exclusive=True,
dest='more',
action='store_true'),
config.Option('--less',
mutually_exclusive=True,
dest='more',
action='store_false'),
]
myconf = config.Config(options=opts)
argv = ['program']
# testing that this raises no error
myconf.parse(argv=argv)
argv = ['program', '--more']
myconf.parse(argv=argv)
self.assertEqual(myconf.more, True)
argv = ['program', '--less']
myconf.parse(argv=argv)
self.assertEqual(myconf.more, False)
def test_mutually_exclusive_fails_excess(self, mock_stderr):
opts = [
config.Option('--foo'),
# if *any* arg in the same mutually_exclusive group says
# required=True, then at least one value in that mutex group
# will be required
config.Option('--more',
mutually_exclusive=True,
dest='more',
action='store_true'),
config.Option('--less',
mutually_exclusive=True,
dest='more',
action='store_false',
required=True),
]
myconf = config.Config(options=opts)
argv = ['program', '--more', '--less']
with self.assertRaises(SystemExit):
try:
myconf.parse(argv=argv) # fails b/c mutual exclusion collision
except SystemExit:
errmsg = ('error: argument --less: '
'not allowed with argument --more')
args, _ = mock_stderr.write.call_args
self.assertIn(errmsg, args[0])
raise
def test_mutual_exclusion(self, mock_stderr):
opts = [
config.Option('--foo'),
config.Option('--key', group='secret', mutually_exclusive=True),
config.Option('--key-file',
group='secret',
dest='key',
mutually_exclusive=True,
type=config.read_from),
config.Option('--key-thing', group='secret'),
]
# for read_from
keystring = 'this-is-a-private-key'
strfile = self.get_tempfile()
strfile.write(('%s-written-to-file' % keystring).encode('utf-8'))
strfile.flush()
myconf = config.Config(options=opts)
argv = ['program', '--key-file', strfile.name, '--key', keystring]
with self.assertRaises(SystemExit):
try:
myconf.parse(argv=argv) # fails b/c mutual exclusion collision
except SystemExit:
errmsg = ('error: argument --key: '
'not allowed with argument --key-file')
args, _ = mock_stderr.write.call_args
self.assertIn(errmsg, args[0])
raise
def test_metaconfig_ini_nooption_raises(self):
"""Test that ini options with no matches raises an error."""
metaconf = textwrap.dedent("""
[default]
ham = glam
grand = slam
notanoption = toobad
[program]
spam = rico
grand = notpreferred
""")
opts = [
config.Option('--ham', ini_section='default'),
config.Option('--grand', ini_section='default'),
config.Option('--spam'),
]
strfile = self.get_tempfile()
strfile.write(metaconf.encode('utf-8'))
strfile.flush()
argv = ['program', '--ini', strfile.name]
myconf = config.Config(options=opts, argv=argv, prog='program')
expected_error = simpl_exceptions.SimplConfigUnknownOption
expected_message = ("No corresponding Option was found for the "
"following values in the ini file: 'notanoption'")
with self.assertRaises(expected_error) as err:
myconf.parse()
self.assertIn(expected_message, str(err.exception))
def test_copies(self):
cfg = config.Config(options=[
config.Option('--one', default=1),
config.Option('--a', default='a'),
config.Option('--none'),
])
another = copy.copy(cfg)
self.assertEqual(cfg, another)
def test_required(self):
self.assertEqual(os.environ['TEST_TWO'], '2')
cfg = config.Config(options=[
config.Option('--one', default=1, required=True),
config.Option('--two', required=True, env='TEST_TWO'),
])
cfg.parse([])
self.assertEqual(cfg.one, 1)
self.assertEqual(cfg.two, '2')
def test_items(self):
cfg = config.Config(options=[
config.Option('--one', default=1),
config.Option('--none'),
])
cfg.parse([])
self.assertEqual(cfg.one, cfg['one'])
self.assertEqual(cfg['one'], 1)
self.assertIsNone(cfg['none'])
def test_defaults(self):
cfg = config.Config(options=[
config.Option('--one', default=1),
config.Option('--a', default='a'),
config.Option('--none'),
])
cfg.parse([])
self.assertEqual(cfg.one, 1)
self.assertEqual(cfg.a, 'a')
self.assertIsNone(cfg.none)
def test_metaconfig_ini_nofile_raises(self):
"""Test that ini options with no matches raises an error."""
opts = [
config.Option('--ham', ini_section='default'),
config.Option('--grand', ini_section='default'),
config.Option('--spam'),
]
nofile = '/i/dont/exist'
argv = ['program', '--ini', nofile]
myconf = config.Config(options=opts, argv=argv, prog='program')
expected_message = "No such file or directory: '%s'" % nofile
with self.assertRaises(OSError) as err:
myconf.parse()
self.assertEqual(errno.ENOENT, err.exception.errno)
self.assertIn(expected_message, str(err.exception))
def test_default_help_formatter(self, mock_stdout):
"""Default Help Formatter Still Works."""
OPTS = [
config.Option(
'--host',
help='Server address.',
default='127.0.0.1',
)
]
self.maxDiff = None
conf = config.Config(
options=OPTS,
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
prog='test')
try:
conf.parse(argv=['test.py', '-h'])
except SystemExit:
pass
expected = textwrap.dedent("""\
usage: test [-h] [--ini PATH] [--host HOST]
optional arguments:
-h, --help show this help message and exit
--host HOST Server address. (default: 127.0.0.1)
initialization (metaconfig) arguments:
evaluated first and can be used to source an entire config
--ini PATH Source some or all of the options from this ini file.
""")
self.assertEqual(mock_stdout.getvalue(), expected)
def setUp(self):
self.opts = [
config.Option(
'--foo',
required=True,
default='bar',
),
config.Option(
'--blarg',
required=True,
default='baz',
),
]
self.conf = config.init(
options=self.opts,
prog='hello_prog',
)
def setUp(self):
self.opts = [
config.Option(
'-r',
'--required',
required=True,
default='req',
env='REQUIRED',
),
config.Option(
'--bool',
action='store_true',
),
]
self.conf = config.Config(
options=self.opts,
prog='test',
)
def test_mutex_no_group_for_option_fail(self):
opts = [
config.Option('--ihavenogroup',
mutually_exclusive=True,
action='store_true'),
]
# mutual exclusion requires a group which is derived from
# 'group' or 'dest'
myconf = config.Config(options=opts)
with self.assertRaises(config.NoGroupForOption):
myconf.build_parser(opts)
def setUp(self):
self.opts = [
config.Option(
'--foo',
required=True,
default='bar',
env='FOO',
),
config.Option(
'--blarg',
required=True,
default='baz',
env='BLARG',
),
]
self.conf = config.Config(
options=self.opts,
prog='test',
)
def test_mutex_with_special_type(self, mock_stderr):
opts = [
config.Option('--foo'),
config.Option('--key', group='secret', mutually_exclusive=True),
config.Option('--key-file',
group='secret',
dest='key',
mutually_exclusive=True,
type=config.read_from),
config.Option('--key-thing', group='secret'),
config.Option('--more',
mutually_exclusive=True,
dest='more',
action='store_true'), # should be ok
config.Option('--less',
mutually_exclusive=True,
dest='more',
action='store_false'),
]
# for read_from
keystring = 'this-is-a-private-key'
strfile = self.get_tempfile()
strfile.write(('%s-written-to-file' % keystring).encode('utf-8'))
strfile.flush()
myconf = config.Config(options=opts)
argv = ['program', '--key', keystring]
myconf.parse(argv=argv)
self.assertEqual(myconf.key, keystring)
argv = ['program', '--key-file', strfile.name]
myconf.parse(argv=argv)
self.assertEqual(myconf.key, '%s-written-to-file' % keystring)
def test_metaconfig_ini(self):
metaconf = textwrap.dedent("""
[default]
ham = glam
grand = slam
[program]
spam = rico
grand = notpreferred
""")
opts = [
config.Option('--ham', ini_section='default'),
config.Option('--grand', ini_section='default'),
config.Option('--spam'),
]
strfile = self.get_tempfile()
strfile.write(metaconf.encode('utf-8'))
strfile.flush()
argv = ['program', '--ini', strfile.name]
myconf = config.Config(options=opts, argv=argv, prog='program')
myconf.parse()
self.assertEqual(myconf.grand, 'slam')
self.assertEqual(myconf.ham, 'glam')
self.assertEqual(myconf.spam, 'rico')
def test_argparser_groups(self):
opts = [
config.Option('--baz'),
config.Option('--password', group='secret'),
config.Option('--key', group='secret'),
config.Option('--this', group='things'),
config.Option('--that', group='things'),
config.Option('--other', group='things'),
config.Option('--who', group='group of its own'),
]
myconf = config.Config(options=opts)
parser = myconf.build_parser(opts)
secret_group = None
things_group = None
own_group = None
for grp in parser._action_groups:
if grp.title == 'secret':
secret_group = grp
elif grp.title == 'things':
things_group = grp
elif grp.title == 'group of its own':
own_group = grp
self.assertTrue(secret_group)
self.assertTrue(things_group)
self.assertTrue(own_group)
self.assertEqual(len(secret_group._group_actions), 2)
option_strings = [
i for k in secret_group._group_actions for i in k.option_strings
]
self.assertIn('--password', option_strings)
self.assertIn('--key', option_strings)
self.assertEqual(len(things_group._group_actions), 3)
option_strings = [
i for k in things_group._group_actions for i in k.option_strings
]
self.assertIn('--this', option_strings)
self.assertIn('--that', option_strings)
self.assertIn('--other', option_strings)
self.assertEqual(len(own_group._group_actions), 1)
option_strings = [
i for k in own_group._group_actions for i in k.option_strings
]
self.assertIn('--who', option_strings)
def test_group_help_usage_output(self):
opts = [
config.Option('--baz'),
config.Option('--password', group='secret'),
config.Option('--key',
group='secret',
group_description='haha security'),
config.Option('--this', group='things'),
config.Option('--that',
group='things',
group_description='define me once'),
config.Option('--other', group='things'),
config.Option('--who', group='group of its own'),
]
myconf = config.Config(options=opts)
parser = myconf.build_parser(opts)
helplines = [k.strip() for k in parser.format_help().splitlines()]
self.assertIn('secret:', helplines)
self.assertIn('haha security', helplines)
self.assertIn('things:', helplines)
self.assertIn('define me once', helplines)
self.assertIn('group of its own:', helplines)
def test_strict(self):
cfg = config.Config(options=[
config.Option('--one', default=1),
])
with self.assertRaises(SystemExit):
cfg.parse(['prog', '--foo'], strict=True)
def test_not_strict(self):
cfg = config.Config(options=[
config.Option('--one', default=1),
])
cfg.parse(['prog', '--foo'], strict=False)
def test_pass_thru(self):
cfg = config.Config(options=[
config.Option('--one', default=1),
])
cfg.parse(['prog', '--one=1', '--', '--pt'], strict=True)
self.assertEqual(cfg.pass_thru_args, ['--pt'])
def test_required_negative(self):
cfg = config.Config(options=[
config.Option('--required', required=True),
])
with self.assertRaises(SystemExit):
cfg.parse([])
LOG = log.getLogger(__name__)
"""
import logging
import os
import sys
from simpl import config
OPTIONS = [
#
# Verbosity, debugging, and monitoring
#
config.Option("--logconfig", help="Optional logging configuration file"),
config.Option("-d",
"--debug",
default=False,
action="store_true",
help="turn on additional debugging inspection and "
"output including full HTTP requests and responses. "
"Log output includes source file path and line "
"numbers"),
config.Option("-v",
"--verbose",
default=False,
action="store_true",
help="turn up logging to DEBUG (default is INFO)"),
config.Option("-q",
"--quiet",
from simpl import config
from simpl.utils import cli as cli_utils
LOG = logging.getLogger(__name__)
def _fill(text):
"""Make a pretty text block."""
return textwrap.fill(text, 50)
OPTIONS = [
config.Option(
'--app', '-a',
help=("WSGI application to load by name.\n"
"Ex: package.module gets the module\n"
" package.module:name gets the variable 'name'\n"
" package.module.func() calls func() and gets the result"),
group='Server Options',
),
config.Option(
'--host',
help='Server address to bind to.',
default='127.0.0.1',
group='Server Options',
),
config.Option(
'--port', '-p',
help='Server port to bind to.',
type=int,
default=8080,
group='Server Options',
LOG = log.getLogger(__name__)
"""
import logging
import os
import sys
from simpl import config
OPTIONS = [
#
# Verbosity, debugging, and monitoring
#
config.Option("--logconfig", help="Optional logging configuration file"),
config.OPTIONS['debug'],
config.OPTIONS['quiet'],
config.Option("-v",
"--verbose",
default=False,
action="store_true",
help="turn up logging to DEBUG (default is INFO)"),
]
getLogger = logging.getLogger # pylint: disable=C0103
def log_level(conf):
"""Get debug settings from arguments.