Merge pull request #886 from QualiSystems/develop

Merging to master for 1.9.0 release

Author: alexazarh

.travis.yml

@@ -4,10 +4,10 @@ env:
 install: 
   - pip install -r external_requirements.txt
   - pip install -r test_requirements.txt
-  - pip install "cloudshell-core>=2.0.0,<2.1.0" --extra-index-url https://testpypi.python.org/simple  
+  - pip install "cloudshell-core>=2.2.0,<2.3.0" --extra-index-url https://testpypi.python.org/simple
   - chmod 777 ./cloudshell_shell_core_install.sh
   - ./cloudshell_shell_core_install.sh
-  - pip install "cloudshell-automation-api>=8.0.0.0,<8.1.0.0" --extra-index-url https://testpypi.python.org/simple
+  - pip install "cloudshell-automation-api>=8.2.0.0,<8.3.0.0" --extra-index-url https://testpypi.python.org/simple
 language: python
 notifications: 
   webhools: "https://qualisystems.getbadges.io/api/app/webhook/63350e33-4119-49c3-8127-075aaa022926"

cloudshell_shell_core_install.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 if [ "${CLOUD_SHELL_SHELL_CORE}" -eq 1 ]
 then
-    pip install "cloudshell-shell-core>=2.0.0,<2.1.0" --extra-index-url https://testpypi.python.org/simple
+    pip install "cloudshell-shell-core>=3.0.0,<3.1.0" --extra-index-url https://testpypi.python.org/simple
 else
     pip install "cloudshell-shell-core>=2.3.0,<2.4.0" --extra-index-url https://testpypi.python.org/simple
 fi

package/cloudshell/cp/vcenter/commands/deploy_vm.py

@@ -11,45 +11,53 @@ def __init__(self, deployer):
         """
         self.deployer = deployer
 
-    def execute_deploy_from_linked_clone(self, si, logger, vcenter_data_model, deployment_params):
+    def execute_deploy_from_linked_clone(self, si, logger, vcenter_data_model, reservation_id, deployment_params):
         """
         Calls the deployer to deploy vm from snapshot
+        :param str reservation_id:
         :param si:
         :param logger:
         :type deployment_params: DeployFromLinkedClone
         :param vcenter_data_model:
         :return:
         """
-        deploy_result = self.deployer.deploy_from_linked_clone(si, logger, deployment_params, vcenter_data_model)
+        deploy_result = self.deployer.deploy_from_linked_clone(si, logger, deployment_params, vcenter_data_model,
+                                                               reservation_id)
         return deploy_result
 
-    def execute_deploy_clone_from_vm(self, si, logger, vcenter_data_model, deployment_params):
+    def execute_deploy_clone_from_vm(self, si, logger, vcenter_data_model, reservation_id, deployment_params):
         """
         Calls the deployer to deploy vm from another vm
+        :param str reservation_id:
         :param si:
         :param logger:
         :type deployment_params: DeployFromTemplateDetails
         :param vcenter_data_model:
         :return:
         """
-        deploy_result = self.deployer.deploy_clone_from_vm(si, logger, deployment_params, vcenter_data_model)
+        deploy_result = self.deployer.deploy_clone_from_vm(si, logger, deployment_params, vcenter_data_model,
+                                                           reservation_id)
         return deploy_result
 
-    def execute_deploy_from_template(self, si, logger, vcenter_data_model, deployment_params):
+    def execute_deploy_from_template(self, si, logger, vcenter_data_model, reservation_id, deployment_params):
         """
 
+        :param str reservation_id:
         :param si:
         :param logger:
         :type deployment_params: DeployFromTemplateDetails
         :param vcenter_data_model:
         :return:
         """
-        deploy_result = self.deployer.deploy_from_template(si, logger, deployment_params, vcenter_data_model)
+        deploy_result = self.deployer.deploy_from_template(si, logger, deployment_params, vcenter_data_model,
+                                                           reservation_id)
         return deploy_result
 
-    def execute_deploy_from_image(self, si, logger, session, vcenter_data_model, deployment_params, resource_context):
+    def execute_deploy_from_image(self, si, logger, session, vcenter_data_model, reservation_id, deployment_params,
+                                  resource_context):
         """
 
+        :param str reservation_id:
         :param si:
         :param logger:
         :param session:
@@ -63,5 +71,6 @@ def execute_deploy_from_image(self, si, logger, session, vcenter_data_model, dep
                                                         session=session,
                                                         vcenter_data_model=vcenter_data_model,
                                                         data_holder=deployment_params,
-                                                        resource_context=resource_context)
+                                                        resource_context=resource_context,
+                                                        reservation_id=reservation_id)
         return deploy_result

package/cloudshell/cp/vcenter/common/utilites/common_name.py

@@ -3,10 +3,15 @@
 ### util methods to help us generate names for different entities ###
 
 
-def generate_unique_name(name_prefix):
+def generate_unique_name(name_prefix, reservation_id=None):
     """
-    generate a unique name.
-    method generate a guid and adds the first 8 characteres of the new guid to 'name_prefix'.
+    Generate a unique name.
+    Method generate a guid and adds the first 8 characteres of the new guid to 'name_prefix'.
+    If reservation id is provided than the first 4 chars of the generated guid are taken and the last 4
+    of the reservation id
     """
-    unique_id = str(uuid.uuid4())[:8]
+    if reservation_id and isinstance(reservation_id, str) and len(reservation_id) >= 4:
+        unique_id = str(uuid.uuid4())[:4] + "-" + reservation_id[-4:]
+    else:
+        unique_id = str(uuid.uuid4())[:8]
     return name_prefix + "_" + unique_id

package/cloudshell/cp/vcenter/common/wrappers/command_wrapper.py

@@ -52,7 +52,7 @@ def __init__(self, pv_service, cloud_shell_helper, resource_model_parser, contex
     @retry(stop_max_attempt_number=3, wait_fixed=2000, retry_on_exception=retry_if_auth_error)
     def execute_command_with_connection(self, context, command, *args):
         """
-        Note: session & vcenter_data_model objects will be injected dynamically to the command
+        Note: session & vcenter_data_model & reservation id objects will be injected dynamically to the command
         :param command:
         :param context: instance of ResourceCommandContext or AutoLoadCommandContext
         :type context: cloudshell.shell.core.context.ResourceCommandContext
@@ -98,10 +98,21 @@ def execute_command_with_connection(self, context, command, *args):
                 logger.info(CONNECTED_TO_CENTER.format(connection_details.host))
                 command_args.append(si)
 
-            self._try_inject_arg(command=command, command_args=command_args, arg_object=session, arg_name='session')
-            self._try_inject_arg(command=command, command_args=command_args, arg_object=vcenter_data_model,
+            self._try_inject_arg(command=command,
+                                 command_args=command_args,
+                                 arg_object=session,
+                                 arg_name='session')
+            self._try_inject_arg(command=command,
+                                 command_args=command_args,
+                                 arg_object=vcenter_data_model,
                                  arg_name='vcenter_data_model')
-            self._try_inject_arg(command=command, command_args=command_args, arg_object=logger,
+            self._try_inject_arg(command=command,
+                                 command_args=command_args,
+                                 arg_object=self._get_reservation_id(context),
+                                 arg_name='reservation_id')
+            self._try_inject_arg(command=command,
+                                 command_args=command_args,
+                                 arg_object=logger,
                                  arg_name='logger')
 
             command_args.extend(args)
@@ -157,6 +168,14 @@ def _get_domain(context):
             domain = reservation.domain
         return domain
 
+    @staticmethod
+    def _get_reservation_id(context):
+        reservation_id = None
+        reservation = getattr(context, 'reservation', getattr(context, 'remote_reservation', None))
+        if reservation:
+            reservation_id = reservation.reservation_id
+        return reservation_id
+
     def _try_inject_arg(self, command, command_args, arg_object, arg_name):
         try:
             if not arg_object:

package/cloudshell/cp/vcenter/vm/deploy.py

@@ -24,31 +24,34 @@ def __init__(self, pv_service, name_generator, ovf_service, cs_helper, resource_
         self.cs_helper = cs_helper  # type CloudshellDriverHelper
         self.resource_model_parser = resource_model_parser  # type ResourceModelParser
 
-    def deploy_from_linked_clone(self, si, logger, data_holder, vcenter_data_model):
+    def deploy_from_linked_clone(self, si, logger, data_holder, vcenter_data_model, reservation_id):
         """
         deploy Cloned VM From VM Command, will deploy vm from a snapshot
 
         :param si:
         :param logger:
-        :type data_holder:
-        :type vcenter_data_model:
+        :param data_holder:
+        :param vcenter_data_model:
+        :param str reservation_id:
         :return:
         """
 
         template_resource_model = data_holder.template_resource_model
 
-        return self._deploy_a_clone(si,
-                                    logger,
-                                    data_holder.app_name,
-                                    template_resource_model.vcenter_vm,
-                                    template_resource_model,
-                                    vcenter_data_model,
+        return self._deploy_a_clone(si=si,
+                                    logger=logger,
+                                    app_name=data_holder.app_name,
+                                    template_name=template_resource_model.vcenter_vm,
+                                    other_params=template_resource_model,
+                                    vcenter_data_model=vcenter_data_model,
+                                    reservation_id=reservation_id,
                                     snapshot=template_resource_model.vcenter_vm_snapshot)
 
-    def deploy_clone_from_vm(self, si, logger, data_holder, vcenter_data_model):
+    def deploy_clone_from_vm(self, si, logger, data_holder, vcenter_data_model, reservation_id):
         """
         deploy Cloned VM From VM Command, will deploy vm from another vm
 
+        :param reservation_id:
         :param si:
         :param logger:
         :type data_holder:
@@ -61,10 +64,12 @@ def deploy_clone_from_vm(self, si, logger, data_holder, vcenter_data_model):
                                     data_holder.app_name,
                                     template_resource_model.vcenter_vm,
                                     template_resource_model,
-                                    vcenter_data_model)
+                                    vcenter_data_model,
+                                    reservation_id)
 
-    def deploy_from_template(self, si, logger, data_holder, vcenter_data_model):
+    def deploy_from_template(self, si, logger, data_holder, vcenter_data_model, reservation_id):
         """
+        :param reservation_id:
         :param si:
         :param logger:
         :type data_holder: DeployFromTemplateDetails
@@ -77,11 +82,13 @@ def deploy_from_template(self, si, logger, data_holder, vcenter_data_model):
                                     data_holder.app_name,
                                     template_resource_model.vcenter_template,
                                     template_resource_model,
-                                    vcenter_data_model)
+                                    vcenter_data_model,
+                                    reservation_id)
 
-    def _deploy_a_clone(self, si, logger, app_name, template_name, other_params, vcenter_data_model, snapshot=''):
+    def _deploy_a_clone(self, si, logger, app_name, template_name, other_params, vcenter_data_model, reservation_id,
+                        snapshot=''):
         # generate unique name
-        vm_name = self.name_generator(app_name)
+        vm_name = self.name_generator(app_name, reservation_id)
 
         VCenterDetailsFactory.set_deplyment_vcenter_params(
             vcenter_resource_model=vcenter_data_model, deploy_params=other_params)
@@ -115,8 +122,8 @@ def _deploy_a_clone(self, si, logger, app_name, template_name, other_params, vce
                             autoload=other_params.autoload
                             )
 
-    def deploy_from_image(self, si, logger, session, vcenter_data_model, data_holder, resource_context):
-        vm_name = self.name_generator(data_holder.app_name)
+    def deploy_from_image(self, si, logger, session, vcenter_data_model, data_holder, resource_context, reservation_id):
+        vm_name = self.name_generator(data_holder.app_name, reservation_id)
 
         connection_details = self.cs_helper.get_connection_details(session=session,
                                                                    vcenter_resource_model=vcenter_data_model,

package/cloudshell/tests/test_commands/test_deploy_vm.py

@@ -32,17 +32,22 @@ def test_deploy_execute(self):
         deploy_command = DeployCommand(deployer)
 
         resource_context = Mock()
+        logger = Mock()
+        vcenter_data_model = Mock()
+        reservation_id = Mock()
 
         # act
         result = deploy_command.execute_deploy_from_template(
-            si=si,
-            logger=Mock(),
-            deployment_params=deploy_params,
-            vcenter_data_model=Mock())
+                si=si,
+                logger=logger,
+                deployment_params=deploy_params,
+                vcenter_data_model=vcenter_data_model,
+                reservation_id=reservation_id)
 
         # assert
         self.assertTrue(result)
-        self.assertTrue(deployer.deploy_from_template.called_with(si, deploy_params, resource_context))
+        deployer.deploy_from_template.assert_called_once_with(si, logger, deploy_params, vcenter_data_model,
+                                                              reservation_id)
 
     def test_deploy_image_execute(self):
         deployer = Mock()
@@ -53,20 +58,29 @@ def test_deploy_image_execute(self):
         deployer.deploy_from_image = Mock(return_value=res)
         session = Mock()
         vcenter_data_model = Mock()
+        logger = Mock()
+        reservation_id = Mock()
 
         deploy_command = DeployCommand(deployer)
 
         # act
         result = deploy_command.execute_deploy_from_image(si=si,
-                                                          logger=Mock(),
+                                                          logger=logger,
                                                           session=session,
                                                           vcenter_data_model=vcenter_data_model,
                                                           deployment_params=deployment_params,
-                                                          resource_context=connectivity)
+                                                          resource_context=connectivity,
+                                                          reservation_id=reservation_id)
 
         # assert
         self.assertTrue(result)
-        self.assertTrue(deployer.deploy_from_image.called_with(si, deployment_params, connectivity))
+        deployer.deploy_from_image.assert_called_once_with(si=si,
+                                                           logger=logger,
+                                                           session=session,
+                                                           vcenter_data_model=vcenter_data_model,
+                                                           data_holder=deployment_params,
+                                                           resource_context=connectivity,
+                                                           reservation_id=reservation_id)
 
     def test_deploy_clone_execute(self):
         # arrange
@@ -83,6 +97,10 @@ def test_deploy_clone_execute(self):
         template_model.vm_folder = 'temp folder'
         deployer.deploy_from_template = Mock(return_value=deploy_res)
 
+        reservation_id = Mock()
+        logger = Mock()
+        vcenter_data_model = Mock()
+
         template_resource_model = vCenterVMFromTemplateResourceModel()
 
         deploy_params = DeployFromTemplateDetails(template_resource_model, 'VM Deployment')
@@ -93,14 +111,16 @@ def test_deploy_clone_execute(self):
 
         # act
         result = deploy_command.execute_deploy_clone_from_vm(
-            si=si,
-            logger=Mock(),
-            vcenter_data_model=Mock(),
-            deployment_params=deploy_params)
+                si=si,
+                logger=logger,
+                vcenter_data_model=vcenter_data_model,
+                deployment_params=deploy_params,
+                reservation_id=reservation_id)
 
         # assert
         self.assertTrue(result)
-        self.assertTrue(deployer.deploy_from_template.called_with(si, deploy_params, resource_context))
+        deployer.deploy_clone_from_vm.assert_called_once_with(si, logger, deploy_params, vcenter_data_model,
+                                                              reservation_id)
 
     def test_deploy_snapshot_execute(self):
         # arrange
@@ -124,14 +144,19 @@ def test_deploy_snapshot_execute(self):
         deploy_command = DeployCommand(deployer)
 
         resource_context = Mock()
+        logger = Mock()
+        vcenter_data_model = Mock()
+        reservation_id = Mock()
 
         # act
         result = deploy_command.execute_deploy_from_linked_clone(
-            si=si,
-            logger=Mock(),
-            deployment_params=deploy_params,
-            vcenter_data_model=Mock())
+                si=si,
+                logger=logger,
+                deployment_params=deploy_params,
+                vcenter_data_model=vcenter_data_model,
+                reservation_id=reservation_id)
 
         # assert
         self.assertTrue(result)
-        self.assertTrue(deployer.deploy_from_template.called_with(si, deploy_params, resource_context))
+        deployer.deploy_from_linked_clone.assert_called_once_with(si, logger, deploy_params, vcenter_data_model,
+                                                               reservation_id)

package/cloudshell/tests/test_common/test_utilities/test_common_name_utils.py

@@ -9,3 +9,18 @@ def test_unique_name_generation(self):
         unique1 = generate_unique_name(name_prefix)
         unique2 = generate_unique_name(name_prefix)
         self.assertNotEqual(unique1, unique2)
+
+    def test_unique_name_generation_with_reservation_id(self):
+        # arrange
+        name_prefix = "some template name"
+        reservation_id = "bcba3fe8-f56a-4f90-91c7-4262526f8ba5"
+
+        # act
+        unique1 = generate_unique_name(name_prefix, reservation_id)
+        unique2 = generate_unique_name(name_prefix, reservation_id)
+
+        # assert
+        self.assertNotEqual(unique1, unique2)
+        self.assertTrue(str(unique1).endswith("-8ba5"))
+        self.assertTrue(str(unique2).endswith("-8ba5"))
+