osm_common/sol007_package.py

   1 # -*- coding: utf-8 -*-
   2
   3 # Copyright 2021 Whitestack, LLC
   4 # *************************************************************
   5 #
   6 # This file is part of OSM common repository.
   7 # All Rights Reserved to Whitestack, LLC
   8 #
   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
  12 #
  13 #         http://www.apache.org/licenses/LICENSE-2.0
  14 #
  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
  19 # under the License.
  20 #
  21 # For those usages not covered by the Apache License, Version 2.0 please
  22 # contact: fbravo@whitestack.com
  23 ##
  24
  25 """Python module for interacting with ETSI GS NFV-SOL007 compliant packages
  26
  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:
  30
  31 SOL007 with metadata directory    SOL007 without metadata directory
  32
  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
  39 ├── Files                         ├── Files
  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
  48     └── charms                                ├── hooks
  49         └── simple                            │   ├── install
  50             ├── config.yaml                  ...
  51             ├── hooks                         │
  52             │   ├── install                   └── src
  53            ...                                    └── charm.py
  54             └── src
  55                 └── charm.py
  56 """
  57
  58 import yaml
  59 import datetime
  60 import os
  61 from .sol_package import SOLPackage
  62
  63
  64 class SOL007PackageException(Exception):
  65     pass
  66
  67
  68 class SOL007Package(SOLPackage):
  69     _MANIFEST_NSD_INVARIANT_ID = "nsd_invariant_id"
  70     _MANIFEST_NSD_NAME = "nsd_name"
  71     _MANIFEST_NSD_DESIGNER = "nsd_designer"
  72     _MANIFEST_NSD_FILE_STRUCTURE_VERSION = "nsd_file_structure_version"
  73     _MANIFEST_NSD_RELEASE_DATE_TIME = "nsd_release_date_time"
  74     _MANIFEST_NSD_COMPATIBLE_SPECIFICATION_VERSIONS = (
  75         "compatible_specification_versions"
  76     )
  77
  78     _MANIFEST_ALL_FIELDS = [
  79         _MANIFEST_NSD_INVARIANT_ID,
  80         _MANIFEST_NSD_NAME,
  81         _MANIFEST_NSD_DESIGNER,
  82         _MANIFEST_NSD_FILE_STRUCTURE_VERSION,
  83         _MANIFEST_NSD_RELEASE_DATE_TIME,
  84         _MANIFEST_NSD_COMPATIBLE_SPECIFICATION_VERSIONS,
  85     ]
  86
  87     def __init__(self, package_path=""):
  88         super().__init__(package_path)
  89
  90     def generate_manifest_data_from_descriptor(self):
  91         descriptor_path = os.path.join(
  92             self._package_path, self.get_descriptor_location()
  93         )
  94         with open(descriptor_path, "r") as descriptor:
  95             try:
  96                 nsd_data = yaml.safe_load(descriptor)["nsd"]
  97             except yaml.YAMLError as e:
  98                 print("Error reading descriptor {}: {}".format(descriptor_path, e))
  99                 return
 100
 101             self._manifest_metadata = {}
 102             self._manifest_metadata[self._MANIFEST_NSD_INVARIANT_ID] = nsd_data.get(
 103                 "id", "default-id"
 104             )
 105             self._manifest_metadata[self._MANIFEST_NSD_NAME] = nsd_data.get(
 106                 "name", "default-name"
 107             )
 108             self._manifest_metadata[self._MANIFEST_NSD_DESIGNER] = nsd_data.get(
 109                 "designer", "OSM"
 110             )
 111             self._manifest_metadata[
 112                 self._MANIFEST_NSD_FILE_STRUCTURE_VERSION
 113             ] = nsd_data.get("version", "1.0")
 114             self._manifest_metadata[self._MANIFEST_NSD_RELEASE_DATE_TIME] = (
 115                 datetime.datetime.now().astimezone().isoformat()
 116             )
 117             self._manifest_metadata[
 118                 self._MANIFEST_NSD_COMPATIBLE_SPECIFICATION_VERSIONS
 119             ] = "2.7.1"