def test_service_manager_initial_state():
service = WaitCancelledService()
manager = AsyncioManager(service)
assert manager.is_started is False
assert manager.is_running is False
assert manager.is_cancelled is False
assert manager.is_finished is False
def _run_asyncio_components(component_types: Tuple[Type[BaseComponentAPI], ...],
boot_info: BootInfo,
processes: Tuple[multiprocessing.Process, ...]) -> None:
runtime_component_types = tuple(
component_cls
for component_cls in component_types
if issubclass(component_cls, ComponentAPI)
)
trinity_config = boot_info.trinity_config
component_manager_service = ComponentManager(
boot_info,
runtime_component_types,
)
manager = AsyncioManager(component_manager_service)
loop = asyncio.get_event_loop()
loop.add_signal_handler(
signal.SIGTERM,
manager.cancel,
'SIGTERM',
)
loop.add_signal_handler(
signal.SIGINT,
component_manager_service.shutdown,
'CTRL+C',
)
try:
loop.run_until_complete(manager.run())
except BaseException as err:
logger = logging.getLogger()
logger.error("Error during trinity run: %r", err)
raise
finally:
kill_trinity_with_reason(trinity_config, processes, component_manager_service.reason)
if trinity_config.trinity_tmp_root_dir:
shutil.rmtree(trinity_config.trinity_root_dir)
async def test_asyncio_service_manager_propogates_and_records_exceptions():
@as_service
async def ThrowErrorService(manager):
raise RuntimeError("this is the error")
service = ThrowErrorService()
manager = AsyncioManager(service)
assert manager.did_error is False
with pytest.raises(RuntimeError, match="this is the error"):
await manager.run()
assert manager.did_error is True
async def test_asyncio_service_lifecycle_run_and_external_cancellation():
@as_service
async def ServiceTest(manager):
while True:
await asyncio.sleep(0)
service = ServiceTest()
manager = AsyncioManager(service)
await do_service_lifecycle_check(
manager=manager,
manager_run_fn=manager.run,
trigger_exit_condition_fn=manager.cancel,
should_be_cancelled=True,
)
async def test_asyncio_service_lifecycle_run_and_clean_exit():
trigger_exit = asyncio.Event()
@as_service
async def ServiceTest(manager):
await trigger_exit.wait()
service = ServiceTest()
manager = AsyncioManager(service)
await do_service_lifecycle_check(
manager=manager,
manager_run_fn=manager.run,
trigger_exit_condition_fn=trigger_exit.set,
should_be_cancelled=False,
)
def run(component_types: Tuple[Type[BaseComponentAPI], ...],
boot_info: BootInfo, get_base_db_fn: Callable[[BootInfo],
LevelDB]) -> None:
runtime_component_types = tuple(
cast(Type[BaseIsolatedComponent], component_cls)
for component_cls in component_types
if issubclass(component_cls, ComponentAPI))
trinity_config = boot_info.trinity_config
component_manager_service = ComponentManager(
boot_info,
runtime_component_types,
)
component_manager_manager = AsyncioManager(component_manager_service)
loop = asyncio.get_event_loop()
loop.add_signal_handler(
signal.SIGTERM,
component_manager_manager.cancel,
'SIGTERM',
)
loop.add_signal_handler(
signal.SIGINT,
component_manager_service.shutdown,
'CTRL+C',
)
logger = logging.getLogger()
try:
loop.run_until_complete(
_run(boot_info, get_base_db_fn, component_manager_manager))
except BaseException:
logger.exception("Error during trinity run")
raise
finally:
reason = component_manager_service.reason
hint = f" ({reason})" if reason else f""
logger.info('Shutting down Trinity%s', hint)
remove_dangling_ipc_files(logger, trinity_config.ipc_dir)
argparse.ArgumentParser().exit(
message=f"Trinity shutdown complete{hint}\n")
if trinity_config.trinity_tmp_root_dir:
shutil.rmtree(trinity_config.trinity_root_dir)
async def test_asyncio_service_lifecycle_run_and_exception():
trigger_error = asyncio.Event()
@as_service
async def ServiceTest(manager):
await trigger_error.wait()
raise RuntimeError("Service throwing error")
service = ServiceTest()
manager = AsyncioManager(service)
async def do_service_run():
with pytest.raises(RuntimeError, match="Service throwing error"):
await manager.run()
await do_service_lifecycle_check(
manager=manager,
manager_run_fn=do_service_run,
trigger_exit_condition_fn=trigger_error.set,
should_be_cancelled=True,
)
async def test_asyncio_service_lifecycle_run_and_daemon_task_exit():
trigger_error = asyncio.Event()
@as_service
async def ServiceTest(manager):
async def daemon_task_fn():
await trigger_error.wait()
manager.run_daemon_task(daemon_task_fn)
service = ServiceTest()
manager = AsyncioManager(service)
async def do_service_run():
with pytest.raises(DaemonTaskExit, match="Daemon task"):
await manager.run()
await do_service_lifecycle_check(
manager=manager,
manager_run_fn=do_service_run,
trigger_exit_condition_fn=trigger_error.set,
should_be_cancelled=True,
)
def main_entry(trinity_boot: BootFn,
app_identifier: str,
component_types: Tuple[Type[BaseComponentAPI], ...],
sub_configs: Sequence[Type[BaseAppConfig]]) -> None:
if is_prerelease():
# this modifies the asyncio logger, but will be overridden by any custom settings below
enable_warnings_by_default()
for component_cls in component_types:
component_cls.configure_parser(parser, subparser)
argcomplete.autocomplete(parser)
args = parser.parse_args()
if not args.genesis and args.network_id not in PRECONFIGURED_NETWORKS:
parser.error(
f"Unsupported network id: {args.network_id}. To use a network besides "
"mainnet or ropsten, you must supply a genesis file with a flag, like "
"`--genesis path/to/genesis.json`, also you must specify a data "
"directory with `--data-dir path/to/data/directory`"
)
# The `common_log_level` is derived from `--log-level <Level>` / `-l <Level>` without
# specifying any module. If present, it is used for both `stderr` and `file` logging.
common_log_level = args.log_levels and args.log_levels.get(None)
has_ambigous_logging_config = ((
common_log_level is not None and
args.stderr_log_level is not None
) or (
common_log_level is not None and
args.file_log_level is not None
))
if has_ambigous_logging_config:
parser.error(
f"""\n
Ambiguous logging configuration: The `--log-level (-l)` flag sets the
log level for both file and stderr logging.
To configure different log level for file and stderr logging,
remove the `--log-level` flag and use `--stderr-log-level` and/or
`--file-log-level` separately.
Alternatively, remove the `--stderr-log-level` and/or `--file-log-level`
flags to share one single log level across both handlers.
"""
)
try:
trinity_config = TrinityConfig.from_parser_args(args, app_identifier, sub_configs)
except AmbigiousFileSystem:
parser.error(TRINITY_AMBIGIOUS_FILESYSTEM_INFO)
if not is_data_dir_initialized(trinity_config):
# TODO: this will only work as is for chains with known genesis
# parameters. Need to flesh out how genesis parameters for custom
# chains are defined and passed around.
try:
initialize_data_dir(trinity_config)
except AmbigiousFileSystem:
parser.error(TRINITY_AMBIGIOUS_FILESYSTEM_INFO)
except MissingPath as e:
parser.error(
"\n"
f"It appears that {e.path} does not exist. "
"Trinity does not attempt to create directories outside of its root path. "
"Either manually create the path or ensure you are using a data directory "
"inside the XDG_TRINITY_ROOT path"
)
# +---------------+
# | LOGGING SETUP |
# +---------------+
# Setup logging to stderr
stderr_logger_level = (
args.stderr_log_level
if args.stderr_log_level is not None
else (common_log_level if common_log_level is not None else logging.INFO)
)
handler_stderr = setup_stderr_logging(stderr_logger_level)
# Setup file based logging
file_logger_level = (
args.file_log_level
if args.file_log_level is not None
else (common_log_level if common_log_level is not None else logging.DEBUG)
)
handler_file = setup_file_logging(trinity_config.logfile_path, file_logger_level)
# Set the individual logger levels that have been specified.
logger_levels = {} if args.log_levels is None else args.log_levels
set_logger_levels(logger_levels)
# get the root logger and set it to the level of the stderr logger.
logger = logging.getLogger()
logger.setLevel(stderr_logger_level)
# This prints out the ASCII "trinity" header in the terminal
display_launch_logs(trinity_config)
# Setup the log listener which child processes relay their logs through
log_listener = IPCListener(handler_stderr, handler_file)
# Determine what logging level child processes should use.
child_process_log_level = min(
stderr_logger_level,
file_logger_level,
*logger_levels.values(),
)
boot_info = BootInfo(
args=args,
trinity_config=trinity_config,
child_process_log_level=child_process_log_level,
logger_levels=logger_levels,
profile=bool(args.profile),
)
# Let the components do runtime validation
for component_cls in component_types:
component_cls.validate_cli(boot_info)
# Components can provide a subcommand with a `func` which does then control
# the entire process from here.
if hasattr(args, 'func'):
args.func(args, trinity_config)
return
if hasattr(args, 'munge_func'):
args.munge_func(args, trinity_config)
runtime_component_types = tuple(
component_cls
for component_cls in component_types
if issubclass(component_cls, ComponentAPI)
)
with log_listener.run(trinity_config.logging_ipc_path):
processes = trinity_boot(boot_info)
loop = asyncio.get_event_loop()
def kill_trinity_with_reason(reason: str) -> None:
kill_trinity_gracefully(
trinity_config,
logger,
processes,
reason=reason
)
component_manager_service = ComponentManager(
boot_info,
runtime_component_types,
kill_trinity_with_reason,
)
manager = AsyncioManager(component_manager_service)
loop.add_signal_handler(
signal.SIGTERM,
manager.cancel,
'SIGTERM',
)
loop.add_signal_handler(
signal.SIGINT,
component_manager_service.shutdown,
'CTRL+C',
)
try:
loop.run_until_complete(manager.run())
except BaseException as err:
logger.error("Error during trinity run: %r", err)
raise
finally:
kill_trinity_with_reason(component_manager_service.reason)
if trinity_config.trinity_tmp_root_dir:
shutil.rmtree(trinity_config.trinity_root_dir)