pmat 3.30.1

PMAT - Zero-config AI context generation and code quality toolkit (CLI, MCP)
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
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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
#![cfg_attr(coverage_nightly, coverage(off))]
//! Edge case tests for README validation: no evidence, negative claims, mixed results, formatting

use super::types::{OutputFormat, ValidateReadmeCmd};
#[allow(unused_imports)]
use crate::services::hallucination_detector::{
    Claim, ClaimType, Entity, Evidence, ValidationResult, ValidationStatus,
};
use std::io::Write;
use std::path::PathBuf;
use std::process::ExitCode;
use tempfile::NamedTempFile;

// ============================================================================
// Edge case tests
// ============================================================================

#[test]
fn test_validation_result_without_evidence() {
    let result = ValidationResult {
        claim: Claim {
            source_file: PathBuf::from("test.md"),
            line_number: 1,
            text: "PMAT can analyze".to_string(),
            claim_type: ClaimType::Capability,
            entities: vec![],
            is_negative: false,
        },
        status: ValidationStatus::Inconclusive,
        evidence: None,
        error_message: Some("No evidence available".to_string()),
        confidence: 0.5,
    };

    let cmd = ValidateReadmeCmd {
        targets: vec![PathBuf::from("test.md")],
        deep_context: PathBuf::from("dc.md"),
        verified_threshold: 0.9,
        contradiction_threshold: 0.3,
        fail_on_contradiction: true,
        fail_on_unverified: false,
        output: OutputFormat::Text,
        failures_only: false,
        verbose: false,
    };

    let results = vec![(PathBuf::from("test.md"), vec![result])];

    // Test all output formats with no evidence
    cmd.print_text_summary(&results, 0, 0, 0);
    assert!(cmd.print_json_summary(&results).is_ok());
    assert!(cmd.print_junit_summary(&results).is_ok());
}

#[test]
fn test_negative_claim_handling() {
    let mut deep_context_file = NamedTempFile::new().unwrap();
    writeln!(
        deep_context_file,
        r#"
Supported languages:
- Rust
        "#
    )
    .unwrap();

    // Negative claim (PMAT cannot compile)
    let mut readme_file = NamedTempFile::new().unwrap();
    writeln!(readme_file, "PMAT cannot compile Rust code.").unwrap();

    let cmd = ValidateReadmeCmd {
        targets: vec![readme_file.path().to_path_buf()],
        deep_context: deep_context_file.path().to_path_buf(),
        verified_threshold: 0.9,
        contradiction_threshold: 0.3,
        fail_on_contradiction: true,
        fail_on_unverified: false,
        output: OutputFormat::Text,
        failures_only: false,
        verbose: false,
    };

    let result = cmd.execute();
    assert!(result.is_ok());
    // Negative claims about compile should be fine (it's correct that PMAT cannot compile)
}

#[test]
fn test_supports_pattern() {
    let mut deep_context_file = NamedTempFile::new().unwrap();
    writeln!(
        deep_context_file,
        r#"
Supported languages:
- Rust
- TypeScript
        "#
    )
    .unwrap();

    // Using "supports" pattern
    let mut readme_file = NamedTempFile::new().unwrap();
    writeln!(readme_file, "PMAT supports Rust and TypeScript analysis.").unwrap();

    let cmd = ValidateReadmeCmd {
        targets: vec![readme_file.path().to_path_buf()],
        deep_context: deep_context_file.path().to_path_buf(),
        verified_threshold: 0.9,
        contradiction_threshold: 0.3,
        fail_on_contradiction: true,
        fail_on_unverified: false,
        output: OutputFormat::Text,
        failures_only: false,
        verbose: false,
    };

    let result = cmd.execute();
    assert!(result.is_ok());
}

#[test]
fn test_empty_deep_context() {
    let mut deep_context_file = NamedTempFile::new().unwrap();
    writeln!(deep_context_file, "# Empty context").unwrap();

    let mut readme_file = NamedTempFile::new().unwrap();
    writeln!(readme_file, "PMAT can analyze Rust code.").unwrap();

    let cmd = ValidateReadmeCmd {
        targets: vec![readme_file.path().to_path_buf()],
        deep_context: deep_context_file.path().to_path_buf(),
        verified_threshold: 0.9,
        contradiction_threshold: 0.3,
        fail_on_contradiction: true,
        fail_on_unverified: false,
        output: OutputFormat::Text,
        failures_only: false,
        verbose: false,
    };

    let result = cmd.execute();
    assert!(result.is_ok());
}

#[test]
fn test_multiple_claims_mixed_results() {
    let mut deep_context_file = NamedTempFile::new().unwrap();
    writeln!(
        deep_context_file,
        r#"
Functions:
- analyze()
- parse()

Supported languages:
- Rust
- TypeScript
        "#
    )
    .unwrap();

    let mut readme_file = NamedTempFile::new().unwrap();
    writeln!(readme_file, "PMAT can analyze Rust code.").unwrap();
    writeln!(readme_file, "PMAT can compile TypeScript.").unwrap();
    writeln!(readme_file, "PMAT supports JavaScript analysis.").unwrap();

    let cmd = ValidateReadmeCmd {
        targets: vec![readme_file.path().to_path_buf()],
        deep_context: deep_context_file.path().to_path_buf(),
        verified_threshold: 0.9,
        contradiction_threshold: 0.3,
        fail_on_contradiction: true,
        fail_on_unverified: false,
        output: OutputFormat::Text,
        failures_only: false,
        verbose: false,
    };

    let result = cmd.execute();
    assert!(result.is_ok());
    // Should fail due to "compile" contradiction
    assert_eq!(result.unwrap(), ExitCode::FAILURE);
}

#[test]
fn test_claim_type_debug_formatting() {
    let claim = Claim {
        source_file: PathBuf::from("test.md"),
        line_number: 1,
        text: "test".to_string(),
        claim_type: ClaimType::Capability,
        entities: vec![Entity::Language("Rust".to_string())],
        is_negative: false,
    };

    // Test debug formatting works
    let debug_output = format!("{:?}", claim.claim_type);
    assert_eq!(debug_output, "Capability");
}

#[test]
fn test_validation_status_debug_formatting() {
    assert_eq!(format!("{:?}", ValidationStatus::Verified), "Verified");
    assert_eq!(
        format!("{:?}", ValidationStatus::Contradiction),
        "Contradiction"
    );
    assert_eq!(format!("{:?}", ValidationStatus::Unverified), "Unverified");
    assert_eq!(format!("{:?}", ValidationStatus::NotFound), "NotFound");
    assert_eq!(format!("{:?}", ValidationStatus::Outdated), "Outdated");
    assert_eq!(
        format!("{:?}", ValidationStatus::Inconclusive),
        "Inconclusive"
    );
}

#[test]
fn test_entity_debug_formatting() {
    let entities = vec![
        Entity::Language("Rust".to_string()),
        Entity::Function("main".to_string()),
        Entity::File("test.rs".to_string()),
        Entity::Module("cli".to_string()),
        Entity::Capability("analyze".to_string()),
    ];

    for entity in &entities {
        // Just verify debug formatting doesn't panic
        let _ = format!("{:?}", entity);
    }
}

// ============================================================================
// Execute edge case tests
// ============================================================================

#[test]
fn test_execute_with_multiple_targets() {
    let mut deep_context_file = NamedTempFile::new().unwrap();
    writeln!(
        deep_context_file,
        r#"
Supported languages:
- Rust
- TypeScript
        "#
    )
    .unwrap();

    let mut readme_file = NamedTempFile::new().unwrap();
    writeln!(readme_file, "PMAT can analyze Rust code.").unwrap();

    let mut claude_file = NamedTempFile::new().unwrap();
    writeln!(claude_file, "PMAT supports TypeScript analysis.").unwrap();

    let cmd = ValidateReadmeCmd {
        targets: vec![
            readme_file.path().to_path_buf(),
            claude_file.path().to_path_buf(),
        ],
        deep_context: deep_context_file.path().to_path_buf(),
        verified_threshold: 0.9,
        contradiction_threshold: 0.3,
        fail_on_contradiction: true,
        fail_on_unverified: false,
        output: OutputFormat::Text,
        failures_only: false,
        verbose: false,
    };

    let result = cmd.execute();
    assert!(result.is_ok());
    assert_eq!(result.unwrap(), ExitCode::SUCCESS);
}

#[test]
fn test_execute_with_no_claims() {
    let mut deep_context_file = NamedTempFile::new().unwrap();
    writeln!(
        deep_context_file,
        r#"
Supported languages:
- Rust
        "#
    )
    .unwrap();

    // README with no PMAT claims
    let mut readme_file = NamedTempFile::new().unwrap();
    writeln!(
        readme_file,
        "This is a simple README without any PMAT claims."
    )
    .unwrap();
    writeln!(readme_file, "It just contains some text.").unwrap();

    let cmd = ValidateReadmeCmd {
        targets: vec![readme_file.path().to_path_buf()],
        deep_context: deep_context_file.path().to_path_buf(),
        verified_threshold: 0.9,
        contradiction_threshold: 0.3,
        fail_on_contradiction: true,
        fail_on_unverified: false,
        output: OutputFormat::Text,
        failures_only: false,
        verbose: false,
    };

    let result = cmd.execute();
    assert!(result.is_ok());
    // REGRESSION: this used to assert SUCCESS. A document from which no
    // verifiable claim could be extracted was never checked, so reporting it
    // as a pass let fabricated documentation through the gate. Nothing
    // checked is now an explicit failure, not a green tick.
    assert_eq!(result.unwrap(), ExitCode::FAILURE);
}

/// REGRESSION (blocker: `pmat validate-readme` certified fabricated docs).
///
/// A document citing a file that does not exist must fail the gate. Before the
/// fix the extractor recognised only three "PMAT can/cannot/supports" phrases,
/// so this document yielded zero claims and printed
/// "All documentation claims are verified!" with exit 0.
#[test]
fn test_execute_fails_on_fabricated_file_reference() {
    let mut deep_context_file = NamedTempFile::new().unwrap();
    writeln!(
        deep_context_file,
        r#"
Functions:
- main()

Supported languages:
- Rust
        "#
    )
    .unwrap();

    let mut readme_file = NamedTempFile::new().unwrap();
    writeln!(
        readme_file,
        "The entry point lives in `src/totally/made/up/nonexistent_module.rs` today."
    )
    .unwrap();

    let cmd = ValidateReadmeCmd {
        targets: vec![readme_file.path().to_path_buf()],
        deep_context: deep_context_file.path().to_path_buf(),
        verified_threshold: 0.9,
        contradiction_threshold: 0.3,
        fail_on_contradiction: true,
        fail_on_unverified: false,
        output: OutputFormat::Text,
        failures_only: false,
        verbose: false,
    };

    let result = cmd.execute();
    assert!(result.is_ok());
    assert_eq!(result.unwrap(), ExitCode::FAILURE);
}

#[test]
fn test_execute_with_code_blocks_ignored() {
    let mut deep_context_file = NamedTempFile::new().unwrap();
    writeln!(
        deep_context_file,
        r#"
Supported languages:
- Rust
        "#
    )
    .unwrap();

    // README with a false claim inside a code block (must be ignored) plus a
    // real claim outside it, so the run has something to actually verify —
    // otherwise "nothing was checked" would be indistinguishable from a pass.
    let mut readme_file = NamedTempFile::new().unwrap();
    writeln!(readme_file, "# Usage").unwrap();
    writeln!(readme_file).unwrap();
    writeln!(readme_file, "PMAT can analyze Rust code.").unwrap();
    writeln!(readme_file, "```bash").unwrap();
    writeln!(readme_file, "# PMAT can compile code inside code block").unwrap();
    writeln!(readme_file, "pmat analyze").unwrap();
    writeln!(readme_file, "```").unwrap();

    let cmd = ValidateReadmeCmd {
        targets: vec![readme_file.path().to_path_buf()],
        deep_context: deep_context_file.path().to_path_buf(),
        verified_threshold: 0.9,
        contradiction_threshold: 0.3,
        fail_on_contradiction: true,
        fail_on_unverified: false,
        output: OutputFormat::Text,
        failures_only: false,
        verbose: false,
    };

    let result = cmd.execute();
    assert!(result.is_ok());
    // Should succeed because the claim is inside a code block and ignored
    assert_eq!(result.unwrap(), ExitCode::SUCCESS);
}