runem 0.2.0__tar.gz → 0.4.0__tar.gz

{runem-0.2.0 → runem-0.4.0}/HISTORY.md

@@ -4,6 +4,50 @@ Changelog
 
 (unreleased)
 ------------
+- Merge pull request #67 from lursight/feat/prettier_logging. [Frank
+  Harrison]
+
+  feat(rich): prettier logging with rich
+- Feat(rich): disable markup handling. [Frank Harrison]
+
+  We got errors running logging through rich in CiCd where
+  [/path/to/thing] was being seen as rich markup, specifically as a rich
+  markup close-tag.
+
+  This stops parsing strings as markup and therefore works around the
+  error.
+- Feat(rich): prettier logging with rich. [Frank Harrison]
+
+  It also makes the logging more useful in different contexts by removing
+  tabs and so on.
+
+
+0.3.0 (2024-12-03)
+------------------
+- Release: version 0.3.0 🚀 [Frank Harrison]
+- Merge pull request #66 from
+  lursight/feat/option_switches_in_simple_commands. [Frank Harrison]
+
+  Feat/option switches in simple commands
+- Chore(pytest): force colour output in pytest, makes it easier to read.
+  [Frank Harrison]
+- Feat(option-switches): adds ability to turn on/off switches in simple
+  commands. [Frank Harrison]
+
+  THis is pretty noddy for now, but it means we can do more things like
+  run `black` or `ruff` with `--check` enabled... as well as some other
+  switches.
+- Merge pull request #65 from lursight/feat/error_on_misplaced_config.
+  [Frank Harrison]
+
+  feat(where-errors): errors when 'tags' and 'phase' are not under 'where'
+- Feat(where-errors): errors when 'tags' and 'phase' are not under
+  'where' [Frank Harrison]
+
+
+0.2.0 (2024-11-21)
+------------------
+- Release: version 0.2.0 🚀 [Frank Harrison]
 - Merge pull request #63 from
   lursight/dependabot/github_actions/actions/cache-4. [Frank Harrison]
 

{runem-0.2.0 → runem-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: runem
-Version: 0.2.0
+Version: 0.4.0
 Summary: Awesome runem created by lursight
 Home-page: https://github.com/lursight/runem/
 Author: lursight

runem-0.4.0/runem/VERSION

@@ -0,0 +1 @@
+0.4.0

runem-0.4.0/runem/blocking_print.py

@@ -0,0 +1,62 @@
+import time
+import typing
+
+from rich.console import Console
+
+
+def _reset_console() -> Console:
+    """Sets the nice user-facing console.
+
+    This function exists so we can reset the output from tests.
+    """
+    global RICH_CONSOLE  # pylint: disable=global-statement
+
+    RICH_CONSOLE = Console(
+        log_path=False,  # Do NOT print the source path.
+        markup=False,  # Do NOT print markup e.g. `[blink]Don't Panic![/blink]`.
+    )
+    return RICH_CONSOLE
+
+
+# Overridden in tests.
+RICH_CONSOLE: Console = _reset_console()
+
+
+def _reset_console_for_tests() -> None:
+    """Overrides the console output with more deterministic version.
+
+    ... so we can have deterministic tests.
+    """
+    global RICH_CONSOLE  # pylint: disable=global-statement
+    RICH_CONSOLE = Console(
+        log_path=False,  # Do NOT print the source path.
+        log_time=False,  # Do not prefix with log time e.g. `[time] log message`.
+        markup=False,  # Do NOT print markup e.g. `[blink]Don't Panic![/blink]`.
+        width=999,  # A very wide width.
+    )
+
+
+def blocking_print(
+    msg: str = "",
+    end: typing.Optional[str] = None,
+    max_retries: int = 5,
+    sleep_time_s: float = 0.1,
+) -> None:
+    """Attempt to print a message, retrying on BlockingIOError.
+
+    Sometimes in long-lasting jobs, that produce lots of output, we hit
+    BlockingIOError where we can't print to screen because the buffer is full or
+    already being written to (for example), i.e. the `print` would need to be a
+    'blocking' call, which it is not.
+    """
+    if end is None:
+        end = "\n"
+    for _ in range(max_retries):
+        try:
+            RICH_CONSOLE.print(msg, end=end)
+            break  # Success, exit the retry loop
+        except BlockingIOError:
+            time.sleep(sleep_time_s)  # Wait a bit for the buffer to clear
+    else:
+        # Optional: handle the failure to print after all retries
+        pass

{runem-0.2.0 → runem-0.4.0}/runem/job.py

@@ -11,6 +11,12 @@ class NoJobName(ValueError):
     pass
 
 
+class BadWhenConfigLocation(ValueError):
+    """The job-config does not contain a label and can't be coerced to crate one."""
+
+    pass
+
+
 class Job:
     """A class with utility functions for jobs.
 
@@ -27,6 +33,16 @@ class Job:
 
         TODO: make a non-static member function
         """
+        if "tags" in job:
+            raise BadWhenConfigLocation(
+                "'tags' should be listed inside the 'when' config for jobs"
+            )
+
+        if "phase" in job:
+            raise BadWhenConfigLocation(
+                "'phase' should be listed inside the 'when' config for jobs"
+            )
+
         if "when" not in job or "tags" not in job["when"]:
             # handle the special case where we have No tags
             return None

{runem-0.2.0 → runem-0.4.0}/runem/job_runner_simple_command.py

@@ -3,8 +3,10 @@ import typing
 
 from typing_extensions import Unpack
 
+from runem.config_metadata import ConfigMetadata
 from runem.run_command import run_command
 from runem.types.common import FilePathList
+from runem.types.options import OptionsWritable
 from runem.types.runem_config import JobConfig
 from runem.types.types_jobs import AllKwargs
 
@@ -36,8 +38,24 @@ def job_runner_simple_command(
             "{file_list}", " ".join(file_list_with_quotes)
         )
 
+    config_metadata: ConfigMetadata = kwargs["config_metadata"]
+    options: OptionsWritable = config_metadata.options
+    command_string_options: str = command_string_files
+    for name, value in options.items():
+        # For now, just pass `--option-name`, `--check` or similar to the
+        # command line. At some point we will want this to be cleverer, but
+        # this will do for now.
+        option_search = f"{{{name}}}"
+        if option_search in command_string_files:
+            replacement = ""
+            if value:
+                replacement = f"--{name}"
+            command_string_options = command_string_options.replace(
+                option_search, replacement
+            )
+
     # use shlex to handle parsing of the command string, a non-trivial problem.
-    cmd = validate_simple_command(command_string_files)
+    cmd = validate_simple_command(command_string_options)
 
     # preserve quotes for consistent handling of strings and avoid the "word
     # splitting" problem for unix-like shells.

{runem-0.2.0 → runem-0.4.0}/runem/runem.py

@@ -36,6 +36,7 @@ from rich.console import Console, ConsoleOptions, ConsoleRenderable, RenderResul
 from rich.spinner import Spinner
 from rich.text import Text
 
+from runem.blocking_print import RICH_CONSOLE
 from runem.command_line import parse_args
 from runem.config import load_project_config, load_user_configs
 from runem.config_metadata import ConfigMetadata
@@ -57,8 +58,6 @@ from runem.types.types_jobs import (
 )
 from runem.utils import printable_set
 
-rich_console = Console()
-
 
 def _determine_run_parameters(argv: typing.List[str]) -> ConfigMetadata:
     """Loads config, parsing cli input and produces the run config.
@@ -143,7 +142,7 @@ def _update_progress(
 
     last_running_jobs_set: typing.Set[str] = set()
 
-    with rich_console.status(spinner):
+    with RICH_CONSOLE.status(spinner):
         while is_running.value:
             running_jobs_set: typing.Set[str] = set(running_jobs.values())
 
@@ -157,7 +156,7 @@ def _update_progress(
                 spinner.text = report
             else:
                 if last_running_jobs_set != running_jobs_set:
-                    rich_console.log(report)
+                    RICH_CONSOLE.log(report)
 
             # Sleep for reduced CPU usage
             time.sleep(0.1)

{runem-0.2.0 → runem-0.4.0}/runem.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: runem
-Version: 0.2.0
+Version: 0.4.0
 Summary: Awesome runem created by lursight
 Home-page: https://github.com/lursight/runem/
 Author: lursight

{runem-0.2.0 → runem-0.4.0}/tests/conftest.py

@@ -5,9 +5,23 @@ import typing
 
 import pytest
 
+from runem.blocking_print import _reset_console, _reset_console_for_tests
+
 FixtureRequest = typing.Any
 
 
+@pytest.fixture(autouse=True)
+def use_test_rich_print(request: FixtureRequest) -> typing.Generator[None, None, None]:
+    """Each test should use the test-version of the `rich` print function.
+
+    This is so we get deterministic output with out timestamps nor auto-wrapping console
+    output.
+    """
+    _reset_console_for_tests()
+    yield
+    _reset_console()
+
+
 # each test runs on cwd to its temp dir
 @pytest.fixture(autouse=True)
 def go_to_tmp_path(request: FixtureRequest) -> typing.Generator[None, None, None]:

{runem-0.2.0 → runem-0.4.0}/tests/test_blocking_print.py

@@ -8,7 +8,7 @@ from runem import blocking_print
 
 @pytest.fixture(name="mock_print")
 def mock_print_fixture() -> typing.Generator[MagicMock, None, None]:
-    with patch("runem.blocking_print.print") as mock_print:
+    with patch("runem.blocking_print.RICH_CONSOLE.print") as mock_print:
         yield mock_print
 
 
@@ -23,7 +23,7 @@ def test_blocking_print_success_first_try(
 ) -> None:
     """Test that blocking_print prints the message successfully on the first try."""
     blocking_print.blocking_print("Test message")
-    mock_print.assert_called_once_with("Test message", end=None)
+    mock_print.assert_called_once_with("Test message", end="\n")
     mock_sleep.assert_not_called()
 
 
@@ -57,7 +57,7 @@ def test_blocking_print_empty_message(
 ) -> None:
     """Test that blocking_print handles an empty message."""
     blocking_print.blocking_print()
-    mock_print.assert_called_once_with("", end=None)
+    mock_print.assert_called_once_with("", end="\n")
     mock_sleep.assert_not_called()
 
 

{runem-0.2.0 → runem-0.4.0}/tests/test_hook_manager.py

@@ -149,7 +149,7 @@ def test_invoke_hooks(do_hooks: bool, hook_man: HookManager) -> None:
     if do_hooks:
         expected_stdout = [
             "runem: hooks: initialising 2 hooks",
-            "runem: hooks:\tinitialising 2 hooks for 'HookName.ON_EXIT'",
+            "runem: hooks:   initialising 2 hooks for 'HookName.ON_EXIT'",
             (
                 "runem: hooks: registered hook for 'HookName.ON_EXIT', have 1: "
                 "<THIS_FILE>._dummy_hook"

{runem-0.2.0 → runem-0.4.0}/tests/test_job.py

@@ -3,7 +3,7 @@ from collections import defaultdict
 
 import pytest
 
-from runem.job import Job, NoJobName
+from runem.job import BadWhenConfigLocation, Job, NoJobName
 from runem.types.common import FilePathList, JobTags
 from runem.types.filters import FilePathListLookup
 from runem.types.runem_config import JobConfig
@@ -27,6 +27,24 @@ def test_get_job_tags(
     assert result == expected_result
 
 
+def test_get_job_tags_bad_tags_path() -> None:
+    """Tests that the 'tags' entry is on 'when' and not on root."""
+    job_config: JobConfig = {  # type: ignore[typeddict-unknown-key]
+        "tags": ["dummy tags"],
+    }
+    with pytest.raises(BadWhenConfigLocation):
+        Job.get_job_tags(job_config)
+
+
+def test_get_job_tags_bad_phase_path() -> None:
+    """Tests that the 'phase' entry is on 'when' and not on root."""
+    job_config: JobConfig = {  # type: ignore[typeddict-unknown-key]
+        "phase": "dummy tags",
+    }
+    with pytest.raises(BadWhenConfigLocation):
+        Job.get_job_tags(job_config)
+
+
 @pytest.fixture(name="file_lists")
 def file_lists_fixture() -> FilePathListLookup:
     """Define a sample file_lists dictionary for testing."""

{runem-0.2.0 → runem-0.4.0}/tests/test_job_runner_simple_command.py

@@ -2,7 +2,7 @@ import io
 import typing
 from contextlib import redirect_stdout
 from pathlib import Path
-from unittest.mock import Mock, patch
+from unittest.mock import ANY, Mock, patch
 
 from runem.config_metadata import ConfigMetadata
 from runem.job import Job
@@ -23,6 +23,7 @@ def test_job_runner_simple_command(mock_run_command: Mock) -> None:
     config_metadata: ConfigMetadata = gen_dummy_config_metadata()
     with io.StringIO() as buf, redirect_stdout(buf):
         ret: None = job_runner_simple_command(  # type: ignore[func-returns-value]
+            config_metadata=config_metadata,
             options=config_metadata.options,  # type: ignore
             file_list=[],
             procs=config_metadata.args.procs,
@@ -38,10 +39,11 @@ def test_job_runner_simple_command(mock_run_command: Mock) -> None:
     assert run_command_stdout.split("\n") == [""]
     mock_run_command.assert_called_once_with(
         cmd=["echo", '"testing job_runner_simple_command"'],
+        config_metadata=ANY,
         file_list=[],
         job={"command": "echo 'testing job_runner_simple_command'"},
         label="echo 'testing job_runner_simple_command'",
-        options={},
+        options=ANY,
         procs=1,
         root_path=Path("."),
         verbose=True,
@@ -71,6 +73,7 @@ def test_job_runner_simple_command_with_file_list(mock_run_command: Mock) -> Non
             file_list=file_list,  # type: ignore[arg-type] # intentional type mismatch
             job=job_config,
             label=Job.get_job_name(job_config),
+            config_metadata=config_metadata,
             options=config_metadata.options,  # type: ignore
             procs=config_metadata.args.procs,
             root_path=Path("."),
@@ -89,10 +92,63 @@ def test_job_runner_simple_command_with_file_list(mock_run_command: Mock) -> Non
             '"file with spaces"',
             '"some option after files"',
         ],
+        config_metadata=ANY,
         file_list=file_list,
         job=job_config,
         label=test_cmd_string,
-        options={},
+        options=ANY,
+        procs=1,
+        root_path=Path("."),
+        verbose=True,
+    )
+
+
+@patch(
+    "runem.job_runner_simple_command.run_command",
+    # return_value=None,
+)
+def test_job_runner_simple_command_with_option(mock_run_command: Mock) -> None:
+    """Tests that option-passing to jobs, pass --option_on but not --option_off."""
+    test_cmd_string: str = (
+        'echo "some option before switch" {option_on} {option_off} "some option after switch"'
+    )
+    job_config: JobConfig = {
+        "command": test_cmd_string,
+    }
+    config_metadata: ConfigMetadata = gen_dummy_config_metadata()
+    file_list: typing.List[typing.Union[str, Path]] = [
+        Path("file1"),
+        "file2",
+        "file with spaces",
+    ]
+    with io.StringIO() as buf, redirect_stdout(buf):
+        ret: None = job_runner_simple_command(  # type: ignore[func-returns-value]
+            file_list=file_list,  # type: ignore[arg-type] # intentional type mismatch
+            job=job_config,
+            label=Job.get_job_name(job_config),
+            config_metadata=config_metadata,
+            options=config_metadata.options,  # type: ignore
+            procs=config_metadata.args.procs,
+            root_path=Path("."),
+            verbose=True,  # config_metadata.args.verbose,
+        )
+        run_command_stdout = buf.getvalue()
+
+    assert ret is None
+    assert run_command_stdout.split("\n") == [""]
+    mock_run_command.assert_called_once_with(
+        cmd=[
+            "echo",
+            '"some option before switch"',
+            "--option_on",
+            # Not this -> "--option_off",
+            '"some option after switch"',
+        ],
+        config_metadata=ANY,
+        file_list=file_list,
+        job=job_config,
+        label=test_cmd_string,
+        options={"option_on": True, "option_off": False},
         procs=1,
         root_path=Path("."),
         verbose=True,

{runem-0.2.0 → runem-0.4.0}/tests/test_run_command.py

@@ -300,7 +300,7 @@ def test_run_command_basic_call_non_standard_exit_ok_code_verbose(
     # check the log output hasn't changed. Update as needed.
     assert run_command_stdout == (
         "runem: running: start: test command: ls\n"
-        "runem: 	allowed return ids are: 3\n"
+        "runem:  allowed return ids are: 3\n"
         "runem: test command: test output\n"
         "runem: running: done: test command: ls\n"
     )