osm_lcm/tests/test_ns.py

   1 #
   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
   5 #
   6 #         http://www.apache.org/licenses/LICENSE-2.0
   7 #
   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
  12 # under the License.
  13 #
  14 # For those usages not covered by the Apache License, Version 2.0 please
  15 # contact: alfonso.tiernosepulveda@telefonica.com
  16 ##
  17
  18
  19 import asynctest   # pip3 install asynctest --user
  20 import asyncio
  21 import yaml
  22 from os import getenv
  23 from osm_lcm import ns
  24 from osm_common.dbmemory import DbMemory
  25 from osm_common.msgkafka import MsgKafka
  26 from osm_common.fslocal import FsLocal
  27 from osm_lcm.lcm_utils import TaskRegistry
  28 from osm_lcm.ROclient import ROClient
  29 from uuid import uuid4
  30
  31 from osm_lcm.tests import test_db_descriptors as descriptors
  32
  33 __author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
  34
  35 """ Perform unittests using asynctest of osm_lcm.ns module
  36 It allows, if some testing ENV are supplied, testing without mocking some external libraries for debugging:
  37     OSMLCMTEST_NS_PUBKEY: public ssh-key returned by N2VC to inject to VMs
  38     OSMLCMTEST_NS_NAME: change name of NS
  39     OSMLCMTEST_PACKAGES_PATH: path where the vnf-packages are stored (de-compressed), each one on a 'vnfd_id' folder
  40     OSMLCMTEST_NS_IPADDRESS: IP address where emulated VMs are reached. Comma separate list
  41     OSMLCMTEST_RO_VIMID: VIM id of RO target vim IP. Obtain it with openmano datcenter-list on RO container
  42     OSMLCMTEST_VCA_NOMOCK: Do no mock the VCA, N2VC library, for debugging it
  43     OSMLCMTEST_RO_NOMOCK: Do no mock the ROClient library, for debugging it
  44     OSMLCMTEST_DB_NOMOCK: Do no mock the database library, for debugging it
  45     OSMLCMTEST_FS_NOMOCK: Do no mock the File Storage library, for debugging it
  46     OSMLCMTEST_LOGGING_NOMOCK: Do no mock the logging
  47     OSMLCM_VCA_XXX: configuration of N2VC
  48     OSMLCM_RO_XXX: configuration of RO
  49 """
  50
  51 lcm_config = {
  52     "timeout": {},
  53     "VCA": {   # TODO replace with os.get_env to get other configurations
  54         "host": getenv("OSMLCM_VCA_HOST", "vca"),
  55         "port": getenv("OSMLCM_VCA_PORT", 17070),
  56         "user": getenv("OSMLCM_VCA_USER", "admin"),
  57         "secret": getenv("OSMLCM_VCA_SECRET", "vca"),
  58         "public_key": getenv("OSMLCM_VCA_PUBKEY", None),
  59         'ca_cert': getenv("OSMLCM_VCA_CACERT", None),
  60         'apiproxy': getenv("OSMLCM_VCA_APIPROXY", "192.168.1.1"),
  61     },
  62     "ro_config": {
  63         "uri": "http://{}:{}/openmano".format(getenv("OSMLCM_RO_HOST", "ro"),
  64                                               getenv("OSMLCM_RO_PORT", "9090")),
  65         "tenant": getenv("OSMLCM_RO_TENANT", "osm"),
  66         "logger_name": "lcm.ROclient",
  67         "loglevel": "DEBUG",
  68     }
  69 }
  70
  71
  72 class TestMyNS(asynctest.TestCase):
  73
  74     async def _n2vc_DeployCharms(self, model_name, application_name, vnfd, charm_path, params={}, machine_spec={},
  75                                  callback=None, *callback_args):
  76         if callback:
  77             for status, message in (("maintenance", "installing sofwware"), ("active", "Ready!")):
  78                 # call callback after some time
  79                 asyncio.sleep(5, loop=self.loop)
  80                 callback(model_name, application_name, status, message, *callback_args)
  81
  82     @staticmethod
  83     def _n2vc_FormatApplicationName(*args):
  84         num_calls = 0
  85         while True:
  86             yield "app_name-{}".format(num_calls)
  87             num_calls += 1
  88
  89     def _n2vc_CreateExecutionEnvironment(self, namespace, reuse_ee_id, db_dict, *args, **kwargs):
  90         k_list = namespace.split(".")
  91         ee_id = k_list[1] + "."
  92         if len(k_list) >= 2:
  93             for k in k_list[2:4]:
  94                 ee_id += k[:8]
  95         else:
  96             ee_id += "_NS_"
  97         return ee_id, {}
  98
  99     def _ro_show(self, *args, **kwargs):
 100         if kwargs.get("delete"):
 101             ro_ns_desc = yaml.load(descriptors.ro_delete_action_text, Loader=yaml.Loader)
 102             while True:
 103                 yield ro_ns_desc
 104
 105         ro_ns_desc = yaml.load(descriptors.ro_ns_text, Loader=yaml.Loader)
 106
 107         # if ip address provided, replace descriptor
 108         ip_addresses = getenv("OSMLCMTEST_NS_IPADDRESS", "")
 109         if ip_addresses:
 110             ip_addresses_list = ip_addresses.split(",")
 111             for vnf in ro_ns_desc["vnfs"]:
 112                 if not ip_addresses_list:
 113                     break
 114                 vnf["ip_address"] = ip_addresses_list[0]
 115                 for vm in vnf["vms"]:
 116                     if not ip_addresses_list:
 117                         break
 118                     vm["ip_address"] = ip_addresses_list.pop(0)
 119
 120         while True:
 121             yield ro_ns_desc
 122             for net in ro_ns_desc["nets"]:
 123                 if net["status"] != "ACTIVE":
 124                     net["status"] = "ACTIVE"
 125                     break
 126             else:
 127                 for vnf in ro_ns_desc["vnfs"]:
 128                     for vm in vnf["vms"]:
 129                         if vm["status"] != "ACTIVE":
 130                             vm["status"] = "ACTIVE"
 131                             break
 132
 133     def _ro_create(self, *args, **kwargs):
 134         while True:
 135             yield {"uuid": str(uuid4())}
 136
 137     def _return_uuid(self, *args, **kwargs):
 138         return str(uuid4())
 139
 140     async def setUp(self):
 141
 142         # Mock DB
 143         if not getenv("OSMLCMTEST_DB_NOMOCK"):
 144             self.db = DbMemory()
 145             self.db.create_list("vnfds", yaml.load(descriptors.db_vnfds_text, Loader=yaml.Loader))
 146             self.db.create_list("nsds", yaml.load(descriptors.db_nsds_text, Loader=yaml.Loader))
 147             self.db.create_list("nsrs", yaml.load(descriptors.db_nsrs_text, Loader=yaml.Loader))
 148             self.db.create_list("vim_accounts", yaml.load(descriptors.db_vim_accounts_text, Loader=yaml.Loader))
 149             self.db.create_list("k8sclusters", yaml.load(descriptors.db_k8sclusters_text, Loader=yaml.Loader))
 150             self.db.create_list("nslcmops", yaml.load(descriptors.db_nslcmops_text, Loader=yaml.Loader))
 151             self.db.create_list("vnfrs", yaml.load(descriptors.db_vnfrs_text, Loader=yaml.Loader))
 152             self.db_vim_accounts = yaml.load(descriptors.db_vim_accounts_text, Loader=yaml.Loader)
 153
 154         # Mock kafka
 155         self.msg = asynctest.Mock(MsgKafka())
 156
 157         # Mock filesystem
 158         if not getenv("OSMLCMTEST_FS_NOMOCK"):
 159             self.fs = asynctest.Mock(FsLocal())
 160             self.fs.get_params.return_value = {"path": getenv("OSMLCMTEST_PACKAGES_PATH", "./test/temp/packages")}
 161             self.fs.file_open = asynctest.mock_open()
 162             # self.fs.file_open.return_value.__enter__.return_value = asynctest.MagicMock()  # called on a python "with"
 163             # self.fs.file_open.return_value.__enter__.return_value.read.return_value = ""   # empty file
 164
 165         # Mock TaskRegistry
 166         self.lcm_tasks = asynctest.Mock(TaskRegistry())
 167         self.lcm_tasks.lock_HA.return_value = True
 168         self.lcm_tasks.waitfor_related_HA.return_value = None
 169         self.lcm_tasks.lookfor_related.return_value = ("", [])
 170
 171         # Mock VCA - K8s
 172         if not getenv("OSMLCMTEST_VCA_K8s_NOMOCK"):
 173             ns.K8sJujuConnector = asynctest.MagicMock(ns.K8sJujuConnector)
 174             ns.K8sHelmConnector = asynctest.MagicMock(ns.K8sHelmConnector)
 175             ns.K8sHelm3Connector = asynctest.MagicMock(ns.K8sHelm3Connector)
 176
 177         if not getenv("OSMLCMTEST_VCA_NOMOCK"):
 178             ns.N2VCJujuConnector = asynctest.MagicMock(ns.N2VCJujuConnector)
 179             ns.N2VCJujuConnectorLCM = asynctest.MagicMock(ns.N2VCJujuConnectorLCM)
 180             ns.LCMHelmConn = asynctest.MagicMock(ns.LCMHelmConn)
 181
 182         # Create NsLCM class
 183         self.my_ns = ns.NsLcm(self.db, self.msg, self.fs, self.lcm_tasks, lcm_config, self.loop)
 184         self.my_ns._wait_dependent_n2vc = asynctest.CoroutineMock()
 185
 186         # Mock logging
 187         if not getenv("OSMLCMTEST_LOGGING_NOMOCK"):
 188             self.my_ns.logger = asynctest.Mock(self.my_ns.logger)
 189
 190         # Mock VCA - N2VC
 191         if not getenv("OSMLCMTEST_VCA_NOMOCK"):
 192             pub_key = getenv("OSMLCMTEST_NS_PUBKEY", "ssh-rsa test-pub-key t@osm.com")
 193             # self.my_ns.n2vc = asynctest.Mock(N2VC())
 194             self.my_ns.n2vc.GetPublicKey.return_value = getenv("OSMLCM_VCA_PUBKEY", "public_key")
 195             # allow several versions of n2vc
 196             self.my_ns.n2vc.FormatApplicationName = asynctest.Mock(side_effect=self._n2vc_FormatApplicationName())
 197             self.my_ns.n2vc.DeployCharms = asynctest.CoroutineMock(side_effect=self._n2vc_DeployCharms)
 198             self.my_ns.n2vc.create_execution_environment = asynctest.CoroutineMock(
 199                 side_effect=self._n2vc_CreateExecutionEnvironment)
 200             self.my_ns.n2vc.install_configuration_sw = asynctest.CoroutineMock(return_value=pub_key)
 201             self.my_ns.n2vc.get_ee_ssh_public__key = asynctest.CoroutineMock(return_value=pub_key)
 202             self.my_ns.n2vc.exec_primitive = asynctest.CoroutineMock(side_effect=self._return_uuid)
 203             self.my_ns.n2vc.exec_primitive = asynctest.CoroutineMock(side_effect=self._return_uuid)
 204             self.my_ns.n2vc.GetPrimitiveStatus = asynctest.CoroutineMock(return_value="completed")
 205             self.my_ns.n2vc.GetPrimitiveOutput = asynctest.CoroutineMock(return_value={"result": "ok",
 206                                                                                        "pubkey": pub_key})
 207             self.my_ns.n2vc.delete_execution_environment = asynctest.CoroutineMock(return_value=None)
 208             self.my_ns.n2vc.get_public_key = asynctest.CoroutineMock(
 209                 return_value=getenv("OSMLCM_VCA_PUBKEY", "public_key"))
 210             self.my_ns.n2vc.delete_namespace = asynctest.CoroutineMock(return_value=None)
 211
 212         # Mock RO
 213         if not getenv("OSMLCMTEST_RO_NOMOCK"):
 214             # self.my_ns.RO = asynctest.Mock(ROclient.ROClient(self.loop, **lcm_config["ro_config"]))
 215             # TODO first time should be empty list, following should return a dict
 216             self.my_ns.RO.get_list = asynctest.CoroutineMock(self.my_ns.RO.get_list, return_value=[])
 217             self.my_ns.RO.create = asynctest.CoroutineMock(self.my_ns.RO.create, side_effect=self._ro_create())
 218             self.my_ns.RO.show = asynctest.CoroutineMock(self.my_ns.RO.show, side_effect=self._ro_show())
 219             self.my_ns.RO.create_action = asynctest.CoroutineMock(self.my_ns.RO.create_action,
 220                                                                   return_value={"vm-id": {"vim_result": 200,
 221                                                                                           "description": "done"}})
 222             self.my_ns.RO.delete = asynctest.CoroutineMock(self.my_ns.RO.delete, return_value={"action_id": "del"})
 223             # self.my_ns.wait_vm_up_insert_key_ro = asynctest.CoroutineMock(return_value="ip-address")
 224
 225     @asynctest.fail_on(active_handles=True)   # all async tasks must be completed
 226     async def test_instantiate(self):
 227         self.db.set_one = asynctest.Mock()
 228         nsr_id = descriptors.test_ids["TEST-A"]["ns"]
 229         nslcmop_id = descriptors.test_ids["TEST-A"]["instantiate"]
 230         # print("Test instantiate started")
 231
 232         # delete deployed information of database
 233         if not getenv("OSMLCMTEST_DB_NOMOCK"):
 234             if self.db.get_list("nsrs")[0]["_admin"].get("deployed"):
 235                 del self.db.get_list("nsrs")[0]["_admin"]["deployed"]
 236             for db_vnfr in self.db.get_list("vnfrs"):
 237                 db_vnfr.pop("ip_address", None)
 238                 for db_vdur in db_vnfr["vdur"]:
 239                     db_vdur.pop("ip_address", None)
 240                     db_vdur.pop("mac_address", None)
 241             if getenv("OSMLCMTEST_RO_VIMID"):
 242                 self.db.get_list("vim_accounts")[0]["_admin"]["deployed"]["RO"] = getenv("OSMLCMTEST_RO_VIMID")
 243             if getenv("OSMLCMTEST_RO_VIMID"):
 244                 self.db.get_list("nsrs")[0]["_admin"]["deployed"]["RO"] = getenv("OSMLCMTEST_RO_VIMID")
 245
 246         await self.my_ns.instantiate(nsr_id, nslcmop_id)
 247
 248         # print("instantiate_result: {}".format(self.db.get_one("nslcmops",
 249         # {"_id": nslcmop_id}).get("detailed-status")))
 250
 251         self.msg.aiowrite.assert_called_once_with("ns", "instantiated",
 252                                                   {"nsr_id": nsr_id, "nslcmop_id": nslcmop_id,
 253                                                    "operationState": "COMPLETED"},
 254                                                   loop=self.loop)
 255         self.lcm_tasks.lock_HA.assert_called_once_with('ns', 'nslcmops', nslcmop_id)
 256         if not getenv("OSMLCMTEST_LOGGING_NOMOCK"):
 257             self.assertTrue(self.my_ns.logger.debug.called, "Debug method not called")
 258             self.my_ns.logger.error.assert_not_called()
 259             self.my_ns.logger.exception().assert_not_called()
 260
 261         if not getenv("OSMLCMTEST_DB_NOMOCK"):
 262             self.assertTrue(self.db.set_one.called, "db.set_one not called")
 263             db_nsr = self.db.get_one("nsrs", {"_id": nsr_id})
 264             db_vnfrs_list = self.db.get_list("vnfrs", {"nsr-id-ref": nsr_id})
 265             self.assertEqual(db_nsr["_admin"].get("nsState"), "INSTANTIATED", "Not instantiated")
 266             for vnfr in db_vnfrs_list:
 267                 self.assertEqual(vnfr["_admin"].get("nsState"), "INSTANTIATED", "Not instantiated")
 268
 269         if not getenv("OSMLCMTEST_VCA_NOMOCK"):
 270             # check intial-primitives called
 271             self.assertTrue(self.my_ns.n2vc.exec_primitive.called,
 272                             "Exec primitive not called for initial config primitive")
 273             for _call in self.my_ns.n2vc.exec_primitive.call_args_list:
 274                 self.assertIn(_call[1]["primitive_name"], ("config", "touch"),
 275                               "called exec primitive with a primitive different than config or touch")
 276
 277         # TODO add more checks of called methods
 278         # TODO add a terminate
 279
 280     async def test_instantiate_ee_list(self):
 281         # Using modern IM where configuration is in the new format of execution_environment_list
 282         ee_descriptor_id = "charm_simple"
 283         non_used_initial_primitive = {
 284             "name": "not_to_be_called",
 285             "seq": 3,
 286             "execution-environment-ref": "not_used_ee"
 287         }
 288         ee_list = [
 289             {
 290                 "id": ee_descriptor_id,
 291                 "juju": {"charm": "simple"},
 292
 293             },
 294         ]
 295
 296         self.db.set_one(
 297             "vnfds",
 298             q_filter={"_id": "7637bcf8-cf14-42dc-ad70-c66fcf1e6e77"},
 299             update_dict={"vnf-configuration.execution-environment-list": ee_list,
 300                          "vnf-configuration.initial-config-primitive.0.execution-environment-ref": ee_descriptor_id,
 301                          "vnf-configuration.initial-config-primitive.1.execution-environment-ref": ee_descriptor_id,
 302                          "vnf-configuration.initial-config-primitive.2": non_used_initial_primitive,
 303                          "vnf-configuration.config-primitive.0.execution-environment-ref": ee_descriptor_id,
 304                          "vnf-configuration.config-primitive.0.execution-environment-primitive": "touch_charm",
 305                          },
 306             unset={"vnf-configuration.juju": None})
 307         await self.test_instantiate()
 308         # this will check that the initial-congig-primitive 'not_to_be_called' is not called
 309
 310     def test_ns_params_2_RO(self):
 311         vims = self.db.get_list("vim_accounts")
 312         vim_id = vims[0]["_id"]
 313         ro_vim_id = vims[0]["_admin"]["deployed"]["RO"]
 314         vim_id2 = vims[1]["_id"]
 315         ro_vim_id2 = vims[1]["_admin"]["deployed"]["RO"]
 316
 317         ns_params = {"vimAccountId": vim_id}
 318         mgmt_interface = {"cp": "cp"}
 319         vdu = [{"id": "vdu_id", "interface": [{"external-connection-point-ref": "cp"}]}]
 320         vnfd_dict = {
 321             "1": {"vdu": vdu, "mgmt-interface": mgmt_interface},
 322             "2": {"vdu": vdu, "mgmt-interface": mgmt_interface, "vnf-configuration": None},
 323             "3": {"vdu": vdu, "mgmt-interface": mgmt_interface, "vnf-configuration": {"config-access": None}},
 324             "4": {"vdu": vdu, "mgmt-interface": mgmt_interface,
 325                   "vnf-configuration": {"config-access": {"ssh-access": None}}},
 326             "5": {"vdu": vdu, "mgmt-interface": mgmt_interface,
 327                   "vnf-configuration": {"config-access": {"ssh-access": {"required": True, "default_user": "U"}}}},
 328         }
 329         nsd = {"constituent-vnfd": []}
 330         db_vnfrs = {}
 331         for k in vnfd_dict.keys():
 332             nsd["constituent-vnfd"].append({"vnfd-id-ref": k, "member-vnf-index": "member " + k})
 333             db_vnfrs["member " + k] = {"vim-account-id": vim_id2 if k == "1" else vim_id}
 334
 335         n2vc_key_list = ["key"]
 336         ro_ns_params = self.my_ns._ns_params_2_RO(ns_params, nsd, vnfd_dict, db_vnfrs, n2vc_key_list)
 337         ro_params_expected = {'wim_account': None, "datacenter": ro_vim_id,
 338                               "vnfs": {
 339                                   "member 5": {"vdus": {"vdu_id": {"mgmt_keys": n2vc_key_list}}},
 340                                   "member 1": {"datacenter": ro_vim_id2}
 341                               }}
 342         self.assertEqual(ro_ns_params, ro_params_expected)
 343
 344     # Test scale() and related methods
 345     @asynctest.fail_on(active_handles=True)   # all async tasks must be completed
 346     async def test_scale(self):
 347         # print("Test scale started")
 348
 349         # TODO: Add more higher-lever tests here, for example:
 350         # scale-out/scale-in operations with success/error result
 351
 352         # Test scale() with missing 'scaleVnfData', should return operationState = 'FAILED'
 353         nsr_id = descriptors.test_ids["TEST-A"]["ns"]
 354         nslcmop_id = descriptors.test_ids["TEST-A"]["instantiate"]
 355         await self.my_ns.scale(nsr_id, nslcmop_id)
 356         expected_value = 'FAILED'
 357         return_value = self.db.get_one("nslcmops", {"_id": nslcmop_id}).get("operationState")
 358         self.assertEqual(return_value, expected_value)
 359         # print("scale_result: {}".format(self.db.get_one("nslcmops", {"_id": nslcmop_id}).get("detailed-status")))
 360
 361     # Test _retry_or_skip_suboperation()
 362     # Expected result:
 363     # - if a suboperation's 'operationState' is marked as 'COMPLETED', SUBOPERATION_STATUS_SKIP is expected
 364     # - if marked as anything but 'COMPLETED', the suboperation index is expected
 365     def test_scale_retry_or_skip_suboperation(self):
 366         # Load an alternative 'nslcmops' YAML for this test
 367         nslcmop_id = descriptors.test_ids["TEST-A"]["instantiate"]
 368         db_nslcmop = self.db.get_one('nslcmops', {"_id": nslcmop_id})
 369         op_index = 2
 370         # Test when 'operationState' is 'COMPLETED'
 371         db_nslcmop['_admin']['operations'][op_index]['operationState'] = 'COMPLETED'
 372         return_value = self.my_ns._retry_or_skip_suboperation(db_nslcmop, op_index)
 373         expected_value = self.my_ns.SUBOPERATION_STATUS_SKIP
 374         self.assertEqual(return_value, expected_value)
 375         # Test when 'operationState' is not 'COMPLETED'
 376         db_nslcmop['_admin']['operations'][op_index]['operationState'] = None
 377         return_value = self.my_ns._retry_or_skip_suboperation(db_nslcmop, op_index)
 378         expected_value = op_index
 379         self.assertEqual(return_value, expected_value)
 380
 381     # Test _find_suboperation()
 382     # Expected result: index of the found sub-operation, or SUBOPERATION_STATUS_NOT_FOUND if not found
 383     def test_scale_find_suboperation(self):
 384         # Load an alternative 'nslcmops' YAML for this test
 385         nslcmop_id = descriptors.test_ids["TEST-A"]["instantiate"]
 386         db_nslcmop = self.db.get_one('nslcmops', {"_id": nslcmop_id})
 387         # Find this sub-operation
 388         op_index = 2
 389         vnf_index = db_nslcmop['_admin']['operations'][op_index]['member_vnf_index']
 390         primitive = db_nslcmop['_admin']['operations'][op_index]['primitive']
 391         primitive_params = db_nslcmop['_admin']['operations'][op_index]['primitive_params']
 392         match = {
 393             'member_vnf_index': vnf_index,
 394             'primitive': primitive,
 395             'primitive_params': primitive_params,
 396         }
 397         found_op_index = self.my_ns._find_suboperation(db_nslcmop, match)
 398         self.assertEqual(found_op_index, op_index)
 399         # Test with not-matching params
 400         match = {
 401             'member_vnf_index': vnf_index,
 402             'primitive': '',
 403             'primitive_params': primitive_params,
 404         }
 405         found_op_index = self.my_ns._find_suboperation(db_nslcmop, match)
 406         self.assertEqual(found_op_index, self.my_ns.SUBOPERATION_STATUS_NOT_FOUND)
 407         # Test with None
 408         match = None
 409         found_op_index = self.my_ns._find_suboperation(db_nslcmop, match)
 410         self.assertEqual(found_op_index, self.my_ns.SUBOPERATION_STATUS_NOT_FOUND)
 411
 412     # Test _update_suboperation_status()
 413     def test_scale_update_suboperation_status(self):
 414         self.db.set_one = asynctest.Mock()
 415         nslcmop_id = descriptors.test_ids["TEST-A"]["instantiate"]
 416         db_nslcmop = self.db.get_one('nslcmops', {"_id": nslcmop_id})
 417         op_index = 0
 418         # Force the initial values to be distinct from the updated ones
 419         q_filter = {"_id": db_nslcmop["_id"]}
 420         # Test to change 'operationState' and 'detailed-status'
 421         operationState = 'COMPLETED'
 422         detailed_status = 'Done'
 423         expected_update_dict = {'_admin.operations.0.operationState': operationState,
 424                                 '_admin.operations.0.detailed-status': detailed_status,
 425                                 }
 426         self.my_ns._update_suboperation_status(db_nslcmop, op_index, operationState, detailed_status)
 427         self.db.set_one.assert_called_once_with("nslcmops", q_filter=q_filter, update_dict=expected_update_dict,
 428                                                 fail_on_empty=False)
 429
 430     def test_scale_add_suboperation(self):
 431         nslcmop_id = descriptors.test_ids["TEST-A"]["instantiate"]
 432         db_nslcmop = self.db.get_one('nslcmops', {"_id": nslcmop_id})
 433         vnf_index = '1'
 434         num_ops_before = len(db_nslcmop.get('_admin', {}).get('operations', [])) - 1
 435         vdu_id = None
 436         vdu_count_index = None
 437         vdu_name = None
 438         primitive = 'touch'
 439         mapped_primitive_params = {'parameter':
 440                                    [{'data-type': 'STRING',
 441                                      'name': 'filename',
 442                                      'default-value': '<touch_filename2>'}],
 443                                    'name': 'touch'}
 444         operationState = 'PROCESSING'
 445         detailed_status = 'In progress'
 446         operationType = 'PRE-SCALE'
 447         # Add a 'pre-scale' suboperation
 448         op_index_after = self.my_ns._add_suboperation(db_nslcmop, vnf_index, vdu_id, vdu_count_index,
 449                                                       vdu_name, primitive, mapped_primitive_params,
 450                                                       operationState, detailed_status, operationType)
 451         self.assertEqual(op_index_after, num_ops_before + 1)
 452
 453         # Delete all suboperations and add the same operation again
 454         del db_nslcmop['_admin']['operations']
 455         op_index_zero = self.my_ns._add_suboperation(db_nslcmop, vnf_index, vdu_id, vdu_count_index,
 456                                                      vdu_name, primitive, mapped_primitive_params,
 457                                                      operationState, detailed_status, operationType)
 458         self.assertEqual(op_index_zero, 0)
 459
 460         # Add a 'RO' suboperation
 461         RO_nsr_id = '1234567890'
 462         RO_scaling_info = [{'type': 'create', 'count': 1, 'member-vnf-index': '1', 'osm_vdu_id': 'dataVM'}]
 463         op_index = self.my_ns._add_suboperation(db_nslcmop, vnf_index, vdu_id, vdu_count_index,
 464                                                 vdu_name, primitive, mapped_primitive_params,
 465                                                 operationState, detailed_status, operationType,
 466                                                 RO_nsr_id, RO_scaling_info)
 467         db_RO_nsr_id = db_nslcmop['_admin']['operations'][op_index]['RO_nsr_id']
 468         self.assertEqual(op_index, 1)
 469         self.assertEqual(RO_nsr_id, db_RO_nsr_id)
 470
 471         # Try to add an invalid suboperation, should return SUBOPERATION_STATUS_NOT_FOUND
 472         op_index_invalid = self.my_ns._add_suboperation(None, None, None, None, None,
 473                                                         None, None, None,
 474                                                         None, None, None)
 475         self.assertEqual(op_index_invalid, self.my_ns.SUBOPERATION_STATUS_NOT_FOUND)
 476
 477     # Test _check_or_add_scale_suboperation() and _check_or_add_scale_suboperation_RO()
 478     # check the possible return values:
 479     # - SUBOPERATION_STATUS_NEW: This is a new sub-operation
 480     # - op_index (non-negative number): This is an existing sub-operation, operationState != 'COMPLETED'
 481     # - SUBOPERATION_STATUS_SKIP: This is an existing sub-operation, operationState == 'COMPLETED'
 482     def test_scale_check_or_add_scale_suboperation(self):
 483         nslcmop_id = descriptors.test_ids["TEST-A"]["instantiate"]
 484         db_nslcmop = self.db.get_one('nslcmops', {"_id": nslcmop_id})
 485         operationType = 'PRE-SCALE'
 486         vnf_index = '1'
 487         primitive = 'touch'
 488         primitive_params = {'parameter':
 489                             [{'data-type': 'STRING',
 490                               'name': 'filename',
 491                               'default-value': '<touch_filename2>'}],
 492                             'name': 'touch'}
 493
 494         # Delete all sub-operations to be sure this is a new sub-operation
 495         del db_nslcmop['_admin']['operations']
 496
 497         # Add a new sub-operation
 498         # For new sub-operations, operationState is set to 'PROCESSING' by default
 499         op_index_new = self.my_ns._check_or_add_scale_suboperation(
 500             db_nslcmop, vnf_index, primitive, primitive_params, operationType)
 501         self.assertEqual(op_index_new, self.my_ns.SUBOPERATION_STATUS_NEW)
 502
 503         # Use the same parameters again to match the already added sub-operation
 504         # which has status 'PROCESSING' (!= 'COMPLETED') by default
 505         # The expected return value is a non-negative number
 506         op_index_existing = self.my_ns._check_or_add_scale_suboperation(
 507             db_nslcmop, vnf_index, primitive, primitive_params, operationType)
 508         self.assertTrue(op_index_existing >= 0)
 509
 510         # Change operationState 'manually' for this sub-operation
 511         db_nslcmop['_admin']['operations'][op_index_existing]['operationState'] = 'COMPLETED'
 512         # Then use the same parameters again to match the already added sub-operation,
 513         # which now has status 'COMPLETED'
 514         # The expected return value is SUBOPERATION_STATUS_SKIP
 515         op_index_skip = self.my_ns._check_or_add_scale_suboperation(
 516             db_nslcmop, vnf_index, primitive, primitive_params, operationType)
 517         self.assertEqual(op_index_skip, self.my_ns.SUBOPERATION_STATUS_SKIP)
 518
 519         # RO sub-operation test:
 520         # Repeat tests for the very similar _check_or_add_scale_suboperation_RO(),
 521         RO_nsr_id = '1234567890'
 522         RO_scaling_info = [{'type': 'create', 'count': 1, 'member-vnf-index': '1', 'osm_vdu_id': 'dataVM'}]
 523         op_index_new_RO = self.my_ns._check_or_add_scale_suboperation(
 524             db_nslcmop, vnf_index, None, None, 'SCALE-RO', RO_nsr_id, RO_scaling_info)
 525         self.assertEqual(op_index_new_RO, self.my_ns.SUBOPERATION_STATUS_NEW)
 526
 527         # Use the same parameters again to match the already added RO sub-operation
 528         op_index_existing_RO = self.my_ns._check_or_add_scale_suboperation(
 529             db_nslcmop, vnf_index, None, None, 'SCALE-RO', RO_nsr_id, RO_scaling_info)
 530         self.assertTrue(op_index_existing_RO >= 0)
 531
 532         # Change operationState 'manually' for this RO sub-operation
 533         db_nslcmop['_admin']['operations'][op_index_existing_RO]['operationState'] = 'COMPLETED'
 534         # Then use the same parameters again to match the already added sub-operation,
 535         # which now has status 'COMPLETED'
 536         # The expected return value is SUBOPERATION_STATUS_SKIP
 537         op_index_skip_RO = self.my_ns._check_or_add_scale_suboperation(
 538             db_nslcmop, vnf_index, None, None, 'SCALE-RO', RO_nsr_id, RO_scaling_info)
 539         self.assertEqual(op_index_skip_RO, self.my_ns.SUBOPERATION_STATUS_SKIP)
 540
 541     async def test_deploy_kdus(self):
 542         nsr_id = descriptors.test_ids["TEST-KDU"]["ns"]
 543         nslcmop_id = descriptors.test_ids["TEST-KDU"]["instantiate"]
 544         db_nsr = self.db.get_one("nsrs", {"_id": nsr_id})
 545         db_vnfr = self.db.get_one("vnfrs", {"nsr-id-ref": nsr_id, "member-vnf-index-ref": "multikdu"})
 546         db_vnfrs = {"multikdu": db_vnfr}
 547         db_vnfd = self.db.get_one("vnfds", {"_id": db_vnfr["vnfd-id"]})
 548         db_vnfds = {db_vnfd["_id"]: db_vnfd}
 549         task_register = {}
 550         logging_text = "KDU"
 551         self.my_ns.k8sclusterhelm3.install = asynctest.CoroutineMock(return_value="k8s_id")
 552         self.my_ns.k8sclusterhelm3.synchronize_repos = asynctest.CoroutineMock(return_value=("", ""))
 553         self.my_ns.k8sclusterhelm3.get_services = asynctest.CoroutineMock(return_value=([]))
 554         await self.my_ns.deploy_kdus(logging_text, nsr_id, nslcmop_id, db_vnfrs, db_vnfds, task_register)
 555         await asyncio.wait(list(task_register.keys()), timeout=100)
 556         db_nsr = self.db.get_list("nsrs")[1]
 557         self.assertIn("K8s", db_nsr["_admin"]["deployed"], "K8s entry not created at '_admin.deployed'")
 558         self.assertIsInstance(db_nsr["_admin"]["deployed"]["K8s"], list, "K8s entry is not of type list")
 559         self.assertEqual(len(db_nsr["_admin"]["deployed"]["K8s"]), 2, "K8s entry is not of type list")
 560         k8s_instace_info = {"kdu-instance": "k8s_id", "k8scluster-uuid": "73d96432-d692-40d2-8440-e0c73aee209c",
 561                             "k8scluster-type": "helm-chart-v3",
 562                             "kdu-name": "ldap", "kdu-model": "stable/openldap:1.2.1",
 563                             "member-vnf-index": "multikdu", "namespace": None}
 564
 565         self.assertEqual(db_nsr["_admin"]["deployed"]["K8s"][0], k8s_instace_info)
 566         k8s_instace_info["kdu-name"] = "mongo"
 567         k8s_instace_info["kdu-model"] = "stable/mongodb"
 568         self.assertEqual(db_nsr["_admin"]["deployed"]["K8s"][1], k8s_instace_info)
 569
 570     async def test_instantiate_pdu(self):
 571         nsr_id = descriptors.test_ids["TEST-A"]["ns"]
 572         nslcmop_id = descriptors.test_ids["TEST-A"]["instantiate"]
 573         # Modify vnfd/vnfr to change KDU for PDU. Adding keys that NBI will already set
 574         self.db.set_one("vnfrs", {"nsr-id-ref": nsr_id, "member-vnf-index-ref": "1"},
 575                         update_dict={"ip-address": "10.205.1.46",
 576                                      "vdur.0.pdu-id": "53e1ec21-2464-451e-a8dc-6e311d45b2c8",
 577                                      "vdur.0.pdu-type": "PDU-TYPE-1",
 578                                      "vdur.0.ip-address": "10.205.1.46",
 579                                      },
 580                         unset={"vdur.status": None})
 581         self.db.set_one("vnfrs", {"nsr-id-ref": nsr_id, "member-vnf-index-ref": "2"},
 582                         update_dict={"ip-address": "10.205.1.47",
 583                                      "vdur.0.pdu-id": "53e1ec21-2464-451e-a8dc-6e311d45b2c8",
 584                                      "vdur.0.pdu-type": "PDU-TYPE-1",
 585                                      "vdur.0.ip-address": "10.205.1.47",
 586                                      },
 587                         unset={"vdur.status": None})
 588
 589         await self.my_ns.instantiate(nsr_id, nslcmop_id)
 590         db_nsr = self.db.get_one("nsrs", {"_id": nsr_id})
 591         self.assertEqual(db_nsr.get("nsState"), "READY", str(db_nsr.get("errorDescription ")))
 592         self.assertEqual(db_nsr.get("currentOperation"), "IDLE", "currentOperation different than 'IDLE'")
 593         self.assertEqual(db_nsr.get("currentOperationID"), None, "currentOperationID different than None")
 594         self.assertEqual(db_nsr.get("errorDescription "), None, "errorDescription different than None")
 595         self.assertEqual(db_nsr.get("errorDetail"), None, "errorDetail different than None")
 596
 597     @asynctest.fail_on(active_handles=True)   # all async tasks must be completed
 598     async def test_terminate_without_configuration(self):
 599         nsr_id = descriptors.test_ids["TEST-A"]["ns"]
 600         nslcmop_id = descriptors.test_ids["TEST-A"]["terminate"]
 601         # set instantiation task as completed
 602         self.db.set_list("nslcmops", {"nsInstanceId": nsr_id, "_id.ne": nslcmop_id},
 603                          update_dict={"operationState": "COMPLETED"})
 604         self.my_ns.RO.show = asynctest.CoroutineMock(ROClient.show, side_effect=self._ro_show(delete=nslcmop_id))
 605         self.db.set_one("nsrs", {"_id": nsr_id},
 606                         update_dict={"_admin.deployed.VCA.0": None, "_admin.deployed.VCA.1": None})
 607
 608         await self.my_ns.terminate(nsr_id, nslcmop_id)
 609         db_nslcmop = self.db.get_one("nslcmops", {"_id": nslcmop_id})
 610         self.assertEqual(db_nslcmop.get("operationState"), 'COMPLETED', db_nslcmop.get("detailed-status"))
 611         db_nsr = self.db.get_one("nsrs", {"_id": nsr_id})
 612         self.assertEqual(db_nsr.get("nsState"), "NOT_INSTANTIATED", str(db_nsr.get("errorDescription ")))
 613         self.assertEqual(db_nsr["_admin"].get("nsState"), "NOT_INSTANTIATED", str(db_nsr.get("errorDescription ")))
 614         self.assertEqual(db_nsr.get("currentOperation"), "IDLE", "currentOperation different than 'IDLE'")
 615         self.assertEqual(db_nsr.get("currentOperationID"), None, "currentOperationID different than None")
 616         self.assertEqual(db_nsr.get("errorDescription "), None, "errorDescription different than None")
 617         self.assertEqual(db_nsr.get("errorDetail"), None, "errorDetail different than None")
 618         db_vnfrs_list = self.db.get_list("vnfrs", {"nsr-id-ref": nsr_id})
 619         for vnfr in db_vnfrs_list:
 620             self.assertEqual(vnfr["_admin"].get("nsState"), "NOT_INSTANTIATED", "Not instantiated")
 621
 622     @asynctest.fail_on(active_handles=True)   # all async tasks must be completed
 623     async def test_terminate_primitive(self):
 624         nsr_id = descriptors.test_ids["TEST-A"]["ns"]
 625         nslcmop_id = descriptors.test_ids["TEST-A"]["terminate"]
 626         self.my_ns.RO.show = asynctest.CoroutineMock(ROClient.show, side_effect=self._ro_show(delete=nslcmop_id))
 627         # set instantiation task as completed
 628         self.db.set_list("nslcmops", {"nsInstanceId": nsr_id, "_id.ne": nslcmop_id},
 629                          update_dict={"operationState": "COMPLETED"})
 630
 631         # modify vnfd descriptor to include terminate_primitive
 632         terminate_primitive = [{
 633             "name": "touch",
 634             "parameter": [{"name": "filename", "value": "terminate_filename"}],
 635             "seq": '1'
 636         }]
 637         db_vnfr = self.db.get_one("vnfrs", {"nsr-id-ref": nsr_id, "member-vnf-index-ref": "1"})
 638         self.db.set_one("vnfds", {"_id": db_vnfr["vnfd-id"]},
 639                         {"vnf-configuration.terminate-config-primitive": terminate_primitive})
 640
 641         await self.my_ns.terminate(nsr_id, nslcmop_id)
 642         db_nslcmop = self.db.get_one("nslcmops", {"_id": nslcmop_id})
 643         self.assertEqual(db_nslcmop.get("operationState"), 'COMPLETED', db_nslcmop.get("detailed-status"))
 644         db_nsr = self.db.get_one("nsrs", {"_id": nsr_id})
 645         self.assertEqual(db_nsr.get("nsState"), "NOT_INSTANTIATED", str(db_nsr.get("errorDescription ")))
 646         self.assertEqual(db_nsr["_admin"].get("nsState"), "NOT_INSTANTIATED", str(db_nsr.get("errorDescription ")))
 647         self.assertEqual(db_nsr.get("currentOperation"), "IDLE", "currentOperation different than 'IDLE'")
 648         self.assertEqual(db_nsr.get("currentOperationID"), None, "currentOperationID different than None")
 649         self.assertEqual(db_nsr.get("errorDescription "), None, "errorDescription different than None")
 650         self.assertEqual(db_nsr.get("errorDetail"), None, "errorDetail different than None")
 651
 652
 653 if __name__ == '__main__':
 654     asynctest.main()