"""Integration tests for persistent PCH/PCM cache. Verifies that PCH/PCM artifacts are written to .clice/cache/pch/ and .clice/cache/pcm/ with content-addressed filenames, survive server restarts via cache.json, and are properly reused across sessions. """ import asyncio import pytest from lsprotocol.types import ( DidCloseTextDocumentParams, HoverParams, Position, ) from tests.conftest import make_client, shutdown_client from tests.integration.utils import write_cdb, doc from tests.integration.utils.wait import MTIME_GRANULARITY, SETTLE_TIME from tests.integration.utils.cache import ( list_pch_files, list_pcm_files, read_cache_json, ) from tests.integration.utils.assertions import assert_clean_compile def _pin_cache_to_workspace(tmp_path): """Write a clice.toml that pins cache_dir to /.clice/.""" (tmp_path / "clice.toml").write_text( '[project]\ncache_dir = "${workspace}/.clice"\n' ) async def test_pch_written_to_cache_dir(client, tmp_path): """After opening a file with #include, a .pch file should appear in .clice/cache/pch/ with a hex-hash filename.""" _pin_cache_to_workspace(tmp_path) (tmp_path / "header.h").write_text("#pragma once\nstruct Foo { int x; };\n") (tmp_path / "main.cpp").write_text( '#include "header.h"\nint main() { Foo f; return f.x; }\n' ) write_cdb(tmp_path, ["main.cpp"]) await client.initialize(tmp_path) uri, _ = await client.open_and_wait(tmp_path / "main.cpp") assert_clean_compile(client, uri) # Verify PCH file exists in the cache directory. pch_files = list_pch_files(tmp_path) assert len(pch_files) >= 1, "Expected at least one .pch file in .clice/cache/pch/" # Filename should be a 16-char hex hash + .pch assert pch_files[0].stem and len(pch_files[0].stem) == 16, ( f"Expected 16-char hex filename, got: {pch_files[0].name}" ) async def test_cache_json_persisted(client, tmp_path): """After a PCH build, cache.json should be written with the entry.""" _pin_cache_to_workspace(tmp_path) (tmp_path / "header.h").write_text("#pragma once\nint global_val = 42;\n") (tmp_path / "main.cpp").write_text( '#include "header.h"\nint main() { return global_val; }\n' ) write_cdb(tmp_path, ["main.cpp"]) await client.initialize(tmp_path) uri, _ = await client.open_and_wait(tmp_path / "main.cpp") assert_clean_compile(client, uri) cache = read_cache_json(tmp_path) assert cache is not None, "cache.json should exist after PCH build" assert "pch" in cache, "cache.json should have 'pch' section" assert len(cache["pch"]) >= 1, "Expected at least one PCH entry in cache.json" # Verify the entry has expected fields. entry = cache["pch"][0] assert "hash" in entry assert "build_at" in entry assert "deps" in entry assert "source_file" in entry async def test_pch_reused_on_close_reopen(client, tmp_path): """Closing and reopening a file within the same session should reuse the cached PCH — no additional .pch files should be created.""" _pin_cache_to_workspace(tmp_path) (tmp_path / "header.h").write_text("#pragma once\nstruct Bar { int y; };\n") (tmp_path / "main.cpp").write_text( '#include "header.h"\nint main() { Bar b; return b.y; }\n' ) write_cdb(tmp_path, ["main.cpp"]) await client.initialize(tmp_path) # First open — builds PCH. uri, _ = await client.open_and_wait(tmp_path / "main.cpp") assert_clean_compile(client, uri) pch_after_first = list_pch_files(tmp_path) assert len(pch_after_first) >= 1 # Close. client.text_document_did_close(DidCloseTextDocumentParams(text_document=doc(uri))) await asyncio.sleep(SETTLE_TIME) # Clear diagnostics so we can wait for fresh ones. client.diagnostics.pop(uri, None) # Reopen — should reuse cached PCH. uri2, _ = await client.open_and_wait(tmp_path / "main.cpp") assert_clean_compile(client, uri2) pch_after_reopen = list_pch_files(tmp_path) assert pch_after_first == pch_after_reopen, ( "PCH file set should be identical after close+reopen" ) async def test_pch_survives_server_restart(executable, tmp_path): """PCH cache should survive a full server restart — cache.json is loaded on startup and the existing .pch file is reused.""" _pin_cache_to_workspace(tmp_path) (tmp_path / "header.h").write_text("#pragma once\nstruct Baz { int z; };\n") (tmp_path / "main.cpp").write_text( '#include "header.h"\nint main() { Baz b; return b.z; }\n' ) write_cdb(tmp_path, ["main.cpp"]) # Session 1: build PCH. c1 = await make_client(executable, tmp_path) uri, _ = await c1.open_and_wait(tmp_path / "main.cpp") assert_clean_compile(c1, uri) pch_files_s1 = list_pch_files(tmp_path) assert len(pch_files_s1) >= 1, "PCH should be created in session 1" pch_mtime_s1 = pch_files_s1[0].stat().st_mtime cache_s1 = read_cache_json(tmp_path) assert cache_s1 is not None, "cache.json should exist after session 1" await shutdown_client(c1) # Session 2: restart server, reopen file. c2 = await make_client(executable, tmp_path) # Clear so we can detect fresh diagnostics. uri2, _ = await c2.open_and_wait(tmp_path / "main.cpp") assert_clean_compile(c2, uri2) # The same PCH file should still exist, not overwritten. pch_files_s2 = list_pch_files(tmp_path) assert len(pch_files_s2) == len(pch_files_s1), ( "No new PCH files should be created in session 2" ) pch_mtime_s2 = pch_files_s2[0].stat().st_mtime assert pch_mtime_s1 == pch_mtime_s2, ( "PCH file should not be rebuilt (mtime should be unchanged)" ) await shutdown_client(c2) async def test_shared_preamble_shares_pch(client, tmp_path): """Two files with identical preambles should share the same PCH file (content-addressed by preamble hash).""" _pin_cache_to_workspace(tmp_path) (tmp_path / "header.h").write_text("#pragma once\nint shared_val = 1;\n") (tmp_path / "a.cpp").write_text( '#include "header.h"\nint fa() { return shared_val; }\n' ) (tmp_path / "b.cpp").write_text( '#include "header.h"\nint fb() { return shared_val + 1; }\n' ) write_cdb(tmp_path, ["a.cpp", "b.cpp"]) await client.initialize(tmp_path) uri_a, _ = await client.open_and_wait(tmp_path / "a.cpp") uri_b, _ = await client.open_and_wait(tmp_path / "b.cpp") assert_clean_compile(client, uri_a) assert_clean_compile(client, uri_b) # Both files have the same preamble (#include "header.h"). # Content-addressed naming means only ONE .pch file should exist. pch_files = list_pch_files(tmp_path) assert len(pch_files) == 1, ( f"Expected exactly 1 PCH file for shared preamble, got {len(pch_files)}: " f"{[f.name for f in pch_files]}" ) async def test_different_preamble_different_pch(client, tmp_path): """Files with different preambles should produce different PCH files.""" _pin_cache_to_workspace(tmp_path) (tmp_path / "a.h").write_text("#pragma once\nint val_a = 1;\n") (tmp_path / "b.h").write_text("#pragma once\nint val_b = 2;\n") (tmp_path / "a.cpp").write_text('#include "a.h"\nint fa() { return val_a; }\n') (tmp_path / "b.cpp").write_text('#include "b.h"\nint fb() { return val_b; }\n') write_cdb(tmp_path, ["a.cpp", "b.cpp"]) await client.initialize(tmp_path) uri_a, _ = await client.open_and_wait(tmp_path / "a.cpp") uri_b, _ = await client.open_and_wait(tmp_path / "b.cpp") assert_clean_compile(client, uri_a) assert_clean_compile(client, uri_b) # Different preambles → different hash → two separate .pch files. pch_files = list_pch_files(tmp_path) assert len(pch_files) == 2, ( f"Expected 2 PCH files for different preambles, got {len(pch_files)}: " f"{[f.name for f in pch_files]}" ) async def test_pch_rebuilt_on_header_change(client, tmp_path): """When a preamble header changes, a new PCH should be built (different hash → different filename). The old one remains for cleanup.""" _pin_cache_to_workspace(tmp_path) (tmp_path / "header.h").write_text("#pragma once\nstruct V1 { int a; };\n") (tmp_path / "main.cpp").write_text( '#include "header.h"\nint main() { V1 v; return v.a; }\n' ) write_cdb(tmp_path, ["main.cpp"]) await client.initialize(tmp_path) uri, _ = await client.open_and_wait(tmp_path / "main.cpp") assert_clean_compile(client, uri) pch_before = list_pch_files(tmp_path) assert len(pch_before) >= 1 # Modify header — changes preamble content hash. await asyncio.sleep(MTIME_GRANULARITY) (tmp_path / "header.h").write_text("#pragma once\nstruct V2 { int b; };\n") # Also update main.cpp to use V2 so it compiles cleanly. (tmp_path / "main.cpp").write_text( '#include "header.h"\nint main() { V2 v; return v.b; }\n' ) # Close and reopen to get fresh preamble. client.text_document_did_close(DidCloseTextDocumentParams(text_document=doc(uri))) await asyncio.sleep(SETTLE_TIME) client.diagnostics.pop(uri, None) uri2, _ = await client.open_and_wait(tmp_path / "main.cpp") assert_clean_compile(client, uri2) pch_after = list_pch_files(tmp_path) # The preamble content changed (#include "header.h" is the same text, # but the preamble hash is computed from the preamble TEXT in the source file, # not from the header content). Since the #include line is identical, # the preamble hash is the same → same PCH filename, but deps changed # so PCH gets rebuilt (overwritten at the same path). # Either way, compilation should succeed. assert len(pch_after) >= 1 async def test_no_tmp_files_after_build(client, tmp_path): """After a successful PCH build, no .tmp files should remain in the cache dir.""" _pin_cache_to_workspace(tmp_path) (tmp_path / "header.h").write_text("#pragma once\nint val = 1;\n") (tmp_path / "main.cpp").write_text( '#include "header.h"\nint main() { return val; }\n' ) write_cdb(tmp_path, ["main.cpp"]) await client.initialize(tmp_path) uri, _ = await client.open_and_wait(tmp_path / "main.cpp") assert_clean_compile(client, uri) # No .tmp files should linger. pch_dir = tmp_path / ".clice" / "cache" / "pch" if pch_dir.exists(): tmp_files = list(pch_dir.glob("*.tmp")) assert len(tmp_files) == 0, f"Stale .tmp files found: {tmp_files}" pcm_dir = tmp_path / ".clice" / "cache" / "pcm" if pcm_dir.exists(): tmp_files = list(pcm_dir.glob("*.tmp")) assert len(tmp_files) == 0, f"Stale .tmp files found: {tmp_files}" async def test_cache_dirs_created_on_startup(client, tmp_path): """The .clice/cache/pch/ and .clice/cache/pcm/ directories should be created when the server initializes a workspace.""" _pin_cache_to_workspace(tmp_path) (tmp_path / "main.cpp").write_text("int main() { return 0; }\n") write_cdb(tmp_path, ["main.cpp"]) await client.initialize(tmp_path) # Trigger a compilation to ensure load_workspace() has completed # (it runs asynchronously after initialization). uri, _ = await client.open_and_wait(tmp_path / "main.cpp") assert_clean_compile(client, uri) assert (tmp_path / ".clice" / "cache" / "pch").is_dir(), ( ".clice/cache/pch/ should be created" ) assert (tmp_path / ".clice" / "cache" / "pcm").is_dir(), ( ".clice/cache/pcm/ should be created" )