1 # Copyright (C) 2019 Verizon. All Rights Reserved
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
22 from collections import Counter
23 from rest_framework import status
25 from catalog.packages import const
26 from catalog.pub.database.models import VnfPkgSubscriptionModel
27 from catalog.pub.exceptions import VnfPkgSubscriptionException,\
28 VnfPkgDuplicateSubscriptionException, SubscriptionDoesNotExistsException
29 from catalog.pub.utils.values import ignore_case_get
32 logger = logging.getLogger(__name__)
35 "notificationTypes": "notification_types",
37 "vnfPkgId": "vnf_pkg_id",
38 "operationalState": "operation_states",
39 "usageState": "usage_states"
43 def is_filter_type_equal(new_filter, existing_filter):
44 return Counter(new_filter) == Counter(existing_filter)
47 class CreateSubscription(object):
49 def __init__(self, data):
51 self.filter = ignore_case_get(self.data, "filters", {})
52 self.callback_uri = ignore_case_get(self.data, "callbackUri")
53 self.authentication = ignore_case_get(self.data, "authentication", {})
54 self.notification_types = ignore_case_get(self.filter, "notificationTypes", [])
55 self.operation_states = ignore_case_get(self.filter, "operationalState", [])
56 self.usage_states = ignore_case_get(self.filter, "usageState", [])
57 self.vnfd_id = ignore_case_get(self.filter, "vnfdId", [])
58 self.vnf_pkg_id = ignore_case_get(self.filter, "vnfPkgId", [])
59 self.vnf_products_from_provider = \
60 ignore_case_get(self.filter, "vnfProductsFromProviders", {})
62 def check_callbackuri_connection(self):
63 logger.debug("SubscribeNotification-post::> Sending GET request "
64 "to %s" % self.callback_uri)
66 response = requests.get(self.callback_uri, timeout=2)
67 if response.status_code != status.HTTP_204_NO_CONTENT:
68 raise VnfPkgSubscriptionException(
69 "callbackUri %s returns %s status code." % (
75 raise VnfPkgSubscriptionException(
76 "callbackUri %s didn't return 204 status code." % self.callback_uri
80 self.subscription_id = str(uuid.uuid4())
81 self.check_callbackuri_connection()
82 self.check_valid_auth_info()
85 subscription = VnfPkgSubscriptionModel.objects.get(
86 subscription_id=self.subscription_id
89 return subscription.toDict()
91 def check_valid_auth_info(self):
92 logger.debug("SubscribeNotification--post::> Validating Auth "
93 "details if provided")
94 if self.authentication.get("paramsBasic", {}) and \
95 const.BASIC not in self.authentication.get("authType"):
96 raise VnfPkgSubscriptionException('Auth type should be ' + const.BASIC)
97 if self.authentication.get("paramsOauth2ClientCredentials", {}) and \
98 const.OAUTH2_CLIENT_CREDENTIALS not in self.authentication.get("authType"):
99 raise VnfPkgSubscriptionException('Auth type should be ' + const.OAUTH2_CLIENT_CREDENTIALS)
101 def check_filter_exists(self, sub):
102 # Check the usage states, operationStates
103 for filter_type in ["operation_states", "usage_states"]:
104 if not is_filter_type_equal(getattr(self, filter_type),
105 ast.literal_eval(getattr(sub, filter_type))):
107 # If all the above types are same then check id filters
108 for id_filter in ["vnfd_id", "vnf_pkg_id"]:
109 if not is_filter_type_equal(getattr(self, id_filter),
110 ast.literal_eval(getattr(sub, id_filter))):
114 def check_valid(self):
115 logger.debug("SubscribeNotification--post::> Checking DB if "
116 "callbackUri already exists")
117 subscriptions = VnfPkgSubscriptionModel.objects.filter(callback_uri=self.callback_uri)
118 if not subscriptions.exists():
120 for subscription in subscriptions:
121 if self.check_filter_exists(subscription):
122 raise VnfPkgDuplicateSubscriptionException(
123 "Already Subscription (%s) exists with the "
124 "same callbackUri and filter" % subscription.subscription_id)
128 logger.debug("SubscribeNotification--post::> Saving the subscription "
129 "%s to the database" % self.subscription_id)
132 "href": os.path.join(const.VNFPKG_SUBSCRIPTION_ROOT_URI, self.subscription_id)
135 VnfPkgSubscriptionModel.objects.create(
136 subscription_id=self.subscription_id,
137 callback_uri=self.callback_uri,
138 notification_types=json.dumps(self.notification_types),
139 auth_info=json.dumps(self.authentication),
140 usage_states=json.dumps(self.usage_states),
141 operation_states=json.dumps(self.operation_states),
142 vnf_products_from_provider=json.dumps(self.vnf_products_from_provider),
143 vnfd_id=json.dumps(self.vnfd_id),
144 vnf_pkg_id=json.dumps(self.vnf_pkg_id),
145 links=json.dumps(links))
146 logger.debug('Create Subscription[%s] success', self.subscription_id)
149 class QuerySubscription(object):
151 def query_multi_subscriptions(self, params):
153 logger.debug("QuerySubscription--get--multi--subscriptions--biz::> Check "
154 "for filters in query params %s" % params)
155 for query, value in list(params.items()):
156 if query in ROOT_FILTERS:
157 query_data[ROOT_FILTERS[query] + '__icontains'] = value
158 # Query the database with filters if the request has fields in request params, else fetch all records
160 subscriptions = VnfPkgSubscriptionModel.objects.filter(**query_data)
162 subscriptions = VnfPkgSubscriptionModel.objects.all()
163 if not subscriptions.exists():
165 return [subscription.toDict() for subscription in subscriptions]
167 def query_single_subscription(self, subscription_id):
168 logger.debug("QuerySingleSubscriptions--get--single--subscription--biz::> "
169 "ID: %s" % subscription_id)
171 subscription = VnfPkgSubscriptionModel.objects.filter(
172 subscription_id=subscription_id)
173 if not subscription.exists():
174 raise SubscriptionDoesNotExistsException("Subscription with ID: %s "
175 "does not exists" % subscription_id)
176 return subscription[0].toDict()
179 class TerminateSubscription(object):
181 def terminate(self, subscription_id):
182 logger.debug("TerminateSubscriptions--delete--biz::> "
183 "ID: %s" % subscription_id)
185 subscription = VnfPkgSubscriptionModel.objects.filter(
186 subscription_id=subscription_id)
187 if not subscription.exists():
188 raise SubscriptionDoesNotExistsException("Subscription with ID: %s "
189 "does not exists" % subscription_id)
190 subscription[0].delete()