Add type to run_experiment, respect when users define AUTOSUBMIT_CONFIGURATION

Author: kinow

autosubmit/autosubmit.py

@@ -80,7 +80,7 @@
 import autosubmit.history.utils as HUtils
 import autosubmit.helpers.autosubmit_helper as AutosubmitHelper
 import autosubmit.statistics.utils as StatisticsUtils
-from autosubmit.helpers.utils import check_jobs_file_exists
+from autosubmit.helpers.utils import check_jobs_file_exists, get_rc_path
 
 from contextlib import suppress
 
@@ -2149,7 +2149,7 @@ def refresh_log_recovery_process(platforms: List[Platform], as_conf: AutosubmitC
             p.work_event.set()
 
     @staticmethod
-    def run_experiment(expid, notransitive=False, start_time=None, start_after=None, run_only_members=None, profile=False):
+    def run_experiment(expid, notransitive=False, start_time=None, start_after=None, run_only_members=None, profile=False) -> int:
         """
         Runs and experiment (submitting all the jobs properly and repeating its execution in case of failure).
         :param expid: the experiment id
@@ -2158,7 +2158,7 @@ def run_experiment(expid, notransitive=False, start_time=None, start_after=None,
         :param start_after: the expid after which the experiment should start
         :param run_only_members: the members to run
         :param profile: if True, the function will be profiled
-        :return: None
+        :return: exit status
 
         """
         # Start profiling if the flag has been used
@@ -3406,7 +3406,7 @@ def describe(input_experiment_list="*",get_from_user=""):
 
     @staticmethod
     def configure(advanced, database_path, database_filename, local_root_path, platforms_conf_path, jobs_conf_path,
-                  smtp_hostname, mail_from, machine, local):
+                  smtp_hostname, mail_from, machine: bool, local: bool):
         """
         Configure several paths for autosubmit: database, local root and others. Can be configured at system,
         user or local levels. Local level configuration precedes user level and user level precedes system
@@ -3486,61 +3486,54 @@ def configure(advanced, database_path, database_filename, local_root_path, platf
                     Log.error("jobs.yml path does not exist.")
                     return False
 
-            if machine:
-                rc_path = '/etc'
-            elif local:
-                rc_path = '.'
-            else:
-                rc_path = home_path
-            rc_path = rc_path.joinpath('.autosubmitrc')
+            rc_path: Path = get_rc_path(machine, local)
 
-            config_file = open(rc_path, 'w')
-            Log.info("Writing configuration file...")
-            try:
-                parser = ConfigParser()
-                parser.add_section('database')
-                parser.set('database', 'path', str(database_path))
-                if database_filename is not None and len(str(database_filename)) > 0:
-                    parser.set('database', 'filename', str(database_filename))
-                parser.add_section('local')
-                parser.set('local', 'path', str(local_root_path))
-                if (jobs_conf_path is not None and len(str(jobs_conf_path)) > 0) or (
-                        platforms_conf_path is not None and len(str(platforms_conf_path)) > 0):
-                    parser.add_section('conf')
-                    if jobs_conf_path is not None:
-                        parser.set('conf', 'jobs', str(jobs_conf_path))
-                    if platforms_conf_path is not None:
-                        parser.set('conf', 'platforms', str(platforms_conf_path))
-                if smtp_hostname is not None or mail_from is not None:
-                    parser.add_section('mail')
-                    parser.set('mail', 'smtp_server', smtp_hostname)
-                    parser.set('mail', 'mail_from', mail_from)
-                parser.add_section("globallogs")
-                parser.set("globallogs", "path", str(global_logs_path))
-                parser.add_section("structures")
-                parser.set("structures", "path", str(structures_path))
-                parser.add_section("historicdb")
-                parser.set("historicdb", "path", str(historicdb_path))
-                parser.add_section("historiclog")
-                parser.set("historiclog", "path", str(historiclog_path))
-                parser.add_section("autosubmitapi")
-                parser.set("autosubmitapi", "url", autosubmitapi_url)
-                # parser.add_section("hosts")
-                # parser.set("hosts", "whitelist", " localhost # Add your machine names")
-                parser.write(config_file)
-                config_file.close()
-                Log.result(f"Configuration file written successfully: \n\t{rc_path}")
-                HUtils.create_path_if_not_exists(local_root_path)
-                HUtils.create_path_if_not_exists(global_logs_path)
-                HUtils.create_path_if_not_exists(structures_path)
-                HUtils.create_path_if_not_exists(historicdb_path)
-                HUtils.create_path_if_not_exists(historiclog_path)
-                Log.result(f"Directories configured successfully: \n\t{str(database_path)} \n\t{str(local_root_path)}"
-                           f" \n\t{str(global_logs_path)} \n\t{str(structures_path)} \n\t{str(historicdb_path)}"
-                           f" \n\t{str(historiclog_path)}")
-            except (IOError, OSError) as e:
-                raise AutosubmitCritical(
-                    "Can not write config file: {0}", 7012, e.message)
+            with open(rc_path, 'w') as config_file:
+                Log.info("Writing configuration file...")
+                try:
+                    parser = ConfigParser()
+                    parser.add_section('database')
+                    parser.set('database', 'path', str(database_path))
+                    if database_filename is not None and len(str(database_filename)) > 0:
+                        parser.set('database', 'filename', str(database_filename))
+                    parser.add_section('local')
+                    parser.set('local', 'path', str(local_root_path))
+                    if (jobs_conf_path is not None and len(str(jobs_conf_path)) > 0) or (
+                            platforms_conf_path is not None and len(str(platforms_conf_path)) > 0):
+                        parser.add_section('conf')
+                        if jobs_conf_path is not None:
+                            parser.set('conf', 'jobs', str(jobs_conf_path))
+                        if platforms_conf_path is not None:
+                            parser.set('conf', 'platforms', str(platforms_conf_path))
+                    if smtp_hostname is not None or mail_from is not None:
+                        parser.add_section('mail')
+                        parser.set('mail', 'smtp_server', smtp_hostname)
+                        parser.set('mail', 'mail_from', mail_from)
+                    parser.add_section("globallogs")
+                    parser.set("globallogs", "path", str(global_logs_path))
+                    parser.add_section("structures")
+                    parser.set("structures", "path", str(structures_path))
+                    parser.add_section("historicdb")
+                    parser.set("historicdb", "path", str(historicdb_path))
+                    parser.add_section("historiclog")
+                    parser.set("historiclog", "path", str(historiclog_path))
+                    parser.add_section("autosubmitapi")
+                    parser.set("autosubmitapi", "url", autosubmitapi_url)
+                    # parser.add_section("hosts")
+                    # parser.set("hosts", "whitelist", " localhost # Add your machine names")
+                    parser.write(config_file)
+                    Log.result(f"Configuration file written successfully: \n\t{rc_path}")
+                    HUtils.create_path_if_not_exists(local_root_path)
+                    HUtils.create_path_if_not_exists(global_logs_path)
+                    HUtils.create_path_if_not_exists(structures_path)
+                    HUtils.create_path_if_not_exists(historicdb_path)
+                    HUtils.create_path_if_not_exists(historiclog_path)
+                    Log.result(f"Directories configured successfully: \n\t{str(database_path)} \n\t{str(local_root_path)}"
+                               f" \n\t{str(global_logs_path)} \n\t{str(structures_path)} \n\t{str(historicdb_path)}"
+                               f" \n\t{str(historiclog_path)}")
+                except (IOError, OSError) as e:
+                    raise AutosubmitCritical(
+                        "Can not write config file: {0}", 7012, e.message)
         except (AutosubmitCritical, AutosubmitError) as e:
             raise
         except BaseException as e:

autosubmit/helpers/utils.py

@@ -2,11 +2,11 @@
 import pwd
 import re
 from itertools import zip_longest
-
-from autosubmitconfigparser.config.basicconfig import BasicConfig
+from pathlib import Path
 
 from autosubmit.notifications.mail_notifier import MailNotifier
 from autosubmit.notifications.notifier import Notifier
+from autosubmitconfigparser.config.basicconfig import BasicConfig
 from log.log import AutosubmitCritical, Log
 
 
@@ -119,6 +119,7 @@ def restore_platforms(platform_to_test, mail_notify=False, as_conf=None, expid=N
         else:
             raise AutosubmitCritical("Issues while checking the connectivity of platforms.", 7010, issues + "\n" + ssh_config_issues)
 
+
 # Source: https://github.com/cylc/cylc-flow/blob/a722b265ad0bd68bc5366a8a90b1dbc76b9cd282/cylc/flow/tui/util.py#L226
 class NaturalSort:
     """An object to use as a sort key for sorting strings as a human would.
@@ -220,3 +221,31 @@ def strtobool(val):
         return 0
     else:
         raise ValueError("invalid truth value %r" % (val,))
+
+
+def get_rc_path(machine: bool, local: bool) -> Path:
+    """Get the ``.autosubmit.rc`` path.
+
+    If the environment variable ``AUTOSUBMIT_CONFIGURATION`` is specified in the
+    system, this function will return a ``Path`` pointing to that value.
+
+    If ``machine`` is ``True``, it will use the file from ``/etc/.autosubmitrc``
+    (pay attention to the dot prefix).
+
+    Else, if ``local`` is ``True``, it will use the file from  ``./.autosubmitrc``
+    (i.e. it will use the current working directory for the process).
+
+    Otherwise, it will load the file from ``~/.autosubmitrc``, for the user
+    currently running Autosubmit.
+    """
+    if 'AUTOSUBMIT_CONFIGURATION' in os.environ:
+        return Path(os.environ['AUTOSUBMIT_CONFIGURATION'])
+
+    if machine:
+        rc_path = '/etc'
+    elif local:
+        rc_path = '.'
+    else:
+        rc_path = Path.home()
+
+    return Path(rc_path) / '.autosubmitrc'

test/unit/helpers/test_utils.py

@@ -15,9 +15,11 @@
 # You should have received a copy of the GNU General Public License
 # along with Autosubmit.  If not, see <http://www.gnu.org/licenses/>.
 
+from pathlib import Path
+
 import pytest
 
-from autosubmit.helpers.utils import strtobool
+from autosubmit.helpers.utils import strtobool, get_rc_path
 
 
 @pytest.mark.parametrize(
@@ -54,3 +56,28 @@ def test_strtobool(val, expected):
             strtobool(val)
     else:
         assert expected == strtobool(val)
+
+
+@pytest.mark.parametrize(
+    'expected,machine,local,env_vars',
+    [
+        (Path('/tmp/hello/scooby/doo/ooo.txt'), True, True, {
+            'AUTOSUBMIT_CONFIGURATION': '/tmp/hello/scooby/doo/ooo.txt'
+        }),
+        (Path('/etc/.autosubmitrc'), True, True, {}),
+        (Path('/etc/.autosubmitrc'), True, False, {}),
+        (Path('./.autosubmitrc'), False, True, {}),
+        (Path(Path.home(), '.autosubmitrc'), False, False, {})
+    ],
+    ids=[
+        'Use env var',
+        'Use machine, even if local is true',
+        'Use machine',
+        'Use local',
+        'Use home'
+    ]
+)
+def test_get_rc_path(expected: Path, machine: bool, local: bool, env_vars: dict, mocker):
+    mocker.patch.dict('autosubmit.helpers.utils.os.environ', env_vars, clear=True)
+
+    assert expected == get_rc_path(machine, local)