filmopen_test_support

A snapshot

This specification is a copy of docs/software/packages/filmopen_test_support.md in the application’s repository, taken at commit 0b4fe88 of 11 November 2026. It is imported byte for byte and is not edited here; a change is made there, and arrives with the next snapshot.

Generated by scripts/package_digest.py; regenerate, never edit.

The fixtures every package’s tests share: loadFixture and fixtureSource build a tiny in-memory project from a list of stems and the fields that matter, readOnlySource wraps one as a project nobody may write, sampleAssetsRoot finds the repository’s assets/sample folder from wherever the runner started, and foldersFixtureFiles is a script on folders with everything a reader has to report: mixed children four deep, a pinned entry, a second listing, a cycle, a bare tag, an entry of another type, one that names nothing, another author’s folder, a folder’s cue, and a folder and a scene that no list names. decodeWithoutBlockTimes reads a project document without the updated the writer stamps on each block of its script, for a test that compares a script’s blocks whole. Beside them, CountingSource wraps a source and counts what an act asks of it — the reads, writes, deletes and listings — with the chain of filmopen_* packages each call came through.

pure Dart. 4 files, 359 lines under lib/; 0 tests in 0 files. Barrel: lib/filmopen_test_support.dart.

Depends on

• filmopen_format — uses BatchStem, CommentaryStem, FileNameParser, FilmProject, MediaLocation, MemoryProjectSource, OfficialStem, ProjectSource, VersionStem, documentPath, projectManifestFileName
• filmopen_store — uses ProjectLoader

Used by

filmopen_app, filmopen_browser, filmopen_cloud, filmopen_dictation, filmopen_engine_mlt, filmopen_engine_mpv, filmopen_exchange, filmopen_forms, filmopen_insertion, filmopen_insertion_ui, filmopen_jobs_ui, filmopen_media, filmopen_plugin_host, filmopen_prompt_ui, filmopen_recorder, filmopen_render_ui, filmopen_sharing, filmopen_state, filmopen_store, filmopen_support, filmopen_sync, filmopen_timeline, filmopen_timeline_ui

Public API

What the barrel exports, file by file. A name is class, enum, mixin, extension, typedef, a top-level function, getter, setter or variable; under a class, its public constructors, fields, getters, setters and methods.

lib/src/counting_source.dart

• class CountingSource — A project source that counts what is asked of it, and through which packages, so a test can measure an act.
  • CountingSource(this.inner) — Wraps [inner], counting nothing yet.
  • final ProjectSource inner — The source every call is forwarded to; a test inspects the film through it without being counted.
  • final List<String> reads — The files asked to be read, in order, one entry per read: a file read twice is there twice.
  • final List<String> writes — The files asked to be written, in order, a refused write included.
  • final List<String> deletes — The files asked to be deleted, in order.
  • int lists — How many times the folder was listed.
  • final Map<String, Map<String, int>> chains — Per kind of call (read, write, delete, list), how many calls came along each chain of packages.
  • void reset() — Forgets everything counted, so a test can set the film up and then count only the act.
  • String report() — The counts and, per kind, every chain with its number of source calls, largest first.

lib/src/fixtures.dart

• function Future<FilmProject> loadFixture(Map<String, Map<String, Object?>> files, { Map<String, String> raw = const {}, ProjectSource? library, }) — Tiny in-memory projects for tests that must not depend on the sample.
• function MemoryProjectSource fixtureSource(Map<String, Map<String, Object?>> files, { Map<String, String> raw = const {}, String label = 'Fixture', }) — The source alone, for a project or shared-library fixture.
• function Map<String, Map<String, Object?>> foldersFixtureFiles() — A script on folders with everything a reader has to report (Project Specification §8.5, §10.1), as [loadFixture] takes it.
• function ProjectSource readOnlySource(MemoryProjectSource inner) — [inner] as a project nobody may write.
• function Map<String, dynamic> decodeWithoutBlockTimes(String text) — The project document [text] holds, each block of its script without the updated the writer stamps (§10.3), for a test that compares a script’s blocks whole.

lib/src/sample_on_disk.dart

• function String sampleAssetsRoot() — The repository’s assets/sample folder, found from wherever the test runner started.