Functional tests implementation for mscolab.py file

mslib/mscolab/conf.py

@@ -156,6 +156,10 @@ class setup_saml2_backend:
             #     }
             # },
         ]
+        #  Setting up the path from environment variables to settings is only for testing purposes
+        mscolab_settings.MSCOLAB_SSO_DIR = os.getenv("TESTING_MSCOLAB_SSO_DIR", mscolab_settings.MSCOLAB_SSO_DIR)
+        mscolab_settings.USE_SAML2 = bool(os.getenv("TESTING_USE_SAML2", mscolab_settings.USE_SAML2))
+
         if os.path.exists(f"{mscolab_settings.MSCOLAB_SSO_DIR}/mss_saml2_backend.yaml"):
             with open(f"{mscolab_settings.MSCOLAB_SSO_DIR}/mss_saml2_backend.yaml", encoding="utf-8") as fobj:
                 yaml_data = yaml.safe_load(fobj)

mslib/mscolab/mscolab.py

@@ -42,8 +42,14 @@
 from mslib.mscolab.utils import create_files
 from mslib.utils import setup_logging
 from mslib.utils.qt import Worker, Updater
+from mslib.mscolab import mscolab
+from mslib.msidp import idp_conf
 
 
+# ToDo: refactor after testing this is a work around just for testing
+import sys
+sys.path.append("../../")
+
 def handle_start(args):
     from mslib.mscolab.server import APP, initialize_managers, start_server
     setup_logging(args)
@@ -271,8 +277,10 @@ def handle_mscolab_metadata_init(repo_exists):
     print('generating metadata file for the mscolab server')
 
     try:
-        command = ["python", os.path.join("mslib", "mscolab", "mscolab.py"),
-                   "start"] if repo_exists else ["mscolab", "start"]
+        import sys
+        print(sys.path)
+
+        command = ["python", mscolab.__file__, "start"] if repo_exists else ["mscolab", "start"]
         process = subprocess.Popen(command)
         cmd_curl = ["curl", "--retry", "5", "--retry-connrefused", "--retry-delay", "3",
                     "http://localhost:8083/metadata/localhost_test_idp",
@@ -294,7 +302,7 @@ def handle_local_idp_metadata_init(repo_exists):
         if os.path.exists(os.path.join(mscolab_settings.MSCOLAB_SSO_DIR, "idp.xml")):
             os.remove(os.path.join(mscolab_settings.MSCOLAB_SSO_DIR, "idp.xml"))
 
-        idp_conf_path = os.path.join("mslib", "msidp", "idp_conf.py")
+        idp_conf_path = idp_conf.__file__
 
         if not repo_exists:
             import site

mslib/msidp/idp_conf.py

@@ -36,14 +36,15 @@
 from saml2.saml import NAME_FORMAT_URI
 from saml2.saml import NAMEID_FORMAT_PERSISTENT
 from saml2.saml import NAMEID_FORMAT_TRANSIENT
+from tests import constants
 
 XMLSEC_PATH = os.path.join(os.environ["CONDA_PREFIX"], "bin", "xmlsec1")
 
 # CRTs and metadata files can be generated through the mscolab server.
 # if configured that way CRTs DIRs should be same in both IDP and mscolab server.
 BASE_DIR = os.path.expanduser("~")
 DATA_DIR = os.path.join(BASE_DIR, "colabdata")
-MSCOLAB_SSO_DIR = os.path.join(DATA_DIR, 'datasso')
+MSCOLAB_SSO_DIR = os.getenv("TESTING_MSCOLAB_SSO_DIR", os.path.join(DATA_DIR, 'datasso'))
 
 BASEDIR = os.path.abspath(os.path.dirname(__file__))
 

tests/_test_mscolab/test_mscolab.py

@@ -25,16 +25,22 @@
     limitations under the License.
 """
 import os
+import argparse
 import pytest
 import mock
-import argparse
 from flask_testing import TestCase
 
 from mslib.mscolab.conf import mscolab_settings
 from mslib.mscolab.models import Operation, User, Permission
-from mslib.mscolab.mscolab import handle_db_reset, handle_db_seed, confirm_action, main
+from mslib.mscolab.mscolab import (handle_db_reset, handle_db_seed, confirm_action, main,
+                                   handle_mscolab_certificate_init, handle_local_idp_certificate_init,
+                                   handle_mscolab_backend_yaml_init, handle_mscolab_metadata_init,
+                                   handle_local_idp_metadata_init)
 from mslib.mscolab.server import APP
 from mslib.mscolab.seed import add_operation
+from tests import constants
+
+mscolab_settings.MSCOLAB_SSO_DIR = constants.MSCOLAB_SSO_DIR
 
 
 def test_confirm_action():
@@ -114,3 +120,104 @@ def test_handle_db_seed(self):
         assert len(all_users) == 10
         all_permissions = Permission.query.all()
         assert len(all_permissions) == 17
+
+    def test_handle_mscolab_certificate_init(self):
+        """
+        Test the initialization of the MSColab server certificate files.
+        This function tests the initialization process of the MSColab server certificate files
+        by calling the initialization function and checking if the generated key and
+        certificate files contain the expected content.
+        """
+        handle_mscolab_certificate_init()
+        file_key = os.path.join(mscolab_settings.MSCOLAB_SSO_DIR, 'key_mscolab.key')
+        key_content = ''
+        with open(file_key, 'r', encoding='utf-8') as file:
+            key_content = file.read()
+        assert "-----BEGIN PRIVATE KEY-----" in key_content
+        assert "-----END PRIVATE KEY-----" in key_content
+        file_cert = os.path.join(mscolab_settings.MSCOLAB_SSO_DIR, 'crt_mscolab.crt')
+        crt_content = ''
+        with open(file_cert, 'r', encoding='utf-8') as file:
+            crt_content = file.read()
+        assert "-----BEGIN CERTIFICATE-----" in crt_content
+        assert "-----END CERTIFICATE-----" in crt_content
+
+    def test_handle_local_idp_certificate_init(self):
+        """
+        Test the initialization of the local Identity Provider (IDP) certificate files.
+        This function tests the initialization process of the local IDP certificate files
+        by calling the initialization function and checking if the generated key and
+        certificate files contain the expected content.
+        """
+
+        handle_local_idp_certificate_init()
+        file_key = os.path.join(mscolab_settings.MSCOLAB_SSO_DIR, 'key_local_idp.key')
+        key_content = ''
+        with open(file_key, 'r', encoding='utf-8') as file:
+            key_content = file.read()
+        assert "-----BEGIN PRIVATE KEY-----" in key_content
+        assert "-----END PRIVATE KEY-----" in key_content
+        file_crt = os.path.join(mscolab_settings.MSCOLAB_SSO_DIR, 'crt_local_idp.crt')
+        crt_content = ''
+        with open(file_crt, 'r', encoding='utf-8') as file:
+            crt_content = file.read()
+        assert "-----BEGIN CERTIFICATE-----" in crt_content
+        assert "-----END CERTIFICATE-----" in crt_content
+
+    def test_handle_mscolab_backend_yaml_init(self):
+        """
+        Test the initialization of MScolab backend YAML configuration.
+        This function tests the initialization process of the MScolab backend YAML
+        """
+
+        handle_mscolab_backend_yaml_init()
+        file_yaml = os.path.join(mscolab_settings.MSCOLAB_SSO_DIR, 'mss_saml2_backend.yaml')
+        mss_saml2_backend_content = ''
+        with open(file_yaml, 'r', encoding='utf-8') as file:
+            mss_saml2_backend_content = file.read()
+        assert "localhost_test_idp" in mss_saml2_backend_content
+        assert "entityid_endpoint" in mss_saml2_backend_content
+
+    def test_handle_mscolab_metadata_init(self):
+        """
+        Test the initialization of MSColab server metadata.
+        This function tests the initialization process of MSColab server metadata
+        by calling several initialization functions and checking if the expected
+        content is present in the generated metadata XML file.
+        """
+        #  set TESTING_USE_SAML2 and MSCOLAB_SSO_DIRthrough envs
+        os.environ['TESTING_MSCOLAB_SSO_DIR'] = mscolab_settings.MSCOLAB_SSO_DIR
+        os.environ['TESTING_USE_SAML2'] = "True"
+
+        handle_mscolab_certificate_init()
+        handle_mscolab_backend_yaml_init()
+        mscolab_settings.USE_SAML2 = True
+        assert handle_mscolab_metadata_init(True) is True
+        metadata_xml = os.path.join(mscolab_settings.MSCOLAB_SSO_DIR, 'metadata_sp.xml')
+        metadata_content = ''
+        with open(metadata_xml, 'r', encoding='utf-8') as file:
+            metadata_content = file.read()
+        assert "urn:oasis:names:tc:SAML:2.0:metadata" in metadata_content
+
+    def test_handle_local_idp_metadata_init(self):
+        """
+        Test the initialization of local Identity Provider (IDP) metadata.
+        This function tests the initialization process of local IDP metadata
+        by calling several initialization functions and checking if the expected
+        content is present in the generated metadata XML file.
+        """
+        #  set TESTING_USE_SAML2 and MSCOLAB_SSO_DIRthrough envs
+        os.environ['TESTING_MSCOLAB_SSO_DIR'] = mscolab_settings.MSCOLAB_SSO_DIR
+        os.environ['TESTING_USE_SAML2'] = "True"
+
+        handle_local_idp_certificate_init()
+        handle_mscolab_backend_yaml_init()
+        handle_mscolab_certificate_init()
+        mscolab_settings.USE_SAML2 = True
+        handle_mscolab_metadata_init(True)
+        assert handle_local_idp_metadata_init(True) is True
+        idp_xml = os.path.join(mscolab_settings.MSCOLAB_SSO_DIR, 'metadata_sp.xml')
+        idp_content = ''
+        with open(idp_xml, 'r', encoding='utf-8') as file:
+            idp_content = file.read()
+        assert "urn:oasis:names:tc:SAML:2.0:metadata" in idp_content

tests/constants.py

@@ -63,6 +63,10 @@
 # we keep DATA_DIR until we move netCDF4 files to pyfilesystem2
 DATA_DIR = DATA_FS.getsyspath("")
 
+# set MSCOLAB_SSO_DIR through envs
+MSCOLAB_SSO_DIR = os.path.join(os.path.expanduser("~"), 'testingdatasso')
+
+
 # deployed mscolab url
 MSCOLAB_URL = "http://localhost:8083"
 # mscolab test server's url