Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix logging for multiple scanners in a script #651

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+252 −165
Open

Fix logging for multiple scanners in a script #651

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 1 addition & 10 deletions src/gallia/cli/gallia.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,8 @@
from gallia.plugins.plugin import CommandTree, load_commands, load_plugins
from gallia.pydantic_argparse import ArgumentParser
from gallia.pydantic_argparse import BaseCommand as PydanticBaseCommand
from gallia.utils import get_log_level

setup_logging(Loglevel.DEBUG)
setup_logging("gallia", Loglevel.DEBUG)


defaults = dict[type, dict[str, Any]]
Expand Down Expand Up @@ -123,7 +122,6 @@ def get_command(config: BaseCommandConfig) -> BaseCommand:
def parse_and_run(
commands: type[BaseCommand] | MutableMapping[str, CommandTree | type[BaseCommand]],
auto_complete: bool = True,
setup_log: bool = True,
top_level_options: Mapping[str, Callable[[], None]] | None = None,
show_help_on_zero_args: bool = True,
) -> Never:
Expand All @@ -136,7 +134,6 @@ def parse_and_run(

:param commands: A hierarchy of commands.
:param auto_complete: Turns auto-complete functionality on.
:param setup_log: Setup logging according to the parameters in the parsed config.
:param top_level_options: Optional top-level actions, such as "--version", given by a mapping of arguments and
functions. The program redirects control to the given function, once the program is
called with the corresponding argument and terminates after it returns.
Expand Down Expand Up @@ -182,12 +179,6 @@ def __call__(

assert isinstance(config, BaseCommandConfig)

if setup_log:
setup_logging(
level=get_log_level(config.verbose),
no_volatile_info=not config.volatile_info,
)

sys.exit(get_command(config).entry_point())


Expand Down
38 changes: 26 additions & 12 deletions src/gallia/command/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
from collections.abc import MutableMapping
from datetime import UTC, datetime
from enum import Enum, unique
from logging import Handler
from pathlib import Path
from subprocess import CalledProcessError, run
from tempfile import gettempdir
Expand All @@ -26,12 +25,12 @@
from gallia.command.config import Field, GalliaBaseModel, Idempotent
from gallia.db.handler import DBHandler
from gallia.dumpcap import Dumpcap
from gallia.log import add_zst_log_handler, get_logger, tz
from gallia.log import LoggingSetupHandler, Loglevel, get_log_level, get_logger, setup_logging, tz
from gallia.power_supply import PowerSupply
from gallia.power_supply.uri import PowerSupplyURI
from gallia.services.uds.core.exception import UDSException
from gallia.transports import BaseTransport, TargetURI
from gallia.utils import camel_to_snake, get_file_log_level
from gallia.utils import camel_to_snake


@unique
Expand Down Expand Up @@ -180,9 +179,11 @@ class BaseCommand(FlockMixin, ABC):
#: a log message with level critical is logged.
CATCHED_EXCEPTIONS: list[type[Exception]] = []

log_file_handlers: list[Handler]

def __init__(self, config: BaseCommandConfig) -> None:
def __init__(
self,
config: BaseCommandConfig = BaseCommandConfig(),
logging_handler: LoggingSetupHandler | None = None,
) -> None:
self.id = camel_to_snake(self.__class__.__name__)
self.config = config
self.artifacts_dir = Path()
Expand All @@ -195,7 +196,7 @@ def __init__(self, config: BaseCommandConfig) -> None:
)
self._lock_file_fd: int | None = None
self.db_handler: DBHandler | None = None
self.log_file_handlers = []
self.provided_logging_handler = logging_handler

@abstractmethod
def run(self) -> int: ...
Expand Down Expand Up @@ -323,15 +324,25 @@ def entry_point(self) -> int:

if self.HAS_ARTIFACTS_DIR:
self.artifacts_dir = self.prepare_artifactsdir(
self.config.artifacts_base, self.config.artifacts_dir
self.config.artifacts_base,
self.config.artifacts_dir,
)

if self.provided_logging_handler is None:
stderr_level = get_log_level(self.config.verbose)
logging_handler = setup_logging(
logger_name="gallia",
stderr_level=stderr_level,
close_on_exit=False,
)
self.log_file_handlers.append(
add_zst_log_handler(
if self.HAS_ARTIFACTS_DIR:
logging_handler.add_zst_file_handler(
logger_name="gallia",
filepath=self.artifacts_dir.joinpath(FileNames.LOGFILE.value),
file_log_level=get_file_log_level(self.config),
log_level=stderr_level if self.config.trace_log is False else Loglevel.TRACE,
)
)
else:
logging_handler = self.provided_logging_handler

if self.config.hooks:
self.run_hook(HookVariant.PRE)
Expand Down Expand Up @@ -380,6 +391,9 @@ def entry_point(self) -> int:
if self._lock_file_fd is not None:
self._release_flock()

if self.provided_logging_handler is None:
logging_handler.stop_logging()

return exit_code


Expand Down
Loading
Loading