compatibility Test coverage

tests/compatibility_tests/add_or_replace_documents/__init__.py

@@ -0,0 +1 @@
+

tests/compatibility_tests/add_or_replace_documents/test_add_documents.py

@@ -0,0 +1,100 @@
+import pytest
+from tests.compatibility_tests.base_test_case.base_compatibility_test import BaseCompatibilityTestCase
+
+@pytest.mark.marqo_version('2.0.0')
+class TestAddDocuments(BaseCompatibilityTestCase):
+    structured_index_name = "test_add_doc_api_structured_index"
+    unstructured_index_name = "test_add_doc_api_unstructured_index"
+
+    indexes_to_test_on = [{
+        "indexName": structured_index_name,
+        "type": "structured",
+        "model": "sentence-transformers/all-MiniLM-L6-v2",
+        "normalizeEmbeddings": False,
+        "allFields": [
+            {"name": "Title", "type": "text"},
+            {"name": "Description", "type": "text"},
+            {"name": "Genre", "type": "text"},
+        ],
+        "tensorFields": ["Title", "Description", "Genre"],
+    },
+        {
+        "indexName": unstructured_index_name,
+        "type": "unstructured",
+        "model": "sentence-transformers/all-MiniLM-L6-v2",
+        "normalizeEmbeddings": False,
+    }]
+
+    text_docs = [{
+        "Title": "The Travels of Marco Polo",
+        "Description": "A 13th-century travelogue describing the travels of Polo",
+        "Genre": "History",
+        "_id": "article_602"
+    },
+    {
+        "Title": "Extravehicular Mobility Unit (EMU)",
+        "Description": "The EMU is a spacesuit that provides environmental protection",
+        "_id": "article_591",
+        "Genre": "Science"
+    }]
+    @classmethod
+    def tearDownClass(cls) -> None:
+        cls.indexes_to_delete = [index['indexName'] for index in cls.indexes_to_test_on]
+        super().tearDownClass()
+
+    @classmethod
+    def setUpClass(cls) -> None:
+        super().setUpClass()
+
+    def prepare(self):
+        self.logger.info(f"Creating indexes {self.indexes_to_test_on} in test case: {self.__class__.__name__}")
+        self.create_indexes(self.indexes_to_test_on)
+
+        try:
+            self.logger.debug(f'Feeding documents to {self.indexes_to_test_on}')
+            for index in self.indexes_to_test_on:
+                if index.get("type") is not None and index.get('type') == 'structured':
+                    self.client.index(index_name = index['indexName']).add_documents(documents = self.text_docs)
+                else:
+                    self.client.index(index_name = index['indexName']).add_documents(documents = self.text_docs,
+                                                                        tensor_fields = ["Description", "Genre", "Title"])
+
+            self.logger.debug(f"Finished running prepare method for test case: {self.__class__.__name__}")
+        except Exception as e:
+            raise e
+
+        all_results = {}
+
+        for index in self.indexes_to_test_on:
+            index_name = index['indexName']
+            all_results[index_name] = {}
+
+            for doc in self.text_docs:
+                doc_id = doc['_id']
+                try:
+                    all_results[index_name][doc_id] = self.client.index(index_name).get_document(doc_id)
+                except Exception as e:
+                    self.logger.error(
+                        f"Exception when getting documents with id: {doc_id} from index: {index_name}",
+                        exc_info=True)
+
+        self.save_results_to_file(all_results)
+
+    def test_add_doc(self):
+        self.logger.info(f"Running test_add_doc on {self.__class__.__name__}")
+        stored_results = self.load_results_from_file()
+        for index in self.indexes_to_test_on:
+            index_name = index['indexName']
+
+            for doc in self.text_docs:
+                doc_id = doc['_id']
+                try:
+                    expected_doc = stored_results[index_name][doc_id]
+                except KeyError as e:
+                    self.logger.error(f"The key {doc_id} doesn't exist in the stored results. Skipping the test for this document.")
+                    continue
+                self.logger.debug(f"Printing expected doc {expected_doc}")
+                actual_doc = self.client.index(index_name).get_document(doc_id)
+                self.logger.debug(f"Printing actual doc {expected_doc}")
+
+                self.assertEqual(expected_doc, actual_doc)

tests/backwards_compatibility_tests/base_compatibility_test_case.py → tests/compatibility_tests/base_test_case/base_compatibility_test.py

@@ -2,7 +2,7 @@
 import logging
 from abc import abstractmethod, ABC
 from pathlib import Path
-from marqo_test import MarqoTestCase
+from tests.compatibility_tests.base_test_case.marqo_test import MarqoTestCase
 
 
 class BaseCompatibilityTestCase(MarqoTestCase, ABC):
@@ -40,6 +40,8 @@ def tearDownClass(cls) -> None:
             cls.delete_indexes(cls.indexes_to_delete)
             cls.logger.debug(f"Deleting indexes {cls.indexes_to_delete}")
 
+        cls.delete_file()
+
     @classmethod
     def save_results_to_file(cls, results):
         """Save results to a JSON file."""
@@ -61,8 +63,11 @@ def load_results_from_file(cls):
     def delete_file(cls):
         """Delete the results file."""
         filepath = cls.get_results_file_path()
-        filepath.unlink()
-        cls.logger.debug(f"Results file deleted: {filepath}")
+        if filepath.exists():
+            filepath.unlink()
+            cls.logger.debug(f"Results file deleted: {filepath}")
+        else:
+            cls.logger.debug(f"Not deleting, as the results file was never created in the first place.")
 
     @abstractmethod
     def prepare(self):