runem 0.4.0__py3-none-any.whl → 0.6.0__py3-none-any.whl

scripts/test_hooks/py.py

@@ -0,0 +1,292 @@
+import pathlib
+import shutil
+import typing
+
+from typing_extensions import Unpack
+
+from runem.log import log
+from runem.run_command import RunCommandUnhandledError, run_command
+from runem.types import FilePathList, JobKwargs, JobName, JobReturnData, Options
+
+
+def _job_py_code_reformat(
+    **kwargs: Unpack[JobKwargs],
+) -> None:
+    """Runs python formatting code in serial order as one influences the other."""
+    label: JobName = kwargs["label"]
+    options: Options = kwargs["options"]
+    python_files: FilePathList = kwargs["file_list"]
+
+    # put into 'check' mode if requested on the command line
+    extra_args = []
+    docformatter_extra_args = [
+        "--in-place",
+    ]
+    if options["check-only"]:
+        extra_args.append("--check")
+        docformatter_extra_args = []  # --inplace is not compatible with --check
+
+    if options["isort"]:
+        isort_cmd = [
+            "python3",
+            "-m",
+            "isort",
+            "--profile",
+            "black",
+            "--treat-all-comment-as-code",
+            *extra_args,
+            *python_files,
+        ]
+        kwargs["label"] = f"{label} isort"
+        run_command(cmd=isort_cmd, **kwargs)
+
+    if options["black"]:
+        black_cmd = [
+            "python3",
+            "-m",
+            "black",
+            *extra_args,
+            *python_files,
+        ]
+        kwargs["label"] = f"{label} black"
+        run_command(cmd=black_cmd, **kwargs)
+
+    if options["docformatter"]:
+        docformatter_cmd = [
+            "python3",
+            "-m",
+            "docformatter",
+            "--wrap-summaries",
+            "88",
+            "--wrap-descriptions",
+            "88",
+            *docformatter_extra_args,
+            *extra_args,
+            *python_files,
+        ]
+        allowed_exits: typing.Tuple[int, ...] = (
+            0,  # no work/change required
+            3,  # no errors, but code was reformatted
+        )
+        if options["check-only"]:
+            # in check it is ONLY ok if no work/change was required
+            allowed_exits = (0,)
+        kwargs["label"] = f"{label} docformatter"
+        run_command(
+            cmd=docformatter_cmd,
+            ignore_fails=False,
+            valid_exit_ids=allowed_exits,
+            **kwargs,
+        )
+
+
+def _job_py_pylint(
+    **kwargs: Unpack[JobKwargs],
+) -> None:
+    python_files: FilePathList = kwargs["file_list"]
+    root_path: pathlib.Path = kwargs["root_path"]
+
+    pylint_cfg = root_path / ".pylint.rc"
+    if not pylint_cfg.exists():
+        raise RuntimeError(f"PYLINT Config not found at '{pylint_cfg}'")
+
+    pylint_cmd = [
+        "python3",
+        "-m",
+        "pylint",
+        "-j1",
+        "--score=n",
+        f"--rcfile={pylint_cfg}",
+        *python_files,
+    ]
+    run_command(cmd=pylint_cmd, **kwargs)
+
+
+def _job_py_flake8(
+    **kwargs: Unpack[JobKwargs],
+) -> None:
+    python_files: FilePathList = kwargs["file_list"]
+    root_path: pathlib.Path = kwargs["root_path"]
+    flake8_rc = root_path / ".flake8"
+    if not flake8_rc.exists():
+        raise RuntimeError(f"flake8 config not found at '{flake8_rc}'")
+
+    flake8_cmd = [
+        "python3",
+        "-m",
+        "flake8",
+        *python_files,
+    ]
+    run_command(cmd=flake8_cmd, **kwargs)
+
+
+def _job_py_mypy(
+    **kwargs: Unpack[JobKwargs],
+) -> None:
+    python_files: FilePathList = kwargs["file_list"]
+    mypy_cmd = ["python3", "-m", "mypy", *python_files]
+    output = run_command(cmd=mypy_cmd, **kwargs)
+    if "mypy.ini" in output or "Not a boolean:" in output:
+        raise RunCommandUnhandledError(f"runem: mypy mis-config detected: {output}")
+
+
+def _delete_old_coverage_reports(root_path: pathlib.Path) -> None:
+    """To avoid false-positives on coverage we delete the coverage report files."""
+    old_coverage_report_files: typing.List[pathlib.Path] = list(
+        root_path.glob(".coverage_report*")
+    )
+    for old_coverage_report in old_coverage_report_files:
+        old_coverage_report.unlink()
+
+
+def _job_py_pytest(  # noqa: C901 # pylint: disable=too-many-branches,too-many-statements
+    **kwargs: Unpack[JobKwargs],
+) -> JobReturnData:
+    label: JobName = kwargs["label"]
+    options: Options = kwargs["options"]
+    procs: int = kwargs["procs"]
+    root_path: pathlib.Path = kwargs["root_path"]
+
+    reports: JobReturnData = {"reportUrls": []}
+    # TODO: use pytest.ini config pytest
+    # pytest_cfg = root_path / ".pytest.ini"
+    # assert pytest_cfg.exists()
+
+    if not options["unit-test"]:
+        # we've disabled unit-testing on the cli
+        return reports
+
+    if options["profile"]:
+        raise RuntimeError("not implemented - see run_test.sh for how to implement")
+
+    pytest_path = root_path / "tests"
+    assert pytest_path.exists()
+
+    coverage_switches: typing.List[str] = []
+    coverage_cfg = root_path / ".coveragerc"
+    if options["coverage"]:
+        _delete_old_coverage_reports(root_path)
+        assert coverage_cfg.exists()
+        coverage_switches = [
+            "--cov=.",
+            f"--cov-config={str(coverage_cfg)}",
+            "--cov-append",
+            "--no-cov-on-fail",  # do not show coverage terminal report when we fail
+            "--cov-fail-under=0",  # we do coverage filing later
+        ]
+
+    # TODO: do we want to disable logs on pytest runs?
+    # "PYTEST_LOG":"--no-print-logs --log-level=CRITICAL" ;
+
+    threading_switches: typing.List[str] = []
+    if procs == -1:
+        threading_switches = ["-n", "auto"]
+
+    verbose_switches: typing.List[str] = []
+    if "verbose" in kwargs and kwargs["verbose"]:
+        verbose_switches = ["-vvv"]
+
+    profile_switches: typing.List[str] = []
+    cmd_pytest = [
+        "python3",
+        "-m",
+        "pytest",
+        "--color=yes",
+        *threading_switches,
+        # "-c",
+        # str(pytest_cfg),
+        *coverage_switches,
+        "--failed-first",
+        "--exitfirst",
+        *profile_switches,
+        *verbose_switches,
+        str(pytest_path),
+    ]
+
+    env_overrides: typing.Dict[str, str] = {}
+
+    kwargs["label"] = f"{label} pytest"
+    run_command(
+        cmd=cmd_pytest,
+        env_overrides=env_overrides,
+        **kwargs,
+    )
+
+    if options["coverage"]:
+        reports_dir: pathlib.Path = root_path / "reports"
+        reports_dir.mkdir(parents=False, exist_ok=True)
+        coverage_output_dir: pathlib.Path = reports_dir / "coverage_python"
+        if coverage_output_dir.exists():
+            shutil.rmtree(coverage_output_dir)
+        coverage_output_dir.mkdir(exist_ok=True)
+        if kwargs["verbose"]:
+            log("COVERAGE: Collating coverage")
+        # first generate the coverage report for our gitlab cicd
+        gen_cobertura_coverage_report_cmd = [
+            "python3",
+            "-m",
+            "coverage",
+            "xml",
+            "-o",
+            str(coverage_output_dir / "cobertura.xml"),
+            f"--rcfile={str(coverage_cfg)}",
+        ]
+        kwargs["label"] = f"{label} coverage cobertura"
+        run_command(cmd=gen_cobertura_coverage_report_cmd, **kwargs)
+
+        # then a html report
+        gen_html_coverage_report_cmd = [
+            "python3",
+            "-m",
+            "coverage",
+            "html",
+            f"--rcfile={str(coverage_cfg)}",
+        ]
+        kwargs["label"] = f"{label} coverage html"
+        run_command(cmd=gen_html_coverage_report_cmd, **kwargs)
+
+        # then a standard command-line report that causes the tests to fail.
+        gen_cli_coverage_report_cmd = [
+            "python3",
+            "-m",
+            "coverage",
+            "report",
+            "--fail-under=100",
+            f"--rcfile={str(coverage_cfg)}",
+        ]
+        kwargs["label"] = f"{label} coverage cli"
+        report_html = coverage_output_dir / "index.html"
+        report_cobertura = coverage_output_dir / "cobertura.xml"
+        try:
+            run_command(cmd=gen_cli_coverage_report_cmd, **kwargs)
+        except BaseException:
+            print()
+            print(report_html)
+            print(report_cobertura)
+            raise
+        assert coverage_output_dir.exists(), coverage_output_dir
+        assert report_html.exists(), report_html
+        assert report_cobertura.exists(), report_cobertura
+        reports["reportUrls"].append(("coverage html", report_html))
+        reports["reportUrls"].append(("coverage cobertura", report_cobertura))
+        if kwargs["verbose"]:
+            log("COVERAGE: cli output done")
+    return reports
+
+
+def _install_python_requirements(
+    **kwargs: Unpack[JobKwargs],
+) -> None:
+    options: Options = kwargs["options"]
+    if not (options["install-deps"]):
+        # not enabled
+        return
+    cmd = [
+        "python3",
+        "-m",
+        "pip",
+        "install",
+        "-e",
+        ".[tests]",
+    ]
+    run_command(cmd=cmd, **kwargs)

scripts/test_hooks/runem_hooks.py

@@ -0,0 +1,19 @@
+import pathlib
+from datetime import timedelta
+
+from typing_extensions import Unpack
+
+from runem.types import HookKwargs
+
+
+def _on_exit_hook(
+    **kwargs: Unpack[HookKwargs],
+) -> None:
+    """A noddy hook."""
+    assert "wall_clock_time_saved" in kwargs
+    wall_clock_time_saved: timedelta = kwargs["wall_clock_time_saved"]
+    root_path: pathlib.Path = pathlib.Path(__file__).parent.parent.parent
+    assert (root_path / ".runem.yml").exists()
+    times_log: pathlib.Path = root_path / ".times.log"
+    with times_log.open("a", encoding="utf-8") as file:
+        file.write(f"{str(wall_clock_time_saved.total_seconds())}\n")

scripts/test_hooks/yarn.py

@@ -0,0 +1,48 @@
+import pathlib
+
+from typing_extensions import Unpack
+
+from runem.run_command import run_command
+from runem.types import JobKwargs, Options
+
+
+def _job_yarn_deps(
+    **kwargs: Unpack[JobKwargs],
+) -> None:
+    """Installs the yarn deps."""
+    options: Options = kwargs["options"]
+
+    install_requested = options["install-deps"]
+    if not (install_requested):
+        root_path: pathlib.Path = kwargs["root_path"]
+        if (root_path / "node_modules").exists():
+            # An install was not requested, nor required.
+            return
+
+    install_cmd = [
+        "yarn",
+        "install",
+    ]
+
+    run_command(cmd=install_cmd, **kwargs)
+
+
+def _job_prettier(
+    **kwargs: Unpack[JobKwargs],
+) -> None:
+    """Runs prettifier on files, including json and maybe yml file.
+
+    TODO: connect me up!
+    """
+    options: Options = kwargs["options"]
+    command_variant = "pretty"
+    if options["check-only"]:
+        command_variant = "prettyCheck"
+
+    pretty_cmd = [
+        "yarn",
+        "run",
+        command_variant,
+    ]
+
+    run_command(cmd=pretty_cmd, **kwargs)

tests/cli/test_initialise_options.py

@@ -0,0 +1,105 @@
+import pathlib
+from argparse import Namespace
+from collections import defaultdict
+from typing import Dict
+from unittest.mock import MagicMock
+
+import pytest
+
+from runem.command_line import initialise_options
+from runem.config_metadata import ConfigMetadata
+from runem.types.runem_config import JobConfig, PhaseGroupedJobs
+
+Options = Dict[str, bool]
+
+
+@pytest.fixture(name="config_metadata")
+def config_metadata_fixture() -> ConfigMetadata:
+    config_file_path = pathlib.Path(__file__).parent / ".runem.yml"
+    expected_job: JobConfig = {
+        "addr": {
+            "file": "test_config_parse.py",
+            "function": "test_parse_config",
+        },
+        "label": "dummy job label",
+        "when": {
+            "phase": "dummy phase 1",
+            "tags": {"dummy tag 1", "dummy tag 2"},
+        },
+    }
+    expected_jobs: PhaseGroupedJobs = defaultdict(list)
+    expected_jobs["dummy phase 1"] = [
+        expected_job,
+    ]
+    return ConfigMetadata(
+        cfg_filepath=config_file_path,
+        phases=("dummy phase 1",),
+        options_config=(
+            {"name": "option1", "default": True},
+            {"name": "option2", "default": False},
+            {"name": "option3", "default": True},
+            {"name": "option4", "default": False},
+        ),
+        file_filters={
+            # "dummy tag": {
+            #     "tag": "dummy tag",
+            #     "regex": ".*1.txt",  # should match just one file
+            # }
+        },
+        hook_manager=MagicMock(),
+        jobs=expected_jobs,
+        all_job_names=set(("dummy job label",)),
+        all_job_phases=set(("dummy phase 1",)),
+        all_job_tags=set(
+            (
+                "dummy tag 2",
+                "dummy tag 1",
+            )
+        ),
+    )
+
+
+def test_initialise_options_no_overrides(config_metadata: ConfigMetadata) -> None:
+    args = Namespace(overrides_on=[], overrides_off=[])
+    options = initialise_options(config_metadata, args)
+    assert options == {
+        "option1": True,
+        "option2": False,
+        "option3": True,
+        "option4": False,
+    }
+
+
+def test_initialise_options_overrides_on(config_metadata: ConfigMetadata) -> None:
+    args = Namespace(overrides_on=["option2", "option4"], overrides_off=[])
+    options = initialise_options(config_metadata, args)
+    assert options == {
+        "option1": True,
+        "option2": True,
+        "option3": True,
+        "option4": True,
+    }
+
+
+def test_initialise_options_overrides_off(config_metadata: ConfigMetadata) -> None:
+    args = Namespace(overrides_on=[], overrides_off=["option1", "option3"])
+    options = initialise_options(config_metadata, args)
+    assert options == {
+        "option1": False,
+        "option2": False,
+        "option3": False,
+        "option4": False,
+    }
+
+
+def test_initialise_options_overrides_on_and_off(
+    config_metadata: ConfigMetadata,
+) -> None:
+    args = Namespace(overrides_on=["option2"], overrides_off=["option1"])
+    options = initialise_options(config_metadata, args)
+    assert options == {
+        "option1": False,
+        "option2": True,
+        "option3": True,
+        "option4": False,
+    }

tests/data/help_output.3.10.txt

@@ -0,0 +1,55 @@
+runem: WARNING: no phase found for 'echo "hello world!"', using 'dummy phase 1'
+usage: -c [-H] [--jobs JOBS [JOBS ...]] [--not-jobs JOBS_EXCLUDED [JOBS_EXCLUDED ...]] [--phases PHASES [PHASES ...]] [--not-phases PHASES_EXCLUDED [PHASES_EXCLUDED ...]] [--tags TAGS [TAGS ...]] [--not-tags TAGS_EXCLUDED [TAGS_EXCLUDED ...]] [--dummy-option-1---complete-option] [--no-dummy-option-1---complete-option] [--dummy-option-2---minimal] [--no-dummy-option-2---minimal] [--call-graphs | --no-call-graphs] [-f | --modified-files | --no-modified-files] [-h | --git-head-files | --no-git-head-files] [--always-files ALWAYS_FILES [ALWAYS_FILES ...]] [--git-files-since-branch GIT_SINCE_BRANCH] [--procs PROCS] [--root ROOT_DIR] [--root-show | --no-root-show] [--silent | --no-silent | -s] [--spinner | --no-spinner] [--verbose | --no-verbose] [--version | --no-version | -v]
+
+Runs the Lursight Lang test-suite
+
+[TEST_REPLACED_OPTION_HEADER]
+  -H, --help            show this help message and exit
+  --call-graphs, --no-call-graphs
+  -f, --modified-files, --no-modified-files
+                        only use files that have changed (default: False)
+  -h, --git-head-files, --no-git-head-files
+                        fast run of files (default: False)
+  --always-files ALWAYS_FILES [ALWAYS_FILES ...]
+                        list of paths/files to always check (overriding -f/-h), if the path matches the filter regex and if file-paths exist
+  --git-files-since-branch GIT_SINCE_BRANCH
+                        Get the list of paths/files changed between a branch, e.g., since 'origin/main'. Useful for checking files changed before pushing.
+  --procs PROCS, -j PROCS
+                        the number of concurrent test jobs to run, -1 runs all test jobs at the same time ([TEST_REPLACED_CORES] cores available)
+  --root ROOT_DIR       which dir to use as the base-dir for testing, defaults to directory containing the config '[TEST_REPLACED_DIR]'
+  --root-show, --no-root-show
+                        show the root-path of runem and exit (default: False)
+  --silent, --no-silent, -s
+                        Whether to show warning messages or not. (default: False)
+  --spinner, --no-spinner
+                        Whether to show the progress spinner or not. Helps reduce log-spam in ci/cd. (default: True)
+  --verbose, --no-verbose
+                        runs runem in in verbose mode, and streams jobs stdout/stderr to console (default: False)
+  --version, --no-version, -v
+                        show the version of runem and exit (default: False)
+
+jobs:
+  --jobs JOBS [JOBS ...]
+                        List of job-names to run the given jobs. Other filters will modify this list. Defaults to 'dummy job label 1', 'dummy job label 2', 'echo "hello world!"', 'hello world'
+  --not-jobs JOBS_EXCLUDED [JOBS_EXCLUDED ...]
+                        List of job-names to NOT run. Defaults to empty. Available options are: 'dummy job label 1', 'dummy job label 2', 'echo "hello world!"', 'hello world'
+
+phases:
+  --phases PHASES [PHASES ...]
+                        Run only the phases passed in, and can be used to change the phase order. Phases are run in the order given. Defaults to 'dummy phase 1', 'dummy phase 2'.
+  --not-phases PHASES_EXCLUDED [PHASES_EXCLUDED ...]
+                        List of phases to NOT run. This option does not change the phase run order. Options are '['dummy phase 1', 'dummy phase 2']'.
+
+tags:
+  --tags TAGS [TAGS ...]
+                        Only run jobs with the given tags. Defaults to '['dummy tag 1', 'dummy tag 2', 'tag only on job 1', 'tag only on job 2']'.
+  --not-tags TAGS_EXCLUDED [TAGS_EXCLUDED ...]
+                        Removes one or more tags from the list of job tags to be run. Options are '['dummy tag 1', 'dummy tag 2', 'tag only on job 1', 'tag only on job 2']'.
+
+job-param overrides:
+  --dummy-option-1---complete-option, --dummy option 1 multi alias 1, --dummy option 1 multi alias 2, -x, --dummy option alias 1
+                        a dummy option description
+  --no-dummy-option-1---complete-option, --no-dummy option 1 multi alias 1, --no-dummy option 1 multi alias 2, --no-x, --no-dummy option alias 1
+                        turn off a dummy option description
+  --dummy-option-2---minimal
+  --no-dummy-option-2---minimal

tests/data/help_output.3.11.txt

@@ -0,0 +1,55 @@
+runem: WARNING: no phase found for 'echo "hello world!"', using 'dummy phase 1'
+usage: -c [-H] [--jobs JOBS [JOBS ...]] [--not-jobs JOBS_EXCLUDED [JOBS_EXCLUDED ...]] [--phases PHASES [PHASES ...]] [--not-phases PHASES_EXCLUDED [PHASES_EXCLUDED ...]] [--tags TAGS [TAGS ...]] [--not-tags TAGS_EXCLUDED [TAGS_EXCLUDED ...]] [--dummy-option-1---complete-option] [--no-dummy-option-1---complete-option] [--dummy-option-2---minimal] [--no-dummy-option-2---minimal] [--call-graphs | --no-call-graphs] [-f | --modified-files | --no-modified-files] [-h | --git-head-files | --no-git-head-files] [--always-files ALWAYS_FILES [ALWAYS_FILES ...]] [--git-files-since-branch GIT_SINCE_BRANCH] [--procs PROCS] [--root ROOT_DIR] [--root-show | --no-root-show] [--silent | --no-silent | -s] [--spinner | --no-spinner] [--verbose | --no-verbose] [--version | --no-version | -v]
+
+Runs the Lursight Lang test-suite
+
+[TEST_REPLACED_OPTION_HEADER]
+  -H, --help            show this help message and exit
+  --call-graphs, --no-call-graphs
+  -f, --modified-files, --no-modified-files
+                        only use files that have changed
+  -h, --git-head-files, --no-git-head-files
+                        fast run of files
+  --always-files ALWAYS_FILES [ALWAYS_FILES ...]
+                        list of paths/files to always check (overriding -f/-h), if the path matches the filter regex and if file-paths exist
+  --git-files-since-branch GIT_SINCE_BRANCH
+                        Get the list of paths/files changed between a branch, e.g., since 'origin/main'. Useful for checking files changed before pushing.
+  --procs PROCS, -j PROCS
+                        the number of concurrent test jobs to run, -1 runs all test jobs at the same time ([TEST_REPLACED_CORES] cores available)
+  --root ROOT_DIR       which dir to use as the base-dir for testing, defaults to directory containing the config '[TEST_REPLACED_DIR]'
+  --root-show, --no-root-show
+                        show the root-path of runem and exit
+  --silent, --no-silent, -s
+                        Whether to show warning messages or not.
+  --spinner, --no-spinner
+                        Whether to show the progress spinner or not. Helps reduce log-spam in ci/cd.
+  --verbose, --no-verbose
+                        runs runem in in verbose mode, and streams jobs stdout/stderr to console
+  --version, --no-version, -v
+                        show the version of runem and exit
+
+jobs:
+  --jobs JOBS [JOBS ...]
+                        List of job-names to run the given jobs. Other filters will modify this list. Defaults to 'dummy job label 1', 'dummy job label 2', 'echo "hello world!"', 'hello world'
+  --not-jobs JOBS_EXCLUDED [JOBS_EXCLUDED ...]
+                        List of job-names to NOT run. Defaults to empty. Available options are: 'dummy job label 1', 'dummy job label 2', 'echo "hello world!"', 'hello world'
+
+phases:
+  --phases PHASES [PHASES ...]
+                        Run only the phases passed in, and can be used to change the phase order. Phases are run in the order given. Defaults to 'dummy phase 1', 'dummy phase 2'.
+  --not-phases PHASES_EXCLUDED [PHASES_EXCLUDED ...]
+                        List of phases to NOT run. This option does not change the phase run order. Options are '['dummy phase 1', 'dummy phase 2']'.
+
+tags:
+  --tags TAGS [TAGS ...]
+                        Only run jobs with the given tags. Defaults to '['dummy tag 1', 'dummy tag 2', 'tag only on job 1', 'tag only on job 2']'.
+  --not-tags TAGS_EXCLUDED [TAGS_EXCLUDED ...]
+                        Removes one or more tags from the list of job tags to be run. Options are '['dummy tag 1', 'dummy tag 2', 'tag only on job 1', 'tag only on job 2']'.
+
+job-param overrides:
+  --dummy-option-1---complete-option, --dummy option 1 multi alias 1, --dummy option 1 multi alias 2, -x, --dummy option alias 1
+                        a dummy option description
+  --no-dummy-option-1---complete-option, --no-dummy option 1 multi alias 1, --no-dummy option 1 multi alias 2, --no-x, --no-dummy option alias 1
+                        turn off a dummy option description
+  --dummy-option-2---minimal
+  --no-dummy-option-2---minimal