Skip to content

Commit

Permalink
feat(log): Separate logger objects from class objects
Browse files Browse the repository at this point in the history
  • Loading branch information
@ferdinandjarisch
ferdinandjarisch committed Sep 15, 2023
1 parent 4f72681 commit f571042
Show file tree
Hide file tree
Showing 40 changed files with 540 additions and 487 deletions.
34 changes: 15 additions & 19 deletions src/gallia/command/base.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,9 @@ def json(self) -> str:
return msgspec.json.encode(self).decode()


logger = get_logger("gallia.base")


class BaseCommand(ABC):
"""BaseCommand is the baseclass for all gallia commands.
This class can be used in standalone scripts via the
Expand All @@ -93,8 +96,6 @@ class BaseCommand(ABC):
#: The string which is shown at the bottom of --help.
EPILOG: str | None = None

#: The name of the logger when this command is run.
LOGGER_NAME = __name__
#: Enable a artifacts_dir. Setting this property to
#: True enables the creation of a logfile.
HAS_ARTIFACTS_DIR: bool = False
Expand All @@ -105,7 +106,6 @@ class BaseCommand(ABC):

def __init__(self, parser: ArgumentParser, config: Config = Config()) -> None:
self.id = camel_to_snake(self.__class__.__name__)
self.logger = get_logger(self.LOGGER_NAME)
self.parser = parser
self.config = config
self.artifacts_dir = Path()
Expand Down Expand Up @@ -172,16 +172,14 @@ def run_hook(
stdout = p.stdout
stderr = p.stderr
except CalledProcessError as e:
self.logger.warning(
f"{variant.value}-hook failed (exit code: {p.returncode})"
)
logger.warning(f"{variant.value}-hook failed (exit code: {p.returncode})")
stdout = e.stdout
stderr = e.stderr

if stdout:
self.logger.info(p.stdout.strip(), extra={"tags": [hook_id, "stdout"]})
logger.info(p.stdout.strip(), extra={"tags": [hook_id, "stdout"]})
if stderr:
self.logger.info(p.stderr.strip(), extra={"tags": [hook_id, "stderr"]})
logger.info(p.stderr.strip(), extra={"tags": [hook_id, "stderr"]})

def configure_class_parser(self) -> None:
group = self.parser.add_argument_group("generic arguments")
Expand Down Expand Up @@ -321,9 +319,9 @@ def _aquire_flock(self, path: Path) -> None:
# log a message and do a blocking wait afterwards.
fcntl.flock(self._lock_file_fd, fcntl.LOCK_EX | fcntl.LOCK_NB)
except BlockingIOError:
self.logger.notice(f"Waiting for flock: {path}")
logger.notice(f"Waiting for flock: {path}")
fcntl.flock(self._lock_file_fd, fcntl.LOCK_EX)
self.logger.info("Acquired lock. Continuing.")
logger.info("Acquired lock. Continuing.")

def _release_flock(self) -> None:
assert self._lock_file_fd
Expand All @@ -335,7 +333,7 @@ def entry_point(self, args: Namespace) -> int:
try:
self._aquire_flock(p)
except OSError as e:
self.logger.critical(f"Unable to lock {p}: {e}")
logger.critical(f"Unable to lock {p}: {e}")
return exitcode.OSFILE

if self.HAS_ARTIFACTS_DIR:
Expand Down Expand Up @@ -370,14 +368,14 @@ def entry_point(self, args: Namespace) -> int:
if isinstance(e, t):
# TODO: Map the exitcode to superclass of builtin exceptions.
exit_code = exitcode.IOERR
self.logger.critical(
logger.critical(
f"Caught expected exception, stack trace on debug level: {e!r}"
)
self.logger.debug(e, exc_info=True)
logger.debug(e, exc_info=True)
break
else:
exit_code = exitcode.SOFTWARE
self.logger.critical(e, exc_info=True)
logger.critical(e, exc_info=True)
finally:
self.run_meta.exit_code = exit_code
self.run_meta.end_time = datetime.now(tz).isoformat()
Expand All @@ -386,7 +384,7 @@ def entry_point(self, args: Namespace) -> int:
self.artifacts_dir.joinpath(FileNames.META.value).write_text(
self.run_meta.json() + "\n"
)
self.logger.notice(f"Stored artifacts at {self.artifacts_dir}")
logger.notice(f"Stored artifacts at {self.artifacts_dir}")

if args.hooks:
self.run_hook(HookVariant.POST, args, exit_code)
Expand Down Expand Up @@ -512,16 +510,14 @@ async def _db_finish_run_meta(self, args: Namespace, exit_code: int) -> None:
self.artifacts_dir,
)
except Exception as e:
self.logger.warning(
logger.warning(
f"Could not write the run meta to the database: {e!r}"
)

try:
await self.db_handler.disconnect()
except Exception as e:
self.logger.error(
f"Could not close the database connection properly: {e!r}"
)
logger.error(f"Could not close the database connection properly: {e!r}")

async def setup(self, args: Namespace) -> None:
if args.target is None:
Expand Down
23 changes: 11 additions & 12 deletions src/gallia/command/uds.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,14 @@

from gallia.command.base import FileNames, Scanner
from gallia.config import Config
from gallia.log import get_logger
from gallia.plugins import load_ecu, load_ecu_plugins
from gallia.services.uds.core.service import NegativeResponse, UDSResponse
from gallia.services.uds.ecu import ECU
from gallia.services.uds.helpers import raise_for_error

logger = get_logger("gallia.base.udsscan")


class UDSScanner(Scanner):
"""UDSScanner is a baseclass, particularly for scanning tasks
Expand Down Expand Up @@ -134,19 +137,17 @@ async def setup(self, args: Namespace) -> None:
await self.db_handler.insert_scan_run(args.target.raw)
self._apply_implicit_logging_setting()
except Exception as e:
self.logger.warning(
f"Could not write the scan run to the database: {e:!r}"
)
logger.warning(f"Could not write the scan run to the database: {e:!r}")

if args.ecu_reset is not None:
resp: UDSResponse = await self.ecu.ecu_reset(args.ecu_reset)
if isinstance(resp, NegativeResponse):
self.logger.warning(f"ECUReset failed: {resp}")
self.logger.warning("Switching to default session")
logger.warning(f"ECUReset failed: {resp}")
logger.warning("Switching to default session")
raise_for_error(await self.ecu.set_session(0x01))
resp = await self.ecu.ecu_reset(args.ecu_reset)
if isinstance(resp, NegativeResponse):
self.logger.warning(f"ECUReset in session 0x01 failed: {resp}")
logger.warning(f"ECUReset in session 0x01 failed: {resp}")

# Handles connecting to the target and waits
# until it is ready.
Expand All @@ -171,7 +172,7 @@ async def setup(self, args: Namespace) -> None:
)
self._apply_implicit_logging_setting()
except Exception as e:
self.logger.warning(
logger.warning(
f"Could not write the properties_pre to the database: {e!r}"
)

Expand All @@ -187,17 +188,15 @@ async def teardown(self, args: Namespace) -> None:
prop_pre = json.loads(await file.read())

if args.compare_properties and await self.ecu.properties(False) != prop_pre:
self.logger.warning("ecu properties differ, please investigate!")
logger.warning("ecu properties differ, please investigate!")

if self.db_handler is not None:
try:
await self.db_handler.complete_scan_run(
await self.ecu.properties(False)
)
except Exception as e:
self.logger.warning(
f"Could not write the scan run to the database: {e!r}"
)
logger.warning(f"Could not write the scan run to the database: {e!r}")

if args.tester_present:
await self.ecu.stop_cyclic_tester_present()
Expand Down Expand Up @@ -226,6 +225,6 @@ async def setup(self, args: Namespace) -> None:
try:
await self.db_handler.insert_discovery_run(args.target.url.scheme)
except Exception as e:
self.logger.warning(
logger.warning(
f"Could not write the discovery run to the database: {e!r}"
)
Loading

0 comments on commit f571042

Please sign in to comment.