odoo-runbot 1.0.0b2__py3-none-any.whl

odoo_runbot/__about__.py

@@ -0,0 +1,3 @@
+__version__ = "1.0.0-beta2"
+__author__ = "Alexis Pasquier"
+__author_email__ = "alexis.pasquier@mangono.io"

odoo_runbot/__init__.py

@@ -0,0 +1,12 @@
+"""This lib is a CLI using typer.
+
+I tried to separate the code by feature part.
+
+- [odoo_runbot.cli][] Contains the entrypoint, All the rich display is done here. (Other than log)
+- [odoo_runbot.runbot_env][] Contains il a python way the env in wich the runbot is running.
+- [odoo_runbot.runbot_init][] Contains all the code to execute to initialize the Odoo to run test
+- [odoo_runbot.runbot_init_branch_resolver][] Contains the working branch resolving (Pull other add-ons from git)
+"""
+
+__import__("os").environ["TZ"] = "UTC"
+__import__("os").environ["WITHOUT_DEMO"] = "False"

odoo_runbot/_odoo_internal.py

@@ -0,0 +1,136 @@
+from __future__ import annotations
+
+import contextlib
+import logging
+import typing
+
+if typing.TYPE_CHECKING:
+    import pathlib
+
+from unittest.mock import patch
+
+from xmlrunner import XMLTestRunner
+from xmlrunner.result import _XMLTestResult
+
+_logger = logging.getLogger("odoo_runbot.odoo_internal")
+try:
+    import odoo
+
+except ModuleNotFoundError:
+    from unittest import mock
+
+    odoo = mock.MagicMock()
+
+__all__ = ["odoo", "patch_odoo_test_suite", "run_odoo_and_stop", "setup_odoo"]
+
+
+class _RunProto(typing.Protocol):
+    def run(self, result): ...
+
+
+class _UpdateProto(typing.Protocol):
+    def update(self, other): ...
+
+
+@contextlib.contextmanager
+def patch_odoo_test_suite(output_dir: pathlib.Path) -> typing.Generator[None]:
+    """Patch odoo test suite and Odoo test result.
+
+    - In Odoo 12 and Odoo 13, The test result is the native unittest.TestResult
+    - In Odoo 14 and Odoo 15. The test result extend unittest.TestResult and add `update` function. So we call it
+    - In 16.0 and more the OdooTestResult don't extend unittest.TestResult.
+    I need to patch the `update` function to add result of the `_XmlTestResult`
+
+    Args:
+        output_dir: Te patch where to store the xml result
+
+    Returns: Nothing, but unpatched function at the end
+    """
+
+    odoo_suite_class, odoo_result_class, apply_update = _try_find_stuff_to_patch()
+    if not odoo_suite_class:
+        msg = f"Odoo version {odoo.release.version} not supported"
+        raise ValueError(msg)
+    output_dir.mkdir(exist_ok=True, parents=True)
+
+    _logger.info("Create test result in %s", output_dir.absolute())
+    _unpatched_run = odoo_suite_class.run
+    patch_odoo_suite_run = f"{odoo_suite_class.__module__}.{odoo_suite_class.__name__}.run"
+    _logger.info("Patch %s", patch_odoo_suite_run)
+    patch_odoo_suite_update = None
+    if odoo_result_class:
+        _unpatched_update = odoo_result_class.update
+        patch_odoo_suite_update = f"{odoo_result_class.__module__}.{odoo_result_class.__name__}.update"
+        _logger.info("Patch %s", patch_odoo_suite_update)
+
+    def patched_suite_run(self, result):
+        # Suite run method will be called by the XMLTestRunner,
+        # so we need to run the original run method
+        with patch.object(self, "run", lambda result: _unpatched_run(self, result)):
+            # Override : XMLTestRunner to run the tests and generate XML reports
+            xml_results = XMLTestRunner(output=str(output_dir.absolute()), verbosity=2).run(self)
+        if apply_update:
+            result.update(xml_results)
+            return result
+        return xml_results
+
+    def patched_suite_update(self, other):
+        # Adapt _XMLTestResult to OdooTestResult
+        if isinstance(other, _XMLTestResult):
+            self.failures_count += len(other.failures)
+            self.errors_count += len(other.errors)
+            self.skipped += len(other.skipped)
+            self.testsRun += other.testsRun
+        else:
+            _unpatched_update(self, other)
+
+    with patch(patch_odoo_suite_run, patched_suite_run):
+        if odoo_result_class:
+            with patch(patch_odoo_suite_update, patched_suite_update):
+                yield
+        else:
+            yield
+
+
+def _try_find_stuff_to_patch() -> tuple[type[_RunProto] | None, type[_UpdateProto] | None, bool]:
+    apply_update = True
+    if "12.0" <= odoo.release.version <= "13.0":
+        from odoo.tests.common import OdooSuite as odoo_suite_class  # noqa: N813
+
+        odoo_result_class = None
+        apply_update = False
+    elif "14.0" <= odoo.release.version <= "15.0":
+        from odoo.tests.common import OdooSuite as odoo_suite_class  # noqa: N813
+
+        odoo_result_class = None
+    elif "16.0" <= odoo.release.version <= "18.0":
+        from odoo.tests.result import OdooTestResult as odoo_result_class  # noqa: N813
+        from odoo.tests.suite import OdooSuite as odoo_suite_class  # noqa: N813
+    else:
+        return None, None, False
+
+    return odoo_suite_class, odoo_result_class, apply_update
+
+
+def run_odoo_and_stop(preload: list[str] | None = None) -> int:
+    preload = preload or odoo.tools.config["db_name"].split(",")
+    return odoo.service.server.start(preload=preload, stop=True)
+
+
+def setup_odoo() -> None:
+    odoo.cli.server.check_root_user()
+    odoo.cli.server.check_postgres_user()
+    odoo.cli.server.report_configuration()
+    odoo.netsvc.init_logger()
+
+
+def parse_config(server_args: list[str]) -> None:
+    __import__("os").environ["TZ"] = "UTC"
+    _logger.info("Start Odoo with args=%s", server_args)
+    # Hard set value
+    # In test mode we don't care about loading language
+    # But il you do multiple step, you load multiple time the registry.
+    # And in odoo.modules.loadings.load_module they `pop` this key, idkw
+    # So in test mode, we force this option key to None
+    odoo.tools.config.options["load_language"] = None
+    odoo.tools.config.parse_config(server_args)

odoo_runbot/cli.py

@@ -0,0 +1,234 @@
+from __future__ import annotations
+
+import logging
+import os
+from pathlib import Path
+
+import typer
+from rich.console import Console, ConsoleOptions, Group, RenderResult
+from rich.panel import Panel
+from rich.table import Table
+from typer import Typer
+from typing_extensions import Annotated
+
+from . import runbot_init
+from .runbot_env import RunbotEnvironment, RunbotStepConfig, RunbotToolConfig, StepAction
+from .runbot_run import StepRunner
+
+app = Typer()
+
+env: RunbotEnvironment = None
+
+
+def rich_force_colors() -> bool:
+    """In Gitlab CI runner there is no tty, and no color.
+
+    This function force the color even if there is no TTY
+    See Also:
+        https://github.com/nf-core/tools/pull/760/files
+        https://github.com/Textualize/rich/issues/343
+    Returns:
+        True if in CI/CD Job or if color is forced
+    """
+    return bool(
+        os.getenv("CI")
+        or os.getenv("GITHUB_ACTIONS")
+        or os.getenv("FORCE_COLOR")
+        or os.getenv("PY_COLORS")
+        or os.getenv("COLORTERM") == "truecolor"
+    )
+
+
+console = Console(width=150, force_terminal=rich_force_colors())
+
+_logger = logging.getLogger("odoo_runbot")
+
+
+@app.callback()
+def _callback(workdir: Path = None, *, verbose: bool = False) -> None:
+    global env  # noqa: PLW0603
+    env = RunbotEnvironment(dict(os.environ), workdir=workdir, verbose=verbose)
+    env.setup_logging_for_runbot(console)
+    env.print_info()
+    if not env.check_ok():
+        raise TypeError(300)
+
+
+@app.command("init")
+def init_runbot() -> None:
+    """Init the current project to run test
+    - Find external addons depedency, install them if needed (git clone + pip install)
+    - Init database, and wait postgresql is ready
+    - Create basic config file for Odoo using $ODOO_RC
+    """
+    current_project_key = f"ADDONS_LOCAL_{env.abs_curr_dir.name.upper()}"
+    project_config = RunbotToolConfig.from_env(env)
+    _logger.info(
+        "Add current project %s=%s ? %s",
+        current_project_key,
+        str(env.abs_curr_dir),
+        project_config.include_current_project,
+    )
+    if project_config.include_current_project:
+        env.environ[current_project_key] = str(env.abs_curr_dir)
+    info, addons = runbot_init.show_addons(env)
+    console.print(info)
+    runbot_init.install_addons(addons)
+    console.print(runbot_init.init_database(env))
+    console.print(runbot_init.init_config(env))
+
+
+@app.command("run", help="""Run the steps after initializing the project""")
+def run_runbot(
+    step_name: Annotated[str, typer.Option(envvar="RUNBOT_STEP")] = "all",
+    only_action: Annotated[StepAction, typer.Option()] = None,
+) -> None:
+    """Run the steps after initializing the project
+
+    You can filter the step you want to run with the `step_name` argument.
+
+    warning:
+        If no step is run, then mangono-runbot will exit with code 100.
+
+    Args:
+        step_name:  The step to run, if None, are "all" then no filter is applied
+        only_action:  Choose wich action to only run
+
+    """
+    if not Path(env.ODOO_RC).exists():
+        _logger.error("[red] Please run `mangono-runbot init config` to create your odoo config file")
+        raise typer.Abort
+
+    project_config = RunbotToolConfig.from_env(env)
+    steps_to_run = []
+    for step in project_config.steps:
+        if only_action is not None and step.action != only_action:
+            _logger.debug("Filter step %s, only want action=%s", step.name, only_action.name)
+            continue
+        if step_name and step_name not in (None, "all", step.name):
+            _logger.info("Skip warmup %s", step.name)
+            continue
+        steps_to_run.append(step)
+
+    step_runner = StepRunner(env)
+    step_runner.setup_warning_filter(project_config.warning_filters)
+    step_runner.setup_odoo()
+    for step in steps_to_run:
+        console.print(RichStep(step))
+        rc = step_runner.execute(step)
+        if rc:
+            console.print(f"[red] Step {step.name} {bool_to_emoji(False)}")  # noqa: FBT003
+            raise typer.Exit(rc)
+        console.print(f"[green] Step {step.name} {bool_to_emoji(True)}")  # noqa: FBT003
+
+    if not step_runner.has_run:
+        raise typer.Exit(100)
+
+
+def bool_to_emoji(v: bool) -> str:  # noqa: FBT001
+    return ":heavy_check_mark:" if v else ":x:"
+
+
+ASCII_ART_MANGONO = """
+                          [medium_spring_green]      %    %             [/]
+                          [medium_spring_green]    %%%   %%%   %%%%%%%  [/]
+                          [medium_spring_green]  %%%%   %%%   %%%    %%%[/]
+                          [medium_spring_green]%%%%     %%%   %%     %%%[/]
+                          [medium_spring_green]  %%%%   %%%   %%%    %%%[/]
+                          [medium_spring_green]    %%%   %%%   %%%%%%%  [/]
+                          [medium_spring_green]      %    %             [/]
+
+          @@@    @@@@   @@@@    @@@   @@   @@@@@@    @@@@@@   @@@   @@   @@@@@@    [medium_spring_green]%%%[/]
+          @@@@   @@@@   @@@@    @@@@  @@  @@   @@@  @@@  @@@@ @@@@  @@  @@@  @@@   [medium_spring_green]  %%%[/]
+          @@@@@ @@@@@  @@@ @@   @@ @@ @@ @@@ @@@@@@@@@    @@@ @@ @@ @@ @@@    @@@  [medium_spring_green]   %%%%[/]
+          @@@ @@@ @@@ @@@@@@@@  @@  @@@@  @@    @@  @@@  @@@@ @@  @@@@  @@@  @@@   [medium_spring_green]  %%%[/]
+          @@@ @@@ @@@ @@    @@@ @@   @@@   @@@@@@    @@@@@@   @@   @@@   @@@@@@    [medium_spring_green]%%%[/]
+
+             @ @ @@ @  @@ @ @ @@@ @ @@  @@ @@@ @ @  [medium_spring_green]%%%%%%%%%[/]
+                                                    [medium_spring_green]%%%%%%%%%[/]
+"""
+
+
+@app.command("diag")
+def diag_print() -> None:
+    console.print(ASCII_ART_MANGONO)
+    console.print("Main Author: Alexis Pasquier")
+    t_warn = Table(
+        "Name",
+        "Action",
+        "Message Filter",
+        "Wanted Category",
+        title="py.warnings Filters",
+    )
+    project_config = RunbotToolConfig.from_env(env)
+    if project_config.warning_filters:
+        for log_filter in project_config.warning_filters:
+            t_warn.add_row(
+                log_filter.name,
+                log_filter.action,
+                f"r'{log_filter.message}'",
+                log_filter.category,
+            )
+    else:
+        t_warn.add_row("[DEFAULT] No py.warnings allowed", "always", ".*", "Warnings", "*")
+    console.print(t_warn)
+    table = Table(
+        "Step",
+        "Module",
+        "Run tests",
+        "Activate Coverage",
+        "Tags to test",
+        "Logger filter",
+        title="Steps",
+    )
+    for step in project_config.steps:
+        table.add_row(
+            step.name,
+            (step.modules and ",".join(step.modules)) or str(step.modules),
+            step.action.name,
+            bool_to_emoji(step.action == StepAction.TESTS and step.coverage),
+            ",".join(step.test_tags),
+            ",".join([f.name for f in step.log_filters]),
+        )
+    console.print(table)
+
+    for step in project_config.steps:
+        console.print(RichStep(step))
+
+
+class RichStep:
+    def __init__(self, step: RunbotStepConfig) -> None:
+        self.step = step
+
+    def __rich_console__(self, console: Console, options: ConsoleOptions) -> RenderResult:
+        t_log = Table("Name", "Regex", "Match", "logger", title="Log Filters", width=146)
+        if self.step.log_filters:
+            for log_filter in self.step.log_filters:
+                match_txt = f"Between {log_filter.min_match} and {log_filter.max_match}"
+                if log_filter.min_match == log_filter.max_match:
+                    match_txt = f"Exactly {log_filter.min_match}"
+                t_log.add_row(
+                    log_filter.name,
+                    f"r'{log_filter.regex}'",
+                    match_txt,
+                    log_filter.logger + " (and all child logger)",
+                )
+        else:
+            t_log.add_row("[DEFAULT] No log allowed", ".*", "Exactly 0", "odoo (and all child logger)")
+
+        yield Panel(
+            Group(
+                f"Install : {self.step.modules}",
+                f"Action : {self.step.action.name}",
+                f"Activate Coverage: {bool_to_emoji(self.step.action == StepAction.TESTS and self.step.coverage)}",
+                f"Allow warnings: {bool_to_emoji(self.step.allow_warnings)}",
+                f"Test Tags: {self.step.test_tags}",
+                t_log,
+            ),
+            style="green" if self.step.action == StepAction.TESTS else "dodger_blue2",
+            title=self.step.name,
+        )
+
+
+if __name__ == "__main__":
+    app()