common/python/rift/mano/sdn/config.py

   1
   2 #
   3 #   Copyright 2017 RIFT.IO Inc
   4 #
   5 #   Licensed under the Apache License, Version 2.0 (the "License");
   6 #   you may not use this file except in compliance with the License.
   7 #   You may obtain a copy of the License at
   8 #
   9 #       http://www.apache.org/licenses/LICENSE-2.0
  10 #
  11 #   Unless required by applicable law or agreed to in writing, software
  12 #   distributed under the License is distributed on an "AS IS" BASIS,
  13 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 #   See the License for the specific language governing permissions and
  15 #   limitations under the License.
  16 #
  17
  18 import asyncio
  19
  20 import gi
  21 gi.require_version('RwDts', '1.0')
  22 import rift.tasklets
  23
  24 from gi.repository import (
  25     RwDts as rwdts,
  26     ProtobufC,
  27     )
  28
  29 from rift.mano.utils.project import get_add_delete_update_cfgs
  30
  31 from . import accounts
  32
  33
  34 class SDNAccountNotFound(Exception):
  35     pass
  36
  37
  38 class SDNAccountError(Exception):
  39     pass
  40
  41
  42 class SDNAccountConfigCallbacks(object):
  43     def __init__(self,
  44                  on_add_apply=None, on_add_prepare=None,
  45                  on_delete_apply=None, on_delete_prepare=None):
  46
  47         @asyncio.coroutine
  48         def prepare_noop(*args, **kwargs):
  49             pass
  50
  51         def apply_noop(*args, **kwargs):
  52             pass
  53
  54         self.on_add_apply = on_add_apply
  55         self.on_add_prepare = on_add_prepare
  56         self.on_delete_apply = on_delete_apply
  57         self.on_delete_prepare = on_delete_prepare
  58
  59         for f in ('on_add_apply', 'on_delete_apply'):
  60             ref = getattr(self, f)
  61             if ref is None:
  62                 setattr(self, f, apply_noop)
  63                 continue
  64
  65             if asyncio.iscoroutinefunction(ref):
  66                 raise ValueError('%s cannot be a coroutine' % (f,))
  67
  68         for f in ('on_add_prepare', 'on_delete_prepare'):
  69             ref = getattr(self, f)
  70             if ref is None:
  71                 setattr(self, f, prepare_noop)
  72                 continue
  73
  74             if not asyncio.iscoroutinefunction(ref):
  75                 raise ValueError("%s must be a coroutine" % f)
  76
  77
  78 class SDNAccountConfigSubscriber(object):
  79     XPATH = "C,/rw-sdn:sdn/rw-sdn:account"
  80
  81     def __init__(self, dts, log, rwlog_hdl, sdn_callbacks, acctstore):
  82         self._dts = dts
  83         self._log = log
  84         self._rwlog_hdl = rwlog_hdl
  85         self._reg = None
  86
  87         self.accounts = acctstore
  88
  89         self._sdn_callbacks = sdn_callbacks
  90
  91     def add_account(self, account_msg):
  92         self._log.info("adding sdn account: {}".format(account_msg))
  93
  94         account = accounts.SDNAccount(self._log, self._rwlog_hdl, account_msg)
  95         self.accounts[account.name] = account
  96
  97         self._sdn_callbacks.on_add_apply(account)
  98
  99     def delete_account(self, account_name):
 100         self._log.info("deleting sdn account: {}".format(account_name))
 101         del self.accounts[account_name]
 102
 103         self._sdn_callbacks.on_delete_apply(account_name)
 104
 105     def update_account(self, account_msg):
 106         """ Update an existing sdn account
 107
 108         In order to simplify update, turn an update into a delete followed by
 109         an add.  The drawback to this approach is that we will not support
 110         updates of an "in-use" sdn account, but this seems like a
 111         reasonable trade-off.
 112
 113
 114         Arguments:
 115             account_msg - The sdn account config message
 116         """
 117         self._log.info("updating sdn account: {}".format(account_msg))
 118
 119         self.delete_account(account_msg.name)
 120         self.add_account(account_msg)
 121
 122     def deregister(self):
 123         if self._reg:
 124             self._reg.deregister()
 125             self._reg = None
 126
 127     def register(self):
 128         @asyncio.coroutine
 129         def apply_config(dts, acg, xact, action, _):
 130             self._log.debug("Got sdn account apply config (xact: %s) (action: %s)", xact, action)
 131
 132             if xact.xact is None:
 133                 if action == rwdts.AppconfAction.INSTALL:
 134                     curr_cfg = self._reg.elements
 135                     for cfg in curr_cfg:
 136                         self._log.debug("SDN account being re-added after restart.")
 137                         if not cfg.has_field('account_type'):
 138                             raise SDNAccountError("New SDN account must contain account_type field.")
 139                         self.add_account(cfg)
 140                 else:
 141                     # When RIFT first comes up, an INSTALL is called with the current config
 142                     # Since confd doesn't actally persist data this never has any data so
 143                     # skip this for now.
 144                     self._log.debug("No xact handle.  Skipping apply config")
 145
 146                 return
 147
 148             add_cfgs, delete_cfgs, update_cfgs = get_add_delete_update_cfgs(
 149                     dts_member_reg=self._reg,
 150                     xact=xact,
 151                     key_name="name",
 152                     )
 153
 154             # Handle Deletes
 155             for cfg in delete_cfgs:
 156                 self.delete_account(cfg.name)
 157
 158             # Handle Adds
 159             for cfg in add_cfgs:
 160                 self.add_account(cfg)
 161
 162             # Handle Updates
 163             for cfg in update_cfgs:
 164                 self.update_account(cfg)
 165
 166         @asyncio.coroutine
 167         def on_prepare(dts, acg, xact, xact_info, ks_path, msg, scratch):
 168             """ Prepare callback from DTS for SDN Account """
 169
 170             action = xact_info.query_action
 171             self._log.debug("SDN account on_prepare config received (action: %s): %s",
 172                             xact_info.query_action, msg)
 173
 174             if action in [rwdts.QueryAction.CREATE, rwdts.QueryAction.UPDATE]:
 175                 if msg.name in self.accounts:
 176                     self._log.debug("SDN account already exists. Invoking update request")
 177
 178                     # Since updates are handled by a delete followed by an add, invoke the
 179                     # delete prepare callbacks to give clients an opportunity to reject.
 180                     yield from self._sdn_callbacks.on_delete_prepare(msg.name)
 181
 182                 else:
 183                     self._log.debug("SDN account does not already exist. Invoking on_prepare add request")
 184                     if not msg.has_field('account_type'):
 185                         raise SDNAccountError("New sdn account must contain account_type field.")
 186
 187                     account = accounts.SDNAccount(self._log, self._rwlog_hdl, msg)
 188                     yield from self._sdn_callbacks.on_add_prepare(account)
 189
 190             elif action == rwdts.QueryAction.DELETE:
 191                 # Check if the entire SDN account got deleted
 192                 fref = ProtobufC.FieldReference.alloc()
 193                 fref.goto_whole_message(msg.to_pbcm())
 194                 if fref.is_field_deleted():
 195                     yield from self._sdn_callbacks.on_delete_prepare(msg.name)
 196
 197                 else:
 198                     self._log.error("Deleting individual fields for SDN account not supported")
 199                     xact_info.respond_xpath(rwdts.XactRspCode.NACK)
 200                     return
 201
 202             else:
 203                 self._log.error("Action (%s) NOT SUPPORTED", action)
 204                 xact_info.respond_xpath(rwdts.XactRspCode.NACK)
 205
 206             xact_info.respond_xpath(rwdts.XactRspCode.ACK)
 207
 208         self._log.debug("Registering for SDN Account config using xpath: %s",
 209                         SDNAccountConfigSubscriber.XPATH,
 210                         )
 211
 212         acg_handler = rift.tasklets.AppConfGroup.Handler(
 213                         on_apply=apply_config,
 214                         )
 215
 216         with self._dts.appconf_group_create(acg_handler) as acg:
 217             self._reg = acg.register(
 218                     xpath=SDNAccountConfigSubscriber.XPATH,
 219                     flags=rwdts.Flag.SUBSCRIBER | rwdts.Flag.DELTA_READY | rwdts.Flag.CACHE,
 220                     on_prepare=on_prepare,
 221                     )