Xrdcp installation only required when copying to/from EOS.

Author: freddieknets

xboinc/__init__.py

@@ -5,10 +5,6 @@
 
 from .general import _pkg_root, __version__, __xsuite__versions__
 
-from .server.eos import is_xrdcp_installed
-if not is_xrdcp_installed():
-    raise Exception("xrdcp is not installed on your system.")
-
 from .register import register
 from .submit import SubmitJobs
 

xboinc/register.py

@@ -40,6 +40,8 @@ def _set_rights(folder, domain):
 
 
 def register(user, folder):
+    if not xrdcp_installed():
+        raise ValueError("Error: xrdcp is not installed on your system. Cannot register to server.")
     folder = Path(folder).expanduser().resolve()
     if not folder.is_dir():
         raise ValueError(f"Folder {folder} not found or not a folder (or no permissions)!")

xboinc/server/eos.py

@@ -11,21 +11,26 @@
 from .tools import log_debug, log_info, log_error
 
 
+# TODO: replace xrdcp with 'eos cp'
+# Alternatively with pyxrootd (https://xrootd.slac.stanford.edu/doc/python/xrootd-python-0.1.0/index.html)
+# though the latter is not in active development
+
+
 # Functions to work with the EOS file system
 # ==========================================
 EOS_MGM_URL = 'root://eosuser.cern.ch'
 eos_env = {**os.environ, 'EOS_MGM_URL': EOS_MGM_URL}
 
 
-def is_xrdcp_installed():
+def xrdcp_installed():
     try:
         # Run the xrdcp command with the "--version" flag to check if it's installed
         cmd = subprocess.run(["xrdcp", "--version"], stdout=subprocess.PIPE, stderr=subprocess.PIPE, check=True)
         if cmd.returncode == 0:
             return True
         else:
             return False
-    except subprocess.CalledProcessError:
+    except (subprocess.CalledProcessError, FileNotFoundError):
         # xrdcp is not installed or returned an error
         return False
 
@@ -80,26 +85,30 @@ def eos_rm(path, is_server=False):
 
 # Always use this file by file, not for a list of files
 def cp_from_eos(source, target, maximum_trials=10, wait=2.7, is_server=False):
-    try:
-        target = Path(target).expanduser().resolve()
-        for i in range(maximum_trials):
-            cmd = subprocess.run(['xrdcp', '--cksum', 'adler32', _eos_path(source), target.as_posix()], env=eos_env)
-            if cmd.returncode == 0 and target.exists() and target.stat().st_size!=0:
-                return 0
-            if i != maximum_trials-1:
-                log_debug(f"Failed to copy {str(source)} to {str(target)}!\nRetrying ({i})..", is_server=is_server)
-                sleep(abs(wait+random.normalvariate(0, 0.1*wait)))
-        log_error(f"Failed to copy {str(source)} to {str(target)}!", is_server=is_server)
-        if not target.exists() or target.stat().st_size==0:
-            log_error(f"Command succeeds but destination file is not created!", is_server=is_server)
-        else:
-            stderr = cmd.stderr.decode('UTF-8').strip().split('\n')
-            log_error(f"Command failed: {stderr}", is_server=is_server)
-        log_error("\nGiving up.", is_server=is_server)
-        return 1
-    except Exception as e:
-        log_error(f"Failed to copy {str(source)} to {str(target)}!\n", e, is_server=is_server)
+    if not xrdcp_installed():
+        log_error("Error: xrdcp is not installed on your system. Cannot copy from EOS.", ValueError(), is_server=is_server)
         return 1
+    else:
+        try:
+            target = Path(target).expanduser().resolve()
+            for i in range(maximum_trials):
+                cmd = subprocess.run(['xrdcp', '--cksum', 'adler32', _eos_path(source), target.as_posix()], env=eos_env)
+                if cmd.returncode == 0 and target.exists() and target.stat().st_size!=0:
+                    return 0
+                if i != maximum_trials-1:
+                    log_debug(f"Failed to copy {str(source)} to {str(target)}!\nRetrying ({i})..", is_server=is_server)
+                    sleep(abs(wait+random.normalvariate(0, 0.1*wait)))
+            log_error(f"Failed to copy {str(source)} to {str(target)}!", is_server=is_server)
+            if not target.exists() or target.stat().st_size==0:
+                log_error(f"Command succeeds but destination file is not created!", is_server=is_server)
+            else:
+                stderr = cmd.stderr.decode('UTF-8').strip().split('\n')
+                log_error(f"Command failed: {stderr}", is_server=is_server)
+            log_error("\nGiving up.", is_server=is_server)
+            return 1
+        except Exception as e:
+            log_error(f"Failed to copy {str(source)} to {str(target)}!\n", e, is_server=is_server)
+            return 1
 
 def mv_from_eos(source, target, maximum_trials=10, wait=2.7, is_server=False):
     if not cp_from_eos(source, target, maximum_trials, wait, is_server=is_server):   # returncode 0 means success
@@ -108,28 +117,32 @@ def mv_from_eos(source, target, maximum_trials=10, wait=2.7, is_server=False):
 
 # Always use this file by file, not for a list of files
 def cp_to_eos(source, target, maximum_trials=10, wait=2.7, is_server=False):
-    try:
-        source = Path(source).expanduser().resolve()
-        target = Path(target, source.name).expanduser().resolve()
-#         target = Path(target).expanduser().resolve()
-        for i in range(maximum_trials):
-            cmd = subprocess.run(['xrdcp', '--cksum', 'adler32', source.as_posix(), _eos_path(target)], env=eos_env)
-            if cmd.returncode == 0 and eos_exists(target):
-                return 0
-            if i != maximum_trials-1:
-                log_debug(f"Failed to copy {str(source)} to {str(target)}!\nRetrying ({i})..", is_server=is_server)
-                sleep(abs(wait+random.normalvariate(0, 0.1*wait)))
-        log_error(f"Failed to copy {str(source)} to {str(target)}!", is_server=is_server)
-        if not eos_exists(target):
-            log_error(f"Command succeeds but destination file is not created!", is_server=is_server)
-        else:
-            stderr = cmd.stderr.decode('UTF-8').strip().split('\n')
-            log_error(f"Command failed: {stderr}", is_server=is_server)
-        log_error("\nGiving up.", is_server=is_server)
-        return 1
-    except Exception as e:
-        log_error(f"Failed to copy {str(source)} to {str(target)}!\n", e, is_server=is_server)
+    if not xrdcp_installed():
+        log_error("Error: xrdcp is not installed on your system. Cannot copy to EOS.", ValueError(), is_server=is_server)
         return 1
+    else:
+        try:
+            source = Path(source).expanduser().resolve()
+            target = Path(target, source.name).expanduser().resolve()
+#             target = Path(target).expanduser().resolve()
+            for i in range(maximum_trials):
+                cmd = subprocess.run(['xrdcp', '--cksum', 'adler32', source.as_posix(), _eos_path(target)], env=eos_env)
+                if cmd.returncode == 0 and eos_exists(target):
+                    return 0
+                if i != maximum_trials-1:
+                    log_debug(f"Failed to copy {str(source)} to {str(target)}!\nRetrying ({i})..", is_server=is_server)
+                    sleep(abs(wait+random.normalvariate(0, 0.1*wait)))
+            log_error(f"Failed to copy {str(source)} to {str(target)}!", is_server=is_server)
+            if not eos_exists(target):
+                log_error(f"Command succeeds but destination file is not created!", is_server=is_server)
+            else:
+                stderr = cmd.stderr.decode('UTF-8').strip().split('\n')
+                log_error(f"Command failed: {stderr}", is_server=is_server)
+            log_error("\nGiving up.", is_server=is_server)
+            return 1
+        except Exception as e:
+            log_error(f"Failed to copy {str(source)} to {str(target)}!\n", e, is_server=is_server)
+            return 1
 
 def mv_to_eos(source, target, maximum_trials=10, wait=2.7, is_server=False):
     if not cp_to_eos(source, target, maximum_trials, wait, is_server=is_server):   # returncode 0 means success

xboinc/submit.py

@@ -9,7 +9,7 @@
 import tempfile
 
 from .user import get_domain, get_folder
-from .server.eos import mv_from_eos, mv_to_eos
+from .server.eos import mv_from_eos, mv_to_eos, xrdcp_installed
 from .server.tools import timestamp
 from .simulation_io import SimConfig, app_version
 
@@ -24,6 +24,8 @@ def __init__(self, user, study):
             raise ValueError("The character sequence '__' is not allowed in 'study'!")
         self._username = user
         self._domain = get_domain(user)
+        if self._domain=='eos' and not xrdcp_installed():
+            raise ValueError("Error: xrdcp is not installed on your system. Cannot submit.")
         self._target = get_folder(user)
         self._studyname = study
         self._submitfile = f"{self._studyname}__{timestamp()}.tar.gz"