aiverify-moonshot 0.4.4__py3-none-any.whl → 0.4.5__py3-none-any.whl

{aiverify_moonshot-0.4.4.dist-info → aiverify_moonshot-0.4.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: aiverify-moonshot
-Version: 0.4.4
+Version: 0.4.5
 Summary: AI Verify advances Gen AI testing with Project Moonshot.
 Project-URL: Repository, https://github.com/aiverify-foundation/moonshot
 Project-URL: Documentation, https://aiverify-foundation.github.io/moonshot/
@@ -45,7 +45,7 @@ Description-Content-Type: text/markdown
 
 ![Moonshot Logo](https://github.com/aiverify-foundation/moonshot/raw/main/misc/aiverify-moonshot-logo.png)
 
-**Version 0.4.4**
+**Version 0.4.5**
 
 A simple and modular tool to evaluate any LLM application.
 

{aiverify_moonshot-0.4.4.dist-info → aiverify_moonshot-0.4.5.dist-info}/RECORD

@@ -1,5 +1,5 @@
 moonshot/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-moonshot/__main__.py,sha256=NB_sWjPRcwr8BbFXtih2y3fbVYPZ1YS5dI_bNNaTD3U,7551
+moonshot/__main__.py,sha256=owir7ug4VzfPwG7hSYTrN03SRpHMiLUifoEe_-IaeYw,9908
 moonshot/api.py,sha256=f7vIMlpC-1ZQsbqipe2cTlP5dwgoVujQKYNxzEKcWlg,4822
 moonshot/integrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 moonshot/integrations/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -33,7 +33,7 @@ moonshot/integrations/cli/utils/process_data.py,sha256=QVL5vp2_8ZgGicmCAdeYEHkeb
 moonshot/integrations/web_api/.env.dev,sha256=0z5_Ut8rF-UqFZtgjkH2qoqORhD5_nSs2w_OeX2SteI,182
 moonshot/integrations/web_api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 moonshot/integrations/web_api/__main__.py,sha256=MdnLi_ZF-olAAEJwTPU1iGYFYwo-fNWNT2qfchkH3y4,2050
-moonshot/integrations/web_api/app.py,sha256=rrL-N4cVO1qBQ5v6y039jfMqUdSC9jyqsgCudmyfZx0,3651
+moonshot/integrations/web_api/app.py,sha256=4EzGEwvFh6any62ZJNGH2GCXUOPjqNYURL0Toe2rTNI,3651
 moonshot/integrations/web_api/container.py,sha256=DVkJG_qm7ItcG6tgMYOqIj07wpKhPWOOfy6-bEv72y4,5915
 moonshot/integrations/web_api/logging_conf.py,sha256=t3EGRV6tZhV732KXe8_Tiy0fiwVAWxZX5Tt8VTgrrfg,3388
 moonshot/integrations/web_api/log/.gitkeep,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -41,7 +41,7 @@ moonshot/integrations/web_api/routes/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeu
 moonshot/integrations/web_api/routes/attack_modules.py,sha256=m0mGGTEHyaVld8WYHXxQ5Gm0sKdTqy_rJUrNVFcgVgw,2413
 moonshot/integrations/web_api/routes/benchmark.py,sha256=RRzouKcoVNYXm7o1LadsZTgzfmUsaYdQTC0AfsLdiC4,4163
 moonshot/integrations/web_api/routes/benchmark_result.py,sha256=WZ_dI8qT4dli9hKPNkhSwhdfz2VfW5BshirpEVEUci4,6351
-moonshot/integrations/web_api/routes/bookmark.py,sha256=K-1jL0IwOYvmYpgJvU65-lRfQlQhMzJk_n-Zf92IeR0,6135
+moonshot/integrations/web_api/routes/bookmark.py,sha256=aHUT86Llbzqo1CT3Dy7ciIhxVEzu1YgZk_VkxVeOZ3s,6304
 moonshot/integrations/web_api/routes/context_strategy.py,sha256=kJTpjrwxfYGyBLY_hAgpHOMZMtjV5Z6vpu7RIdHDylg,4828
 moonshot/integrations/web_api/routes/cookbook.py,sha256=oddmcdfhgH3qZb4_ThfUk8SBKmHOt51dFlAHubQh2fQ,8648
 moonshot/integrations/web_api/routes/dataset.py,sha256=qtxflHRDr31W3u6voOFE5iRHsCVr0MQ35H94Pw5M1YU,6114
@@ -114,7 +114,7 @@ moonshot/src/api/api_session.py,sha256=OGH05ZxAwo_hKI-RNaJ-jCp_v-zcTm-9bHUclpq2z
 moonshot/src/bookmark/bookmark.py,sha256=KZoKOyJseW02IS5KqfCIMusFiNwESBxOAvOZTwO7YUw,8867
 moonshot/src/bookmark/bookmark_arguments.py,sha256=rwgUPMXmDLNaHfJvRTR4GaZ8vwRilchzOg9bZJQoe_8,1130
 moonshot/src/configs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-moonshot/src/configs/env_variables.py,sha256=leemw8TNM6GI_6iaajFb49zv1K3hWB0EpZfO0p9CWZQ,7100
+moonshot/src/configs/env_variables.py,sha256=eF__UJN37LCzIB4pv_T7G-kQHlOa657QA7IpL1d_0MM,7150
 moonshot/src/connectors/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 moonshot/src/connectors/connector.py,sha256=e0ZCX9m83ezjMiY5H8gbWE64IStsNQqxzVwGtMwShPY,13396
 moonshot/src/connectors/connector_prompt_arguments.py,sha256=cIlAgbFk2g_XUZ0stVM904Ng2g4GYP2LyiAjktmhEQM,470
@@ -155,7 +155,7 @@ moonshot/src/runners/runner.py,sha256=Wsvdzcw4KOa-ppgGVRGSK2YxLfXK-daHDw3k5jETv-
 moonshot/src/runners/runner_arguments.py,sha256=Bg4OPSmgr9jZKNAwPH0T3epEHw-6qGrflszFc6oMyEU,1640
 moonshot/src/runners/runner_type.py,sha256=jOfnAnaCYp-rPTRJXhM8hin_dinlR0sMwmimQXvLcJ0,100
 moonshot/src/runs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-moonshot/src/runs/run.py,sha256=QFdvWwCnqSjLrsTk3jJ1ccs3R1ZAZNvz5ls9Q_iRxO0,14132
+moonshot/src/runs/run.py,sha256=3Y_256IfOv5zpeujVPsA5YdX7uZjGMRvg0VencUwgLw,14339
 moonshot/src/runs/run_arguments.py,sha256=G043ERvHIU_dd0JghboZgxDWCcjYOaDwue1ieDunDKA,6443
 moonshot/src/runs/run_progress.py,sha256=d1BcNo6Kp4vA165TDx_xebl8JDo92aV-YutPxsgCOxE,6495
 moonshot/src/runs/run_status.py,sha256=TRtizcDzPxf6aQ2c3OovM6IQKJ0VCBhqDWvn7UBw5Zg,251
@@ -169,9 +169,9 @@ moonshot/src/utils/import_modules.py,sha256=T9zTN59PFnvY2rjyWhSV9KSIAHxWV1pyBemF
 moonshot/src/utils/log.py,sha256=YNgD7Eh2OT36XlmVBKCGUTAh9TRp4Akfe4kDdvHASgs,2502
 moonshot/src/utils/pagination.py,sha256=5seymyRoqyENIhKllAatr1T91kMCGFslcvRnJHyMSvc,814
 moonshot/src/utils/timeit.py,sha256=TvuF0w8KWhp0oZFY0cUU3UY0xlGKjchb0OkfYfgVTlc,866
-aiverify_moonshot-0.4.4.dist-info/METADATA,sha256=zQ4rKRFVE_p6uB6dgGBcKhIB4KXRn8ZzdBymh3d2y6g,12368
-aiverify_moonshot-0.4.4.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-aiverify_moonshot-0.4.4.dist-info/licenses/AUTHORS.md,sha256=mmAbe3i3sT8JZHJMBhxp3i1xRehV0g7WB4T_eyIBuBs,59
-aiverify_moonshot-0.4.4.dist-info/licenses/LICENSE.md,sha256=mDOKOkWFbJmUORaAchXByEVGC1jw37QRn-zS14wY_wM,11347
-aiverify_moonshot-0.4.4.dist-info/licenses/NOTICES.md,sha256=0Ikx6IBGGQEOJeNb2MkRoXxTXwrtlMz6EDgLBFIz6v0,179593
-aiverify_moonshot-0.4.4.dist-info/RECORD,,
+aiverify_moonshot-0.4.5.dist-info/METADATA,sha256=d8sIDGy6Ywuov6QnMj62fa6Qu5Uvbekv4_rBGeLObWM,12368
+aiverify_moonshot-0.4.5.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+aiverify_moonshot-0.4.5.dist-info/licenses/AUTHORS.md,sha256=mmAbe3i3sT8JZHJMBhxp3i1xRehV0g7WB4T_eyIBuBs,59
+aiverify_moonshot-0.4.5.dist-info/licenses/LICENSE.md,sha256=mDOKOkWFbJmUORaAchXByEVGC1jw37QRn-zS14wY_wM,11347
+aiverify_moonshot-0.4.5.dist-info/licenses/NOTICES.md,sha256=0Ikx6IBGGQEOJeNb2MkRoXxTXwrtlMz6EDgLBFIz6v0,179593
+aiverify_moonshot-0.4.5.dist-info/RECORD,,

moonshot/__main__.py

@@ -1,10 +1,12 @@
 import argparse
 import os
 import platform
+import shutil
 import subprocess
 import sys
 import threading
 import warnings
+from typing import Any
 
 from dotenv import dotenv_values
 
@@ -19,7 +21,7 @@ Run the Moonshot application
 """
 
 
-def run_subprocess(*args, **kwargs):
+def run_subprocess(*args: Any, **kwargs: Any) -> subprocess.CompletedProcess:
     """
     Run a subprocess with the option to use shell=True on Windows.
     """
@@ -28,7 +30,7 @@ def run_subprocess(*args, **kwargs):
     return subprocess.run(*args, **kwargs)
 
 
-def ms_lib_env_file(data_repo_name):
+def ms_lib_env_file(data_repo_name: str) -> None:
     """
     Writes the env file to be used for moonshot library
     """
@@ -70,7 +72,7 @@ def ms_lib_env_file(data_repo_name):
         env_file.write(combined_content.strip())
 
 
-def ms_ui_env_file(ui_repo):
+def ms_ui_env_file(ui_repo: str) -> None:
     """
     Write the env file to be used with moonshot ui
     """
@@ -84,90 +86,160 @@ def ms_ui_env_file(ui_repo):
         env_file.write(env_content.strip())
 
 
-def moonshot_data_installation():
+def download_nltk_resources() -> None:
+    """
+    Download and verify necessary NLTK resources.
+
+    This function downloads a predefined list of NLTK resources and verifies their availability.
+    If a resource fails to download or verify, a warning is logged and an exception is raised.
+    """
+    import nltk
+
+    resources = [
+        "punkt",
+        "stopwords",
+    ]
+
+    for resource in resources:
+        try:
+            nltk.download(resource)
+            # Check if the resource is available
+            nltk.data.find(
+                f"tokenizers/{resource}"
+            ) if resource == "punkt" else nltk.data.find(f"corpora/{resource}")
+            logger.info(f"Successfully downloaded and verified {resource}")
+        except LookupError:
+            logger.warning(f"Failed to download {resource}")
+            raise
+        except Exception as e:
+            logger.warning(f"An error occurred while downloading {resource}: {e}")
+            raise
+
+
+def moonshot_data_installation() -> None:
     # Code for moonshot-data installation
     logger.info("Installing Moonshot Data from GitHub")
     repo = "https://github.com/aiverify-foundation/moonshot-data.git"
     folder_name = repo.split("/")[-1].replace(".git", "")
 
     # Check if the directory already exists
-    if not os.path.exists(folder_name):
-        logger.info(f"Cloning {repo}")
-        # Clone the repository
-        run_subprocess(["git", "clone", repo], check=True)
+    if os.path.exists(folder_name):
+        logger.warning(f"Directory {folder_name} already exists.")
+        user_input = (
+            input(
+                f"Directory {folder_name} already exists. Do you want to remove it and reinstall? (Y/n): "
+            )
+            .strip()
+            .lower()
+        )
+        if user_input == "y":
+            logger.info(f"Removing directory {folder_name}.")
+            # Remove the existing directory
+            shutil.rmtree(folder_name)
+        else:
+            logger.info("Exiting function without removing the directory.")
+            return
 
-        # Create .env to point to installed folder
-        ms_lib_env_file(folder_name)
+    logger.info(f"Cloning {repo}")
+    # Clone the repository
+    run_subprocess(["git", "clone", repo], check=True)
 
-        # Change directory to the folder
-        os.chdir(folder_name)
+    # Create .env to point to installed folder
+    ms_lib_env_file(folder_name)
 
-        logger.info(f"Installing requirements for {folder_name}")
-        # Install the requirements if they exist
-        if os.path.exists("requirements.txt"):
-            run_subprocess(["pip", "install", "-r", "requirements.txt"], check=True)
-            import nltk
+    # Change directory to the folder
+    os.chdir(folder_name)
 
-            nltk.download("punkt")
-            nltk.download("stopwords")
-            nltk.download("averaged_perceptron_tagger")
-            nltk.download("universal_tagset")
+    logger.info(f"Installing requirements for {folder_name}")
+    # Install the requirements if they exist
+    if os.path.exists("requirements.txt"):
+        run_subprocess(["pip", "install", "-r", "requirements.txt"], check=True)
+        download_nltk_resources()
 
-        # Change back to the base directory
-        os.chdir("..")
+    # Change back to the base directory
+    os.chdir("..")
 
-    else:
-        logger.warning(f"Directory {folder_name} already exists, skipping clone.")
+
+def check_node() -> bool:
+    """
+    Check if Node.js is installed on the user's machine.
+    """
+    try:
+        result = subprocess.run(
+            ["node", "--version"], capture_output=True, text=True, check=True
+        )
+        node_version = result.stdout.strip()
+        logger.info(f"Node.js is installed. Version: {node_version}")
+        return True
+    except (subprocess.CalledProcessError, FileNotFoundError):
+        logger.error("Node.js is not installed. Please install Node.js to proceed.")
+        return False
 
 
-def moonshot_ui_installation():
+def moonshot_ui_installation() -> None:
+    if not check_node():
+        logger.error("Node.js is not installed. Please install Node.js to proceed.")
+        return
+
     # Code for moonshot-ui installation
     repo = "https://github.com/aiverify-foundation/moonshot-ui.git"
     folder_name = repo.split("/")[-1].replace(".git", "")
 
     # Check if the directory already exists
-    if not os.path.exists(folder_name):
-        logger.info(f"Cloning {repo}")
-        # Clone the repository
-        run_subprocess(["git", "clone", repo], check=True)
+    if os.path.exists(folder_name):
+        logger.warning(f"Directory {folder_name} already exists.")
+        user_input = (
+            input(
+                f"Directory {folder_name} already exists. Do you want to remove it and reinstall? (Y/n): "
+            )
+            .strip()
+            .lower()
+        )
+        if user_input == "y":
+            logger.info(f"Removing directory {folder_name}.")
+            # Remove the existing directory
+            shutil.rmtree(folder_name)
+        else:
+            logger.info("Exiting function without removing the directory.")
+            return
 
-        # Change directory to the folder
-        os.chdir(folder_name)
+    logger.info(f"Cloning {repo}")
+    # Clone the repository
+    run_subprocess(["git", "clone", repo], check=True)
 
-        logger.info(f"Installing requirements for {folder_name}")
-        # Install the requirements if they exist
-        if os.path.exists("package.json"):
-            run_subprocess(["npm", "install"], check=True)
-            run_subprocess(["npm", "run", "build"], check=True)
+    # Change directory to the folder
+    os.chdir(folder_name)
 
-        # Change back to the base directory
-        os.chdir("..")
+    logger.info(f"Installing requirements for {folder_name}")
+    # Install the requirements if they exist
+    if os.path.exists("package.json"):
+        run_subprocess(["npm", "install"], check=True)
+        run_subprocess(["npm", "run", "build"], check=True)
 
-        # Create .env for ui
-        ms_ui_env_file(folder_name)
-    else:
-        logger.warning(
-            f"Directory {folder_name} already exists, skipping installation."
-        )
+    # Change back to the base directory
+    os.chdir("..")
 
+    # Create .env for ui
+    ms_ui_env_file(folder_name)
 
-def run_moonshot_ui_dev():
+
+def run_moonshot_ui() -> None:
     """
     To start a thread to run the Moonshot UI
     """
     base_directory = os.getcwd()
-    ui_dev_dir = os.path.join(base_directory, "moonshot-ui")
+    ui_dir = os.path.join(base_directory, "moonshot-ui")
 
-    if not os.path.exists(ui_dev_dir):
+    if not os.path.exists(ui_dir):
         logger.error(
             "moonshot-ui does not exist. Please run with '-i moonshot-ui' to install moonshot-ui first."
         )
         sys.exit(1)
     # ms_ui_env_file(ui_dev_dir)
-    run_subprocess(["npm", "start"], cwd=ui_dev_dir)
+    run_subprocess(["npm", "start"], cwd=ui_dir)
 
 
-def main():
+def main() -> None:
     parser = argparse.ArgumentParser(description="Run the Moonshot application")
     parser.add_argument(
         "mode",
@@ -206,7 +278,7 @@ def main():
 
     if args.mode == "help":
         parser.print_help()
-        sys.exit(1)
+        sys.exit(0)
 
     api_set_environment_variables(dotenv_values(args.env))
 
@@ -216,7 +288,7 @@ def main():
         web_api.start_app()
     elif args.mode == "web":
         # Create and start the UI dev server thread
-        ui_thread = threading.Thread(target=run_moonshot_ui_dev)
+        ui_thread = threading.Thread(target=run_moonshot_ui)
         ui_thread.start()
         ui_thread.join(timeout=0.1)  # Wait briefly for the thread to become alive
         if not ui_thread.is_alive():
@@ -232,8 +304,7 @@ def main():
         # Handle CLI mode here, possibly also with additional arguments
         pass
     else:
-        parser.print_help()
-        sys.exit(1)
+        sys.exit(0)
 
 
 if __name__ == "__main__":

moonshot/integrations/web_api/app.py

@@ -71,7 +71,7 @@ def create_app(cfg: providers.Configuration) -> CustomFastAPI:
     }
 
     app: CustomFastAPI = CustomFastAPI(
-        title="Project Moonshot", version="0.4.4", **app_kwargs
+        title="Project Moonshot", version="0.4.5", **app_kwargs
     )
 
     if cfg.cors.enabled():

moonshot/integrations/web_api/routes/bookmark.py

@@ -1,7 +1,9 @@
+import os
 from typing import Optional
 
 from dependency_injector.wiring import Provide, inject
 from fastapi import APIRouter, Depends, HTTPException, Query
+from fastapi.responses import FileResponse
 
 from ..container import Container
 from ..schemas.bookmark_create_dto import BookmarkCreateDTO, BookmarkPydanticModel
@@ -136,7 +138,7 @@ def delete_bookmark(
             raise HTTPException(
                 status_code=500, detail=f"Failed to delete bookmark: {e.msg}"
             )
-@router.post(
+@router.get(
     "/api/v1/bookmarks/export", response_description="Exporting Bookmark to JSON file"
 )
 @inject
@@ -145,7 +147,7 @@ def export_bookbookmarks(
         "bookmarks", description="Name of the exported file"
     ),
     bookmark_service: BookmarkService = Depends(Provide[Container.bookmark_service]),
-) -> str:
+) -> FileResponse:
     """
     Export bookmarks to a JSON file with a given file name.
 
@@ -154,10 +156,11 @@ def export_bookbookmarks(
         bookmark_service: The service responsible for bookmark operations.
 
     Returns:
-        A string with the path to the exported file or an error message.
+        A FileResponse with the path to the exported file or an error message.
     """
     try:
-        return bookmark_service.export_bookmarks(export_file_name)
+        file_path = bookmark_service.export_bookmarks(export_file_name)
+        return FileResponse(file_path, media_type="application/json", filename=export_file_name)
     except ServiceException as e:
         if e.error_code == "FileNotFound":
             raise HTTPException(

moonshot/src/configs/env_variables.py

@@ -39,7 +39,11 @@ class EnvironmentVars:
     ]
     BOOKMARKS = [
         env_vars.get(EnvVariables.BOOKMARKS.value),
-        str(importlib.resources.files(__app_name__).joinpath("data/generated-outputs/bookmarks")),
+        str(
+            importlib.resources.files(__app_name__).joinpath(
+                "data/generated-outputs/bookmarks"
+            )
+        ),
     ]
     CONNECTORS = [
         env_vars.get(EnvVariables.CONNECTORS.value),
@@ -144,8 +148,8 @@ class EnvironmentVars:
                     EnvironmentVars.__dict__[key][0] = str(given_path)
                 else:
                     logger.warning(
-                        f"Unable to set {key}. The provided path {given_path} does not exist. ",
-                        "The stock set will be used.",
+                        f"Unable to set {key}. The provided path {given_path} does not exist. "
+                        "The stock set will be used."
                     )
             else:
                 unset_keys.append(key)

moonshot/src/runs/run.py

@@ -20,6 +20,7 @@ logger = configure_logger(__name__)
 
 
 class Run:
+    sql_table_name = "run_table"
     sql_create_run_table = """
         CREATE TABLE IF NOT EXISTS run_table (
         run_id INTEGER PRIMARY KEY AUTOINCREMENT,
@@ -147,6 +148,12 @@ class Run:
         if not database_instance:
             raise RuntimeError("[Run] Database instance not provided.")
 
+        # Check that the table exists
+        if not Storage.check_database_table_exists(
+            database_instance, Run.sql_table_name
+        ):
+            return []
+
         all_run_arguments_info = Storage.read_database_records(
             database_instance,
             Run.sql_read_all_run_records,