6 # Licensed under the Apache License, Version 2.0 (the "License"); you may
7 # not use this file except in compliance with the License. You may obtain
8 # a copy of the License at
10 # http://www.apache.org/licenses/LICENSE-2.0
12 # Unless required by applicable law or agreed to in writing, software
13 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
14 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
15 # License for the specific language governing permissions and limitations
18 from osmclient
.common
.exceptions
import ClientException
24 from osm_im
.validation
import Validation
as validation_im
25 from jinja2
import Environment
, PackageLoader
32 class PackageTool(object):
33 def __init__(self
, client
=None):
35 self
._logger
= logging
.getLogger('osmclient')
37 def create(self
, package_type
, base_directory
, package_name
, override
, image
, vdus
, vcpu
, memory
, storage
,
38 interfaces
, vendor
, detailed
, netslice_subnets
, netslice_vlds
):
40 **Create a package descriptor**
43 - package_type: [vnf, ns, nst]
44 - base directory: path of destination folder
45 - package_name: is the name of the package to be created
46 - image: specify the image of the vdu
47 - vcpu: number of virtual cpus of the vdu
48 - memory: amount of memory in MB pf the vdu
49 - storage: amount of storage in GB of the vdu
50 - interfaces: number of interfaces besides management interface
51 - vendor: vendor name of the vnf/ns
52 - detailed: include all possible values for NSD, VNFD, NST
53 - netslice_subnets: number of netslice_subnets for the NST
54 - netslice_vlds: number of virtual link descriptors for the NST
58 self
._logger
.debug("")
59 # print("location: {}".format(osmclient.__path__))
60 file_loader
= PackageLoader("osmclient")
61 env
= Environment(loader
=file_loader
)
62 if package_type
== 'ns':
63 template
= env
.get_template('nsd.yaml.j2')
64 content
= {"name": package_name
, "vendor": vendor
, "vdus": vdus
, "clean": False, "interfaces": interfaces
,
66 elif package_type
== 'vnf':
67 template
= env
.get_template('vnfd.yaml.j2')
68 content
= {"name": package_name
, "vendor": vendor
, "vdus": vdus
, "clean": False, "interfaces": interfaces
,
69 "image": image
, "vcpu": vcpu
, "memory": memory
, "storage": storage
, "detailed": detailed
}
70 elif package_type
== 'nst':
71 template
= env
.get_template('nst.yaml.j2')
72 content
= {"name": package_name
, "vendor": vendor
, "interfaces": interfaces
,
73 "netslice_subnets": netslice_subnets
, "netslice_vlds": netslice_vlds
, "detailed": detailed
}
75 raise ClientException("Wrong descriptor type {}. Options: ns, vnf, nst".format(package_type
))
77 # print("To be rendered: {}".format(content))
78 output
= template
.render(content
)
81 structure
= self
.discover_folder_structure(base_directory
, package_name
, override
)
82 if structure
.get("folders"):
83 self
.create_folders(structure
["folders"], package_type
)
84 if structure
.get("files"):
85 self
.create_files(structure
["files"], output
, package_type
)
88 def validate(self
, base_directory
, recursive
=True):
90 **Validate OSM Descriptors given a path**
93 - base_directory is the root path for all descriptors
95 :return: List of dict of validated descriptors. keys: type, path, valid, error
97 self
._logger
.debug("")
100 descriptors_paths
= [f
for f
in glob
.glob(base_directory
+ "/**/*.yaml", recursive
=recursive
)]
102 descriptors_paths
= [f
for f
in glob
.glob(base_directory
+ "/*.yaml", recursive
=recursive
)]
103 print("Base directory: {}".format(base_directory
))
104 print("{} Descriptors found to validate".format(len(descriptors_paths
)))
105 for desc_path
in descriptors_paths
:
106 with
open(desc_path
) as descriptor_file
:
107 descriptor_data
= descriptor_file
.read()
110 desc_type
, descriptor_data
= validation_im
.yaml_validation(self
, descriptor_data
)
111 validation_im
.pyangbind_validation(self
, desc_type
, descriptor_data
)
112 table
.append({"type": desc_type
, "path": desc_path
, "valid": "OK", "error": "-"})
113 except Exception as e
:
114 table
.append({"type": desc_type
, "path": desc_path
, "valid": "ERROR", "error": str(e
)})
117 def build(self
, package_folder
, skip_validation
=False, skip_charm_build
=False):
119 **Creates a .tar.gz file given a package_folder**
122 - package_folder: is the name of the folder to be packaged
123 - skip_validation: is the flag to validate or not the descriptors on the folder before build
125 :returns: message result for the build process
127 self
._logger
.debug("")
128 package_folder
= package_folder
.rstrip('/')
129 if not os
.path
.exists("{}".format(package_folder
)):
130 return "Fail, package is not in the specified path"
131 if not skip_validation
:
132 print('Validating package {}'.format(package_folder
))
133 results
= self
.validate(package_folder
, recursive
=False)
135 for result
in results
:
136 if result
["valid"] != "OK":
137 raise ClientException("There was an error validating the file {} with error: {}"
138 .format(result
["path"], result
["error"]))
139 print('Validation OK')
141 raise ClientException("No descriptor file found in: {}".format(package_folder
))
142 charm_list
= self
.build_all_charms(package_folder
, skip_charm_build
)
143 return self
.build_tarfile(package_folder
, charm_list
)
145 def calculate_checksum(self
, package_folder
):
147 **Function to calculate the checksum given a folder**
150 - package_folder: is the folder where we have the files to calculate the checksum
153 self
._logger
.debug("")
154 files
= [f
for f
in glob
.glob(package_folder
+ "/**/*.*", recursive
=True) if os
.path
.isfile(f
)]
155 with
open("{}/checksums.txt".format(package_folder
), "w+") as checksum
:
156 for file_item
in files
:
157 if "checksums.txt" in file_item
:
159 # from https://www.quickprogrammingtips.com/python/how-to-calculate-md5-hash-of-a-file-in-python.html
160 md5_hash
= hashlib
.md5()
161 with
open(file_item
, "rb") as f
:
162 # Read and update hash in chunks of 4K
163 for byte_block
in iter(lambda: f
.read(4096), b
""):
164 md5_hash
.update(byte_block
)
165 checksum
.write("{}\t{}\n".format(md5_hash
.hexdigest(), file_item
))
167 def create_folders(self
, folders
, package_type
):
169 **Create folder given a list of folders**
172 - folders: [List] list of folders paths to be created
173 - package_type: is the type of package to be created
177 for folder
in folders
:
179 # print("Folder {} == package_type {}".format(folder[1], package_type))
180 if folder
[1] == package_type
:
181 print("Creating folder:\t{}".format(folder
[0]))
182 os
.makedirs(folder
[0])
183 except FileExistsError
:
186 def save_file(self
, file_name
, file_body
):
188 **Create a file given a name and the content**
191 - file_name: is the name of the file with the relative route
192 - file_body: is the content of the file
195 print("Creating file: \t{}".format(file_name
))
197 with
open(file_name
, "w+") as f
:
199 except Exception as e
:
200 raise ClientException(e
)
202 def generate_readme(self
):
204 **Creates the README content**
206 :returns: readme content
208 return """# Descriptor created by OSM descriptor package generated\n\n**Created on {} **""".format(
209 time
.strftime("%m/%d/%Y, %H:%M:%S", time
.localtime()))
211 def generate_cloud_init(self
):
213 **Creates the cloud-init content**
215 :returns: cloud-init content
217 return "---\n#cloud-config"
219 def create_files(self
, files
, file_content
, package_type
):
221 **Creates the files given the file list and type**
224 - files: is the list of files structure
225 - file_content: is the content of the descriptor rendered by the template
226 - package_type: is the type of package to filter the creation structure
230 self
._logger
.debug("")
231 for file_item
, file_package
, file_type
in files
:
232 if package_type
== file_package
:
233 if file_type
== "descriptor":
234 self
.save_file(file_item
, file_content
)
235 elif file_type
== "readme":
236 self
.save_file(file_item
, self
.generate_readme())
237 elif file_type
== "cloud_init":
238 self
.save_file(file_item
, self
.generate_cloud_init())
240 def check_files_folders(self
, path_list
, override
):
242 **Find files and folders missing given a directory structure {"folders": [], "files": []}**
245 - path_list: is the list of files and folders to be created
246 - override: is the flag used to indicate the creation of the list even if the file exist to override it
248 :return: Missing paths Dict
250 self
._logger
.debug("")
254 for folder
in path_list
.get("folders"):
255 if not os
.path
.exists(folder
[0]):
256 folders
.append(folder
)
257 missing_paths
["folders"] = folders
259 for file_item
in path_list
.get("files"):
260 if not os
.path
.exists(file_item
[0]) or override
is True:
261 files
.append(file_item
)
262 missing_paths
["files"] = files
266 def build_all_charms(self
, package_folder
, skip_charm_build
):
268 **Read the descriptor file, check that the charms referenced are in the folder and compiles them**
271 - packet_folder: is the location of the package
272 :return: Files and Folders not found. In case of override, it will return all file list
274 self
._logger
.debug("")
276 descriptor_file
= False
277 descriptors_paths
= [f
for f
in glob
.glob(package_folder
+ "/*.yaml")]
278 for file in descriptors_paths
:
279 if file.endswith('nfd.yaml'):
280 descriptor_file
= True
281 listCharms
= self
.charms_search(file, 'vnf')
282 if file.endswith('nsd.yaml'):
283 descriptor_file
= True
284 listCharms
= self
.charms_search(file, 'ns')
285 print("List of charms in the descriptor: {}".format(listCharms
))
286 if not descriptor_file
:
287 raise ClientException ('descriptor name is not correct in: {}'.format(package_folder
))
288 if listCharms
and not skip_charm_build
:
289 for charmName
in listCharms
:
290 if os
.path
.isdir('{}/charms/layers/{}'.format(package_folder
,charmName
)):
291 print('Building charm {}/charms/layers/{}'.format(package_folder
, charmName
))
292 self
.charm_build(package_folder
, charmName
)
293 print('Charm built: {}'.format(charmName
))
295 if not os
.path
.isdir('{}/charms/{}'.format(package_folder
,charmName
)):
296 raise ClientException ('The charm: {} referenced in the descriptor file '
297 'is not present either in {}/charms or in {}/charms/layers'.
298 format(charmName
, package_folder
,package_folder
))
299 self
._logger
.debug("Return list of charms: {}".format(listCharms
))
302 def discover_folder_structure(self
, base_directory
, name
, override
):
304 **Discover files and folders structure for OSM descriptors given a base_directory and name**
307 - base_directory: is the location of the package to be created
308 - name: is the name of the package
309 - override: is the flag used to indicate the creation of the list even if the file exist to override it
310 :return: Files and Folders not found. In case of override, it will return all file list
312 self
._logger
.debug("")
313 prefix
= "{}/{}".format(base_directory
, name
)
314 files_folders
= {"folders": [("{}_ns".format(prefix
), "ns"),
315 ("{}_ns/icons".format(prefix
), "ns"),
316 ("{}_ns/charms".format(prefix
), "ns"),
317 ("{}_vnf".format(name
), "vnf"),
318 ("{}_vnf/charms".format(prefix
), "vnf"),
319 ("{}_vnf/cloud_init".format(prefix
), "vnf"),
320 ("{}_vnf/images".format(prefix
), "vnf"),
321 ("{}_vnf/icons".format(prefix
), "vnf"),
322 ("{}_vnf/scripts".format(prefix
), "vnf"),
323 ("{}_nst".format(prefix
), "nst"),
324 ("{}_nst/icons".format(prefix
), "nst")
326 "files": [("{}_ns/{}_nsd.yaml".format(prefix
, name
), "ns", "descriptor"),
327 ("{}_ns/README.md".format(prefix
), "ns", "readme"),
328 ("{}_vnf/{}_vnfd.yaml".format(prefix
, name
), "vnf", "descriptor"),
329 ("{}_vnf/cloud_init/cloud-config.txt".format(prefix
), "vnf", "cloud_init"),
330 ("{}_vnf/README.md".format(prefix
), "vnf", "readme"),
331 ("{}_nst/{}_nst.yaml".format(prefix
, name
), "nst", "descriptor"),
332 ("{}_nst/README.md".format(prefix
), "nst", "readme")
335 missing_files_folders
= self
.check_files_folders(files_folders
, override
)
336 # print("Missing files and folders: {}".format(missing_files_folders))
337 return missing_files_folders
339 def charm_build(self
, charms_folder
, build_name
):
341 Build the charms inside the package.
342 params: package_folder is the name of the folder where is the charms to compile.
343 build_name is the name of the layer or interface
345 self
._logger
.debug("")
346 os
.environ
['JUJU_REPOSITORY'] = "{}/charms".format(charms_folder
)
347 os
.environ
['CHARM_LAYERS_DIR'] = "{}/layers".format(os
.environ
['JUJU_REPOSITORY'])
348 os
.environ
['CHARM_INTERFACES_DIR'] = "{}/interfaces".format(os
.environ
['JUJU_REPOSITORY'])
349 os
.environ
['CHARM_BUILD_DIR'] = "{}/charms/builds".format(charms_folder
)
350 if not os
.path
.exists(os
.environ
['CHARM_BUILD_DIR']):
351 os
.makedirs(os
.environ
['CHARM_BUILD_DIR'])
352 src_folder
= '{}/{}'.format(os
.environ
['CHARM_LAYERS_DIR'], build_name
)
353 result
= subprocess
.run(["charm", "build", "{}".format(src_folder
)])
354 if result
.returncode
== 1:
355 raise ClientException("failed to build the charm: {}".format(src_folder
))
356 self
._logger
.verbose("charm {} built".format(src_folder
))
358 def build_tarfile(self
, package_folder
, charm_list
=None):
360 Creates a .tar.gz file given a package_folder
361 params: package_folder is the name of the folder to be packaged
362 returns: .tar.gz name
364 self
._logger
.debug("")
367 directory_name
, package_name
= self
.create_temp_dir(package_folder
, charm_list
)
369 os
.chdir(directory_name
)
370 self
.calculate_checksum(package_name
)
371 with tarfile
.open("{}.tar.gz".format(package_name
), mode
='w:gz') as archive
:
372 print("Adding File: {}".format(package_name
))
373 archive
.add('{}'.format(package_name
), recursive
=True)
374 # return "Created {}.tar.gz".format(package_folder)
375 # self.build("{}".format(os.path.basename(package_folder)))
378 created_package
= "{}/{}.tar.gz".format(os
.path
.dirname(package_folder
) or '.', package_name
)
379 os
.rename("{}/{}.tar.gz".format(directory_name
, package_name
),
381 os
.rename("{}/{}/checksums.txt".format(directory_name
, package_name
),
382 "{}/checksums.txt".format(package_folder
))
383 print("Package created: {}".format(created_package
))
384 return created_package
385 except Exception as exc
:
386 raise ClientException('failure during build of targz file (create temp dir, calculate checksum, '
387 'tar.gz file): {}'.format(exc
))
391 shutil
.rmtree(os
.path
.join(package_folder
, "tmp"))
393 def create_temp_dir(self
, package_folder
, charm_list
=None):
395 Method to create a temporary folder where we can move the files in package_folder
397 self
._logger
.debug("")
398 ignore_patterns
= ('.gitignore')
399 ignore
= shutil
.ignore_patterns(ignore_patterns
)
400 directory_name
= os
.path
.abspath(package_folder
)
401 package_name
= os
.path
.basename(directory_name
)
402 directory_name
+= "/tmp"
403 os
.makedirs("{}/{}".format(directory_name
, package_name
), exist_ok
=True)
404 self
._logger
.debug("Makedirs DONE: {}/{}".format(directory_name
, package_name
))
405 for item
in os
.listdir(package_folder
):
406 self
._logger
.debug("Item: {}".format(item
))
408 s
= os
.path
.join(package_folder
, item
)
409 d
= os
.path
.join(os
.path
.join(directory_name
, package_name
), item
)
412 os
.makedirs(d
, exist_ok
=True)
413 s_builds
= os
.path
.join(s
, "builds")
414 for charm
in charm_list
:
415 self
._logger
.debug("Copying charm {}".format(charm
))
416 if charm
in os
.listdir(s
):
417 s_charm
= os
.path
.join(s
, charm
)
418 elif charm
in os
.listdir(s_builds
):
419 s_charm
= os
.path
.join(s_builds
, charm
)
421 raise ClientException('The charm {} referenced in the descriptor file '
422 'could not be found in {}/charms or in {}/charms/builds'.
423 format(charm
, package_folder
, package_folder
))
424 d_temp
= os
.path
.join(d
, charm
)
425 self
._logger
.debug("Copying tree: {} -> {}".format(s_charm
, d_temp
))
426 shutil
.copytree(s_charm
, d_temp
, symlinks
=True, ignore
=ignore
)
427 self
._logger
.debug("DONE")
429 self
._logger
.debug("Copying tree: {} -> {}".format(s
,d
))
430 shutil
.copytree(s
, d
, symlinks
=True, ignore
=ignore
)
431 self
._logger
.debug("DONE")
433 if item
in ignore_patterns
:
435 self
._logger
.debug("Copying file: {} -> {}".format(s
,d
))
437 self
._logger
.debug("DONE")
438 return directory_name
, package_name
440 def charms_search(self
, descriptor_file
, desc_type
):
441 self
._logger
.debug("")
442 with
open("{}".format(descriptor_file
)) as yaml_desc
:
443 descriptor_dict
= yaml
.safe_load(yaml_desc
)
444 if "catalog" in descriptor_dict
: # Match OSM-IM vnfd-catalog and nsd-catalog
445 charms_list
= self
._charms
_search
_on
_osm
_im
_dict
(descriptor_dict
, desc_type
)
447 charms_list
= self
._charms
_search
_on
_sol
006_dict
(descriptor_dict
, desc_type
)
451 def _charms_search_on_osm_im_dict(self
, osm_im_dict
, desc_type
):
453 for k1
, v1
in osm_im_dict
.items():
454 for k2
, v2
in v1
.items():
456 if '{}-configuration'.format(desc_type
) in entry
:
457 vnf_config
= entry
['{}-configuration'.format(desc_type
)]
458 for k3
, v3
in vnf_config
.items():
460 charms_list
.append((v3
['charm']))
464 if 'vdu-configuration' in vdu
:
465 for k4
, v4
in vdu
['vdu-configuration'].items():
467 charms_list
.append((v4
['charm']))
470 def _charms_search_on_sol006_dict(self
, sol006_dict
, desc_type
):
472 for k1
, v1
in sol006_dict
.items():
473 for k2
, v2
in v1
.items():
474 if '{}-configuration'.format(desc_type
) in k2
:
475 for vnf_config
in v2
:
476 for k3
, v3
in vnf_config
.items():
478 charms_list
.append((v3
['charm']))
479 if 'vdu-configuration' in k2
:
480 for vdu_config
in v2
:
481 for k3
, v3
in vdu_config
.items():
483 charms_list
.append((v3
['charm']))