dpcs 0.12.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

//! Package format tests.

use dpcs::{
    artifact_entry, pack, resolve_artifact, unpack, validate_package, write_manifest,
    PackageManifest,
};
use std::fs;

#[test]
fn pack_unpack_round_trip() {
    let root = tempfile::tempdir().unwrap();
    let pkg = root.path().join("demo.dpcspkg");
    fs::create_dir_all(pkg.join("artifacts")).unwrap();
    let contract = include_str!("../../../examples/minimal.dpcs.yaml");
    fs::write(pkg.join("artifacts/minimal.dpcs.yaml"), contract).unwrap();
    let mut manifest = PackageManifest {
        id: "demo".into(),
        version: "0.1.0".into(),
        ..Default::default()
    };
    manifest.artifacts.push(artifact_entry(
        "minimal",
        "pipelineContract",
        "0.1.0",
        "artifacts/minimal.dpcs.yaml",
    ));
    write_manifest(&pkg, &manifest).unwrap();
    let report = validate_package(&pkg);
    assert!(report.is_valid(), "{:?}", report.diagnostics);
    let archive = root.path().join("demo.dpcspkg.zip");
    pack(&pkg, Some(&archive)).unwrap();
    let dest = root.path().join("out");
    let layout = unpack(&archive, &dest).unwrap();
    assert_eq!(layout.manifest.id, "demo");
    let resolved = resolve_artifact(&dest, "minimal", Some("0.1.0")).unwrap();
    assert!(resolved.is_file());
}

#[test]
fn example_package_validates() {
    let path = std::path::PathBuf::from(env!("CARGO_MANIFEST_DIR"))
        .join("../..")
        .canonicalize()
        .unwrap()
        .join("examples/packages/minimal.dpcspkg");
    let report = validate_package(&path);
    assert!(report.is_valid(), "{:?}", report.diagnostics);
}

#[test]
fn rejects_path_escape_in_manifest() {
    let root = tempfile::tempdir().unwrap();
    let pkg = root.path().join("bad.dpcspkg");
    fs::create_dir_all(&pkg).unwrap();
    let mut manifest = PackageManifest {
        id: "bad".into(),
        version: "0.1.0".into(),
        ..Default::default()
    };
    manifest.artifacts.push(artifact_entry(
        "escape",
        "pipelineContract",
        "0.1.0",
        "../outside.yaml",
    ));
    write_manifest(&pkg, &manifest).unwrap();
    let report = validate_package(&pkg);
    assert!(!report.is_valid());
}

#[test]
fn pack_rejects_archive_under_package_root() {
    let root = tempfile::tempdir().unwrap();
    let pkg = root.path().join("demo.dpcspkg");
    fs::create_dir_all(pkg.join("artifacts")).unwrap();
    let contract = include_str!("../../../examples/minimal.dpcs.yaml");
    fs::write(pkg.join("artifacts/minimal.dpcs.yaml"), contract).unwrap();
    let mut manifest = PackageManifest {
        id: "demo".into(),
        version: "0.1.0".into(),
        ..Default::default()
    };
    manifest.artifacts.push(artifact_entry(
        "minimal",
        "pipelineContract",
        "0.1.0",
        "artifacts/minimal.dpcs.yaml",
    ));
    write_manifest(&pkg, &manifest).unwrap();
    let nested = pkg.join("nested/out.zip");
    let err = pack(&pkg, Some(&nested)).unwrap_err();
    let msg = format!("{err}");
    assert!(
        msg.contains("outside the package root"),
        "unexpected error: {msg}"
    );
}

#[test]
fn resolve_without_version_uses_last_match() {
    let root = tempfile::tempdir().unwrap();
    let pkg = root.path().join("demo.dpcspkg");
    fs::create_dir_all(pkg.join("artifacts")).unwrap();
    let contract = include_str!("../../../examples/minimal.dpcs.yaml");
    fs::write(pkg.join("artifacts/a.yaml"), contract).unwrap();
    fs::write(pkg.join("artifacts/b.yaml"), contract).unwrap();
    let mut manifest = PackageManifest {
        id: "demo".into(),
        version: "0.1.0".into(),
        ..Default::default()
    };
    manifest.artifacts.push(artifact_entry(
        "dup",
        "pipelineContract",
        "0.1.0",
        "artifacts/a.yaml",
    ));
    manifest.artifacts.push(artifact_entry(
        "dup",
        "pipelineContract",
        "0.2.0",
        "artifacts/b.yaml",
    ));
    write_manifest(&pkg, &manifest).unwrap();
    let resolved = resolve_artifact(&pkg, "dup", None).unwrap();
    assert!(resolved.ends_with("b.yaml"));
}