Teardowndebug

sandbox_scripts/QualiEnvironmentUtils/RepositoryClients/GitLabClient.py

@@ -4,8 +4,8 @@
 import pip
 
 try:
-    import gitlab
     imported_gitlab = True
+    import gitlab
 except:
     try:
         pip.main(["install","pyapi-gitlab"])
@@ -58,7 +58,6 @@ def download(self, source, destination):
         try:
             with open(destination,'w') as dest:
                     dest.write(filetext)
-            print "Downloaded: " + source
             return 0, "Successfully retrieved file from repository and saved to destination"
         except Exception as ex:
             raise QualiError("GitLabClient","ERROR: Retrieved file from repository - failed to save to destination : " + str(ex.message))

sandbox_scripts/QualiEnvironmentUtils/Resource.py

@@ -22,11 +22,7 @@ def __init__(self, resource_name, resource_alias=''):
 
             self.attributes = self.details.ResourceAttributes
             # If there is an attribute named 'model' take its value (exist in shells), otherwise take the family's model
-            if self.attribute_exist('Model'):
-                self.model = self.get_attribute('Model')
-            else:
-                self.model = self.details.ResourceModelName
-
+            self.model = self.get_attrib_value_ending_in_model()
             self.alias = resource_alias
 
     # -----------------------------------------
@@ -45,17 +41,24 @@ def has_command(self, command_name):
     def attribute_exist(self, attribute_name):
         attribute_name = attribute_name.lower()
         for attribute in self.attributes:
-            if attribute.Name.lower() == attribute_name:
+            if attribute.Name.lower() == attribute_name or attribute.Name.lower().endswith('.' + attribute_name):
                 return True
         return False
 
+    # -----------------------------------------
+    # -----------------------------------------
+    def get_attrib_value_ending_in_model(self):
+        for attribute in self.attributes:
+            if attribute.Name.endswith('.Model'):
+                return str(attribute.Value)
+        return str(self.details.ResourceModelName)
 
     # -----------------------------------------
     # -----------------------------------------
     def get_attribute(self, attribute_name):
         attribute_name = attribute_name.lower()
         for attribute in self.attributes:
-            if attribute.Name.lower() == attribute_name:
+            if attribute.Name.lower() == attribute_name or attribute.Name.lower().endswith('.' + attribute_name):
                 if attribute.Type == 'Password':
                     decrypted = self.api_session.DecryptPassword(attribute.Value)
                     return decrypted.Value
@@ -66,11 +69,17 @@ def get_attribute(self, attribute_name):
     # -----------------------------------------
     # -----------------------------------------
     def set_attribute_value(self, attribute_name, attribute_value):
+        # if caller passes ending string of name, need to handle not knowing prefix
         try:
-            self.api_session.SetAttributeValue(resourceFullPath=self.name, attributeName=attribute_name,
-                                               attributeValue=attribute_value)
+            attribute_name = attribute_name.lower()
+            for attribute in self.attributes:
+                if attribute.Name.lower() == attribute_name or attribute.Name.lower().endswith('.' + attribute_name):
+                    self.api_session.SetAttributeValue(resourceFullPath=self.name,
+                                                       attributeName=attribute.Name,
+                                                       attributeValue=attribute_value)
+                    return
         except CloudShellAPIError as error:
-            raise QualiError(self.name, "Attribute: " + attribute_name + " not found. " + error.message)
+            raise QualiError(self.name, "Attribute named or ending-with: " + attribute_name + " not found. " + error.message)
 
     # -----------------------------------------
     # implement the command to get the neighbors and their ports

sandbox_scripts/QualiEnvironmentUtils/Sandbox.py

@@ -3,6 +3,10 @@
 from cloudshell.core.logger.qs_logger import *
 from cloudshell.helpers.scripts import cloudshell_scripts_helpers as helpers
 from os.path import *
+from time import gmtime, strftime
+import smtplib
+import socket
+from email.mime.text import MIMEText
 
 
 SEVERITY_INFO = 20
@@ -20,9 +24,10 @@ def __init__(self, reservation_id, logger):
             """:type : logging.Logger"""
             self.api_session = helpers.get_api_session()
             self.id = reservation_id
-
+            self.owner = helpers.get_reservation_context_details().owner_user
             self.Blueprint_name = helpers.get_reservation_context_details().environment_name
-
+            if self.Blueprint_name == '':
+                raise QualiError("Blueprint name empty (from env name)")
 
             full_path = None
             tp = self.api_session.GetActiveTopologyNames()
@@ -53,19 +58,41 @@ def _write_message_to_output(self, message, severity_level=SEVERITY_INFO):
             self.api_session.WriteMessageToReservationOutput(self.id, '<font color="red">' + message + '</font>')
 
     # ----------------------------------
-    def report_error(self, error_message, log_message=None, raise_error=True, write_to_output_window=False):
+    def report_error(self, error_message, log_message=None, raise_error=True, write_to_output_window=False,
+                     send_email=False):
         """
         Report on an error to the log file, output window is optional.There is also an option to raise the error up
         :param str error_message:  The error message you would like to present
         :param str log_message: The error message you would like to write to the log. Keep None to use the message param
         :param bool raise_error:  Do you want to throw an exception
         :param bool write_to_output_window:  Would you like to write the message to the output window
         """
+
+        emailresult = ''
+        if raise_error:
+            if send_email:
+                emailOwner = False
+                try:
+                    emailSubject = str(self.Blueprint_name) + ' / ' + str(self.owner)
+                    emailBody = "Sandbox: " + str(self.Blueprint_name) + "\n" + \
+                            "Owner: " + str(self.owner) + "\n\n"
+                    sb_owner = str(self.owner)
+                except:
+                    emailSubject = "Catastrophic ERROR in sandbox."
+                    emailBody = str(os.environ) + "\n\n"
+                    sb_owner = "Owner Unknown"
+
+                if log_message:
+                    emailBody += "LogMsg: " + log_message + "\n\n"
+                if error_message:
+                    emailBody += "ErrMsg: " + error_message + "\n\n"
+                emailresult = self.emailalert(emailSubject, emailBody, owner=sb_owner, ishtml=False, emailOwner=emailOwner) + "\n"
+
         if self._logger:
             if log_message:
-                self._logger.error(log_message)
+                self._logger.error(emailresult + log_message)
             else:
-                self._logger.error(error_message)
+                self._logger.error(emailresult + error_message)
         if write_to_output_window:
             self._write_message_to_output(error_message, SEVERITY_ERROR)
         if raise_error:
@@ -87,6 +114,51 @@ def report_info(self, message, log_message=None, write_to_output_window=False):
         if write_to_output_window:
             self._write_message_to_output(message, SEVERITY_INFO)
 
+    # ----------------------------------
+    def emailalert(self, subject, body, owner, ishtml=False, emailOwner=False):
+        try:
+            globalsresource = self.get_config_set_pool_resource()
+            host = str(globalsresource.get_attribute("ConfigPool_SMTP_Server"))
+            port = str(globalsresource.get_attribute("ConfigPool_SMTP_port"))
+            emailfrom = str(globalsresource.get_attribute("ConfigPool_SMTP_from"))
+            emailto = emailfrom
+            emailcc = ''
+            emailbcc = ''
+
+            if emailOwner:
+                try:
+                    emailto = str(self.api_session.GetUserDetails(owner).Email)
+                    emailbcc = emailfrom
+                    body += "----\n A copy of this email was also sent to our support staff."
+                except:
+                    emailbcc = ''
+                    emailto = emailfrom
+
+            try:
+                if ishtml:
+                    emsg = MIMEText(body + '\n\n', 'html')
+                else:
+                    emsg = MIMEText(body + '\n\n', 'plain')
+
+                emsg['Subject'] = subject
+                emsg['From'] = emailfrom
+                emsg['To'] = ",".join([emailto])
+                emsg['CC'] = ""
+                emsg.preamble = subject
+                tolist = emailto.split(",") + emailcc.split(",") + emailbcc.split(",")
+                mailer = smtplib.SMTP(host=host, port=port)
+                mailer.sendmail(emailfrom, tolist, emsg.as_string())
+                return "Emailed OK"
+
+            except smtplib.SMTPException as e:
+                # cannot post again as error or we could be in a loop!
+                return ("ERROR Failed to send email, %s" % str(e))
+            except:
+                # cannot post again as error or we could be in a loop!
+                return "ERROR Failed to send email(1)"
+        except:
+            return "ERROR Failed to send email(2)"
+
     # ----------------------------------
     def get_root_resources(self):
         """
@@ -173,7 +245,8 @@ def clear_all_resources_live_status(self):
         """
         root_resources = self.get_root_resources()
         for resource in root_resources:
-            self.api_session.SetResourceLiveStatus(resource.name, '')
+            self.api_session.SetResourceLiveStatus(resource.name, liveStatusName="Info",
+                                                   additionalInfo='status cleared ' + strftime("%H:%M:%S", gmtime()))
 
     # ----------------------------------
     # ----------------------------------

sandbox_scripts/QualiEnvironmentUtils/StorageClients/TFTPClient.py

@@ -5,9 +5,10 @@
 import tempfile
 import pip
 
+
 try:
-    import tftpy
     imported_tftpy = True
+    import tftpy
 except:
     try:
         pip.main(["install","tftpy"])

sandbox_scripts/QualiEnvironmentUtils/StorageManager.py

@@ -26,6 +26,12 @@ def __init__(self, sandbox ):
 
     # ----------------------------------
     # ----------------------------------
+    #def _get_storage_client(self, storage_resource):
+    #    if storage_resource.model.lower() == 'generic tftp server':
+    #        return TFTPClient(self.sandbox,storage_resource)
+    #   elif storage_resource.model.lower() == 'generic ftp server':
+    #        return FTPClient(self.sandbox,storage_resource)
+
     def _get_storage_client(self, storage_resource):
         if storage_resource.model.lower() == 'generic tftp server':
             return TFTPClient(self.sandbox,storage_resource)

sandbox_scripts/QualiEnvironmentUtils/tests/DebugInteractive_setup_resources.py

@@ -1,10 +1,9 @@
 import cloudshell.helpers.scripts.cloudshell_dev_helpers as dev_helpers
 from sandbox_scripts.environment.setup.setup_resources import *
 
-dev_helpers.attach_to_cloudshell_as(user="admin", password="dev", domain="Global",
-                                    reservation_id="d7be79c2-57d0-4063-9ada-e27cd3c608a7",
+dev_helpers.attach_to_cloudshell_as(user="admin", password="xxx", domain="Global",
+                                    reservation_id="3a8cad5c-f197-4b1e-8739-70829957562f",
                                     server_address="svl-dev-quali")
-os.environ["environment_name"] = "Abstract-ALL"
 
 x = EnvironmentSetupResources()
-x.execute()
+x.execute()

sandbox_scripts/QualiEnvironmentUtils/tests/DebugInteractive_teardown_resources.py

@@ -0,0 +1,9 @@
+import cloudshell.helpers.scripts.cloudshell_dev_helpers as dev_helpers
+from sandbox_scripts.environment.teardown.teardown_resources import *
+
+dev_helpers.attach_to_cloudshell_as(user="admin", password="xx", domain="Global",
+                                    reservation_id="bc0517e5-7240-4184-b04d-19e755f9c9a7",
+                                    server_address="svl-dev-quali")
+
+x = EnvironmentTeardownResources()
+x.execute()

sandbox_scripts/QualiEnvironmentUtils/tests/test_Sandbox.py

@@ -6,12 +6,14 @@
 import json
 import os
 from cloudshell.api.common_cloudshell_api import CloudShellAPIError
+from freezegun import freeze_time
 
 resContext = '''{"id":"5487c6ce-d0b3-43e9-8ee7-e27af8406905",
  "ownerUser":"bob",
  "ownerPass":"nIqm+BG6ZGJjby5hUittVFFJASc=",
  "domain":"Global",
  "environmentName":"My environment",
+ "environmentPath":"My environment",
  "description":"New demo environment",
  "parameters":
    { "globalInputs": [],
@@ -202,9 +204,10 @@ def test_clear_all_resources_live_status_two_devices(self,mock_resourcebase):
         rr = [resource1, resource2]
         self.sandbox.get_root_resources = Mock(return_value=rr)
 
-        self.sandbox.clear_all_resources_live_status()
-        calls = [call('r1', ''),
-                 call('r2', '')]
+        with freeze_time("2017-01-17 12:00:01"):
+            self.sandbox.clear_all_resources_live_status()
+        calls = [call('r1', additionalInfo='status cleared 12:00:01', liveStatusName='Info'),
+                 call('r2', additionalInfo='status cleared 12:00:01', liveStatusName='Info')]
         self.mock_api_session.return_value.SetResourceLiveStatus.assert_has_calls(calls)
 
     #================================================================

sandbox_scripts/environment/setup/setup_VM.py

@@ -1,4 +1,9 @@
-from sandbox_scripts.helpers.Networking.NetworkingSaveNRestore import *
+from cloudshell.helpers.scripts import cloudshell_scripts_helpers as helpers
+from sandbox_scripts.helpers.Networking.save_restore_mgr import SaveRestoreManager
+from sandbox_scripts.QualiEnvironmentUtils.Sandbox import SandboxBase
+from cloudshell.core.logger.qs_logger import get_qs_logger
+from multiprocessing.pool import ThreadPool
+from threading import Lock
 
 
 class EnvironmentSetupVM(object):
@@ -19,7 +24,7 @@ def execute(self):
         reservation_details = self.sandbox.api_session.GetReservationDetails(self.reservation_id)
 
         #TODO: don't use networking save and restore to figure if it's a snapshot setup
-        saveNRestoreTool = NetworkingSaveRestore(self.sandbox)
+        saveNRestoreTool = SaveRestoreManager(self.sandbox)
         if saveNRestoreTool.get_storage_manager():
             if saveNRestoreTool.is_snapshot():
                 self.is_snapshot = True

sandbox_scripts/environment/teardown/teardown_VM.py

@@ -1,9 +1,11 @@
+from cloudshell.helpers.scripts import cloudshell_scripts_helpers as helpers
+from cloudshell.core.logger import qs_logger
+from sandbox_scripts.helpers.Networking.save_restore_mgr import SaveRestoreManager
+from sandbox_scripts.QualiEnvironmentUtils.Sandbox import SandboxBase
 from multiprocessing.pool import ThreadPool
 from threading import Lock
+from cloudshell.api.common_cloudshell_api import CloudShellAPIError
 
-from cloudshell.core.logger import qs_logger
-
-from sandbox_scripts.helpers.Networking.NetworkingSaveNRestore import *
 
 
 class EnvironmentTeardownVM:
@@ -25,7 +27,7 @@ def execute(self):
         reservation_details = self.sandbox.api_session.GetReservationDetails(self.reservation_id)
 
 
-        saveNRestoreTool = NetworkingSaveRestore(self.sandbox)
+        saveNRestoreTool = SaveRestoreManager(self.sandbox)
 
         filename = "Snapshot_"+self.reservation_id+".txt"
 

sandbox_scripts/environment/teardown/teardown_resources.py

@@ -3,7 +3,8 @@
 from cloudshell.helpers.scripts import cloudshell_scripts_helpers as helpers
 from sandbox_scripts.QualiEnvironmentUtils.Sandbox import SandboxBase
 from sandbox_scripts.helpers.Networking.save_restore_mgr import SaveRestoreManager
-from QualiUtils import QualiError
+from sandbox_scripts.QualiEnvironmentUtils.QualiUtils import QualiError
+import sys
 
 
 class EnvironmentTeardownResources:
@@ -18,14 +19,17 @@ def execute(self):
         sandbox = SandboxBase(self.reservation_id, self.logger)
         saveNRestoreTool = SaveRestoreManager(sandbox)
 
-        sandbox.report_info("Beginning load configuration for resources")
+        sandbox.report_info("Beginning load baseline configuration for resources", write_to_output_window=True)
         sandbox.clear_all_resources_live_status()
         try:
             if saveNRestoreTool.get_storage_manager():
                 ignore_models = ['Generic TFTP server', 'Config Set Pool', 'Generic FTP server', 'netscout switch 3912',
                              'OnPATH Switch 3903', 'Ixia Traffic generator', "SubNet-28", "SubNet-30", "GitLab"]
-                saveNRestoreTool.load_config(config_stage='Base', config_type='Running',
-                                         ignore_models=ignore_models, remove_temp_files=True, in_teardown_mode=True)
+                saveNRestoreTool.load_config(config_stage='Base',
+                                             config_type='Running',
+                                             ignore_models=ignore_models,
+                                             remove_temp_files=True,
+                                             in_teardown_mode=True)
             else:
                 sandbox.report_info("Skipping load configuration. No storage resource associated with the blueprint ",
                                     write_to_output_window=True)