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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
|
# ============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
from mod.network_function import NetworkFunction
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'
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')
def prepare_subscription_event(self, xnf_name, app_conf):
"""Prepare the sub event for publishing
Args:
xnf_name: the AAI xnf name.
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': xnf_name, '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 {xnf_name}: {e}', exc_info=True)
raise
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=self.administrativeState)
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)
def add_network_function_to_subscription(self, nf):
""" Associates a network function to a Subscription
Args:
nf : A NetworkFunction object.
"""
current_sub = self.create()
try:
current_nf = nf.create()
logger.debug(f'Adding network function {nf.nf_name} to Subscription '
f'{current_sub.subscription_name}')
existing_entry = NfSubRelationalModel.query.filter(
NfSubRelationalModel.subscription_name == current_sub.subscription_name,
NfSubRelationalModel.nf_name == current_nf.nf_name).one_or_none()
if existing_entry is None:
new_nf_sub = NfSubRelationalModel(current_sub.subscription_name,
nf.nf_name, SubNfState.PENDING_CREATE.value)
new_nf_sub.nf = current_nf
current_sub.nfs.append(new_nf_sub)
logger.debug(f'Network function {current_nf.nf_name} added to Subscription '
f'{current_sub.subscription_name}')
db.session.add(current_sub)
db.session.commit()
except Exception as e:
logger.error(f'Failed to add nf {nf.nf_name} to subscription '
f'{current_sub.subscription_name}: {e}', exc_info=True)
logger.debug(f'Subscription {current_sub.subscription_name} now contains these XNFs:'
f'{Subscription.get_nf_names_per_sub(current_sub.subscription_name)}')
@staticmethod
def get(subscription_name):
""" Retrieves a subscription
Args:
subscription_name (str): The subscription name
Returns:
Subscription object else None
"""
return SubscriptionModel.query.filter(
SubscriptionModel.subscription_name == subscription_name).one_or_none()
@staticmethod
def get_all():
""" Retrieves a list of subscriptions
Returns:
list: Subscription list else empty
"""
return SubscriptionModel.query.all()
@staticmethod
def get_nf_names_per_sub(subscription_name):
""" Retrieves a list of network function names related to the subscription
Args:
subscription_name (str): The subscription name
Returns:
list: List of network function names
"""
nf_sub_rel = NfSubRelationalModel.query.filter(
NfSubRelationalModel.subscription_name == subscription_name).all()
list_of_nfs = []
for nf in nf_sub_rel:
list_of_nfs.append(nf.nf_name)
return list_of_nfs
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)
def delete_subscription(self):
""" Deletes a subscription and all its association from the database. A network function
that is only associated with the subscription being removed will also be deleted."""
try:
subscription = SubscriptionModel.query.filter(
SubscriptionModel.subscription_name == self.subscriptionName).one_or_none()
if subscription:
for nf_relationship in subscription.nfs:
other_nf_relationship = NfSubRelationalModel.query.filter(
NfSubRelationalModel.subscription_name != self.subscriptionName,
NfSubRelationalModel.nf_name == nf_relationship.nf_name).one_or_none()
if not other_nf_relationship:
db.session.delete(nf_relationship.nf)
db.session.delete(subscription)
db.session.commit()
except Exception as e:
logger.error(f'Failed to delete subscription: {self.subscriptionName} '
f'and it\'s relations from the DB: {e}', exc_info=True)
def process_subscription(self, nfs, mr_pub, app_conf):
action = 'Deactivate'
sub_nf_state = SubNfState.PENDING_DELETE.value
self.update_subscription_status()
if self.administrativeState == AdministrativeState.UNLOCKED.value:
action = 'Activate'
sub_nf_state = SubNfState.PENDING_CREATE.value
logger.info(f'{action} subscription initiated for {self.subscriptionName}.')
try:
for nf in nfs:
mr_pub.publish_subscription_event_data(self, nf.nf_name, app_conf)
logger.debug(f'Publishing Event to {action} '
f'Sub: {self.subscriptionName} for the nf: {nf.nf_name}')
if action == 'Activate':
self.add_network_function_to_subscription(nf)
self.update_sub_nf_status(self.subscriptionName, sub_nf_state, nf.nf_name)
except Exception as err:
raise Exception(f'Error publishing activation event to MR: {err}')
@staticmethod
def get_all_nfs_subscription_relations():
""" Retrieves all network function to subscription relations
Returns:
list: NetworkFunctions per Subscription list else empty
"""
nf_per_subscriptions = NfSubRelationalModel.query.all()
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_nf_models(self):
nf_sub_relationships = NfSubRelationalModel.query.filter(
NfSubRelationalModel.subscription_name == self.subscriptionName)
nf_models = []
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()
nf_models.append(nf_model_object)
return nf_models
def get_network_functions(self):
nfs = []
nf_models = self._get_nf_models()
for nf_model in nf_models:
nf = NetworkFunction(
nf_name=nf_model.nf_name,
orchestration_status=nf_model.orchestration_status
)
nfs.append(nf)
return nfs
|
