Bug 1862: Fixed required field in SOL006 IM to generate OSM repo index

[osm/osmclient.git] / osmclient / sol005 / osmrepo.py

diff --git a/osmclient/sol005/osmrepo.py b/osmclient/sol005/osmrepo.py
index 02318de..85529de 100644 (file)
--- a/osmclient/sol005/osmrepo.py
+++ b/osmclient/sol005/osmrepo.py
@@ -16,7 +16,6 @@
 OSM Repo API handling
 """
 import glob
 OSM Repo API handling
 """
 import glob

-import hashlib

 import logging
 from os import listdir, mkdir, getcwd, remove
 from os.path import isfile, isdir, join, abspath
 import logging
 from os import listdir, mkdir, getcwd, remove
 from os.path import isfile, isdir, join, abspath


@@ -29,6 +28,7 @@ from osm_im.validation import Validation as validation_im
 from osmclient.common.exceptions import ClientException
 from osmclient.common.package_tool import PackageTool
 from osmclient.sol005.repo import Repo
 from osmclient.common.exceptions import ClientException
 from osmclient.common.package_tool import PackageTool
 from osmclient.sol005.repo import Repo

+from osmclient.common import utils

 from packaging import version as versioning
 import requests
 import yaml
 from packaging import version as versioning
 import requests
 import yaml


@@ -188,6 +188,7 @@ class OSMRepo(Repo):
         artifacts = []
         directories = []
         for f in listdir(origin):
         artifacts = []
         directories = []
         for f in listdir(origin):

+            self._logger.debug(f"Element: {join(origin,f)}")

             if isfile(join(origin, f)) and f.endswith(".tar.gz"):
                 artifacts.append(f)
             elif (
             if isfile(join(origin, f)) and f.endswith(".tar.gz"):
                 artifacts.append(f)
             elif (


@@ -200,13 +201,15 @@ class OSMRepo(Repo):
                 )  # TODO: Document that nested directories are not supported
             else:
                 self._logger.debug(f"Ignoring {f}")
                 )  # TODO: Document that nested directories are not supported
             else:
                 self._logger.debug(f"Ignoring {f}")

-        for artifact in artifacts:
-            self.register_artifact_in_repository(
-                join(origin, artifact), destination, source="artifact"
+        self._logger.debug(f"Artifacts: {artifacts}")
+        for package in artifacts:
+            self.register_package_in_repository(
+                join(origin, package), origin, destination, kind="artifact"

             )
             )

-        for artifact in directories:
-            self.register_artifact_in_repository(
-                join(origin, artifact), destination, source="directory"
+        self._logger.debug(f"Directories: {directories}")
+        for package in directories:
+            self.register_package_in_repository(
+                join(origin, package), origin, destination, kind="directory"

             )
         self._logger.info("\nFinal Results: ")
         self._logger.info(
             )
         self._logger.info("\nFinal Results: ")
         self._logger.info(


@@ -223,19 +226,6 @@ class OSMRepo(Repo):
             + str(len(glob.glob(destination + "/nst/*/*/metadata.yaml")))
         )
 
             + str(len(glob.glob(destination + "/nst/*/*/metadata.yaml")))
         )
 

-    def md5(self, fname):
-        """
-        Checksum generator
-        :param fname: file path
-        :return: checksum string
-        """
-        self._logger.debug("")
-        hash_md5 = hashlib.md5()
-        with open(fname, "rb") as f:
-            for chunk in iter(lambda: f.read(4096), b""):
-                hash_md5.update(chunk)
-        return hash_md5.hexdigest()
-

     def fields_building(self, descriptor_dict, file, package_type):
         """
         From an artifact descriptor, obtain the fields required for indexing
     def fields_building(self, descriptor_dict, file, package_type):
         """
         From an artifact descriptor, obtain the fields required for indexing


@@ -318,8 +308,8 @@ class OSMRepo(Repo):
             msg = f"Unexpected descriptor format {descriptor_dict}"
             self._logger.error(msg)
             raise ValueError(msg)
             msg = f"Unexpected descriptor format {descriptor_dict}"
             self._logger.error(msg)
             raise ValueError(msg)

-
-        fields["name"] = aux_dict.get("name")
+        # Repo search is based on 'name' entry in index.yaml. It is mandatory then
+        fields["name"] = aux_dict.get("name", aux_dict["product-name"])

         fields["id"] = aux_dict.get("id")
         fields["description"] = aux_dict.get("description")
         fields["vendor"] = aux_dict.get("vendor")
         fields["id"] = aux_dict.get("id")
         fields["description"] = aux_dict.get("description")
         fields["vendor"] = aux_dict.get("vendor")


@@ -351,21 +341,24 @@ class OSMRepo(Repo):
         descriptor_file = glob.glob("{}/*.y*ml".format(folder))[0]
         return folder, descriptor_file
 
         descriptor_file = glob.glob("{}/*.y*ml".format(folder))[0]
         return folder, descriptor_file
 

-    def validate_artifact(self, path, source):
+    def validate_artifact(self, path, origin, kind):

         """
         Validation of artifact.
         :param path: file path
         """
         Validation of artifact.
         :param path: file path

-        :param source: flag to select the correct file type (directory or artifact)
+        :param origin: folder where the package is located
+        :param kind: flag to select the correct file type (directory or artifact)

         :return: status details, status, fields, package_type
         """
         :return: status details, status, fields, package_type
         """

-        self._logger.debug(f"Validating {path} {source}")
+        self._logger.debug(f"Validating {path} {kind}")

         package_type = ""
         folder = ""
         try:
         package_type = ""
         folder = ""
         try:

-            if source == "directory":
+            if kind == "directory":

                 descriptor_file = glob.glob("{}/*.y*ml".format(path))[0]
             else:
                 folder, descriptor_file = self.zip_extraction(path)
                 descriptor_file = glob.glob("{}/*.y*ml".format(path))[0]
             else:
                 folder, descriptor_file = self.zip_extraction(path)

+                folder = join(origin, folder)
+                self._logger.debug(f"Kind is an artifact (tar.gz). Folder: {folder}. Descriptor_file: {descriptor_file}")

 
             self._logger.debug("Opening descriptor file: {}".format(descriptor_file))
 
 
             self._logger.debug("Opening descriptor file: {}".format(descriptor_file))
 


@@ -409,39 +402,40 @@ class OSMRepo(Repo):
             if folder:
                 rmtree(folder, ignore_errors=True)
 
             if folder:
                 rmtree(folder, ignore_errors=True)
 

-    def register_artifact_in_repository(self, path, destination, source):
+    def register_package_in_repository(self, path, origin, destination, kind):

         """
         Registration of one artifact in a repository
         """
         Registration of one artifact in a repository

-        param path:
-        param destination: path for index creation
-        param source:
+        :param path: absolute path of the VNF/NS package
+        :param origin: folder where the package is located
+        :param destination: path for index creation
+        :param kind: artifact (tar.gz) or directory

         """
         self._logger.debug("")
         pt = PackageTool()
         compressed = False
         try:
             fields = {}
         """
         self._logger.debug("")
         pt = PackageTool()
         compressed = False
         try:
             fields = {}

-            _, valid, fields, package_type = self.validate_artifact(path, source)
+            _, valid, fields, package_type = self.validate_artifact(path, origin, kind)

             if not valid:
                 raise Exception(
                     "{} {} Not well configured.".format(package_type.upper(), str(path))
                 )
             else:
             if not valid:
                 raise Exception(
                     "{} {} Not well configured.".format(package_type.upper(), str(path))
                 )
             else:

-                if source == "directory":
+                if kind == "directory":

                     path = pt.build(path)
                     self._logger.debug(f"Directory path {path}")
                     compressed = True
                     path = pt.build(path)
                     self._logger.debug(f"Directory path {path}")
                     compressed = True

-                fields["checksum"] = self.md5(path)
+                fields["checksum"] = utils.md5(path)

                 self.indexation(destination, path, package_type, fields)
 
         except Exception as e:
             self._logger.exception(
                 self.indexation(destination, path, package_type, fields)
 
         except Exception as e:
             self._logger.exception(

-                "Error registering artifact in Repository: {}".format(e)
+                "Error registering package in Repository: {}".format(e)

             )
             raise ClientException(e)
 
         finally:
             )
             raise ClientException(e)
 
         finally:

-            if source == "directory" and compressed:
+            if kind == "directory" and compressed:

                 remove(path)
 
     def indexation(self, destination, path, package_type, fields):
                 remove(path)
 
     def indexation(self, destination, path, package_type, fields):