dtcs 0.3.0

Reference implementation of the Data Transformation Contract Standard (DTCS)
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

//! Version identifier validation (SPEC Chapter 25 ยง10).

use crate::diagnostics::{
    codes, Diagnostic, DiagnosticCategory, DiagnosticReport, DiagnosticStage, Severity,
};
use crate::model::{is_vendor_namespaced_identifier, TransformationContract};

/// Validate version identifiers on a transformation contract.
#[must_use]
pub fn validate(contract: &TransformationContract) -> DiagnosticReport {
    let mut diagnostics = Vec::new();

    if !is_valid_semver_like(&contract.version) {
        diagnostics.push(
            Diagnostic::new(
                codes::INVALID_VERSION,
                Severity::Error,
                DiagnosticStage::Validation,
                DiagnosticCategory::Compatibility,
                format!(
                    "contract version '{}' is not a valid semver identifier",
                    contract.version
                ),
            )
            .with_object_ref("version")
            .with_remediation("Use semver format such as 1.0.0 or 0.2.0"),
        );
    }

    if let Some(versioning) = &contract.versioning {
        if let Some(policy) = &versioning.compatibility {
            if policy.trim().is_empty() {
                diagnostics.push(
                    Diagnostic::new(
                        codes::INVALID_VERSION,
                        Severity::Error,
                        DiagnosticStage::Validation,
                        DiagnosticCategory::Compatibility,
                        "versioning.compatibility policy must be non-empty when declared",
                    )
                    .with_object_ref("versioning.compatibility"),
                );
            } else if !policy.starts_with("dtcs:") && !is_vendor_namespaced_identifier(policy) {
                diagnostics.push(
                    Diagnostic::new(
                        codes::INVALID_VERSION,
                        Severity::Error,
                        DiagnosticStage::Validation,
                        DiagnosticCategory::Compatibility,
                        format!("versioning.compatibility policy '{policy}' must be namespaced"),
                    )
                    .with_object_ref("versioning.compatibility")
                    .with_remediation("Use a dtcs: or vendor: compatibility policy identifier"),
                );
            }
        }
    }

    if let Some(metadata) = &contract.metadata {
        if let Some(identity) = &metadata.identity {
            if let Some(meta_version) = &identity.version {
                if meta_version.trim() != contract.version.trim() {
                    diagnostics.push(
                        Diagnostic::new(
                            codes::VERSION_CONFLICT,
                            Severity::Warning,
                            DiagnosticStage::Validation,
                            DiagnosticCategory::Compatibility,
                            format!(
                                "metadata.identity.version '{meta_version}' differs from contract version '{}'",
                                contract.version
                            ),
                        )
                        .with_object_ref("metadata.identity.version")
                        .with_remediation(
                            "Align metadata.identity.version with the top-level version field",
                        ),
                    );
                }
            }
        }
    }

    DiagnosticReport { diagnostics }
}

fn is_valid_semver_like(version: &str) -> bool {
    !version.trim().is_empty() && semver::Version::parse(version).is_ok()
}