Skip to content

Handle Configuration Traceback #910

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kzscisoft wants to merge 23 commits into
base: dev
Choose a base branch
from
Open

Handle Configuration Traceback #910

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
4ef75c0
Merge pull request #734 from simvue-io/dev
kzscisoft Feb 27, 2025
f7a6261
Merge pull request #743 from simvue-io/dev
kzscisoft Mar 4, 2025
68d5fdb
Merge pull request #750 from simvue-io/dev
kzscisoft Mar 7, 2025
88bdd86
Merge pull request #758 from simvue-io/dev
kzscisoft Mar 7, 2025
28d4e8c
Merge pull request #760 from simvue-io/dev
kzscisoft Mar 7, 2025
eb38356
Merge branch 'v2.1'
kzscisoft Mar 28, 2025
6e483c9
Merge pull request #786 from simvue-io/dev
wk9874 Apr 25, 2025
ef31da8
Merge branch 'v2.1'
kzscisoft Jun 25, 2025
7969be9
Merge branch 'v2.1'
kzscisoft Jun 25, 2025
2d8d3da
Merge branch 'v2.2'
kzscisoft Sep 22, 2025
1501d3f
Merge branch 'v2.2'
kzscisoft Sep 22, 2025
bad14ea
Merge branch 'dev'
kzscisoft Oct 13, 2025
381a4f3
Merge branch 'dev'
kzscisoft Oct 14, 2025
56bfe9c
Merge branch 'dev'
kzscisoft Nov 10, 2025
0253e0f
Merge branch 'dev'
kzscisoft Nov 13, 2025
958cb59
Merge branch 'v2.3'
kzscisoft Dec 11, 2025
0fd0453
🥅 Catch config not found exception in user API
kzscisoft Jan 26, 2026
7d52007
✅ Fix metadata Python env test
kzscisoft Jan 26, 2026
07f1eac
🚸 Add better help on config fail
kzscisoft Jan 26, 2026
07d0803
Added executor process termination to logs and better exception handling
kzscisoft Jan 26, 2026
09396b0
Remove unused test imports
kzscisoft Jan 27, 2026
7cdd88c
Merge branch 'dev' into kzscisoft/handle-config-traceback
kzscisoft Jan 27, 2026
e2eee6c
[skip ci] Updated CHANGELOG
kzscisoft Jan 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Change Log

## Unreleased

- Added graceful handling of configuration errors with a simple error message.
- Added option to specify that exceptions should be raised when using the `simvue.Run` class.
- Ensured that if Simvue itself aborts a process, this abort is recorded in log files.

## [v2.3.0](https://github.com/simvue-io/client/releases/tag/v2.3.0) - 2025-12-11

- Refactored sender functionality introducing new `Sender` class.
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ markers = [
"local: tests of functionality which do not involve a server or writing to an offline cache file",
"object_retrieval: tests relating to retrieval of objects from the server",
"object_removal: tests relating to removal of objects from the server",
"cli: sender CLI tests"
]

[tool.interrogate]
Expand Down
6 changes: 4 additions & 2 deletions simvue/config/user.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
import toml
import semver

from simvue.exception import SimvueUserConfigError

try:
from typing import Self
except ImportError:
Expand Down Expand Up @@ -225,10 +227,10 @@ def fetch(
_run_mode = mode or _config_dict["run"].get("mode") or "online"

if not _server_url and _run_mode != "offline":
raise RuntimeError("No server URL was specified")
raise SimvueUserConfigError("No server URL was specified")

if not _server_token and _run_mode != "offline":
raise RuntimeError("No server token was specified")
raise SimvueUserConfigError("No server token was specified")

_config_dict["server"]["token"] = _server_token
_config_dict["server"]["url"] = _server_url
Expand Down
16 changes: 14 additions & 2 deletions simvue/exception.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,13 @@
"""


class ObjectNotFoundError(Exception):
class SimvueException(Exception):
"""Base exception for all Simvue Python API errors."""

pass


class ObjectNotFoundError(SimvueException):
"""For failure retrieving Simvue object from server"""

def __init__(self, obj_type: str, name: str, extra: str | None = None) -> None:
Expand All @@ -18,7 +24,13 @@ def __init__(self, obj_type: str, name: str, extra: str | None = None) -> None:
)


class SimvueRunError(RuntimeError):
class SimvueRunError(SimvueException, RuntimeError):
"""A special sub-class of runtime error specifically for Simvue run errors"""

pass


class SimvueUserConfigError(SimvueException):
"""Raised when no local Simvue Configuration file has been found."""

pass
8 changes: 8 additions & 0 deletions simvue/executor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import time
import typing
from simvue.api.objects.alert.user import UserAlert
from simvue.models import simvue_timestamp

if typing.TYPE_CHECKING:
import simvue
Expand Down Expand Up @@ -475,6 +476,13 @@ def kill_process(
kill_children_only : bool, optional
if process_id is an integer, whether to kill only its children
"""
# Ensure logs have record of aborted status
with pathlib.Path(f"{self._runner.name}_{process_id}.err").open(
"a"
) as err_file:
err_file.writelines(
[f"{simvue_timestamp()} Process was aborted by Simvue executor."]
)
if isinstance(process_id, str):
if not (process := self._processes.get(process_id)):
logger.error(
Expand Down
54 changes: 43 additions & 11 deletions simvue/run.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
from simvue.api.objects.alert.fetch import Alert
from simvue.api.objects.folder import Folder
from simvue.api.objects.grids import GridMetrics
from simvue.exception import ObjectNotFoundError, SimvueRunError
from simvue.exception import ObjectNotFoundError, SimvueRunError, SimvueUserConfigError
from simvue.utilities import prettify_pydantic


Expand Down Expand Up @@ -122,6 +122,7 @@ def __init__(
abort_callback: typing.Callable[[Self], None] | None = None,
server_token: pydantic.SecretStr | None = None,
server_url: str | None = None,
raise_exception: bool = False,
debug: bool = False,
) -> None:
"""Initialise a new Simvue run
Expand All @@ -141,6 +142,9 @@ def __init__(
overwrite value for server token, default is None
server_url : str, optional
overwrite value for server URL, default is None
raise_exception : bool, optional
whether to raise an exception with traceback as opposed to
printing an error and exiting, default is False
debug : bool, optional
run in debug mode, default is False

Expand Down Expand Up @@ -175,6 +179,11 @@ def __init__(
self._grids: dict[str, str] = {}
self._suppress_errors: bool = False
self._queue_blocking: bool = False
self._raise_exception: bool = raise_exception

# Capture exceptions raised within threads
self._thread_exception_message: str | None = None

self._status: (
typing.Literal[
"created", "running", "completed", "failed", "terminated", "lost"
Expand All @@ -184,9 +193,23 @@ def __init__(
self._data: dict[str, typing.Any] = {}
self._step: int = 0
self._active: bool = False
self._user_config: SimvueConfiguration = SimvueConfiguration.fetch(
server_url=server_url, server_token=server_token, mode=mode
)

try:
self._user_config: SimvueConfiguration = SimvueConfiguration.fetch(
server_url=server_url, server_token=server_token, mode=mode
)
except SimvueUserConfigError as e:
if self._raise_exception:
raise e
_help_str = (
"A required Simvue configuration is missing, "
"please ensure you have created a valid configuration "
"file, or the environment variables 'SIMVUE_URL' and 'SIMVUE_TOKEN' "
"have been defined."
)
click.secho(_help_str)
click.secho(f"[simvue] {e}", bold=True, fg="red")
sys.exit(1)

logging.getLogger(self.__class__.__module__).setLevel(
logging.DEBUG
Expand Down Expand Up @@ -298,7 +321,6 @@ def processes(self) -> list[psutil.Process]:
def _terminate_run(
self,
abort_callback: typing.Callable[[Self], None] | None,
force_exit: bool = True,
) -> None:
"""Close the current simvue Run and its subprocesses.

Expand All @@ -309,8 +331,6 @@ def _terminate_run(
----------
abort_callback: Callable, optional
the callback to execute on the termination else None
force_exit: bool, optional
whether to close Python itself, the default is True
"""
self._alert_raised_trigger.set()
logger.debug("Received abort request from server")
Expand All @@ -326,13 +346,16 @@ def _terminate_run(
self._dispatcher.join()
if self._active:
self.set_status("terminated")
if self._raise_exception:
self._thread_exception_message = "Run was aborted."
return
click.secho(
"[simvue] Run was aborted.",
fg="red" if self._term_color else None,
bold=self._term_color,
)
if self._abort_on_alert == "terminate":
os._exit(1) if force_exit else sys.exit(1)
os._exit(1)

def _get_internal_metrics(
self,
Expand Down Expand Up @@ -445,7 +468,9 @@ def _heartbeat(
# Check if the user has aborted the run
with self._configuration_lock:
if self._sv_obj and self._sv_obj.abort_trigger:
self._terminate_run(abort_callback=abort_callback)
self._terminate_run(
abort_callback=abort_callback,
)

if self._sv_obj:
self._sv_obj.send_heartbeat()
Expand Down Expand Up @@ -1862,14 +1887,21 @@ def _tidy_run(self) -> None:
)
if _error_msg:
_error_msg = f":\n{_error_msg}"
_error_msg = (
f"Process executor terminated with non-zero exit status {_non_zero}"
)
if self._raise_exception:
raise SimvueRunError(_error_msg)
click.secho(
"[simvue] Process executor terminated with non-zero exit status "
f"{_non_zero}{_error_msg}",
f"[simvue] {_error_msg}",
fg="red" if self._term_color else None,
bold=self._term_color,
)
sys.exit(_non_zero)

if self._thread_exception_message and self._raise_exception:
raise SimvueRunError(self._thread_exception_message)

@skip_if_failed("_aborted", "_suppress_errors", False)
def close(self) -> bool:
"""Close the run
Expand Down
33 changes: 10 additions & 23 deletions tests/conftest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,15 +133,8 @@ def log_messages(caplog):


@pytest.fixture
def prevent_script_exit(monkeypatch: monkeypatch.MonkeyPatch) -> None:
_orig_func = sv_run.Run._terminate_run
monkeypatch.setattr(sv_run.Run, "_terminate_run", lambda *args, **kwargs: _orig_func(*args, force_exit=False, **kwargs))


@pytest.fixture
def create_test_run(request, prevent_script_exit) -> Generator[tuple[sv_run.Run, dict]]:
_ = prevent_script_exit
with sv_run.Run() as run:
def create_test_run(request) -> Generator[tuple[sv_run.Run, dict]]:
with sv_run.Run(raise_exception=True) as run:
with tempfile.TemporaryDirectory() as tempd:
_test_run_data = setup_test_run(run, temp_dir=pathlib.Path(tempd), create_objects=True, request=request)
yield run, _test_run_data
Expand All @@ -154,11 +147,10 @@ def create_test_run(request, prevent_script_exit) -> Generator[tuple[sv_run.Run,


@pytest.fixture
def create_test_run_offline(request, monkeypatch: pytest.MonkeyPatch, prevent_script_exit) -> Generator[tuple[sv_run.Run, dict]]:
_ = prevent_script_exit
def create_test_run_offline(request, monkeypatch: pytest.MonkeyPatch) -> Generator[tuple[sv_run.Run, dict]]:
with tempfile.TemporaryDirectory() as temp_d:
monkeypatch.setenv("SIMVUE_OFFLINE_DIRECTORY", temp_d)
with sv_run.Run("offline") as run:
with sv_run.Run("offline", raise_exception=True) as run:
_test_run_data = setup_test_run(run, temp_dir=pathlib.Path(temp_d), create_objects=True, request=request)
yield run, _test_run_data
with contextlib.suppress(ObjectNotFoundError):
Expand All @@ -170,32 +162,27 @@ def create_test_run_offline(request, monkeypatch: pytest.MonkeyPatch, prevent_sc


@pytest.fixture
def create_plain_run(request, prevent_script_exit, mocker) -> Generator[tuple[sv_run.Run, dict]]:
_ = prevent_script_exit
def testing_exit(status: int) -> None:
raise SystemExit(status)
with sv_run.Run() as run:
def create_plain_run(request, mocker) -> Generator[tuple[sv_run.Run, dict]]:
with sv_run.Run(raise_exception=True) as run:
run.metric_spy = mocker.spy(run, "_get_internal_metrics")
with tempfile.TemporaryDirectory() as tempd:
yield run, setup_test_run(run, temp_dir=pathlib.Path(tempd), create_objects=False, request=request)
clear_out_files()


@pytest.fixture
def create_pending_run(request, prevent_script_exit) -> Generator[tuple[sv_run.Run, dict]]:
_ = prevent_script_exit
with sv_run.Run() as run:
def create_pending_run(request) -> Generator[tuple[sv_run.Run, dict]]:
with sv_run.Run(raise_exception=True) as run:
with tempfile.TemporaryDirectory() as tempd:
yield run, setup_test_run(run, temp_dir=pathlib.Path(tempd), create_objects=False, request=request, created_only=True)
clear_out_files()


@pytest.fixture
def create_plain_run_offline(request,prevent_script_exit,monkeypatch) -> Generator[tuple[sv_run.Run, dict]]:
_ = prevent_script_exit
def create_plain_run_offline(request, monkeypatch) -> Generator[tuple[sv_run.Run, dict]]:
with tempfile.TemporaryDirectory() as temp_d:
monkeypatch.setenv("SIMVUE_OFFLINE_DIRECTORY", temp_d)
with sv_run.Run("offline") as run:
with sv_run.Run("offline", raise_exception=True) as run:
_temporary_directory = pathlib.Path(temp_d)
yield run, setup_test_run(run, temp_dir=_temporary_directory, create_objects=False, request=request)
clear_out_files()
Expand Down
24 changes: 16 additions & 8 deletions tests/functional/test_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

import tempfile
import simvue.client as svc
from simvue.exception import ObjectNotFoundError
from simvue.exception import ObjectNotFoundError, SimvueRunError
import simvue.run as sv_run
import simvue.api.objects as sv_api_obj
from simvue.api.objects.alert.base import AlertBase
Expand Down Expand Up @@ -535,16 +535,24 @@ def test_alert_deletion() -> None:

@pytest.mark.client
@pytest.mark.object_removal
def test_abort_run(speedy_heartbeat, create_plain_run: tuple[sv_run.Run, dict]) -> None:
run, run_data = create_plain_run
def test_abort_run(speedy_heartbeat) -> None:
run = sv_run.Run(raise_exception=True)
unique_id = f"{uuid.uuid4()}".split("-")[0]
run.init(
name="test_abort_run",
folder=f"/simvue_unit_testing/{unique_id}",
tags=["test_tag_deletion", platform.system()],
retention_period="1 min",
)
run._heartbeat_interval = 1
_uuid = f"{uuid.uuid4()}".split("-")[0]
run.update_tags([f"delete_me_{_uuid}"])
_client = svc.Client()
_client.abort_run(run.id, reason="Test abort")
_attempts: int = 0

while run.status != "terminated" and _attempts < 10:
time.sleep(1)
_attempts += 1
if _attempts >= 10:
raise AssertionError("Failed to terminate run.")
with pytest.raises(SimvueRunError):
run.close()
while run.status != "terminated" and _attempts < 10:
time.sleep(1)
_attempts += 1
3 changes: 2 additions & 1 deletion tests/functional/test_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
import pytest_mock
import tempfile
from simvue.config.user import SimvueConfiguration
from simvue.exception import SimvueUserConfigError


@pytest.mark.config
Expand Down Expand Up @@ -100,7 +101,7 @@ def _mocked_find(file_names: list[str], *_, ppt_file=_ppt_file, conf_file=_confi
import simvue.config.user

if not use_file and not use_env and not use_args:
with pytest.raises(RuntimeError):
with pytest.raises(SimvueUserConfigError):
simvue.config.user.SimvueConfiguration.fetch(mode="online")
return
elif use_args:
Expand Down
Loading