Skip to main content

Crate beamte

Crate beamte 

Source
Expand description

Test-quality rules over treebank trees. Trees in, findings out.

Beamte takes a parsed test file and returns findings about it. Every rule restates a post from the Google Testing Blog and carries its citation.

It parses nothing, reads no files, writes no output format and owns no configuration: those belong to the host running the scan. notes/DESIGN.md is the authoritative document.

Re-exports§

pub use finding::Citation;
pub use finding::EvidenceStep;
pub use finding::Finding;
pub use finding::Property;
pub use finding::Rule;
pub use finding::RuleId;
pub use manifest::RoleTable;
pub use model::LANGUAGES;
pub use model::TestModel;
pub use node::Node;
pub use node::Span;
pub use node::Unit;
pub use node::Visit;
pub use node::walk;
pub use role::Role;
pub use role::RoleSet;

Modules§

finding
What a rule returns.
manifest
Roles read out of a treebank grammar’s own manifests.
model
What marks a test, an assertion, a mock, a fixture.
node
The boundary. Beamte walks trees through this trait and owns no parser.
role
The treebank node vocabulary, as the terms beamte consumes.
rules
The rule catalogue. One module per rule, each naming the post it restates.

Enums§

Selection
Which rules to run.

Functions§

catalogue
Every rule beamte implements, with its property and citation.
inspect
Run every rule over one unit.
inspect_with
Run a chosen set of rules over one unit.
rule
The rule a name identifies, for a host validating its own configuration.