designguard 0.1.1

KiCad schematic and PCB validation library
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

//! Tests for specific validation rules

use designguard::prelude::*;
use designguard::analyzer::rules::RulesEngine;
use designguard::parse_schematic;
use std::path::PathBuf;

fn fixture_path(name: &str) -> PathBuf {
    PathBuf::from(env!("CARGO_MANIFEST_DIR"))
        .join("tests")
        .join("fixtures")
        .join(name)
}

#[test]
fn test_decoupling_rule() {
    let schematic = parse_schematic(&fixture_path("missing_decap.kicad_sch"))
        .expect("Should parse schematic");

    let rules = RulesEngine::with_default_rules();
    let issues = rules.analyze(&schematic);

    // Should have decoupling-related issues
    let decap_issues: Vec<_> = issues
        .iter()
        .filter(|i| {
            i.rule_id.contains("decoupling")
                || i.message.to_lowercase().contains("decoupling")
        })
        .collect();

    assert!(!decap_issues.is_empty(), "Should detect decoupling issues");
}

#[test]
fn test_i2c_pullup_rule() {
    let schematic = parse_schematic(&fixture_path("missing_i2c_pullups.kicad_sch"))
        .expect("Should parse schematic");

    let rules = RulesEngine::with_default_rules();
    let issues = rules.analyze(&schematic);

    // Should have pull-up related issues
    let pullup_issues: Vec<_> = issues
        .iter()
        .filter(|i| {
            i.message.to_lowercase().contains("pull")
                && (i.message.contains("SDA") || i.message.contains("SCL"))
        })
        .collect();

    assert!(
        !pullup_issues.is_empty(),
        "Should detect missing I2C pull-ups"
    );
}

#[test]
fn test_severity_levels() {
    let options = ValidationOptions::default();

    let result = DesignGuardCore::validate_schematic(
        &fixture_path("missing_decap.kicad_sch"),
        options,
    )
    .expect("Should parse");

    // Test that severity enum works
    for issue in &result.issues {
        match issue.severity {
            Severity::Error | Severity::Warning | Severity::Suggestion | Severity::Info => {
                // Valid severity
            }
        }
    }
}

#[test]
fn test_issue_structure() {
    let options = ValidationOptions::default();

    let result = DesignGuardCore::validate_schematic(
        &fixture_path("missing_decap.kicad_sch"),
        options,
    )
    .expect("Should parse");

    for issue in &result.issues {
        // Every issue should have a message
        assert!(!issue.message.is_empty(), "Issue should have message");

        // Every issue should have a rule_id
        assert!(!issue.rule_id.is_empty(), "Issue should have rule_id");

        // Suggestion is optional but should be meaningful if present
        if let Some(ref suggestion) = issue.suggestion {
            assert!(!suggestion.is_empty(), "Suggestion should not be empty");
        }
    }
}