feat: Increase test coverage for pysqa/base/remote.py (#448)

* feat: Increase test coverage for pysqa/base/remote.py

- Add tests for get_job_from_remote
- Add tests for authentication methods in _open_ssh_connection
- Increase coverage of pysqa/base/remote.py from 72% to 80%

* Format black

* Update _version.py

* Update queue.yaml

* Update queue.yaml

* Update queue.yaml

* Update test_remote_auth.py

---------

Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
Co-authored-by: pyiron-runner <[email protected]>

Author: 3 people

tests/config/remote_rebex/queue.yaml

@@ -11,4 +11,4 @@ ssh_continous_connection: False
 ssh_port: 22
 python_executable: python3
 queues:
-  remote: {cores_max: 100, cores_min: 10, run_time_max: 259200}
+  remote: {cores_max: 100, cores_min: 10, run_time_max: 259200}

tests/test_remote.py

@@ -176,4 +176,23 @@ def test_get_transport(self):
         remote = QueueAdapter(directory=os.path.join(path, "config/remote_rebex"))
         self.assertIsNotNone(get_transport(remote._adapter._open_ssh_connection()))
         with self.assertRaises(ValueError):
-            get_transport(ssh=FakeSSH())
+            get_transport(ssh=FakeSSH())
+
+    def test_get_job_from_remote(self):
+        path = os.path.dirname(os.path.abspath(__file__))
+        remote = QueueAdapter(directory=os.path.join(path, "config/remote_rebex"))
+        remote._adapter._ssh_remote_path = path
+        remote._adapter._ssh_local_path = path
+        remote._adapter._ssh_delete_file_on_remote = True
+        with unittest.mock.patch(
+            "pysqa.base.remote.RemoteQueueAdapter._execute_remote_command"
+        ) as mock_execute:
+            mock_execute.return_value = '{"dirs": [], "files": ["test.txt"]}'
+            with unittest.mock.patch(
+                "pysqa.base.remote.RemoteQueueAdapter._transfer_files"
+            ) as mock_transfer:
+                remote._adapter.get_job_from_remote(
+                    working_directory=os.path.join(path, "config/empty")
+                )
+                self.assertEqual(mock_transfer.call_count, 1)
+            self.assertEqual(mock_execute.call_count, 2)

tests/test_remote_auth.py

@@ -0,0 +1,39 @@
+import os
+import unittest
+from pysqa import QueueAdapter
+
+try:
+    import paramiko
+    from tqdm import tqdm
+    from pysqa.base.remote import get_transport
+
+    skip_remote_test = False
+except ImportError:
+    skip_remote_test = True
+
+
+@unittest.skipIf(
+    skip_remote_test,
+    "Either paramiko or tqdm are not installed, so the remote queue adapter tests are skipped.",
+)
+class TestRemoteQueueAdapterAuth(unittest.TestCase):
+    def test_password_auth(self):
+        path = os.path.dirname(os.path.abspath(__file__))
+        remote = QueueAdapter(directory=os.path.join(path, "config/remote_rebex"))
+        remote._adapter._ssh_ask_for_password = False
+        remote._adapter._ssh_key = None
+        self.assertIsNotNone(remote._adapter._open_ssh_connection())
+
+    def test_key_auth(self):
+        path = os.path.dirname(os.path.abspath(__file__))
+        remote = QueueAdapter(directory=os.path.join(path, "config/remote_rebex"))
+        remote._adapter._ssh_password = None
+        with self.assertRaises(ValueError):
+            remote._adapter._open_ssh_connection()
+
+    def test_two_factor_auth(self):
+        path = os.path.dirname(os.path.abspath(__file__))
+        remote = QueueAdapter(directory=os.path.join(path, "config/remote_rebex"))
+        remote._adapter._ssh_two_factor_authentication = True
+        with self.assertRaises(paramiko.ssh_exception.AuthenticationException):
+            remote._adapter._open_ssh_connection()