engram-core 0.19.0

AI Memory Infrastructure - Persistent memory for AI agents with semantic search
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229

"""Tests for the CrewAI integration.

All tests use MagicMock for EngramClient — no network calls are made.
"""

from __future__ import annotations

from unittest.mock import MagicMock, call

import pytest

from engram_client.integrations.crewai import (
    EngramEntityMemory,
    EngramLongTermMemory,
    EngramShortTermMemory,
)


# ---------------------------------------------------------------------------
# Fixtures
# ---------------------------------------------------------------------------


@pytest.fixture
def mock_client() -> MagicMock:
    """Return a MagicMock that stands in for EngramClient."""
    client = MagicMock()
    # Default return values that look like real Engram responses
    client.create_daily.return_value = {"id": 1, "content": "[key] value"}
    client.create.return_value = {"id": 2, "content": "[key] value"}
    client.search.return_value = {"memories": []}
    client.create_identity.return_value = {"canonical_id": "person:alice", "display_name": "Alice"}
    client.resolve_identity.return_value = {"canonical_id": "person:alice"}
    client.delete.return_value = {"deleted": True}
    return client


# ---------------------------------------------------------------------------
# EngramShortTermMemory
# ---------------------------------------------------------------------------


class TestEngramShortTermMemory:
    def test_save_calls_create_daily(self, mock_client: MagicMock) -> None:
        """save() must delegate to client.create_daily with correct arguments."""
        stm = EngramShortTermMemory(mock_client, workspace="crewai-stm", ttl_seconds=3600)

        stm.save("task_result", "All steps completed")

        mock_client.create_daily.assert_called_once_with(
            content="[task_result] All steps completed",
            tags=["crewai", "short-term", "key:task_result"],
            workspace="crewai-stm",
            ttl_seconds=3600,
            metadata={},
        )

    def test_save_passes_custom_metadata(self, mock_client: MagicMock) -> None:
        """save() must forward caller-supplied metadata to create_daily."""
        stm = EngramShortTermMemory(mock_client)
        meta = {"agent": "researcher", "step": 3}

        stm.save("intermediate", "partial findings", metadata=meta)

        _, kwargs = mock_client.create_daily.call_args
        assert kwargs["metadata"] == meta

    def test_search_calls_client_search(self, mock_client: MagicMock) -> None:
        """search() must call client.search with the correct workspace and limit."""
        stm = EngramShortTermMemory(mock_client, workspace="crewai-stm")

        stm.search("completed tasks", limit=3)

        mock_client.search.assert_called_once_with(
            "completed tasks", workspace="crewai-stm", limit=3
        )

    def test_reset_deletes_found_memories(self, mock_client: MagicMock) -> None:
        """reset() must search and delete all memories returned."""
        mock_client.search.return_value = {
            "memories": [{"id": 10}, {"id": 11}, {"id": 12}]
        }
        stm = EngramShortTermMemory(mock_client, workspace="crewai-stm")

        stm.reset()

        mock_client.search.assert_called_once_with(
            "crewai", workspace="crewai-stm", limit=100
        )
        assert mock_client.delete.call_count == 3
        mock_client.delete.assert_any_call(10)
        mock_client.delete.assert_any_call(11)
        mock_client.delete.assert_any_call(12)

    def test_reset_skips_entries_without_id(self, mock_client: MagicMock) -> None:
        """reset() must not crash when a memory dict lacks an 'id' key."""
        mock_client.search.return_value = {
            "memories": [{"content": "no id here"}, {"id": 5}]
        }
        stm = EngramShortTermMemory(mock_client)

        stm.reset()  # should not raise

        mock_client.delete.assert_called_once_with(5)

    def test_default_workspace_and_ttl(self, mock_client: MagicMock) -> None:
        """Constructor defaults: workspace='crewai-stm', ttl_seconds=3600."""
        stm = EngramShortTermMemory(mock_client)

        assert stm.workspace == "crewai-stm"
        assert stm.ttl_seconds == 3600


# ---------------------------------------------------------------------------
# EngramLongTermMemory
# ---------------------------------------------------------------------------


class TestEngramLongTermMemory:
    def test_save_calls_create(self, mock_client: MagicMock) -> None:
        """save() must delegate to client.create with correct arguments."""
        ltm = EngramLongTermMemory(mock_client, crew_name="research-crew")

        ltm.save("finding_1", "Paris is the capital of France")

        mock_client.create.assert_called_once_with(
            content="[finding_1] Paris is the capital of France",
            tags=["crewai", "long-term", "key:finding_1"],
            workspace="crewai-research-crew",
            metadata={},
        )

    def test_uses_crew_specific_workspace(self, mock_client: MagicMock) -> None:
        """The workspace must be derived from crew_name when not supplied."""
        ltm = EngramLongTermMemory(mock_client, crew_name="sales-team")

        assert ltm.workspace == "crewai-sales-team"

    def test_custom_workspace_overrides_crew_name(self, mock_client: MagicMock) -> None:
        """Explicit workspace parameter must take precedence over crew_name."""
        ltm = EngramLongTermMemory(
            mock_client, crew_name="ignored", workspace="my-custom-ws"
        )

        assert ltm.workspace == "my-custom-ws"

    def test_search_calls_client_search(self, mock_client: MagicMock) -> None:
        """search() must call client.search with the crew workspace."""
        ltm = EngramLongTermMemory(mock_client, crew_name="analysis")

        ltm.search("capital cities", limit=7)

        mock_client.search.assert_called_once_with(
            "capital cities", workspace="crewai-analysis", limit=7
        )

    def test_save_passes_metadata(self, mock_client: MagicMock) -> None:
        """save() must forward caller-supplied metadata to create."""
        ltm = EngramLongTermMemory(mock_client)
        meta = {"source": "wikipedia", "confidence": 0.95}

        ltm.save("fact", "The sky is blue", metadata=meta)

        _, kwargs = mock_client.create.call_args
        assert kwargs["metadata"] == meta


# ---------------------------------------------------------------------------
# EngramEntityMemory
# ---------------------------------------------------------------------------


class TestEngramEntityMemory:
    def test_save_entity_calls_create_identity(self, mock_client: MagicMock) -> None:
        """save_entity() must call client.create_identity with a canonical ID."""
        em = EngramEntityMemory(mock_client)

        em.save_entity("Alice Smith", "person", "Lead researcher")

        mock_client.create_identity.assert_called_once_with(
            canonical_id="person:alice_smith",
            display_name="Alice Smith (Lead researcher)",
            aliases=[],
        )

    def test_save_entity_passes_aliases(self, mock_client: MagicMock) -> None:
        """save_entity() must forward aliases to create_identity."""
        em = EngramEntityMemory(mock_client)
        aliases = ["alice@example.com", "+5511999999999"]

        em.save_entity("Alice", "person", "Engineer", aliases=aliases)

        _, kwargs = mock_client.create_identity.call_args
        assert kwargs["aliases"] == aliases

    def test_get_entity_resolves_canonical_id(self, mock_client: MagicMock) -> None:
        """get_entity() must resolve using the canonical ID format."""
        em = EngramEntityMemory(mock_client)

        em.get_entity("Bob Jones", entity_type="person")

        mock_client.resolve_identity.assert_called_once_with("person:bob_jones")

    def test_get_entity_default_type_is_person(self, mock_client: MagicMock) -> None:
        """get_entity() defaults entity_type to 'person'."""
        em = EngramEntityMemory(mock_client)

        em.get_entity("Carol")

        mock_client.resolve_identity.assert_called_once_with("person:carol")

    def test_search_entities_calls_client_search(self, mock_client: MagicMock) -> None:
        """search_entities() must call client.search in the entity workspace."""
        em = EngramEntityMemory(mock_client, workspace="crewai-entities")

        em.search_entities("researcher", limit=3)

        mock_client.search.assert_called_once_with(
            "researcher", workspace="crewai-entities", limit=3
        )

    def test_canonical_id_normalises_spaces(self, mock_client: MagicMock) -> None:
        """Spaces in entity names must be replaced by underscores in the ID."""
        em = EngramEntityMemory(mock_client)

        em.save_entity("Open AI", "company", "AI lab")

        _, kwargs = mock_client.create_identity.call_args
        assert kwargs["canonical_id"] == "company:open_ai"