3 # Copyright 2017 RIFT.IO Inc
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
9 # http://www.apache.org/licenses/LICENSE-2.0
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.
21 gi
.require_version('RwDts', '1.0')
24 from gi
.repository
import (
29 from . import accounts
32 class SDNAccountNotFound(Exception):
36 class SDNAccountError(Exception):
40 def get_add_delete_update_cfgs(dts_member_reg
, xact
, key_name
):
41 # Unforunately, it is currently difficult to figure out what has exactly
42 # changed in this xact without Pbdelta support (RIFT-4916)
43 # As a workaround, we can fetch the pre and post xact elements and
44 # perform a comparison to figure out adds/deletes/updates
45 xact_cfgs
= list(dts_member_reg
.get_xact_elements(xact
))
46 curr_cfgs
= list(dts_member_reg
.elements
)
48 xact_key_map
= {getattr(cfg
, key_name
): cfg
for cfg
in xact_cfgs
}
49 curr_key_map
= {getattr(cfg
, key_name
): cfg
for cfg
in curr_cfgs
}
52 added_keys
= set(xact_key_map
) - set(curr_key_map
)
53 added_cfgs
= [xact_key_map
[key
] for key
in added_keys
]
56 deleted_keys
= set(curr_key_map
) - set(xact_key_map
)
57 deleted_cfgs
= [curr_key_map
[key
] for key
in deleted_keys
]
60 updated_keys
= set(curr_key_map
) & set(xact_key_map
)
61 updated_cfgs
= [xact_key_map
[key
] for key
in updated_keys
if xact_key_map
[key
] != curr_key_map
[key
]]
63 return added_cfgs
, deleted_cfgs
, updated_cfgs
66 class SDNAccountConfigCallbacks(object):
68 on_add_apply
=None, on_add_prepare
=None,
69 on_delete_apply
=None, on_delete_prepare
=None):
72 def prepare_noop(*args
, **kwargs
):
75 def apply_noop(*args
, **kwargs
):
78 self
.on_add_apply
= on_add_apply
79 self
.on_add_prepare
= on_add_prepare
80 self
.on_delete_apply
= on_delete_apply
81 self
.on_delete_prepare
= on_delete_prepare
83 for f
in ('on_add_apply', 'on_delete_apply'):
84 ref
= getattr(self
, f
)
86 setattr(self
, f
, apply_noop
)
89 if asyncio
.iscoroutinefunction(ref
):
90 raise ValueError('%s cannot be a coroutine' % (f
,))
92 for f
in ('on_add_prepare', 'on_delete_prepare'):
93 ref
= getattr(self
, f
)
95 setattr(self
, f
, prepare_noop
)
98 if not asyncio
.iscoroutinefunction(ref
):
99 raise ValueError("%s must be a coroutine" % f
)
102 class SDNAccountConfigSubscriber(object):
103 XPATH
= "C,/rw-sdn:sdn/rw-sdn:account"
105 def __init__(self
, dts
, log
, rwlog_hdl
, sdn_callbacks
, acctstore
):
108 self
._rwlog
_hdl
= rwlog_hdl
111 self
.accounts
= acctstore
113 self
._sdn
_callbacks
= sdn_callbacks
115 def add_account(self
, account_msg
):
116 self
._log
.info("adding sdn account: {}".format(account_msg
))
118 account
= accounts
.SDNAccount(self
._log
, self
._rwlog
_hdl
, account_msg
)
119 self
.accounts
[account
.name
] = account
121 self
._sdn
_callbacks
.on_add_apply(account
)
123 def delete_account(self
, account_name
):
124 self
._log
.info("deleting sdn account: {}".format(account_name
))
125 del self
.accounts
[account_name
]
127 self
._sdn
_callbacks
.on_delete_apply(account_name
)
129 def update_account(self
, account_msg
):
130 """ Update an existing sdn account
132 In order to simplify update, turn an update into a delete followed by
133 an add. The drawback to this approach is that we will not support
134 updates of an "in-use" sdn account, but this seems like a
135 reasonable trade-off.
139 account_msg - The sdn account config message
141 self
._log
.info("updating sdn account: {}".format(account_msg
))
143 self
.delete_account(account_msg
.name
)
144 self
.add_account(account_msg
)
148 def apply_config(dts
, acg
, xact
, action
, _
):
149 self
._log
.debug("Got sdn account apply config (xact: %s) (action: %s)", xact
, action
)
151 if xact
.xact
is None:
152 if action
== rwdts
.AppconfAction
.INSTALL
:
153 curr_cfg
= self
._reg
.elements
155 self
._log
.debug("SDN account being re-added after restart.")
156 if not cfg
.has_field('account_type'):
157 raise SDNAccountError("New SDN account must contain account_type field.")
158 self
.add_account(cfg
)
160 # When RIFT first comes up, an INSTALL is called with the current config
161 # Since confd doesn't actally persist data this never has any data so
163 self
._log
.debug("No xact handle. Skipping apply config")
167 add_cfgs
, delete_cfgs
, update_cfgs
= get_add_delete_update_cfgs(
168 dts_member_reg
=self
._reg
,
174 for cfg
in delete_cfgs
:
175 self
.delete_account(cfg
.name
)
179 self
.add_account(cfg
)
182 for cfg
in update_cfgs
:
183 self
.update_account(cfg
)
186 def on_prepare(dts
, acg
, xact
, xact_info
, ks_path
, msg
, scratch
):
187 """ Prepare callback from DTS for SDN Account """
189 action
= xact_info
.query_action
190 self
._log
.debug("SDN account on_prepare config received (action: %s): %s",
191 xact_info
.query_action
, msg
)
193 if action
in [rwdts
.QueryAction
.CREATE
, rwdts
.QueryAction
.UPDATE
]:
194 if msg
.name
in self
.accounts
:
195 self
._log
.debug("SDN account already exists. Invoking update request")
197 # Since updates are handled by a delete followed by an add, invoke the
198 # delete prepare callbacks to give clients an opportunity to reject.
199 yield from self
._sdn
_callbacks
.on_delete_prepare(msg
.name
)
202 self
._log
.debug("SDN account does not already exist. Invoking on_prepare add request")
203 if not msg
.has_field('account_type'):
204 raise SDNAccountError("New sdn account must contain account_type field.")
206 account
= accounts
.SDNAccount(self
._log
, self
._rwlog
_hdl
, msg
)
207 yield from self
._sdn
_callbacks
.on_add_prepare(account
)
209 elif action
== rwdts
.QueryAction
.DELETE
:
210 # Check if the entire SDN account got deleted
211 fref
= ProtobufC
.FieldReference
.alloc()
212 fref
.goto_whole_message(msg
.to_pbcm())
213 if fref
.is_field_deleted():
214 yield from self
._sdn
_callbacks
.on_delete_prepare(msg
.name
)
217 self
._log
.error("Deleting individual fields for SDN account not supported")
218 xact_info
.respond_xpath(rwdts
.XactRspCode
.NACK
)
222 self
._log
.error("Action (%s) NOT SUPPORTED", action
)
223 xact_info
.respond_xpath(rwdts
.XactRspCode
.NACK
)
225 xact_info
.respond_xpath(rwdts
.XactRspCode
.ACK
)
227 self
._log
.debug("Registering for SDN Account config using xpath: %s",
228 SDNAccountConfigSubscriber
.XPATH
,
231 acg_handler
= rift
.tasklets
.AppConfGroup
.Handler(
232 on_apply
=apply_config
,
235 with self
._dts
.appconf_group_create(acg_handler
) as acg
:
236 self
._reg
= acg
.register(
237 xpath
=SDNAccountConfigSubscriber
.XPATH
,
238 flags
=rwdts
.Flag
.SUBSCRIBER | rwdts
.Flag
.DELTA_READY | rwdts
.Flag
.CACHE
,
239 on_prepare
=on_prepare
,