madsci.node_module 0.0.3__tar.gz

madsci_node_module-0.0.3/PKG-INFO

@@ -0,0 +1,11 @@
+Metadata-Version: 2.1
+Name: madsci.node_module
+Version: 0.0.3
+Summary: The Modular Autonomous Discovery for Science (MADSci) Node Module Helper Classes.
+Author-Email: Tobias Ginsburg <tginsburg@anl.gov>, "Ryan D. Lewis" <ryan.lewis@anl.gov>, Casey Stone <cstone@anl.gov>, Doga Ozgulbas <dozgulbas@anl.gov>
+License: MIT
+Project-URL: Homepage, https://github.com/AD-SDL/MADSci
+Requires-Python: >=3.9.1
+Requires-Dist: madsci.common
+Description-Content-Type: text/markdown
+

madsci_node_module-0.0.3/pyproject.toml

@@ -0,0 +1,29 @@
+[project]
+name = "madsci.node_module"
+version = "0.0.3"
+description = "The Modular Autonomous Discovery for Science (MADSci) Node Module Helper Classes."
+authors = [
+    { name = "Tobias Ginsburg", email = "tginsburg@anl.gov" },
+    { name = "Ryan D. Lewis", email = "ryan.lewis@anl.gov" },
+    { name = "Casey Stone", email = "cstone@anl.gov" },
+    { name = "Doga Ozgulbas", email = "dozgulbas@anl.gov" },
+]
+requires-python = ">=3.9.1"
+readme = "README.md"
+dependencies = [
+    "madsci.common",
+]
+
+[project.license]
+text = "MIT"
+
+[project.urls]
+Homepage = "https://github.com/AD-SDL/MADSci"
+
+[build-system]
+requires = [
+    "pdm-backend",
+]
+build-backend = "pdm.backend"
+
+[tool]

madsci_node_module-0.0.3/tests/example_rest_node.py

@@ -0,0 +1,79 @@
+"""A test REST Node for validating the madsci.node_module package."""
+
+from typing import Optional
+
+from madsci.client.event_client import EventClient
+from madsci.common.types.node_types import RestNodeConfig
+from madsci.node_module.abstract_node_module import action
+from madsci.node_module.rest_node_module import RestNode
+
+
+class TestNodeConfig(RestNodeConfig):
+    """Configuration for the test node module."""
+
+    test_required_param: int
+    """A required parameter."""
+    test_optional_param: Optional[int] = None
+    """An optional parameter."""
+    test_default_param: int = 42
+    """A parameter with a default value."""
+
+
+class TestNodeInterface:
+    """A fake test interface for testing."""
+
+    status_code: int = 0
+
+    def __init__(self, logger: Optional[EventClient] = None) -> "TestNodeInterface":
+        """Initialize the test interface."""
+        self.logger = logger if logger else EventClient()
+
+    def run_command(self, command: str, fail: bool = False) -> bool:
+        """Run a command on the test interface."""
+        self.logger.log(f"Running command {command}.")
+        if fail:
+            self.logger.log(f"Failed to run command {command}.")
+            return False
+        return True
+
+
+class TestNode(RestNode):
+    """A test node module for automated testing."""
+
+    test_interface: TestNodeInterface = None
+    config_model = TestNodeConfig
+
+    def startup_handler(self) -> None:
+        """Called to (re)initialize the node. Should be used to open connections to devices or initialize any other resources."""
+        self.test_interface = TestNodeInterface(logger=self.logger)
+        self.logger.log("Test node initialized!")
+
+    def shutdown_handler(self) -> None:
+        """Called to shutdown the node. Should be used to close connections to devices or release any other resources."""
+        self.logger.log("Shutting down")
+        del self.test_interface
+
+    def state_handler(self) -> dict[str, int]:
+        """Periodically called to get the current state of the node."""
+        if self.test_interface is not None:
+            self.node_state = {
+                "test_status_code": self.test_interface.status_code,
+            }
+        return self.node_state
+
+    @action
+    def test_action(self, test_param: int) -> bool:
+        """A test action."""
+        return self.test_interface.run_command(f"Test action with param {test_param}.")
+
+    @action
+    def test_action_fail(self, test_param: int) -> bool:
+        """A test action that fails."""
+        return self.test_interface.run_command(
+            f"Test action with param {test_param}.", fail=True
+        )
+
+
+if __name__ == "__main__":
+    test_node = TestNode()
+    test_node.start_node()

madsci_node_module-0.0.3/tests/test_module.module.yaml

@@ -0,0 +1,21 @@
+node_name: null
+module_name: TestModule
+node_type: device
+module_description: A module for automated testing
+module_version: 0.0.1
+capabilities:
+  get_info: false
+  get_state: false
+  get_status: false
+  send_action: false
+  get_action_result: false
+  get_action_history: false
+  action_files: false
+  send_admin_commands: false
+  set_config: false
+  get_resources: false
+  get_log: false
+  events: false
+  resources: false
+  admin_commands: []
+commands: {}