Have ert show hooked workflows in GUI#13397
Open
jonathan-eq wants to merge 4 commits into
Open
Conversation
jonathan-eq
force-pushed
the
23042026_show_workflow_status_in_gui
branch
2 times, most recently
from
0095d01 to
4e61524
Compare
Contributor
Author
|
Changing iteration tabs does not always update the fm_overview table... |
jonathan-eq
force-pushed
the
23042026_show_workflow_status_in_gui
branch
from
4e61524 to
fd82164
Compare
jonathan-eq
commented
Apr 29, 2026
|
|
||
| from pydantic import BaseModel, ConfigDict, Field, TypeAdapter | ||
|
|
||
| from _ert.hook_runtime import HookRuntime |
Contributor
Author
There was a problem hiding this comment.
Had to move hook_runtime to _ert to avoid circular import
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## main #13397 +/- ##
==========================================
+ Coverage 89.54% 89.55% +0.01%
==========================================
Files 463 465 +2
Lines 32747 33129 +382
==========================================
+ Hits 29322 29668 +346
- Misses 3425 3461 +36
Flags with carried forward coverage won't be shown. Click here to find out more.
|
jonathan-eq
force-pushed
the
23042026_show_workflow_status_in_gui
branch
from
9181b64 to
4d0e6b6
Compare
jonathan-eq
commented
Apr 30, 2026
|
|
||
|
|
||
| class _WorkflowEvent(BaseModel): | ||
| hook: HookRuntime | None = None |
Contributor
Author
There was a problem hiding this comment.
workflow_runner tests required this to be optional
jonathan-eq
commented
Apr 30, 2026
jonathan-eq
commented
Apr 30, 2026
| from .workflow import WorkflowWidget | ||
|
|
||
|
|
||
| class IterationWidget(QWidget): |
Contributor
Author
There was a problem hiding this comment.
This is the widget that allows us to group the tabs. Maybe TabGroupingWidget is better? It can contain UpdateWidget, RealizationWidget, and WorkflowWIdget.
jonathan-eq
commented
Apr 30, 2026
Comment on lines
+24
to
+30
| _STATUS_TO_BACKGROUND = { | ||
| WorkflowStatus.PENDING: QColor(*state.COLOR_PENDING), | ||
| WorkflowStatus.RUNNING: QColor(*state.COLOR_RUNNING), | ||
| WorkflowStatus.FINISHED: QColor(*state.COLOR_FINISHED), | ||
| WorkflowStatus.FAILED: QColor(*state.COLOR_FAILED), | ||
| WorkflowStatus.CANCELLED: QColor(*state.COLOR_CANCELLED), | ||
| } |
Contributor
Author
There was a problem hiding this comment.
This is very similar to the statuses and look we have in evaluator. The tables can probably at some point be combined (if we want to add the duration field for workflows too).
jonathan-eq
commented
Apr 30, 2026
Comment on lines
+33
to
+34
| "Workflow job": 0, | ||
| "Status": 1, |
Contributor
Author
There was a problem hiding this comment.
Maybe all should be uppercase?
jonathan-eq
force-pushed
the
23042026_show_workflow_status_in_gui
branch
3 times, most recently
from
2e60d28 to
d466b09
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces workflow lifecycle events (batch + per-workflow started/finished/cancelled) and wires them through the run model into the GUI so workflow execution can be visualized in dedicated tabs (including per-iteration/update grouping). It also centralizes HookRuntime under _ert and updates affected tests accordingly.
Changes:
- Add new workflow event types (
Workflow*Event,WorkflowStatus) and emit them fromRunModel.run_workflows()andWorkflowRunner.run_blocking(). - Introduce GUI widgets/tabs (
WorkflowWidget,IterationWidget) and updateRunDialogto place workflow hooks before/after iteration/update tabs. - Expand unit/UI test coverage to assert event emission and GUI tab ordering/behavior for workflows.
Reviewed changes
Copilot reviewed 22 out of 24 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/ert/unit_tests/workflow_runner/test_workflow_runner.py | Adds tests asserting per-workflow events include hook/iteration/workflow_name and capture stdout; adds cancellation event assertions. |
| tests/ert/unit_tests/run_models/test_base_run_model.py | Adds test for workflow batch events across multiple workflows, including non-stopping failures. |
| tests/ert/unit_tests/gui/experiments/test_run_dialog.py | Updates GUI unit tests for new IterationWidget structure and adds test for workflow tabs placement around iteration tab. |
| tests/ert/ui_tests/gui/test_workflow_widget.py | New UI test suite validating WorkflowWidget status/label/output rendering and row coloring. |
| tests/ert/ui_tests/gui/test_update_runs.py | Extends UI tests to validate workflow hook tab placement across experiment/iteration/update lifecycle. |
| tests/ert/ui_tests/gui/test_restart_ensemble_experiment.py | Adjusts UI tests to navigate through IterationWidget to reach RealizationWidget. |
| tests/ert/ui_tests/gui/test_docs_screenshots.py | Updates screenshot test navigation for IterationWidget nesting. |
| tests/ert/ui_tests/gui/conftest.py | Updates common GUI test helper to account for IterationWidget tab nesting. |
| src/ert/workflow_runner.py | Emits workflow started/finished/cancelled events and aggregates stdout/stderr across jobs. |
| src/ert/run_models/update_run_model.py | Reorders RunModelUpdateBeginEvent/status emission relative to pre-update workflows. |
| src/ert/run_models/run_model.py | Emits workflow batch started/finished events and passes hook/iteration/name into WorkflowRunner. |
| src/ert/run_models/event.py | Extends run-model event union to include WorkflowEvent. |
| src/ert/gui/experiments/view/workflow.py | New WorkflowWidget displaying workflow status and stdout/stderr in a table with status coloring. |
| src/ert/gui/experiments/view/iteration.py | New IterationWidget to group Run/Update/Workflow sub-tabs per iteration/update. |
| src/ert/gui/experiments/view/init.py | Exports IterationWidget and WorkflowWidget. |
| src/ert/gui/experiments/run_dialog.py | Reworks tab management to use IterationWidget containers and to create/update workflow tabs on workflow events. |
| src/ert/config/workflow_fixtures.py | Switches HookRuntime import to _ert.hook_runtime. |
| src/ert/config/parsing/hook_runtime.py | Removes local HookRuntime definition (moved to _ert). |
| src/ert/config/parsing/config_schema.py | Updates schema typing to use _ert.hook_runtime.HookRuntime. |
| src/ert/config/parsing/init.py | Re-exports _ert.hook_runtime.HookRuntime from parsing package. |
| src/_ert/hook_runtime.py | New home for HookRuntime plus workflow_tab_title() helper for GUI labels. |
| src/_ert/events.py | Adds WorkflowStatus and workflow event models to the shared events module. |
Comment on lines
+185
to
+190
| logger.info(f"Workflow job {jobrunner.name} starting") | ||
| jobrunner.run(args, fixtures=self.fixtures) | ||
| try: | ||
| jobrunner.run(args, fixtures=self.fixtures) | ||
| except Exception as err: | ||
| stdout = "" | ||
| stderr = str(err) |
Comment on lines
+186
to
+188
| try: | ||
| jobrunner.run(args, fixtures=self.fixtures) | ||
| except Exception as err: |
Contributor
Author
There was a problem hiding this comment.
This will be step 2!
Comment on lines
+220
to
+222
| item.setText("-" if text == "" else text) # noqa: PLC1901 | ||
| item.setTextAlignment(Qt.AlignmentFlag.AlignCenter) | ||
| item.setToolTip(text) |
Contributor
Author
There was a problem hiding this comment.
Wouldn't passing None be fine?
Contributor
Author
|
Now it is possible to cancel hooked workflows while they are running. It is very similar to the fm step statuses during evaluation. Screen.Recording.2026-05-05.at.14.59.47.mov |
jonathan-eq
force-pushed
the
23042026_show_workflow_status_in_gui
branch
from
de417eb to
5f7baed
Compare
jonathan-eq
force-pushed
the
23042026_show_workflow_status_in_gui
branch
from
5f7baed to
b3a7616
Compare
Comment on lines
+225
to
+227
| item.setText("-" if text == "" else text) # noqa: PLC1901 | ||
| item.setTextAlignment(Qt.AlignmentFlag.AlignCenter) | ||
| item.setToolTip(text) |
Comment on lines
+201
to
+203
| @pytest.mark.usefixtures("use_tmpdir") | ||
| def test_run_workflows_emits_events_for_following_workflow_after_non_stopping_failure(): | ||
| WorkflowCommon.createExternalDumpJob() |
Comment on lines
+280
to
+283
| def test_run_workflows_cancels_active_workflow_and_stops_following_workflows( | ||
| use_tmpdir, | ||
| ): | ||
| WorkflowCommon.createExternalDumpJob() |
| @pytest.mark.filterwarnings( | ||
| "ignore:Use of legacy_ertscript_workflow is deprecated.*:DeprecationWarning" | ||
| ) | ||
| def test_run_dialog_places_all_workflow_hooks_in_expected_tabs(qtbot, tmp_path): |
Comment on lines
+478
to
+480
| def test_esmda_with_all_workflows_produces_expected_final_gui( | ||
| qtbot, tmp_path, source_root, run_experiment | ||
| ): |
Contributor
Author
|
Found a new bug: #13487 |
jonathan-eq
force-pushed
the
23042026_show_workflow_status_in_gui
branch
3 times, most recently
from
3cac030 to
12957a2
Compare
jonathan-eq
force-pushed
the
23042026_show_workflow_status_in_gui
branch
from
f89b19b to
f45a77b
Compare
jonathan-eq
added
the
release-notes:new-feature
jonathan-eq
force-pushed
the
23042026_show_workflow_status_in_gui
branch
from
f45a77b to
1db9136
Compare
Comment on lines
+204
to
+206
| @pytest.mark.filterwarnings("ignore:.*Deprecated keywords, SCRIPT and INTERNAL") | ||
| @pytest.mark.usefixtures("use_tmpdir") | ||
| def test_run_workflows_emits_events_for_following_workflow_after_non_stopping_failure(): |
Comment on lines
+330
to
+337
| @pytest.mark.mpl_image_compare(tolerance=10.0) | ||
| @pytest.mark.skip_mac_ci # test is slow | ||
| @pytest.mark.filterwarnings( | ||
| "ignore:Use of legacy_ertscript_workflow is deprecated.*:DeprecationWarning" | ||
| ) | ||
| def test_esmda_with_all_workflows_produces_expected_final_gui( | ||
| qtbot: QtBot, tmp_path, source_root, run_experiment | ||
| ): |
| self, | ||
| workflow_name: str, | ||
| status: WorkflowStatus, | ||
| ) -> int | None: |
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 24 out of 27 changed files in this pull request and generated no new comments.
Comments suppressed due to low confidence (1)
src/ert/workflow_runner.py:135
WorkflowRunnercreates a newThreadPoolExecutorper instance (self._workflow_executor = ...) but it is never shut down. This can leave idle worker threads alive for the lifetime of the process (especially in the GUI where workflows can be run repeatedly). Consider shutting down the executor (e.g., in__exit__/a dedicatedclose()method, or by lazily creating it only whenrun()is used and shutting it down after completion).
self.__workflow_result: bool | None = None
self._workflow_executor = futures.ThreadPoolExecutor(max_workers=1)
self._workflow_job: Future[None] | None = None
1618f9d to
0a686ec
Compare
Contributor
Author
|
Findings: Rerun doesnt clear workflow widget table before appending more rows |
jonathan-eq
force-pushed
the
23042026_show_workflow_status_in_gui
branch
4 times, most recently
from
051e529 to
63d618a
Compare
Comment on lines
+403
to
+411
| if isinstance(widget, TabGroupWidget): | ||
| current_widget = widget.current_widget() | ||
| if isinstance(current_widget, RealizationWidget): | ||
| current_widget.refresh_current_selection() | ||
|
|
||
| self.fm_step_frame.setHidden(isinstance(current_widget, UpdateWidget)) | ||
| return | ||
|
|
||
| self.fm_step_frame.setHidden(isinstance(widget, UpdateWidget)) | ||
| self.fm_step_frame.setHidden(False) |
Contributor
Author
There was a problem hiding this comment.
Maybe in the future, this is closer to the behavior we already had.
| finally: | ||
| self._workflow_runner = None | ||
|
|
||
| if self._end_event.is_set(): |
| from ert.gui.experiments.view.tab_group_widget import TabGroupWidget | ||
|
|
||
|
|
||
| def test_tab_group_widget_current_widget_tracks_tab_widget_selection(qtbot): |
jonathan-eq
force-pushed
the
23042026_show_workflow_status_in_gui
branch
from
b3ff033 to
91a94b6
Compare
This commit changes the GUI to: * Show iterations and updates in tabs to accommodate showing pre/post run/update workflows * Show pre-experiment and post-experiment workflows on main tab-bar * Pressing terminate experiment during hooked workflows cancels the workflow, and marks it as cancelled by user. Following workflows in the same hook will be marked as cancelled, as to not mislead the user.
jonathan-eq
force-pushed
the
23042026_show_workflow_status_in_gui
branch
from
91a94b6 to
4c7c553
Compare
jonathan-eq
force-pushed
the
23042026_show_workflow_status_in_gui
branch
from
4c7c553 to
f1c555d
Compare
Contributor
Author
|
This one is almost ready, it just needs some cleanup and an additional test that makes sure tabs dont auto select on new events if the user has manually selected a tab. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Issue
Resolves #13320
Approach
This commit changes the GUI to:
run/update workflows
workflow, and marks it as cancelled by user. Following workflows in
the same hook will be marked as cancelled, as to not mislead the user.
(Screenshot of new behavior in GUI if applicable)
git rebase -i main --exec 'just rapid-tests')When applicable