trigger 2.2.3__tar.gz → 2.2.5__tar.gz

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

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

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

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "trigger"
-version = "2.2.3"
+version = "2.2.5"
 description = "Network automation toolkit for managing network devices"
 readme = "README.md"
 license = "BSD-3-Clause"
@@ -110,69 +110,15 @@ select = [
     "UP",     # pyupgrade - Python 3 modernization
     "W",      # pycodestyle warnings
 ]
+extend-select = [
+    "D401",   # non-imperative-mood (not in google convention, enabled explicitly)
+]
 ignore = [
     # --- Formatter conflicts ---
     "COM812",   # trailing-comma-missing (handled by ruff formatter)
 
     # --- Kept from v2.0.0 baseline ---
-    "E402",     # module-import-not-at-top-of-file
     "E501",     # line-too-long (handled by formatter)
-    "E721",     # type-comparison (existing code style)
-    "E722",     # bare-except (intentional in many places)
-    "E741",     # ambiguous-variable-name (existing code style)
-    "F401",     # unused-import (may be used dynamically)
-    "F402",     # import-shadowed-by-loop-var
-    "F403",     # undefined-local-with-import-star
-    "F405",     # undefined-local-with-import-star-usage
-    "F523",     # string-dot-format-extra-positional-arguments
-    "F811",     # redefined-while-unused
-    "F821",     # undefined-name
-    "UP031",    # printf-string-formatting
-
-    # --- Bugbear exceptions ---
-    "B016",     # raise-literal (used intentionally in tests)
-    "B018",     # useless-expression (test assertions)
-
-    # --- Pre-commit specific ignores ---
-    "PLW1641",  # __hash__ implementation (false positive, requires __eq__ impl)
-    "PT028",    # pytest parameter defaults (false positive, not pytest functions)
-
-    # --- Docstring exceptions (not enforcing coverage/style) ---
-    "D100",     # undocumented-public-module
-    "D101",     # undocumented-public-class
-    "D102",     # undocumented-public-method
-    "D103",     # undocumented-public-function
-    "D104",     # undocumented-public-package
-    "D105",     # undocumented-magic-method
-    "D107",     # undocumented-public-init
-    "D200",     # unnecessary-multiline-docstring
-    "D205",     # missing-blank-line-after-summary
-    "D401",     # non-imperative-mood
-    "D402",     # signature-in-docstring
-    "D404",     # docstring-starts-with-this
-
-    # --- Complexity (deep refactoring territory) ---
-    "PLR0911",  # too-many-return-statements
-    "PLR0912",  # too-many-branches
-    "PLR0913",  # too-many-arguments
-    "PLR0915",  # too-many-statements
-    "PLR2004",  # magic-value-comparison
-    "PLW0603",  # global-statement (parser pattern)
-
-    # --- Security false positives for network toolkit ---
-    "S101",     # assert (used in tests)
-    "S105",     # hardcoded-password-string (false positives)
-    "S110",     # try-except-pass
-    "S112",     # try-except-continue
-    "S314",     # suspicious-xml-element-tree-usage
-    "S603",     # subprocess-without-shell-equals-true
-    "S605",     # start-process-with-a-shell (fix manually)
-    "S606",     # start-process-with-no-shell
-    "S608",     # hardcoded-sql-expression
-
-    # --- Other ---
-    "RUF012",   # mutable-class-default (too many in device metadata)
-    "SLF001",   # private-member-access (common in Twisted patterns)
 ]
 
 [tool.ruff.lint.pydocstyle]
@@ -237,6 +183,8 @@ minor_tags = ["feat"]
 patch_tags = ["fix", "perf"]
 
 [tool.semantic_release.changelog]
+
+[tool.semantic_release.changelog.default_templates]
 changelog_file = "CHANGELOG.md"
 
 [tool.semantic_release.branches.main]

{trigger-2.2.3 → trigger-2.2.5}/tests/test_acl.py

@@ -1,10 +1,5 @@
 #!/usr/bin/python
 
-__author__ = "Jathan McCollum, Michael Shields"
-__maintainer__ = "Jathan McCollum"
-__copyright__ = "Copyright 2005-2011 AOL Inc.; 2013 Salesforce.com"
-__version__ = "2.0"
-
 import contextlib
 import unittest
 from io import StringIO
@@ -72,7 +67,7 @@ class CheckRangeList(unittest.TestCase):
         """Check RangeList behavior as a container type."""
         r = acl.RangeList([1, (3, 6)])
         self.assertTrue(1 in r)
-        self.assertTrue(5 in r)
+        self.assertTrue(5 in r)  # noqa: PLR2004
         self.assertTrue(0 not in r)
         r = acl.RangeList([acl.TIP("10/8"), acl.TIP("172.16/12")])
         self.assertTrue(acl.TIP("10.1.1.1") in r)
@@ -695,7 +690,7 @@ class CheckMiscIOS(unittest.TestCase):
         # Python 3: map() returns an iterator, convert to list for comparison
         self.assertEqual(
             t.output_ios(),
-            list(map(lambda x: "permit icmp any any %d" % x, types)),
+            list(map(lambda x: "permit icmp any any %d" % x, types)),  # noqa: UP031
         )
 
     def testCounterSuppression(self):
@@ -748,8 +743,8 @@ class CheckTriggerIP(unittest.TestCase):
         # Until we fix inactive testing, this is legit
         self.assertTrue(obj in self.test_net)
 
-    def testInactive(self):
-        """Test an inactive IP object"""
+    def testInactiveAndNegated(self):
+        """Test an inactive and negated IP object"""
         test = "inactive: 1.2.3.4/32 except"
         obj = acl.TIP(test)
         self.assertEqual(str(obj), test)

{trigger-2.2.3 → trigger-2.2.5}/tests/test_acl_queue.py

@@ -6,7 +6,7 @@ Test the functionality of `~trigger.acl.queue` (aka task queue)
 Only tests SQLite for now.
 """
 
-import os
+import os  # noqa: F401
 import tempfile
 from pathlib import Path
 

{trigger-2.2.3 → trigger-2.2.5}/tests/test_changemgmt.py

@@ -4,13 +4,6 @@
 Tests for bounce windows and the stuff that goes with them.
 """
 
-__author__ = "Jathan McCollum, Michael Shields"
-__maintainer__ = "Jathan McCollum"
-__email__ = "jmccollum@salesforce.com"
-__copyright__ = "Copyright 2013 Salesforce.com"
-__version__ = "2.0"
-
-
 # Make sure we load the mock redis library
 from utils import mock_redis
 

{trigger-2.2.3 → trigger-2.2.5}/tests/test_except.py

@@ -1,5 +1,5 @@
 # a test for except processing
-import os
+import os  # noqa: F401
 import sys
 from pathlib import Path
 

{trigger-2.2.3 → trigger-2.2.5}/tests/test_netdevices.py

@@ -7,11 +7,6 @@ This uses the mockups of netdevices.xml, acls.db, and autoacls.py in
 tests/data.
 """
 
-__author__ = "Jathan McCollum, Michael Shields"
-__maintainer__ = "Jathan McCollum"
-__copyright__ = "Copyright 2005-2011 AOL Inc.; 2013 Salesforce.com"
-__version__ = "2.0"
-
 import unittest
 
 # Make sure we load the mock redis library

{trigger-2.2.3 → trigger-2.2.5}/tests/test_scripts.py

@@ -2,11 +2,6 @@
 
 # tests/scripts.py
 
-__author__ = "Michael Shields"
-__maintainer__ = "Jathan McCollum"
-__copyright__ = "Copyright 2005-2011 AOL Inc."
-__version__ = "1.1"
-
 import os
 import subprocess
 import unittest

{trigger-2.2.3 → trigger-2.2.5}/tests/test_tacacsrc.py

@@ -1,11 +1,5 @@
 #!/usr/bin/env python
 
-__author__ = "Jathan McCollum, Michael Shields"
-__maintainer__ = "Jathan McCollum"
-__copyright__ = "Copyright 2005-2011 AOL Inc.; 2013 Salesforce.com"
-__version__ = "2.0.1"
-
-
 import os
 import tempfile
 import unittest
@@ -13,7 +7,7 @@ from pathlib import Path
 from unittest.mock import patch
 
 from trigger.conf import settings
-from trigger.tacacsrc import Credentials, Tacacsrc
+from trigger.tacacsrc import Credentials, Tacacsrc, convert_tacacsrc
 
 # Constants
 aol = Credentials("jschmoe", "abc123", "aol")
@@ -147,6 +141,31 @@ class TacacsrcTest(unittest.TestCase):
         new_perms = self._get_perms(fname)
         self.assertNotEqual(new_perms, RIGHT_PERMS)
 
+    def test_convert_tacacsrc(self):
+        """Test that convert_tacacsrc reads old creds and writes via GPG."""
+        captured = {}
+
+        def spy_encrypt_and_write(self):
+            captured["creds"] = dict(self.creds)
+            captured["use_gpg"] = self.use_gpg
+            captured["file_name"] = self.file_name
+
+        with (
+            patch("trigger.tacacsrc.Tacacsrc", MockTacacsrc),
+            patch.object(MockTacacsrc, "_encrypt_and_write", spy_encrypt_and_write),
+            patch.object(MockTacacsrc, "_update_perms"),
+        ):
+            convert_tacacsrc()
+
+        # GPG write path should have been reached
+        self.assertIn("creds", captured)
+        # All original credentials should be preserved
+        for name, value in ALL_CREDS:
+            self.assertEqual(captured["creds"][name], value)
+        # Should be in GPG mode targeting the .gpg file
+        self.assertTrue(captured["use_gpg"])
+        self.assertEqual(captured["file_name"], settings.TACACSRC + ".gpg")
+
 
 if __name__ == "__main__":
     unittest.main()

{trigger-2.2.3 → trigger-2.2.5}/tests/test_templates.py

@@ -3,7 +3,7 @@ from io import StringIO
 
 from trigger.cmds import Commando
 from trigger.netdevices import NetDevices
-from trigger.utils.templates import *
+from trigger.utils.templates import *  # noqa: F403
 
 # Constants
 DEVICE_NAME = "test1-abc.net.aol.com"
@@ -112,12 +112,12 @@ class CheckTemplates(unittest.TestCase):
 
     def testTemplatePath(self):
         """Test that template path is correct."""
-        t_path = get_template_path("show clock", dev_type="cisco_ios")
+        t_path = get_template_path("show clock", dev_type="cisco_ios")  # noqa: F405
         self.assertTrue("vendor/ntc_templates/cisco_ios_show_clock.template" in t_path)
 
     def testGetTextFsmObject(self):
         """Test that we get structured data back from cli output."""
-        data = get_textfsm_object(self.re_table, cli_data)
+        data = get_textfsm_object(self.re_table, cli_data)  # noqa: F405
         self.assertTrue(isinstance(data, dict))
         keys = ["dayweek", "time", "timezone", "year", "day", "month"]
         # Python 3: dict.has_key() removed, use 'in' operator

{trigger-2.2.3 → trigger-2.2.5}/tests/test_twister.py

@@ -160,7 +160,7 @@ class TestPromptMatchStart:
         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
+        assert prompt_match_start(m) == 7  # noqa: PLR2004
 
     def test_match_after_crlf(self):
         """Match after \\r\\n skips both characters."""
@@ -169,7 +169,7 @@ class TestPromptMatchStart:
         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
+        assert prompt_match_start(m) == 8  # noqa: PLR2004
 
 
 # =============================================================================

{trigger-2.2.3 → trigger-2.2.5}/tests/test_twister2.py

@@ -7,10 +7,4 @@ This uses the mockups of netdevices.xml in
 tests/data.
 """
 
-__author__ = "Thomas Cuthbert, Jathan McCollum"
-__maintainer__ = "Jathan McCollum"
-__copyright__ = "Copyright 2005-2011 AOL Inc.; 2013 Salesforce.com.; 2016 Dropbox"
-__version__ = "1.0"
-
-
 # TODO: see http://twistedmatrix.com/trac/wiki/TwistedTrial

{trigger-2.2.3 → trigger-2.2.5}/trigger/__init__.py

@@ -1,3 +1,5 @@
+"""Trigger: Network automation toolkit for managing network devices."""
+
 from importlib.metadata import PackageNotFoundError, version
 
 try:

{trigger-2.2.3 → trigger-2.2.5}/trigger/acl/__init__.py

@@ -6,13 +6,6 @@ ACL and return an ACL object that can be easily translated to any supported
 vendor syntax.
 """
 
-__author__ = "Jathan McCollum"
-__author__ = "Jathan McCollum, Mike Biancaniello, Mike Harding"
-__maintainer__ = "Jathan McCollum"
-__email__ = "jathanism@aol.com"
-__copyright__ = "Copyright 2010-2012, AOL Inc."
-__version__ = (0, 1)
-
 import os
 
 from trigger.conf import settings
@@ -21,11 +14,11 @@ __all__ = ["acl_exists", "parser"]
 
 # Parser
 from . import parser
-from .parser import *
+from .parser import *  # noqa: F403
 
 __all__.extend(parser.__all__)
 
 
 # Functions
-def acl_exists(name):
+def acl_exists(name):  # noqa: D103
     return os.access(settings.FIREWALL_DIR + "/acl." + name, os.R_OK)

{trigger-2.2.3 → trigger-2.2.5}/trigger/acl/autoacl.py

@@ -1,4 +1,4 @@
-"""This module controls when ACLs get auto-applied to network devices,
+"""Controls when ACLs get auto-applied to network devices,
 in addition to what is specified in acls.db.
 
 This is primarily used by :class:`~trigger.acl.db.AclsDB` to populate the
@@ -14,12 +14,7 @@ devices out of the Trigger packaging.
 
 If you do not specify a location for ``AUTOACL_FILE`` or the module cannot be
 loaded, then a default :func:`autoacl()` function ill be used.
-"""
-
-__author__ = "Jathan McCollum, Eileen Tschetter"
-__maintainer__ = "Jathan McCollum"
-__email__ = "jathan.mccollum@teamaol.com"
-__copyright__ = "Copyright 2010-2012, AOL Inc."
+"""  # noqa: D205
 
 import warnings
 
@@ -32,7 +27,6 @@ __all__ = ("autoacl",)
 
 module_path = settings.AUTOACL_FILE
 
-
 # In either case we're exporting a single name: autoacl().
 try:
     # Placeholder for the custom autoacl module that will provide the autoacl()
@@ -64,5 +58,5 @@ except ImportError:
 
         NOTE: If the default function is returned it does nothing with the
         arguments and always returns an empty set.
-        """
+        """  # noqa: D205
         return set()

{trigger-2.2.3 → trigger-2.2.5}/trigger/acl/db.py

@@ -16,12 +16,7 @@ set(['juniper-router.policer', 'juniper-router-protect'])
 {'all': set(['abc123', 'juniper-router-protect', 'juniper-router.policer']),
  'explicit': set(['abc123']),
   'implicit': set(['juniper-router-protect', 'juniper-router.policer'])}
-"""
-
-__author__ = "Jathan McCollum"
-__maintainer__ = "Jathan McCollum"
-__email__ = "jathan@gmail.com"
-__copyright__ = "Copyright 2010-2012, AOL Inc.; 2013 Salesforce.com"
+"""  # noqa: D205
 
 from collections import defaultdict
 from pathlib import Path
@@ -63,7 +58,7 @@ class AclsDB:
     add/remove operations are for explicit associations only.
     """
 
-    def __init__(self):
+    def __init__(self):  # noqa: D107
         self.redis = r
         log.msg("ACLs database client initialized")
 
@@ -111,7 +106,7 @@ class AclsDB:
         'testgreenj', 'testops_blockmj']),
         'explicit': set(['test-bluej', 'testgreenj', 'testops_blockmj']),
         'implicit': set(['115j', 'protectRE', 'protectRE.policer'])}
-        """
+        """  # noqa: D401, D205
         acls = {}
 
         # Explicit (we want to make sure the key exists before we try to assign
@@ -142,7 +137,7 @@ class AclsDB:
         set(['testops_blockmj', 'test-bluej', 'testgreenj'])
         >>> a.get_acl_set(dev, 'implicit')
         set(['protectRE', 'protectRE.policer', '115j'])
-        """
+        """  # noqa: D205
         acls_dict = self.get_acl_dict(device)
         ACL_SETS = acls_dict.keys()
         if DEBUG:
@@ -180,7 +175,7 @@ def populate_explicit_acls(aclsdb_file):
 
 
 def backup_explicit_acls():
-    """Dumps acls:explicit:* to csv."""
+    """Dumps acls:explicit:* to csv."""  # noqa: D401
     import csv
 
     out = csv.writer(Path(ACLSDB_BACKUP).open("w"))  # noqa: SIM115
@@ -212,7 +207,7 @@ def get_all_acls(nd=None):
     >>> all_acls = get_all_acls()
     >>> all_acls['abc123']
     set([<NetDevice: test1-abc.net.aol.com>, <NetDevice: fw1-xyz.net.aol.com>])
-    """
+    """  # noqa: D401, D205
     nd = nd or get_netdevices()
     all_acls = defaultdict(set)
     for device in nd.all():
@@ -224,7 +219,7 @@ def get_all_acls(nd=None):
 def get_bulk_acls(nd=None):
     """Returns a set of acls with an applied count over
     settings.AUTOLOAD_BULK_THRESH.
-    """
+    """  # noqa: D401, D205
     nd = nd or get_netdevices()
     all_acls = get_all_acls()
     return set(
@@ -269,7 +264,7 @@ def get_matching_acls(wanted, exact=True, match_acl=True, match_device=False, nd
     >>> adb.get_matching_acls(['test1-abc'], match_device=True, exact=False)
     [('test1-abc.net.aol.com', ['abc123', 'juniper-router-protect',
     'juniper-router.policer'])]
-    """
+    """  # noqa: D205
     found = []
     wanted_set = set(wanted)
 

{trigger-2.2.3 → trigger-2.2.5}/trigger/acl/dicts.py

@@ -1,4 +1,4 @@
-"""This code is originally from parser.py. It contains all the simple data definitions in
+"""Originally from parser.py. Contains all the simple data definitions in
 form of dictionaries and lists and such. This file is not meant to by used by itself.
 Imported into support.py.
 
@@ -21,13 +21,7 @@ Variables defined:
   tcp_flag_names
   tcp_flag_specials
   tcp_flag_rev
-"""
-
-__author__ = "Jathan McCollum, Mike Biancaniello, Michael Harding, Michael Shields"
-__editor__ = "Joseph Malone"
-__maintainer__ = "Jathan McCollum"
-__email__ = "jathanism@aol.com"
-__copyright__ = "Copyright 2006-2013, AOL Inc.; 2013 Saleforce.com"
+"""  # noqa: D205
 
 adrsbk = {"svc": {"group": {}, "book": {}}, "addr": {"group": {}, "book": {}}}
 

{trigger-2.2.3 → trigger-2.2.5}/trigger/acl/grammar.py

@@ -1,4 +1,4 @@
-"""This code is originally from parser.py. This is the basic grammar and rules
+"""Originally from parser.py. Provides the basic grammar and rules
 from which the other specific grammars are built. This file is not meant to by used by itself.
 Imported into the specific grammar files.
 
@@ -10,15 +10,9 @@ Imported into the specific grammar files.
     literals
     update
     dict_sum
-"""
+"""  # noqa: D205
 
-__author__ = "Jathan McCollum, Mike Biancaniello, Michael Harding, Michael Shields"
-__editor__ = "Joseph Malone"
-__maintainer__ = "Jathan McCollum"
-__email__ = "jathanism@aol.com"
-__copyright__ = "Copyright 2006-2013, AOL Inc.; 2013 Saleforce.com"
-
-from .support import *
+from .support import *  # noqa: F403
 
 # Each production can be any of:
 # 1. string
@@ -37,7 +31,7 @@ def S(prod):
     performing modifiers.
 
     :param prod: The parser product.
-    """
+    """  # noqa: D205
     subtagged.add(prod)
     return prod
 
@@ -46,22 +40,23 @@ def literals(d):
     """Longest match of all the strings that are keys of 'd'."""
     keys = [str(key) for key in d]
     keys.sort(key=lambda x: -len(x))  # Sort by length descending
-    return " / ".join(['"%s"' % key for key in keys])
+    return " / ".join([f'"{key}"' for key in keys])
 
 
-def update(d, **kwargs):
+def update(d, **kwargs):  # noqa: D103
     # Check for duplicate subterms, which is legal but too confusing to be
     # allowed at AOL.  For example, a Juniper term can have two different
     # 'destination-address' clauses, which means that the first will be
     # ignored.  This led to an outage on 2006-10-11.
     for key in kwargs:
         if key in d:
-            raise exceptions.ParseError("duplicate %s" % key)
+            msg = f"duplicate {key}"
+            raise exceptions.ParseError(msg)  # noqa: F405
     d.update(kwargs)
     return d
 
 
-def dict_sum(dlist):
+def dict_sum(dlist):  # noqa: D103
     dsum = {}
     for d in dlist:
         for k, v in d.items():
@@ -91,20 +86,20 @@ rules = {
     "anychar": "[ a-zA-Z0-9.$:()&,/'_-]",
     "hex": "[0-9a-fA-F]+",
     "ipchars": "[0-9a-fA-F:.]+",
-    "ipv4": ('digits, (".", digits)*', TIP),
-    "ipaddr": ("ipchars", TIP),
+    "ipv4": ('digits, (".", digits)*', TIP),  # noqa: F405
+    "ipaddr": ("ipchars", TIP),  # noqa: F405
     "cidr": (
         '("inactive:", ws+)?, (ipaddr / ipv4), "/", digits, (ws+, "except")?',
-        TIP,
+        TIP,  # noqa: F405
     ),
     "macaddr": 'hex, (":", hex)+',
-    "protocol": (literals(Protocol.name2num) + " / digits", do_protocol_lookup),
-    "tcp": ('"tcp" / "6"', Protocol("tcp")),
-    "udp": ('"udp" / "17"', Protocol("udp")),
-    "icmp": ('"icmp" / "1"', Protocol("icmp")),
-    "icmp_type": (literals(icmp_types) + " / digits", do_icmp_type_lookup),
-    "icmp_code": (literals(icmp_codes) + " / digits", do_icmp_code_lookup),
-    "port": (literals(ports) + " / digits", do_port_lookup),
-    "dscp": (literals(dscp_names) + " / digits", do_dscp_lookup),
+    "protocol": (literals(Protocol.name2num) + " / digits", do_protocol_lookup),  # noqa: F405
+    "tcp": ('"tcp" / "6"', Protocol("tcp")),  # noqa: F405
+    "udp": ('"udp" / "17"', Protocol("udp")),  # noqa: F405
+    "icmp": ('"icmp" / "1"', Protocol("icmp")),  # noqa: F405
+    "icmp_type": (literals(icmp_types) + " / digits", do_icmp_type_lookup),  # noqa: F405
+    "icmp_code": (literals(icmp_codes) + " / digits", do_icmp_code_lookup),  # noqa: F405
+    "port": (literals(ports) + " / digits", do_port_lookup),  # noqa: F405
+    "dscp": (literals(dscp_names) + " / digits", do_dscp_lookup),  # noqa: F405
     "root": "ws?, junos_raw_acl / junos_replace_family_acl / junos_replace_acl / junos_replace_policers / ios_acl, ws?",
 }