trigger 2.2.1__tar.gz → 2.2.3__tar.gz

{trigger-2.2.1/trigger.egg-info → trigger-2.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: trigger
-Version: 2.2.1
+Version: 2.2.3
 Summary: Network automation toolkit for managing network devices
 Author-email: Jathan McCollum <jathan@gmail.com>
 License-Expression: BSD-3-Clause
@@ -33,12 +33,14 @@ Requires-Dist: pytest>=7.4.0; extra == "dev"
 Requires-Dist: pytest-twisted>=1.14.0; extra == "dev"
 Requires-Dist: ruff>=0.1.0; extra == "dev"
 Requires-Dist: python-semantic-release>=9.0.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx>=7.0; extra == "docs"
+Requires-Dist: sphinx_rtd_theme>=2.0; extra == "docs"
 Dynamic: license-file
 
 # What is Trigger?
 
-[![Tests](https://github.com/trigger/trigger/workflows/Tests/badge.svg)](https://github.com/trigger/trigger/actions)
-[![Join the chat at https://gitter.im/trigger/trigger](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/trigger/trigger?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![CI](https://github.com/trigger/trigger/workflows/CI/badge.svg)](https://github.com/trigger/trigger/actions/workflows/ci.yml)
 
 Trigger is a robust network automation toolkit written in Python that was
 designed for interfacing with network devices and managing network
@@ -79,16 +81,9 @@ network devices with ease. Here are some of things that make Trigger tick:
 + Flexible access-list & firewall policy parser that can test access if access
   is permitted, or easily convert ACLs from one format to another.
 + Detailed support for timezones and maintenance windows.
++ Import your metadata from an existing [RANCID](http://shrubbery.net/rancid/) installation or a CSV file to get up-and-running quickly.
 + A suite of tools for simplifying many common tasks.
 
-New in version 1.2:
-
-+ Import your metadata from an existing [RANCID](http://shrubbery.net/rancid/) installation to get up-and-running quickly!
-
-New in version 1.3:
-
-+ Import your metadata from a CSV file and get up-and-running even quicker!
-
 ## Getting Started
 
 The best way to get started is to read the documentation hosted by [Read the
@@ -142,21 +137,13 @@ See the [Migration Guide](https://trigger.readthedocs.io/en/latest/migration.htm
 
 ### Before you begin
 
-+ The [develop](https://github.com/trigger/trigger/tree/develop) branch is
-  the default branch that will be active when you clone this repository. While
-  it is generally stable this branch is not considered production-ready. Use at
-  your own risk!
-+ The [master](https://github.com/trigger/trigger/tree/master) branch is
-  the stable branch, and will reflect the latest production-ready changes. It
-  is recommended that this is the branch you use if you are installing Trigger
-  for the first time.
-+ Each point release of Trigger is maintained as a [tag branch](https://github.com/trigger/trigger/tags). If you require a
++ The [main](https://github.com/trigger/trigger/tree/main) branch is the
+  primary branch for all development and releases. All pull requests target
+  `main`.
++ Each point release of Trigger is maintained as a [tag](https://github.com/trigger/trigger/tags). If you require a
   specific Trigger version, please refer to these.
 
 ### Get in touch!
 
-If you run into any snags, have questions, feedback, or just want to talk shop:
-[contact us](https://trigger.readthedocs.io/en/latest/#getting-help)!
-
-**Pro tip**: Find us on IRC at `#trigger` on Freenode
-([irc://irc.freenode.net/trigger](irc://irc.freenode.net/trigger)).
+If you run into any snags, have questions, feedback, or just want to talk shop,
+please open an issue on [GitHub Issues](https://github.com/trigger/trigger/issues).

{trigger-2.2.1 → trigger-2.2.3}/README.md

@@ -1,7 +1,6 @@
 # What is Trigger?
 
-[![Tests](https://github.com/trigger/trigger/workflows/Tests/badge.svg)](https://github.com/trigger/trigger/actions)
-[![Join the chat at https://gitter.im/trigger/trigger](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/trigger/trigger?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![CI](https://github.com/trigger/trigger/workflows/CI/badge.svg)](https://github.com/trigger/trigger/actions/workflows/ci.yml)
 
 Trigger is a robust network automation toolkit written in Python that was
 designed for interfacing with network devices and managing network
@@ -42,16 +41,9 @@ network devices with ease. Here are some of things that make Trigger tick:
 + Flexible access-list & firewall policy parser that can test access if access
   is permitted, or easily convert ACLs from one format to another.
 + Detailed support for timezones and maintenance windows.
++ Import your metadata from an existing [RANCID](http://shrubbery.net/rancid/) installation or a CSV file to get up-and-running quickly.
 + A suite of tools for simplifying many common tasks.
 
-New in version 1.2:
-
-+ Import your metadata from an existing [RANCID](http://shrubbery.net/rancid/) installation to get up-and-running quickly!
-
-New in version 1.3:
-
-+ Import your metadata from a CSV file and get up-and-running even quicker!
-
 ## Getting Started
 
 The best way to get started is to read the documentation hosted by [Read the
@@ -105,21 +97,13 @@ See the [Migration Guide](https://trigger.readthedocs.io/en/latest/migration.htm
 
 ### Before you begin
 
-+ The [develop](https://github.com/trigger/trigger/tree/develop) branch is
-  the default branch that will be active when you clone this repository. While
-  it is generally stable this branch is not considered production-ready. Use at
-  your own risk!
-+ The [master](https://github.com/trigger/trigger/tree/master) branch is
-  the stable branch, and will reflect the latest production-ready changes. It
-  is recommended that this is the branch you use if you are installing Trigger
-  for the first time.
-+ Each point release of Trigger is maintained as a [tag branch](https://github.com/trigger/trigger/tags). If you require a
++ The [main](https://github.com/trigger/trigger/tree/main) branch is the
+  primary branch for all development and releases. All pull requests target
+  `main`.
++ Each point release of Trigger is maintained as a [tag](https://github.com/trigger/trigger/tags). If you require a
   specific Trigger version, please refer to these.
 
 ### Get in touch!
 
-If you run into any snags, have questions, feedback, or just want to talk shop:
-[contact us](https://trigger.readthedocs.io/en/latest/#getting-help)!
-
-**Pro tip**: Find us on IRC at `#trigger` on Freenode
-([irc://irc.freenode.net/trigger](irc://irc.freenode.net/trigger)).
+If you run into any snags, have questions, feedback, or just want to talk shop,
+please open an issue on [GitHub Issues](https://github.com/trigger/trigger/issues).

{trigger-2.2.1 → trigger-2.2.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "trigger"
-version = "2.2.1"
+version = "2.2.3"
 description = "Network automation toolkit for managing network devices"
 readme = "README.md"
 license = "BSD-3-Clause"
@@ -42,6 +42,10 @@ dev = [
     "ruff>=0.1.0",
     "python-semantic-release>=9.0.0",
 ]
+docs = [
+    "sphinx>=7.0",
+    "sphinx_rtd_theme>=2.0",
+]
 
 [project.scripts]
 acl = "trigger.bin.acl:main"

trigger-2.2.3/tests/test_twister.py

@@ -0,0 +1,255 @@
+import re
+
+import pytest
+
+from trigger.conf import settings
+from trigger.twister import compile_prompt_pattern, prompt_match_start
+
+
+def test_ioslike_prompt_pattern_enabled():
+    """Test enabled that IOS-like prompt patterns match correctly."""
+    pat = settings.IOSLIKE_PROMPT_PAT
+
+    prompt_tests = [
+        "foo-bar1#",
+        "foo-bar1# ",
+        "foo-bar1(config)# ",
+        "\rfoo-bar01(config)# \x08 ",  # "Bonus" backspace in there
+        "foo-bar01(config) \r#",  # "Bonus" '\s\r' in there
+    ]
+
+    for prompt in prompt_tests:
+        assert re.search(pat, prompt) is not None
+
+
+def test_ioslike_prompt_pattern_nonenabled():
+    """Test non-enabled that IOS-like prompt patterns match correctly."""
+    pat = settings.IOSLIKE_ENABLE_PAT
+
+    prompt_tests = [
+        "foo-bar1>",
+        "foo-bar1> ",
+        "\rfoo-bar01)> \x08 ",  # "Bonus" backspace in there
+        "foo-bar01) \r>",  # "Bonus" '\s\r' in there
+    ]
+
+    for prompt in prompt_tests:
+        assert re.search(pat, prompt) is not None
+
+
+# =============================================================================
+# False-positive prevention tests (Issue #317)
+# =============================================================================
+
+
+class TestFalsePositivePrevention:
+    """Verify that command output containing '>' or '#' is NOT matched as a prompt."""
+
+    def test_juniper_rsync_flag_not_matched(self):
+        """Juniper 'Flags: <Sync RSync>' must not match as a prompt (issue #317)."""
+        pat = compile_prompt_pattern(settings.PROMPT_PATTERNS["juniper"])
+        buffer = "Flags: <Sync RSync>\r\n"
+        assert pat.search(buffer) is None
+
+    def test_ioslike_comment_not_matched(self):
+        """A '# comment' line must not match IOS-like prompt pattern."""
+        pat = compile_prompt_pattern(settings.IOSLIKE_PROMPT_PAT)
+        buffer = "some output\r\n# This is a comment in output\r\n"
+        assert pat.search(buffer) is None
+
+    def test_enable_angle_bracket_not_matched(self):
+        """A '>' inside command output must not match the enable pattern."""
+        pat = compile_prompt_pattern(settings.IOSLIKE_ENABLE_PAT)
+        buffer = "Description: Traffic >1Gbps\r\nMore output here\r\n"
+        assert pat.search(buffer) is None
+
+    def test_ioslike_prompt_mid_line_not_matched(self):
+        """IOS-like prompt pattern should not match '#' in the middle of a line."""
+        pat = compile_prompt_pattern(settings.IOSLIKE_PROMPT_PAT)
+        buffer = "some leading text device-name# "
+        assert pat.search(buffer) is None
+
+    def test_juniper_xml_angle_bracket_not_matched(self):
+        """Juniper XML output with '>' should not match as prompt."""
+        pat = compile_prompt_pattern(settings.PROMPT_PATTERNS["juniper"])
+        buffer = '<rpc-reply xmlns:junos="http://xml.juniper.net">\r\n'
+        assert pat.search(buffer) is None
+
+
+# =============================================================================
+# Valid prompt regression tests
+# =============================================================================
+
+
+class TestValidPromptMatching:
+    """Verify that real prompts still match correctly after the anchoring fix."""
+
+    def test_first_prompt_no_preceding_newline(self):
+        """A prompt at the very start of the buffer (no preceding newline) must match."""
+        pat = compile_prompt_pattern(settings.IOSLIKE_PROMPT_PAT)
+        buffer = "router1# "
+        m = pat.search(buffer)
+        assert m is not None
+
+    def test_prompt_after_newline(self):
+        """A prompt after \\n must match."""
+        pat = compile_prompt_pattern(settings.IOSLIKE_PROMPT_PAT)
+        buffer = "some output\nrouter1# "
+        m = pat.search(buffer)
+        assert m is not None
+        assert prompt_match_start(m) == len("some output\n")
+
+    def test_prompt_after_crlf(self):
+        """A prompt after \\r\\n must match."""
+        pat = compile_prompt_pattern(settings.IOSLIKE_PROMPT_PAT)
+        buffer = "some output\r\nrouter1# "
+        m = pat.search(buffer)
+        assert m is not None
+        assert prompt_match_start(m) == len("some output\r\n")
+
+    def test_juniper_prompt_after_master_banner(self):
+        """Juniper prompt after {master} banner must match."""
+        pat = compile_prompt_pattern(settings.PROMPT_PATTERNS["juniper"])
+        buffer = "{master}\nuser@router> "
+        m = pat.search(buffer)
+        assert m is not None
+
+    def test_ioslike_config_mode_prompt(self):
+        """IOS config mode prompt must match."""
+        pat = compile_prompt_pattern(settings.IOSLIKE_PROMPT_PAT)
+        buffer = "output line\nswitch1(config)# "
+        m = pat.search(buffer)
+        assert m is not None
+
+    def test_enable_prompt_at_start(self):
+        """Enable prompt at start of buffer must match."""
+        pat = compile_prompt_pattern(settings.IOSLIKE_ENABLE_PAT)
+        buffer = "router1> "
+        m = pat.search(buffer)
+        assert m is not None
+        assert prompt_match_start(m) == 0
+
+    def test_paloalto_prompt_with_crlf(self):
+        """Palo Alto prompt with \\r\\n prefix must match."""
+        pat = compile_prompt_pattern(settings.PROMPT_PATTERNS["paloalto"])
+        buffer = "output\r\nadmin@fw1> "
+        m = pat.search(buffer)
+        assert m is not None
+
+
+# =============================================================================
+# prompt_match_start correctness tests
+# =============================================================================
+
+
+class TestPromptMatchStart:
+    """Verify prompt_match_start returns the correct index."""
+
+    def test_match_at_buffer_start(self):
+        """Match at buffer start returns 0."""
+        pat = compile_prompt_pattern(settings.IOSLIKE_PROMPT_PAT)
+        buffer = "router1# "
+        m = pat.search(buffer)
+        assert m is not None
+        assert prompt_match_start(m) == 0
+
+    def test_match_after_lf(self):
+        """Match after \\n skips the newline character."""
+        pat = compile_prompt_pattern(settings.IOSLIKE_PROMPT_PAT)
+        buffer = "output\nrouter1# "
+        m = pat.search(buffer)
+        assert m is not None
+        # The \n is at index 6, prompt starts at index 7
+        assert prompt_match_start(m) == 7
+
+    def test_match_after_crlf(self):
+        """Match after \\r\\n skips both characters."""
+        pat = compile_prompt_pattern(settings.IOSLIKE_PROMPT_PAT)
+        buffer = "output\r\nrouter1# "
+        m = pat.search(buffer)
+        assert m is not None
+        # \r at 6, \n at 7, prompt starts at 8
+        assert prompt_match_start(m) == 8
+
+
+# =============================================================================
+# compile_prompt_pattern behavior tests
+# =============================================================================
+
+
+class TestCompilePromptPattern:
+    """Verify compile_prompt_pattern handles various inputs correctly."""
+
+    def test_already_compiled_pattern_returned_unchanged(self):
+        """An already-compiled re.Pattern should be returned as-is."""
+        compiled = re.compile(r"foo#\s?$")
+        result = compile_prompt_pattern(compiled)
+        assert result is compiled
+
+    def test_pattern_starting_with_caret_not_double_anchored(self):
+        """A pattern starting with ^ should not get a redundant prefix."""
+        pat = compile_prompt_pattern(r"^\S+#\s?$")
+        assert pat.search("router1# ") is not None
+        # Verify no double-anchor by checking pattern string
+        assert not pat.pattern.startswith(r"(?:^|\r?\n)^")
+
+    def test_pattern_starting_with_backslash_r_not_prefixed(self):
+        """A pattern starting with \\r should not get a prefix (e.g. paloalto)."""
+        pat = compile_prompt_pattern(r"\r\n\S+(?:\>|#)\s?$")
+        # Pattern should still work
+        assert pat.search("\r\nadmin@fw1> ") is not None
+        # Verify no prefix added
+        assert not pat.pattern.startswith(r"(?:^|\r?\n)\r")
+
+    def test_pattern_starting_with_backslash_n_not_prefixed(self):
+        """A pattern starting with \\n should not get a prefix."""
+        pat = compile_prompt_pattern(r"\n\S+#\s?$")
+        assert not pat.pattern.startswith(r"(?:^|\r?\n)\n")
+
+    def test_multiline_flag_is_set(self):
+        """The compiled pattern should have re.MULTILINE enabled."""
+        pat = compile_prompt_pattern(r"\S+#\s?$")
+        assert pat.flags & re.MULTILINE
+
+
+# =============================================================================
+# Parametrized vendor pattern tests
+# =============================================================================
+
+
+# Map each vendor pattern to a sample prompt that should match on its own line
+VENDOR_PROMPT_SAMPLES = {
+    "aruba": "(Aruba7010) #",
+    "avocent": "admin-0->",
+    "citrix": " Done\n",
+    "cumulus": "cumulus@switch# ",
+    "f5": "admin@(bigip1)(cfg-sync Standalone)(Active)(/Common)(tmos)# ",
+    "juniper": "user@router> ",
+    "mrv": "\r\nMRV OptiSwitch 1 >>",
+    "netscreen": "fw1-> ",
+    "paloalto": "\r\nadmin@fw1> ",
+    "pica8": "admin@switch> ",
+}
+
+
+@pytest.mark.parametrize(
+    ("vendor", "sample_prompt"),
+    list(VENDOR_PROMPT_SAMPLES.items()),
+    ids=list(VENDOR_PROMPT_SAMPLES.keys()),
+)
+def test_vendor_pattern_matches_sample_prompt(vendor, sample_prompt):
+    """Each vendor pattern must match its expected sample prompt."""
+    pat = compile_prompt_pattern(settings.PROMPT_PATTERNS[vendor])
+    assert pat.search(sample_prompt) is not None, (
+        f"Vendor {vendor!r} pattern failed to match sample prompt {sample_prompt!r}"
+    )
+
+
+@pytest.mark.parametrize(
+    "vendor",
+    list(settings.PROMPT_PATTERNS.keys()),
+)
+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)

{trigger-2.2.1 → trigger-2.2.3}/trigger/netdevices/__init__.py

@@ -500,7 +500,9 @@ class NetDevice:
         self.factories["base"] = factory
 
         # FIXME(jathan): prompt_pattern could move back to protocol?
-        prompt = re.compile(settings.IOSLIKE_PROMPT_PAT)
+        from trigger.twister import compile_prompt_pattern
+
+        prompt = compile_prompt_pattern(settings.IOSLIKE_PROMPT_PAT)
         proto = endpoint.connect(factory, prompt_pattern=prompt)
         self._proto = proto  # Track this for later, too.
 
@@ -594,7 +596,9 @@ class NetDevice:
 
         # Here's where we're using self._connect injected on .open()
         ep = TriggerSSHShellClientEndpointBase.existingConnection(self._conn)
-        prompt = re.compile(settings.IOSLIKE_PROMPT_PAT)
+        from trigger.twister import compile_prompt_pattern
+
+        prompt = compile_prompt_pattern(settings.IOSLIKE_PROMPT_PAT)
         proto = ep.connect(factory, prompt_pattern=prompt)
 
         d = defer.Deferred()

{trigger-2.2.1 → trigger-2.2.3}/trigger/twister.py

@@ -99,6 +99,52 @@ def is_awaiting_confirmation(prompt):
     return any(prompt.endswith(match.lower()) for match in matchlist)
 
 
+def compile_prompt_pattern(pattern):
+    r"""Compile a prompt pattern with line-start anchoring to prevent false matches.
+
+    Prepends ``(?:^|\r?\n)`` to the pattern so that prompts only match at the
+    start of a line (beginning of buffer or after a newline).  Already-compiled
+    ``re.Pattern`` objects and patterns that already start with a line anchor
+    (``^``, ``\r``, ``\n``) are returned unchanged.
+
+    :param pattern:
+        A prompt regex string or compiled ``re.Pattern``.
+
+    :returns:
+        A compiled ``re.Pattern`` with ``re.MULTILINE`` enabled.
+    """
+    if isinstance(pattern, re.Pattern):
+        return pattern
+    if pattern.startswith(("^", r"\r", r"\n")):
+        return re.compile(pattern, re.MULTILINE)
+    return re.compile(r"(?:^|\r?\n)" + pattern, re.MULTILINE)
+
+
+def prompt_match_start(match):
+    r"""Return the start position of the actual prompt within a match.
+
+    When ``compile_prompt_pattern`` prepends a ``(?:^|\r?\n)`` prefix, the
+    match may begin with ``\r`` or ``\n`` characters that are not part of the
+    prompt itself.  This helper skips those leading characters and returns the
+    index where the real prompt text begins.
+
+    :param match:
+        A ``re.Match`` object from a prompt search.
+
+    :returns:
+        An integer index suitable for slicing the buffer at the prompt boundary.
+    """
+    s = match.start()
+    text = match.group()
+    # Skip any leading \r or \n consumed by the anchor prefix
+    for ch in text:
+        if ch in "\r\n":
+            s += 1
+        else:
+            break
+    return s
+
+
 def requires_enable(proto_obj, data):
     """Check if a device requires enable.
 
@@ -951,7 +997,7 @@ class TriggerSSHChannelFactory(TriggerClientFactory):
         self.timeout = timeout
         self.channel_class = channel_class
         self.command_interval = command_interval
-        self.prompt = re.compile(prompt_pattern)
+        self.prompt = compile_prompt_pattern(prompt_pattern)
         self.device = device
         self.connection_class = connection_class
         TriggerClientFactory.__init__(self, deferred, creds)
@@ -1292,7 +1338,7 @@ class Interactor(protocol.Protocol):
 
     def __init__(self, log_to=None):
         self._log_to = log_to
-        self.enable_prompt = re.compile(settings.IOSLIKE_ENABLE_PAT)
+        self.enable_prompt = compile_prompt_pattern(settings.IOSLIKE_ENABLE_PAT)
         self.enabled = False
         self.initialized = False
 
@@ -1306,7 +1352,7 @@ class Interactor(protocol.Protocol):
         c.dataReceived = self.write
         self.stdio = stdio.StandardIO(c)
         self.device = self.factory.device  # Attach the device object
-        self.prompt = re.compile(self.device.vendor.prompt_pattern)
+        self.prompt = compile_prompt_pattern(self.device.vendor.prompt_pattern)
 
     def loseConnection(self):
         """Terminate the connection. Link this to the transport method of the same
@@ -1415,7 +1461,7 @@ class TriggerSSHChannelBase(channel.SSHChannel, TimeoutMixin):
         log.msg(f"[{self.device}] My startup commands: {self.startup_commands!r}")
 
         # For IOS-like devices that require 'enable'
-        self.enable_prompt = re.compile(settings.IOSLIKE_ENABLE_PAT)
+        self.enable_prompt = compile_prompt_pattern(settings.IOSLIKE_ENABLE_PAT)
         self.enabled = False
 
     def channelOpen(self, data):
@@ -1467,7 +1513,7 @@ class TriggerSSHChannelBase(channel.SSHChannel, TimeoutMixin):
             # 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 = m.start()
+            prompt_idx = prompt_match_start(m)
 
         # Strip the prompt from the match result
         result = self.data[:prompt_idx]  # Cut the prompt out
@@ -1759,7 +1805,7 @@ class TriggerSSHNetscalerChannel(TriggerSSHChannelBase):
             return
         log.msg(f"[{self.device}] STATE: prompt {m.group()!r}")
 
-        result = self.data[: m.start()]  # Strip ' Done\n' from results.
+        result = self.data[: prompt_match_start(m)]  # Strip ' Done\n' from results.
 
         if self.initialized:
             self.results.append(result)
@@ -2026,7 +2072,7 @@ class IoslikeSendExpect(protocol.Protocol, TimeoutMixin):
         self.with_errors = with_errors
         self.timeout = timeout
         self.command_interval = command_interval
-        self.prompt = re.compile(settings.IOSLIKE_PROMPT_PAT)
+        self.prompt = compile_prompt_pattern(settings.IOSLIKE_PROMPT_PAT)
         self.startup_commands = copy.copy(self.device.startup_commands)
         log.msg(f"[{self.device}] My initialize commands: {self.startup_commands!r}")
         self.initialized = False
@@ -2059,7 +2105,7 @@ class IoslikeSendExpect(protocol.Protocol, TimeoutMixin):
                 return
         else:
             # Or just use the matched regex object...
-            prompt_idx = m.start()
+            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.1 → trigger-2.2.3}/trigger/twister2.py

@@ -37,6 +37,7 @@ from trigger.conf import settings
 from trigger.twister import (
     has_ioslike_error,
     is_awaiting_confirmation,
+    prompt_match_start,
 )
 
 
@@ -655,7 +656,7 @@ class IoslikeSendExpect(protocol.Protocol, TimeoutMixin):
                 return
         else:
             # Or just use the matched regex object...
-            prompt_idx = m.start()
+            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.1 → trigger-2.2.3/trigger.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: trigger
-Version: 2.2.1
+Version: 2.2.3
 Summary: Network automation toolkit for managing network devices
 Author-email: Jathan McCollum <jathan@gmail.com>
 License-Expression: BSD-3-Clause
@@ -33,12 +33,14 @@ Requires-Dist: pytest>=7.4.0; extra == "dev"
 Requires-Dist: pytest-twisted>=1.14.0; extra == "dev"
 Requires-Dist: ruff>=0.1.0; extra == "dev"
 Requires-Dist: python-semantic-release>=9.0.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx>=7.0; extra == "docs"
+Requires-Dist: sphinx_rtd_theme>=2.0; extra == "docs"
 Dynamic: license-file
 
 # What is Trigger?
 
-[![Tests](https://github.com/trigger/trigger/workflows/Tests/badge.svg)](https://github.com/trigger/trigger/actions)
-[![Join the chat at https://gitter.im/trigger/trigger](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/trigger/trigger?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![CI](https://github.com/trigger/trigger/workflows/CI/badge.svg)](https://github.com/trigger/trigger/actions/workflows/ci.yml)
 
 Trigger is a robust network automation toolkit written in Python that was
 designed for interfacing with network devices and managing network
@@ -79,16 +81,9 @@ network devices with ease. Here are some of things that make Trigger tick:
 + Flexible access-list & firewall policy parser that can test access if access
   is permitted, or easily convert ACLs from one format to another.
 + Detailed support for timezones and maintenance windows.
++ Import your metadata from an existing [RANCID](http://shrubbery.net/rancid/) installation or a CSV file to get up-and-running quickly.
 + A suite of tools for simplifying many common tasks.
 
-New in version 1.2:
-
-+ Import your metadata from an existing [RANCID](http://shrubbery.net/rancid/) installation to get up-and-running quickly!
-
-New in version 1.3:
-
-+ Import your metadata from a CSV file and get up-and-running even quicker!
-
 ## Getting Started
 
 The best way to get started is to read the documentation hosted by [Read the
@@ -142,21 +137,13 @@ See the [Migration Guide](https://trigger.readthedocs.io/en/latest/migration.htm
 
 ### Before you begin
 
-+ The [develop](https://github.com/trigger/trigger/tree/develop) branch is
-  the default branch that will be active when you clone this repository. While
-  it is generally stable this branch is not considered production-ready. Use at
-  your own risk!
-+ The [master](https://github.com/trigger/trigger/tree/master) branch is
-  the stable branch, and will reflect the latest production-ready changes. It
-  is recommended that this is the branch you use if you are installing Trigger
-  for the first time.
-+ Each point release of Trigger is maintained as a [tag branch](https://github.com/trigger/trigger/tags). If you require a
++ The [main](https://github.com/trigger/trigger/tree/main) branch is the
+  primary branch for all development and releases. All pull requests target
+  `main`.
++ Each point release of Trigger is maintained as a [tag](https://github.com/trigger/trigger/tags). If you require a
   specific Trigger version, please refer to these.
 
 ### Get in touch!
 
-If you run into any snags, have questions, feedback, or just want to talk shop:
-[contact us](https://trigger.readthedocs.io/en/latest/#getting-help)!
-
-**Pro tip**: Find us on IRC at `#trigger` on Freenode
-([irc://irc.freenode.net/trigger](irc://irc.freenode.net/trigger)).
+If you run into any snags, have questions, feedback, or just want to talk shop,
+please open an issue on [GitHub Issues](https://github.com/trigger/trigger/issues).

{trigger-2.2.1 → trigger-2.2.3}/trigger.egg-info/requires.txt

@@ -19,3 +19,7 @@ pytest>=7.4.0
 pytest-twisted>=1.14.0
 ruff>=0.1.0
 python-semantic-release>=9.0.0
+
+[docs]
+sphinx>=7.0
+sphinx_rtd_theme>=2.0

trigger-2.2.1/tests/test_twister.py

@@ -1,34 +0,0 @@
-import re
-
-from trigger.conf import settings
-
-
-def test_ioslike_prompt_pattern_enabled():
-    """Test enabled that IOS-like prompt patterns match correctly."""
-    pat = settings.IOSLIKE_PROMPT_PAT
-
-    prompt_tests = [
-        "foo-bar1#",
-        "foo-bar1# ",
-        "foo-bar1(config)# ",
-        "\rfoo-bar01(config)# \x08 ",  # "Bonus" backspace in there
-        "foo-bar01(config) \r#",  # "Bonus" '\s\r' in there
-    ]
-
-    for prompt in prompt_tests:
-        assert re.search(pat, prompt) is not None
-
-
-def test_ioslike_prompt_pattern_nonenabled():
-    """Test non-enabled that IOS-like prompt patterns match correctly."""
-    pat = settings.IOSLIKE_ENABLE_PAT
-
-    prompt_tests = [
-        "foo-bar1>",
-        "foo-bar1> ",
-        "\rfoo-bar01)> \x08 ",  # "Bonus" backspace in there
-        "foo-bar01) \r>",  # "Bonus" '\s\r' in there
-    ]
-
-    for prompt in prompt_tests:
-        assert re.search(pat, prompt) is not None