Merge branch 'master' into fix-issue-2570-review-recovery-args

Author: VindeeR

CHANGELOG.md

@@ -42,6 +42,7 @@ the filter the jobs. Not using any value for `-fp` still returns all jobs.
 - Fix PS platform to work with the local machine #2374
 - Fixed a `ZeroDivisionError` when using RO-Crate or `stats`, and also an issue
   where the message said `None` could not be iterable. #2389
+- Fixed a bug that produces an infinite loop when it is not possible to create log files #2618
 
 **Enhancements:**
 

autosubmit/log/log.py

@@ -201,7 +201,13 @@ def get_logger(name="Autosubmit") -> None:
         logging.getLogger(name)
 
     @staticmethod
-    def set_file(file_path: str, type='out', level="WARNING") -> None:
+    def set_file(
+        file_path: str,
+        type="out",
+        level="WARNING",
+        max_retries: int = 3,
+        timeout: int = 5,
+    ) -> None:
         """Configure the file to store the log.
 
         If another file was specified earlier, new messages will only go to the new file.
@@ -210,6 +216,8 @@ def set_file(file_path: str, type='out', level="WARNING") -> None:
         :type file_path: str
         :param type: file type
         :param level: log level
+        :param max_retries: maximum number of retries to create the log file
+        :param timeout: time to wait between retries (in seconds)
         """
         levels = {
             "STATUS_FAILED": 500,
@@ -225,9 +233,7 @@ def set_file(file_path: str, type='out', level="WARNING") -> None:
 
         level = levels.get(str(level).upper(), "DEBUG")
 
-        max_retries = 3
-        retries = 1
-        timeout = 5
+        retries = 0
 
         while not os.path.exists(file_path) and retries < max_retries:
             try:
@@ -271,9 +277,12 @@ def set_file(file_path: str, type='out', level="WARNING") -> None:
                     status_file_handler.addFilter(custom_filter)
                     Log.log.addHandler(status_file_handler)
                 os.chmod(file_path, 509)
-            except Exception:  # retry again
-                Log.warning(f'Unexpected error setting the log file {str(file_path)}, retry {retries} out '
-                            f'of {max_retries}: {str(e)}')
+            except Exception as exc:  # retry again
+                retries += 1
+                if retries >= max_retries:
+                    raise AutosubmitCritical(
+                        message=f"Could not create log file {file_path} after {max_retries} attempts: {exc}"
+                    )
                 sleep(timeout * retries)
 
     @staticmethod

test/unit/test_log.py

@@ -15,7 +15,14 @@
 # You should have received a copy of the GNU General Public License
 # along with Autosubmit.  If not, see <http://www.gnu.org/licenses/>.
 
-from autosubmit.log.log import AutosubmitError, AutosubmitCritical, Log
+from typing import TYPE_CHECKING
+
+import pytest
+
+from autosubmit.log.log import AutosubmitCritical, AutosubmitError, Log
+
+if TYPE_CHECKING:
+    from pytest_mock import MockFixture
 
 """Tests for the log module."""
 
@@ -65,3 +72,17 @@ def _send_messages(msg: str):
     # Format messages
     msg = "Test {foo, bar}"
     _send_messages(msg)
+
+
+def test_set_file_retrial(mocker: 'MockFixture'):
+    max_retries = 3
+
+    # Make os.path.split raise an exception
+    mocker.patch("os.path.split", side_effect=Exception("Mocked exception"))
+
+    sleep = mocker.patch("autosubmit.log.log.sleep")
+
+    with pytest.raises(AutosubmitCritical):
+        Log.set_file("imaginary.log", max_retries=max_retries, timeout=1)
+
+    assert sleep.call_count == max_retries - 1