|
| 1 | +#![cfg(unix)] |
| 2 | +//! 原项目文档契约的实际 Clippy 检查；不安装工具，不作为独立精度或生产资格。 |
| 3 | +use serde_json::{Value, json}; |
| 4 | +use sha2::{Digest, Sha256}; |
| 5 | +use std::{fs, path::PathBuf, process::Command}; |
| 6 | + |
| 7 | +struct Project(PathBuf); |
| 8 | +impl Project { |
| 9 | + fn new(index: usize, source: &str) -> Self { |
| 10 | + let root = std::env::temp_dir() |
| 11 | + .canonicalize() |
| 12 | + .unwrap() |
| 13 | + .join(format!("cg-clippy-doc-{}-{index}", std::process::id())); |
| 14 | + fs::create_dir_all(root.join("src")).unwrap(); |
| 15 | + fs::write( |
| 16 | + root.join("Cargo.toml"), |
| 17 | + "[package]\nname='documentation-sample'\nversion='0.1.0'\nedition='2021'\n", |
| 18 | + ) |
| 19 | + .unwrap(); |
| 20 | + fs::write( |
| 21 | + root.join("Cargo.lock"), |
| 22 | + "version = 4\n[[package]]\nname=\"documentation-sample\"\nversion=\"0.1.0\"\n", |
| 23 | + ) |
| 24 | + .unwrap(); |
| 25 | + fs::write(root.join("src/lib.rs"), source).unwrap(); |
| 26 | + let init = Self(root); |
| 27 | + init.invoke(&["init", "--apply", "--format=json"]); |
| 28 | + init |
| 29 | + } |
| 30 | + fn invoke(&self, args: &[&str]) -> Value { |
| 31 | + let output = Command::new(env!("CARGO_BIN_EXE_codeguard")) |
| 32 | + .args(args) |
| 33 | + .arg(&self.0) |
| 34 | + .env_remove("CODEGUARD_TIMEOUT") |
| 35 | + .output() |
| 36 | + .unwrap(); |
| 37 | + assert_eq!( |
| 38 | + output.status.code(), |
| 39 | + Some(3), |
| 40 | + "{}", |
| 41 | + String::from_utf8_lossy(&output.stderr) |
| 42 | + ); |
| 43 | + serde_json::from_slice(&output.stdout).unwrap() |
| 44 | + } |
| 45 | +} |
| 46 | +impl Drop for Project { |
| 47 | + fn drop(&mut self) { |
| 48 | + let _ = fs::remove_dir_all(&self.0); |
| 49 | + } |
| 50 | +} |
| 51 | + |
| 52 | +#[test] |
| 53 | +#[ignore = "requires explicitly selected installed Cargo with Clippy; no installation"] |
| 54 | +fn native_documentation_contracts_reuse_tasks_and_preserve_semantic_limits() { |
| 55 | + let tool = std::env::var("CODEGUARD_TEST_CARGO").expect("select existing Cargo"); |
| 56 | + let version = Command::new(&tool) |
| 57 | + .args(["clippy", "--version"]) |
| 58 | + .output() |
| 59 | + .unwrap(); |
| 60 | + assert!(version.status.success()); |
| 61 | + let version = String::from_utf8(version.stdout).unwrap(); |
| 62 | + let cli_sha256 = format!( |
| 63 | + "{:x}", |
| 64 | + Sha256::digest(fs::read(env!("CARGO_BIN_EXE_codeguard")).unwrap()) |
| 65 | + ); |
| 66 | + let mut evidence = Vec::new(); |
| 67 | + for (index, (rule, section, body, detail)) in [ |
| 68 | + ( |
| 69 | + "missing_errors_doc", |
| 70 | + "Errors", |
| 71 | + "pub fn fail() -> Result<(), &'static str> { Err(\"unavailable\") }", |
| 72 | + "不可用时返回 unavailable 错误。", |
| 73 | + ), |
| 74 | + ( |
| 75 | + "missing_panics_doc", |
| 76 | + "Panics", |
| 77 | + "pub fn fail() { panic!(\"unavailable\"); }", |
| 78 | + "每次调用都会因 unavailable 而 panic。", |
| 79 | + ), |
| 80 | + ( |
| 81 | + "missing_safety_doc", |
| 82 | + "Safety", |
| 83 | + "pub unsafe fn fail() {}", |
| 84 | + "本接口没有额外调用前置条件。", |
| 85 | + ), |
| 86 | + ] |
| 87 | + .into_iter() |
| 88 | + .enumerate() |
| 89 | + { |
| 90 | + let source = |doc: &str, suppression: &str| { |
| 91 | + format!( |
| 92 | + "#![warn(clippy::{rule})]\n{}/// 演示原生契约检查。\n{}{body}\n", |
| 93 | + if suppression.is_empty() { |
| 94 | + String::new() |
| 95 | + } else { |
| 96 | + format!("{suppression}\n") |
| 97 | + }, |
| 98 | + if doc.is_empty() { |
| 99 | + String::new() |
| 100 | + } else { |
| 101 | + format!("{doc}\n") |
| 102 | + } |
| 103 | + ) |
| 104 | + }; |
| 105 | + let p = Project::new(index, &source("", "")); |
| 106 | + let lint = || p.invoke(&["lint", "rust", "--cargo-tool", &tool, "--format=json"]); |
| 107 | + let first = lint(); |
| 108 | + let native_rule = format!("clippy::{rule}"); |
| 109 | + assert_eq!( |
| 110 | + first["native_report"]["local_scan_complete"], true, |
| 111 | + "{first}" |
| 112 | + ); |
| 113 | + let finding = first["native_report"]["findings"] |
| 114 | + .as_array() |
| 115 | + .unwrap() |
| 116 | + .iter() |
| 117 | + .find(|f| f["rule_id"] == native_rule) |
| 118 | + .expect("native documentation finding"); |
| 119 | + let id = finding["finding_id"].as_str().unwrap(); |
| 120 | + let brief = &first["next"]["repair_brief"]; |
| 121 | + assert_eq!(brief["task_id"], id, "{first}"); |
| 122 | + assert!(brief["step"].as_str().unwrap().contains(section), "{brief}"); |
| 123 | + let repeat = lint(); |
| 124 | + assert_eq!(repeat["next"]["repair_brief"]["task_id"], id); |
| 125 | + let verify = || p.invoke(&["task", "verify", id, "--cargo-tool", &tool, "--format=json"]); |
| 126 | + let present = verify(); |
| 127 | + assert_eq!(present["observation"], "still_present", "{present}"); |
| 128 | + fs::write( |
| 129 | + p.0.join("src/lib.rs"), |
| 130 | + source("", &format!("#[allow(clippy::{rule})]")), |
| 131 | + ) |
| 132 | + .unwrap(); |
| 133 | + let suppressed = verify(); |
| 134 | + assert_eq!( |
| 135 | + suppressed["observation"], "suppression_requires_review", |
| 136 | + "{suppressed}" |
| 137 | + ); |
| 138 | + fs::write( |
| 139 | + p.0.join("src/lib.rs"), |
| 140 | + source(&format!("/// # {section}"), ""), |
| 141 | + ) |
| 142 | + .unwrap(); |
| 143 | + let bare = lint(); |
| 144 | + assert_eq!(bare["native_report"]["local_scan_complete"], true, "{bare}"); |
| 145 | + assert!( |
| 146 | + bare["native_report"]["findings"] |
| 147 | + .as_array() |
| 148 | + .unwrap() |
| 149 | + .iter() |
| 150 | + .all(|f| f["rule_id"] != native_rule), |
| 151 | + "{bare}" |
| 152 | + ); |
| 153 | + assert_eq!(bare["delivery_decision"], "not_evaluated"); |
| 154 | + fs::write( |
| 155 | + p.0.join("src/lib.rs"), |
| 156 | + source(&format!("/// # {section}\n/// {detail}"), ""), |
| 157 | + ) |
| 158 | + .unwrap(); |
| 159 | + let repaired = verify(); |
| 160 | + assert_eq!( |
| 161 | + repaired["observation"], "candidate_absent_unverified_policy", |
| 162 | + "{repaired}" |
| 163 | + ); |
| 164 | + let fact: Value = serde_json::from_slice( |
| 165 | + &fs::read(p.0.join(format!(".codeguard/findings/{id}/finding.json"))).unwrap(), |
| 166 | + ) |
| 167 | + .unwrap(); |
| 168 | + assert_eq!(fact["state"], "open"); |
| 169 | + evidence.push(json!({"rule":native_rule,"first":first,"repeat":repeat,"present":present,"suppressed":suppressed,"bare_heading":bare,"repaired":repaired,"state":fact["state"]})); |
| 170 | + } |
| 171 | + let p = Project::new( |
| 172 | + 3, |
| 173 | + "/// 返回固定错误。\npub fn fail() -> Result<(), &'static str> { Err(\"unavailable\") }\n", |
| 174 | + ); |
| 175 | + let unselected = p.invoke(&["lint", "rust", "--cargo-tool", &tool, "--format=json"]); |
| 176 | + assert_eq!( |
| 177 | + unselected["native_report"]["local_scan_complete"], true, |
| 178 | + "{unselected}" |
| 179 | + ); |
| 180 | + assert!( |
| 181 | + unselected["native_report"]["findings"] |
| 182 | + .as_array() |
| 183 | + .unwrap() |
| 184 | + .iter() |
| 185 | + .all(|f| f["rule_id"] != "clippy::missing_errors_doc") |
| 186 | + ); |
| 187 | + if let Ok(path) = std::env::var("CODEGUARD_CLIPPY_DOC_EVIDENCE") { |
| 188 | + fs::write(path, serde_json::to_vec_pretty(&json!({"qualification":"not_granted","cli_sha256":cli_sha256,"clippy_version":version.trim(),"cases":evidence,"unselected_pedantic":unselected})).unwrap()).unwrap(); |
| 189 | + } |
| 190 | +} |
0 commit comments