fix: using cached version for remove lock on exit (#3709)

* feat: using cached for removing lock file when exiting

* test: adding tests

* chore: adding changelog file 3709.fixed.md [dependabot-skip]

* fix: vulnerabilities warning

* fix: warnings import

* chore: revert "fix: warnings import"

This reverts commit 5593e6b.

* fix: warnings import

---------

Co-authored-by: pyansys-ci-bot <[email protected]>

Author: germa89

doc/changelog.d/3709.fixed.md

@@ -0,0 +1 @@
+fix: using cached version for remove lock on exit

src/ansys/mapdl/core/mapdl_grpc.py

@@ -1197,7 +1197,7 @@ def _exit_mapdl(self, path: str = None) -> None:
 
             self._close_process()
 
-            self._remove_lock_file(path)
+            self._remove_lock_file(path, use_cached=True)
         else:
             self._exit_mapdl_server()
 
@@ -1360,17 +1360,24 @@ def _cache_pids(self):
 
         self._log.debug(f"Recaching PIDs: {self._pids}")
 
-    def _remove_lock_file(self, mapdl_path=None):
+    def _remove_lock_file(
+        self, mapdl_path: str = None, jobname: str = None, use_cached: bool = False
+    ):
         """Removes the lock file.
 
         Necessary to call this as a segfault of MAPDL or exit(0) will
         not remove the lock file.
         """
+        if jobname is None and use_cached:
+            jobname = self._jobname
+        elif jobname is None:
+            jobname = self.jobname
+
         self._log.debug("Removing lock file after exit.")
         if mapdl_path is None:  # pragma: no cover
             mapdl_path = self.directory
         if mapdl_path:
-            for lockname in [self.jobname + ".lock", "file.lock"]:
+            for lockname in [jobname + ".lock", "file.lock"]:
                 lock_file = os.path.join(mapdl_path, lockname)
                 if os.path.isfile(lock_file):
                     try:
@@ -3804,6 +3811,7 @@ def kill_job(self, jobid: int) -> None:
             Job ID.
         """
         cmd = ["scancel", f"{jobid}"]
+        # to ensure the job is stopped properly, let's issue the scancel twice.
         subprocess.Popen(cmd)  # nosec B603
 
     def __del__(self):

tests/test_mapdl.py

@@ -1727,13 +1727,25 @@ def test_mode(mapdl, cleared):
     mapdl._mode = "grpc"  # Going back to default
 
 
-def test_remove_lock_file(mapdl, cleared, tmpdir):
+@pytest.mark.parametrize("use_cached", (True, False))
+def test_remove_lock_file(mapdl, cleared, tmpdir, use_cached):
     tmpdir_ = tmpdir.mkdir("ansys")
     lock_file = tmpdir_.join("file.lock")
     with open(lock_file, "w") as fid:
         fid.write("test")
 
-    mapdl._remove_lock_file(tmpdir_)
+    with patch(
+        "ansys.mapdl.core.mapdl_grpc.MapdlGrpc.jobname", new_callable=PropertyMock
+    ) as mock_jb:
+        mock_jb.return_value = mapdl._jobname
+
+        mapdl._remove_lock_file(tmpdir_, use_cached=use_cached)
+
+    if use_cached:
+        mock_jb.assert_not_called()
+    else:
+        mock_jb.assert_called()
+
     assert not os.path.exists(lock_file)