Add logging to pymin.services.vrrp module.

[software/pymin.git] / pymin / services / ip / __init__.py

diff --git a/pymin/services/ip/__init__.py b/pymin/services/ip/__init__.py
index 4330eeb359b8cdb8a31d49295505c07a69d9d911..71354abdbba6983ce20618ec4bed4a17261c01db 100644 (file)
--- a/pymin/services/ip/__init__.py
+++ b/pymin/services/ip/__init__.py
@@ -2,300 +2,280 @@
 
 from subprocess import Popen, PIPE
 from os import path
 
 from subprocess import Popen, PIPE
 from os import path

+import logging ; log = logging.getLogger('pymin.services.ip')

 
 from pymin.seqtools import Sequence
 from pymin.dispatcher import handler, HandlerError, Handler
 from pymin.services.util import Restorable, ConfigWriter, InitdHandler, \
 
 from pymin.seqtools import Sequence
 from pymin.dispatcher import handler, HandlerError, Handler
 from pymin.services.util import Restorable, ConfigWriter, InitdHandler, \

-                                TransactionalHandler
+                                TransactionalHandler, SubHandler, call, \
+                                get_network_devices, ListComposedSubHandler, \
+                                DictComposedSubHandler, Device, Address, \
+                                ExecutionError

 
 

-__ALL__ = ('IpHandler', 'Error','DeviceError', 'DeviceNotFoundError',
-           'RouteError', 'RouteNotFoundError', 'RouteAlreadyExistsError',
-           'AddressError', 'AddressNotFoundError', 'AddressAlreadyExistsError')
+__ALL__ = ('IpHandler',)

 
 

-class Error(HandlerError):
-    r"""
-    Error(command) -> Error instance :: Base IpHandler exception class.
+# TODO: convertir HopHandler a ComposedSubHandler

 
 

-    All exceptions raised by the IpHandler inherits from this one, so you can
-    easily catch any IpHandler exception.
+class HopError(HandlerError):

 
 

-    message - A descriptive error message.
-    """
+    def __init__(self, hop):
+        self.message = u'Hop error : "%s"' % hop

 
 

-    def __init__(self, message):
-        r"Initialize the Error object. See class documentation for more info."
-        self.message = message
+class HopNotFoundError(HopError):

 
 

-    def __str__(self):
-        return self.message
+    def __init__(self, hop):
+        self.message = u'Hop not found : "%s"' % hop

 
 

-class DeviceError(Error):
+class HopAlreadyExistsError(HopError):

 
 

-    def __init__(self, device):
-        self.message = 'Device error : "%s"' % device
+    def __init__(self, hop):
+        self.message = u'Hop already exists : "%s"' % hop

 
 

-class DeviceNotFoundError(DeviceError):

 
 

-    def __init__(self, device):
-        self.message = 'Device not found : "%s"' % device
+class Hop(Sequence):

 
 

-class AddressError(Error):
-
-    def __init__(self, addr):
-        self.message = 'Address error : "%s"' % addr
-
-class AddressNotFoundError(AddressError):
-
-    def __init__(self, address):
-        self.message = 'Address not found : "%s"' % address
-
-class AddressAlreadyExistsError(AddressError):
-
-    def __init__(self, address):
-        self.message = 'Address already exists : "%s"' % address
-
-class RouteError(Error):
-
-    def __init__(self, route):
-        self.message = 'Route error : "%s"' % route
-
-class RouteNotFoundError(RouteError):
-
-    def __init__(self, route):
-        self.message = 'Route not found : "%s"' % route
-
-class RouteAlreadyExistsError(RouteError):
-
-    def __init__(self, route):
-        self.message = 'Route already exists : "%s"' % route
-
-
-class Route(Sequence):
-
-    def __init__(self, net_addr, prefix, gateway):
-        self.net_addr = net_addr
-        self.prefix = prefix
+    def __init__(self, gateway, device):

         self.gateway = gateway
         self.gateway = gateway

+        self.device = device

 
     def as_tuple(self):
 
     def as_tuple(self):

-        return(self.addr, self.prefix, self.gateway)
+        return (self.gateway, self.device)

 
     def __cmp__(self, other):
 
     def __cmp__(self, other):

-        if self.net_addr == other.net_addr \
-                and self.prefix == other.prefix \
-                and self.gateway == other.gateway:
+        if self.gateway == other.gateway \
+                and self.device == other.device:

             return 0
         return cmp(id(self), id(other))
 
             return 0
         return cmp(id(self), id(other))
 

-class RouteHandler(Handler):
+class HopHandler(Handler):

 
 

-    def __init__(self, devices):
-        self.devices = devices
+    def __init__(self, parent):
+        self.parent = parent

 
 

-    @handler(u'Adds a route to a device')
-    def add(self, device, net_addr, prefix, gateway):
-        if not device in self.devices:
+    @handler('Adds a hop : add <gateway> <device>')
+    def add(self, gw, dev):
+        if not dev in self.parent.devices:

             raise DeviceNotFoundError(device)
             raise DeviceNotFoundError(device)

-        r = Route(net_addr, prefix, gateway)
+        h = Hop(gw, dev)

         try:
         try:

-            self.devices[device].routes.index(r)
-            raise RouteAlreadyExistsError(net_addr + '/' + prefix + '->' + gateway)
+            self.parent.hops.index(h)
+            raise HopAlreadyExistsError(gw  + '->' + dev)

         except ValueError:
         except ValueError:

-            self.devices[device].routes.append(r)
+            self.parent.hops.append(h)

 
 

-    @handler(u'Deletes a route from a device')
-    def delete(self, device, net_addr, prefix, gateway):
-        if not device in self.devices:
+    @handler(u'Deletes a hop : delete <gateway> <device>')
+    def delete(self, gw, dev):
+        if not dev in self.parent.devices:

             raise DeviceNotFoundError(device)
             raise DeviceNotFoundError(device)

-        r = Route(net_addr, prefix, gateway)
+        h = Hop(gw, dev)

         try:
         try:

-            self.devices[device].routes.remove(r)
+            self.parent.hops.remove(h)

         except ValueError:
         except ValueError:

-            raise RouteNotFoundError(net_addr + '/' + prefix + '->' + gateway)
-
-    @handler(u'Flushes routes from a device')
-    def flush(self, device):
-        if not device in self.devices:
-            raise DeviceNotFoundError(device)
-        self.devices[device].routes = list()
-
+            raise HopNotFoundError(gw + '->' + dev)

 
 

-    @handler(u'List routes')
+    @handler(u'Lists hops : list <dev>')

     def list(self, device):
         try:
     def list(self, device):
         try:

-            k = self.devices[device].routes.keys()
+            k = self.parent.hops.keys()

         except ValueError:
             k = list()
         return k
 
         except ValueError:
             k = list()
         return k
 

-    @handler(u'Get information about all routes')
-    def show(self):
+    @handler(u'Get information about all hops: show <dev>')
+    def show(self, device):

         try:
         try:

-            k = self.devices[device].routes.values()
+            k = self.parent.hops.values()

         except ValueError:
             k = list()
         return k
 
         except ValueError:
             k = list()
         return k
 

-
-class Address(Sequence):
-
-    def __init__(self, ip, prefix, broadcast):
-        self.ip = ip
+class Route(Sequence):
+    def __init__(self, net_addr, prefix, gateway):
+        self.net_addr = net_addr

         self.prefix = prefix
         self.prefix = prefix

-        self.broadcast = broadcast
-
+        self.gateway = gateway
+    def update(self, net_addr=None, prefix=None, gateway=None):
+        if net_addr is not None: self.net_addr = net_addr
+        if prefix is not None: self.prefix = prefix
+        if gateway is not None: self.gateway = gateway

     def as_tuple(self):
     def as_tuple(self):

-        return (self.ip, self.prefix, self.broadcast)
-
-class AddressHandler(Handler):
-
-    def __init__(self, devices):
-        self.devices = devices
-
-    @handler(u'Adds an address to a device')
-    def add(self, device, ip, prefix, broadcast='+'):
-        if not device in self.devices:
-            raise DeviceNotFoundError(device)
-        if ip in self.devices[device].addrs:
-            raise AddressAlreadyExistsError(ip)
-        self.devices[device].addrs[ip] = Address(ip, prefix, broadcast)
-
-    @handler(u'Deletes an address from a device')
-    def delete(self, device, ip):
-        if not device in self.devices:
-            raise DeviceNotFoundError(device)
-        if not ip in self.devices[device].addrs:
-            raise AddressNotFoundError(ip)
-        del self.devices[device].addrs[ip]
-
-    @handler(u'Flushes addresses from a device')
-    def flush(self, device):
-        if not device in self.devices:
-            raise DeviceNotFoundError(device)
-        self.devices[device].addrs = dict()
-
-    @handler(u'List all addresses from a device')
-    def list(self, device):
-        try:
-            k = self.devices[device].addrs.keys()
-        except ValueError:
-            k = list()
-        return k
+        return(self.net_addr, self.prefix, self.gateway)

 
 

-    @handler(u'Get information about addresses from a device')
-    def show(self, device):
-        try:
-            k = self.devices[device].addrs.values()
-        except ValueError:
-            k = list()
-        return k
+class RouteHandler(ListComposedSubHandler):
+    handler_help = u"Manage IP routes"
+    _comp_subhandler_cont = 'devices'
+    _comp_subhandler_attr = 'routes'
+    _comp_subhandler_class = Route

 
 
 
 

-class Device(Sequence):
+class AddressHandler(DictComposedSubHandler):
+    handler_help = u"Manage IP addresses"
+    _comp_subhandler_cont = 'devices'
+    _comp_subhandler_attr = 'addrs'
+    _comp_subhandler_class = Address

 
 

-    def __init__(self, name, mac):
-        self.name = name
-        self.mac = mac
-        self.addrs = dict()
-        self.routes = list()

 
 

-    def as_tuple(self):
-        return (self.name, self.mac)
+class DeviceHandler(SubHandler):

 
 

-class DeviceHandler(Handler):
+    handler_help = u"Manage network devices"

 
 

-    def __init__(self, devices):
+    def __init__(self, parent):
+        log.debug(u'DeviceHandler(%r)', parent)

         # FIXME remove templates to execute commands
         from mako.template import Template
         # FIXME remove templates to execute commands
         from mako.template import Template

-        self.devices = devices
+        self.parent = parent

         template_dir = path.join(path.dirname(__file__), 'templates')
         dev_fn = path.join(template_dir, 'device')
         self.device_template = Template(filename=dev_fn)
 
     @handler(u'Bring the device up')
     def up(self, name):
         template_dir = path.join(path.dirname(__file__), 'templates')
         dev_fn = path.join(template_dir, 'device')
         self.device_template = Template(filename=dev_fn)
 
     @handler(u'Bring the device up')
     def up(self, name):

-        if name in self.devices:
-            print self.device_template.render(dev=name, action='up')
+        log.debug(u'DeviceHandler.up(%r)', name)
+        if name in self.parent.devices:
+            call(self.device_template.render(dev=name, action='up'), shell=True)

         else:
         else:

+            log.debug(u'DeviceHandler.up: device not found')

             raise DeviceNotFoundError(name)
 
     @handler(u'Bring the device down')
     def down(self, name):
             raise DeviceNotFoundError(name)
 
     @handler(u'Bring the device down')
     def down(self, name):

-        if name in self.devices:
-            print self.device_template.render(dev=name, action='down')
+        log.debug(u'DeviceHandler.down(%r)', name)
+        if name in self.parent.devices:
+            call(self.device_template.render(dev=name, action='down'), shell=True)

         else:
         else:

+            log.debug(u'DeviceHandler.up: device not found')

             raise DeviceNotFoundError(name)
 
     @handler(u'List all devices')
     def list(self):
             raise DeviceNotFoundError(name)
 
     @handler(u'List all devices')
     def list(self):

-        return self.devices.keys()
+        log.debug(u'DeviceHandler.list()')
+        return self.parent.devices.keys()

 
     @handler(u'Get information about a device')
     def show(self):
 
     @handler(u'Get information about a device')
     def show(self):

-        return self.devices.items()
-
-
-def get_devices():
-    p = Popen(('ip', 'link', 'list'), stdout=PIPE, close_fds=True)
-    string = p.stdout.read()
-    p.wait()
-    d = dict()
-    i = string.find('eth')
-    while i != -1:
-        eth = string[i:i+4]
-        m = string.find('link/ether', i+4)
-        mac = string[ m+11 : m+11+17]
-        d[eth] = Device(eth, mac)
-        i = string.find('eth', m+11+17)
-    return d
+        log.debug(u'DeviceHandler.show()')
+        return self.parent.devices.items()

 
 class IpHandler(Restorable, ConfigWriter, TransactionalHandler):
 
 
 class IpHandler(Restorable, ConfigWriter, TransactionalHandler):
 

-    _persistent_attrs = 'devices'
+    handler_help = u"Manage IP devices, addresses, routes and hops"
+
+    _persistent_attrs = ('devices','hops')

 
 

-    _restorable_defaults = dict(devices=get_devices())
+    _restorable_defaults = dict(
+                            devices=get_network_devices(),
+                            hops = list()
+                            )

 
     _config_writer_files = ('device', 'ip_add', 'ip_del', 'ip_flush',
 
     _config_writer_files = ('device', 'ip_add', 'ip_del', 'ip_flush',

-                            'route_add', 'route_del', 'route_flush')
+                            'route_add', 'route_del', 'route_flush', 'hop')

     _config_writer_tpl_dir = path.join(path.dirname(__file__), 'templates')
 
     def __init__(self, pickle_dir='.', config_dir='.'):
         r"Initialize DhcpHandler object, see class documentation for details."
     _config_writer_tpl_dir = path.join(path.dirname(__file__), 'templates')
 
     def __init__(self, pickle_dir='.', config_dir='.'):
         r"Initialize DhcpHandler object, see class documentation for details."

+        log.debug(u'IpHandler(%r, %r)', pickle_dir, config_dir)

         self._persistent_dir = pickle_dir
         self._config_writer_cfg_dir = config_dir
         self._config_build_templates()
         self._restore()
         self._persistent_dir = pickle_dir
         self._config_writer_cfg_dir = config_dir
         self._config_build_templates()
         self._restore()

-        self.addr = AddressHandler(self.devices)
-        self.route = RouteHandler(self.devices)
-        self.dev = DeviceHandler(self.devices)
+        self._write_config()
+        self.addr = AddressHandler(self)
+        self.route = RouteHandler(self)
+        self.dev = DeviceHandler(self)
+        self.hop = HopHandler(self)

 
     def _write_config(self):
         r"_write_config() -> None :: Execute all commands."
 
     def _write_config(self):
         r"_write_config() -> None :: Execute all commands."

+        log.debug(u'IpHandler._write_config()')

         for device in self.devices.values():
         for device in self.devices.values():

-            print self._render_config('route_flush', dict(dev=device.name))
-            print self._render_config('ip_flush', dict(dev=device.name))
+            log.debug(u'IpHandler._write_config: processing device %s', device)
+            try:
+                log.debug(u'IpHandler._write_config: flushing routes...')
+                call(self._render_config('route_flush', dict(dev=device.name)),
+                        shell=True)
+            except ExecutionError, e:
+                log.debug(u'IpHandler._write_config: error flushing -> %r', e)
+            try:
+                log.debug(u'IpHandler._write_config: flushing addrs...')
+                call(self._render_config('ip_flush', dict(dev=device.name)),
+                        shell=True)
+            except ExecutionError, e:
+                log.debug(u'IpHandler._write_config: error flushing -> %r', e)

             for address in device.addrs.values():
             for address in device.addrs.values():

-                print self._render_config('ip_add', dict(
-                        dev = device.name,
-                        addr = address.ip,
-                        prefix = address.prefix,
-                        broadcast = address.broadcast,
-                    )
-                )
+                broadcast = address.broadcast
+                if broadcast is None:
+                    broadcast = '+'
+                try:
+                    log.debug(u'IpHandler._write_config: adding %r', address)
+                    call(self._render_config('ip_add', dict(
+                            dev = device.name,
+                            addr = address.ip,
+                            netmask = address.netmask,
+                            peer = address.peer,
+                            broadcast = broadcast,
+                        )), shell=True)
+                except ExecutionError, e:
+                    log.debug(u'IpHandler._write_config: error adding -> %r', e)

             for route in device.routes:
             for route in device.routes:

-                print self._render_config('route_add', dict(
-                        dev = device.name,
-                        net_addr = route.net_addr,
-                        prefix = route.prefix,
-                        gateway = route.gateway,
-                    )
-                )
+                try:
+                    log.debug(u'IpHandler._write_config: adding %r', route)
+                    call(self._render_config('route_add', dict(
+                            dev = device.name,
+                            net_addr = route.net_addr,
+                            prefix = route.prefix,
+                            gateway = route.gateway,
+                        )), shell=True)
+                except ExecutionError, e:
+                    log.debug(u'IpHandler._write_config: error adding -> %r', e)
+        if self.hops:
+            log.debug(u'IpHandler._write_config: we have hops: %r', self.hops)
+            try:
+                log.debug(u'IpHandler._write_config: flushing default route')
+                call('ip route del default', shell=True)
+            except ExecutionError, e:
+                log.debug(u'IpHandler._write_config: error adding -> %r', e)
+            try:
+                log.debug(u'IpHandler._write_config: configuring hops')
+                call(self._render_config('hop', dict(
+                    hops = self.hops,
+                        )
+                ), shell=True)
+            except ExecutionError, e:
+                log.debug(u'IpHandler._write_config: error adding -> %r', e)
+
+    def handle_timer(self):
+        log.debug(u'IpHandler.handle_timer()')
+        self.refresh_devices()
+
+    def refresh_devices(self):
+        log.debug(u'IpHandler.update_devices()')
+        devices = get_network_devices()
+        #add not registered devices
+        for k,v in devices.items():
+            if k not in self.devices:
+                log.debug(u'IpHandler.update_devices: adding %r', v)
+                self.devices[k] = v
+        #delete dead devices
+        for k in self.devices.keys():
+            if k not in devices:
+                log.debug(u'IpHandler.update_devices: removing %s', k)
+                del self.devices[k]
+

 
 
 if __name__ == '__main__':
 
 
 
 if __name__ == '__main__':
 

+    logging.basicConfig(
+        level   = logging.DEBUG,
+        format  = '%(asctime)s %(levelname)-8s %(message)s',
+        datefmt = '%H:%M:%S',
+    )
+

     ip = IpHandler()
     print '----------------------'
     ip = IpHandler()
     print '----------------------'

+    ip.hop.add('201.21.32.53','eth0')
+    ip.hop.add('205.65.65.25','eth1')
+    ip.commit()

     ip.dev.up('eth0')
     ip.addr.add('eth0','192.168.0.23','24','192.168.255.255')
     ip.addr.add('eth0','192.168.0.26','24')
     ip.dev.up('eth0')
     ip.addr.add('eth0','192.168.0.23','24','192.168.255.255')
     ip.addr.add('eth0','192.168.0.26','24')


@@ -303,11 +283,9 @@ if __name__ == '__main__':
     ip.route.add('eth0','192.168.0.0','24','192.168.0.1')
     ip.route.add('eth0','192.168.0.5','24','192.168.0.1')
     ip.commit()
     ip.route.add('eth0','192.168.0.0','24','192.168.0.1')
     ip.route.add('eth0','192.168.0.5','24','192.168.0.1')
     ip.commit()

-    ip.route.flush('eth0')
-    ip.commit()
-    ip.addr.delete('eth0','192.168.0.23')
+    ip.hop.delete('201.21.32.53','eth0')
+    ip.route.clear('eth0')

     ip.commit()
 
 
 
     ip.commit()
 
 
 

-