Merge pull request #31 from Better-Boy/mind-name-validation

added validation for mind name

Author: ZoranPandovski

minds/exceptions.py

@@ -18,3 +18,6 @@ class Unauthorized(Exception):
 class UnknownError(Exception):
     ...
 
+
+class MindNameInvalid(Exception):
+    ...

minds/minds.py

@@ -1,11 +1,9 @@
 from typing import List, Union, Iterable
 from urllib.parse import urlparse, urlunparse
-from datetime import datetime
 
 from openai import OpenAI
-
+import minds.utils as utils
 import minds.exceptions as exc
-
 from minds.datasources import Datasource, DatabaseConfig
 
 DEFAULT_PROMPT_TEMPLATE = 'Use your database tools to answer the user\'s question: {{question}}'
@@ -25,7 +23,7 @@ def __init__(
         self.api = client.api
         self.client = client
         self.project = 'mindsdb'
-
+        
         self.name = name
         self.model_name = model_name
         self.provider = provider
@@ -74,6 +72,9 @@ def update(
         :param parameters, dict: alter other parameters of the mind, optional
         """
         data = {}
+        
+        if name is not None:
+            utils.validate_mind_name(name)
 
         if datasources is not None:
             ds_names = []
@@ -216,7 +217,7 @@ def get(self, name: str) -> Mind:
         :param name: name of the mind
         :return: a mind object
         """
-
+        
         item = self.api.get(f'/projects/{self.project}/minds/{name}').json()
         return Mind(self.client, **item)
 
@@ -263,6 +264,9 @@ def create(
         :param update: if true - to update mind if exists, default is false
         :return: created mind
         """
+        
+        if name is not None:
+            utils.validate_mind_name(name)
 
         if replace:
             try:

minds/utils.py

@@ -0,0 +1,26 @@
+import re
+import minds.exceptions as exc
+
+def validate_mind_name(mind_name):
+    """
+    Validate the Mind name.
+
+    A valid Mind name should:
+    - Start with a letter
+    - Contain only letters, numbers, or underscores
+    - Have a maximum length of 32 characters
+    - Not contain spaces
+
+    Parameters:
+    mind_name (str): The Mind name to validate.
+
+    Returns:
+    bool: True if valid, False otherwise.
+    """
+    # Regular expression pattern
+    pattern = r'^[A-Za-z][A-Za-z0-9_]{0,31}$'
+
+    # Check if the Mind name matches the pattern
+    if not re.match(pattern, mind_name):
+        raise exc.MindNameInvalid("Mind name should start with a letter and contain only letters, numbers or underscore, with a maximum of 32 characters. Spaces are not allowed.")
+    

tests/integration/test_base_flow.py

@@ -9,7 +9,7 @@
 
 from minds.datasources.examples import example_ds
 
-from minds.exceptions import ObjectNotFound
+from minds.exceptions import ObjectNotFound, MindNameInvalid
 
 
 def get_client():
@@ -58,6 +58,7 @@ def test_minds():
     ds_name = 'test_datasource_'
     ds_name2 = 'test_datasource2_'
     mind_name = 'int_test_mind_'
+    invalid_mind_name = 'mind-123'
     mind_name2 = 'int_test_mind2_'
     prompt1 = 'answer in german'
     prompt2 = 'answer in spanish'
@@ -80,6 +81,13 @@ def test_minds():
     ds2_cfg.tables = ['home_rentals']
 
     # create
+    with pytest.raises(MindNameInvalid):
+        mind = client.minds.create(
+            invalid_mind_name,
+            datasources=[ds],
+            provider='openai'
+        )
+    
     mind = client.minds.create(
         mind_name,
         datasources=[ds],
@@ -102,6 +110,9 @@ def test_minds():
     mind = client.minds.get(mind_name)
     assert len(mind.datasources) == 2
     assert mind.prompt_template == prompt1
+    
+    with pytest.raises(MindNameInvalid):
+        client.minds.get(invalid_mind_name)
 
     # list
     mind_list = client.minds.list()
@@ -113,6 +124,14 @@ def test_minds():
         datasources=[ds.name],
         prompt_template=prompt2
     )
+    
+    with pytest.raises(MindNameInvalid):
+        mind.update(
+            name=invalid_mind_name,
+            datasources=[ds.name],
+            prompt_template=prompt2
+        )
+    
     with pytest.raises(ObjectNotFound):
         # this name not exists
         client.minds.get(mind_name)
@@ -160,3 +179,6 @@ def test_minds():
     client.minds.drop(mind_name2)
     client.datasources.drop(ds.name)
     client.datasources.drop(ds2_cfg.name)
+    
+    with pytest.raises(MindNameInvalid):
+        client.minds.drop(invalid_mind_name)