proofsheet-core 0.1.1

Core driver for proofsheet: CDP browser control, deterministic capture, receipts.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

//! # proofsheet-core
//!
//! Local-first browser control for two jobs that turn out to be the same job:
//! producing store-ready screenshots at exact dimensions, and running
//! deterministic tests against a real browser.
//!
//! Both need the same three things — a driver, a way to make the page stop
//! being nondeterministic, and a record of what happened that can be checked
//! later. So they share one core.
//!
//! ## Design commitments
//!
//! - **The model never authors code or selectors.** Actions are typed; the
//!   runtime composes them. A free-text field in a tool schema is
//!   grammar-constrained to *any* text, so the field is removed rather than
//!   validated after the fact.
//! - **Output pixels are the source of truth.** Stores specify pixels; the
//!   viewport is derived. See [`device`].
//! - **Determinism is injected, not hoped for.** See [`determinism`].
//! - **Nothing is claimed without a negative control.** A check that cannot
//!   fail on correct input is not evidence.
//!
//! ## Dependencies
//!
//! Deliberately small. No async runtime, no browser automation framework: a
//! tool people install should not drag a dependency tree behind it.

#![deny(rust_2018_idioms)]
#![warn(missing_debug_implementations)]

pub mod capture;
pub mod cdp;
pub mod determinism;
pub mod device;
pub mod error;
pub mod png;
pub mod progress;
pub mod run;
mod ws;

pub use capture::{capture, Capture, CaptureRequest, Environment, Stability};
pub use cdp::{find_browser, Browser, LaunchOptions};
pub use determinism::Determinism;
pub use device::{builtin, by_id, for_store, Device, Platform, Requirement, Store};
pub use error::{Error, Result};
pub use progress::{Collector, DeviceEvent, Outcome, Progress, Silent, Summary, Tally};
pub use run::{run, DeviceResult, RunOptions, RunReport};

/// The crate version, surfaced so receipts can record which build produced
/// them.
pub const VERSION: &str = env!("CARGO_PKG_VERSION");

#[cfg(test)]
mod tests {
    #[test]
    fn version_is_populated() {
        assert!(!super::VERSION.is_empty());
    }
}