2 # Licensed under the Apache License, Version 2.0 (the "License"); you may
3 # not use this file except in compliance with the License. You may obtain
4 # a copy of the License at
6 # http://www.apache.org/licenses/LICENSE-2.0
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
10 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
11 # License for the specific language governing permissions and limitations
20 from os
import listdir
, mkdir
, getcwd
, remove
21 from os
.path
import isfile
, isdir
, join
, abspath
22 from shutil
import copyfile
, rmtree
27 from osm_im
.validation
import Validation
as validation_im
28 from osmclient
.common
.exceptions
import ClientException
29 from osmclient
.common
.package_tool
import PackageTool
30 from osmclient
.sol005
.repo
import Repo
31 from osmclient
.common
import utils
32 from packaging
import version
as versioning
38 def __init__(self
, http
=None, client
=None):
41 self
._apiName
= "/admin"
42 self
._apiVersion
= "/v1"
43 self
._apiResource
= "/osmrepos"
44 self
._logger
= logging
.getLogger("osmclient")
45 self
._apiBase
= "{}{}{}".format(
46 self
._apiName
, self
._apiVersion
, self
._apiResource
49 def pkg_list(self
, pkgtype
, filter=None, repo
=None):
51 Returns a repo based on name or id
53 self
._logger
.debug("")
54 self
._client
.get_token()
55 # Get OSM registered repository list
56 repositories
= self
.list()
58 repositories
= [r
for r
in repositories
if r
["name"] == repo
]
60 raise ClientException("Not repository found")
63 for repository
in repositories
:
65 r
= requests
.get("{}/index.yaml".format(repository
.get("url")))
67 if r
.status_code
== 200:
68 repo_list
= yaml
.safe_load(r
.text
)
69 vnf_packages
= repo_list
.get("{}_packages".format(pkgtype
))
70 for repo
in vnf_packages
:
71 versions
= vnf_packages
.get(repo
)
72 latest
= versions
.get("latest")
73 del versions
["latest"]
74 for version
in versions
:
75 latest_version
= False
80 "vendor": versions
[version
].get("vendor"),
81 "name": versions
[version
].get("name"),
83 "description": versions
[version
].get("description"),
84 "location": versions
[version
].get("path"),
85 "repository": repository
.get("name"),
86 "repourl": repository
.get("url"),
87 "latest": latest_version
,
92 "repository in url {} unreachable".format(repository
.get("url"))
94 except Exception as e
:
96 "Error cannot read from repository {} '{}': {}".format(
97 repository
["name"], repository
["url"], e
103 vnf_repos_filtered
= []
105 for vnf_repo
in vnf_repos
:
106 for k
, v
in vnf_repo
.items():
108 kf
, vf
= filter.split("=")
109 if k
== kf
and vf
in v
:
110 vnf_repos_filtered
.append(vnf_repo
)
112 vnf_repos
= vnf_repos_filtered
115 def get_pkg(self
, pkgtype
, name
, repo
, filter, version
):
117 Returns the filename of the PKG downloaded to disk
119 self
._logger
.debug("")
120 self
._client
.get_token()
123 # Get OSM registered repository list
124 pkgs
= self
.pkg_list(pkgtype
, filter, repo
)
126 if pkg
.get("repository") == repo
and pkg
.get("name") == name
:
127 if "latest" in version
:
128 if not pkg
.get("latest"):
131 version
= pkg
.get("version")
132 if pkg
.get("version") == version
:
134 "{}{}".format(pkg
.get("repourl"), pkg
.get("location")),
137 if r
.status_code
!= 200:
138 raise ClientException("Package not found")
140 with tempfile
.NamedTemporaryFile(delete
=False) as f
:
141 f
.write(r
.raw
.read())
144 raise ClientException(
145 "{} {} not found at repo {}".format(pkgtype
, name
, repo
)
149 def pkg_get(self
, pkgtype
, name
, repo
, version
, filter):
150 pkg_name
= self
.get_pkg(pkgtype
, name
, repo
, filter, version
)
152 raise ClientException("Package not found")
153 folder
, descriptor
= self
.zip_extraction(pkg_name
)
154 with
open(descriptor
) as pkg
:
155 pkg_descriptor
= yaml
.safe_load(pkg
)
156 rmtree(folder
, ignore_errors
=False)
159 and (pkg_descriptor
.get("vnfd") or pkg_descriptor
.get("vnfd:vnfd_catalog"))
162 and (pkg_descriptor
.get("nsd") or pkg_descriptor
.get("nsd:nsd_catalog"))
164 raise ClientException("Wrong Package type")
165 return pkg_descriptor
167 def repo_index(self
, origin
=".", destination
="."):
169 Repo Index main function
170 :param origin: origin directory for getting all the artifacts
171 :param destination: destination folder for create and index the valid artifacts
173 self
._logger
.debug("Starting index composition")
174 if destination
== ".":
175 if origin
== destination
:
176 destination
= "repository"
178 destination
= abspath(destination
)
179 origin
= abspath(origin
)
180 self
._logger
.debug(f
"Paths {destination}, {origin}")
182 origin
= join(getcwd(), origin
)
183 if destination
[0] != "/":
184 destination
= join(getcwd(), destination
)
186 self
.init_directory(destination
)
189 for f
in listdir(origin
):
190 self
._logger
.debug(f
"Element: {join(origin,f)}")
191 if isfile(join(origin
, f
)) and f
.endswith(".tar.gz"):
194 isdir(join(origin
, f
))
195 and f
!= destination
.split("/")[-1]
196 and not f
.startswith(".")
200 ) # TODO: Document that nested directories are not supported
202 self
._logger
.debug(f
"Ignoring {f}")
203 self
._logger
.debug(f
"Artifacts: {artifacts}")
204 for package
in artifacts
:
205 self
.register_package_in_repository(
206 join(origin
, package
), origin
, destination
, kind
="artifact"
208 self
._logger
.debug(f
"Directories: {directories}")
209 for package
in directories
:
210 self
.register_package_in_repository(
211 join(origin
, package
), origin
, destination
, kind
="directory"
213 self
._logger
.info("\nFinal Results: ")
215 "VNF Packages Indexed: "
216 + str(len(glob
.glob(destination
+ "/vnf/*/*/metadata.yaml")))
219 "NS Packages Indexed: "
220 + str(len(glob
.glob(destination
+ "/ns/*/*/metadata.yaml")))
224 "NST Packages Indexed: "
225 + str(len(glob
.glob(destination
+ "/nst/*/*/metadata.yaml")))
228 def fields_building(self
, descriptor_dict
, file, package_type
):
230 From an artifact descriptor, obtain the fields required for indexing
231 :param descriptor_dict: artifact description
232 :param file: artifact package
233 :param package_type: type of artifact (vnf, ns, nst)
236 self
._logger
.debug("")
239 base_path
= "/{}/".format(package_type
)
241 if package_type
== "vnf":
242 if descriptor_dict
.get("vnfd-catalog", False):
243 aux_dict
= descriptor_dict
.get("vnfd-catalog", {}).get("vnfd", [{}])[0]
244 elif descriptor_dict
.get("vnfd:vnfd-catalog"):
245 aux_dict
= descriptor_dict
.get("vnfd:vnfd-catalog", {}).get(
248 elif descriptor_dict
.get("vnfd"):
249 aux_dict
= descriptor_dict
["vnfd"]
250 if aux_dict
.get("vnfd"):
251 aux_dict
= aux_dict
["vnfd"][0]
253 msg
= f
"Unexpected descriptor format {descriptor_dict}"
254 self
._logger
.error(msg
)
255 raise ValueError(msg
)
257 f
"Extracted descriptor info for {package_type}: {aux_dict}"
260 for vdu
in aux_dict
.get("vdu", aux_dict
.get("kdu", ())):
261 images
.append(vdu
.get("image", vdu
.get("name")))
262 fields
["images"] = images
263 elif package_type
== "ns":
264 if descriptor_dict
.get("nsd-catalog", False):
265 aux_dict
= descriptor_dict
.get("nsd-catalog", {}).get("nsd", [{}])[0]
266 elif descriptor_dict
.get("nsd:nsd-catalog"):
267 aux_dict
= descriptor_dict
.get("nsd:nsd-catalog", {}).get("nsd", [{}])[
270 elif descriptor_dict
.get("nsd"):
271 aux_dict
= descriptor_dict
["nsd"]
272 if aux_dict
.get("nsd"):
273 aux_dict
= descriptor_dict
["nsd"]["nsd"][0]
275 msg
= f
"Unexpected descriptor format {descriptor_dict}"
276 self
._logger
.error(msg
)
277 raise ValueError(msg
)
279 if aux_dict
.get("constituent-vnfd"):
280 for vnf
in aux_dict
.get("constituent-vnfd", ()):
281 vnfs
.append(vnf
.get("vnfd-id-ref"))
283 vnfs
= aux_dict
.get("vnfd-id")
284 self
._logger
.debug("Used VNFS in the NSD: " + str(vnfs
))
285 fields
["vnfd-id-ref"] = vnfs
286 elif package_type
== "nst":
287 if descriptor_dict
.get("nst-catalog", False):
288 aux_dict
= descriptor_dict
.get("nst-catalog", {}).get("nst", [{}])[0]
289 elif descriptor_dict
.get("nst:nst-catalog"):
290 aux_dict
= descriptor_dict
.get("nst:nst-catalog", {}).get("nst", [{}])[
293 elif descriptor_dict
.get("nst"):
294 aux_dict
= descriptor_dict
["nst"]
295 if aux_dict
.get("nst"):
296 aux_dict
= descriptor_dict
["nst"]["nst"][0]
298 for nsd
in aux_dict
.get("netslice-subnet", ()):
299 nsds
.append(nsd
.get("nsd-ref"))
300 self
._logger
.debug("Used NSDs in the NST: " + str(nsds
))
302 msg
= f
"Unexpected descriptor format {descriptor_dict}"
303 self
._logger
.error(msg
)
304 raise ValueError(msg
)
305 fields
["nsd-id-ref"] = nsds
307 msg
= f
"Unexpected descriptor format {descriptor_dict}"
308 self
._logger
.error(msg
)
309 raise ValueError(msg
)
310 # Repo search is based on 'name' entry in index.yaml. It is mandatory then
311 fields
["name"] = aux_dict
.get("name", aux_dict
["product-name"])
312 fields
["id"] = aux_dict
.get("id")
313 fields
["description"] = aux_dict
.get("description")
314 fields
["vendor"] = aux_dict
.get("vendor")
315 fields
["version"] = str(aux_dict
.get("version", "1.0"))
316 fields
["path"] = "{}{}/{}/{}-{}.tar.gz".format(
321 fields
.get("version"),
325 def zip_extraction(self
, file_name
):
327 Validation of artifact.
328 :param file: file path
329 :return: status details, status, fields, package_type
331 self
._logger
.debug("Decompressing package file")
332 temp_file
= "/tmp/{}".format(file_name
.split("/")[-1])
333 if file_name
!= temp_file
:
334 copyfile(file_name
, temp_file
)
335 with tarfile
.open(temp_file
, "r:gz") as tar
:
336 folder
= tar
.getnames()[0].split("/")[0]
340 descriptor_file
= glob
.glob("{}/*.y*ml".format(folder
))[0]
341 return folder
, descriptor_file
343 def validate_artifact(self
, path
, origin
, kind
):
345 Validation of artifact.
346 :param path: file path
347 :param origin: folder where the package is located
348 :param kind: flag to select the correct file type (directory or artifact)
349 :return: status details, status, fields, package_type
351 self
._logger
.debug(f
"Validating {path} {kind}")
355 if kind
== "directory":
356 descriptor_file
= glob
.glob("{}/*.y*ml".format(path
))[0]
358 folder
, descriptor_file
= self
.zip_extraction(path
)
359 folder
= join(origin
, folder
)
361 f
"Kind is an artifact (tar.gz). Folder: {folder}. Descriptor_file: {descriptor_file}"
364 self
._logger
.debug("Opening descriptor file: {}".format(descriptor_file
))
366 with
open(descriptor_file
, "r") as f
:
367 descriptor_data
= f
.read()
368 self
._logger
.debug(f
"Descriptor data: {descriptor_data}")
369 validation
= validation_im()
370 desc_type
, descriptor_dict
= validation
.yaml_validation(descriptor_data
)
372 validation_im
.pyangbind_validation(self
, desc_type
, descriptor_dict
)
373 except Exception as e
:
374 self
._logger
.error(e
, exc_info
=True)
376 descriptor_type_ref
= list(descriptor_dict
.keys())[0].lower()
377 if "vnf" in descriptor_type_ref
:
379 elif "nst" in descriptor_type_ref
:
381 elif "ns" in descriptor_type_ref
:
384 msg
= f
"Unknown package type {descriptor_type_ref}"
385 self
._logger
.error(msg
)
386 raise ValueError(msg
)
387 self
._logger
.debug("Descriptor: {}".format(descriptor_dict
))
388 fields
= self
.fields_building(descriptor_dict
, path
, package_type
)
389 self
._logger
.debug(f
"Descriptor successfully validated {fields}")
392 "detail": "{}D successfully validated".format(package_type
.upper()),
399 except Exception as e
:
400 # Delete the folder we just created
401 return {"detail": str(e
)}, False, {}, package_type
404 rmtree(folder
, ignore_errors
=True)
406 def register_package_in_repository(self
, path
, origin
, destination
, kind
):
408 Registration of one artifact in a repository
409 :param path: absolute path of the VNF/NS package
410 :param origin: folder where the package is located
411 :param destination: path for index creation
412 :param kind: artifact (tar.gz) or directory
414 self
._logger
.debug("")
419 _
, valid
, fields
, package_type
= self
.validate_artifact(path
, origin
, kind
)
422 "{} {} Not well configured.".format(package_type
.upper(), str(path
))
425 if kind
== "directory":
426 path
= pt
.build(path
)
427 self
._logger
.debug(f
"Directory path {path}")
429 fields
["checksum"] = utils
.md5(path
)
430 self
.indexation(destination
, path
, package_type
, fields
)
432 except Exception as e
:
433 self
._logger
.exception(
434 "Error registering package in Repository: {}".format(e
)
436 raise ClientException(e
)
439 if kind
== "directory" and compressed
:
442 def indexation(self
, destination
, path
, package_type
, fields
):
444 Process for index packages
445 :param destination: index repository path
446 :param path: path of the package
447 :param package_type: package type (vnf, ns, nst)
448 :param fields: dict with the required values
450 self
._logger
.debug(f
"Processing {destination} {path} {package_type} {fields}")
453 "name": fields
.get("name"),
454 "description": fields
.get("description"),
455 "vendor": fields
.get("vendor"),
456 "path": fields
.get("path"),
458 self
._logger
.debug(data_ind
)
460 destination
, package_type
, fields
.get("id"), fields
.get("version")
462 if isdir(join(destination
, package_type
, fields
.get("id"))):
463 if isdir(final_path
):
464 self
._logger
.warning(
465 "{} {} already exists".format(package_type
.upper(), str(path
))
475 + fields
.get("version")
480 open(final_path
+ "/" + "metadata.yaml", "w"),
481 default_flow_style
=False,
485 index
= yaml
.safe_load(open(destination
+ "/index.yaml"))
487 index
["{}_packages".format(package_type
)][fields
.get("id")][
488 fields
.get("version")
491 index
["{}_packages".format(package_type
)][fields
.get("id")][
494 ) < versioning
.parse(fields
.get("version")):
495 index
["{}_packages".format(package_type
)][fields
.get("id")][
497 ] = fields
.get("version")
500 open(destination
+ "/index.yaml", "w"),
501 default_flow_style
=False,
506 "{} {} added in the repository".format(
507 package_type
.upper(), str(path
)
511 mkdir(destination
+ "/{}/".format(package_type
) + fields
.get("id"))
519 + fields
.get("version")
524 open(join(final_path
, "metadata.yaml"), "w"),
525 default_flow_style
=False,
529 index
= yaml
.safe_load(open(destination
+ "/index.yaml"))
531 index
["{}_packages".format(package_type
)][fields
.get("id")] = {
532 fields
.get("version"): data_ind
534 index
["{}_packages".format(package_type
)][fields
.get("id")][
536 ] = fields
.get("version")
539 open(join(destination
, "index.yaml"), "w"),
540 default_flow_style
=False,
545 "{} {} added in the repository".format(package_type
.upper(), str(path
))
548 def current_datetime(self
):
551 :return: Datetime as string with the following structure "2020-04-29T08:41:07.681653Z"
553 self
._logger
.debug("")
554 return time
.strftime("%Y-%m-%dT%H:%M:%S.%sZ")
556 def init_directory(self
, destination
):
558 Initialize the index directory. Creation of index.yaml, and the directories for vnf and ns
562 self
._logger
.debug("")
563 if not isdir(destination
):
565 if not isfile(join(destination
, "index.yaml")):
566 mkdir(join(destination
, "vnf"))
567 mkdir(join(destination
, "ns"))
568 mkdir(join(destination
, "nst"))
571 "generated": self
.current_datetime(),
576 with
open(join(destination
, "index.yaml"), "w") as outfile
:
578 index_data
, outfile
, default_flow_style
=False, width
=80, indent
=4