Fixes and issue with the experiment_data.yml not being saved under a shared account. (#82)

* fix metadatafolder not being generated

* Test and update version

* def is_current_logged_user_owner(self) -> bool:
property

* Removed -cov, the same change was done by Bruno in autosubmit proj

Added tests

* Changed mock (didn't work under CI/CD )

* re-added cov

* Added docstring

Author: dbeltrankyl

VERSION

@@ -1 +1 @@
-1.0.78
+1.0.79

autosubmitconfigparser/config/configcommon.py

@@ -1761,6 +1761,14 @@ def is_current_real_user_owner(self) -> bool:
         """
         return Path(self.experiment_data["ROOTDIR"]).owner() == self.experiment_data["AS_ENV_CURRENT_USER"]
 
+    @property
+    def is_current_logged_user_owner(self) -> bool:
+        """
+        Check if the current user is the owner of the experiment folder
+        :return: bool
+        """
+        return Path(self.experiment_data["ROOTDIR"]).owner() == os.environ.get("USER", None)
+
     @staticmethod
     def load_as_env_variables(parameters: Dict[str, Any]) -> Dict[str, Any]:
         """
@@ -1866,14 +1874,15 @@ def load_workflow_commit(self) -> None:
         """
         Load the workflow commit from the .git folder
         """
-        project_dir = f"{self.experiment_data.get('ROOTDIR', '')}/proj/{self.experiment_data.get('PROJECT', {}).get('PROJECT_DESTINATION', 'git_project')}"
-        if Path(project_dir).joinpath(".git").exists():
-            with suppress(KeyError, ValueError, UnicodeDecodeError):
-                self.experiment_data["AUTOSUBMIT"]["WORKFLOW_COMMIT"] = subprocess.check_output(
-                    "git rev-parse HEAD",
-                    cwd=project_dir,
-                    shell=True
-                ).decode(locale.getpreferredencoding()).strip("\n")
+        if self.is_current_logged_user_owner:
+            project_dir = f"{self.experiment_data.get('ROOTDIR', '')}/proj/{self.experiment_data.get('PROJECT', {}).get('PROJECT_DESTINATION', 'git_project')}"
+            if Path(project_dir).joinpath(".git").exists():
+                with suppress(KeyError, ValueError, UnicodeDecodeError):
+                    self.experiment_data["AUTOSUBMIT"]["WORKFLOW_COMMIT"] = subprocess.check_output(
+                        "git rev-parse HEAD",
+                        cwd=project_dir,
+                        shell=True
+                    ).decode(locale.getpreferredencoding()).strip("\n")
 
     def load_current_hpcarch_parameters(self) -> None:
         """
@@ -1889,7 +1898,7 @@ def save(self):
         Saves the experiment data into the experiment_folder/conf/metadata folder as a yaml file
         :return: True if the data has changed, False otherwise
         """
-        if self.is_current_real_user_owner:
+        if self.is_current_logged_user_owner:
             if not self.metadata_folder.exists():
                 self.metadata_folder.mkdir(parents=True, exist_ok=True)
                 self.metadata_folder.chmod(0o755)

setup.py

@@ -27,7 +27,7 @@
 
 setup(
     name="autosubmitconfigparser",
-    version="1.0.78",
+    version="1.0.79",
     author="Daniel Beltran Mora",
     author_email="[email protected]",
     description="An utility library that allows to read an Autosubmit 4 experiment configuration.",

test/unit/test_load_workflow_commit.py

@@ -1,5 +1,7 @@
 from pathlib import Path
 import subprocess
+
+import pytest
 from log.log import Log
 
 
@@ -15,10 +17,18 @@ def test_add_autosubmit_dict(autosubmit_config, mocker):
     Log.warning.assert_called_once()
 
 
-def test_load_workflow_commit(autosubmit_config, tmpdir):
+@pytest.mark.parametrize("is_owner", [True, False])
+def test_load_workflow_commit(autosubmit_config, tmpdir, mocker, is_owner):
+    """Test that the workflow commit is correctly injected into the experiment_data (Autosubmit will add it to the database)."""
     as_conf = autosubmit_config(
         expid='a000',
-        experiment_data={})
+        experiment_data={}
+    )
+    mocker.patch(
+        "autosubmitconfigparser.config.configcommon.AutosubmitConfig.is_current_logged_user_owner",
+        new_callable=mocker.PropertyMock,  # This is needed for property mocking
+        return_value=is_owner
+    )
     as_conf.reload()
     assert "AUTOSUBMIT" in as_conf.experiment_data
     assert "WORKFLOW_COMMIT" not in as_conf.experiment_data["AUTOSUBMIT"]
@@ -33,12 +43,15 @@ def test_load_workflow_commit(autosubmit_config, tmpdir):
     project_dir = f"{as_conf.experiment_data.get('ROOTDIR', '')}/proj"
 
     Path(project_dir).mkdir(parents=True, exist_ok=True)
-    # Project root is third parent, ../../../ (zero-indexed).
+    # Project root is third parent, ../../../.
     project_path = Path(__file__).parents[2]
     # git clone this project
     output = subprocess.check_output(f"git clone file://{project_path} git_project",
                                      cwd=project_dir, shell=True)
     assert output is not None
     as_conf.load_workflow_commit()
-    assert "WORKFLOW_COMMIT" in as_conf.experiment_data["AUTOSUBMIT"]
-    assert len(as_conf.experiment_data["AUTOSUBMIT"]["WORKFLOW_COMMIT"]) > 0
+    if is_owner:
+        assert "WORKFLOW_COMMIT" in as_conf.experiment_data["AUTOSUBMIT"]
+        assert len(as_conf.experiment_data["AUTOSUBMIT"]["WORKFLOW_COMMIT"]) > 0
+    else:
+        assert "WORKFLOW_COMMIT" not in as_conf.experiment_data["AUTOSUBMIT"]

test/unit/test_properties.py

@@ -0,0 +1,27 @@
+import os
+
+import pytest
+
+
+@pytest.mark.parametrize("is_owner", [True, False])
+def test_is_current_real_user_owner(autosubmit_config, mocker, is_owner):
+    """Test if the SUDO_USER from the environment matches the owner of the current experiment."""
+    as_conf = autosubmit_config(
+        expid='a000',
+        experiment_data={"ROOTDIR": "/dummy/rootdir", "AS_ENV_CURRENT_USER": "dummy"}
+    )
+    mocker.patch("pathlib.Path.owner", return_value="dummy" if is_owner else "otheruser")
+    assert as_conf.is_current_real_user_owner == is_owner
+
+
+@pytest.mark.parametrize("is_owner", [True, False])
+def test_is_current_logged_user_owner(autosubmit_config, mocker, is_owner):
+    """Test if the USER from the environment matches the owner of the current experiment."""
+    as_conf = autosubmit_config(
+        expid='a000',
+        experiment_data={"ROOTDIR": "/dummy/rootdir"}
+    )
+    os.environ["USER"] = "dummy" if is_owner else "otheruser"
+
+    mocker.patch("pathlib.Path.owner", return_value="dummy")
+    assert as_conf.is_current_logged_user_owner == is_owner

test/unit/test_save.py

@@ -1,3 +1,5 @@
+import os
+
 import pytest
 from pathlib import Path
 from ruamel.yaml import YAML
@@ -17,10 +19,11 @@
 ], ids=["local_true", "local_false"])
 def test_save(autosubmit_config, tmpdir, mocker, data, owner):
     data['ROOTDIR'] = tmpdir.strpath
+
     if owner:
-        data['AS_ENV_CURRENT_USER'] = Path(tmpdir).owner()
+        os.environ["USER"] = Path(tmpdir).owner()
     else:
-        data['AS_ENV_CURRENT_USER'] = 'whatever'
+        os.environ["USER"] = 'whatever'
     as_conf = autosubmit_config(expid='t000', experiment_data=data)
     as_conf.save()
     if not owner: