from osmclient.common.exceptions import NotFound
from osmclient.common.exceptions import ClientException
from osmclient.common import utils
-import yaml
import json
+import yaml
import magic
-#from os import stat
-#from os.path import basename
+from os.path import basename
+import logging
+import os.path
+from urllib.parse import quote
+import tarfile
+from osm_im.validation import Validation as validation_im
+from zipfile import ZipFile
-class Vnfd(object):
+class Vnfd(object):
def __init__(self, http=None, client=None):
self._http = http
self._client = client
- self._apiName = '/vnfpkgm'
- self._apiVersion = '/v1'
- self._apiResource = '/vnf_packages'
- self._apiBase = '{}{}{}'.format(self._apiName,
- self._apiVersion, self._apiResource)
- #self._apiBase='/vnfds'
+ self._logger = logging.getLogger("osmclient")
+ self._apiName = "/vnfpkgm"
+ self._apiVersion = "/v1"
+ self._apiResource = "/vnf_packages"
+ self._apiBase = "{}{}{}".format(
+ self._apiName, self._apiVersion, self._apiResource
+ )
def list(self, filter=None):
- filter_string = ''
+ self._logger.debug("")
+ self._client.get_token()
+ filter_string = ""
if filter:
- filter_string = '?{}'.format(filter)
- resp = self._http.get_cmd('{}{}'.format(self._apiBase,filter_string))
+ filter_string = "?{}".format(filter)
+ _, resp = self._http.get2_cmd("{}{}".format(self._apiBase, filter_string))
+
if resp:
- return resp
+ return json.loads(resp)
return list()
def get(self, name):
+ self._logger.debug("")
+ self._client.get_token()
if utils.validate_uuid4(name):
for vnfd in self.list():
- if name == vnfd['_id']:
+ if name == vnfd["_id"]:
return vnfd
else:
for vnfd in self.list():
- if 'name' in vnfd and name == vnfd['name']:
+ if "product-name" in vnfd and name == vnfd["product-name"]:
+ return vnfd
+ elif "name" in vnfd and name == vnfd["name"]:
return vnfd
raise NotFound("vnfd {} not found".format(name))
def get_individual(self, name):
+ self._logger.debug("")
vnfd = self.get(name)
# It is redundant, since the previous one already gets the whole vnfpkginfo
# The only difference is that a different primitive is exercised
- resp = self._http.get_cmd('{}/{}'.format(self._apiBase, vnfd['_id']))
- #print yaml.safe_dump(resp)
- if resp:
- return resp
- raise NotFound("vnfd {} not found".format(name))
+ try:
+ _, resp = self._http.get2_cmd("{}/{}".format(self._apiBase, vnfd["_id"]))
+ if resp:
+ return json.loads(resp)
+ except NotFound:
+ raise NotFound("vnfd '{}' not found".format(name))
+ raise NotFound("vnfd '{}' not found".format(name))
def get_thing(self, name, thing, filename):
+ self._logger.debug("")
vnfd = self.get(name)
headers = self._client._headers
- headers['Accept'] = 'application/binary'
- http_code, resp = self._http.get2_cmd('{}/{}/{}'.format(self._apiBase, vnfd['_id'], thing))
- #print 'HTTP CODE: {}'.format(http_code)
- #print 'RESP: {}'.format(resp)
- if http_code in (200, 201, 202, 204):
- if resp:
- #store in a file
- return resp
- else:
- msg = ""
- if resp:
- try:
- msg = json.loads(resp)
- except ValueError:
- msg = resp
- raise ClientException("failed to get {} from {} - {}".format(thing, name, msg))
+ headers["Accept"] = "application/binary"
+ http_code, resp = self._http.get2_cmd(
+ "{}/{}/{}".format(self._apiBase, vnfd["_id"], thing)
+ )
+
+ if resp:
+ return json.loads(resp)
def get_descriptor(self, name, filename):
- self.get_thing(name, 'vnfd', filename)
+ self._logger.debug("")
+ self.get_thing(name, "vnfd", filename)
def get_package(self, name, filename):
- self.get_thing(name, 'package_content', filename)
+ self._logger.debug("")
+ self.get_thing(name, "package_content", filename)
def get_artifact(self, name, artifact, filename):
- self.get_thing(name, 'artifacts/{}'.format(artifact), filename)
+ self._logger.debug("")
+ self.get_thing(name, "artifacts/{}".format(artifact), filename)
def delete(self, name, force=False):
+ self._logger.debug("")
+ self._client.get_token()
vnfd = self.get(name)
- querystring = ''
+ querystring = ""
if force:
- querystring = '?FORCE=True'
- http_code, resp = self._http.delete_cmd('{}/{}{}'.format(self._apiBase,
- vnfd['_id'], querystring))
- #print 'HTTP CODE: {}'.format(http_code)
- #print 'RESP: {}'.format(resp)
+ querystring = "?FORCE=True"
+ http_code, resp = self._http.delete_cmd(
+ "{}/{}{}".format(self._apiBase, vnfd["_id"], querystring)
+ )
+
if http_code == 202:
- print 'Deletion in progress'
+ print("Deletion in progress")
elif http_code == 204:
- print 'Deleted'
+ print("Deleted")
else:
- msg = ""
- if resp:
- try:
- msg = json.loads(resp)
- except ValueError:
- msg = resp
+ msg = resp or ""
raise ClientException("failed to delete vnfd {} - {}".format(name, msg))
- def create(self, filename, overwrite=None, update_endpoint=None):
- mime_type = magic.from_file(filename, mime=True)
- if mime_type is None:
- raise ClientException(
- "failed to guess MIME type for file '{}'".format(filename))
- headers= self._client._headers
- if mime_type in ['application/yaml', 'text/plain']:
- headers['Content-Type'] = 'application/yaml'
- elif mime_type == 'application/gzip':
- headers['Content-Type'] = 'application/gzip'
- #headers['Content-Type'] = 'application/binary'
- # Next three lines are to be removed in next version
- #headers['Content-Filename'] = basename(filename)
- #file_size = stat(filename).st_size
- #headers['Content-Range'] = 'bytes 0-{}/{}'.format(file_size - 1, file_size)
- else:
- raise ClientException(
- "Unexpected MIME type for file {}: MIME type {}".format(
- filename, mime_type)
- )
- headers["Content-File-MD5"] = utils.md5(filename)
- http_header = ['{}: {}'.format(key,val)
- for (key,val) in headers.items()]
- self._http.set_http_header(http_header)
- if update_endpoint:
- http_code, resp = self._http.put_cmd(endpoint=update_endpoint, filename=filename)
- else:
- ow_string = ''
- if overwrite:
- ow_string = '?{}'.format(overwrite)
- self._apiResource = '/vnf_packages_content'
- self._apiBase = '{}{}{}'.format(self._apiName,
- self._apiVersion, self._apiResource)
- endpoint = '{}{}'.format(self._apiBase,ow_string)
- http_code, resp = self._http.post_cmd(endpoint=endpoint, filename=filename)
- #print 'HTTP CODE: {}'.format(http_code)
- #print 'RESP: {}'.format(resp)
- if http_code in (200, 201, 202, 204):
- if resp:
- resp = json.loads(resp)
- if not resp or 'id' not in resp:
- raise ClientException('unexpected response from server: '.format(
- resp))
- print resp['id']
+ def create(
+ self,
+ filename,
+ overwrite=None,
+ update_endpoint=None,
+ skip_charm_build=False,
+ override_epa=False,
+ override_nonepa=False,
+ override_paravirt=False,
+ ):
+ self._logger.debug("")
+ if os.path.isdir(filename):
+ filename = filename.rstrip("/")
+ filename = self._client.package_tool.build(
+ filename, skip_validation=False, skip_charm_build=skip_charm_build
+ )
+
+ print("Uploading package {}".format(filename))
+ self.create(
+ filename,
+ overwrite=overwrite,
+ update_endpoint=update_endpoint,
+ override_epa=override_epa,
+ override_nonepa=override_nonepa,
+ override_paravirt=override_paravirt,
+ )
else:
- msg = ""
- if resp:
- try:
- msg = json.loads(resp)
- except ValueError:
- msg = resp
- raise ClientException("failed to create/update vnfd - {}".format(name, msg))
+ self._client.get_token()
+ mime_type = magic.from_file(filename, mime=True)
+ if mime_type is None:
+ raise ClientException(
+ "Unexpected MIME type for file {}: MIME type {}".format(
+ filename, mime_type
+ )
+ )
+ headers = self._client._headers
+ headers["Content-Filename"] = basename(filename)
+ if mime_type in ["application/yaml", "text/plain", "application/json"]:
+ headers["Content-Type"] = "text/plain"
+ elif mime_type in ["application/gzip", "application/x-gzip"]:
+ headers["Content-Type"] = "application/gzip"
+ elif mime_type in ["application/zip"]:
+ headers["Content-Type"] = "application/zip"
+ else:
+ raise ClientException(
+ "Unexpected MIME type for file {}: MIME type {}".format(
+ filename, mime_type
+ )
+ )
+
+ special_override_string = ""
+ if override_epa or override_nonepa or override_paravirt:
+ # If override for EPA, non-EPA or paravirt is required, get the descriptor data
+ descriptor_data = None
+ if mime_type in ["application/yaml", "text/plain", "application/json"]:
+ with open(filename) as df:
+ descriptor_data = df.read()
+ elif mime_type in ["application/gzip", "application/x-gzip"]:
+ tar_object = tarfile.open(filename, "r:gz")
+ descriptor_list = []
+ for member in tar_object:
+ if member.isreg():
+ if "/" not in os.path.dirname(
+ member.name
+ ) and member.name.endswith(".yaml"):
+ descriptor_list.append(member.name)
+ if len(descriptor_list) > 1:
+ raise ClientException(
+ "Found more than one potential descriptor in the tar.gz file"
+ )
+ elif len(descriptor_list) == 0:
+ raise ClientException(
+ "No descriptor was found in the tar.gz file"
+ )
+ with tar_object.extractfile(descriptor_list[0]) as df:
+ descriptor_data = df.read()
+ tar_object.close()
+ elif mime_type in ["application/zip"]:
+ package_zip = ZipFile(filename)
+ package_files = package_zip.infolist()
+
+ descriptors = []
+ if (
+ "Definitions" in package_files
+ and "TOSCA-Metadata" in package_files
+ ):
+ descriptors = [
+ definition
+ for definition in package_files
+ if "Definitions/" in definition
+ and (
+ definition.endswith(".yaml")
+ or definition.endswith(".yml")
+ )
+ ]
+ else:
+ descriptors = [
+ definition
+ for definition in package_files
+ if definition.endswith(".yaml")
+ or definition.endswith(".yml")
+ ]
+ if len(descriptors) < 1:
+ raise ClientException(
+ "No descriptor found on this package, OSM was expecting at least 1"
+ )
+ descriptor_data = package_zip.open(descriptors[0])
+ package_zip.close()
+
+ if not descriptor_data:
+ raise ClientException("Descriptor could not be read")
+ desc_type, vnfd = validation_im().yaml_validation(descriptor_data)
+ validation_im().pyangbind_validation(desc_type, vnfd)
+
+ vnfd = yaml.safe_load(descriptor_data)
+ vcd_list = []
+ vdu_list = []
+ for k in vnfd:
+ # Get only the first descriptor in case there are many in the yaml file
+ # k can be vnfd or etsi-nfv-vnfd:vnfd. This check is skipped
+ first_vnfd = vnfd.get(k, {})
+ vcd_list = first_vnfd.get("virtual-compute-desc", [])
+ vdu_list = first_vnfd.get("vdu", [])
+ break
+
+ for vcd_number, vcd in enumerate(vcd_list):
+ if override_epa:
+ virtual_memory = vcd["virtual-memory"]
+ virtual_memory["mempage-size"] = "LARGE"
+ virtual_memory["numa-enabled"] = True
+ virtual_memory["numa-node-policy"] = {
+ "node-cnt": 1,
+ "mem-policy": "STRICT",
+ }
+ virtual_cpu = vcd["virtual-cpu"]
+ virtual_cpu["pinning"] = {
+ "policy": "static",
+ "thread-policy": "PREFER",
+ }
+
+ cpu_override_string = (
+ "virtual-compute-desc.{}.virtual-cpu={};".format(
+ vcd_number, quote(yaml.safe_dump(virtual_cpu))
+ )
+ )
+ memory_override_string = (
+ "virtual-compute-desc.{}.virtual-memory={};".format(
+ vcd_number, quote(yaml.safe_dump(virtual_memory))
+ )
+ )
+ special_override_string = "{}{}{}".format(
+ special_override_string,
+ cpu_override_string,
+ memory_override_string,
+ )
+
+ headers["Query-String-Format"] = "yaml"
+ if override_nonepa:
+ virtual_memory = vcd["virtual-memory"]
+ virtual_memory["mempage-size"] = ""
+ virtual_memory["numa-enabled"] = ""
+ virtual_memory["numa-node-policy"] = {}
+ virtual_cpu = vcd["virtual-cpu"]
+ virtual_cpu["pinning"] = {}
+
+ cpu_override_string = (
+ "virtual-compute-desc.{}.virtual-cpu={};".format(
+ vcd_number, quote(yaml.safe_dump(virtual_cpu))
+ )
+ )
+ memory_override_string = (
+ "virtual-compute-desc.{}.virtual-memory={};".format(
+ vcd_number, quote(yaml.safe_dump(virtual_memory))
+ )
+ )
+ special_override_string = "{}{}{}".format(
+ special_override_string,
+ cpu_override_string,
+ memory_override_string,
+ )
+
+ if override_paravirt:
+ for vdu_number, vdu in enumerate(vdu_list):
+ for cpd_number, cpd in enumerate(vdu["int-cpd"]):
+ for vnir_number, vnir in enumerate(
+ cpd["virtual-network-interface-requirement"]
+ ):
+ special_override_string = (
+ "{}vdu.{}.int-cpd.{}.virtual-network-interface-"
+ "requirement.{}.virtual-interface.type="
+ "PARAVIRT;".format(
+ special_override_string,
+ vdu_number,
+ cpd_number,
+ vnir_number,
+ )
+ )
+
+ special_override_string = special_override_string.rstrip(";")
+
+ headers["Content-File-MD5"] = utils.md5(filename)
+ http_header = [
+ "{}: {}".format(key, val) for (key, val) in list(headers.items())
+ ]
+
+ self._http.set_http_header(http_header)
+ if update_endpoint:
+ http_code, resp = self._http.put_cmd(
+ endpoint=update_endpoint, filename=filename
+ )
+ else:
+ ow_string = ""
+ if special_override_string:
+ if overwrite:
+ overwrite = "{};{}".format(overwrite, special_override_string)
+ else:
+ overwrite = special_override_string
+
+ if overwrite:
+ ow_string = "?{}".format(overwrite)
+ self._apiResource = "/vnf_packages_content"
+ self._apiBase = "{}{}{}".format(
+ self._apiName, self._apiVersion, self._apiResource
+ )
+ endpoint = "{}{}".format(self._apiBase, ow_string)
+ http_code, resp = self._http.post_cmd(
+ endpoint=endpoint, filename=filename
+ )
+
+ if http_code in (200, 201, 202):
+ if resp:
+ resp = json.loads(resp)
+ if not resp or "id" not in resp:
+ raise ClientException(
+ "unexpected response from server: {}".format(resp)
+ )
+ print(resp["id"])
+ elif http_code == 204:
+ print("Updated")
def update(self, name, filename):
+ self._logger.debug("")
+ self._client.get_token()
vnfd = self.get(name)
- endpoint = '{}/{}/vnfd_content'.format(self._apiBase, vnfd['_id'])
+ endpoint = "{}/{}/package_content".format(self._apiBase, vnfd["_id"])
self.create(filename=filename, update_endpoint=endpoint)
-