Files
Sylpheed/crates/sylpheed-formats/tests/caption_families_disc.rs
Fabian Hamm 15d51b30ac test(formats): make $SYLPHEED_DISC an actual control (#16 remedy 3)
Before this commit, `unset SYLPHEED_DISC` did not disable the disc-backed
suites on the machine that has the disc: every `disc_root()` fell back to a
hardcoded absolute path that exists on this box. The env var looked like a
control and was not one. Same for $SYLPHEED_RES3D and $SYLPHEED_ISO.

Replace the duplicated resolvers with one `tests/common/mod.rs`:

  - 17 local `disc_root()` definitions -> 1
  - 7 copies of the skip macro -> 1 (`skip_without_disc!` and siblings)
  - 16 hardcoded absolute paths -> 0 executable ones
    (3 of those were inline in `mesh_disc.rs`, in no resolver at all,
     and 2 were in `examples/`)
  - `corpus_report.rs` now reports on the SAME resolver the suites use,
    instead of a second copy of the logic its own comments flagged as a
    drift risk.

The 17 copies had already drifted into FIVE variants, and they were not all
the same function. `movie_manifest_disc`, `movie_subtitle_disc` and `slb_disc`
honoured $SYLPHEED_DISC and nothing else, while the other 14 fell back. So one
name already meant two things -- a third instance of the shape #16 is about.
The shared helper adopts the env-only behaviour those three already had, rather
than inventing a sixth variant.

Two module docs still described the fallback after it was deleted, which is the
same defect in prose: `texture_disc` claimed "or the default dev path exists"
and `pak_idxd_disc` said "or drop it at the default dev path below". Both now
say what the code does.

Verified both ways on the machine that HAS the corpus, which is the only place
this refactor can be falsified:

  A  env unset  -> "ABSENT -- $SYLPHEED_DISC unset; its suites self-skip"
                   suites=31 passed=209 failed=0 ignored=14, slowest 0.12s
  B  env set    -> "PRESENT via $SYLPHEED_DISC" (all three corpora)
                   suites=31 passed=209 failed=0 ignored=14,
                   slowest 1235.53s (mesh_consistency_disc)

Identical tallies, opposite corpus states, ~10000x apart in wall clock. (A) is
new behaviour -- it was previously unreachable here. (B) proves nothing broke.

`just test-disc` sources `.env` (already gitignored) for the set case. Note the
quoting trap documented there: the corpus paths contain spaces, and an unquoted
`VAR=a b c` parses as "run command `b`", failing silently into ABSENT -- which
looks exactly like a working skip.

Remedy (1) (`#[ignore]` + `--ignored`) is deliberately NOT done here: (3) already
moves the mode from the filesystem into the environment, and `#[ignore]` already
carries three meanings in this directory (corpus-absent, known-failing, bare).
Overloading it a fourth time would re-create the defect.

`cargo fmt --all --check` clean; no new compiler warnings.

Refs #16

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-09-10 20:47:23 +02:00

73 lines
2.7 KiB
Rust

//! Caption recovery across all eight `MSG_*` families.
//!
//! `build_demo_text` reads only `MSG_DEMO_*`, the smallest family.
//! `build_caption_text` generalises the key parser to all eight.
use std::collections::BTreeMap;
use sylpheed_formats::{movie_subtitle, PakArchive};
mod common;
use common::skip_without_disc;
#[test]
fn all_eight_caption_families_are_read() {
skip_without_disc!(root);
let pak = PakArchive::open(root.join("dat/GP_MAIN_GAME_E.pak")).expect("pak");
let all = movie_subtitle::build_caption_text(&pak);
let mut per: BTreeMap<String, usize> = BTreeMap::new();
for (id, lines) in &all {
*per.entry(id.split('_').next().unwrap().to_string())
.or_default() += lines.len();
}
let fams: Vec<&str> = per.keys().map(String::as_str).collect();
assert_eq!(
fams,
["ACRO", "ADAN", "ADPL", "BIRD", "DEMO", "RHIN", "TCAF", "VOICE"],
"all eight families must appear"
);
let total: usize = all.values().map(|v| v.len()).sum();
// 8800 is ALL of them: every distinct text-bearing MSG_* key on the disc has
// the <id>_<page>_<line> shape, and the field reader recovers 8800 of 8800.
assert_eq!(total, 8800, "recovered caption lines");
assert_eq!(all.len(), 4085, "recovered caption ids");
// `VOICE` is the only family with a letter before the id; its ids must keep it.
assert!(
all.contains_key("VOICE_A_150"),
"VOICE ids keep their family letter"
);
}
/// The control: generalising must not lose anything the DEMO-only reader had.
/// It does not — it gains, because token adjacency was dropping lines there too.
#[test]
fn demo_family_is_not_lost_by_generalising() {
skip_without_disc!(root);
let pak = PakArchive::open(root.join("dat/GP_MAIN_GAME_E.pak")).expect("pak");
let demo = movie_subtitle::build_demo_text(&pak);
let all = movie_subtitle::build_caption_text(&pak);
let old: usize = demo.values().map(|v| v.len()).sum();
let new: usize = all
.iter()
.filter(|(k, _)| k.starts_with("DEMO_"))
.map(|(_, v)| v.len())
.sum();
// The token-adjacency reader misses 4 DEMO lines that the field reader gets,
// so the record route is strictly better even on the family it was written
// for. It must never be WORSE.
assert_eq!(old, 537, "build_demo_text, token adjacency");
assert_eq!(new, 541, "build_caption_text, record fields");
assert!(new >= old, "the record route must not lose lines");
// …and 16x more text overall than the DEMO-only path saw.
let total: usize = all.values().map(|v| v.len()).sum();
assert!(
total > old * 16,
"expected a large gain, got {total} vs {old}"
);
}