Files
clice/tests/unit/server/module_worker_tests.cpp
ykiko bc04845293 refactor(tests): CMake-based CDB, workspace fixture, test cleanup (#378)
## Summary

- **CMake-based CDB generation for module tests**: Replace hand-written
compile_commands.json with CMakeLists.txt (CMake 3.28 `FILE_SET
CXX_MODULES`) in all 26 `tests/data/modules/*/` directories. CDB is
generated on-the-fly via `cmake -G Ninja` during test setup.
- **`@pytest.mark.workspace()` decorator**: Introduce a marker + fixture
pattern so tests declare their workspace via decorator and receive a
resolved `workspace` path. The fixture auto-generates CDB when a
CMakeLists.txt is present.
- **`CliceClient` helper methods**: Add `initialize()`, `open()`,
`wait_diagnostics()`, and `open_and_wait()` to reduce boilerplate across
all test files.
- **Use `asyncio_mode = "auto"`**: Switch from `@pytest_asyncio.fixture`
+ `@pytest.mark.asyncio` to `@pytest.fixture` + auto mode for proper
Pylance type inference on fixtures.
- **Test cleanup**: Remove redundant section separators and docstrings,
delete `tests/pyproject.toml` (config moved to `pytest.ini`).
- **Format task**: Add `.cppm` to `format-cpp` glob pattern.
- **CI fix**: Disable `CMAKE_CXX_SCAN_FOR_MODULES` and prefer pixi
clang++ to fix macOS CI where CMake rejects module scanning.

## Test plan

- [x] All 26 module test directories have CMakeLists.txt with FILE_SET
CXX_MODULES
- [x] generate_cdb() produces valid compile_commands.json with module
flags
- [x] Integration tests pass locally
- [ ] CI passes on all platforms (Linux, macOS, Windows)

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Tests**
* Unified fixtures and client workflow: new init/open/wait helpers,
workspace marker support, bounded diagnostics waiting, CMake-based
compilation-database generation, and directory-backed temp-file
workflows; enabled asyncio test mode.
* **Chores**
* Added many C++20 module test projects and test data; removed prior
test pyproject in favor of pytest config; updated formatter to include
.cppm files.
* **Style**
* Reformatted many module/source implementations to consistent
multi-line function bodies.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-31 16:57:48 +08:00

285 lines
8.9 KiB
C++

#include <string>
#include <vector>
#include "test/test.h"
#include "server/protocol.h"
#include "server/worker_test_helpers.h"
namespace clice::testing {
namespace {
namespace et = eventide;
// ============================================================================
// End-to-end module compilation through real workers:
// 1. Stateless worker builds PCM for module interface
// 2. Stateful worker compiles a file that imports the module using the PCM
// This tests the same pipeline as MasterServer.run_build_drain().
// ============================================================================
TEST_SUITE(ModuleWorker) {
TEST_CASE(BuildPCMThenCompileWithImport) {
TempDir tmp;
// Module interface: produces PCM.
tmp.touch("mod_iface.cppm",
"export module Hello;\n" R"(export const char* hello() { return "world"; })" "\n");
auto iface = tmp.path("mod_iface.cppm");
// Consumer: imports the module.
tmp.touch("consumer.cpp", "import Hello;\n" "int main() { return hello()[0]; }\n");
auto consumer = tmp.path("consumer.cpp");
// --- Phase 1: Build PCM via stateless worker ---
WorkerHandle sl;
ASSERT_TRUE(sl.spawn("stateless-worker"));
std::string pcm_path;
bool phase1_done = false;
sl.run([&]() -> et::task<> {
worker::BuildPCMParams params;
params.file = iface;
params.directory = "/tmp";
params.arguments = {"clang++",
"-resource-dir",
std::string(resource_dir()),
"-std=c++20",
"--precompile",
iface};
params.module_name = "Hello";
auto result = co_await sl.peer->send_request(params);
CO_ASSERT_TRUE(result.has_value());
CO_ASSERT_TRUE(result.value().success);
pcm_path = result.value().pcm_path;
EXPECT_FALSE(pcm_path.empty());
phase1_done = true;
sl.peer->close_output();
});
ASSERT_TRUE(phase1_done);
ASSERT_FALSE(pcm_path.empty());
// --- Phase 2: Compile consumer with the PCM via stateful worker ---
WorkerHandle sf;
ASSERT_TRUE(sf.spawn("stateful-worker"));
bool phase2_done = false;
sf.run([&]() -> et::task<> {
worker::CompileParams params;
params.path = consumer;
params.version = 1;
params.text = "import Hello;\n" "int main() { return hello()[0]; }\n";
params.directory = "/tmp";
params.arguments = {"clang++",
"-resource-dir",
std::string(resource_dir()),
"-std=c++20",
"-fsyntax-only",
consumer};
// Pass the PCM — same as MasterServer fills CompileParams.pcms.
params.pcms = {
{"Hello", pcm_path}
};
auto result = co_await sf.peer->send_request(params);
CO_ASSERT_TRUE(result.has_value());
EXPECT_EQ(result.value().version, 1);
phase2_done = true;
sf.peer->close_output();
});
ASSERT_TRUE(phase2_done);
// Cleanup PCM temp file.
std::remove(pcm_path.c_str());
}
TEST_CASE(BuildPCMChainThenCompile) {
TempDir tmp;
// Module A: no deps.
tmp.touch("chain_a.cppm", "export module A;\n" "export int val_a() { return 1; }\n");
auto mod_a = tmp.path("chain_a.cppm");
// Module B: imports A.
tmp.touch("chain_b.cppm",
"export module B;\n"
"import A;\n"
"export int val_b() { return val_a() + 1; }\n");
auto mod_b = tmp.path("chain_b.cppm");
// Consumer: imports B (transitively needs A).
tmp.touch("chain_consumer.cpp", "import B;\n" "int main() { return val_b(); }\n");
auto consumer = tmp.path("chain_consumer.cpp");
WorkerHandle sl;
ASSERT_TRUE(sl.spawn("stateless-worker"));
std::string pcm_a, pcm_b;
bool pcm_done = false;
sl.run([&]() -> et::task<> {
// Build PCM for A first.
{
worker::BuildPCMParams params;
params.file = mod_a;
params.directory = "/tmp";
params.arguments = {"clang++",
"-resource-dir",
std::string(resource_dir()),
"-std=c++20",
"--precompile",
mod_a};
params.module_name = "A";
auto result = co_await sl.peer->send_request(params);
CO_ASSERT_TRUE(result.has_value() && result.value().success);
pcm_a = result.value().pcm_path;
}
// Build PCM for B, passing A's PCM (transitive dep).
{
worker::BuildPCMParams params;
params.file = mod_b;
params.directory = "/tmp";
params.arguments = {"clang++",
"-resource-dir",
std::string(resource_dir()),
"-std=c++20",
"--precompile",
mod_b};
params.module_name = "B";
params.pcms = {
{"A", pcm_a}
};
auto result = co_await sl.peer->send_request(params);
CO_ASSERT_TRUE(result.has_value() && result.value().success);
pcm_b = result.value().pcm_path;
}
pcm_done = true;
sl.peer->close_output();
});
ASSERT_TRUE(pcm_done);
// Compile consumer with BOTH PCMs via stateful worker.
WorkerHandle sf;
ASSERT_TRUE(sf.spawn("stateful-worker"));
bool compile_done = false;
sf.run([&]() -> et::task<> {
worker::CompileParams params;
params.path = consumer;
params.version = 1;
params.text = "import B;\n" "int main() { return val_b(); }\n";
params.directory = "/tmp";
params.arguments = {"clang++",
"-resource-dir",
std::string(resource_dir()),
"-std=c++20",
"-fsyntax-only",
consumer};
// Clang needs ALL transitive PCMs.
params.pcms = {
{"A", pcm_a},
{"B", pcm_b}
};
auto result = co_await sf.peer->send_request(params);
CO_ASSERT_TRUE(result.has_value());
EXPECT_EQ(result.value().version, 1);
compile_done = true;
sf.peer->close_output();
});
ASSERT_TRUE(compile_done);
std::remove(pcm_a.c_str());
std::remove(pcm_b.c_str());
}
TEST_CASE(ModuleImplementationUnitWithWorker) {
TempDir tmp;
// Module interface.
tmp.touch("impl_iface.cppm", "export module Calc;\n" "export int add(int a, int b);\n");
auto iface = tmp.path("impl_iface.cppm");
// Module implementation unit (no export).
tmp.touch("impl_unit.cpp", "module Calc;\n" "int add(int a, int b) { return a + b; }\n");
auto impl = tmp.path("impl_unit.cpp");
// Build PCM for interface.
WorkerHandle sl;
ASSERT_TRUE(sl.spawn("stateless-worker"));
std::string pcm_path;
bool pcm_done = false;
sl.run([&]() -> et::task<> {
worker::BuildPCMParams params;
params.file = iface;
params.directory = "/tmp";
params.arguments = {"clang++",
"-resource-dir",
std::string(resource_dir()),
"-std=c++20",
"--precompile",
iface};
params.module_name = "Calc";
auto result = co_await sl.peer->send_request(params);
CO_ASSERT_TRUE(result.has_value() && result.value().success);
pcm_path = result.value().pcm_path;
pcm_done = true;
sl.peer->close_output();
});
ASSERT_TRUE(pcm_done);
// Compile implementation unit with the PCM via stateful worker.
WorkerHandle sf;
ASSERT_TRUE(sf.spawn("stateful-worker"));
bool compile_done = false;
sf.run([&]() -> et::task<> {
worker::CompileParams params;
params.path = impl;
params.version = 1;
params.text = "module Calc;\n" "int add(int a, int b) { return a + b; }\n";
params.directory = "/tmp";
params.arguments = {"clang++",
"-resource-dir",
std::string(resource_dir()),
"-std=c++20",
"-fsyntax-only",
impl};
params.pcms = {
{"Calc", pcm_path}
};
auto result = co_await sf.peer->send_request(params);
CO_ASSERT_TRUE(result.has_value());
EXPECT_EQ(result.value().version, 1);
compile_done = true;
sf.peer->close_output();
});
ASSERT_TRUE(compile_done);
std::remove(pcm_path.c_str());
}
}; // TEST_SUITE(ModuleWorker)
} // namespace
} // namespace clice::testing