1 # -*- coding: utf-8 -*-
3 # Copyright 2021 Whitestack, LLC
4 # *************************************************************
6 # This file is part of OSM common repository.
7 # All Rights Reserved to Whitestack, LLC
9 # Licensed under the Apache License, Version 2.0 (the "License"); you may
10 # not use this file except in compliance with the License. You may obtain
11 # a copy of the License at
13 # http://www.apache.org/licenses/LICENSE-2.0
15 # Unless required by applicable law or agreed to in writing, software
16 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
17 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
18 # License for the specific language governing permissions and limitations
21 # For those usages not covered by the Apache License, Version 2.0 please
22 # contact: fbravo@whitestack.com
25 """Python module for interacting with ETSI GS NFV-SOL007 compliant packages
27 This module provides a SOL007Package class for validating and interacting with
28 ETSI SOL007 packages. A valid SOL007 package may have its files arranged according
29 to one of the following two structures:
31 SOL007 with metadata directory SOL007 without metadata directory
33 native_charm_vnf/ native_charm_vnf/
34 ├── TOSCA-Metadata ├── native_charm_nsd.mf
35 │ └── TOSCA.meta ├── native_charm_nsd.yaml
36 ├── manifest.mf ├── ChangeLog.txt
37 ├── Definitions ├── Licenses
38 │ └── native_charm_nsd.yaml │ └── license.lic
40 │ ├── icons │ └── icons
41 │ │ └── osm.png │ └── osm.png
42 │ ├── Licenses └── Scripts
43 │ │ └── license.lic ├── cloud_init
44 │ └── changelog.txt │ └── cloud-config.txt
45 └── Scripts └── charms
46 ├── cloud_init └── simple
47 │ └── cloud-config.txt ├── config.yaml
49 └── simple │ ├── install
63 from .sol_package
import SOLPackage
66 class SOL007PackageException(Exception):
70 class SOL007Package(SOLPackage
):
71 _MANIFEST_NSD_INVARIANT_ID
= "nsd_invariant_id"
72 _MANIFEST_NSD_NAME
= "nsd_name"
73 _MANIFEST_NSD_DESIGNER
= "nsd_designer"
74 _MANIFEST_NSD_FILE_STRUCTURE_VERSION
= "nsd_file_structure_version"
75 _MANIFEST_NSD_RELEASE_DATE_TIME
= "nsd_release_date_time"
76 _MANIFEST_NSD_COMPATIBLE_SPECIFICATION_VERSIONS
= (
77 "compatible_specification_versions"
80 _MANIFEST_ALL_FIELDS
= [
81 _MANIFEST_NSD_INVARIANT_ID
,
83 _MANIFEST_NSD_DESIGNER
,
84 _MANIFEST_NSD_FILE_STRUCTURE_VERSION
,
85 _MANIFEST_NSD_RELEASE_DATE_TIME
,
86 _MANIFEST_NSD_COMPATIBLE_SPECIFICATION_VERSIONS
,
89 def __init__(self
, package_path
=""):
90 super().__init
__(package_path
)
92 def generate_manifest_data_from_descriptor(self
):
93 descriptor_path
= os
.path
.join(
94 self
._package
_path
, self
.get_descriptor_location()
96 with
open(descriptor_path
, "r") as descriptor
:
98 nsd_data
= yaml
.safe_load(descriptor
)["nsd"]
99 except yaml
.YAMLError
as e
:
100 print("Error reading descriptor {}: {}".format(descriptor_path
, e
))
103 self
._manifest
_metadata
= {}
104 self
._manifest
_metadata
[self
._MANIFEST
_NSD
_INVARIANT
_ID
] = nsd_data
.get(
107 self
._manifest
_metadata
[self
._MANIFEST
_NSD
_NAME
] = nsd_data
.get(
108 "name", "default-name"
110 self
._manifest
_metadata
[self
._MANIFEST
_NSD
_DESIGNER
] = nsd_data
.get(
113 self
._manifest
_metadata
[
114 self
._MANIFEST
_NSD
_FILE
_STRUCTURE
_VERSION
115 ] = nsd_data
.get("version", "1.0")
116 self
._manifest
_metadata
[self
._MANIFEST
_NSD
_RELEASE
_DATE
_TIME
] = (
117 datetime
.datetime
.now().astimezone().isoformat()
119 self
._manifest
_metadata
[
120 self
._MANIFEST
_NSD
_COMPATIBLE
_SPECIFICATION
_VERSIONS