Add copy all button to suggestor

Author: SAKavli

src/ert/gui/ertwidgets/suggestor/suggestor.py

@@ -19,9 +19,11 @@
     QVBoxLayout,
     QWidget,
 )
+from typing_extensions import override
 
 from ert.gui import is_dark_mode
 
+from .. import CopyButton
 from ._colors import BLUE_TEXT
 from ._suggestor_message import SuggestorMessage
 
@@ -105,6 +107,32 @@ def _combine_messages(infos: Sequence[ErrorInfo]) -> list[tuple[str, list[str]]]
 """
 
 
+class _CopyAllButton(CopyButton):
+    def __init__(
+        self,
+        errors: list[ErrorInfo],
+        warnings: list[WarningInfo],
+        deprecations: list[WarningInfo],
+    ) -> None:
+        super().__init__()
+        self.setText(" Copy all messages")
+        self.all_messages = "\n\n".join(
+            [
+                f"{info.message}" + (f"\n{info.location()}" if info.location() else "")
+                for info in (errors + warnings + deprecations)
+            ]
+        )
+        self.setStyleSheet(SECONDARY_BUTTON_STYLE)
+
+    @override
+    def copy(self) -> None:
+        logger.info(
+            "Copy all button in Suggestor used. "
+            f"Copied {len(self.all_messages)} characters"
+        )
+        self.copy_text(self.all_messages)
+
+
 class Suggestor(QWidget):
     def __init__(
         self,
@@ -147,9 +175,15 @@ def __init__(
 
         action_buttons = QWidget(parent=self)
         action_buttons_layout = QHBoxLayout()
-        action_buttons_layout.insertStretch(-1, -1)
         action_buttons_layout.setContentsMargins(0, 24, 0, 0)
 
+        if any([errors, warnings, deprecations]):
+            action_buttons_layout.addWidget(
+                _CopyAllButton(errors, warnings, deprecations)
+            )
+
+        action_buttons_layout.addStretch()
+
         if continue_action:
             action_buttons_layout.addWidget(self._continue_button())
 

tests/ert/unit_tests/gui/test_suggestor.py

@@ -1,8 +1,11 @@
+import re
+
 import pytest
-from PyQt6.QtWidgets import QWidget
+from PyQt6.QtWidgets import QApplication, QPushButton, QWidget
 
-from ert.config import ErrorInfo
+from ert.config import ErrorInfo, WarningInfo
 from ert.gui.ertwidgets import Suggestor
+from ert.gui.ertwidgets.suggestor.suggestor import _CopyAllButton
 
 
 @pytest.mark.parametrize(
@@ -21,3 +24,56 @@ def test_suggestor_combines_errors_with_the_same_message(qtbot, errors, expected
     msg_layout = msgs.layout()
     assert msg_layout is not None
     assert msg_layout.count() == expected_num
+
+
+def test_that_copy_all_button_concatenates_errors_warnings_and_deprecations(qtbot):
+    errors = [ErrorInfo("error", filename="script.py", line="5")]
+    warnings = [WarningInfo("warning", filename="script.py", line="6")]
+    deprecations = [
+        WarningInfo("deprecation", filename="script.py", line="7", is_deprecation=True)
+    ]
+    suggestor = Suggestor(errors, warnings, deprecations, lambda: None)
+
+    all_buttons = suggestor.findChildren(QPushButton)
+    copy_all_button = next(
+        button for button in all_buttons if isinstance(button, _CopyAllButton)
+    )
+    copy_all_button.click()
+
+    expected_clipboard = """error
+    script.py: Line 5
+
+    warning
+    script.py: Line 6
+
+    deprecation
+    script.py: Line 7"""
+
+    def remove_whitespaces(s: str) -> str:
+        return re.sub(r"\s+", "", s)
+
+    assert remove_whitespaces(QApplication.clipboard().text()) == remove_whitespaces(
+        expected_clipboard
+    )
+
+
+@pytest.mark.parametrize(
+    "errors",
+    [
+        [ErrorInfo("error")] * 2,
+        [ErrorInfo("error", filename="script.py", line="5")] * 2,
+    ],
+)
+def test_that_copy_all_button_separates_messages_with_double_newlines(qtbot, errors):
+    """This test ensures that _CopyAllButton consistently inserts two newlines between
+    each message regardless of locational context."""
+    suggestor = Suggestor(errors, [], [], lambda: None)
+
+    all_buttons = suggestor.findChildren(QPushButton)
+    copy_all_button = next(
+        button for button in all_buttons if isinstance(button, _CopyAllButton)
+    )
+    copy_all_button.click()
+
+    assert "\n" * 2 in QApplication.clipboard().text()
+    assert "\n" * 3 not in QApplication.clipboard().text()