Add test for CI (#3114)

### What problem does this PR solve?

Add test for CI

### Type of change

- [x] New Feature (non-breaking change which adds functionality)

Co-authored-by: liuhua <10215101452@stu.ecun.edu.cn>

sdk/python/test/conftest.py

@@ -1,11 +1,11 @@
-import pytest
-import requests
 import string
 import random
+import os
+import pytest
+import requests
 
 
-
-HOST_ADDRESS = 'http://127.0.0.1:9380'
+HOST_ADDRESS = os.getenv('HOST_ADDRESS', 'http://127.0.0.1:9380')
 
 def generate_random_email():
     return 'user_' + ''.join(random.choices(string.ascii_lowercase + string.digits, k=8))+'@1.com'

sdk/python/test/t_chat.py

@@ -1,12 +1,14 @@
+import os
 from ragflow_sdk import RAGFlow
-HOST_ADDRESS = 'http://127.0.0.1:9380'
+
+HOST_ADDRESS = os.getenv('HOST_ADDRESS', 'http://127.0.0.1:9380')
 
 def test_create_chat_with_name(get_api_key_fixture):
     API_KEY = get_api_key_fixture
     rag = RAGFlow(API_KEY, HOST_ADDRESS)
     kb = rag.create_dataset(name="test_create_chat")
     displayed_name = "ragflow.txt"
-    with open("./ragflow.txt","rb") as file:
+    with open("ragflow.txt", "rb") as file:
         blob = file.read()
     document = {"displayed_name":displayed_name,"blob":blob}
     documents = []
@@ -22,7 +24,7 @@ def test_update_chat_with_name(get_api_key_fixture):
     rag = RAGFlow(API_KEY, HOST_ADDRESS)
     kb = rag.create_dataset(name="test_update_chat")
     displayed_name = "ragflow.txt"
-    with open("./ragflow.txt", "rb") as file:
+    with open("ragflow.txt", "rb") as file:
         blob = file.read()
     document = {"displayed_name": displayed_name, "blob": blob}
     documents = []
@@ -39,7 +41,7 @@ def test_delete_chats_with_success(get_api_key_fixture):
     rag = RAGFlow(API_KEY, HOST_ADDRESS)
     kb = rag.create_dataset(name="test_delete_chat")
     displayed_name = "ragflow.txt"
-    with open("./ragflow.txt", "rb") as file:
+    with open("ragflow.txt", "rb") as file:
         blob = file.read()
     document = {"displayed_name": displayed_name, "blob": blob}
     documents = []
@@ -53,9 +55,9 @@ def test_delete_chats_with_success(get_api_key_fixture):
 def test_list_chats_with_success(get_api_key_fixture):
     API_KEY = get_api_key_fixture
     rag = RAGFlow(API_KEY, HOST_ADDRESS)
-    kb = rag.create_dataset(name="test_delete_chat")
+    kb = rag.create_dataset(name="test_list_chats")
     displayed_name = "ragflow.txt"
-    with open("./ragflow.txt", "rb") as file:
+    with open("ragflow.txt", "rb") as file:
         blob = file.read()
     document = {"displayed_name": displayed_name, "blob": blob}
     documents = []

sdk/python/test/t_dataset.py

@@ -1,54 +1,55 @@
-from ragflow_sdk import RAGFlow
-import random
-import pytest
-
-HOST_ADDRESS = 'http://127.0.0.1:9380'
-
-def test_create_dataset_with_name(get_api_key_fixture):
-    API_KEY = get_api_key_fixture
-    rag = RAGFlow(API_KEY, HOST_ADDRESS)
-    rag.create_dataset("test_create_dataset_with_name")
-
-def test_create_dataset_with_duplicated_name(get_api_key_fixture):
-    API_KEY = get_api_key_fixture
-    rag = RAGFlow(API_KEY, HOST_ADDRESS)
-    with pytest.raises(Exception) as exc_info:
-        rag.create_dataset("test_create_dataset_with_name")
-    assert str(exc_info.value) == "Duplicated dataset name in creating dataset."
-
-def test_create_dataset_with_random_chunk_method(get_api_key_fixture):
-    API_KEY = get_api_key_fixture
-    rag = RAGFlow(API_KEY, HOST_ADDRESS)
-    valid_chunk_methods = ["naive","manual","qa","table","paper","book","laws","presentation","picture","one","knowledge_graph","email"]
-    random_chunk_method = random.choice(valid_chunk_methods)
-    rag.create_dataset("test_create_dataset_with_random_chunk_method",chunk_method=random_chunk_method)
-
-def test_create_dataset_with_invalid_parameter(get_api_key_fixture):
-    API_KEY = get_api_key_fixture
-    rag = RAGFlow(API_KEY, HOST_ADDRESS)
-    valid_chunk_methods = ["naive", "manual", "qa", "table", "paper", "book", "laws", "presentation", "picture", "one",
-                           "knowledge_graph", "email"]
-    chunk_method = "invalid_chunk_method"
-    with pytest.raises(Exception) as exc_info:
-        rag.create_dataset("test_create_dataset_with_name",chunk_method=chunk_method)
-    assert str(exc_info.value) == f"{chunk_method} is not in {valid_chunk_methods}"
-
-
-def test_update_dataset_with_name(get_api_key_fixture):
-    API_KEY = get_api_key_fixture
-    rag = RAGFlow(API_KEY, HOST_ADDRESS)
-    ds = rag.create_dataset("test_update_dataset")
-    ds.update({"name": "updated_dataset"})
-
-
-def test_delete_datasets_with_success(get_api_key_fixture):
-    API_KEY = get_api_key_fixture
-    rag = RAGFlow(API_KEY, HOST_ADDRESS)
-    ds = rag.create_dataset("MA")
-    rag.delete_datasets(ids=[ds.id])
-
-
-def test_list_datasets_with_success(get_api_key_fixture):
-    API_KEY = get_api_key_fixture
-    rag = RAGFlow(API_KEY, HOST_ADDRESS)
-    rag.list_datasets()
+import os
+import random
+import pytest
+from ragflow_sdk import RAGFlow
+
+HOST_ADDRESS = os.getenv('HOST_ADDRESS', 'http://127.0.0.1:9380')
+
+def test_create_dataset_with_name(get_api_key_fixture):
+    API_KEY = get_api_key_fixture
+    rag = RAGFlow(API_KEY, HOST_ADDRESS)
+    rag.create_dataset("test_create_dataset_with_name")
+
+def test_create_dataset_with_duplicated_name(get_api_key_fixture):
+    API_KEY = get_api_key_fixture
+    rag = RAGFlow(API_KEY, HOST_ADDRESS)
+    with pytest.raises(Exception) as exc_info:
+        rag.create_dataset("test_create_dataset_with_name")
+    assert str(exc_info.value) == "Duplicated dataset name in creating dataset."
+
+def test_create_dataset_with_random_chunk_method(get_api_key_fixture):
+    API_KEY = get_api_key_fixture
+    rag = RAGFlow(API_KEY, HOST_ADDRESS)
+    valid_chunk_methods = ["naive","manual","qa","table","paper","book","laws","presentation","picture","one","knowledge_graph","email"]
+    random_chunk_method = random.choice(valid_chunk_methods)
+    rag.create_dataset("test_create_dataset_with_random_chunk_method",chunk_method=random_chunk_method)
+
+def test_create_dataset_with_invalid_parameter(get_api_key_fixture):
+    API_KEY = get_api_key_fixture
+    rag = RAGFlow(API_KEY, HOST_ADDRESS)
+    valid_chunk_methods = ["naive", "manual", "qa", "table", "paper", "book", "laws", "presentation", "picture", "one",
+                           "knowledge_graph", "email"]
+    chunk_method = "invalid_chunk_method"
+    with pytest.raises(Exception) as exc_info:
+        rag.create_dataset("test_create_dataset_with_name",chunk_method=chunk_method)
+    assert str(exc_info.value) == f"'{chunk_method}' is not in {valid_chunk_methods}"
+
+
+def test_update_dataset_with_name(get_api_key_fixture):
+    API_KEY = get_api_key_fixture
+    rag = RAGFlow(API_KEY, HOST_ADDRESS)
+    ds = rag.create_dataset("test_update_dataset")
+    ds.update({"name": "updated_dataset"})
+
+
+def test_delete_datasets_with_success(get_api_key_fixture):
+    API_KEY = get_api_key_fixture
+    rag = RAGFlow(API_KEY, HOST_ADDRESS)
+    ds = rag.create_dataset("MA")
+    rag.delete_datasets(ids=[ds.id])
+
+
+def test_list_datasets_with_success(get_api_key_fixture):
+    API_KEY = get_api_key_fixture
+    rag = RAGFlow(API_KEY, HOST_ADDRESS)
+    rag.list_datasets()

sdk/python/test/t_document.py

@@ -1,6 +1,7 @@
+import os
 from ragflow_sdk import RAGFlow, DataSet, Document, Chunk
 
-HOST_ADDRESS = 'http://127.0.0.1:9380'
+HOST_ADDRESS = os.getenv('HOST_ADDRESS', 'http://127.0.0.1:9380')
 
 
 def test_upload_document_with_success(get_api_key_fixture):
@@ -66,7 +67,7 @@ def test_download_document_with_success(get_api_key_fixture):
     # Check if the retrieved document is of type Document
     if isinstance(doc, Document):
         # Download the document content and save it to a file
-        with open("./ragflow.txt", "wb+") as file:
+        with open("ragflow.txt", "wb+") as file:
             file.write(doc.download())
             # Print the document object for debugging
         print(doc)
@@ -144,7 +145,7 @@ def test_parse_and_cancel_document(get_api_key_fixture):
 
     # Define the document name and path
     name3 = 'westworld.pdf'
-    path = './test_data/westworld.pdf'
+    path = 'test_data/westworld.pdf'
 
     # Create a document in the dataset using the file path
     ds.upload_documents({"name": name3, "blob": open(path, "rb").read()})

sdk/python/test/t_session.py

@@ -1,94 +1,96 @@
-from ragflow_sdk import RAGFlow
-HOST_ADDRESS = 'http://127.0.0.1:9380'
-
-
-def test_create_session_with_success(get_api_key_fixture):
-    API_KEY = get_api_key_fixture
-    rag = RAGFlow(API_KEY, HOST_ADDRESS)
-    kb = rag.create_dataset(name="test_create_session")
-    displayed_name = "ragflow.txt"
-    with open("./ragflow.txt", "rb") as file:
-        blob = file.read()
-    document = {"displayed_name":displayed_name,"blob":blob}
-    documents = []
-    documents.append(document)
-    docs= kb.upload_documents(documents)
-    for doc in docs:
-        doc.add_chunk("This is a test to add chunk")
-    assistant=rag.create_chat("test_create", dataset_ids=[kb.id])
-    assistant.create_session()
-
-
-def test_create_conversation_with_success(get_api_key_fixture):
-    API_KEY = get_api_key_fixture
-    rag = RAGFlow(API_KEY, HOST_ADDRESS)
-    kb = rag.create_dataset(name="test_create_conversation")
-    displayed_name = "ragflow.txt"
-    with open("./ragflow.txt","rb") as file:
-        blob = file.read()
-    document = {"displayed_name": displayed_name, "blob": blob}
-    documents = []
-    documents.append(document)
-    docs = kb.upload_documents(documents)
-    for doc in docs:
-        doc.add_chunk("This is a test to add chunk")
-    assistant = rag.create_chat("test_create", dataset_ids=[kb.id])
-    session = assistant.create_session()
-    question = "What is AI"
-    for ans in session.ask(question, stream=True):
-        pass
-    assert not ans.content.startswith("**ERROR**"), "Please check this error."
-
-
-def test_delete_sessions_with_success(get_api_key_fixture):
-    API_KEY = get_api_key_fixture
-    rag = RAGFlow(API_KEY, HOST_ADDRESS)
-    kb = rag.create_dataset(name="test_delete_session")
-    displayed_name = "ragflow.txt"
-    with open("./ragflow.txt","rb") as file:
-        blob = file.read()
-    document = {"displayed_name":displayed_name,"blob":blob}
-    documents = []
-    documents.append(document)
-    docs= kb.upload_documents(documents)
-    for doc in docs:
-        doc.add_chunk("This is a test to add chunk")
-    assistant=rag.create_chat("test_create", dataset_ids=[kb.id])
-    session = assistant.create_session()
-    assistant.delete_sessions(ids=[session.id])
-
-def test_update_session_with_name(get_api_key_fixture):
-    API_KEY = get_api_key_fixture
-    rag = RAGFlow(API_KEY, HOST_ADDRESS)
-    kb = rag.create_dataset(name="test_update_session")
-    displayed_name = "ragflow.txt"
-    with open("./ragflow.txt","rb") as file:
-        blob = file.read()
-    document = {"displayed_name": displayed_name, "blob": blob}
-    documents = []
-    documents.append(document)
-    docs = kb.upload_documents(documents)
-    for doc in docs:
-        doc.add_chunk("This is a test to add chunk")
-    assistant = rag.create_chat("test_create", dataset_ids=[kb.id])
-    session = assistant.create_session(name="old session")
-    session.update({"name": "new session"})
-
-
-def test_list_sessions_with_success(get_api_key_fixture):
-    API_KEY = get_api_key_fixture
-    rag = RAGFlow(API_KEY, HOST_ADDRESS)
-    kb = rag.create_dataset(name="test_list_session")
-    displayed_name = "ragflow.txt"
-    with open("./ragflow.txt","rb") as file:
-        blob = file.read()
-    document = {"displayed_name":displayed_name,"blob":blob}
-    documents = []
-    documents.append(document)
-    docs= kb.upload_documents(documents)
-    for doc in docs:
-        doc.add_chunk("This is a test to add chunk")
-    assistant=rag.create_chat("test_create", dataset_ids=[kb.id])
-    assistant.create_session("test_1")
-    assistant.create_session("test_2")
+import os
+from ragflow_sdk import RAGFlow
+
+HOST_ADDRESS = os.getenv('HOST_ADDRESS', 'http://127.0.0.1:9380')
+
+
+def test_create_session_with_success(get_api_key_fixture):
+    API_KEY = get_api_key_fixture
+    rag = RAGFlow(API_KEY, HOST_ADDRESS)
+    kb = rag.create_dataset(name="test_create_session")
+    displayed_name = "ragflow.txt"
+    with open("ragflow.txt", "rb") as file:
+        blob = file.read()
+    document = {"displayed_name":displayed_name,"blob":blob}
+    documents = []
+    documents.append(document)
+    docs= kb.upload_documents(documents)
+    for doc in docs:
+        doc.add_chunk("This is a test to add chunk")
+    assistant=rag.create_chat("test_create_session", dataset_ids=[kb.id])
+    assistant.create_session()
+
+
+def test_create_conversation_with_success(get_api_key_fixture):
+    API_KEY = get_api_key_fixture
+    rag = RAGFlow(API_KEY, HOST_ADDRESS)
+    kb = rag.create_dataset(name="test_create_conversation")
+    displayed_name = "ragflow.txt"
+    with open("ragflow.txt", "rb") as file:
+        blob = file.read()
+    document = {"displayed_name": displayed_name, "blob": blob}
+    documents = []
+    documents.append(document)
+    docs = kb.upload_documents(documents)
+    for doc in docs:
+        doc.add_chunk("This is a test to add chunk")
+    assistant = rag.create_chat("test_create_conversation", dataset_ids=[kb.id])
+    session = assistant.create_session()
+    question = "What is AI"
+    for ans in session.ask(question, stream=True):
+        pass
+    assert not ans.content.startswith("**ERROR**"), "Please check this error."
+
+
+def test_delete_sessions_with_success(get_api_key_fixture):
+    API_KEY = get_api_key_fixture
+    rag = RAGFlow(API_KEY, HOST_ADDRESS)
+    kb = rag.create_dataset(name="test_delete_session")
+    displayed_name = "ragflow.txt"
+    with open("ragflow.txt", "rb") as file:
+        blob = file.read()
+    document = {"displayed_name":displayed_name,"blob":blob}
+    documents = []
+    documents.append(document)
+    docs= kb.upload_documents(documents)
+    for doc in docs:
+        doc.add_chunk("This is a test to add chunk")
+    assistant=rag.create_chat("test_delete_session", dataset_ids=[kb.id])
+    session = assistant.create_session()
+    assistant.delete_sessions(ids=[session.id])
+
+def test_update_session_with_name(get_api_key_fixture):
+    API_KEY = get_api_key_fixture
+    rag = RAGFlow(API_KEY, HOST_ADDRESS)
+    kb = rag.create_dataset(name="test_update_session")
+    displayed_name = "ragflow.txt"
+    with open("ragflow.txt", "rb") as file:
+        blob = file.read()
+    document = {"displayed_name": displayed_name, "blob": blob}
+    documents = []
+    documents.append(document)
+    docs = kb.upload_documents(documents)
+    for doc in docs:
+        doc.add_chunk("This is a test to add chunk")
+    assistant = rag.create_chat("test_update_session", dataset_ids=[kb.id])
+    session = assistant.create_session(name="old session")
+    session.update({"name": "new session"})
+
+
+def test_list_sessions_with_success(get_api_key_fixture):
+    API_KEY = get_api_key_fixture
+    rag = RAGFlow(API_KEY, HOST_ADDRESS)
+    kb = rag.create_dataset(name="test_list_session")
+    displayed_name = "ragflow.txt"
+    with open("ragflow.txt", "rb") as file:
+        blob = file.read()
+    document = {"displayed_name":displayed_name,"blob":blob}
+    documents = []
+    documents.append(document)
+    docs= kb.upload_documents(documents)
+    for doc in docs:
+        doc.add_chunk("This is a test to add chunk")
+    assistant=rag.create_chat("test_list_session", dataset_ids=[kb.id])
+    assistant.create_session("test_1")
+    assistant.create_session("test_2")
     assistant.list_sessions()