Crate cli_sandbox

cli-sandbox

cli-sandbox is a sandboxing environment and testing utility to help you test and debug your CLI applications, inspired by Cargo’s cargo-test-support.

All tests get their own temporary directories, where you can create files, check files, test your program against those files and check the output of your program in various ways.

For example, if you want to check that your Python to Rust transpiler works correctly:

use cli_sandbox::{project, WithStdout};
use std::error::Error;

#[test]
fn compiling() -> Result<(), Box<dyn Error>> {
    cli_sandbox::init(); // Initialize the sandbox
    let proj = project()?;                      // Create a project

    // Let's create a file, and put in there some Python.
    proj.new_file("my-program.py",
r#"def main():
    print("Hi! this is a test")

main()"#)?;

    let cmd = proj.command(["build"])?;         // Execute the command "<YOUR COMMAND> build". Cli-sandbox will automatically get pickup your command.

    // Now, let's check that the transpiler created the file correctly.
    proj.check_file("my-program.rs",
r#"fn main() {
    println!("Hi! this is a test");
}

main()"#)?;

    // And that the command stdout and stderr are correct.

    cmd.with_stdout("File transpiled correctly! (`my-program.py` -> `my-program.rs`)");

    // If the stderr isn't empty, we'll panic.
    if !cmd.empty_stderr() {
        panic!("Something went wrong! stderr isn't empty");
    };
}

You can also get the path of a project (it changes each time the tests are executed, they’re temporary).

Installation

cargo add cli-sandbox --dev

Usage

The first step is to create a Project. You can use either Project::new() or project(). This will create a temporary directory for you to put all your testing files in there.

From a project, you can execute commands, do I/O operations or even operate over it manually by getting the project’s path (Project::path()).

Check the project’s documentation for more info.

Features

• Regex support for checking stdout and stderr. (feature: regex)
• All output is beautiful thanks to pretty-assertions and better_panic. (feature: pretty, also can be enabled individually)
• Little fuzzing functionality (feature: fuzz)
• Testing either the debug or release profile (features: dev or release)

Re-exports

pub use better_panic;

Modules

panic

Structs

Project

Constants

MANIFEST_DIR

Traits

WithStdout

Functions

fuzz

Generates a random string of text, meant to be used a mini-fuzz test. (As input to your CLI.)

init

Initializes a new sandbox testing environment. Note that this doesn’t initialize a project, just creates some environment variables with metadata about your project.

project

Shortcut for Project::new().