add scripts for manual testing (#14)

* scaffold script organization

* formatting

* add manual scripts. ignore bpython from typechecking

* add step function to manual scripts for convenience

* add manual scripts

* abstract step function to separate module

Author: jacklowrie

pyproject.toml

@@ -115,9 +115,13 @@ convention = "google"
 python_version = "3.10"
 warn_return_any = true
 warn_unused_configs = true
-files = ["src", "tests"]
+files = ["src", "tests", "scripts"]
 exclude = [
     '(^|.*/)__pycache__/',  # matches __pycache__ at any depth
     '(^|.*/).ruff_cache/',
     '(^|.*/).mypy_cache/',
 ]
+
+[[tool.mypy.overrides]]
+module = ["bpython"]
+ignore_missing_imports = true

scripts/auto/__init__.py

@@ -0,0 +1 @@
+"""__init__.py: nothing to see here..."""

scripts/auto/anchor.py

@@ -0,0 +1 @@
+"""anchor.py: creates and starts an anchor node for testing."""

scripts/auto/joiner.py

@@ -0,0 +1 @@
+"""joiner.py: creates a joining node for debugging."""

scripts/manual/__init__.py

@@ -0,0 +1 @@
+"""__init__.py: nothing to see here..."""

scripts/manual/anchor.py

@@ -0,0 +1,33 @@
+"""anchor.py: creates and starts an anchor node for testing."""
+import sys
+
+import bpython
+from step import step  #type: ignore
+
+from chordnet import Node as ChordNode
+
+
+def main() -> None:
+    """Creates a new ring with this computer as the only node."""
+    if len(sys.argv) != 3:
+        print("usage: [uv run] python anchor.py ip_addr port_no")
+        exit(1)
+
+    ip = sys.argv[1]
+    port = int(sys.argv[2])
+
+    node = ChordNode(ip, port)
+    # create (start) the ring
+    node.create()
+    print(f"Node created as \"node\": {node.address}", file=sys.stderr)
+    repl_locals = {
+        'node': node,
+        'step': step,
+    }
+    print("starting repl. access `node`, advance with `step(node)`")
+    bpython.embed(locals_=repl_locals)
+    node.stop()
+
+
+if __name__ == '__main__':
+    main()

scripts/manual/joiner.py

@@ -0,0 +1,36 @@
+"""joiner.py: creates a joining node for debugging."""
+import sys
+
+import bpython
+from step import step  #type: ignore
+
+from chordnet import Node as ChordNode
+
+
+def main() -> None:
+    """Creates a new ring with this computer as the only node."""
+    if len(sys.argv) != 5:
+        print("usage: [uv run] python " \
+              "joiner.py this_ip this_port target_ip target_port")
+        exit(1)
+
+    # Get IP and port from command line arguments
+    ip = sys.argv[1]
+    port = int(sys.argv[2])
+    target_ip = sys.argv[3]
+    target_port = int(sys.argv[4])
+
+    # Create and join node
+    node = ChordNode(ip, port)
+    node.join(target_ip, target_port)
+    repl_locals = {
+        'node': node,
+        'step': step,
+    }
+    print("starting repl. access `node`, advance with `step(node)`")
+    bpython.embed(locals_=repl_locals)
+    node.stop()
+
+
+if __name__ == '__main__':
+    main()

scripts/manual/step.py

@@ -0,0 +1,12 @@
+"""step.py: helper for manual scripts."""
+
+from chordnet import Node as ChordNode
+
+
+def step(node: ChordNode) -> None:
+    """Runs the periodic tasks for the node once."""
+    node.stabilize()
+    node.fix_fingers()
+
+    print(f"pred: {node.predecessor} succ: {node.successor()}")
+    print(node.finger_table)

src/chordnet/address.py

@@ -58,6 +58,7 @@ def __eq__(self, other: object) -> bool:
         """
         if not isinstance(other, Address):
             return NotImplemented
+
         return (self.ip == other.ip and
                 self.port == other.port and
                 self.key == other.key)