# SPDX-FileCopyrightText: 2022-present deepset GmbH # # SPDX-License-Identifier: Apache-2.0 from unittest.mock import MagicMock import pytest from haystack import Document from haystack.components.caching.cache_checker import CacheChecker from haystack.document_stores.in_memory import InMemoryDocumentStore from haystack.testing.factory import document_store_class class TestCacheChecker: def test_to_dict(self): mocked_docstore_class = document_store_class("MockedDocumentStore") component = CacheChecker(document_store=mocked_docstore_class(), cache_field="url") data = component.to_dict() assert data == { "type": "haystack.components.caching.cache_checker.CacheChecker", "init_parameters": { "document_store": {"type": "haystack.testing.factory.MockedDocumentStore", "init_parameters": {}}, "cache_field": "url", }, } def test_to_dict_with_custom_init_parameters(self): mocked_docstore_class = document_store_class("MockedDocumentStore") component = CacheChecker(document_store=mocked_docstore_class(), cache_field="my_url_field") data = component.to_dict() assert data == { "type": "haystack.components.caching.cache_checker.CacheChecker", "init_parameters": { "document_store": {"type": "haystack.testing.factory.MockedDocumentStore", "init_parameters": {}}, "cache_field": "my_url_field", }, } def test_from_dict(self): data = { "type": "haystack.components.caching.cache_checker.CacheChecker", "init_parameters": { "document_store": { "type": "haystack.document_stores.in_memory.document_store.InMemoryDocumentStore", "init_parameters": {}, }, "cache_field": "my_url_field", }, } component = CacheChecker.from_dict(data) assert isinstance(component.document_store, InMemoryDocumentStore) assert component.cache_field == "my_url_field" def test_from_dict_without_docstore(self): data = {"type": "haystack.components.caching.cache_checker.CacheChecker", "init_parameters": {}} with pytest.raises( TypeError, match="missing 2 required positional arguments: 'document_store' and 'cache_field'" ): CacheChecker.from_dict(data) def test_from_dict_nonexisting_docstore(self): # Use a type whose module passes the deserialization allowlist (haystack.*) but cannot be # resolved, so we still exercise the "import failed" code path rather than the allowlist gate. data = { "type": "haystack.components.caching.cache_checker.CacheChecker", "init_parameters": { "document_store": {"type": "haystack.does.not.exist.DocumentStore", "init_parameters": {}} }, } with pytest.raises( ImportError, match=r"Failed to deserialize 'document_store':.*haystack\.does\.not\.exist\.DocumentStore" ): CacheChecker.from_dict(data) def test_run(self, in_memory_doc_store): documents = [ Document(content="doc1", meta={"url": "https://example.com/1"}), Document(content="doc2", meta={"url": "https://example.com/2"}), Document(content="doc3", meta={"url": "https://example.com/1"}), Document(content="doc4", meta={"url": "https://example.com/2"}), ] in_memory_doc_store.write_documents(documents) checker = CacheChecker(in_memory_doc_store, cache_field="url") results = checker.run(items=["https://example.com/1", "https://example.com/5"]) assert results == {"hits": [documents[0], documents[2]], "misses": ["https://example.com/5"]} def test_filters_syntax(self): mocked_docstore_class = document_store_class("MockedDocumentStore") mocked_docstore_class.filter_documents = MagicMock() checker = CacheChecker(document_store=mocked_docstore_class(), cache_field="url") checker.run(items=["https://example.com/1"]) valid_filters_syntax = {"field": "url", "operator": "==", "value": "https://example.com/1"} mocked_docstore_class.filter_documents.assert_any_call(filters=valid_filters_syntax)