Add log and comment
[modeling/etsicatalog.git] / catalog / packages / biz / vnf_package.py
index daf2fb2..a91f17a 100644 (file)
@@ -15,7 +15,6 @@
 import json
 import logging
 import os
-
 import threading
 import traceback
 import urllib
@@ -35,11 +34,19 @@ logger = logging.getLogger(__name__)
 
 
 class VnfPackage(object):
+    """
+    The class for VNF package management
+    """
 
     def __init__(self):
         pass
 
     def create_vnf_pkg(self, data):
+        """
+        Create a VNF package
+        :param data: user defined data
+        :return: VNF package info
+        """
         user_defined_data = ignore_case_get(data, "userDefinedData", {})
         vnf_pkg_id = str(uuid.uuid4())
         VnfPackageModel.objects.create(
@@ -60,6 +67,10 @@ class VnfPackage(object):
         return data
 
     def query_multiple(self):
+        """
+        Query the list of VNF package
+        :return: The list of VNF pakcage
+        """
         pkgs_info = []
         nf_pkgs = VnfPackageModel.objects.filter()
         for nf_pkg in nf_pkgs:
@@ -68,6 +79,11 @@ class VnfPackage(object):
         return pkgs_info
 
     def query_single(self, vnf_pkg_id):
+        """
+        Query a single VNF package by given id
+        :param vnf_pkg_id: The id of VNF package
+        :return: VNF pckage info
+        """
         nf_pkg = VnfPackageModel.objects.filter(vnfPackageId=vnf_pkg_id)
         if not nf_pkg.exists():
             logger.error('VNF package(%s) does not exist.' % vnf_pkg_id)
@@ -75,6 +91,11 @@ class VnfPackage(object):
         return fill_response_data(nf_pkg[0])
 
     def delete_vnf_pkg(self, vnf_pkg_id):
+        """
+        Delete a VNF package by give id
+        :param vnf_pkg_id: The id of VNF package
+        :return:
+        """
         vnf_pkg = VnfPackageModel.objects.filter(vnfPackageId=vnf_pkg_id)
         if not vnf_pkg.exists():
             logger.debug('VNF package(%s) has been deleted.' % vnf_pkg_id)
@@ -105,6 +126,12 @@ class VnfPackage(object):
         logger.info('VNF package(%s) has been deleted.' % vnf_pkg_id)
 
     def upload(self, vnf_pkg_id, remote_file):
+        """
+        Update VNF pckage file for given id
+        :param vnf_pkg_id: The id of VNF package
+        :param remote_file: VNF package file
+        :return:
+        """
         logger.info('Start to upload VNF package(%s)...' % vnf_pkg_id)
         vnf_pkg = VnfPackageModel.objects.filter(vnfPackageId=vnf_pkg_id)
         # if vnf_pkg[0].onboardingState != PKG_STATUS.CREATED:
@@ -131,6 +158,11 @@ class VnfPackage(object):
         return read(local_file_path, start, end)
 
     def download_vnfd(self, vnf_pkg_id):
+        """
+        Download VNFD for given id
+        :param vnf_pkg_id: The id of VNF package
+        :return: VNFD
+        """
         logger.info('Start to download VNFD of VNF package(%s)...' % vnf_pkg_id)
         nf_pkg = VnfPackageModel.objects.filter(vnfPackageId=vnf_pkg_id)
         if not nf_pkg.exists():
@@ -184,6 +216,10 @@ class VnfPackage(object):
 
 
 class VnfPkgUploadThread(threading.Thread):
+    """
+    The Thread for upload VNF pckage
+    """
+
     def __init__(self, data, vnf_pkg_id):
         threading.Thread.__init__(self)
         self.vnf_pkg_id = vnf_pkg_id
@@ -229,6 +265,68 @@ class VnfPkgUploadThread(threading.Thread):
         logger.info('VNF packge(%s) has been uploaded.' % self.vnf_pkg_id)
 
 
+def get_mfile_data(path):
+    logger.debug('get_mfile_data path %s' % path)
+    files = fileutil.filter_files(path, '.mf')
+    if files:
+        src_file = os.path.join(path, files[0])
+        src_dict_list = []
+        with open(src_file, 'r') as f:
+            data = f.readlines()
+            for line in data:
+                if line.strip() == "":
+                    continue
+                src_dict = {}
+                k, v = line.split(':', maxsplit=1)
+                if k.strip() in ["Source", "Algorithm", "Hash"]:
+                    if k.strip() == "Source" and src_dict:
+                        src_dict_list.extend(src_dict)
+                        src_dict = {}
+                    src_dict[k.strip()] = v.strip()
+                    print("src_dict:%s" % src_dict)
+        if src_dict:
+            src_dict_list.append(src_dict)
+
+        logger.debug('get_mfile_data: %s' % src_dict_list)
+        return src_dict_list
+
+
+def fill_artifacts_data(vnf_pkg_id):
+    vnf_pkg_path = os.path.join(CATALOG_ROOT_PATH, vnf_pkg_id)
+    if os.path.exists(vnf_pkg_path) is False:
+        return None
+    files = fileutil.filter_files(vnf_pkg_path, '.csar')
+    for filename in files:
+        logger.info('fill_artifacts_data filename (%s)...' % filename)
+        dst_file_path = os.path.join(vnf_pkg_path, "tmp")
+        src_file = os.path.join(vnf_pkg_path, filename)
+        dst_file = os.path.join(dst_file_path, filename)
+        fileutil.recreate_dir(dst_file_path)
+        fileutil.copy(src_file, vnf_pkg_path, dst_file)
+        artifact_vnf_file = fileutil.unzip_file(dst_file, dst_file_path, "")
+        artifacts = get_mfile_data(artifact_vnf_file)
+        if artifacts:
+            return [{
+                "artifactPath": artifact.get("Source", ""),
+                "checksum": {
+                    "algorithm": artifact.get("Hash", "Null"),
+                    "hash": artifact.get("Algorithm", "Null")
+                }
+            } for artifact in artifacts]
+
+
+def fill_links(pkg_id, is_onboarded=False):
+    self_href = "/api/vnfpkgm/v1/vnf_packages/%s" % (pkg_id)
+    links = {
+        "self": {"href": self_href},
+        "vnfd": {"href": "%s/%s" % (self_href, "vnfd")},
+        "packageContent": {"href": "%s/%s" % (self_href, "package_content")}
+    }
+    if not is_onboarded:
+        links.pop("vnfd")
+    return links
+
+
 def fill_response_data(nf_pkg):
     pkg_info = {}
     pkg_info["id"] = nf_pkg.vnfPackageId
@@ -239,13 +337,13 @@ def fill_response_data(nf_pkg):
     if nf_pkg.checksum:
         pkg_info["checksum"] = json.JSONDecoder().decode(nf_pkg.checksum)
     pkg_info["softwareImages"] = None  # TODO
-    pkg_info["additionalArtifacts"] = None  # TODO
+    pkg_info["additionalArtifacts"] = fill_artifacts_data(nf_pkg.vnfPackageId)
     pkg_info["onboardingState"] = nf_pkg.onboardingState
     pkg_info["operationalState"] = nf_pkg.operationalState
     pkg_info["usageState"] = nf_pkg.usageState
     if nf_pkg.userDefinedData:
         pkg_info["userDefinedData"] = json.JSONDecoder().decode(nf_pkg.userDefinedData)
-    pkg_info["_links"] = None  # TODO
+    pkg_info["_links"] = fill_links(nf_pkg.vnfPackageId, True)
     return pkg_info