util/managedfile: error on unsynced retrieval

For the managedfile, if it is remote, the rpath will only be available
once the resource has been synced to the remote host. Raise an error if
retrieval is attempted before synchronization.

Signed-off-by: Rouven Czerwinski <[email protected]>

Author: Emantor

labgrid/util/managedfile.py

@@ -131,6 +131,9 @@ def get_remote_path(self):
             str: path to the file on the remote host
         """
         if isinstance(self.resource, NetworkResource):
+            if self.rpath is None:
+                raise ManagedFileError("sync_to_resource() needs to be called before the remote-path can be retrieved")
+
             return f"{self.rpath}{os.path.basename(self.local_path)}"
 
         return self.local_path

tests/test_util.py

@@ -1,4 +1,5 @@
 import os.path
+import re
 import subprocess
 import socket
 import atexit
@@ -14,7 +15,7 @@
 from labgrid.util.helper import get_free_port
 from labgrid.util.ssh import ForwardError, SSHConnection, sshmanager
 from labgrid.util.proxy import proxymanager
-from labgrid.util.managedfile import ManagedFile
+from labgrid.util.managedfile import ManagedFile, ManagedFileError
 from labgrid.driver.exception import ExecutionError
 from labgrid.resource.serialport import NetworkSerialPort
 from labgrid.resource.common import Resource, NetworkResource
@@ -352,6 +353,22 @@ def test_local_managedfile(target, tmpdir):
     assert hash == mf.get_hash()
     assert str(t) == mf.get_remote_path()
 
+def test_network_managedfile_no_sync(target, tmpdir):
+    import hashlib
+
+    res = NetworkResource(target, "localhost", "test")
+    t = tmpdir.join("test")
+    t.write(
+"""
+Test
+"""
+    )
+    mf = ManagedFile(t, res, detect_nfs=False)
+
+    expected = re.escape("sync_to_resource() needs to be called before the remote-path can be retrieved")
+    with pytest.raises(ManagedFileError, match=expected) as e:
+        mf.get_remote_path()
+
 
 def test_find_dict():
     dict_a = {"a": {"a.a": {"a.a.a": "a.a.a_val"}}, "b": "b_val"}