77 lines
4.7 KiB
Markdown
77 lines
4.7 KiB
Markdown
# Rust reporter trial
|
|
|
|
Branch: `feature/rust-reporter`. Scope: PPTX video reporter only; the document
|
|
exporter stays in Python. Python remains the regression reference during the trial.
|
|
|
|
- [x] Read local instructions, coverage task, and `rust_realease` contract.
|
|
- [x] Resolve canonical badge owner/project/default branch: `Beffroi/beffroi-tools/main`.
|
|
- [x] Port ZIP discovery, presentation ordering, media extraction and metadata.
|
|
- [x] Port per-shape trims, looping/unsupported timing and effective durations.
|
|
- [x] Preserve HTML, Markdown, TXT, JSON, Typst, PDF, dense PDF and Ontime.
|
|
- [x] Embed Typst and a report font; locate bundled/system FFprobe.
|
|
- [x] Provide CLI parity and progress events shared with the GUI.
|
|
- [x] Add drag/drop, file picker, options, background jobs, cancellation, ETA,
|
|
result actions and remembered settings to the desktop app.
|
|
- [x] Prepare Windows GNU and Linux Cross builds, portable packaging and
|
|
`rust_realease` metadata; keep release creation outside Jenkins.
|
|
- [x] Add default-branch version/test/coverage badges and safe publication.
|
|
- [x] Test parity, errors, report rendering, GUI state, badge rendering,
|
|
coverage gating and publication with temporary fixtures.
|
|
- [x] Run format, lint, docs, tests, measured coverage and available cross builds.
|
|
- [x] Record unavailable Windows/Jenkins/live-publication checks explicitly.
|
|
- [x] Commit the completed trial on the feature branch.
|
|
|
|
The badge renderer is copied from `Dandaedre/agent-tasks` revision
|
|
`8923682b958de698c5ec41f4275bfc6f7e44a2f6`. CI may publish the three mutable badges
|
|
on `main`; it must never create a release, tag, or upload release binaries.
|
|
|
|
|
|
## Verification and remaining deployment checks
|
|
|
|
- Python: 57 tests, including badge rendering, failed/below-floor coverage,
|
|
publication permissions/symlink migration, and portable archive contents.
|
|
- Rust: 14 tests with all features; 10 with default features disabled.
|
|
The GUI tests feed egui input without a display and cover drop validation,
|
|
progress, error/completion state, and bounded activity history.
|
|
- Formatting, Clippy with warnings denied, and rustdoc with warnings denied pass.
|
|
- Measured Rust line coverage: **83.84%**, above the **75%** gate, with no
|
|
production-code exclusions. Cleanup leaves exactly three valid SVG badges.
|
|
- Real-media parity: report JSON and Ontime JSON match Python exactly for the
|
|
synthetic trim/loop/custom-timing fixture. Every report format is generated.
|
|
- Full and dense PDF pages were rendered and visually inspected. The Linux
|
|
desktop app was launched and its window inspected.
|
|
- Windows GNU and Linux GNU release executables cross-compile successfully
|
|
with Cross 0.2.5 and its main images (Rust 1.99.1). PE inspection
|
|
confirms the GUI subsystem and only Windows system DLL imports.
|
|
- `rust_realease` 0.1.6-rc.2 accepts metadata, both binaries, targets, and the
|
|
canonical Gitea destination. A publishing dry-run reports the intentionally
|
|
absent `v0.1.0` tag; it creates nothing.
|
|
- `rust_realease . --package pptx-reporter --compile-only --skip-tests` also
|
|
succeeded: both fresh Cross builds and both `.tgz` archives were verified.
|
|
Tests had already passed separately. These local archives contain the two
|
|
Cargo binaries only; FFprobe is added by the separate portable packager.
|
|
- The cross-built Linux release binary passes the same real-media parity check.
|
|
|
|
External checkpoints still required before distributing a Windows release:
|
|
|
|
- [ ] Run on a real Windows machine: drag/drop, file dialogs, scaling, Unicode
|
|
paths, opening reports, and a standalone target FFprobe beside the app.
|
|
- [x] Add release-time downloading of BtbN's target FFprobe with archive checksum,
|
|
executable architecture checks, upstream license and provenance. Keep
|
|
downloads and portable bundles ignored by Git.
|
|
- [ ] Review dependency notices before distribution.
|
|
- [ ] Configure/execute the actual Jenkins Multibranch job and confirm that its
|
|
`rust_no_docker` worker has the documented dependencies and asset mount.
|
|
- [ ] Confirm actual Jenkins archival, default-branch publication and all three
|
|
public badge responses after an authorized push/main build. Local tests
|
|
validate generated SVGs and publication into temporary directories only.
|
|
|
|
No production asset mount was modified and no push or release was made.
|
|
The subsequent local `v0.1.0` tag marks the original trial commit `2591252`;
|
|
release-time FFprobe fetching is a later follow-up change.
|
|
|
|
FFprobe follow-up validation: both target downloads passed checksum and
|
|
architecture checks; the Linux binary successfully probed real MPEG4 media.
|
|
Both portable archives were built with `--fetch-ffprobe`. Windows executable
|
|
imports were inspected; actual Windows execution remains unchecked.
|