Merge pull request #196 from bennyz/tftp-driver

introduce tftp driver

Author: mangelajo

contrib/drivers/tftp/.gitignore

@@ -0,0 +1,3 @@
+__pycache__/
+.coverage
+coverage.xml

contrib/drivers/tftp/.python-version

@@ -0,0 +1 @@
+3.12

contrib/drivers/tftp/README.md

@@ -0,0 +1,3 @@
+# Jumpstarter Driver for TFTP
+
+Simple TFTP server driver for Jumpstarter

contrib/drivers/tftp/examples/exporter.yaml

@@ -0,0 +1,16 @@
+apiVersion: jumpstarter.dev/v1alpha1
+kind: ExporterConfig
+endpoint: grpc.jumpstarter.192.168.0.203.nip.io:8082
+token: "<token>"
+export:
+  serial:
+    type: "jumpstarter.drivers.pyserial.driver.PySerial"
+    config:
+      url: "/dev/ttyUSB0"
+      baudrate: 1843200
+  tftp:
+    type: jumpstarter_driver_tftp.driver.TftpServer
+    config:
+      root_dir: "/var/lib/tftpboot/"
+      host: "192.168.1.111"
+      port: 6969

contrib/drivers/tftp/examples/tftp_test.py

@@ -0,0 +1,49 @@
+import time
+
+from jumpstarter_driver_tftp.driver import FileNotFound, TftpError
+
+from jumpstarter.common.utils import env
+
+
+def test_tftp_upload():
+    with env() as client:
+        try:
+            client.tftp.start()
+            print("TFTP server started")
+
+            time.sleep(1)
+
+            test_file = "test.bin"
+            with open(test_file, "wb") as f:
+                f.write(b"Hello from TFTP streaming test!")
+
+            try:
+                client.tftp.put_local_file(test_file)
+                print(f"Successfully uploaded {test_file}")
+
+                files = client.tftp.list_files()
+                print(f"Files in TFTP root: {files}")
+
+                if test_file in files:
+                    client.tftp.delete_file(test_file)
+                    print(f"Successfully deleted {test_file}")
+                else:
+                    print(f"Warning: {test_file} not found in TFTP root")
+
+            except TftpError as e:
+                print(f"TFTP operation failed: {e}")
+            except FileNotFound as e:
+                print(f"File not found: {e}")
+
+        except Exception as e:
+            print(f"Error: {e}")
+        finally:
+            try:
+                client.tftp.stop()
+                print("TFTP server stopped")
+            except Exception as e:
+                print(f"Error stopping server: {e}")
+
+
+if __name__ == "__main__":
+    test_tftp_upload()

contrib/drivers/tftp/pyproject.toml

@@ -0,0 +1,41 @@
+[project]
+name = "jumpstarter-driver-tftp"
+version = "0.1.0"
+description = "Add your description here"
+readme = "README.md"
+authors = [
+    { name = "Benny Zlotnik", email = "bzlotnik@redhat.com" }
+]
+requires-python = ">=3.12"
+dependencies = [
+    "anyio>=4.6.2.post1",
+    "jumpstarter",
+    "aiofiles>=24.1.0"
+]
+
+[tool.hatch.version]
+source = "vcs"
+raw-options = { 'root' = '../../../'}
+
+[tool.hatch.metadata.hooks.vcs.urls]
+Homepage = "https://jumpstarter.dev"
+source_archive = "https://github.com/jumpstarter-dev/repo/archive/{commit_hash}.zip"
+
+[tool.pytest.ini_options]
+#addopts = "--cov --cov-report=html --cov-report=xml"
+log_cli = true
+log_cli_level = "INFO"
+testpaths = ["src"]
+asyncio_mode = "auto"
+
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[dependency-groups]
+dev = [
+    "pytest-cov>=6.0.0",
+    "pytest>=8.3.3",
+    "ruff>=0.7.1",
+
+]

contrib/drivers/tftp/src/jumpstarter_driver_tftp/__init__.py

@@ -0,0 +1,110 @@
+from dataclasses import dataclass
+from pathlib import Path
+
+from opendal import Operator
+
+from jumpstarter.client import DriverClient
+from jumpstarter.client.adapters import OpendalAdapter
+
+
+@dataclass(kw_only=True)
+class TftpServerClient(DriverClient):
+    """
+    Client interface for TFTP Server driver
+
+    This client provides methods to control a TFTP server and manage files on it.
+    Supports file operations like uploading from various storage backends through OpenDAL.
+    """
+
+    def start(self):
+        """
+        Start the TFTP server
+
+        Initializes and starts the TFTP server if it's not already running.
+        The server will listen on the configured host and port.
+        """
+        self.call("start")
+
+    def stop(self):
+        """
+        Stop the TFTP server
+
+        Stops the running TFTP server and releases associated resources.
+
+        Raises:
+            ServerNotRunning: If the server is not currently running
+        """
+        self.call("stop")
+
+    def list_files(self) -> list[str]:
+        """
+        List files in the TFTP server root directory
+
+        Returns:
+            list[str]: A list of filenames present in the TFTP server's root directory
+        """
+        return self.call("list_files")
+
+    def put_file(self, operator: Operator, path: str):
+        """
+        Upload a file to the TFTP server using an OpenDAL operator
+
+        Args:
+            operator (Operator): OpenDAL operator for accessing the source storage
+            path (str): Path to the file in the source storage system
+
+        Returns:
+            str: Name of the uploaded file
+        """
+        filename = Path(path).name
+        with OpendalAdapter(client=self, operator=operator, path=path, mode="rb") as handle:
+            return self.call("put_file", filename, handle)
+
+    def put_local_file(self, filepath: str):
+        """
+        Upload a file from the local filesystem to the TFTP server
+        Note: this doesn't use TFTP to upload.
+
+        Args:
+            filepath (str): Path to the local file to upload
+
+        Returns:
+            str: Name of the uploaded file
+
+        Example:
+            >>> client.put_local_file("/path/to/local/file.txt")
+        """
+        absolute = Path(filepath).resolve()
+        with OpendalAdapter(client=self, operator=Operator("fs", root="/"), path=str(absolute), mode="rb") as handle:
+            return self.call("put_file", absolute.name, handle)
+
+    def delete_file(self, filename: str):
+        """
+        Delete a file from the TFTP server
+
+        Args:
+            filename (str): Name of the file to delete
+
+        Raises:
+            FileNotFound: If the specified file doesn't exist
+            TftpError: If deletion fails for other reasons
+        """
+        return self.call("delete_file", filename)
+
+    def get_host(self) -> str:
+        """
+        Get the host address the TFTP server is listening on
+
+        Returns:
+            str: The IP address or hostname the server is bound to
+        """
+        return self.call("get_host")
+
+    def get_port(self) -> int:
+        """
+        Get the port number the TFTP server is listening on
+
+        Returns:
+            int: The port number (default is 69)
+        """
+        return self.call("get_port")