fixses per Alex PR remarks

Author: dan-amzulescu

package/cloudshell/iac/terraform/models/exceptions.py

@@ -2,3 +2,9 @@ class TerraformExecutionError(Exception):
     def __init__(self, message, std_out=""):
         self.message = message + std_out
         super().__init__(self.message)
+
+
+class TerraformAutoTagsError(Exception):
+    def __init__(self, message, std_out=""):
+        self.message = message + std_out
+        super().__init__(self.message)

package/cloudshell/iac/terraform/services/object_factory.py

@@ -22,7 +22,7 @@ class ObjectFactory:
     def create_tf_proc_executer(config: TerraformShellConfig,
                                 sandbox_data_handler: SandboxDataHandler,
                                 shell_helper: ShellHelperObject,
-                                tf_working_dir: str):
+                                tf_working_dir: str) -> TfProcExec:
         backend_handler = BackendHandler(shell_helper, tf_working_dir, sandbox_data_handler.get_tf_uuid())
         input_output_service = InputOutputService(shell_helper, config.inputs_map, config.outputs_map)
         tf_proc_executer = TfProcExec(shell_helper, sandbox_data_handler, backend_handler, input_output_service)

package/cloudshell/iac/terraform/tagging/tag_terraform_resources.py

@@ -12,6 +12,8 @@
 
 
 # =====================================================================================================================
+from cloudshell.iac.terraform.models.exceptions import TerraformAutoTagsError
+
 
 class Constants:
     TAGS = "tags"  # used for tag aws and azure resources in terraform
@@ -119,6 +121,7 @@ def write_error(msg: str, code_line: int = None):
 
 # =====================================================================================================================
 
+
 def parse_comma_separated_string(params_string: str = None) -> dict:
     res = {}
 
@@ -230,7 +233,6 @@ def _init_colony_autoScaling_tags_flat_maps_list(self):
         list_of_maps_value = " ,\n\t\t".join(colony_tags_to_list)
         self.colony_autoScaling_tags_flat_maps_list = f"\nlist(\n\t\t{list_of_maps_value}\n)"
 
-
     def _get_basic_override_tags_template(self, resource_type: str, resource_name: str, tags: str) -> str:
         tags_label = Constants.LABELS if resource_type.startswith("kubernetes_") else Constants.TAGS
         return """
@@ -559,7 +561,7 @@ def _get_untaggable_resources_types_from_plan_output(text: str) -> List[str]:
 
 def start_tagging_terraform_resources(main_dir_path: str, logger, tags_dict: dict, inputs_dict: dict = dict()):
     if not os.path.exists(main_dir_path):
-        raise ValueError(f"Path {main_dir_path} does not exist")
+        raise TerraformAutoTagsError(f"Path {main_dir_path} does not exist")
     tfs_folder_path = main_dir_path
     # log_path = Constants.get_override_log_path(main_dir_path)
     # colony_tags_file_path = Constants.get_colony_tags_path(main_dir_path)
@@ -580,7 +582,7 @@ def start_tagging_terraform_resources(main_dir_path: str, logger, tags_dict: dic
 
         # Had to change exit(3) to "raise" so exception can be handled outside
         #exit(3)
-        raise ValueError("Exit before the override procedure began because the init/plan failed")
+        raise TerraformAutoTagsError("Validation errors during Terraform Init/Plan when applying automated tags")
     LoggerHelper.write_info(f"terraform init & plan passed successfully")
 
     tags_templates_creator = OverrideTagsTemplatesCreator(tags_dict)
@@ -648,14 +650,15 @@ def start_tagging_terraform_resources(main_dir_path: str, logger, tags_dict: dic
                 LoggerHelper.write_error("Tagging terraform resources operation has FAILED !!!!!")
                 # Had to change exit(1) to "raise" so exception can be handled outside
                 # exit(1)
-                raise ValueError("Errors were found in the last validation check")
+                raise TerraformAutoTagsError("Errors were found in the last validation check")
 
         else:
             LoggerHelper.write_warning("No untaggable resources were found, but errors in plan file do exists")
             LoggerHelper.write_error("Tagging terraform resources operation has FAILED !!!!!")
             # Had to change exit(1) to "raise" so exception can be handled outside
             # exit(1)
-            raise ValueError("No untaggable resources were found, but errors in plan file do exists")
+            raise TerraformAutoTagsError("No untaggable resources were found, but there is an error in Terraform "
+                                         "Plan when applying automated tags. Please check the logs for more details")
     else:
         LoggerHelper.write_info("No errors founds in plan output")
 

shells/generic_terraform_service/tests/integration_tests/helper_objects/integration_context.py

@@ -48,7 +48,8 @@ def _set_context(self):
         self.context.reservation.domain = self._env_vars.cs_domain
 
     def set_context_resource_attributes(self, the_only_attribute_to_update=""):
-        services = self.real_api.GetReservationDetails(self._env_vars.cs_res_id, disableCache=True).ReservationDescription.Services
+        services = self.real_api.GetReservationDetails(self._env_vars.cs_res_id, disableCache=True)\
+            .ReservationDescription.Services
         for service in services:
             if service.Alias == self._env_vars.sb_service_alias:
                 for attribute in service.Attributes:

shells/generic_terraform_service/tests/integration_tests/int_test_tf_execute_destroy.py

@@ -1,7 +1,7 @@
-import function as function
 from cloudshell.api.cloudshell_api import AttributeNameValue
 from dotenv import load_dotenv
 from tests.integration_tests.constants import SHELL_NAME
+from typing import Callable
 
 from tests.integration_tests.helper_objects.integration_context import IntegrationData
 
@@ -16,19 +16,19 @@ def setUp(self) -> None:
         self.integration_data2 = IntegrationData(os.environ.get("SB_SERVICE_ALIAS2"))
 
     def run_execute_and_destroy(
-            self, pre_exec_function: function,
-            pre_destroy_function: function,
+            self, pre_exec_function: Callable,
+            pre_destroy_function: Callable,
             integration_data: IntegrationData
     ):
         self.clear_sb_data()
         self.run_execute(pre_exec_function, integration_data)
         self.run_destroy(pre_destroy_function, integration_data)
 
-    def run_execute(self, pre_exec_function: function, integration_data: IntegrationData):
+    def run_execute(self, pre_exec_function: Callable, integration_data: IntegrationData):
         self.pre_exec_prep(pre_exec_function, integration_data)
         integration_data.driver.execute_terraform(integration_data.context)
 
-    def run_destroy(self,pre_destroy_function: function, integration_data: IntegrationData):
+    def run_destroy(self,pre_destroy_function: Callable, integration_data: IntegrationData):
         self.pre_destroy_prep(pre_destroy_function, integration_data)
         integration_data.driver.destroy_terraform(integration_data.context)
 
@@ -104,10 +104,10 @@ def test_execute_and_destroy_azure_vault_without_remote(self):
 
     '''------------------------------ Functions : general _pre prep functions ---------------------------------'''
 
-    def pre_exec_prep(self, pre_exec_function: function, integration_data: IntegrationData):
+    def pre_exec_prep(self, pre_exec_function: Callable, integration_data: IntegrationData):
         pre_exec_function(integration_data)
 
-    def pre_destroy_prep(self, pre_destroy_function: function, integration_data: IntegrationData):
+    def pre_destroy_prep(self, pre_destroy_function: Callable, integration_data: IntegrationData):
         pre_destroy_function(integration_data)
 
     def clear_sb_data(self):

shells/generic_terraform_service/tests/test_requirements.txt

@@ -1,3 +1,2 @@
 cloudshell-iac-terraform==0.1.0
-function==1.2.0
 python-dotenv==0.18.0