yams/tests/unit/search/simeon_lexical_backend_catch2_test.cpp
Trevon bfe7cd94ca
test: expand storage-readiness coverage — 48.1%→59.8% broad, 74.3% narrow (#38)
* fix(daemon): avoid socket cancel on stop

Signal active sockets with shutdown only so pending I/O wakes without entering Boost.Asio's reactor cancel path during teardown.

* fix(metadata): open read pools read-only

* ci: fix coverage report generation

* fix(metadata): tag unscoped pool holders

* test(daemon): avoid ipc teardown takeover

* ci: skip plugin coverage objects

* fix(daemon): repair completed FTS5 ghosts

* build(vector): guard unusable FAISS headers

* ci: use clang gcov for coverage

* test(daemon): stabilize arm CI flakes

* Harden search and compression numeric config

* fix(daemon): reconcile orphan vector embeddings

* fix: address vector cleanup review comments

* chore(main): release 0.16.1

* Harden search ranking divisors

* Harden snippet distance and command registration

* test(storage): add readiness coverage gate

Document the distributed sync readiness surface and add direct adapter, refcount, and GC failure-path coverage.

* test(storage): cover strict resolver fallback

* fix(search): tighten retrieval ranking

Honor component weights in default RRF, over-fetch vector chunks before document aggregation, and persist topology centroids for sparse-guided routing.

* fix(search): route weak queries through topology

* fix(search): improve rerank and weak queries

Wire provider-backed cross reranking, add direct Simeon candidates for weak lexical pools, and report stage-level retrieval metrics.

* fix(storage): honor explicit plugin names

Add readiness coverage for factory, URL backend, and compressed storage failure paths.

* fix(storage): avoid remote size listing

* fix(api): rollback failed content adds

* test(storage): cover engine readiness

* test(storage): cover compressed readiness

* fix(core): harden delete and recovery paths

Route prune and local delete fallback through DocumentService so content, metadata, vectors, and KG cleanup stay consistent.

Treat transient SQLite quick_check lock failures as ResourceBusy, refresh IPC activity on streaming writes, and preserve reranker config in tuner seeding.

* test(storage): cover URL backend readiness

* fix(api): harden content rollback

* feat(storage): add list seam, URL listing, and write-edge coverage

* feat(api): reconcile ambiguous remote manifest writes

* feat(storage): add deep compressed scan validation

* test(storage): add plugin loader error path coverage

* fix(gc): prune reference rows after collection

* test(api,storage): add health, compact, gc, and verify edge coverage

* docs: update storage-readiness coverage to 71.8%

* test(metadata): add connection pool shutdown-while-leased coverage

* test(metadata): add tree builder snapshot root stability coverage

* test(vector): add before-init and after-close operation rejection coverage

* test(metadata): add database post-close, open-failure, and cache-clear coverage

* test(integrity): add P2P wrong-hash rejection + batch matrix resolution

* docs: audit and resolve all matrix rows — 18 fully covered

* test(metadata): add failed-migration and rollback coverage

* test(storage): add getBlockSize-invalid-key, empty-verify, PUT/DELETE retry coverage

* feat(storage): add file-open and rename failure hooks + ContentStore retrieve edge coverage

* docs: add broad-surface coverage with per-subsystem breakdown

* test(integrity): add chunk validator manifest validation coverage

* test(vector): add batch insert, delete, and update operation coverage

* docs: update integrity subsystem coverage to 46.4%

* docs: consolidate coverage report — clean matrix, remove boilerplate

* docs: update coverage with complete-suite numbers — 59.8% broad, 74.3% narrow

* test(storage): add URLBackend HEAD exists with 2xx coverage

* bump submodules

* fix: address PR review — curl_slist leak, ec ordering, CAS rollback, production hooks

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-05-25 22:58:15 -04:00

403 lines
14 KiB
C++

#include <catch2/catch_approx.hpp>
#include <catch2/catch_test_macros.hpp>
#include <chrono>
#include <cstdlib>
#include <filesystem>
#include <memory>
#include <string>
#include <thread>
#include <vector>
#include <yams/metadata/metadata_repository.h>
#include <yams/search/simeon_lexical_backend.h>
#include <simeon/bm25.hpp>
#include <simeon/fusion.hpp>
using namespace yams;
using namespace yams::metadata;
using namespace yams::search;
namespace {
std::filesystem::path tempDbPath(const char* prefix) {
const char* t = std::getenv("YAMS_TEST_TMPDIR");
auto base = (t && *t) ? std::filesystem::path(t) : std::filesystem::temp_directory_path();
std::error_code ec;
std::filesystem::create_directories(base, ec);
auto ts = std::chrono::steady_clock::now().time_since_epoch().count();
auto p = base / (std::string(prefix) + std::to_string(ts) + ".db");
std::filesystem::remove(p, ec);
return p;
}
struct TempCorpus {
std::filesystem::path dbPath;
std::unique_ptr<ConnectionPool> pool;
std::shared_ptr<MetadataRepository> repo;
std::vector<std::int64_t> docIds;
};
TempCorpus makeCorpus(const std::vector<std::pair<std::string, std::string>>& docs) {
TempCorpus corpus;
corpus.dbPath = tempDbPath("simeon_lex_");
ConnectionPoolConfig pcfg;
corpus.pool = std::make_unique<ConnectionPool>(corpus.dbPath.string(), pcfg);
REQUIRE(corpus.pool->initialize().has_value());
corpus.repo = std::make_shared<MetadataRepository>(*corpus.pool);
for (const auto& [hash, content] : docs) {
DocumentInfo d;
d.filePath = "/tmp/" + hash + ".txt";
d.fileName = hash + ".txt";
d.fileExtension = ".txt";
d.fileSize = static_cast<int64_t>(content.size());
d.sha256Hash = hash;
d.mimeType = "text/plain";
d.createdTime = std::chrono::floor<std::chrono::seconds>(std::chrono::system_clock::now());
d.modifiedTime = d.createdTime;
d.indexedTime = d.createdTime;
auto did = corpus.repo->insertDocument(d);
REQUIRE(did.has_value());
corpus.docIds.push_back(did.value());
REQUIRE(corpus.repo->indexDocumentContent(did.value(), hash, content, "text/plain")
.has_value());
DocumentContent dc;
dc.documentId = did.value();
dc.contentText = content;
dc.contentLength = static_cast<int64_t>(content.size());
dc.extractionMethod = "test";
dc.language = "en";
REQUIRE(corpus.repo->insertContent(dc).has_value());
}
return corpus;
}
bool waitReady(const SimeonLexicalBackend& backend, std::chrono::milliseconds timeout) {
const auto deadline = std::chrono::steady_clock::now() + timeout;
while (std::chrono::steady_clock::now() < deadline) {
if (backend.ready()) {
return true;
}
std::this_thread::sleep_for(std::chrono::milliseconds(25));
}
return backend.ready();
}
bool waitNotBuilding(const SimeonLexicalBackend& backend, std::chrono::milliseconds timeout) {
const auto deadline = std::chrono::steady_clock::now() + timeout;
while (std::chrono::steady_clock::now() < deadline) {
if (!backend.building()) {
return true;
}
std::this_thread::sleep_for(std::chrono::milliseconds(25));
}
return !backend.building();
}
} // namespace
TEST_CASE("SimeonLexicalBackend default config uses SabSmooth", "[search][simeon][catch2]") {
SimeonLexicalBackend::Config cfg;
CHECK(cfg.variant == SimeonLexicalBackend::Variant::SabSmooth);
CHECK(cfg.subword_gamma == 5.0f);
CHECK(cfg.max_corpus_docs == 200'000u);
CHECK(cfg.max_corpus_bytes == 256ULL * 1024ULL * 1024ULL);
CHECK(cfg.build_doc_chunk_bytes == 16ULL * 1024ULL);
CHECK(cfg.build_doc_max_chunks == 4u);
CHECK(cfg.fragment_geometry_enabled);
CHECK(cfg.fragment_geometry_min_corpus_docs == 1000u);
CHECK(cfg.fragment_geometry_max_docs == 20'000u);
CHECK(cfg.fragment_geometry_max_corpus_bytes == 64ULL * 1024ULL * 1024ULL);
CHECK(cfg.fragment_geometry_pmi_sample_docs == 8192u);
CHECK(cfg.fragment_geometry_pmi_sample_bytes == 32ULL * 1024ULL * 1024ULL);
CHECK(cfg.fragment_geometry_config.use_phss);
CHECK(cfg.fragment_geometry_config.phss_config.criterion ==
simeon::PhssConfig::Criterion::LargestGapApprox);
}
TEST_CASE("SimeonLexicalBackend buildAsync flips ready on small corpus",
"[search][simeon][catch2]") {
auto corpus = makeCorpus({
{"hash_a", "alpha beta gamma delta"},
{"hash_b", "beta gamma epsilon"},
{"hash_c", "omega sigma tau"},
});
SimeonLexicalBackend backend(SimeonLexicalBackend::Config{});
CHECK_FALSE(backend.ready());
auto build = backend.buildAsync(corpus.repo);
REQUIRE(build.has_value());
REQUIRE(waitReady(backend, std::chrono::seconds(5)));
CHECK(backend.doc_count() == 3u);
}
TEST_CASE("SimeonLexicalBackend skips build when corpus text budget is exceeded",
"[search][simeon][catch2]") {
auto corpus = makeCorpus({
{"hash_a", "alpha beta gamma delta"},
{"hash_b", "beta gamma epsilon zeta"},
{"hash_c", "omega sigma tau upsilon"},
});
SimeonLexicalBackend::Config cfg;
cfg.max_corpus_bytes = 16;
SimeonLexicalBackend backend(cfg);
REQUIRE(backend.buildAsync(corpus.repo).has_value());
REQUIRE(waitNotBuilding(backend, std::chrono::seconds(5)));
CHECK_FALSE(backend.ready());
CHECK(backend.doc_count() == 0u);
}
TEST_CASE("SimeonLexicalBackend chunks oversized docs before applying corpus byte budget",
"[search][simeon][catch2]") {
std::string large(4096, 'x');
auto corpus = makeCorpus({{{"hash_big", large}}});
SimeonLexicalBackend::Config cfg;
cfg.max_corpus_bytes = 512;
cfg.build_doc_chunk_bytes = 128;
cfg.build_doc_max_chunks = 2;
cfg.fragment_geometry_enabled = false;
SimeonLexicalBackend backend(cfg);
REQUIRE(backend.buildAsync(corpus.repo).has_value());
REQUIRE(waitReady(backend, std::chrono::seconds(5)));
CHECK(backend.doc_count() == 1u);
}
TEST_CASE("SimeonLexicalBackend score returns one float per candidate",
"[search][simeon][catch2]") {
auto corpus = makeCorpus({
{"hash_a", "alpha beta gamma delta"},
{"hash_b", "beta gamma epsilon"},
{"hash_c", "omega sigma tau"},
});
SimeonLexicalBackend backend(SimeonLexicalBackend::Config{});
REQUIRE(backend.buildAsync(corpus.repo).has_value());
REQUIRE(waitReady(backend, std::chrono::seconds(5)));
auto scores = backend.score("beta", corpus.docIds);
REQUIRE(scores.has_value());
CHECK(scores.value().size() == corpus.docIds.size());
}
TEST_CASE("SimeonLexicalBackend scoring folds ASCII case consistently",
"[search][simeon][catch2]") {
auto corpus = makeCorpus({
{"hash_a", "Beta beta gamma"},
{"hash_b", "omega sigma tau"},
});
SimeonLexicalBackend backend(SimeonLexicalBackend::Config{});
REQUIRE(backend.buildAsync(corpus.repo).has_value());
REQUIRE(waitReady(backend, std::chrono::seconds(5)));
auto lower = backend.score("beta", corpus.docIds);
auto upper = backend.score("BETA", corpus.docIds);
REQUIRE(lower.has_value());
REQUIRE(upper.has_value());
REQUIRE(lower.value().size() == upper.value().size());
CHECK(lower.value()[0] > 0.0f);
CHECK(upper.value()[0] == Catch::Approx(lower.value()[0]));
}
TEST_CASE("Simeon BM25 variant RRF does not assign priors to zero-score docs",
"[search][simeon][catch2]") {
simeon::Bm25Config sabCfg;
sabCfg.variant = simeon::Bm25Variant::SubwordAwareBackoff;
simeon::Bm25Index sab(sabCfg);
simeon::Bm25Config atireCfg;
atireCfg.variant = simeon::Bm25Variant::Atire;
simeon::Bm25Index atire(atireCfg);
for (auto* idx : {&sab, &atire}) {
idx->add_doc("alpha beta");
idx->add_doc("gamma delta");
idx->finalize();
}
std::vector<float> scores(2, -1.0f);
const simeon::Bm25Index* variants[2] = {&sab, &atire};
simeon::score_bm25_variants_rrf(std::span<const simeon::Bm25Index* const>(variants, 2),
"absent", std::span<float>{scores}, 60.0f);
CHECK(scores[0] == 0.0f);
CHECK(scores[1] == 0.0f);
}
TEST_CASE("Simeon lead-field arm uses indexed auxiliary lead text", "[search][simeon][catch2]") {
auto makeLongDoc = [](bool needleInLead) {
std::string text;
if (needleInLead) {
text = "needle";
}
for (int i = 0; i < 80; ++i) {
if (!text.empty()) {
text.push_back(' ');
}
text += "filler";
}
if (!needleInLead) {
text += " needle";
}
return text;
};
auto corpus = makeCorpus({
{"hash_lead", makeLongDoc(true)},
{"hash_tail", makeLongDoc(false)},
});
SimeonLexicalBackend::Config cfg;
cfg.strategy_router_enabled = true;
cfg.fragment_geometry_enabled = false;
SimeonLexicalBackend backend(cfg);
REQUIRE(backend.buildAsync(corpus.repo).has_value());
REQUIRE(waitReady(backend, std::chrono::seconds(5)));
auto base = backend.scoreBanditRouted("needle", "sab_smooth", corpus.docIds);
auto lead = backend.scoreBanditRouted("needle", "lead_field", corpus.docIds);
REQUIRE(base.has_value());
REQUIRE(lead.has_value());
REQUIRE(base.value().scores.size() == 2U);
REQUIRE(lead.value().scores.size() == 2U);
const float baseGap = base.value().scores[0] - base.value().scores[1];
const float leadGap = lead.value().scores[0] - lead.value().scores[1];
CHECK(leadGap > baseGap);
}
TEST_CASE("SimeonLexicalBackend skips fragment geometry below the default corpus threshold",
"[search][simeon][catch2]") {
std::vector<std::pair<std::string, std::string>> docs;
docs.reserve(80);
for (int i = 0; i < 80; ++i) {
std::string content;
for (int j = 0; j < 20; ++j) {
if (j > 0) {
content.push_back(' ');
}
content += "token" + std::to_string((i + j) % 80);
}
docs.emplace_back("hash_" + std::to_string(i), std::move(content));
}
auto corpus = makeCorpus(docs);
SimeonLexicalBackend backend(SimeonLexicalBackend::Config{});
REQUIRE(backend.buildAsync(corpus.repo).has_value());
REQUIRE(waitReady(backend, std::chrono::seconds(10)));
CHECK_FALSE(backend.fragmentGeometryReady());
}
TEST_CASE("SimeonLexicalBackend score returns 0 for unknown doc_ids", "[search][simeon][catch2]") {
auto corpus = makeCorpus({
{"hash_a", "alpha beta gamma"},
{"hash_b", "beta gamma epsilon"},
});
SimeonLexicalBackend backend(SimeonLexicalBackend::Config{});
REQUIRE(backend.buildAsync(corpus.repo).has_value());
REQUIRE(waitReady(backend, std::chrono::seconds(5)));
const std::int64_t missingId = 999'999;
std::vector<std::int64_t> ids = {corpus.docIds.front(), missingId};
auto scores = backend.score("beta", ids);
REQUIRE(scores.has_value());
REQUIRE(scores.value().size() == ids.size());
CHECK(scores.value()[1] == 0.0f);
}
TEST_CASE("SimeonLexicalBackend score before ready returns NotInitialized",
"[search][simeon][catch2]") {
SimeonLexicalBackend backend(SimeonLexicalBackend::Config{});
REQUIRE_FALSE(backend.ready());
std::vector<std::int64_t> ids = {1};
auto scores = backend.score("anything", ids);
REQUIRE_FALSE(scores.has_value());
CHECK(scores.error().code == ErrorCode::NotInitialized);
}
TEST_CASE("SimeonLexicalBackend Atire variant also builds", "[search][simeon][catch2]") {
auto corpus = makeCorpus({
{"hash_a", "alpha beta gamma"},
{"hash_b", "beta gamma epsilon"},
});
SimeonLexicalBackend::Config cfg;
cfg.variant = SimeonLexicalBackend::Variant::Atire;
SimeonLexicalBackend backend(cfg);
REQUIRE(backend.buildAsync(corpus.repo).has_value());
REQUIRE(waitReady(backend, std::chrono::seconds(5)));
auto scores = backend.score("beta", corpus.docIds);
REQUIRE(scores.has_value());
CHECK(scores.value().size() == corpus.docIds.size());
}
TEST_CASE("SimeonLexicalBackend scoreRouted passthrough when router disabled",
"[search][simeon][catch2]") {
auto corpus = makeCorpus({
{"hash_a", "alpha beta gamma delta"},
{"hash_b", "beta gamma epsilon"},
{"hash_c", "omega sigma tau"},
});
SimeonLexicalBackend::Config cfg; // router_enabled=false by default
SimeonLexicalBackend backend(cfg);
REQUIRE(backend.buildAsync(corpus.repo).has_value());
REQUIRE(waitReady(backend, std::chrono::seconds(5)));
auto decision = backend.scoreRouted("beta", corpus.docIds);
REQUIRE(decision.has_value());
CHECK(decision.value().scores.size() == corpus.docIds.size());
// router=off → recipe label falls back to the configured variant.
CHECK(std::string(decision.value().recipe_name) == "SabSmooth");
}
TEST_CASE("SimeonLexicalBackend scoreRouted picks a recipe with router on",
"[search][simeon][catch2]") {
auto corpus = makeCorpus({
{"hash_a", "alpha beta gamma delta"},
{"hash_b", "beta gamma epsilon zeta"},
{"hash_c", "omega sigma tau upsilon"},
{"hash_d", "beta gamma theta iota"},
});
SimeonLexicalBackend::Config cfg;
cfg.router_enabled = true; // passE preset defaults
SimeonLexicalBackend backend(cfg);
REQUIRE(backend.buildAsync(corpus.repo).has_value());
REQUIRE(waitReady(backend, std::chrono::seconds(5)));
auto decision = backend.scoreRouted("beta gamma", corpus.docIds);
REQUIRE(decision.has_value());
CHECK(decision.value().scores.size() == corpus.docIds.size());
const std::string name = decision.value().recipe_name;
CHECK((name == "Bm25Atire" || name == "Bm25SabSmooth" || name == "CascadeLinearAlpha"));
}
TEST_CASE("SimeonLexicalBackend scoreRouted routes OOV query to SabSmooth",
"[search][simeon][catch2]") {
auto corpus = makeCorpus({
{"hash_a", "alpha beta gamma delta"},
{"hash_b", "beta gamma epsilon zeta"},
{"hash_c", "omega sigma tau upsilon"},
});
SimeonLexicalBackend::Config cfg;
cfg.router_enabled = true; // passE: oov_threshold=0 → any OOV → SAB
SimeonLexicalBackend backend(cfg);
REQUIRE(backend.buildAsync(corpus.repo).has_value());
REQUIRE(waitReady(backend, std::chrono::seconds(5)));
// "xyzneverpresent" does not appear in any document → oov_rate = 1.0 > 0.
auto decision = backend.scoreRouted("xyzneverpresent", corpus.docIds);
REQUIRE(decision.has_value());
CHECK(std::string(decision.value().recipe_name) == "Bm25SabSmooth");
}