Crate marker_uitest 

Marker UI-test

The easiest way to test lints, is simply to run them on examples and look at the generated output. We are programmers, which means that we have tools to automate this process. marker_uitest is a thin wrapper around the ui_test crate for Marker. It performs all the common setup magic required to run ui-tests.

Prerequisites

marker_uitest requires Cargo, rustup and cargo_marker to be installed.

Usage

The ui_test crate runs Marker on every .rs-file in the tests/ui folder and compares the output with the .stderr and .stdout files next to them. To automatically update the .stderr and .stdout files, you can either run cargo test -- -- --bless or set the RUST_BLESS environment variable.

For a full list of supported features and magic comments, please refer to the documentation of the ui_test crate.

Setup

Manifest

First add marker_utils to the dev-dependencies of the lint crate, and specify that the ui-test doesn’t require a test harness, like this:

[dev-dependencies]
marker_uitest = "0.5.0"

[[test]]
name = "uitest"
harness = false

Setup test file

Create a uitest.rs file in the tests directory. Then you can use the following template to get started:

use marker_uitest::ui_test::*;
use std::{env, path::Path};

fn main() -> color_eyre::Result<()> {
    let mut config = marker_uitest::simple_ui_test_config!()?;

    // Allows you to automatically update `.stderr` and `.stdout` files
    let bless = env::var_os("RUST_BLESS").is_some() || env::args().any(|arg| arg == "--bless");
    if bless {
        config.output_conflict_handling = OutputConflictHandling::Bless
    }

    // Maybe define replacement filters
    config.stderr_filter(r"\\", "/");
    config.stdout_filter(r"\\", "/");

    // Run the test
    run_tests_generic(
        config,
        default_file_filter,
        default_per_file_config,
        status_emitter::Text,
    )
}

Contributing

Contributions are highly appreciated! If you encounter any issues or have suggestions for improvements, please check out Marker’s GitHub repository.

License

Copyright (c) 2022-2023 Rust-Marker

Rust-marker is distributed under the terms of the MIT license or the Apache License (Version 2.0).

See LICENSE-APACHE, LICENSE-MIT.

Re-exports

pub use ui_test;

Macros

simple_ui_test_config

This macro automatically fills the parameters of create_ui_test_config with environment values and default values.

Functions

create_ui_test_config

This function creates a ui_test::Config instance configured to run Marker as a driver, with the given crate as a lint crate.