Add basic implementation

Author: acampove

src/dmu/fsystem/fcopy.py

@@ -0,0 +1,50 @@
+'''
+Module holding FCopy class and FCopyConf
+'''
+from pathlib               import Path
+from typing                import Final
+from pydantic              import BaseModel
+from dmu.logging.log_store import LogStore
+
+log=LogStore.add_logger('dmu:fsystem:fcopy')
+# ----------------------
+class FCopyConf(BaseModel):
+    '''
+    Class meant to store configuration for FCopy
+    '''
+    host : str
+# ----------------------
+class FCopy:
+    '''
+    Class meant to act as a wrapper to rsync by
+
+    - Checking that the server and local machine are suitable
+    - Talking to rsync
+    '''
+    # ----------------------
+    def __init__(self, cfg : FCopyConf):
+        '''
+        Parameters
+        -------------
+        cfg: Instance of FCopyConf storing configuration
+        '''
+        self._cfg : Final[FCopyConf] = cfg
+    # ----------------------
+    def copy(self, source : Path, target : Path) -> bool:
+        '''
+        Parameters
+        ---------------
+        source: Path to file to be copied
+        target: Destination path
+
+        Returns
+        ---------------
+        True if success
+        '''
+        log.debug('')
+        log.debug(source)
+        log.debug('--->')
+        log.debug(target)
+
+        return True
+# ----------------------

tests/fsystem/test_fcopy.py

@@ -2,15 +2,54 @@
 Script with tests for FCopy class
 '''
 
-from dmu import FCopy 
+from pathlib import Path
+from dmu     import FCopy, FCopyConf
 
 from dmu.logging.log_store import LogStore
 
 log=LogStore.add_logger('dmu:test_fcopy')
 # ----------------------
-def test_simple() -> None:
+def _make_paths(
+    dir       : Path, 
+    make_file : bool,
+    number    : int,
+    size      : int = 1) -> list[Path]:
+    '''
+    Parameters
+    -------------
+    dir      : Path to directory
+    make_file: If true, will make an empty file
+    number   : Number of paths to make
+    size     : Size in MB, default 1
+
+    Returns
+    -------------
+    List of paths
+    '''
+    dir.mkdir(parents=True, exist_ok=True)
+
+    l_path = []
+    for index in range(number):
+        path = dir / f'{index:03}'
+
+        if make_file:
+            with open(path, 'wb') as f:
+                f.seek(size * 1024 * 1024 - 1)
+                f.write(b'\0')
+
+        l_path.append(path)
+
+    return l_path
+# ----------------------
+def test_simple(tmp_path) -> None:
     '''
     '''
+    l_source = _make_paths(dir=tmp_path / 'source', make_file= True, number=10)
+    l_target = _make_paths(dir=tmp_path / 'target', make_file=False, number=10)
+
+    cfg = FCopyConf(host='localhost')
     fcp = FCopy(cfg=cfg)
-    fcp.copy(source=source, target=target)
+
+    for source, target in zip(l_source, l_target):
+        fcp.copy(source=source, target=target)
 # ----------------------