From c01e1b5d5713ac2b500960080c80576e0dd7072a Mon Sep 17 00:00:00 2001 From: Robert Nemes Date: Wed, 4 Dec 2024 18:45:57 +0000 Subject: [PATCH 1/3] Added --code flag for collecting code context. --- doc/en/introduction.rst | 1 + doc/newsfragments/2981_new.code_context.rst | 2 + testplan/base.py | 6 ++ testplan/parser.py | 8 ++ testplan/runnable/base.py | 1 + testplan/testing/base.py | 8 ++ testplan/testing/multitest/base.py | 5 +- testplan/testing/multitest/entries/base.py | 1 + .../testing/multitest/entries/schemas/base.py | 1 + testplan/testing/result.py | 50 +++++---- .../src/AssertionPane/AssertionHeader.js | 102 ++++++++++++++++-- .../AssertionHeader.test.js.snap | 4 + testplan/web_ui/testing/src/Common/utils.js | 14 +++ .../__snapshots__/BatchReport.test.js.snap | 5 +- .../web_ui/testing/src/Toolbar/Toolbar.js | 11 +- 15 files changed, 187 insertions(+), 32 deletions(-) create mode 100644 doc/newsfragments/2981_new.code_context.rst diff --git a/doc/en/introduction.rst b/doc/en/introduction.rst index 383eca95a..5cc7fe8c1 100644 --- a/doc/en/introduction.rst +++ b/doc/en/introduction.rst @@ -455,6 +455,7 @@ Command line --label LABEL Label the test report with the given name, useful to categorize or classify similar reports (aka "run-id"). --driver-info Display drivers startup and teardown information, and visualise driver connections in the report. + --code Collects file path, line number and code context of the assertions. Highlighted features diff --git a/doc/newsfragments/2981_new.code_context.rst b/doc/newsfragments/2981_new.code_context.rst new file mode 100644 index 000000000..8901e941d --- /dev/null +++ b/doc/newsfragments/2981_new.code_context.rst @@ -0,0 +1,2 @@ +Added ``--code`` flag to collect code context for the assertions. Code context one-liner will be displayed on the web UI if enabled. +Note that file path information is no longer collected by default. To collect file path information, enable code context. \ No newline at end of file diff --git a/testplan/base.py b/testplan/base.py index 168006e17..58f69b914 100644 --- a/testplan/base.py +++ b/testplan/base.py @@ -146,6 +146,8 @@ class Testplan(entity.RunnableManager): categorize or classify similar reports . :param driver_info: Display driver setup / teardown time and driver interconnection information in UI report. + :param collect_code_context: Collects the file path, line number and code + context of the assertions. """ CONFIG = TestplanConfig @@ -194,6 +196,7 @@ def __init__( extra_deps: Optional[List[Union[str, ModuleType]]] = None, label: Optional[str] = None, driver_info: bool = False, + collect_code_context: bool = False, auto_part_runtime_limit: int = defaults.AUTO_PART_RUNTIME_LIMIT, plan_runtime_target: int = defaults.PLAN_RUNTIME_TARGET, **options, @@ -256,6 +259,7 @@ def __init__( extra_deps=extra_deps, label=label, driver_info=driver_info, + collect_code_context=collect_code_context, auto_part_runtime_limit=auto_part_runtime_limit, plan_runtime_target=plan_runtime_target, **options, @@ -401,6 +405,7 @@ def main_wrapper( extra_deps=None, label=None, driver_info=False, + collect_code_context=False, auto_part_runtime_limit=defaults.AUTO_PART_RUNTIME_LIMIT, plan_runtime_target=defaults.PLAN_RUNTIME_TARGET, **options, @@ -462,6 +467,7 @@ def test_plan_inner_inner(): extra_deps=extra_deps, label=label, driver_info=driver_info, + collect_code_context=collect_code_context, auto_part_runtime_limit=auto_part_runtime_limit, plan_runtime_target=plan_runtime_target, **options, diff --git a/testplan/parser.py b/testplan/parser.py index 922a85494..c51ee1976 100644 --- a/testplan/parser.py +++ b/testplan/parser.py @@ -499,6 +499,14 @@ def generate_parser(self) -> HelpParser: help="Display drivers setup / teardown timing and interconnection information in UI report.", ) + report_group.add_argument( + "--code", + dest="collect_code_context", + action="store_true", + default=self._default_options["collect_code_context"], + help="Collects file path, line number and code context of the assertions.", + ) + self.add_arguments(parser) return parser diff --git a/testplan/runnable/base.py b/testplan/runnable/base.py index a8c7378ea..f53dea7da 100644 --- a/testplan/runnable/base.py +++ b/testplan/runnable/base.py @@ -267,6 +267,7 @@ def get_options(cls): "skip_strategy", default=common.SkipStrategy.noop() ): Use(common.SkipStrategy.from_option_or_none), ConfigOption("driver_info", default=False): bool, + ConfigOption("collect_code_context", default=False): bool, } diff --git a/testplan/testing/base.py b/testplan/testing/base.py index 3c2e349b5..66644bf83 100644 --- a/testplan/testing/base.py +++ b/testplan/testing/base.py @@ -901,6 +901,14 @@ def driver_info(self) -> bool: return False return self.cfg.driver_info + @property + def collect_code_context(self) -> bool: + """ + Collecting the file path, line number and code context of the assertions + if enabled. + """ + return getattr(self.cfg, "collect_code_context", False) + class ProcessRunnerTestConfig(TestConfig): """ diff --git a/testplan/testing/multitest/base.py b/testplan/testing/multitest/base.py index 657703313..8f6eb463b 100644 --- a/testplan/testing/multitest/base.py +++ b/testplan/testing/multitest/base.py @@ -30,7 +30,7 @@ ) from testplan.testing.multitest import suite as mtest_suite from testplan.testing.multitest.entries import base as entries_base -from testplan.testing.result import report_target +from testplan.testing.result import report_target, collect_code_context from testplan.testing.multitest.suite import ( get_suite_metadata, get_testcase_metadata, @@ -1158,6 +1158,9 @@ def _run_testcase( ), ) + if self.cfg.collect_code_context: + testcase = collect_code_context(func=testcase) + # specially handle skipped testcases if hasattr(testcase, "__should_skip__"): with compose_contexts( diff --git a/testplan/testing/multitest/entries/base.py b/testplan/testing/multitest/entries/base.py index dd172d7a5..3ab892628 100644 --- a/testplan/testing/multitest/entries/base.py +++ b/testplan/testing/multitest/entries/base.py @@ -50,6 +50,7 @@ def __init__(self, description, category=None, flag=None): # Will be set explicitly via containers self.line_no = None self.file_path = None + self.code_context = None def __str__(self): return repr(self) diff --git a/testplan/testing/multitest/entries/schemas/base.py b/testplan/testing/multitest/entries/schemas/base.py index dc234fe20..c5a6fe9c0 100644 --- a/testplan/testing/multitest/entries/schemas/base.py +++ b/testplan/testing/multitest/entries/schemas/base.py @@ -33,6 +33,7 @@ class BaseSchema(Schema): category = fields.String() flag = fields.String() file_path = fields.String() + code_context = fields.String() custom_style = fields.Dict(keys=fields.String(), values=fields.String()) def load(self, *args, **kwargs): diff --git a/testplan/testing/result.py b/testplan/testing/result.py index be1edda57..6310fdaf2 100644 --- a/testplan/testing/result.py +++ b/testplan/testing/result.py @@ -113,6 +113,14 @@ def __exit__(self, exc_type, exc_value, tb): assertion_state = threading.local() +def collect_code_context(func: Callable) -> Callable: + def wrapper(*args, **kwargs): + assertion_state.collect_code_context = True + func(*args, **kwargs) + + return wrapper + + def report_target(func: Callable, ref_func: Callable = None) -> Callable: """ Sets the decorated function's filepath and line-range in assertion state. @@ -165,7 +173,10 @@ def wrapper(result, *args, **kwargs): custom_style = kwargs.pop("custom_style", None) dryrun = kwargs.pop("dryrun", False) entry = func(result, *args, **kwargs) - if top_assertion: + if not top_assertion: + return entry + + if getattr(assertion_state, "collect_code_context", False): with MOD_LOCK: call_stack = inspect.stack() try: @@ -183,34 +194,35 @@ def wrapper(result, *args, **kwargs): frame = call_stack[1] entry.file_path = os.path.abspath(frame.filename) entry.line_no = frame.lineno + entry.code_context = frame.code_context[0].strip() finally: # https://docs.python.org/3/library/inspect.html del frame del call_stack - if custom_style is not None: - if not isinstance(custom_style, dict): - raise TypeError( - "Use `dict[str, str]` to specify custom CSS style" - ) - entry.custom_style = custom_style + if custom_style is not None: + if not isinstance(custom_style, dict): + raise TypeError( + "Use `dict[str, str]` to specify custom CSS style" + ) + entry.custom_style = custom_style - assert isinstance(result, AssertionNamespace) or isinstance( - result, Result - ), "Incorrect usage of assertion decorator" + assert isinstance(result, AssertionNamespace) or isinstance( + result, Result + ), "Incorrect usage of assertion decorator" - if isinstance(result, AssertionNamespace): - result = result.result + if isinstance(result, AssertionNamespace): + result = result.result - if not dryrun: - result.entries.append(entry) + if not dryrun: + result.entries.append(entry) - stdout_registry.log_entry( - entry=entry, stdout_style=result.stdout_style - ) + stdout_registry.log_entry( + entry=entry, stdout_style=result.stdout_style + ) - if not entry and not result.continue_on_failure: - raise AssertionError(entry) + if not entry and not result.continue_on_failure: + raise AssertionError(entry) return entry finally: diff --git a/testplan/web_ui/testing/src/AssertionPane/AssertionHeader.js b/testplan/web_ui/testing/src/AssertionPane/AssertionHeader.js index 69cbb92a2..5635b5864 100644 --- a/testplan/web_ui/testing/src/AssertionPane/AssertionHeader.js +++ b/testplan/web_ui/testing/src/AssertionPane/AssertionHeader.js @@ -12,6 +12,7 @@ import { } from "@fortawesome/free-solid-svg-icons"; import Button from "@material-ui/core/Button"; import Linkify from "linkify-react"; +import { getWorkspacePath } from "../Common/utils"; library.add(faLayerGroup); @@ -35,6 +36,7 @@ function AssertionHeader({ const [isUTCTooltipOpen, setIsUTCTooltipOpen] = useState(false); const [isPathTooltipOpen, setIsPathTooltipOpen] = useState(false); const [isDurationTooltipOpen, setIsDurationTooltipOpen] = useState(false); + const [is1LinerTooltipOpen, setIs1LinerTooltipOpen] = useState(false); /** * Toggle the visibility of tooltip of file path. @@ -57,6 +59,13 @@ function AssertionHeader({ setIsDurationTooltipOpen(!isDurationTooltipOpen); }; + /** + * Toggle the visibility of tooltip of duration between assertions. + */ + const toggle1LinerTooltip = () => { + setIs1LinerTooltipOpen(!is1LinerTooltipOpen); + }; + const cardHeaderColorStyle = assertion.passed === undefined ? styles.cardHeaderColorLog @@ -131,15 +140,13 @@ function AssertionHeader({ ); - let pathButton = displayPath ? ( + const pathButton = assertion.file_path && assertion.line_no ? ( <> diff --git a/testplan/web_ui/testing/src/Toolbar/Toolbar.js b/testplan/web_ui/testing/src/Toolbar/Toolbar.js index 0e888f5ef..0fadd3829 100644 --- a/testplan/web_ui/testing/src/Toolbar/Toolbar.js +++ b/testplan/web_ui/testing/src/Toolbar/Toolbar.js @@ -165,11 +165,11 @@ const PanelViewSwitch = ({ panel_types, switchPanelViewFunc }) => { ); }; -const UserPreferenceCheckbox = ({ children, preferenceAtom }) => { +const UserPreferenceCheckbox = ({ children, preferenceAtom, title }) => { const [preference, setPreference] = useAtom(preferenceAtom); return ( -