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
|
# ============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 tenacity import retry, retry_if_exception_type, wait_exponential, stop_after_attempt
import mod.pmsh_logging as logger
from mod import db
from mod.db_models import SubscriptionModel, NfSubRelationalModel
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.
"""
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
def create(self):
""" Creates a subscription database entry
Returns:
Subscription object
"""
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
def add_network_functions_to_subscription(self, nf_list):
""" Associates network functions to a Subscription
Args:
nf_list : A list of NetworkFunction objects.
"""
current_sub = self.create()
logger.debug(f'Adding network functions to subscription {current_sub.subscription_name}')
for nf in nf_list:
current_nf = nf.create()
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
logger.debug(current_nf)
current_sub.nfs.append(new_nf_sub)
db.session.add(current_sub)
db.session.commit()
@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()
def update_subscription_status(self):
""" Updates the status of subscription in subscription table """
SubscriptionModel.query.filter(
SubscriptionModel.subscription_name == self.subscriptionName). \
update({SubscriptionModel.status: self.administrativeState},
synchronize_session='evaluate')
db.session.commit()
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."""
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()
@retry(wait=wait_exponential(multiplier=1, min=30, max=120), stop=stop_after_attempt(3),
retry=retry_if_exception_type(Exception))
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
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}')
self.add_network_functions_to_subscription(nfs)
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
"""
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()
|
