trigger 2.2.4__tar.gz → 2.2.6__tar.gz

{trigger-2.2.4/trigger.egg-info → trigger-2.2.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: trigger
-Version: 2.2.4
+Version: 2.2.6
 Summary: Network automation toolkit for managing network devices
 Author-email: Jathan McCollum <jathan@gmail.com>
 License-Expression: BSD-3-Clause

{trigger-2.2.4 → trigger-2.2.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "trigger"
-version = "2.2.4"
+version = "2.2.6"
 description = "Network automation toolkit for managing network devices"
 readme = "README.md"
 license = "BSD-3-Clause"

{trigger-2.2.4 → trigger-2.2.6}/tests/test_twister.py

@@ -1,9 +1,14 @@
 import re
+from unittest.mock import MagicMock
 
 import pytest
 
 from trigger.conf import settings
-from trigger.twister import compile_prompt_pattern, prompt_match_start
+from trigger.twister import (
+    compile_prompt_pattern,
+    is_awaiting_confirmation,
+    prompt_match_start,
+)
 
 
 def test_ioslike_prompt_pattern_enabled():
@@ -253,3 +258,184 @@ def test_vendor_pattern_compiles_without_error(vendor):
     """Every vendor pattern in PROMPT_PATTERNS must compile successfully."""
     pat = compile_prompt_pattern(settings.PROMPT_PATTERNS[vendor])
     assert isinstance(pat, re.Pattern)
+
+
+# =============================================================================
+# is_awaiting_confirmation tests
+# =============================================================================
+
+
+class TestIsAwaitingConfirmation:
+    """Verify is_awaiting_confirmation detects all CONTINUE_PROMPTS patterns."""
+
+    @pytest.mark.parametrize(
+        "prompt",
+        [
+            "Do you want to continue?",
+            "Are you sure you want to proceed?",
+            "Save changes (y/n):",
+            "Confirm action [y/n]:",
+            "Press enter to [confirm]",
+            "Overwrite existing config [yes/no]: ",
+            "overwrite file [startup-config] ?[yes/press any key for no]....",
+            "Destination filename [running-config]? ",
+        ],
+    )
+    def test_detects_confirmation_prompts(self, prompt):
+        """Each CONTINUE_PROMPTS pattern should be detected."""
+        assert is_awaiting_confirmation(prompt) is True
+
+    @pytest.mark.parametrize(
+        "prompt",
+        [
+            "router1# ",
+            "show version",
+            "Building configuration...",
+            "interface GigabitEthernet0/0",
+            "",
+        ],
+    )
+    def test_rejects_non_confirmation_prompts(self, prompt):
+        """Normal command output should not be detected as confirmation."""
+        assert is_awaiting_confirmation(prompt) is False
+
+    def test_case_insensitive(self):
+        """Detection should be case-insensitive."""
+        assert is_awaiting_confirmation("CONTINUE?") is True
+        assert is_awaiting_confirmation("Proceed?") is True
+        assert is_awaiting_confirmation("(Y/N):") is True
+
+
+# =============================================================================
+# SSH channel confirmation auto-response tests (issue #91)
+# =============================================================================
+
+
+class TestSSHChannelConfirmationAutoResponse:
+    """Verify TriggerSSHChannelBase auto-responds to confirmation prompts."""
+
+    def _make_channel(self, delimiter="\n"):
+        """Create a minimal mock of TriggerSSHChannelBase for testing dataReceived."""
+        ch = MagicMock()
+        ch.data = ""
+        # Device must be an object with a delimiter attribute, not a string
+        ch.device = MagicMock()
+        ch.device.nodeName = "test-device1"
+        ch.device.delimiter = delimiter
+        ch.device.__str__ = lambda self: self.nodeName
+        ch.enabled = True
+        ch.initialized = True
+        ch.results = []
+        ch.with_errors = False
+        ch.command_interval = 0
+        ch.prompt = compile_prompt_pattern(settings.IOSLIKE_PROMPT_PAT)
+        return ch
+
+    def test_confirmation_prompt_sends_delimiter(self):
+        """When a confirmation prompt is detected, write(device.delimiter) should be called."""
+        from trigger.twister import TriggerSSHChannelBase
+
+        ch = self._make_channel()
+
+        # Simulate receiving a confirmation prompt
+        ch.data = ""
+        incoming = "copy running-config startup-config\nDestination filename [running-config]? "
+        ch.data += incoming
+
+        # Call the real dataReceived logic
+        TriggerSSHChannelBase.dataReceived(ch, incoming)
+
+        ch.write.assert_called_once_with("\n")
+        ch.resetTimeout.assert_called_once()
+        assert ch.data == ""
+
+    def test_confirmation_prompt_uses_device_delimiter(self):
+        """Confirmation response should use the device-specific delimiter (e.g. \\r\\n for Force10)."""
+        from trigger.twister import TriggerSSHChannelBase
+
+        # Force10 devices use \r\n as delimiter
+        ch = self._make_channel(delimiter="\r\n")
+
+        incoming = "copy running-config startup-config\nDestination filename [running-config]? "
+        ch.data = incoming
+
+        TriggerSSHChannelBase.dataReceived(ch, incoming)
+
+        ch.write.assert_called_once_with("\r\n")
+
+    def test_confirmation_prompt_does_not_advance_commands(self):
+        """When a confirmation prompt is detected, results should not be appended."""
+        from trigger.twister import TriggerSSHChannelBase
+
+        ch = self._make_channel()
+
+        incoming = "Overwrite file [startup-config] ?[Yes/press any key for no]...."
+        ch.data = incoming
+
+        TriggerSSHChannelBase.dataReceived(ch, incoming)
+
+        # Should not have appended any results
+        assert ch.results == []
+
+
+class TestTelnetConfirmationAutoResponse:
+    """Verify IoslikeSendExpect (telnet) auto-responds to confirmation prompts."""
+
+    def _make_protocol(self, delimiter="\n"):
+        """Create a minimal mock of IoslikeSendExpect for testing dataReceived."""
+        proto = MagicMock()
+        proto.data = ""
+        # Device must be an object with a delimiter attribute, not a string
+        proto.device = MagicMock()
+        proto.device.nodeName = "test-device1"
+        proto.device.delimiter = delimiter
+        proto.device.__str__ = lambda self: self.nodeName
+        proto.initialized = True
+        proto.results = []
+        proto.with_errors = False
+        proto.command_interval = 0
+        proto.prompt = compile_prompt_pattern(settings.IOSLIKE_PROMPT_PAT)
+        proto.factory = MagicMock()
+        return proto
+
+    def test_confirmation_prompt_sends_delimiter(self):
+        """Telnet channel should send device.delimiter on confirmation prompt."""
+        from trigger.twister import IoslikeSendExpect
+
+        proto = self._make_protocol()
+
+        incoming = "Save changes [y/n]:"
+        proto.data = incoming
+
+        IoslikeSendExpect.dataReceived(proto, incoming)
+
+        proto.write.assert_called_once_with("\n")
+        proto.resetTimeout.assert_called_once()
+        assert proto.data == ""
+
+    def test_confirmation_prompt_uses_device_delimiter(self):
+        """Telnet confirmation response should use device-specific delimiter (e.g. \\r\\n for Force10)."""
+        from trigger.twister import IoslikeSendExpect
+
+        # Force10 devices use \r\n as delimiter
+        proto = self._make_protocol(delimiter="\r\n")
+
+        incoming = "Save changes [y/n]:"
+        proto.data = incoming
+
+        IoslikeSendExpect.dataReceived(proto, incoming)
+
+        proto.write.assert_called_once_with("\r\n")
+
+    def test_confirmation_prompt_does_not_advance_commands(self):
+        """Telnet channel should not append results on confirmation prompt."""
+        from trigger.twister import IoslikeSendExpect
+
+        proto = self._make_protocol()
+
+        incoming = "Are you sure you want to proceed?"
+        proto.data = incoming
+
+        IoslikeSendExpect.dataReceived(proto, incoming)
+
+        assert proto.results == []

{trigger-2.2.4 → trigger-2.2.6}/trigger/bin/acl.py

@@ -10,6 +10,7 @@ and to manage the ACL task queue.
 import optparse
 import sys
 from collections import defaultdict
+from pathlib import Path
 from textwrap import wrap
 
 from trigger import __version__, exceptions
@@ -24,7 +25,8 @@ def parse_args(argv, optp):  # noqa: D103
         %prog --display [--exact | --device-name-only] (<acl_name> | <device>)
         %prog (--add | --remove) <acl_name> [<device> [<device> ...]]
         %prog (--clear | --inject) [--quiet] [<acl_name> [<acl_name> ...]]
-        %prog (--list | --listmanual)"""
+        %prog (--list | --listmanual)
+        %prog --staged"""
 
     # Parse arguments.
     optp.usage = usage
@@ -46,6 +48,14 @@ def parse_args(argv, optp):  # noqa: D103
         const="listmanual",
         dest="mode",
     )
+    optp.add_option(
+        "-s",
+        "--staged",
+        help="list currently staged ACLs",
+        action="store_const",
+        const="staged",
+        dest="mode",
+    )
     optp.add_option(
         "-i",
         "--inject",
@@ -128,7 +138,7 @@ def main():  # noqa: PLR0912, PLR0915
     # Setup
     aclsdb = AclsDB()
     term_width = get_terminal_width()  # How wide is your term!
-    valid_modes = ["list", "listmanual"]  # Valid listing modes
+    valid_modes = ["list", "listmanual", "staged"]  # Valid listing modes
 
     optp = optparse.OptionParser()
     opts, args = parse_args(sys.argv, optp)
@@ -167,6 +177,20 @@ def main():  # noqa: PLR0912, PLR0915
         if not queue.list(queue="manual"):
             print("Nothing in the manual queue.")
 
+    elif opts.mode == "staged":
+        tftproot = settings.TFTPROOT_DIR
+        tftp_path = Path(tftproot)
+        if not tftp_path.is_dir():
+            print(f"TFTPROOT_DIR directory not found: {tftproot}")
+            sys.exit(1)
+        staged_files = sorted(p.name for p in tftp_path.iterdir() if p.is_file())
+        if staged_files:
+            print(f"Access-lists currently staged in {tftproot}:")
+            for filename in staged_files:
+                print(f"  {filename}")
+        else:
+            print(f"No ACLs currently staged in {tftproot}.")
+
     elif opts.mode == "inject":
         for arg in args:
             devs = [dev[0] for dev in get_matching_acls([arg])]

{trigger-2.2.4 → trigger-2.2.6}/trigger/twister.py

@@ -1495,18 +1495,21 @@ class TriggerSSHChannelBase(channel.SSHChannel, TimeoutMixin):
                 send_enable(self)
                 return
 
-            # Check for confirmation prompts
-            # If the prompt confirms set the index to the matched bytes
+            # Check for confirmation prompts and auto-confirm with Enter
             if is_awaiting_confirmation(self.data):
                 log.msg(f"[{self.device}] Got confirmation prompt: {self.data!r}")
-                prompt_idx = self.data.find(bytes)
-            else:
+                log.msg(f"[{self.device}] Sending confirmation response")
+                self.write(self.device.delimiter)
+                self.data = ""
+                self.resetTimeout()
                 return
-        else:
-            # Or just use the matched regex object...
-            log.msg(f"[{self.device}] STATE: buffer {self.data!r}")
-            log.msg(f"[{self.device}] STATE: prompt {m.group()!r}")
-            prompt_idx = prompt_match_start(m)
+
+            return
+
+        # Or just use the matched regex object...
+        log.msg(f"[{self.device}] STATE: buffer {self.data!r}")
+        log.msg(f"[{self.device}] STATE: prompt {m.group()!r}")
+        prompt_idx = prompt_match_start(m)
 
         # Strip the prompt from the match result
         result = self.data[:prompt_idx]  # Cut the prompt out
@@ -2092,15 +2095,19 @@ class IoslikeSendExpect(protocol.Protocol, TimeoutMixin):
         # None
         m = self.prompt.search(self.data)
         if not m:
-            # If the prompt confirms set the index to the matched bytes,
+            # Check for confirmation prompts and auto-confirm with Enter
             if is_awaiting_confirmation(self.data):
                 log.msg(f"[{self.device}] Got confirmation prompt: {self.data!r}")
-                prompt_idx = self.data.find(bytes)
-            else:
+                log.msg(f"[{self.device}] Sending confirmation response")
+                self.write(self.device.delimiter)
+                self.data = ""
+                self.resetTimeout()
                 return
-        else:
-            # Or just use the matched regex object...
-            prompt_idx = prompt_match_start(m)
+
+            return
+
+        # Or just use the matched regex object...
+        prompt_idx = prompt_match_start(m)
 
         result = self.data[:prompt_idx]
         # Trim off the echoed-back command.  This should *not* be necessary

{trigger-2.2.4 → trigger-2.2.6}/trigger/twister2.py

@@ -648,15 +648,19 @@ class IoslikeSendExpect(protocol.Protocol, TimeoutMixin):
         # None
         m = self.prompt.search(self.data)
         if not m:
-            # If the prompt confirms set the index to the matched bytes,
+            # Check for confirmation prompts and auto-confirm with Enter
             if is_awaiting_confirmation(self.data):
                 log.msg(f"[{self.device}] Got confirmation prompt: {self.data!r}")
-                prompt_idx = self.data.find(bytes)
-            else:
+                log.msg(f"[{self.device}] Sending confirmation response")
+                self.transport.write(self.device.delimiter)
+                self.data = ""
+                self.resetTimeout()
                 return
-        else:
-            # Or just use the matched regex object...
-            prompt_idx = prompt_match_start(m)
+
+            return
+
+        # Or just use the matched regex object...
+        prompt_idx = prompt_match_start(m)
 
         result = self.data[:prompt_idx]
         # Trim off the echoed-back command.  This should *not* be necessary

{trigger-2.2.4 → trigger-2.2.6/trigger.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: trigger
-Version: 2.2.4
+Version: 2.2.6
 Summary: Network automation toolkit for managing network devices
 Author-email: Jathan McCollum <jathan@gmail.com>
 License-Expression: BSD-3-Clause