Merge pull request #25 from neo4j-contrib/15-test-suite-deletes-database

implement testcontainers for IT, update README

Author: a-s-g93

servers/mcp-neo4j-cypher/CHANGELOG.md

@@ -1,7 +1,23 @@
-## Next
+## Next 
 
 ### Fixed
 
+* IT no longer has risk of affecting locally deployed Neo4j instances
+
+### Changed
+
+* IT now uses Testcontainers library instead of Docker scripts 
+
+### Added
+
+## v0.2.1
+
+### Fixed
+
+* Fixed MCP version notation for declaration in config files - README
+
+## v0.2.0
+
 ### Changed
 
 * Refactor mcp-neo4j-cypher to use the FastMCP class

servers/mcp-neo4j-cypher/README.md

@@ -162,11 +162,6 @@ uv pip install -e ".[dev]"
 
 3. Run Integration Tests
 
-**CLOSE ANY LOCAL NEO4J DATABASES BEFORE RUNNING TESTS**
-* Tests will deploy a local docker container containing the test Neo4j instance. 
-* However if a Neo4j database is running locally, then the test driver may connect here instead. 
-* **This will result in you local Neo4j database having its contents erased.**
-
 ```bash
 ./tests.sh
 ```

servers/mcp-neo4j-cypher/pyproject.toml

@@ -20,6 +20,7 @@ dev-dependencies = [
  "pytest>=7.0.0",
  "pytest-asyncio>=0.20.3",
  "ruff>=0.11.5",
+ "testcontainers[neo4j]>=4.10.0"
 ]
 
 [project.scripts]

servers/mcp-neo4j-cypher/src/mcp_neo4j_cypher/server.py

@@ -85,8 +85,8 @@ def create_mcp_server(neo4j_driver: AsyncDriver, database: str = "neo4j") -> Fas
 
     async def get_neo4j_schema() -> list[types.TextContent]:
         """List all node, their attributes and their relationships to other nodes in the neo4j database.
-            If this fails with a message that includes "Neo.ClientError.Procedure.ProcedureNotFound"
-            suggest that the user install and enable the APOC plugin.
+        If this fails with a message that includes "Neo.ClientError.Procedure.ProcedureNotFound"
+        suggest that the user install and enable the APOC plugin.
         """
 
         get_schema_query = """

servers/mcp-neo4j-cypher/test.sh

@@ -1,3 +1 @@
-docker compose -f tests/integration/docker-compose.yml up -d
-uv run pytest tests/integration -s 
-docker compose -f tests/integration/docker-compose.yml stop
+uv run pytest tests/integration -s 

servers/mcp-neo4j-cypher/tests/integration/conftest.py

@@ -1,72 +1,59 @@
-import time
+import os
 from typing import Any
 
 import pytest
 import pytest_asyncio
-from neo4j import AsyncGraphDatabase, Driver, GraphDatabase
-from neo4j.exceptions import DatabaseError
+from neo4j import AsyncGraphDatabase
+from testcontainers.neo4j import Neo4jContainer
 
 from mcp_neo4j_cypher.server import create_mcp_server
 
+neo4j = (
+    Neo4jContainer("neo4j:latest")
+    .with_env("NEO4J_apoc_export_file_enabled", "true")
+    .with_env("NEO4J_apoc_import_file_enabled", "true")
+    .with_env("NEO4J_apoc_import_file_use__neo4j__config", "true")
+    .with_env("NEO4J_PLUGINS", '["apoc"]')
+)
 
-@pytest_asyncio.fixture(scope="session")
-async def async_neo4j_driver():
+
+@pytest.fixture(scope="module", autouse=True)
+def setup(request):
+    neo4j.start()
+
+    def remove_container():
+        neo4j.get_driver().close()
+        neo4j.stop()
+
+    request.addfinalizer(remove_container)
+    os.environ["NEO4J_URI"] = neo4j.get_connection_url()
+    os.environ["NEO4J_HOST"] = neo4j.get_container_host_ip()
+    os.environ["NEO4J_PORT"] = neo4j.get_exposed_port(7687)
+
+    yield neo4j
+
+
+@pytest_asyncio.fixture(scope="function")
+async def async_neo4j_driver(setup: Neo4jContainer):
     driver = AsyncGraphDatabase.driver(
-        "neo4j://localhost:7687", auth=("neo4j", "testingpassword")
+        setup.get_connection_url(), auth=(setup.username, setup.password)
     )
     try:
         yield driver
     finally:
         await driver.close()
 
 
-@pytest.fixture(scope="session")
-def sync_neo4j_driver():
-    uri = "neo4j://localhost:7687"
-    auth = ("neo4j", "testingpassword")
-    driver = GraphDatabase.driver(uri, auth=auth)
-    yield driver
-    driver.close()
-
-
-@pytest.fixture(scope="session")
-def healthcheck(sync_neo4j_driver: Driver):
-    """Confirm that Neo4j is running before running IT."""
-
-    print("Confirming Neo4j is running...")
-    attempts = 0
-    success = False
-    print("\nWaiting for Neo4j to Start...\n")
-    time.sleep(3)
-    while not success and attempts < 3:
-        try:
-            print(f"Attempt {attempts + 1} to connect to Neo4j...")
-            with sync_neo4j_driver.session(database="neo4j") as session:
-                session.run("RETURN 1")
-            success = True
-            print("Neo4j is running!")
-        except Exception as e:
-            attempts += 1
-            print(
-                f"failed connection {attempts} | waiting {(1 + attempts) * 2} seconds..."
-            )
-            print(f"Error: {e}")
-            time.sleep((1 + attempts) * 2)
-    if not success:
-        raise DatabaseError()
-    yield
-
-
-@pytest_asyncio.fixture(scope="session")
+@pytest_asyncio.fixture(scope="function")
 async def mcp_server(async_neo4j_driver):
     mcp = create_mcp_server(async_neo4j_driver, "neo4j")
 
     return mcp
 
 
-@pytest.fixture(scope="session")
-def init_data(sync_neo4j_driver: Driver, clear_data: Any):
-    with sync_neo4j_driver.session(database="neo4j") as session:
+@pytest.fixture(scope="function")
+def init_data(setup: Neo4jContainer, clear_data: Any):
+    with setup.get_driver().session(database="neo4j") as session:
         session.run("CREATE (a:Person {name: 'Alice', age: 30})")
         session.run("CREATE (b:Person {name: 'Bob', age: 25})")
         session.run("CREATE (c:Person {name: 'Charlie', age: 35})")
@@ -78,7 +65,7 @@ def init_data(sync_neo4j_driver: Driver, clear_data: Any):
         )
 
 
-@pytest.fixture(scope="session")
-def clear_data(sync_neo4j_driver: Driver):
-    with sync_neo4j_driver.session(database="neo4j") as session:
+@pytest.fixture(scope="function")
+def clear_data(setup: Neo4jContainer):
+    with setup.get_driver().session(database="neo4j") as session:
         session.run("MATCH (n) DETACH DELETE n")

servers/mcp-neo4j-cypher/tests/integration/docker-compose.yml

@@ -5,8 +5,8 @@
 from mcp.server import FastMCP
 
 
-@pytest.mark.asyncio(loop_scope="session")
-async def test_get_neo4j_schema(mcp_server: FastMCP, healthcheck: Any, init_data: Any):
+@pytest.mark.asyncio(loop_scope="function")
+async def test_get_neo4j_schema(mcp_server: FastMCP, init_data: Any):
     response = await mcp_server.call_tool("get_neo4j_schema", dict())
 
     schema = json.loads(response[0].text)[0]
@@ -17,8 +17,8 @@ async def test_get_neo4j_schema(mcp_server: FastMCP, healthcheck: Any, init_data
     assert "relationships" in schema
 
 
-@pytest.mark.asyncio(loop_scope="session")
-async def test_write_neo4j_cypher(mcp_server: FastMCP, healthcheck: Any):
+@pytest.mark.asyncio(loop_scope="function")
+async def test_write_neo4j_cypher(mcp_server: FastMCP):
     # Execute a Cypher query to create a node
     query = "CREATE (n:Test {name: 'test', age: 123}) RETURN n.name"
     response = await mcp_server.call_tool("write_neo4j_cypher", dict(query=query))
@@ -31,8 +31,8 @@ async def test_write_neo4j_cypher(mcp_server: FastMCP, healthcheck: Any):
     assert result["properties_set"] == 2
 
 
-@pytest.mark.asyncio(loop_scope="session")
-async def test_read_neo4j_cypher(mcp_server: FastMCP, healthcheck: Any, init_data: Any):
+@pytest.mark.asyncio(loop_scope="function")
+async def test_read_neo4j_cypher(mcp_server: FastMCP, init_data: Any):
     # Prepare test data
 
     # Execute a complex read query