Necessist

Run tests with statements and method calls removed to help identify broken tests

Necessist currently supports Anchor (TS), Foundry, Go, Hardhat (TS), and Rust.

A paper on Necessist (Test Harness Mutilation) appeared in Mutation 2024. (slides, preprint)

Contents

• Installation
• Overview
• Usage
• Details
• Configuration files
• Limitations
• Semantic versioning policy
• Goals
• Anti-goals
• References
• License

Installation

System requirements:

Install pkg-config and sqlite3 development files on your system, e.g., on Ubuntu:

sudo apt install pkg-config libsqlite3-dev

Install Necessist from crates.io:

cargo install necessist

Install Necessist from github.com:

cargo install --git https://github.com/trailofbits/necessist --branch release

Overview

Necessist iteratively removes statements and method calls from tests and then runs them. If a test passes with a statement or method call removed, it could indicate a problem in the test. Or worse, it could indicate a problem in the code being tested.

Example

This example is from rust-openssl. The verify_untrusted_callback_override_ok test checks that a failed certificate validation can be overridden by a callback. But if the callback were never called (e.g., because of a failed connection), the test would still pass. Necessist reveals this fact by showing that the test passes without the call to set_verify_callback:

#[test]
fn verify_untrusted_callback_override_ok() {
    let server = Server::builder().build();

    let mut client = server.client();
    client
        .ctx()
        .set_verify_callback(SslVerifyMode::PEER, |_, x509| { //
            assert!(x509.current_cert().is_some());           // Test passes without this call
            true                                              // to `set_verify_callback`.
        });                                                   //

    client.connect();
}

Following this discovery, a flag was added to the test to record whether the callback is called. The flag must be set for the test to succeed:

#[test]
fn verify_untrusted_callback_override_ok() {
    static CALLED_BACK: AtomicBool = AtomicBool::new(false);  // Added

    let server = Server::builder().build();

    let mut client = server.client();
    client
        .ctx()
        .set_verify_callback(SslVerifyMode::PEER, |_, x509| {
            CALLED_BACK.store(true, Ordering::SeqCst);        // Added
            assert!(x509.current_cert().is_some());
            true
        });

    client.connect();
    assert!(CALLED_BACK.load(Ordering::SeqCst));              // Added
}

Comparison to conventional mutation testing

Possible theoretical foundation

{ Q[(x - 1)/x] ^ x >= 1 }
x -= 1;
{ Q }

Usage

Usage: necessist [OPTIONS] [TEST_FILES]... [-- <ARGS>...]

Arguments:
  [TEST_FILES]...  Test files to mutilate (optional)
  [ARGS]...        Additional arguments to pass to each test command

Options:
      --allow <WARNING>        Silence <WARNING>; `--allow all` silences all warnings
      --default-config         Create a default necessist.toml file in the project's root directory
      --deny <WARNING>         Treat <WARNING> as an error; `--deny all` treats all warnings as errors
      --dump                   Dump sqlite database contents to the console
      --dump-candidates        Dump removal candidates and exit (for debugging)
      --framework <FRAMEWORK>  Assume testing framework is <FRAMEWORK> [possible values: anchor, auto, foundry, go, hardhat, rust]
      --no-dry-run             Do not perform dry runs
      --no-sqlite              Do not output to an sqlite database
      --quiet                  Do not output to the console
      --reset                  Discard sqlite database contents
      --resume                 Resume from the sqlite database
      --root <ROOT>            Root directory of the project under test
      --timeout <TIMEOUT>      Maximum number of seconds to run any test; 60 is the default, 0 means no timeout
      --verbose                Show test outcomes besides `passed`
  -h, --help                   Print help
  -V, --version                Print version

Output

By default, Necessist outputs to the console only when tests pass. Passing --verbose causes Necessist to instead output all of the removal outcomes below.

By default, Necessist outputs to both the console and to an sqlite database. For the latter, a tool like sqlitebrowser can be used to filter/sort the results.

Details

Generally speaking, Necessist will not attempt to remove a statement if it is one the following:

• a statement containing other statements (e.g., a for loop)
• a declaration (e.g., a local or let binding)
• a break, continue, or return
• the last statement in a test

Similarly, Necessist will not attempt to remove a method call if:

• It is the primary effect of an enclosing statement (e.g., x.foo();).
• It appears in the argument list of an ignored function, method, or macro (see below).

Also, for some frameworks, certain statements and methods are ignored. Click on a framework to see its specifics.

Configuration files

A configuration file allows one to tailor Necessist's behavior with respect to a project. The file must be named necessist.toml, appear in the project's root directory, and be toml encoded. The file may contain one more of the options listed below.

• ignored_functions, ignored_methods, ignored_macros: A list of strings interpreted as patterns. A function, method, or macro (respectively) whose path matches a pattern in the list is ignored. Note that ignored_macros is used only by the Rust framework currently.

• ignored_path_disambiguation: One of the strings Either, Function, or Method. For a path that could refer to a function or method (see below), this option influences whether the function or method is ignored.

  • Either (default): Ignore if the path matches either an ignored_functions or ignored_methods pattern.

  • Function: Ignore only if the path matches an ignored_functions pattern.

  • Method: Ignore only if the path matches an ignored_methods pattern.

• ignored_tests: A list of strings. A test whose name exactly matches a string in the list is ignored. For Mocha-based frameworks (e.g., Anchor and Hardhat), a test name is consider to be a message passed to it.

• walkable_functions: A list of strings interpreted as patterns. If a test calls a function that matches the pattern, and the function is declared in the same file as the test, then statements and method calls are removed from the function as though it were a test.

Patterns

A pattern is a string composed of letters, numbers, ., _, or *. Each character, other than *, is treated literally and matches itself only. A * matches any string, including the empty string.

The following are examples of patterns:

• assert: matches itself only
• assert_eq: matches itself only
• assertEqual: matches itself only
• assert.Equal: matches itself only
• assert.*: matches assert.Equal, but not assert, assert_eq, or assertEqual
• assert*: matches assert, assert_eq, assertEqual, and assert.Equal
• *.Equal: matches assert.Equal, but not Equal

Notes:

• Patterns match paths, not individual identifiers.
• . is treated literally like in a glob pattern, not like in regular expression.

Paths

A path is a sequence of identifiers separated by .. Consider this example (from Chainlink):

operator.connect(roles.oracleNode).signer.sendTransaction({
    to: operator.address,
    data,
}),

In the above, operator.connect and signer.sendTransaction are paths.

Note, however, that paths like operator.connect are ambiguous:

• If operator refers to package or module, then operator.connect refers to a function.
• If operator refers to an object, then operator.connect refers to a method.

By default, Necessist ignores such a path if it matches either an ignored_functions or ignored_methods pattern. Setting the ignored_path_disambiguation option above to Function or Method causes Necessist ignore the path only if it matches an ignored_functions or ignored_methods pattern (respectively).

Limitations

• Slow. Modifying tests requires them to be rebuilt. Running Necessist on even moderately sized codebases can take several hours.

• Triage requires intimate knowledge of the source code. Generally speaking, Necessist does not produce "obvious" bugs. In our experience, deciding whether a statement/method call should be necessary requires intimate knowledge of the code under test. Necessist is best run on codebases for which one has (or intends to have) such knowledge.

Semantic versioning policy

We reserve the right to change the following, and to consider such changes non-breaking:

• the syntax that Necessist ignores by default

Changes to the following will be accompanied by a bump of at least Necessist's minor version:

• the order in which removal candidates are output
• the order in which records are stored in necessist.db

Goals

• If a project uses a supported framework, then cding into the project's directory and typing necessist (with no arguments) should produce meaningful output.

Anti-goals

• Become a general-purpose mutation testing tool. Good such tools already exist (e.g., universalmutator).

References

• Groce, A., Ahmed, I., Jensen, C., McKenney, P.E., Holmes, J.: How verified (or tested) is my code? Falsification-driven verification and testing. Autom. Softw. Eng. 25, 917–960 (2018). A preprint is available. See Section 2.3.

License

Necessist is licensed and distributed under the AGPLv3 license. Contact us if you're looking for an exception to the terms.