bender 0.31.0

A dependency management tool for hardware projects.
Documentation 
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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165

// Copyright (c) 2025 ETH Zurich
// Tim Fischer <fischeti@iis.ee.ethz.ch>

use std::path::{Path, PathBuf};
use std::process::Command as SysCommand;
use std::sync::OnceLock;

use assert_cmd::cargo;
use pretty_assertions::assert_eq;

static SETUP: OnceLock<(PathBuf, PathBuf)> = OnceLock::new();

fn get_test_env() -> &'static (PathBuf, PathBuf) {
    SETUP.get_or_init(|| {
        let root = Path::new("target/tmp_regression");
        let install_root = root.join("golden_install");
        let repo_dir = Path::new("tests/cli_regression").to_path_buf();

        // Install Golden Bender
        let bender_exe = install_root.join("bin").join("bender");

        let golden_branch = std::env::var("BENDER_TEST_GOLDEN_BRANCH")
            .or_else(|_| std::env::var("GITHUB_BASE_REF")) // For GitHub Actions
            .unwrap_or_else(|_| "master".to_string());

        println!("Using golden bender branch: {}", golden_branch);

        if !bender_exe.exists() {
            // Create dir to ensure root exists
            std::fs::create_dir_all(&install_root).expect("Failed to create install dir");

            let status = SysCommand::new("cargo")
                .args(&[
                    "install",
                    "--git",
                    "https://github.com/pulp-platform/bender",
                    "--branch",
                    &golden_branch,
                    "--root",
                    install_root.to_str().unwrap(),
                    "bender",
                ])
                .status()
                .expect("Failed to run cargo install");

            assert!(status.success(), "Failed to install golden bender");
        }

        let bender_exe_abs = std::env::current_dir().unwrap().join(&bender_exe);

        // Checkout the dependencies in the beginning
        let status = SysCommand::new(&bender_exe_abs)
            .arg("checkout")
            .current_dir(&repo_dir)
            .status()
            .expect("Failed to run bender checkout");
        assert!(
            status.success(),
            "Failed to initialize common_cells with bender"
        );

        (bender_exe, repo_dir)
    })
}

fn run_regression(subcommand_args: &[&str]) {
    let (golden_bin, repo_dir) = get_test_env();

    // Construct common args: -d /path/to/repo <SUBCOMMAND_ARGS>
    // We add the directory flag automatically here.
    let mut full_args = vec!["-d", repo_dir.to_str().unwrap()];
    full_args.extend(subcommand_args);

    // Run GOLDEN
    let golden_out = SysCommand::new(golden_bin)
        .args(&full_args)
        .output()
        .expect("Failed to execute golden binary");

    // Run NEW (Current Build)
    let new_out = cargo::cargo_bin_cmd!()
        .args(&full_args)
        .output()
        .expect("Failed to execute new binary");

    // Compare
    let golden_stdout = String::from_utf8_lossy(&golden_out.stdout);
    let new_stdout = String::from_utf8_lossy(&new_out.stdout);

    assert_eq!(golden_stdout, new_stdout);
}

// The Macro generates the tests
macro_rules! regression_tests {
    ($($name:ident: $args:expr),* $(,)?) => {
        $(
            #[test]
            #[ignore]
            fn $name() {
                run_regression($args);
            }
        )*
    };
}

regression_tests! {
    cli_flist:                      &["script", "flist"],
    cli_flist_relative:             &["script", "flist", "--relative-path"],
    cli_flist_plus:                 &["script", "flist-plus"],
    cli_flist_plus_relative:        &["script", "flist-plus", "--define", "CUSTOM_DEFINE=2", "-DSECOND_DEF"],
    cli_flist_plus_only_defines:    &["script", "flist-plus", "--only-defines"],
    cli_flist_plus_only_includes:   &["script", "flist-plus", "--only-includes"],
    cli_flist_plus_only_sources:    &["script", "flist-plus", "--only-sources"],
    cli_flist_plus_nodeps:          &["script", "flist-plus", "--no-deps"],
    cli_flist_plus_cc:              &["script", "flist-plus", "--package", "common_cells"],
    cli_flist_plus_exclude_cc:      &["script", "flist-plus", "--exclude", "common_cells"],
    cli_flist_assume_rtl:           &["script", "flist-plus", "--assume-rtl"],
    cli_vsim:                       &["script", "vsim"],
    cli_vsim_separate:              &["script", "vsim", "--compilation-mode", "separate"],
    cli_vsim_common:                &["script", "vsim", "--compilation-mode", "common"],
    cli_vsim_vlog_arg:              &["script", "vsim", "--vlog-arg", "arg"],
    cli_vsim_vcom_arg:              &["script", "vsim", "--vcom-arg", "arg"],
    cli_vsim_noabort:               &["script", "vsim", "--no-abort-on-error"],
    cli_vcs:                        &["script", "vcs"],
    cli_vcs_vlogan_arg:             &["script", "vcs", "--vlogan-arg", "arg"],
    cli_vcs_vhdlan_arg:             &["script", "vcs", "--vhdlan-arg", "arg"],
    cli_vcs_vlog_old_arg:           &["script", "vcs", "--vlog-arg", "arg"],
    cli_vcs_vcom_old_arg:           &["script", "vcs", "--vcom-arg", "arg"],
    cli_vcs_vhdlan_bin:             &["script", "vcs", "--vhdlan-bin", "arg"],
    cli_vcs_vlogan_bin:             &["script", "vcs", "--vlogan-bin", "arg"],
    cli_verilator:                  &["script", "verilator"],
    cli_verilator_args:             &["script", "verilator", "--vlt-args", "arg"],
    cli_verilator_args_alias:       &["script", "verilator", "--vlog-args", "arg"],
    cli_synopsys:                   &["script", "synopsys"],
    cli_synopsys_verilog_arg:       &["script", "synopsys", "--verilog-args", "arg"],
    cli_synopsys_vhdl_arg:          &["script", "synopsys", "--vhdl-args", "arg"],
    cli_synopsys_vlog_old_arg:      &["script", "synopsys", "--vlog-arg", "arg"],
    cli_synopsys_vcom_old_arg:      &["script", "synopsys", "--vcom-arg", "arg"],
    cli_formality:                  &["script", "formality"],
    cli_riviera:                    &["script", "riviera"],
    cli_riviera_vlog_arg:           &["script", "riviera", "--vlog-arg", "arg"],
    cli_riviera_vcom_arg:           &["script", "riviera", "--vcom-arg", "arg"],
    cli_genus:                      &["script", "genus"],
    cli_vivado:                     &["script", "vivado"],
    cli_vivado_opts:                &["script", "vivado", "--no-simset"],
    cli_vivado_only_defines:        &["script", "vivado", "--only-defines"],
    cli_vivado_only_includes:       &["script", "vivado", "--only-includes"],
    cli_vivado_only_sources:        &["script", "vivado", "--only-sources"],
    cli_vivado_sim:                 &["script", "vivado-sim"],
    cli_vivado_sim_opts:            &["script", "vivado-sim", "--no-simset"],
    cli_vivado_sim_only_defines:    &["script", "vivado-sim", "--only-defines"],
    cli_vivado_sim_only_includes:   &["script", "vivado-sim", "--only-includes"],
    cli_vivado_sim_only_sources:    &["script", "vivado-sim", "--only-sources"],
    cli_precision:                  &["script", "precision"],
    cli_template_json:              &["script", "template_json"],
    script_target_pre:              &["script", "--target", "rtl", "vsim"],
    script_target_post:             &["script", "vsim", "--target", "rtl"],
    audit:                          &["audit"],
    audit_with_deps:                &["audit", "--only-update"],
    parents:                        &["parents", "common_cells"],
    packages:                       &["packages"],
    packages_graph:                 &["packages", "--graph"],
    packages_flat:                  &["packages", "--flat"],

}