Push license selection seed code

Issue-ID: OPTFRA-48
Change-Id: I8555f03ed5bf6ee14409b0f5614607c696ee22a6
Signed-off-by: Sastry Isukapalli <sastry@research.att.com>

5 files changed, 177 insertions, 0 deletions

diff --git a/adapters/sdc/__init__.py b/adapters/sdc/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/adapters/sdc/__init__.py
diff --git a/adapters/sdc/asdc.py b/adapters/sdc/asdc.py
new file mode 100755
index 0000000..43932ba
--- /dev/null
+++ b/adapters/sdc/asdc.py
@@ -0,0 +1,40 @@
+# -------------------------------------------------------------------------
+#   Copyright (c) 2015-2017 AT&T Intellectual Property
+#
+#   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.
+#
+# -------------------------------------------------------------------------
+#
+
+from osdf.utils.interfaces import RestClient
+import xml.etree.ElementTree as ET
+
+def request(model_version_id, request_id, config):
+    """Get all of the license artifacts from SDC using service_resource_id and model_version_id
+    :param model_version_id: model_version_id
+    :param request_id: request_id
+    :return: license artifacts from SDC
+    """
+    base_url = config['sdcUrl']
+    uid, passwd = config['sdcUsername'], config['sdcPassword']
+    headers = {"CSP_UID": config['sdcMechId'], "X-ONAP-InstanceID": "osdf"}
+    rc = RestClient(userid=uid, passwd=passwd, headers=headers, method="GET", req_id=request_id)
+    resource_data = rc.request(base_url + '/resources/{}/metadata'.format(model_version_id))
+
+    artifact_ids = [x['artifactURL'].split("/resources/")[-1]  # get the part after /resources/
+                    for x in resource_data.get('artifacts', []) if x.get('artifactType') == "VF_LICENSE"]
+    artifact_urls = [base_url + '/resources/' + str(artifact_id) for artifact_id in artifact_ids]
+    licenses = []
+    for x in artifact_urls:
+        licenses.append(ET.fromstring(rc.request(x, asjson=False)))
+    return licenses
diff --git a/adapters/sdc/constraint_handler.py b/adapters/sdc/constraint_handler.py
new file mode 100644
index 0000000..2aae9a0
--- /dev/null
+++ b/adapters/sdc/constraint_handler.py
@@ -0,0 +1,81 @@
+# -------------------------------------------------------------------------

+#   Copyright (c) 2015-2017 AT&T Intellectual Property

+#

+#   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.

+#

+# -------------------------------------------------------------------------

+#

+

+from osdf.config.base import osdf_config

+from osdf.utils.programming_utils import dot_notation

+

+ns = {'p': 'http://xmlns.onap.org/sdc/license-model/1.0'}

+config_local = osdf_config.core

+

+

+def choose_license(license_artifacts, order_info, service_type):

+    entitlement_pool_uuids = []

+    license_key_group_uuids = []

+

+    for license_artifact in license_artifacts:

+        for feature in license_artifact.findall('./p:feature-group-list/', ns):

+            for entitlement in feature.findall('./p:entitlement-pool-list/', ns):

+                if is_valid(entitlement, order_info, service_type):

+                    entitlement_pool_uuid = entitlement.find('p:entitlement-pool-uuid', ns).text

+                    entitlement_pool_uuids.append(entitlement_pool_uuid)

+            for license_key_group in feature.findall('./p:license-key-group-list/', ns):

+                if is_valid(license_key_group, order_info, service_type):

+                    license_key_group_uuid = license_key_group.find('p:license-key-group-uuid', ns).text

+                    license_key_group_uuids.append(license_key_group_uuid)

+    return entitlement_pool_uuids, license_key_group_uuids

+

+

+# element is expected to be a license-key-group or entitlement-pool

+# if these elements diverge at a later date this method should be refactored

+def is_valid(element, order_info, service_type):

+    for limit in element.findall('./p:sp-limits/p:limit', ns):

+        # description = limit.find('p:description', ns).text

+        metric_value = limit.find('p:values', ns).text

+        metric = limit.find('p:metric', ns).text

+        try:

+            order_value = dot_notation(order_info, config_local['service_info'][service_type][metric])

+            # print("The order has the value %s for the metric %s and the limit specifies the value %s. The limit has the description %s." % (order_value, metric, metric_value, description))

+            if isinstance(order_value, list): # it is possible a list is returned, for example a list of vnfs for vCPE

+                for arr_value in order_value:

+                    if str(metric_value) != str(arr_value):

+                        return False

+            else:

+                if str(metric_value) != str(order_value):

+                    return False

+        except KeyError:

+            return False

+    # vendor limits

+    for limit in element.findall('./p:vendor-limits/p:limit', ns):

+            # description = limit.find('p:description', ns).text

+            metric_value = limit.find('p:values', ns).text

+            metric = limit.find('p:metric', ns).text

+            try:

+                order_value = dot_notation(order_info, config_local['service_info'][service_type][metric])

+                if isinstance(order_value, list): # it is possible a list is returned, for example a list of vnfs for vCPE

+                    for arr_value in order_value:

+                        if str(metric_value) != str(arr_value):

+                            return False

+                else:

+                    if str(metric_value) != str(order_value):

+                        return False

+                # print("The order has the value %s for the metric %s and the limit specifies the value %s. The limit has the description %s." % (order_value, metric, metric_value, description))

+

+            except KeyError:

+                return False

+    return True

+

diff --git a/optimizers/licenseopt/__init__.py b/optimizers/licenseopt/__init__.py
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/optimizers/licenseopt/__init__.py
diff --git a/optimizers/licenseopt/simple_license_allocation.py b/optimizers/licenseopt/simple_license_allocation.py
new file mode 100644
index 0000000..1b5b670
--- /dev/null
+++ b/optimizers/licenseopt/simple_license_allocation.py
@@ -0,0 +1,56 @@
+# -------------------------------------------------------------------------
+#   Copyright (c) 2015-2017 AT&T Intellectual Property
+#
+#   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.
+#
+# -------------------------------------------------------------------------
+#
+
+import json
+
+from requests import RequestException
+from osdf.datasources.sdc import sdc, constraint_handler
+from osdf.logging.osdf_logging import audit_log, metrics_log, MH
+from osdf.config.base import osdf_config
+from osdf.utils import data_mapping
+
+
+def license_optim(request_json):
+    """
+    Fetch license artifacts associated with the service model and search licensekey-group-UUID and entitlement-pool-uuid
+    associated with the given att part number and nominal throughput in a request
+    :param request_json: Request in a JSON format
+    :return: A tuple of licensekey-group-uuid-list and entitlement-group-uuid-list
+    """
+    req_id = request_json["requestInfo"]["requestId"]
+    config = osdf_config.deployment
+
+    model_name = request_json['placementInfo']['serviceModelInfo']['modelName']
+    service_name = data_mapping.get_service_type(model_name)
+
+    license_info = []
+
+    order_info = json.loads(request_json["placementInfo"]["orderInfo"])
+    if service_name == 'VPE':
+        data_mapping.normalize_user_params(order_info)
+    for licenseDemand in request_json['placementInfo']['demandInfo']['licenseDemand']:
+        metrics_log.info(MH.requesting("sdc", req_id))
+        license_artifacts = sdc.request(licenseDemand['resourceModelInfo']['modelVersionId'],request_json["requestInfo"]["requestId"], config)
+        entitlement_pool_uuids, license_key_group_uuids = constraint_handler.choose_license(license_artifacts,order_info, service_name)
+        license_info.append(
+            {'serviceResourceId': licenseDemand['serviceResourceId'],
+             'resourceModuleName': licenseDemand['resourceModuleName'],
+             'entitlementPoolList': entitlement_pool_uuids,
+             'licenseKeyGroupList': license_key_group_uuids
+             })
+    return license_info