Feature/dan ci integration tests

.github/workflows/ci.yml

@@ -44,7 +44,21 @@ jobs:
           python -m pip install --upgrade pip
           chmod +x ci_deploy.sh
           ./ci_deploy.sh
-      - name: Test with unittest
+      - name: Test unit tests with unittest
         run: |
           python -m unittest
+      - name: Test integration tests for package/tests/integration_tests
+        env:
+          GH_TOKEN_DEC: ${{ secrets.GH_TOKEN_DEC }}
+          CURRENT_BRANCH: ${{ env.BRANCH_NAME }}
+          AZURE_APPLICATION_KEY_DEC: ${{ secrets.AZURE_APPLICATION_KEY_DEC }}
+          AZURE_SUBSCRIPTION_ID: ${{ secrets.AZURE_SUBSCRIPTION_ID }}
+          AZURE_TENANT_ID: ${{ secrets.AZURE_TENANT_ID }}
+          AZURE_APPLICATION_ID: ${{ secrets.AZURE_APPLICATION_ID }}
 
+
+        run: |
+          pwd
+          echo "1: ${{ env.BRANCH_NAME }}"
+
+          python -m unittest discover -p "package/tests/integration_tests/mock_api_based_tests/int_test_mock*.py"

.gitignore

@@ -11,6 +11,7 @@ __pycache__/
 .idea/
 venv/
 package/tests/.env
+package/tests/integration_tests/.env
 env/
 build/
 develop-eggs/
@@ -64,4 +65,5 @@ cloudshell_config.yml
 
 # env files
 *.env
-!*.template.env
+!*.template.env
+!package/tests/integration_tests/int_tests.env

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

@@ -13,7 +13,7 @@ def set_env_vars_based_on_clp(self):
 
     @staticmethod
     def does_attribute_match(clp_res_model, clp_attribute, attr_name_to_check) -> bool:
-        if f"{clp_res_model}.{clp_attribute.Name}" == attr_name_to_check or clp_attribute.Name == attr_name_to_check:
+        if f"{clp_res_model}.{attr_name_to_check}" == clp_attribute.Name or attr_name_to_check == clp_attribute.Name:
             return True
         return False
 
@@ -57,11 +57,11 @@ def __init__(self, clp_res_model, clp_resource_attributes, shell_helper):
 
     def set_env_vars_based_on_clp(self):
         for attr in self._clp_resource_attributes:
-            if self.does_attribute_match(self._clp_res_model, attr, self._shell_helper, "Azure Subscription ID"):
+            if self.does_attribute_match(self._clp_res_model, attr, "Azure Subscription ID"):
                 os.environ["ARM_SUBSCRIPTION_ID"] = attr.Value
-            if self.does_attribute_match(self._clp_res_model, attr, self._shell_helper, "Azure Tenant ID"):
-                os.environ["Azure Tenant ID"] = attr.Value
-            if self.does_attribute_match(self._clp_res_model, attr, self._shell_helper, "Azure Application ID"):
+            if self.does_attribute_match(self._clp_res_model, attr, "Azure Tenant ID"):
+                os.environ["ARM_TENANT_ID"] = attr.Value
+            if self.does_attribute_match(self._clp_res_model, attr, "Azure Application ID"):
                 os.environ["ARM_CLIENT_ID"] = attr.Value
-            if self.does_attribute_match(self._clp_res_model, attr, self._shell_helper, "Azure Application Key", True):
+            if self.does_attribute_match(self._clp_res_model, attr, "Azure Application Key"):
                 os.environ["ARM_CLIENT_SECRET"] = self._shell_helper.api.DecryptPassword(attr.Value).Value

package/cloudshell/iac/terraform/terraform_shell.py

@@ -85,6 +85,9 @@ def _validate_remote_backend_or_existing_working_dir(self, sandbox_data_handler,
                 not LocalDir.does_working_dir_exists(sandbox_data_handler.get_tf_working_dir()):
             self._handle_error_output(shell_helper, f"Missing local folder {sandbox_data_handler.get_tf_working_dir()}")
 
+    def get_tf_service(self):
+        return self._tf_service
+
     @staticmethod
     def _destroy_passed(sandbox_data_handler):
         return sandbox_data_handler.get_status(DESTROY_STATUS) == DESTROY_PASSED

package/requirements.txt

@@ -1,5 +1,5 @@
 cloudshell-shell-core==5.0.5
 requests==2.25.1
-cloudshell-automation-api==2021.1.0.181140
+cloudshell-automation-api==2021.2.0.182230
 retry==0.9.2
 python-hcl2==2.0.1

package/test_requirements.txt

@@ -1,2 +1,6 @@
 mock==4.0.3
 python-dotenv==0.18.0
+pathlib==1.0.1
+
+#azure-common==1.1.27
+#azure-mgmt==5.0.0

package/tests/constants.py

@@ -1,5 +1,5 @@
-GITHUB_TF_PUBLIC_HELLO_URL_FILE = "https://github.com/QualiSystemsLab/CloudShell-Terraform-Shell/blob/master/package/tests/tests_helper_files/tf_modules/hello/hello.tf"
-GITHUB_TF_PUBLIC_HELLO_URL_FOLDER = "https://github.com/QualiSystemsLab/CloudShell-Terraform-Shell/tree/master/package/tests/tests_helper_files/tf_modules/hello"
+GH_TF_PUBLIC_HELLO_URL_FILE = "https://github.com/QualiSystemsLab/CloudShell-Terraform-Shell/blob/master/package/tests/tests_helper_files/tf_modules/hello/hello.tf"
+GH_TF_PUBLIC_HELLO_URL_FOLDER = "https://github.com/QualiSystemsLab/CloudShell-Terraform-Shell/tree/master/package/tests/tests_helper_files/tf_modules/hello"
 
 
 TF_STATE_FILE_STRING = 'tf_state_file_string'
@@ -8,3 +8,6 @@
 TERRAFORM_EXEC_FILE = "terraform.exe"
 TF_HELLO_FILE = "hello.tf"
 SHELL_NAME = "Generic Terraform Service"
+
+MOCK_ALIAS1 = "MOCK_ALIAS1"
+MOCK_ALIAS2 = "MOCK_ALIAS2"

package/tests/integration_tests/INT-TEST-README.md

@@ -0,0 +1,91 @@
+# Integration Tests for CloudShell-Terraform-Shell 
+
+The purpose of this documentation section is to provide explanations regarding different aspects of the integrations tests usage and concepts used the making.
+
+## Content
+
+1) Structure
+2) Helper Objects/Services
+3) How to:
+   1) Run
+   2) Extend
+
+### Structure
+
+The Integration tests are devided into two types:
+1) Mocked (mock_api_based_tests)
+2) Real (real_api_based_tests)
+
+The Mocked (*1) tests will be using the Mock API (multiple patched functions of the API) during tests
+for that it shall also use the MockAPIIntegrationData Object that inherits from BaseIntegrationData part of helper_objects\integration_context.py
+
+he Real (*2) tests will be using the Real API (Communicate with an actual live CloudShell server) during tests
+* for that one would need to create a int_tests_secrets.env file based on the values mentioned in int_tests_secrets.template.env
+  in order for the test to work.
+* In addition, one must also create a blueprint (and a derived sandbox) with two services (which the tests will use for running the tests) 
+for that it shall also use the RealAPIIntegrationData Object that inherits from BaseIntegrationData part of helper_objects\integration_context.py
+
+### Helper Objects/Services
+
+1) Helper Object (helper_objects)
+   1) Environment Variables (helper_objects\env_vars.py)
+      * Used to hold generatl information regarding the Real reservation testing against
+   2) Integration Context Data (helper_objects\integration_context.py)
+      * Used both by "Real" and "Mocked" in order to construct the data for the tests wether real or mocked 
+2) Helper Services (helper_services)
+   1) Serice Attributes Factory (helper_services\service_attributes_factory.py)
+      * Used by "Mocked" tests to create empty attributes
+
+### How To
+
+#### Run
+prerequisite: have a a unit tests plugin installed (e.g. unittests)
+
+   1) As IDEs have sometimes issues with importing packages, best way is to open the project from it`s "Package" as root dir
+   2) For running real tests:
+      1) Instantiate a CloudShell server
+      2) Create a blueprint with two TF Services
+      3) create a int_tests_secrets.env file and fill it with the variables (and their values) from int_tests_secrets.template.env
+   3) For mock tests:
+      1) either from IDE or CLI : python -m unittest discover -p "int_test_mock*.py"
+
+#### Extend
+
+Test cases part of int_test_mock_tf_execute_destroy.py have several sections:
+
+1) Patching (bypassing the use of real api / server requirements):
+
+ For example:
+
+    @patch('cloudshell.iac.terraform.services.tf_proc_exec.TfProcExec.can_destroy_run')
+    @patch('cloudshell.iac.terraform.terraform_shell.SandboxDataHandler')
+    @patch('cloudshell.iac.terraform.services.object_factory.CloudShellSessionContext')
+
+2) Making sure the patched functions/objects are initialized with the right values:
+
+ For example:
+
+    def test_execute_and_destroy_azure_vault(self, patch_api, patched_sbdata_handler, can_destroy_run):
+
+        can_destroy_run.return_value = True
+
+        patch_api.return_value.get_api.return_value = self.mock_api
+
+        mock_sbdata_handler = Mock()
+        mock_sbdata_handler.get_tf_working_dir = self._get_mocked_tf_working_dir
+        mock_sbdata_handler.set_tf_working_dir = self._set_mocked_tf_working_dir
+        patched_sbdata_handler.return_value = mock_sbdata_handler
+
+3) the run_execute_and_destroy function that holds 3 parameters
+   what function needs to run before executing
+      * create such a function and modify the attributes values there, so it will match the test case requirements here 
+   what function needs to run before destroying
+   The data used for the test (self.integration_data1)
+
+ For example:
+
+self.run_execute_and_destroy(
+            pre_exec_function=self.pre_exec_azure_vault,
+            pre_destroy_function=self.pre_destroy,
+            integration_data=self.integration_data1
+        )

shells/generic_terraform_service/tests/integration_tests/constants.py → package/tests/integration_tests/constants.py

@@ -1,5 +1,7 @@
 SHELL_NAME = "Generic Terraform Service"
-UUID_ATTRIBUTE = f"{SHELL_NAME}.UUID"
+
+INT_TEST_TF_VER = "0.15.1"
+INT_TEST_CLP_RESOURSE = "real_azure"
 
 
 class ATTRIBUTE_NAMES:
@@ -17,3 +19,8 @@ class ATTRIBUTE_NAMES:
     BRANCH = "Branch"
     CLOUD_PROVIDER = "Cloud Provider"
     UUID = "UUID"
+
+
+EXPECTED_VAULT_TF_OUTPUTS = "BLA1=bla1,BLA2=bla2"
+EXPECTED_VAULT_TF_SENSETIVE_OUTPUTS_DEC = "SECRET_VALUE=test,SECRET_VALUE_2=my_secret"
+EXPECTED_VAULT_TF_SENSETIVE_OUTPUTS_ENC = 'nwH0Qhxnn7ntDpWxsvol+89EPFFSvYE16gHjACzsQRDzvXXnNFc4WfYpgq5w1kw8'

package/tests/integration_tests/helper_objects/integration_context.py

@@ -1,51 +1,88 @@
 from unittest import mock
+from unittest.mock import Mock
 
 from cloudshell.api.cloudshell_api import CloudShellAPISession
+from cloudshell.iac.terraform import TerraformShell, TerraformShellConfig
 from cloudshell.logging.qs_logger import get_qs_logger
 from cloudshell.shell.core.driver_context import ResourceCommandContext
 
-
+# from tests.integration_tests.helper_objects.env_vars import EnvVars
 from package.tests.integration_tests.helper_objects.env_vars import EnvVars
+# from tests.integration_tests.helper_services.service_attributes_factory import ServiceAttributesMockBuilder
+from package.tests.integration_tests.helper_services.service_attributes_factory import ServiceAttributesMockBuilder
+
+from abc import ABCMeta, abstractmethod
+
+
+class BaseIntegrationData(metaclass=ABCMeta):
+    def __init__(self, service_name: str):
+        self._sb_service_alias = service_name
+        self._logger = get_qs_logger(log_group=service_name)
+
+        self._build_context()
+        self._set_general_context_resource_data()
+        self._set_context()
+        self.create_tf_shell()
+
+    @abstractmethod
+    def _set_context(self):
+        raise NotImplementedError()
+
+    def _build_context(self):
+        self.context = mock.create_autospec(ResourceCommandContext)
+        self.context.connectivity = Mock()
+
+    def _set_general_context_resource_data(self):
+        self.context.resource = Mock()
+        self.context.resource.attributes = dict()
+        self.context.resource.name = self._sb_service_alias
+        self.context.resource.model = 'Generic Terraform Service'
 
+    def create_tf_shell(self):
+        _config = TerraformShellConfig(write_sandbox_messages=True, update_live_status=True)
+        self.tf_shell = TerraformShell(self.context, self._logger, _config)
 
-class IntegrationData(object):
-    def __init__(self):
+
+class RealAPIIntegrationData(BaseIntegrationData):
+    def __init__(self, service_name: str):
         self._env_vars = EnvVars()
-        self.real_api = CloudShellAPISession(
+        self.api = CloudShellAPISession(
             self._env_vars.cs_server,
             self._env_vars.cs_user,
             self._env_vars.cs_pass,
             self._env_vars.cs_domain
         )
-        self._set_context()
-        self._logger = get_qs_logger(log_group=self.context.resource.name)
-
-        # self._create_driver()
+        BaseIntegrationData.__init__(self, service_name)
 
     def _set_context(self):
-        self.context = mock.create_autospec(ResourceCommandContext)
-        self.context.connectivity = mock.MagicMock()
         self.context.connectivity.server_address = self._env_vars.cs_server
-        self.context.connectivity.admin_auth_token = self.real_api.authentication.xmlrpc_token
-
-        self.context.resource = mock.MagicMock()
-        self.context.resource.attributes = dict()
-        self.context.resource.name = self._env_vars.sb_service_alias
-        self.context.resource.model = 'Generic Terraform Service'
-        self.set_context_resource_attributes()
-
-        self.context.reservation = mock.MagicMock()
+        self.context.connectivity.admin_auth_token = self.api.authentication.xmlrpc_token
+        self.set_context_resource_attributes_from_cs()
+        self.context.reservation = Mock()
         self.context.reservation.reservation_id = self._env_vars.cs_res_id
         self.context.reservation.domain = self._env_vars.cs_domain
 
-    def set_context_resource_attributes(self):
-        services = self.real_api.GetReservationDetails(self._env_vars.cs_res_id).ReservationDescription.Services
+    def set_context_resource_attributes_from_cs(self, the_only_attribute_to_update: str = ""):
+        services = self.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:
+            if service.Alias == self._sb_service_alias:
                 for attribute in service.Attributes:
-                    self.context.resource.attributes[attribute.Name] = attribute.Value
-    '''
-    def _create_driver(self) :
-        self.driver = GenericTerraformServiceDriver()
-        self.driver.initialize(self.context)
-    '''
+                    if the_only_attribute_to_update and attribute.Name == the_only_attribute_to_update:
+                        self.context.resource.attributes[attribute.Name] = attribute.Value
+                        return
+                    elif not the_only_attribute_to_update:
+                        self.context.resource.attributes[attribute.Name] = attribute.Value
+
+
+class MockAPIIntegrationData(BaseIntegrationData):
+    def __init__(self, service_name: str, mock_api: Mock):
+        self.api = mock_api
+        self.api.authentication.xmlrpc_token = Mock()
+
+        BaseIntegrationData.__init__(self, service_name)
+
+    def _set_context(self):
+        self.context.resource.attributes = ServiceAttributesMockBuilder.create_empty_attributes()
+        self.context.reservation = Mock()
+        self.context.reservation.reservation_id = "mock_reservation_id"

package/tests/integration_tests/helper_objects/mock_tests_data.py

@@ -0,0 +1,63 @@
+import os
+from unittest.mock import Mock
+
+from package.tests.integration_tests.helper_objects.integration_context import MockAPIIntegrationData
+from package.tests.integration_tests.helper_services.service_attributes_factory import ServiceAttributesMockBuilder
+
+from cloudshell.api.cloudshell_api import NameValuePair
+
+
+class MockTestsData(object):
+    def __init__(self):
+        self.mock_api = Mock()
+        self.service1 = Mock()
+        self.service2 = Mock()
+        self._mocked_tf_working_dir = ''
+        self.service1.Alias = ''
+        self.service1.Attributes = None
+        self.service2.Alias = ''
+        self.service2.Attributes = None
+
+        self._prepare_mock_services()
+        self._prepare_mock_api()
+
+    def prepare_integration_data(self):
+        self.integration_data1 = MockAPIIntegrationData(self.service1.Alias, self.mock_api)
+        self.integration_data2 = MockAPIIntegrationData(self.service2.Alias, self.mock_api)
+
+    def _prepare_mock_services(self):
+        self.service1 = Mock()
+        self.service1.Alias = "MOCK_ALIAS1"
+        self.service1.Attributes = ServiceAttributesMockBuilder.create_empty_attributes()
+        self.service2 = Mock()
+        self.service2.Alias = "MOCK_ALIAS2"
+        self.service2.Attributes = ServiceAttributesMockBuilder.create_empty_attributes()
+
+    def _prepare_mock_api(self):
+        self.mock_api = Mock()
+        self.mock_api.DecryptPassword = _decrypt_password
+        self.mock_api.GetReservationDetails.return_value.ReservationDescription.Services = [self.service1,
+                                                                                            self.service2]
+
+        # self.mock_api.SetServiceAttributesValues = self._set_service_attributes_values
+
+        self.mock_api.GetResourceDetails.return_value.ResourceFamilyName = 'Cloud Provider'
+        self.mock_api.GetResourceDetails.return_value.ResourceModelName = 'Microsoft Azure'
+        self.mock_api.GetResourceDetails.return_value.ResourceAttributes = [
+            NameValuePair(Name="Azure Subscription ID", Value=os.environ.get("AZURE_SUBSCRIPTION_ID")),
+            NameValuePair(Name="Azure Tenant ID", Value=os.environ.get("AZURE_TENANT_ID")),
+            NameValuePair(Name="Azure Application ID", Value=os.environ.get("AZURE_APPLICATION_ID")),
+            NameValuePair(Name="Azure Application Key", Value=os.environ.get("AZURE_APPLICATION_KEY_DEC"))
+        ]
+
+    def _get_mocked_tf_working_dir(self):
+        return self._mocked_tf_working_dir
+
+    def _set_mocked_tf_working_dir(self, tf_working_dir: str):
+        self._mocked_tf_working_dir = tf_working_dir
+
+
+def _decrypt_password(x):
+    result = Mock()
+    result.Value = x
+    return result