basic-memory/tests/mcp/test_tool_basic_memory_diagnostics.py at 29be0299f012b7d143ab3622cd89d50133218aa5 · basicmachines-co/basic-memory · GitHub

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
"""Tests for the basic_memory_diagnostics MCP tool."""

import json
import platform
import sys
from unittest.mock import MagicMock, patch

import basic_memory
from basic_memory.mcp.tools.basic_memory_diagnostics import (
    _redact_config,
    basic_memory_diagnostics,
)


# ---------------------------------------------------------------------------
# Unit tests for _redact_config helper
# ---------------------------------------------------------------------------


def test_redact_config_removes_cloud_api_key():
    raw = {"cloud_api_key": "bmc_secret", "default_project": "main", "projects": {}}
    result = _redact_config(raw)
    assert "cloud_api_key" not in result
    assert result["default_project"] == "main"
    assert "projects" in result


def test_redact_config_passes_through_safe_fields():
    raw = {"default_project": "main", "log_level": "INFO", "env": "dev"}
    result = _redact_config(raw)
    assert result == raw


def test_redact_config_empty_dict():
    assert _redact_config({}) == {}


# ---------------------------------------------------------------------------
# Tests for the basic_memory_diagnostics tool
# ---------------------------------------------------------------------------


def test_diagnostics_returns_string():
    result = basic_memory_diagnostics()
    assert isinstance(result, str)


def test_diagnostics_includes_version():
    result = basic_memory_diagnostics()
    assert basic_memory.__version__ in result
    assert basic_memory.__api_version__ in result


def test_diagnostics_includes_python_version():
    result = basic_memory_diagnostics()
    # sys.version can be multi-line; just check the version tuple prefix
    major_minor = f"{sys.version_info.major}.{sys.version_info.minor}"
    assert major_minor in result


def test_diagnostics_includes_platform():
    result = basic_memory_diagnostics()
    assert platform.machine() in result


def test_diagnostics_includes_config_path(tmp_path):
    """Config path section should appear in output."""
    with patch("basic_memory.mcp.tools.basic_memory_diagnostics.ConfigManager") as MockMgr:
        mock_mgr = MagicMock()
        mock_mgr.config_dir = tmp_path
        MockMgr.return_value = mock_mgr

        config_file = tmp_path / "config.json"
        config_file.write_text(json.dumps({"default_project": "main", "projects": {}}))

        result = basic_memory_diagnostics()

    assert str(tmp_path) in result
    assert "Config path:" in result


def test_diagnostics_config_exists_with_valid_json(tmp_path):
    """When config file exists, its safe contents should appear as JSON."""
    config_data = {
        "default_project": "research",
        "projects": {"research": {"path": str(tmp_path / "research")}},
    }
    with patch("basic_memory.mcp.tools.basic_memory_diagnostics.ConfigManager") as MockMgr:
        mock_mgr = MagicMock()
        mock_mgr.config_dir = tmp_path
        MockMgr.return_value = mock_mgr

        config_file = tmp_path / "config.json"
        config_file.write_text(json.dumps(config_data))

        result = basic_memory_diagnostics()

    assert "research" in result
    assert "```json" in result


def test_diagnostics_redacts_cloud_api_key(tmp_path):
    """cloud_api_key must never appear in diagnostic output."""
    config_data = {
        "default_project": "main",
        "cloud_api_key": "bmc_super_secret_token",
        "projects": {},
    }
    with patch("basic_memory.mcp.tools.basic_memory_diagnostics.ConfigManager") as MockMgr:
        mock_mgr = MagicMock()
        mock_mgr.config_dir = tmp_path
        MockMgr.return_value = mock_mgr

        config_file = tmp_path / "config.json"
        config_file.write_text(json.dumps(config_data))

        result = basic_memory_diagnostics()

    assert "bmc_super_secret_token" not in result
    assert "cloud_api_key" not in result


def test_diagnostics_config_missing(tmp_path):
    """When config file does not exist, output should say so."""
    with patch("basic_memory.mcp.tools.basic_memory_diagnostics.ConfigManager") as MockMgr:
        mock_mgr = MagicMock()
        mock_mgr.config_dir = tmp_path
        MockMgr.return_value = mock_mgr

        # Ensure no config.json is present
        config_file = tmp_path / "config.json"
        assert not config_file.exists()

        result = basic_memory_diagnostics()

    assert "Config exists: False" in result
    assert "<config file not found>" in result


def test_diagnostics_output_sections():
    """All expected section headers should be present."""
    result = basic_memory_diagnostics()
    assert "# Basic Memory Diagnostics" in result
    assert "## Version" in result
    assert "## System" in result
    assert "## Configuration" in result