dpcs 0.10.0

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

//! Package validation.

use std::collections::BTreeSet;
use std::path::Path;

use crate::diagnostics::{categories, Diagnostic, ValidationReport};
use crate::model::is_valid_version;
use crate::package::{PackageLayout, PackageManifest};
use crate::paths::{is_safe_relative, join_under_root};

/// Validate a package directory.
pub fn validate_package(root: impl AsRef<Path>) -> ValidationReport {
    let mut report = ValidationReport::new();
    let layout = match PackageLayout::open(root) {
        Ok(layout) => layout,
        Err(err) => {
            report.push(
                Diagnostic::error(
                    "DPCS-PKG-001",
                    categories::PACKAGE,
                    format!("failed to open package: {err}"),
                )
                .with_remediation("Ensure manifest.yaml exists and is well-formed"),
            );
            return report;
        }
    };
    validate_manifest(&layout.manifest, &mut report);
    let mut seen = BTreeSet::new();
    for (idx, entry) in layout.manifest.artifacts.iter().enumerate() {
        let key = format!("{}@{}", entry.id, entry.version);
        if !seen.insert(key) {
            report.push(
                Diagnostic::error(
                    "DPCS-PKG-002",
                    categories::PACKAGE,
                    format!(
                        "duplicate artifact id/version `{}@{}`",
                        entry.id, entry.version
                    ),
                )
                .with_object_ref(format!("artifacts[{idx}]")),
            );
        }
        if entry.id.trim().is_empty() {
            report.push(
                Diagnostic::error(
                    "DPCS-PKG-003",
                    categories::PACKAGE,
                    "artifact id must be non-empty",
                )
                .with_object_ref(format!("artifacts[{idx}].id")),
            );
        }
        if !is_valid_version(&entry.version) {
            report.push(
                Diagnostic::error(
                    "DPCS-PKG-004",
                    categories::PACKAGE,
                    format!("invalid artifact version `{}`", entry.version),
                )
                .with_object_ref(format!("artifacts[{idx}].version")),
            );
        }
        if !is_safe_relative(&entry.path) {
            report.push(
                Diagnostic::error(
                    "DPCS-PKG-005",
                    categories::PACKAGE,
                    format!("unsafe or absolute artifact path `{}`", entry.path),
                )
                .with_object_ref(format!("artifacts[{idx}].path"))
                .with_remediation("Use a relative path without '..'"),
            );
            continue;
        }
        let path = match join_under_root(&layout.root, &entry.path) {
            Ok(path) => path,
            Err(err) => {
                report.push(
                    Diagnostic::error(
                        "DPCS-PKG-005",
                        categories::PACKAGE,
                        format!("artifact path escapes package root `{}`: {err}", entry.path),
                    )
                    .with_object_ref(format!("artifacts[{idx}].path")),
                );
                continue;
            }
        };
        match std::fs::symlink_metadata(&path) {
            Ok(meta) if meta.file_type().is_symlink() => {
                report.push(
                    Diagnostic::error(
                        "DPCS-PKG-010",
                        categories::PACKAGE,
                        format!("artifact path must not be a symlink: {}", entry.path),
                    )
                    .with_object_ref(format!("artifacts[{idx}].path")),
                );
            }
            Ok(meta) if meta.is_file() => {}
            Ok(_) | Err(_) => {
                report.push(
                    Diagnostic::error(
                        "DPCS-PKG-006",
                        categories::PACKAGE,
                        format!("artifact file missing: {}", entry.path),
                    )
                    .with_object_ref(format!("artifacts[{idx}].path")),
                );
            }
        }
    }
    report
}

fn validate_manifest(manifest: &PackageManifest, report: &mut ValidationReport) {
    if manifest.id.trim().is_empty() {
        report.push(
            Diagnostic::error(
                "DPCS-PKG-007",
                categories::PACKAGE,
                "package id must be non-empty",
            )
            .with_object_ref("id"),
        );
    }
    if !is_valid_version(&manifest.version) {
        report.push(
            Diagnostic::error(
                "DPCS-PKG-008",
                categories::PACKAGE,
                format!("invalid package version `{}`", manifest.version),
            )
            .with_object_ref("version"),
        );
    }
    if manifest.dpcs_version.trim().is_empty() {
        report.push(
            Diagnostic::error(
                "DPCS-PKG-009",
                categories::PACKAGE,
                "package dpcsVersion must be non-empty",
            )
            .with_object_ref("dpcsVersion"),
        );
    }
}