vex2pdf 4.0.0

A tool to convert CycloneDX(VEX) JSON or XML documents to PDF reports
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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226

#![cfg(feature = "concurrency")]

use std::path::Path;
use std::process::Command;
use tempfile::TempDir;

mod common;

use common::paths;
use common::utils;

/// Helper function to run vex2pdf with max_jobs and verify success
fn run_vex2pdf_with_jobs(
    input_path: &str,
    output_dir: &Path,
    max_jobs: Option<u8>,
) -> std::process::Output {
    let mut cmd = Command::new(paths::PATH_TO_EXE);
    cmd.arg("-d").arg(output_dir).arg(input_path);

    if let Some(jobs) = max_jobs {
        cmd.arg("--max-jobs").arg(jobs.to_string());
    }

    let output = cmd.output().expect("Failed to execute command");

    // Print output for debugging
    if !output.stdout.is_empty() {
        println!("stdout: {}", utils::bytes_to_str(&output.stdout));
    }
    if !output.stderr.is_empty() {
        eprintln!("stderr: {}", utils::bytes_to_str(&output.stderr));
    }

    // Assert command succeeded
    assert!(
        output.status.success(),
        "Command failed with status: {}",
        output.status
    );

    output
}

#[test]
fn test_single_threaded_mode() {
    let output_dir = TempDir::new().expect("Failed to create temp dir");

    let output = run_vex2pdf_with_jobs(paths::SIMPLE_BOM_PATH, output_dir.path(), Some(1));

    // Verify single-threaded message appears in output
    utils::assert_output_contains(
        &output.stdout,
        "Concurrency Disabled: running all jobs sequentially in main thread",
    );

    // Verify PDF was generated
    let pdf_count = utils::count_pdf_files(output_dir.path());
    assert_eq!(
        pdf_count, 1,
        "Should generate exactly 1 PDF in single-threaded mode"
    );
}

#[test]
fn test_multi_threaded_mode_2_jobs() {
    let output_dir = TempDir::new().expect("Failed to create temp dir");

    // Use directory with multiple files
    let output = run_vex2pdf_with_jobs(
        paths::SOURCE_BOMS_BASE_ARTIFACTS_DIR,
        output_dir.path(),
        Some(2),
    );

    // Verify multi-threaded message with 2 jobs
    utils::assert_output_contains(&output.stdout, "Concurrency Enabled: running with 2 jobs");

    // Verify PDFs were generated
    let pdf_count = utils::count_pdf_files(output_dir.path());
    assert!(
        pdf_count > 1,
        "Should generate multiple PDFs with 2 jobs, found {}",
        pdf_count
    );
}

#[test]
fn test_multi_threaded_mode_4_jobs() {
    let output_dir = TempDir::new().expect("Failed to create temp dir");

    // Use directory with multiple files
    let output = run_vex2pdf_with_jobs(
        paths::SOURCE_BOMS_BASE_ARTIFACTS_DIR,
        output_dir.path(),
        Some(4),
    );

    // Verify multi-threaded message with 4 jobs
    utils::assert_output_contains(&output.stdout, "Concurrency Enabled: running with 4 jobs");

    // Verify PDFs were generated
    let pdf_count = utils::count_pdf_files(output_dir.path());
    assert!(
        pdf_count > 1,
        "Should generate multiple PDFs with 4 jobs, found {}",
        pdf_count
    );
}

#[test]
fn test_default_parallelism() {
    let output_dir = TempDir::new().expect("Failed to create temp dir");

    // No max_jobs argument - should use default (all available cores)
    let output = run_vex2pdf_with_jobs(paths::SIMPLE_BOM_PATH, output_dir.path(), None);

    // Verify multi-threaded message (default should enable concurrency)
    utils::assert_output_contains(&output.stdout, "Concurrency Enabled: running with");

    // Verify PDF was generated
    let pdf_count = utils::count_pdf_files(output_dir.path());
    assert_eq!(
        pdf_count, 1,
        "Should generate exactly 1 PDF with default parallelism"
    );
}

#[test]
fn test_max_jobs_zero_uses_default() {
    let output_dir = TempDir::new().expect("Failed to create temp dir");

    // max_jobs = 0 should use default parallelism (all available cores)
    let output = run_vex2pdf_with_jobs(paths::SIMPLE_BOM_PATH, output_dir.path(), Some(0));

    // Verify multi-threaded message (0 should trigger default behavior)
    utils::assert_output_contains(&output.stdout, "Concurrency Enabled: running with");

    // Verify PDF was generated
    let pdf_count = utils::count_pdf_files(output_dir.path());
    assert_eq!(
        pdf_count, 1,
        "Should generate exactly 1 PDF with max_jobs=0"
    );
}

#[test]
fn test_env_var_single_threaded() {
    let output_dir = TempDir::new().expect("Failed to create temp dir");

    // Use VEX2PDF_MAX_JOBS=1 environment variable
    let output = Command::new(paths::PATH_TO_EXE)
        .env("VEX2PDF_MAX_JOBS", "1")
        .arg("-d")
        .arg(output_dir.path())
        .arg(paths::SIMPLE_BOM_PATH)
        .output()
        .expect("Failed to execute command");

    // Print output for debugging
    if !output.stdout.is_empty() {
        println!("stdout: {}", utils::bytes_to_str(&output.stdout));
    }
    if !output.stderr.is_empty() {
        eprintln!("stderr: {}", utils::bytes_to_str(&output.stderr));
    }

    // Assert command succeeded
    assert!(
        output.status.success(),
        "Command failed with status: {}",
        output.status
    );

    // Verify single-threaded message appears in output
    utils::assert_output_contains(
        &output.stdout,
        "Concurrency Disabled: running all jobs sequentially in main thread",
    );

    // Verify PDF was generated
    let pdf_count = utils::count_pdf_files(output_dir.path());
    assert_eq!(
        pdf_count, 1,
        "Should generate exactly 1 PDF with VEX2PDF_MAX_JOBS=1"
    );
}

#[test]
fn test_env_var_default_parallelism() {
    let output_dir = TempDir::new().expect("Failed to create temp dir");

    // Use VEX2PDF_MAX_JOBS=0 environment variable (should use default)
    let output = Command::new(paths::PATH_TO_EXE)
        .env("VEX2PDF_MAX_JOBS", "0")
        .arg("-d")
        .arg(output_dir.path())
        .arg(paths::SIMPLE_BOM_PATH)
        .output()
        .expect("Failed to execute command");

    // Print output for debugging
    if !output.stdout.is_empty() {
        println!("stdout: {}", utils::bytes_to_str(&output.stdout));
    }
    if !output.stderr.is_empty() {
        eprintln!("stderr: {}", utils::bytes_to_str(&output.stderr));
    }

    // Assert command succeeded
    assert!(
        output.status.success(),
        "Command failed with status: {}",
        output.status
    );

    // Verify multi-threaded message (0 should trigger default behavior)
    utils::assert_output_contains(&output.stdout, "Concurrency Enabled: running with");

    // Verify PDF was generated
    let pdf_count = utils::count_pdf_files(output_dir.path());
    assert_eq!(
        pdf_count, 1,
        "Should generate exactly 1 PDF with VEX2PDF_MAX_JOBS=0"
    );
}