ifstate 2.0.0rc3__py3-none-any.whl → 2.0.0rc4__py3-none-any.whl

{ifstate-2.0.0rc3.dist-info → ifstate-2.0.0rc4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ifstate
-Version: 2.0.0rc3
+Version: 2.0.0rc4
 Summary: Manage host interface settings in a declarative manner
 Home-page: https://ifstate.net/
 Author: Thomas Liske

{ifstate-2.0.0rc3.dist-info → ifstate-2.0.0rc4.dist-info}/RECORD

@@ -3,12 +3,12 @@ ifstate/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ifstate/ifstate.py,sha256=ioiM9xgVWdrpTpK_UxJdaJFlmpFM9R-2_d5pq9_Hepo,9272
 ifstate/shell.py,sha256=7_JFpi4icr9MijynDzbb0v5mxhFsng6PCC4m3uQ255A,2177
 ifstate/vrrp.py,sha256=FJ9b1eJseTtZFfknHU-xV68Qz7cPrRrc5PTcjUVj-fY,5953
-ifstate-2.0.0rc3.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-libifstate/__init__.py,sha256=iDV2VI11gPAIDrTXKqkWbo4B9bRcokiY3Fzyu440ayg,33194
-libifstate/exception.py,sha256=jhLN46mqlyGNEz7lmc0K2d3SoZJtKzEVyPduPh22oC0,2280
+ifstate-2.0.0rc4.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+libifstate/__init__.py,sha256=twHhETYpEtBxqnWKOGYwOyOV1Ahgqi_ybAk2rodpre4,33845
+libifstate/exception.py,sha256=NmKqD9O8dRWBgO__Pt0_wGSR5GWZ1RHXZZEUI3ArVLo,2360
 libifstate/log.py,sha256=XVoZdwdQoWsjuupFIuG6OP0OrBpXpx7oqyAaUhQ-nJk,4553
 libifstate/util.py,sha256=raYAaRy15JQNUbU3_4GchYV_PkaCvWR_8xjt7NTzMYw,11335
-libifstate/address/__init__.py,sha256=zIGM7UWXSvoijHMD06DfS2CDtiHpiJlqDgJG7Dl1IPE,3222
+libifstate/address/__init__.py,sha256=SobrZ9e2ItrmEidnKPBhUMitRDdTEajbkU9Rkmtx-gQ,3165
 libifstate/bpf/__init__.py,sha256=NVzaunTmJU2PbIQg9eWBMKpFgLh3EnD3ujNa7Yt6rNc,7699
 libifstate/bpf/ctypes.py,sha256=kLZJHZlba09Vc-tbsJAcKpDwdoNO2IjlYVLCopawHmA,4274
 libifstate/bpf/map.py,sha256=cLHNMvRBDNW2yVCEf3z242_oRdU0HqVbFEYVkKXng0w,10818
@@ -16,23 +16,23 @@ libifstate/brport/__init__.py,sha256=NzdA8F4hr2se1bXKNnyKZbvOFlCWBq_cdjwsL1H0Y-o
 libifstate/fdb/__init__.py,sha256=9dpL5n8ct3CaA-z8I6ZEkD3yL6yWJQeq3fpIe9pc2zw,6486
 libifstate/hook/__init__.py,sha256=OPUyhrr-eT1UNp8ryYoJyvi4WWqL2Ql33szir673Td4,7379
 libifstate/link/__init__.py,sha256=QZggoC-bIscqwVedqVycaSqS1CmXB3Bx3m2FZei8Q_4,115
-libifstate/link/base.py,sha256=dazZVPRMyXms-ICiL7VOCUXwZnqNr1X6R2NjTlm2nEU,34384
-libifstate/link/physical.py,sha256=ectyXVchCHqWZR8qsjAD9667wjQbGW1OUKLQheTUFys,594
-libifstate/link/tun.py,sha256=SWkscSAgIk3DWFPWHo9Cmokhj88rO1_sR7Z0Qlg2xGA,993
+libifstate/link/base.py,sha256=zsitL1kSPLvjzZqyUIyEoCVlE_dhX2z5acNL1iZ2EAE,34508
+libifstate/link/physical.py,sha256=IG1OXG2q25QmvhxEDhyT-bf7guwIyXl0OzSJgQOqXzY,613
+libifstate/link/tun.py,sha256=Rzn3ysE0cVuQGi3naxs9QXYBrLwVQTaVrFv2dtR1D60,1012
 libifstate/link/veth.py,sha256=Sv5WZMMsefYFz9I0BQSZyKytCQYxv0vjwAnB7FYHR1A,2283
 libifstate/neighbour/__init__.py,sha256=FJJpbJvqnxvOEii6QDMYzW5jQDEbiEy71GQOEbqaS48,2463
-libifstate/netns/__init__.py,sha256=ptSIVld_BNXPE6f4SiIPVdYOE1sgprf5-ZhR-L_3BPE,10145
-libifstate/parser/__init__.py,sha256=byz1W0G7UewVc5FFie-ti3UZjGK3-75wHIaOeq0oySQ,88
-libifstate/parser/base.py,sha256=EV7uJYdVke3a2ghkUZ6ZeaIeVQAPVS4rFnYhebXeQm0,5932
+libifstate/netns/__init__.py,sha256=5Ak4vHU5UvdSYPFIQ8i8VMba2luyUeSpYAtRXxdTGPE,10287
+libifstate/parser/__init__.py,sha256=uzv5U-6RPy-SSIyxR6H_F0SvAOQQF8x5ygErpUhsa7Y,109
+libifstate/parser/base.py,sha256=PPUXWzZ1iMWseZzeV2uWmFIInmi8xxGDgul6afmVjd4,6584
 libifstate/parser/yaml.py,sha256=MC0kmwqt3P45z61fb_wfUqoj0iZyhFYkdPyr0UqMSZA,1415
 libifstate/routing/__init__.py,sha256=O4lbaCJvLgx-iQUa0WDgRmSPR4AKvveqPgxxb4HwYQ4,25305
-libifstate/sysctl/__init__.py,sha256=u1VJ1aPXeGCl3rwj3g0bDbz6k5k9YS5hQIsgFOBokpk,3202
-libifstate/tc/__init__.py,sha256=inPdampCOIr_4oKNB3awqMkW0Eh4fpPh9jvSba6sPVg,12092
+libifstate/sysctl/__init__.py,sha256=VLzz1YcNEclRMVvwZuJgkYxPTjErl-7-rwSOKiEG6_M,3544
+libifstate/tc/__init__.py,sha256=T8LEBxiHZH4sayPn9lK5hK8eB8dskuw6-kw81W_aMWU,12097
 libifstate/wireguard/__init__.py,sha256=dXILLIuahBCkX2ONhre28SzJrVNksbjOICs-cSGGaRg,8625
 libifstate/xdp/__init__.py,sha256=X1xhEIGng7R5d5F4KsChykT2g6H-XBRWbWABijoYDQA,7208
 schema/2/ifstate.conf.schema.json,sha256=ukCafLPfHCXpk44u5RMMhWIh9JoIAt2j_3idysAVHaQ,218763
-ifstate-2.0.0rc3.dist-info/METADATA,sha256=hdygdnfWvpggPIMQXwGSHPovg8Xt8VzsE-gAlPf1y-Y,1607
-ifstate-2.0.0rc3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-ifstate-2.0.0rc3.dist-info/entry_points.txt,sha256=HF6jX7Uu_nF1Ly-J9uEPeiRapOxnM6LuHsb2y6Mt-k4,52
-ifstate-2.0.0rc3.dist-info/top_level.txt,sha256=A7peI7aKBaM69fsiSPvMbL3rzTKZZr5qDxKC-pHMGdE,19
-ifstate-2.0.0rc3.dist-info/RECORD,,
+ifstate-2.0.0rc4.dist-info/METADATA,sha256=l7BY5YH_qpCDHZnyMRjS8sa9p4dZn-TyxaVPqCtBpbM,1607
+ifstate-2.0.0rc4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+ifstate-2.0.0rc4.dist-info/entry_points.txt,sha256=HF6jX7Uu_nF1Ly-J9uEPeiRapOxnM6LuHsb2y6Mt-k4,52
+ifstate-2.0.0rc4.dist-info/top_level.txt,sha256=A7peI7aKBaM69fsiSPvMbL3rzTKZZr5qDxKC-pHMGdE,19
+ifstate-2.0.0rc4.dist-info/RECORD,,

libifstate/__init__.py

@@ -5,7 +5,7 @@ from libifstate.fdb import FDB
 from libifstate.hook import Hooks
 from libifstate.neighbour import Neighbours
 from libifstate.routing import Tables, Rules, RTLookups
-from libifstate.parser import Parser
+from libifstate.parser import Parser, get_available_hooks
 from libifstate.tc import TC
 from libifstate.exception import netlinkerror_classes
 import bisect
@@ -35,11 +35,16 @@ except ModuleNotFoundError:
     # ignore missing plugin
     pass
 
+try:
+    from jsonschema import validate, ValidationError, FormatChecker
+except ModuleNotFoundError:
+    # fail open and ignore missing jsonschema dependency
+    pass
+
 from libifstate.netns import NetNameSpace, prepare_netns, LinkRegistry, get_netns_instances
 from libifstate.util import logger, root_iw, IfStateLogging, LinkDependency, IDENTIFY_LOOKUPS
 from libifstate.exception import FeatureMissingError, LinkCircularLinked, LinkNoConfigFound, ParserValidationError
 from ipaddress import ip_network, ip_interface
-from jsonschema import validate, ValidationError, FormatChecker
 from copy import deepcopy
 import os
 import pkgutil
@@ -49,7 +54,7 @@ import json
 import errno
 import logging
 
-__version__ = "2.0.0rc3"
+__version__ = "2.0.0rc4"
 
 class IfState():
     def __init__(self):
@@ -66,6 +71,7 @@ class IfState():
             'link': True,
             'sysctl': os.access('/proc/sys/net', os.R_OK),
             'ethtool': not ethtool_path is None,
+            'schema': not globals().get("validate") is None,
             'tc': True,
             'wireguard': not globals().get("WireGuard") is None,
             'bpf': not globals().get("libbpf") is None,
@@ -81,28 +87,31 @@ class IfState():
                 libbpf.libbpf_set_print(0)
 
     def update(self, ifstates, soft_schema):
-        # check config schema
-        schema = json.loads(pkgutil.get_data(
-            "libifstate", "../schema/{}/ifstate.conf.schema.json".format(__version__.split('.')[0])))
-        try:
-            validate(ifstates, schema, format_checker=FormatChecker())
-        except ValidationError as ex:
-            if len(ex.path) > 0:
-                path = ["$"]
-                for i, p in enumerate(ex.absolute_path):
-                    if type(p) == int:
-                        path.append("[{}]".format(p))
-                    else:
-                        path.append(".")
-                        path.append(p)
+        if self.features['schema']:
+            # check config schema
+            schema = json.loads(pkgutil.get_data(
+                "libifstate", "../schema/{}/ifstate.conf.schema.json".format(__version__.split('.')[0])))
+            try:
+                validate(ifstates, schema, format_checker=FormatChecker())
+            except ValidationError as ex:
+                if len(ex.path) > 0:
+                    path = ["$"]
+                    for i, p in enumerate(ex.absolute_path):
+                        if type(p) == int:
+                            path.append("[{}]".format(p))
+                        else:
+                            path.append(".")
+                            path.append(p)
 
-                detail = "{}: {}".format("".join(path), ex.message)
-            else:
-                detail = ex.message
-            if soft_schema:
-                logger.error("Config validation failed for {}".format(detail))
-            else:
-                raise ParserValidationError(detail)
+                    detail = "{}: {}".format("".join(path), ex.message)
+                else:
+                    detail = ex.message
+                if soft_schema:
+                    logger.error("Config validation failed for {}".format(detail))
+                else:
+                    raise ParserValidationError(detail)
+        else:
+            logger.debug('Python package jsonschema not available, skipping config validation.')
 
         # add interface defaults
         if 'defaults' in ifstates:
@@ -349,8 +358,8 @@ class IfState():
                     # ignore if the link is already gone, this might happen
                     # when removing veth link peers
                     if err.code != errno.ENODEV:
-                        logger.warning('removing link {} failed: {}'.format(
-                            ifname, err.args[1]), extra={'netns': item.netns})
+                        logger.warning('removing failed: {}'.format(
+                            err.args[1]), extra={'iface': ifname, 'netns': item.netns})
             return True
         else:
             # shutdown physical interfaces
@@ -364,8 +373,8 @@ class IfState():
                     except Exception as err:
                         if not isinstance(err, netlinkerror_classes):
                             raise
-                        logger.warning('updating link {} failed: {}'.format(
-                            ifname, err.args[1]), extra={'netns': item.netns})
+                        logger.warning('updating failed: {}'.format(
+                            err.args[1]), extra={'iface': ifname, 'netns': item.netns})
             return False
 
     def _dependencies(self, netns):
@@ -518,9 +527,8 @@ class IfState():
                 if link_dep.netns is None:
                     self._apply_iface(do_apply, self.root_netns, link_dep, by_vrrp, vrrp_type, vrrp_name, vrrp_state)
                 else:
-                    if link_dep.netns not in self.namespaces:
-                        logger.warning("add link {} failed: netns '{}' is unknown".format(link_dep.ifname, link_dep.netns))
-                        return
+                    if self.namespaces is None or link_dep.netns not in self.namespaces:
+                        logger.warning("apply link {} failed: netns '{}' is unknown".format(link_dep.ifname, link_dep.netns))
                     else:
                         self._apply_iface(do_apply, self.namespaces[link_dep.netns], link_dep, by_vrrp, vrrp_type, vrrp_name, vrrp_state)
 
@@ -559,8 +567,10 @@ class IfState():
 
     def _apply_iface(self, do_apply, netns, link_dep, by_vrrp, vrrp_type, vrrp_name, vrrp_state):
         ifname = link_dep.ifname
-        if ifname in netns.links:
-            link = netns.links[ifname]
+        if not ifname in netns.links:
+            logger.warning('no link settings found', extra={'iface': ifname, 'netns': netns})
+            return
+        link = netns.links[ifname]
 
         # check for vrrp mode:
         #   disable: vrrp type & name matches, but vrrp state not
@@ -672,6 +682,10 @@ class IfState():
     def show(self, showall=False, show_secrets=False):
         if showall:
             defaults = deepcopy(Parser._default_ifstates)
+
+            hooks = get_available_hooks()
+            if hooks:
+                defaults['parameters']['hooks'] = hooks
         else:
             defaults = {}
 

libifstate/address/__init__.py

@@ -18,8 +18,8 @@ class Addresses():
         # get ifindex
         idx = next(iter(self.netns.ipr.link_lookup(ifname=self.iface)), None)
 
+        # check if interface exists
         if idx == None:
-            logger.warning('link missing', extra={'iface': self.iface, 'netns': self.netns})
             return
 
         # get active ip addresses

libifstate/exception.py

@@ -4,8 +4,9 @@ from libifstate.util import logger
 netlinkerror_classes = (NetlinkError)
 
 class ExceptionCollector():
-    def __init__(self, ifname):
+    def __init__(self, ifname, netns):
         self.ifname = ifname
+        self.netns = netns
         self.reset()
 
     def reset(self):
@@ -19,8 +20,9 @@ class ExceptionCollector():
             'args': kwargs,
         })
         if not self.quiet:
-            logger.warning('{} link {} failed: {}'.format(
-                op, self.ifname, excpt.args[1]))
+            logger.warning('{} failed: {}'.format(
+                op, excpt.args[1]),
+                extra={'iface': self.ifname, 'netns': self.netns})
 
     def has_op(self, op):
         for e in self.excpts:

libifstate/link/base.py

@@ -436,7 +436,7 @@ class Link(ABC):
         return self.match_vrrp_select(vrrp_type, vrrp_name) and (vrrp_state in self.vrrp['states'])
 
     def apply(self, do_apply, sysctl):
-        excpts = ExceptionCollector(self.settings['ifname'])
+        excpts = ExceptionCollector(self.settings['ifname'], self.netns)
         osettings = copy.deepcopy(self.settings)
 
         # lookup for attributes requiring a interface index
@@ -448,8 +448,11 @@ class Link(ABC):
                     # ignore *_netns settings if the netns is the same as the interface's one
                     # (there is no IFLA_LINK_NETNSID attribute in such cases)
                     if self.settings[netns_attr] != self.netns.netns:
-                        # ToDo: throw exception for unknown netns
-                        (peer_ipr, peer_nsid) = self.netns.get_netnsid(self.settings[netns_attr])
+                        try:
+                            (peer_ipr, peer_nsid) = self.netns.get_netnsid(self.settings[netns_attr])
+                        except NetnsUnknown as ex:
+                            excpts.add('apply', ex)
+                            return excpts
                         self.settings[netnsid_attr] = peer_nsid
                         idx = next(iter(peer_ipr.link_lookup(
                             ifname=self.settings[attr])), None)

libifstate/link/physical.py

@@ -10,4 +10,4 @@ class PhysicalLink(Link):
         self.ethtool = ethtool
  
     def create(self, do_apply, sysctl, excpts, oper="add"):
-        logger.warning('Unable to create missing physical link: {}'.format(self.settings.get('ifname')))
+        logger.warning('unable to create physical link', extra={'iface': self.settings.get('ifname'), 'netns': self.netns})

libifstate/link/tun.py

@@ -18,6 +18,6 @@ class TunLink(Link):
  
     def create(self, do_apply, sysctl, excpts, oper="add"):
         if not self.cap_create:
-            logger.warning('Unable to create missing non-persistent tuntap link: {}'.format(self.settings.get('ifname')))
+            logger.warning('unable to create non-persistent tuntap link', extra={'iface': self.settings.get('ifname'), 'netns': self.netns})
         else:
             super().create(do_apply, sysctl, excpts, oper)

libifstate/netns/__init__.py

@@ -1,3 +1,4 @@
+from libifstate.exception import NetnsUnknown
 from libifstate.util import logger, IfStateLogging, IPRouteExt, NetNSExt, root_ipr, root_iw, IDENTIFY_LOOKUPS
 from libifstate.sysctl import Sysctl
 
@@ -88,9 +89,11 @@ class NetNameSpace():
         if peer_netns_name is None:
             peer_ipr = root_ipr
             peer_pid = 1
-        else:
+        elif peer_netns_name in netns_name_map:
             peer_ipr = netns_name_map[peer_netns_name]
             peer_pid = peer_ipr.child
+        else:
+            raise NetnsUnknown(peer_netns_name)
 
         result = self.ipr.get_netnsid(pid=peer_pid)
         if result['nsid'] == 4294967295:

libifstate/parser/__init__.py

@@ -1,2 +1,2 @@
-from libifstate.parser.base import Parser
+from libifstate.parser.base import Parser, get_available_hooks
 from libifstate.parser.yaml import YamlParser

libifstate/parser/base.py

@@ -1,7 +1,22 @@
+from libifstate.hook import HOOK_DIR
 from libifstate.util import logger
 from libifstate.exception import ParserValidationError
 from abc import ABC, abstractmethod
 from copy import deepcopy
+import os
+
+
+def get_available_hooks():
+    # check if there is a hooks dir before trying to scan it
+    if not os.path.isdir(HOOK_DIR):
+        return {}
+
+    hooks = {}
+    with os.scandir(HOOK_DIR) as it:
+        for dentry in it:
+            if dentry.is_file():
+                hooks[dentry.name] = {}
+    return hooks
 
 
 class Parser(ABC):
@@ -151,6 +166,14 @@ class Parser(ABC):
         for namespace in cfg.get('namespaces', {}):
             self._update_lo(cfg['namespaces'][namespace])
 
+        # add available hooks
+        if "hooks"  in cfg["parameters"]:
+            hooks = get_available_hooks()
+            hooks.update(cfg["parameters"]["hooks"])
+            cfg["parameters"]["hooks"] = hooks
+        else:
+            cfg["parameters"]["hooks"] = get_available_hooks()
+
         # merge builtin defaults
         if "defaults" in cfg["parameters"]:
             cfg["parameters"]["defaults"].extend(cfg["parameters"]["defaults_builtin"])

libifstate/sysctl/__init__.py

@@ -3,6 +3,14 @@ import pyroute2.netns
 
 import os
 
+def deep_update(d, u):
+    """update the nested dict `d` with values from `u`"""
+    for k, v in u.items():
+        if isinstance(v, dict):
+            d[k] = deep_update(d.get(k, {}), v)
+        else:
+            d[k] = v
+    return d
 
 class Sysctl():
     def __init__(self, netns):
@@ -17,7 +25,8 @@ class Sysctl():
         self.netns = netns
 
     def add(self, iface, sysctl):
-        self.sysctls[iface] = sysctl
+        # deeply apply changes to the default/previously defined values
+        self.sysctls[iface] = deep_update(self.sysctls[iface], sysctl)
 
     def add_global(self, proto, sysctl):
         self.globals[proto] = sysctl

libifstate/tc/__init__.py

@@ -254,7 +254,7 @@ class TC():
         return changes
 
     def apply(self, do_apply):
-        excpts = ExceptionCollector(ifname=self.iface)
+        excpts = ExceptionCollector(self.iface, self.netns)
 
         # get ifindex
         self.idx = next(iter(self.netns.ipr.link_lookup(ifname=self.iface)), None)