def test_config_path():
# use config path
config_path = '/some/path'.replace('/', os.sep)
with patch('colcon_core.location.logger.info') as info:
set_default_config_path(path=config_path)
info.assert_called_once_with(
"Using config path '{config_path}'".format_map(locals()))
# use config path if environment variable is not set
config_path_env_var = 'TEST_COLCON_CONFIG_PATH'
with patch('colcon_core.location.logger.info') as info:
set_default_config_path(path=config_path, env_var=config_path_env_var)
info.assert_called_once_with(
"Using config path '{config_path}'".format_map(locals()))
# use environment variable when set
config_path = '/other/path'.replace('/', os.sep)
with EnvironmentContext(**{config_path_env_var: config_path}):
assert isinstance(get_config_path(), Path)
assert str(get_config_path()) == config_path
def _main(*, command_name, argv):
global colcon_logger
# default log level
colcon_logger.setLevel(logging.WARNING)
set_logger_level_from_env(
colcon_logger, '{command_name}_LOG_LEVEL'.format_map(locals()).upper())
colcon_logger.debug(
'Command line arguments: {argv}'
.format(argv=argv if argv is not None else sys.argv))
# set default locations for config files
set_default_config_path(
path=(
Path('~') / '.{command_name}'.format_map(locals())).expanduser(),
env_var='{command_name}_HOME'.format_map(locals()).upper())
parser = create_parser('colcon_core.environment_variable')
verb_extensions = get_verb_extensions()
# add subparsers for all verb extensions but without arguments for now
subparser = create_subparser(
parser, command_name, verb_extensions, attribute='verb_name')
verb_parsers = add_parsers_without_arguments(
parser, subparser, verb_extensions, attribute='verb_name')
with SuppressUsageOutput([parser] + list(verb_parsers.values())):
known_args, _ = parser.parse_known_args(args=argv)
# add the arguments for the requested verb
if known_args.verb_name:
add_parser_arguments(known_args.verb_parser, known_args.verb_extension)
args = parser.parse_args(args=argv)
context = CommandContext(command_name=command_name, args=args)
if args.log_level:
colcon_logger.setLevel(args.log_level)
colcon_logger.debug(
'Parsed command line arguments: {args}'.format_map(locals()))
# error: no verb provided
if args.verb_name is None:
print(parser.format_usage())
return 'Error: No verb provided'
# set default locations for log files
now = datetime.datetime.now()
now_str = str(now)[:-7].replace(' ', '_').replace(':', '-')
set_default_log_path(
base_path=args.log_base,
env_var='{command_name}_LOG_PATH'.format_map(locals()).upper(),
subdirectory='{args.verb_name}_{now_str}'.format_map(locals()))
# add a file handler writing all levels if logging isn't disabled
log_path = get_log_path()
if log_path is not None:
create_log_path(args.verb_name)
handler = add_file_handler(
colcon_logger, log_path / 'logger_all.log')
# write previous log messages to the file handler
log_record = colcon_logger.makeRecord(
colcon_logger.name, logging.DEBUG, __file__, 0,
'Command line arguments: {argv}'
.format(argv=argv if argv is not None else sys.argv),
None, None)
handler.handle(log_record)
log_record = colcon_logger.makeRecord(
colcon_logger.name, logging.DEBUG, __file__, 0,
'Parsed command line arguments: {args}'.format_map(locals()),
None, None)
handler.handle(log_record)
# invoke verb
return verb_main(context, colcon_logger)
def main(*, command_name='colcon', argv=None):
"""
Execute the main logic of the command.
The overview of the process:
* Configure logging level based on an environment variable
* Configure the configuration path
* Create the argument parser
* Document all environment variables
* Decorate the parsers with additional functionality
* Add the available verbs and their arguments
* Configure logging level based on an arguments
* Create an invocation specific log directory
* Invoke the logic of the selected verb (if applicable)
:param str command_name: The name of the command invoked
:param list argv: The list of arguments
:returns: The return code
"""
global colcon_logger
# default log level
colcon_logger.setLevel(logging.WARN)
set_logger_level_from_env(
colcon_logger, '{command_name}_LOG_LEVEL'.format_map(locals()).upper())
colcon_logger.debug('Command line arguments: {argv}'.format(
argv=argv if argv is not None else sys.argv))
# set default locations for config files
set_default_config_path(
path=(Path('~') / '.{command_name}'.format_map(locals())).expanduser(),
env_var='{command_name}_HOME'.format_map(locals()).upper())
parser = create_parser('colcon_core.environment_variable')
verb_extensions = get_verb_extensions()
# add subparsers for all verb extensions but without arguments for now
subparser = create_subparser(parser,
command_name,
verb_extensions,
attribute='verb_name')
verb_parsers = add_parsers_without_arguments(parser,
subparser,
verb_extensions,
attribute='verb_name')
with SuppressUsageOutput([parser] + list(verb_parsers.values())):
known_args, _ = parser.parse_known_args(args=argv)
# add the arguments for the requested verb
if known_args.verb_name:
add_parser_arguments(known_args.verb_parser, known_args.verb_extension)
args = parser.parse_args(args=argv)
context = CommandContext(command_name=command_name, args=args)
if args.log_level:
colcon_logger.setLevel(args.log_level)
colcon_logger.debug('Parsed command line arguments: {args}'.format_map(
locals()))
# error: no verb provided
if args.verb_name is None:
print(parser.format_usage())
return 'Error: No verb provided'
# set default locations for log files
now = datetime.datetime.now()
now_str = str(now)[:-7].replace(' ', '_').replace(':', '-')
set_default_log_path(
base_path=args.log_base,
env_var='{command_name}_LOG_PATH'.format_map(locals()).upper(),
subdirectory='{args.verb_name}_{now_str}'.format_map(locals()))
# add a file handler writing all levels
create_log_path(args.verb_name)
handler = add_file_handler(colcon_logger,
get_log_path() / 'logger_all.log')
# write previous log messages to the file handler
log_record = colcon_logger.makeRecord(
colcon_logger.name, logging.DEBUG, __file__, 0,
'Command line arguments: {argv}'.format(
argv=argv if argv is not None else sys.argv), None, None)
handler.handle(log_record)
log_record = colcon_logger.makeRecord(
colcon_logger.name, logging.DEBUG, __file__, 0,
'Parsed command line arguments: {args}'.format_map(locals()), None,
None)
handler.handle(log_record)
# invoke verb
return verb_main(context, colcon_logger)
