aboutsummaryrefslogtreecommitdiff
path: root/dev_tools/src/bin/test-all-markdown-code.rs
blob: 31aebdd6b02c10d211ecf74e0b294f07c3c0efb0 (plain) (blame)
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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
use std::collections::HashMap;
use std::env;
use std::io::Write;
use std::path::{Path, PathBuf};

use colored::Colorize;
use tools::verify::{
    build_block, compute_block_hash, generate_cargo_toml, generate_main_rs, is_block_testable,
    parse_code_blocks, write_summary_report,
};
use tools::{eprintln_cargo_style, println_cargo_style};

/// Config from verified-docs.toml
#[derive(serde::Deserialize)]
struct Config {
    verified: VerifiedPaths,
}

#[derive(serde::Deserialize)]
struct VerifiedPaths {
    readme: String,
    #[serde(default)]
    documents_en_us: Option<String>,
    #[serde(default)]
    documents_zh_cn: Option<String>,
}

#[tokio::main]
async fn main() {
    #[cfg(windows)]
    let _ = colored::control::set_virtual_terminal(true);

    let config_path = PathBuf::from("verified-docs.toml");
    if !config_path.exists() {
        eprintln_cargo_style!("verified-docs.toml not found in current directory");
        std::process::exit(1);
    }

    let config: Config = {
        let content = std::fs::read_to_string(&config_path).unwrap_or_else(|_e| {
            eprintln_cargo_style!("Failed to read verified-docs.toml");
            std::process::exit(1);
        });
        toml::from_str(&content).unwrap_or_else(|_e| {
            eprintln_cargo_style!("Failed to parse verified-docs.toml");
            std::process::exit(1);
        })
    };

    // Parse optional path argument from env args
    let single_file: Option<PathBuf> = {
        let args: Vec<String> = env::args().collect();
        if args.len() > 1 {
            let p = PathBuf::from(&args[1]);
            if p.exists() {
                Some(p)
            } else {
                eprintln_cargo_style!("error: specified file '{}' does not exist", args[1]);
                std::process::exit(1);
            }
        } else {
            None
        }
    };

    // Collect all markdown files from config
    let mut files: Vec<(String, PathBuf)> = Vec::new();

    // README
    let readme_path = PathBuf::from(&config.verified.readme);
    if readme_path.exists() {
        files.push(("README".to_string(), readme_path));
        println_cargo_style!("Source: found README.md");
    }

    // English docs
    if let Some(pattern) = &config.verified.documents_en_us {
        let base = pattern.trim_end_matches("/**").trim_end_matches('*');
        let dir = PathBuf::from(base);
        if dir.exists() && dir.is_dir() {
            collect_md_files(&dir, &mut files, "en");
            println_cargo_style!("Source: found docs/pages/");
        }
    }

    // Chinese docs
    if let Some(pattern) = &config.verified.documents_zh_cn {
        let base = pattern.trim_end_matches("/**").trim_end_matches('*');
        let dir = PathBuf::from(base);
        if dir.exists() && dir.is_dir() {
            collect_md_files(&dir, &mut files, "zh_CN");
            println_cargo_style!("Source: found docs/_zh_CN/pages/");
        }
    }

    // If a single file was specified, filter the list to only that file
    if let Some(ref target) = single_file {
        // Canonicalize to compare paths reliably
        let target_canon = std::fs::canonicalize(target).unwrap_or_else(|_| target.clone());
        files.retain(|(_, path)| {
            std::fs::canonicalize(path)
                .map(|p| p == target_canon)
                .unwrap_or(false)
        });
        if files.is_empty() {
            eprintln_cargo_style!(
                "error: specified file '{}' is not among the configured documentation files",
                target.display()
            );
            std::process::exit(1);
        }
        println_cargo_style!("Source: testing only file '{}'", target.display());
    }

    if files.is_empty() {
        eprintln_cargo_style!("No markdown files found to verify");
        std::process::exit(1);
    }

    // Parse all code blocks into a flat list with global indices
    let mut flat_blocks: Vec<(usize, tools::verify::CodeBlock)> = Vec::new();

    for (label, path) in &files {
        let content = std::fs::read_to_string(path).unwrap_or_else(|e| {
            eprintln_cargo_style!("Failed to read {}: {}", path.display(), e);
            String::new()
        });
        let source_file = format!("{label}/{}", path.file_name().unwrap().to_string_lossy());
        let blocks = parse_code_blocks(&content, &source_file);
        let testable: Vec<_> = blocks.into_iter().filter(is_block_testable).collect();
        for block in testable {
            let idx = flat_blocks.len() + 1; // 1-based global index
            flat_blocks.push((idx, block));
        }
    }

    let total_testable = flat_blocks.len();

    if total_testable == 0 {
        println_cargo_style!("No testable code blocks found");
        return;
    }

    println_cargo_style!(
        "Test: found {total_testable} testable code blocks across {} files",
        files.len()
    );

    // Group blocks by dependency hash
    let mut groups: HashMap<String, Vec<(usize, tools::verify::CodeBlock)>> = HashMap::new();
    for (idx, block) in flat_blocks {
        let hash = compute_block_hash(&block);
        groups.entry(hash).or_default().push((idx, block));
    }

    println_cargo_style!(
        "Cache: grouped into {} unique dependency configurations",
        groups.len()
    );

    let temp_base = PathBuf::from(".temp/doc-test");

    // Sort groups by hash for deterministic output order
    let mut group_vec: Vec<(String, Vec<(usize, tools::verify::CodeBlock)>)> =
        groups.into_iter().collect();
    group_vec.sort_by(|a, b| a.0.cmp(&b.0));

    // Spawn a blocking task per group — groups run in parallel, blocks within a group are serial
    let mut handles = Vec::new();
    for (hash, blocks) in group_vec {
        let temp_base = temp_base.clone();
        let handle = tokio::task::spawn_blocking(move || {
            let crate_dir = temp_base.join(&hash);
            let src_dir = crate_dir.join("src");
            let manifest_path = crate_dir.join("Cargo.toml");

            // Buffer all output for this group so it prints contiguously
            let mut output = String::new();

            // Generate a single Cargo.toml for the whole group (all blocks share same deps)
            let first_block = &blocks[0].1;
            let cargo_toml = generate_cargo_toml(first_block, "test-doc", &manifest_path);

            let mut group_results: Vec<(String, usize, bool, String)> = Vec::new();
            for (block_idx, block) in &blocks {
                let block_label =
                    format!("Block {block_idx} ({}:{})", block.source_file, block.line);

                let main_rs = generate_main_rs(block);
                let (ok, err) = build_block(&src_dir, &manifest_path, &cargo_toml, &main_rs);
                if ok {
                    output.push_str(&format!(
                        "  Testing {block_label} ... {}\n",
                        "passed".bold().bright_green()
                    ));
                } else {
                    output.push_str(&format!(
                        "  Testing {block_label} ... {}\n",
                        "failed".bold().bright_red()
                    ));
                    output.push_str(&format!("  {block_label} FAILED:\n{err}\n"));
                }
                group_results.push((block.source_file.clone(), block.line, ok, err));
            }
            (output, group_results)
        });
        handles.push(handle);
    }

    // Collect results from all groups
    let mut results: Vec<(String, usize, bool, String)> = Vec::new();
    let mut passed = 0usize;
    let mut failed = 0usize;

    for handle in handles {
        match handle.await {
            Ok((output, group_results)) => {
                // Print entire group output at once, avoiding interleaving
                print!("{output}");
                let _ = std::io::stdout().flush();
                for (file, line, ok, err) in group_results {
                    if ok {
                        passed += 1;
                    } else {
                        failed += 1;
                    }
                    results.push((file, line, ok, err));
                }
            }
            Err(e) => {
                eprintln_cargo_style!("Task panicked: {}", e);
                std::process::exit(1);
            }
        }
    }

    let result_msg = format!("Result: {passed}/{total_testable} blocks passed");
    println_cargo_style!(result_msg);

    write_summary_report(
        Path::new(".temp/DOCS-TEST-RESULT.md"),
        "Documentation Code Block Test Report",
        &results,
        total_testable,
        passed,
        failed,
    );

    if failed > 0 {
        let fail_msg = format!("{failed} block(s) failed to build");
        eprintln_cargo_style!(fail_msg);
        std::process::exit(1);
    }

    println_cargo_style!("Done: All verified code blocks build successfully!");
}

/// Recursively collect all `.md` files under a directory
fn collect_md_files(dir: &Path, files: &mut Vec<(String, PathBuf)>, lang: &str) {
    if let Ok(entries) = std::fs::read_dir(dir) {
        for entry in entries.flatten() {
            let path = entry.path();
            if path.is_dir() {
                collect_md_files(&path, files, lang);
            } else if path.extension().is_some_and(|ext| ext == "md") {
                files.push((lang.to_string(), path));
            }
        }
    }
}