Skip to content

gds_software.erd.checks

ERD verification checks (ER-001..ER-004).

ER-001: Relationship source/target are declared entities.

Source code in packages/gds-software/gds_software/erd/checks.py 
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
def check_er001_relationship_validity(model: ERDModel) -> list[Finding]:
    """ER-001: Relationship source/target are declared entities."""
    findings: list[Finding] = []
    for rel in model.relationships:
        src_valid = rel.source in model.entity_names
        findings.append(
            Finding(
                check_id="ER-001",
                severity=Severity.ERROR,
                message=(
                    f"Relationship {rel.name!r} source {rel.source!r} "
                    f"{'is' if src_valid else 'is NOT'} a declared entity"
                ),
                source_elements=[rel.name, rel.source],
                passed=src_valid,
            )
        )
        tgt_valid = rel.target in model.entity_names
        findings.append(
            Finding(
                check_id="ER-001",
                severity=Severity.ERROR,
                message=(
                    f"Relationship {rel.name!r} target {rel.target!r} "
                    f"{'is' if tgt_valid else 'is NOT'} a declared entity"
                ),
                source_elements=[rel.name, rel.target],
                passed=tgt_valid,
            )
        )
    return findings

ER-002: Every entity has at least one primary key attribute.

Source code in packages/gds-software/gds_software/erd/checks.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
def check_er002_pk_existence(model: ERDModel) -> list[Finding]:
    """ER-002: Every entity has at least one primary key attribute."""
    findings: list[Finding] = []
    for entity in model.entities:
        has_pk = any(a.is_primary_key for a in entity.attributes)
        findings.append(
            Finding(
                check_id="ER-002",
                severity=Severity.WARNING,
                message=(
                    f"Entity {entity.name!r} "
                    f"{'has' if has_pk else 'has NO'} primary key"
                ),
                source_elements=[entity.name],
                passed=has_pk,
            )
        )
    return findings

ER-003: No duplicate attribute names within an entity.

Source code in packages/gds-software/gds_software/erd/checks.py 
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
def check_er003_attribute_uniqueness(model: ERDModel) -> list[Finding]:
    """ER-003: No duplicate attribute names within an entity."""
    findings: list[Finding] = []
    for entity in model.entities:
        seen: set[str] = set()
        for attr in entity.attributes:
            is_unique = attr.name not in seen
            if not is_unique:
                findings.append(
                    Finding(
                        check_id="ER-003",
                        severity=Severity.ERROR,
                        message=(
                            f"Entity {entity.name!r} has duplicate "
                            f"attribute {attr.name!r}"
                        ),
                        source_elements=[entity.name, attr.name],
                        passed=False,
                    )
                )
            seen.add(attr.name)

    if not findings:
        findings.append(
            Finding(
                check_id="ER-003",
                severity=Severity.ERROR,
                message="All entity attributes are unique",
                source_elements=[],
                passed=True,
            )
        )
    return findings

ER-004: No duplicate relationship names.

Source code in packages/gds-software/gds_software/erd/checks.py 
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
def check_er004_relationship_naming(model: ERDModel) -> list[Finding]:
    """ER-004: No duplicate relationship names."""
    findings: list[Finding] = []
    seen: set[str] = set()
    for rel in model.relationships:
        is_unique = rel.name not in seen
        findings.append(
            Finding(
                check_id="ER-004",
                severity=Severity.ERROR,
                message=(
                    f"Relationship name {rel.name!r} "
                    f"{'is' if is_unique else 'is NOT'} unique"
                ),
                source_elements=[rel.name],
                passed=is_unique,
            )
        )
        seen.add(rel.name)
    return findings