Git Product home page Git Product logo

datatest-stable's Introduction

datatest-stable

datatest-stable on crates.io Documentation (latest release) Documentation (main) License License

datatest-stable is a very simple test harness intended to write data-driven tests, where individual test cases are specified as files and not as code. Given:

  • a test my_test that accepts a path as input
  • a directory to look for files in
  • a pattern to match files on

datatest-stable will call the my_test function once per matching file in the directory.

datatest-stable works with cargo nextest, and is part of the nextest-rs organization on GitHub.

Usage

  1. Configure the test target by setting harness = false in Cargo.toml:
[[test]]
name = "<test target name>"
harness = false
  1. Call the datatest_stable::harness!(testfn, root, pattern) macro with the following parameters:
  • testfn - The test function to be executed on each matching input. This function can be one of:
    • fn(&Path) -> datatest_stable::Result<()>
    • fn(&Utf8Path) -> datatest_stable::Result<()> (Utf8Path is part of the camino library, and is re-exported here for convenience.)
  • root - The path to the root directory where the input files (fixtures) live. This path is relative to the root of the crate.
  • pattern - the regex used to match against and select each file to be tested.

The three parameters can be repeated if you have multiple sets of data-driven tests to be run: datatest_stable::harness!(testfn1, root1, pattern1, testfn2, root2, pattern2)

Examples

This is an example test. Use it with harness = false.

use datatest_stable::Utf8Path;
use std::path::Path;

fn my_test(path: &Path) -> datatest_stable::Result<()> {
    // ... write test here

    Ok(())
}

fn my_test_utf8(path: &Utf8Path) -> datatest_stable::Result<()> {
    // ... write test here

    Ok(())
}

datatest_stable::harness!(
    my_test, "path/to/fixtures", r"^.*/*",
    my_test_utf8, "path/to/fixtures", r"^.*/*,
);

Minimum supported Rust version (MSRV)

The minimum supported Rust version is Rust 1.60. MSRV bumps may be accompanied by a minor version update; at any time, at least the last 3 stable versions of Rust will be supported.

See also

License

This project is available under the terms of either the Apache 2.0 license or the MIT license.

datatest-stable's People

Contributors

andyyu2004 avatar badicsalex avatar bmwill avatar bors-libra avatar dependabot-preview[bot] avatar dependabot[bot] avatar huitseeker avatar lukaskalbertodt avatar metajack avatar mimoo avatar rexhoffman avatar sunshowers avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.