cairo-test 2.19.0

Test runner for the Cairo programming language
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

//! Compiles and runs Cairo tests.

use std::path::PathBuf;

use cairo_lang_compiler::project::check_compiler_path;
use cairo_lang_runner::clap::RunProfilerConfigArg;
use cairo_lang_test_runner::{TestRunConfig, TestRunner};
use clap::Parser;

#[cfg(feature = "mimalloc")]
#[global_allocator]
static GLOBAL: mimalloc::MiMalloc = mimalloc::MiMalloc;

/// Compiles a Cairo project and runs all the functions marked as `#[test]`.
/// Exits with 1 if the compilation or run fails, otherwise 0.
#[derive(Parser, Debug)]
#[command(version, verbatim_doc_comment)]
struct Args {
    /// The Cairo project path to compile and run its tests.
    path: PathBuf,
    /// Whether path is a single file.
    #[arg(short, long)]
    single_file: bool,
    /// Allows the compilation to succeed with warnings.
    #[arg(long)]
    allow_warnings: bool,
    /// The filter for the tests, running only tests containing the filter string.
    #[arg(short, long, default_value_t = String::default())]
    filter: String,
    /// Whether to run ignored tests as well.
    #[arg(long, default_value_t = false)]
    include_ignored: bool,
    /// Whether to run only the ignored tests.
    #[arg(long, default_value_t = false)]
    ignored: bool,
    /// Whether to add the Starknet plugin to run the tests.
    #[arg(long, default_value_t = false)]
    starknet: bool,
    /// Whether to run the profiler, and what results to produce. See
    /// [cairo_lang_runner::profiling::ProfilerConfig].
    #[arg(short, long, default_value_t, value_enum)]
    run_profiler: RunProfilerConfigArg,
    /// Whether to disable gas calculation.
    #[arg(long)]
    gas_disabled: bool,
    /// Whether to print resource usage after each test.
    #[arg(long, default_value_t = false)]
    print_resource_usage: bool,
}

fn main() -> anyhow::Result<()> {
    let args = Args::parse();

    // Check if args.path is a file or a directory.
    check_compiler_path(args.single_file, &args.path)?;

    let config = TestRunConfig {
        filter: args.filter,
        ignored: args.ignored,
        include_ignored: args.include_ignored,
        profiler_config: args.run_profiler.try_into().ok(),
        gas_enabled: !args.gas_disabled,
        print_resource_usage: args.print_resource_usage,
    };

    let runner = TestRunner::new(&args.path, args.starknet, args.allow_warnings, config)?;
    runner.run()?;

    Ok(())
}