Source code for tbot.log_event

# tbot, Embedded Automation Tool
# Copyright (C) 2019  Harald Seiler
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <>.

import time
import typing

from tbot import log
from tbot.log import u, c

__all__ = ("testcase_begin", "testcase_end", "command")

[docs]def testcase_begin(name: str) -> None: """ Log a testcase's beginning. :param str name: Name of the testcase """ log.EventIO( ["tc", "begin"], "Calling " + c(name).cyan.bold + " ...", verbosity=log.Verbosity.QUIET, name=name, ) log.NESTING += 1
[docs]def testcase_end( name: str, duration: float, success: bool = True, skipped: typing.Optional[str] = None, ) -> None: """ Log a testcase's end. :param float duration: Time passed while this testcase ran :param bool success: Whether the testcase succeeded :param str skipped: ``None`` if the testcase ran normally or a string (the reason) if it was skipped. If a testcase was skipped, ``success`` is ignored. """ if skipped is not None: message = c("Skipped").yellow.bold + f": {skipped}" skip_info = {"skip_reason": skipped} else: # Testcase ran normally skip_info = {} if success: message = c("Done").green.bold + f". ({duration:.3f}s)" else: message = c("Fail").red.bold + f". ({duration:.3f}s)" log.EventIO( ["tc", "end"], message, nest_first=u("└─", "\\-"), verbosity=log.Verbosity.QUIET, name=name, duration=duration, success=success, skipped=skipped is not None, **skip_info, ) log.NESTING -= 1
# Table which maps each control character to its unicode symbol from the # "Control Picture" block. _CONTROL_MAPPING = {c: 0x2400 + c for c in range(32)}
[docs]def command(mach: str, cmd: str) -> log.EventIO: """ Log a command's execution. :param str mach: Name of the machine the command is run on :param str cmd: The command itself :rtype: EventIO :returns: A stream that the output of the command should be written to. """ # Replace all newlines and other special characters in the command string if log.IS_UNICODE: cmd = cmd.translate(_CONTROL_MAPPING) ev = log.EventIO( ["cmd", mach], "[" + c(mach).yellow + "] " + c(cmd).dark, verbosity=log.Verbosity.COMMAND, cmd=cmd, ) if log.INTERACTIVE: if input(ev._prefix() + c(" OK [Y/n]? ").magenta).upper() not in ("", "Y"): raise RuntimeError("Aborted by user") ev.prefix = " ## " ev.verbosity = log.Verbosity.STDOUT return ev
def tbot_start() -> None: print(log.c("tbot").yellow.bold + " starting ...") log.NESTING += 1 def tbot_end(success: bool) -> None: log.message( log.c( log.u( "────────────────────────────────────────", "----------------------------------------", ) ).dark ) if log.LOGFILE is not None: log.message(f"Log written to {!r}") msg = log.c("SUCCESS").green.bold if success else log.c("FAILURE").red.bold duration = time.monotonic() - log.START_TIME log.EventIO( ["tbot", "end"], msg + f" ({duration:.3f}s)", nest_first=log.u("└─", "\\-"), verbosity=log.Verbosity.QUIET, success=success, duration=duration, ) def exception(name: str, trace: str) -> log.EventIO: ev = log.EventIO( ["exception"], log.c("Exception").red.bold + ":", verbosity=log.Verbosity.QUIET, name=name, trace=trace, ) ev.prefix = " " ev.write(trace) return ev