1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
|
# ============LICENSE_START===================================================
# Copyright (C) 2019-2020 Nordix Foundation.
# ============================================================================
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0
# ============LICENSE_END=====================================================
from enum import Enum
from mod import db, logger
from mod.api.db_models import SubscriptionModel, NfSubRelationalModel, NetworkFunctionModel
class SubNfState(Enum):
PENDING_CREATE = 'PENDING_CREATE'
CREATE_FAILED = 'CREATE_FAILED'
CREATED = 'CREATED'
PENDING_DELETE = 'PENDING_DELETE'
DELETE_FAILED = 'DELETE_FAILED'
class AdministrativeState(Enum):
UNLOCKED = 'UNLOCKED'
LOCKED = 'LOCKED'
PENDING = 'PENDING'
subscription_nf_states = {
AdministrativeState.LOCKED.value: {
'success': SubNfState.CREATED,
'failed': SubNfState.DELETE_FAILED
},
AdministrativeState.UNLOCKED.value: {
'success': SubNfState.CREATED,
'failed': SubNfState.CREATE_FAILED
}
}
class Subscription:
def __init__(self, **kwargs):
self.subscriptionName = kwargs.get('subscriptionName')
self.administrativeState = kwargs.get('administrativeState')
self.fileBasedGP = kwargs.get('fileBasedGP')
self.fileLocation = kwargs.get('fileLocation')
self.nfFilter = kwargs.get('nfFilter')
self.measurementGroups = kwargs.get('measurementGroups')
self.create()
def create(self):
""" Creates a subscription database entry
Returns:
Subscription object
"""
try:
existing_subscription = (SubscriptionModel.query.filter(
SubscriptionModel.subscription_name == self.subscriptionName).one_or_none())
if existing_subscription is None:
new_subscription = SubscriptionModel(subscription_name=self.subscriptionName,
status=AdministrativeState.PENDING.value)
db.session.add(new_subscription)
db.session.commit()
return new_subscription
else:
logger.debug(f'Subscription {self.subscriptionName} already exists,'
f' returning this subscription..')
return existing_subscription
except Exception as e:
logger.error(f'Failed to create subscription {self.subscriptionName} in the DB: {e}',
exc_info=True)
finally:
db.session.remove()
def update_subscription_status(self):
""" Updates the status of subscription in subscription table """
try:
SubscriptionModel.query.filter(
SubscriptionModel.subscription_name == self.subscriptionName)\
.update({SubscriptionModel.status: self.administrativeState},
synchronize_session='evaluate')
db.session.commit()
except Exception as e:
logger.error(f'Failed to update status of subscription: {self.subscriptionName}: {e}',
exc_info=True)
finally:
db.session.remove()
def prepare_subscription_event(self, nf, app_conf):
"""Prepare the sub event for publishing
Args:
nf (NetworkFunction): the AAI nf.
app_conf (AppConfig): the application configuration.
Returns:
dict: the Subscription event to be published.
"""
try:
clean_sub = {k: v for k, v in self.__dict__.items() if k != 'nfFilter'}
sub_event = {'nfName': nf.nf_name,
'ipv4Address': nf.ip_address,
'blueprintName': nf.sdnc_model_name,
'blueprintVersion': nf.sdnc_model_version,
'policyName': app_conf.operational_policy_name,
'changeType': 'DELETE'
if self.administrativeState == AdministrativeState.LOCKED.value
else 'CREATE', 'closedLoopControlName': app_conf.control_loop_name,
'subscription': clean_sub}
return sub_event
except Exception as e:
logger.error(f'Failed to prep Sub event for xNF {nf.nf_name}: {e}', exc_info=True)
raise
def add_network_function_to_subscription(self, nf, sub_model):
""" Associates a network function to a Subscription
Args:
sub_model(SubscriptionModel): The SubscriptionModel from the DB.
nf(NetworkFunction): A NetworkFunction object.
"""
try:
current_nf = nf.create()
existing_entry = NfSubRelationalModel.query.filter(
NfSubRelationalModel.subscription_name == self.subscriptionName,
NfSubRelationalModel.nf_name == current_nf.nf_name).one_or_none()
if existing_entry is None:
new_nf_sub = NfSubRelationalModel(self.subscriptionName,
nf.nf_name, SubNfState.PENDING_CREATE.value)
sub_model.nfs.append(new_nf_sub)
db.session.add(sub_model)
db.session.commit()
logger.info(f'Network function {current_nf.nf_name} added to Subscription '
f'{self.subscriptionName}')
except Exception as e:
logger.error(f'Failed to add nf {nf.nf_name} to subscription '
f'{self.subscriptionName}: {e}', exc_info=True)
logger.debug(f'Subscription {self.subscriptionName} now contains these XNFs:'
f'{[nf.nf_name for nf.nf_name in self.get_network_functions()]}')
def get(self):
""" Retrieves a SubscriptionModel object
Returns:
SubscriptionModel object else None
"""
sub_model = SubscriptionModel.query.filter(
SubscriptionModel.subscription_name == self.subscriptionName).one_or_none()
return sub_model
def get_local_sub_admin_state(self):
""" Retrieves the subscription admin state
Returns:
str: The admin state of the SubscriptionModel
"""
sub_model = SubscriptionModel.query.filter(
SubscriptionModel.subscription_name == self.subscriptionName).one_or_none()
db.session.remove()
return sub_model.status
@staticmethod
def get_all():
""" Retrieves a list of subscriptions
Returns:
list(SubscriptionModel): Subscriptions list else empty
"""
sub_models = SubscriptionModel.query.all()
db.session.remove()
return sub_models
def activate_subscription(self, nfs, mr_pub, app_conf):
logger.info(f'Activate subscription initiated for {self.subscriptionName}.')
try:
existing_nfs = self.get_network_functions()
sub_model = self.get()
for nf in [new_nf for new_nf in nfs if new_nf not in existing_nfs]:
logger.info(f'Publishing event to activate '
f'Sub: {self.subscriptionName} for the nf: {nf.nf_name}')
mr_pub.publish_subscription_event_data(self, nf, app_conf)
self.add_network_function_to_subscription(nf, sub_model)
self.update_sub_nf_status(self.subscriptionName, SubNfState.PENDING_CREATE.value,
nf.nf_name)
except Exception as err:
raise Exception(f'Error publishing activation event to MR: {err}')
def deactivate_subscription(self, mr_pub, app_conf):
try:
nfs = self.get_network_functions()
if nfs:
logger.info(f'Deactivate subscription initiated for {self.subscriptionName}.')
for nf in nfs:
mr_pub.publish_subscription_event_data(self, nf, app_conf)
logger.debug(f'Publishing Event to deactivate '
f'Sub: {self.subscriptionName} for the nf: {nf.nf_name}')
self.update_sub_nf_status(self.subscriptionName,
SubNfState.PENDING_DELETE.value,
nf.nf_name)
except Exception as err:
raise Exception(f'Error publishing deactivation event to MR: {err}')
@staticmethod
def get_all_nfs_subscription_relations():
""" Retrieves all network function to subscription relations
Returns:
list(NfSubRelationalModel): NetworkFunctions per Subscription list else empty
"""
nf_per_subscriptions = NfSubRelationalModel.query.all()
db.session.remove()
return nf_per_subscriptions
@staticmethod
def update_sub_nf_status(subscription_name, status, nf_name):
""" Updates the status of the subscription for a particular nf
Args:
subscription_name (str): The subscription name
nf_name (str): The network function name
status (str): Status of the subscription
"""
try:
NfSubRelationalModel.query.filter(
NfSubRelationalModel.subscription_name == subscription_name,
NfSubRelationalModel.nf_name == nf_name). \
update({NfSubRelationalModel.nf_sub_status: status}, synchronize_session='evaluate')
db.session.commit()
except Exception as e:
logger.error(f'Failed to update status of nf: {nf_name} for subscription: '
f'{subscription_name}: {e}', exc_info=True)
def get_network_functions(self):
nf_sub_relationships = NfSubRelationalModel.query.filter(
NfSubRelationalModel.subscription_name == self.subscriptionName)
nfs = []
for nf_sub_entry in nf_sub_relationships:
nf_model_object = NetworkFunctionModel.query.filter(
NetworkFunctionModel.nf_name == nf_sub_entry.nf_name).one_or_none()
nfs.append(nf_model_object.to_nf())
db.session.remove()
return nfs
|
