annet 2.5.3__tar.gz → 2.6.0__tar.gz

{annet-2.5.3/annet.egg-info → annet-2.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: annet
-Version: 2.5.3
+Version: 2.6.0
 Summary: annet
 Home-page: https://github.com/annetutil/annet
 License: MIT
@@ -21,7 +21,7 @@ Requires-Dist: yarl>=1.8.2
 Requires-Dist: adaptix==3.0.0b7
 Requires-Dist: dataclass-rest==0.4
 Provides-Extra: netbox
-Requires-Dist: annetbox[sync]>=0.2.2; extra == "netbox"
+Requires-Dist: annetbox[sync]>=0.3.0; extra == "netbox"
 Dynamic: home-page
 Dynamic: license
 Dynamic: license-file

{annet-2.5.3 → annet-2.6.0}/annet/adapters/netbox/common/manufacturer.py

@@ -8,6 +8,7 @@ _VENDORS = {
     "cisco": "Cisco",
     "catalyst": "Cisco Catalyst",
     "nexus": "Cisco Nexus",
+    "iosxr": "Cisco XR",
     "huawei": "Huawei",
     "optixtrans": "Huawei OptiXtrans",
     "juniper": "Juniper",

{annet-2.5.3 → annet-2.6.0}/annet/adapters/netbox/common/models.py

@@ -19,6 +19,11 @@ class Entity(DumpableView):
         return self.name
 
 
+@dataclass
+class EntityWithSlug(Entity):
+    slug: str
+
+
 @dataclass
 class Label:
     value: str
@@ -82,7 +87,7 @@ class IpAddress(DumpableView, Generic[_PrefixT]):
     family: IpFamily
     address: str
     status: Label
-    tags: List[Entity]
+    tags: List[EntityWithSlug]
     created: datetime
     last_updated: datetime
     prefix: Optional[_PrefixT] = None
@@ -135,12 +140,14 @@ class Interface(Entity, Generic[_IpAddressT]):
     mode: Optional[InterfaceMode]
     untagged_vlan: Optional[InterfaceVlan]
     tagged_vlans: Optional[List[InterfaceVlan]]
+    tags: List[EntityWithSlug] = field(default_factory=list)
     display: str = ""
     ip_addresses: List[_IpAddressT] = field(default_factory=list)
     vrf: Optional[Entity] = None
     mtu: int | None = None
     lag: Entity | None = None
     lag_min_links: int | None = None
+    speed: int | None = None
 
     def add_addr(self, address_mask: str, vrf: str | None) -> None:
         for existing_addr in self.ip_addresses:
@@ -186,10 +193,11 @@ class NetboxDevice(Entity, Generic[_InterfaceT]):
     primary_ip: Optional[DeviceIp]
     primary_ip4: Optional[DeviceIp]
     primary_ip6: Optional[DeviceIp]
-    tags: List[Entity]
+    tags: List[EntityWithSlug]
     custom_fields: Dict[str, Any]
     created: datetime
     last_updated: datetime
+    cluster: Optional[Entity]
 
     fqdn: str
     hostname: str

{annet-2.5.3 → annet-2.6.0}/annet/adapters/netbox/common/storage_base.py

@@ -161,6 +161,7 @@ class BaseNetboxStorage(
             return self._id_devices[obj_id]
 
         device = self.netbox.get_device(obj_id)
+        self._fill_device_interfaces([device])
         self._record_device(device)
         return device
 

{annet-2.5.3 → annet-2.6.0}/annet/annet.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+import logging
 import sys
 
 import annet
@@ -18,8 +19,14 @@ def main():
     parser.add_commands(parser.find_subcommands(cli.list_subcommands()))
     try:
         return parser.dispatch(pre_call=annet.init, add_help_command=True)
-    except (generators.GeneratorError, annet.ExecError):
+    except (generators.GeneratorError, annet.ExecError) as e:
+        logging.error(e)
         return 1
+    except BaseException as e:
+        if formatted_output := getattr(e, "formatted_output", None):
+            logging.error(formatted_output)
+            return 1
+        raise e
 
 
 if __name__ == "__main__":

{annet-2.5.3 → annet-2.6.0}/annet/annlib/netdev/devdb/data/devdb.json

@@ -6,6 +6,7 @@
     "Cisco.ASR": " ASR",
     "Cisco.ASR.ASR9000": " 9\\d{3}",
     "Cisco.XRV": "XRv",
+    "Cisco.XR": " 8[\\d\\d\\d]",
     "Cisco.Catalyst": " (Catalyst |WS-C)",
     "Cisco.Catalyst.C2900": "29\\d\\d",
     "Cisco.Catalyst.C2900.C2950": "2950",

{annet-2.5.3 → annet-2.6.0}/annet/annlib/netdev/views/hardware.py

@@ -75,6 +75,8 @@ class HardwareView(HardwareLeaf):
 def hw_to_vendor(hw: HardwareView) -> Optional[str]:
     if hw.Nexus:
         return "nexus"
+    elif hw.Cisco.XR or hw.Cisco.ASR or hw.Cisco.XRV:
+        return "iosxr"
     elif hw.Cisco:
         return "cisco"
     elif hw.OptiXtrans:
@@ -108,6 +110,7 @@ def vendor_to_hw(vendor):
             "cisco": "Cisco",
             "catalyst": "Cisco Catalyst",
             "nexus": "Cisco Nexus",
+            "iosxr": "Cisco XR",
             "huawei": "Huawei",
             "optixtrans": "Huawei OptiXtrans",
             "juniper": "Juniper",

{annet-2.5.3 → annet-2.6.0}/annet/annlib/rbparser/platform.py

@@ -3,6 +3,7 @@ VENDOR_REVERSES = {
     "h3c": "undo",
     "optixtrans": "undo",
     "cisco": "no",
+    "iosxr": "no",
     "nexus": "no",
     "juniper": "delete",
     "arista": "no",
@@ -18,6 +19,7 @@ VENDOR_DIFF = {
     "huawei": "common.default_diff",
     "optixtrans": "common.default_diff",
     "cisco": "common.default_diff",
+    "iosxr": "common.default_diff",
     "nexus": "common.default_diff",
     "juniper": "juniper.default_diff",
     "arista": "common.default_diff",
@@ -33,6 +35,7 @@ VENDOR_DIFF_ORDERED = {
     "huawei": "common.ordered_diff",
     "optixtrans": "common.ordered_diff",
     "cisco": "common.ordered_diff",
+    "iosxr": "common.ordered_diff",
     "nexus": "common.ordered_diff",
     "juniper": "juniper.ordered_diff",
     "arista": "common.ordered_diff",
@@ -49,6 +52,7 @@ VENDOR_EXIT = {
     "h3c": "quit",
     "optixtrans": "quit",
     "cisco": "exit",
+    "iosxr": "exit",
     "nexus": "exit",
     "arista": "exit",
     "juniper": "",

{annet-2.5.3 → annet-2.6.0}/annet/annlib/rulebook/common.py

@@ -297,7 +297,7 @@ def apply(hw, do_commit, do_finalize, **_):
             after.add_cmd(Command("abort"))  # просто exit оставит висеть configure session
         if do_finalize:
             after.add_cmd(Command("write memory"))
-    elif hw.ASR or hw.XRV:
+    elif hw.ASR or hw.XRV or hw.XR:
         # коммит сам сохраняет изменения в стартап do_finalize не применим
         before.add_cmd(Command("configure exclusive"))
         if do_commit:

{annet-2.5.3 → annet-2.6.0}/annet/generators/__init__.py

@@ -197,7 +197,7 @@ def _run_partial_generator(gen: "PartialGenerator", run_args: GeneratorPartialRu
                 raise
             except Exception as err:
                 filename, lineno = gen.get_running_line()
-                logger.exception("Generator error in file '%s:%i'", filename, lineno)
+                logger.error("Generator error in file '%s:%i'", filename, lineno)
                 raise GeneratorError(f"{gen} on {device}") from err
 
             fmtr = tabparser.make_formatter(device.hw)

{annet-2.5.3 → annet-2.6.0}/annet/parallel.py

@@ -15,13 +15,14 @@ import tempfile
 import time
 import traceback
 import warnings
-from typing import Any, List, Optional, Type
+from typing import Any, List, Optional, Type, Callable
 from uuid import uuid4
 
 from contextlog import get_logger
 
 import annet
 from annet import tracing
+from annet.connectors import Connector
 from annet.lib import catch_ctrl_c, find_exc_in_stack
 from annet.output import capture_output
 from annet.tracing import tracing_connector
@@ -38,6 +39,20 @@ class PoolWorkerTask:
     payload: Optional[Any] = None
 
 
+class _PickleSafeTracebackFormatterConnector(Connector[Callable[[BaseException], str]]):
+    name = "PickleSafeTraceBackFormatter"
+    ep_name = "pickle_safe_traceback_formatter"
+
+    def _get_default(self) -> Callable[[], Callable[[BaseException], str]]:
+        def wrapper():
+            return lambda x: "".join(traceback.format_exception(x))
+
+        return wrapper
+
+
+pickle_safe_traceback_formatter_connector = _PickleSafeTracebackFormatterConnector()
+
+
 class PickleSafeException(Exception):
     """An exception that can be safely pickled and passed between processes."""
 
@@ -59,9 +74,14 @@ class PickleSafeException(Exception):
         pretty_lines.append(self.formatted_output)
         return "\n".join(pretty_lines)
 
-    @staticmethod
-    def from_exc(orig_exc: Exception, device_id: str, formatted_output: str) -> "PickleSafeException":
-        return PickleSafeException(orig_exc.__class__, str(orig_exc), device_id, formatted_output)
+    @classmethod
+    def from_exc(cls, orig_exc: Exception, device_id: str) -> "PickleSafeException":
+        return PickleSafeException(
+            orig_exc.__class__,
+            str(orig_exc),
+            device_id,
+            pickle_safe_traceback_formatter_connector.get()(orig_exc)
+        )
 
 
 @catch_ctrl_c
@@ -164,7 +184,7 @@ def _pool_worker(pool, index, task_queue, done_queue):
         except KeyboardInterrupt:  # pylint: disable=try-except-raise
             raise
         except Exception as exc:
-            safe_exc = PickleSafeException.from_exc(exc, task.payload, traceback.format_exc())
+            safe_exc = PickleSafeException.from_exc(exc, task.payload)
             ret_exc = safe_exc
             task_result.exc = safe_exc
             task_result.result = None
@@ -301,11 +321,10 @@ class Parallel:
                             **self.kwargs
                         )
                 except Exception as exc:
+                    safe_exc = PickleSafeException.from_exc(exc, device_id)
                     if not tolerate_fails:
-                        raise
-                    exc.device_id = device_id
-                    exc.formatted_output = traceback.format_exc()
-                    task_result.exc = exc
+                        raise safe_exc
+                    task_result.exc = safe_exc
                 if self.capture_output:
                     task_result.extra["cap_stdout"] = cap_stdout.read()
                     task_result.extra["cap_stderr"] = cap_stderr.read()

annet-2.6.0/annet/rulebook/texts/arista.rul

@@ -0,0 +1,82 @@
+description %global
+
+
+qos profile *
+    ~ %global
+
+username * ssh-key
+username *                %logic=arista.aaa.user
+
+aaa group ~
+    ~ %global
+
+
+role *
+    ~ %global
+
+
+vrf instance *
+    ~ %global
+
+
+interface *               %logic=arista.iface.permanent
+    no switchport
+    description *
+    channel-group *
+    lacp rate *
+    service-profile *
+    ~ %global
+
+
+ip access-list standard *
+    *                       %logic=common.undo_redo
+
+ipv6 access-list standard *
+    *                       %logic=common.undo_redo
+
+ipv6 access-list *
+    *                       %logic=common.undo_redo
+
+
+# ios-like way of configuring prefix lists
+# should be kept above a eos-native one in arista.rul
+# since beginnig of commands are the same
+# if you use it keep all prefix lists in this format
+
+ip prefix-list * seq *    %logic=common.undo_redo
+ipv6 prefix-list * seq *  %logic=common.undo_redo
+
+
+# arista eos native way of configuring prefix lists
+# should be below to not collide with ios-like one
+# only one format is supported at the time for one family
+# prefer this one over the ios-like one
+
+ip prefix-list *
+    seq *                 %logic=common.undo_redo
+
+ipv6 prefix-list *
+    seq *                 %logic=common.undo_redo
+
+
+route-map * * *
+    ~ %global
+
+router bfd
+    ~ %global
+
+
+router bgp *
+    no bgp default *
+    neighbor * maximum-routes
+    ! no neighbor * shutdown
+    ~ %global
+
+ip load-sharing trident fields *              %logic=common.default_instead_undo
+
+management *
+    ~ %global
+
+
+no ~ %global
+~ %global

annet-2.6.0/annet/rulebook/texts/iosxr.deploy

@@ -0,0 +1,27 @@
+# Рулбук деплоя на устройства
+#
+# Операторы:
+#   *  Один аргумент
+#   ~  Несколько аргументов (минимум один)
+#
+# Параметры:
+#   %timeout=...  Таймаут выполнения команды (в секундах, по умолчанию 30)
+#
+# Ответы на вопросы
+#
+# <команда>
+#   dialog: <вопрос> ::: <ответ> <параметры>
+#
+# Если <вопрос> заключён в слеши (//), то воспринимается как регулярка, иначе - точное совпадение.
+# Параметы:
+#   %send_nl=...  Посылать ли перевод строки после ответа (bool, по умолчанию true)
+# -----
+
+crypto key generate rsa %timeout=60
+    dialog: Do you really want to replace them? [yes/no]: ::: no
+    dialog: How many bits in the modulus [512]: ::: 2048
+no username * privilege * secret * *
+    dialog: This operation will remove all username related configurations with same name.Do you want to continue? [confirm] ::: Y  %send_nl=0
+
+copy running-config startup-config
+    dialog: Destination filename [startup-config]? ::: startup-config

annet-2.6.0/annet/rulebook/texts/iosxr.order

@@ -0,0 +1,85 @@
+# В этом файле определяется порядок команд, в котором их следует подавать на устройство.
+# - Если порядок команды не важен - ее можно не писать сюда совсем.
+# - Если команда начинается с undo и прописан параметр %order_reverse - команда считается
+#   обратной, но занимает место между прямыми там, где указано.
+
+banner login %order_reverse
+
+# Фичи должны быть включены прежде всего
+feature
+# За ним сервисы
+service
+
+aaa new-model
+aaa ~
+
+no password strength-check
+username
+tacacs-server
+
+radius
+radius-server
+dot1x
+
+privilege
+file
+
+ip access-list
+ipv6 access-list
+class-map
+policy-map
+system qos
+control-plane
+
+snmp-server source-interface
+snmp-server user
+snmp-server host
+snmp-server enable
+snmp-server context
+snmp-server community
+snmp-server mib
+
+ntp distribute
+ntp server
+ntp commit
+
+vlan
+vlan group
+
+spanning-tree
+
+# перед тем, как менять mtu на интерфейсах, надо выставить максимальный
+no system jumbomtu %order_reverse
+system jumbomtu
+
+service dhcp
+ip dhcp relay
+ipv6 dhcp relay
+
+vrf context
+
+interface */Vlan\d+/
+interface *
+    no switchport
+    encapsulation
+    vrf member
+    ip
+    ipv6
+    no ipv6 nd %order_reverse
+    ipv6 nd
+    ~
+    channel-group
+
+interface */\S+\.\d+/
+
+route-map
+
+# удалять eth-trunk можно только после того, как вычистим member interfaces
+undo interface */port-channel\d+/  %order_reverse
+
+# remote as of neighbors should be assigned before peer-group, the rule is applied to neighbors, not peer-groups
+router bgp
+    neighbor */[\da-f\.\:]+/ remote-as
+    neighbor */[\da-f\.\:]+/ peer-group
+
+line

annet-2.6.0/annet/rulebook/texts/iosxr.rul

@@ -0,0 +1,110 @@
+# Операторы:
+#   *  Один аргумент в undo
+#   ~  Несколько аргументов (минимум один) в undo
+#
+# Параметры:
+#   %global         Команда действует на любом уровне ниже
+#   %logic=...      Кастомная функция обработки правила
+#   %diff_logic=... Кастомная функция построения диффа.
+#                   данная функция работает для подблоков (в отличие от %logic)
+#   %comment=...    Добавить коммент после строки который будет видно с опцией patch --add-comments
+#                   Сделано в основном для того чтобы генерировать специальные команды для наливки
+# -----
+
+ip domain-name *
+hostname *
+
+banner login * %logic=cisco.misc.banner_login
+
+ip community-list standard ~
+
+!vrf context management
+vrf context *
+
+vlan group * vlan-list %logic=cisco.vlandb.simple
+vlan */[^\d].*/
+vlan %logic=cisco.vlandb.simple
+    name
+
+ip ssh version 2 %logic=cisco.misc.ssh_key
+
+# ordering of SNMP blocks
+ip access-list ~
+snmp-server view ~
+snmp-server community ~
+snmp-server host ~
+# Deleting a user using either SNMP or the CLI results in the user being deleted for both SNMP and the CLI.
+# User-role mapping changes are synchronized in SNMP and the CLI.
+!snmp-server user admin ~
+!snmp-server user *
+# Disabling this SNMP option throws WARNING which stops mpdaemon set-up process
+no snmp-server sysobjectid type stack-oid
+
+!interface */(mgmt|ipmi|Vlan1$)/
+
+interface Loopback
+    ipv6 address *
+    ip address ~
+    ! no ip address
+
+# SVI/Subifs/Lagg
+interface */(Vlan|Ethernet.*\.|port-channel.*\.?)\d+$/ %diff_logic=cisco.iface.diff
+    vrf member
+    ipv6 link-local
+    ipv6 address *
+    ipv6 nd ~                      %logic=cisco.misc.no_ipv6_nd_suppress_ra
+    ip address ~
+    ! no ip address
+    mtu
+
+# Physical
+interface */\w*Ethernet[0-9\/]+$/     %logic=common.permanent %diff_logic=cisco.iface.diff
+    switchport mode
+    switchport trunk native vlan
+    switchport access vlan
+    switchport trunk allowed vlan %logic=cisco.vlandb.swtrunk
+    vrf member
+    ipv6 link-local
+    ipv6 address *
+    ip address ~
+    ! no ip address
+    channel-group
+    mtu
+    storm-control * level
+    spanning-tree portfast
+
+router bgp
+    router-id
+    vrf *
+        router-id
+        address-family ~
+            maximum-paths
+        neighbor ~
+            update-source
+
+policy-map type qos *
+    class *            %ordered
+        ~
+
+prefix-set *
+    ~              %rewrite %global
+
+as-path-set *
+    ~              %rewrite %global
+
+community-set *
+    ~              %rewrite %global
+
+route-policy *
+    ~              %rewrite %global
+
+line ~
+    exec-timeout
+    transport input
+
+description %global
+
+no ~ %global
+~ %global
+
+# vim: set syntax=annrulebook:

{annet-2.5.3 → annet-2.6.0}/annet/tabparser.py

@@ -23,7 +23,7 @@ def make_formatter(hw, **kwargs):
         cls = OptixtransFormatter
     elif hw.Huawei:
         cls = HuaweiFormatter
-    elif hw.Cisco.ASR or hw.Cisco.XRV:
+    elif hw.Cisco.ASR or hw.Cisco.XRV or hw.Cisco.XR:
         cls = AsrFormatter
     elif hw.Nexus:
         cls = NexusFormatter

{annet-2.5.3 → annet-2.6.0/annet.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: annet
-Version: 2.5.3
+Version: 2.6.0
 Summary: annet
 Home-page: https://github.com/annetutil/annet
 License: MIT
@@ -21,7 +21,7 @@ Requires-Dist: yarl>=1.8.2
 Requires-Dist: adaptix==3.0.0b7
 Requires-Dist: dataclass-rest==0.4
 Provides-Extra: netbox
-Requires-Dist: annetbox[sync]>=0.2.2; extra == "netbox"
+Requires-Dist: annetbox[sync]>=0.3.0; extra == "netbox"
 Dynamic: home-page
 Dynamic: license
 Dynamic: license-file

{annet-2.5.3 → annet-2.6.0}/annet.egg-info/SOURCES.txt

@@ -173,6 +173,9 @@ annet/rulebook/texts/cisco.rul
 annet/rulebook/texts/huawei.deploy
 annet/rulebook/texts/huawei.order
 annet/rulebook/texts/huawei.rul
+annet/rulebook/texts/iosxr.deploy
+annet/rulebook/texts/iosxr.order
+annet/rulebook/texts/iosxr.rul
 annet/rulebook/texts/juniper.order
 annet/rulebook/texts/juniper.rul
 annet/rulebook/texts/nexus.deploy

{annet-2.5.3 → annet-2.6.0}/annet.egg-info/requires.txt

@@ -13,4 +13,4 @@ adaptix==3.0.0b7
 dataclass-rest==0.4
 
 [netbox]
-annetbox[sync]>=0.2.2
+annetbox[sync]>=0.3.0

{annet-2.5.3 → annet-2.6.0}/annet_generators/rpl_example/generator.py

@@ -30,6 +30,9 @@ class CommunityGenerator(CommunityListGenerator):
 
 
 class PolicyGenerator(RoutingPolicyGenerator):
+    def get_prefix_lists(self, device: Any) -> list[IpPrefixList]:
+        return PREFIX_LISTS
+
     def get_policies(self, device: Any) -> list[RoutingPolicy]:
         return get_policies(
             routemap=routemap,

{annet-2.5.3 → annet-2.6.0}/setup.py

@@ -44,7 +44,7 @@ if __name__ == "__main__":
           ],
         },
         extras_require={
-            "netbox": ["annetbox[sync]>=0.2.2"],
+            "netbox": ["annetbox[sync]>=0.3.0"],
         },
         python_requires=">=3.10",
         install_requires=requirements(),