Struct cargo_culture_kit::UsesPropertyBasedTestLibrary

pub struct UsesPropertyBasedTestLibrary;

Rule that asserts a good Rust project: "Should be making an effort to use property based tests."

Justification

Property based testing is an advanced testing technique that combines pseudo-random test input generation with checking desired behavioral characteristics.

Property based testing libraries provide tools to generate many input values for a test, kind of like a type-safe and typically shorter-running fuzz test.

Since property based tests encourage reasoning about how input data affects the state-space of the program and can help rapidly achieve more comprehensive correctness assurances, this Rule recommends it here as important for quality-attentive projects.

See Also

• proptest
• quickcheck
• suppositions

Caveats

This Rule presently only checks whether or not a known property-based test library is present in the project dependencies (or dev-dependencies). Actually writing good tests is an exercise left to the reader.

Trait Implementations

impl Debug for UsesPropertyBasedTestLibrary

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for UsesPropertyBasedTestLibrary

fn default() -> UsesPropertyBasedTestLibrary

Returns the "default value" for a type.

impl Rule for UsesPropertyBasedTestLibrary

fn description(&self) -> &'static str

The central tenet of this Rule. Serves as a unique identifier for Rule instances, as well as a human-readable summary of what this Rule means for a given project.

fn evaluate(&self, context: RuleContext) -> RuleOutcome

Does the Rust project found at cargo_manifest_path uphold this Rule, as summarized in the description?