Merge pull request privacera#253 from SiddheshwarKamble/securechat_update_apikey_name

Update apikey name from PAIG_API_KEY to PAIG_APP_API_KEY

Author: pravin-bansod

paig-securechat/web-server/src/paig_securechat/app/server.py

@@ -20,7 +20,7 @@
 from fastapi.responses import HTMLResponse
 import os
 from core import constants
-from core.utils import set_paig_api_key
+from core.utils import set_paig_app_api_key
 import webbrowser
 import logging
 from fastapi.exceptions import RequestValidationError
@@ -136,7 +136,7 @@ def make_middleware() -> List[Middleware]:
 
 def create_app() -> FastAPI:
     init_settings()
-    set_paig_api_key()
+    set_paig_app_api_key()
     init_paig_shield()
     init_vector_db()
     app_ = FastAPI(

paig-securechat/web-server/src/paig_securechat/core/utils.py

@@ -82,13 +82,13 @@ def set_up_standalone_mode(
     constants.SINGLE_USER_MODE = single_user_mode
 
 
-def set_paig_api_key():
+def set_paig_app_api_key():
     from core import config
     conf = config.Config
-    if 'PAIG_API_KEY' not in os.environ:
+    if 'PAIG_APP_API_KEY' not in os.environ:
         if 'paig' in conf and 'key_file' in conf['paig']:
             key_file_path = conf['paig']['key_file']
             if os.path.exists(key_file_path):
                 with open(key_file_path, 'r') as file:
-                    paig_api_key = file.read().strip()
-                    os.environ["PAIG_API_KEY"] = paig_api_key
+                    paig_app_api_key = file.read().strip()
+                    os.environ["PAIG_APP_API_KEY"] = paig_app_api_key

paig-securechat/web-server/src/paig_securechat/services/paig_shield.py

@@ -24,9 +24,9 @@ def setup_shield_client(self):
                 paig_shield_client.setup(frameworks=self.ai_application_conf["shield_frameworks"])
             except paig_client.exception.AccessControlException as err:
                 logger.error(f"PAIG Shield plugin setup failed with error {err}")
-                if 'PAIG_API_KEY' in os.environ:
-                    logger.error(f"Invalid PAIG_API_KEY key.")
-                    sys.exit('PAIG Shield plugin setup failed. Please provide valid PAIG_API_KEY key.')
+                if 'PAIG_APP_API_KEY' in os.environ:
+                    logger.error(f"Invalid PAIG_APP_API_KEY key.")
+                    sys.exit('PAIG Shield plugin setup failed. Please provide valid PAIG_APP_API_KEY key.')
                 elif 'PRIVACERA_SHIELD_CONF_FILE' in os.environ:
                     logger.error(f"PAIG Shield configuration file used is {os.environ['PRIVACERA_SHIELD_CONF_FILE']}")
                     sys.exit(f"PAIG Shield plugin setup failed. Please confirm if the configuration file {os.environ['PRIVACERA_SHIELD_CONF_FILE']} is correct and exists")
@@ -37,8 +37,8 @@ def paig_shield_setup_app_with_file(self, ai_application_name, paig_shield_confi
         """Handles PAIG Shield setup using a configuration file."""
         if not paig_shield_config_file:
             if app_count > 1:
-                logger.error(f"AI Application {ai_application_name} missing required 'paig_api_key' or 'paig_shield_config_file' in configuration file")
-                sys.exit(f"AI Application {ai_application_name} missing required 'paig_api_key' or 'paig_shield_config_file' configuration file")
+                logger.error(f"AI Application {ai_application_name} missing required 'paig_app_api_key' or 'paig_shield_config_file' in configuration file")
+                sys.exit(f"AI Application {ai_application_name} missing required 'paig_app_api_key' or 'paig_shield_config_file' configuration file")
             if 'PRIVACERA_SHIELD_CONF_FILE' in os.environ:
                 logger.info(f"AI Application {ai_application_name} setup using 'PRIVACERA_SHIELD_CONF_FILE' environment variable")
                 return
@@ -60,20 +60,20 @@ def paig_shield_setup_app_with_file(self, ai_application_name, paig_shield_confi
 
     def set_paig_config_map(self, ai_application_name, ai_application_config, app_count):
         """Sets up PAIG Shield configuration using either API key or config file."""
-        paig_api_key = ai_application_config.get('paig_api_key')
+        paig_app_api_key = ai_application_config.get('paig_app_api_key')
 
-        if paig_api_key:
+        if paig_app_api_key:
             try:
-                ai_app = paig_shield_client.setup_app(application_config_api_key=paig_api_key)
+                ai_app = paig_shield_client.setup_app(application_config_api_key=paig_app_api_key)
                 self.paig_config_map[ai_application_name] = ai_app
             except paig_client.exception.AccessControlException as err:
                 logger.error(f"PAIG Shield plugin setup failed for {ai_application_name} with error {err}")
                 sys.exit(f"PAIG Shield plugin setup failed for {ai_application_name} with error {err}")
             return
 
-        if app_count == 1 and 'PAIG_API_KEY' in os.environ:
-            logger.info(f"AI Application {ai_application_name} setup using 'PAIG_API_KEY' environment variable")
+        if app_count == 1 and 'PAIG_APP_API_KEY' in os.environ:
+            logger.info(f"AI Application {ai_application_name} setup using 'PAIG_APP_API_KEY' environment variable")
             return
 
-        logger.info("'paig_api_key' is not provided in config. Trying to setup PAIG Shield using configuration file.")
+        logger.info("'paig_app_api_key' is not provided in config. Trying to setup PAIG Shield using configuration file.")
         self.paig_shield_setup_app_with_file(ai_application_name, ai_application_config.get('paig_shield_config_file'), app_count)

paig-securechat/web-server/src/paig_securechat/tests/test_utils.py

@@ -6,7 +6,7 @@
 
 from core.utils import (
     get_uuid, generate_title, extract_keywords, summarize_conversation,
-    construct_title, recursive_merge_dicts, set_paig_api_key
+    construct_title, recursive_merge_dicts, set_paig_app_api_key
 )
 
 
@@ -54,11 +54,11 @@ def test_recursive_merge_dicts():
 
 
 
-def test_set_paig_api_key():
+def test_set_paig_app_api_key():
     with patch("os.environ", {}), patch("os.path.exists", return_value=True), \
          patch("builtins.open", mock_open(read_data="test-paig-api-key")), \
          patch("core.config.Config", {"paig": {"key_file": "test_paig.key"}}):
-        set_paig_api_key()
-        assert os.environ["PAIG_API_KEY"] == "test-paig-api-key"
+        set_paig_app_api_key()
+        assert os.environ["PAIG_APP_API_KEY"] == "test-paig-api-key"
         # unset the environment variable
-        del os.environ["PAIG_API_KEY"]
+        del os.environ["PAIG_APP_API_KEY"]