Add RemoteBin abstract class (#20)

* Add RemoteBin abstract class

* Use abstract class

* Remove bootstrap whitelist from Node config files

* Add abstract stop method

---------

Co-authored-by: sydhds <[email protected]>

massa_test_framework/compile.py

@@ -62,9 +62,9 @@ class CompileOpts:
             "deferred_credits.json": Path(
                 "massa-node/base_config/deferred_credits.json"
             ),
-            "bootstrap_whitelist.json": Path(
-                "massa-node/base_config/bootstrap_whitelist.json"
-            ),
+            # "bootstrap_whitelist.json": Path(
+            #     "massa-node/base_config/bootstrap_whitelist.json"
+            # ),
             "node_privkey.key": Path("massa-node/config/node_privkey.key"),
             "abi_gas_costs.json": Path(
                 "massa-node/base_config/gas_costs/abi_gas_costs.json"
@@ -233,29 +233,26 @@ def build_kind(self) -> BuildKind:
         else:
             return BuildKind.Debug
 
+    def bin_path(self, bin_name: str):
+        """Relative path (relative to compilation folder) to (rust compiled) binary"""
+        if self._target:
+            return Path(f"target/{self._target}/{self.build_kind}/{bin_name}")
+        else:
+            return Path(f"target/{self.build_kind}/{bin_name}")
+
     @property
     def massa_node(self) -> Path:
         """Relative path (relative to compilation folder) to massa node binary"""
-        if self._target:
-            return Path(f"target/{self._target}/{self.build_kind}/massa-node")
-        else:
-            return Path(f"target/{self.build_kind}/massa-node")
+        return self.bin_path("massa-node")
 
     @property
     def massa_client(self) -> Path:
         """Relative path (relative to compilation folder) to massa client binary"""
-        if self._target:
-            return Path(f"target/{self._target}/{self.build_kind}/massa-client")
-        else:
-            return Path(f"target/{self.build_kind}/massa-client")
+        return self.bin_path("massa-client")
 
     @property
     def massa_ledger_editor(self) -> Path:
-        # TODO: can we factorize this with massa_node & massa_client?
-        if self._target:
-            return Path(f"target/{self._target}/{self.build_kind}/massa-ledger-editor")
-        else:
-            return Path(f"target/{self.build_kind}/massa-ledger-editor")
+        return self.bin_path("massa-ledger-editor")
 
     @property
     def config_files(self) -> Dict[str, Path]:

massa_test_framework/remote_bin.py

@@ -0,0 +1,119 @@
+import sys
+from contextlib import contextmanager
+from pathlib import Path
+from dataclasses import dataclass
+from abc import ABC, abstractmethod
+
+from typing import Optional, Dict, List
+
+from .server import Server
+from .compile import CompileUnit, CompileOpts
+from .remote import RemotePath, copy_file
+
+
+@dataclass
+class SrcDst:
+    """Source and Destination paths (usually for copy)"""
+    src: Path
+    dst: Path
+
+
+class RemoteBin(ABC):
+
+    @abstractmethod
+    def __init__(self, server: Server, compile_unit: CompileUnit):
+        # Dummy code
+        self.server = server
+        self.compile_unit = compile_unit
+        self.start_cmd = [""]
+        self.install_folder = self.install({})
+
+    def install(self, to_install: Dict[str, Path | SrcDst], tmp_prefix: str = "remote_bin_") -> Path | RemotePath:
+
+        """
+        Install files from compile unit to a server install folder (tmp folder)
+
+        Args:
+            to_install: a dict of key (filename), path (relative path in install folder)
+            tmp_prefix: prefix for install folder (created as a tmp folder)
+        """
+
+        tmp_folder = self.server.mkdtemp(prefix=tmp_prefix)
+        # self.server.mkdir(tmp_folder)
+        repo = self.compile_unit.repo
+
+        for _filename, to_install_item in to_install.items():
+            if isinstance(to_install_item, SrcDst):
+                src = repo / to_install_item.src
+                dst = tmp_folder / to_install_item.dst
+            else:
+                src = repo / to_install_item
+                dst = tmp_folder / to_install_item
+
+            # print("server mkdir:", dst.parent)
+            self.server.mkdir(dst.parent)
+            # print(f"copy_file {src} -> {dst}")
+            copy_file(src, dst)
+
+        return tmp_folder
+
+    @classmethod
+    def from_compile_unit(cls, server: Server, compile_unit: CompileUnit) -> "RemoteBin":
+        node = cls(server, compile_unit)
+        return node
+
+    @classmethod
+    def from_dev(
+            cls, server: Server, repo: Path, build_opts: Optional[List[str]] = None
+    ) -> "RemoteBin":
+        compile_opts = CompileOpts()
+        compile_opts.already_compiled = repo
+        if build_opts:
+            compile_opts.build_opts = build_opts
+        cu = CompileUnit(server, compile_opts)
+        node = cls(server, cu)
+        return node
+
+    @contextmanager
+    def start(
+            self,
+            env: Optional[Dict[str, str]] = None,
+            args: Optional[List[str]] = None,
+            stdout=sys.stdout,
+            stderr=sys.stderr,
+    ):
+        cmd = " ".join(self.start_cmd)
+        if args:
+            args_joined = " ".join(args)
+            if args_joined:
+                cmd += " "
+                cmd += args_joined
+
+        print(f"{cmd=}")
+        process = self.server.run(
+            [cmd],
+            cwd=str(self.install_folder),
+            env=env,
+            stdout=stdout,
+            stderr=stderr,
+        )
+        with process as p:
+            try:
+                yield p
+            except Exception:
+                # Note: Need to catch every exception here as we need to stop subprocess.Popen
+                #       otherwise it will wait forever
+                #       so first print traceback then stop the process
+                import traceback
+
+                print(traceback.format_exc())
+                self.stop(p)
+                # Re Raise exception so test will be marked as failed
+                raise
+            else:
+                # Note: normal end
+                self.stop(p)
+
+    @abstractmethod
+    def stop(self, process):
+        pass