poolster-core 0.5.0-alpha.1

Language-neutral OpenAPI code generation primitives
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

use poolster_core::{GeneratedFile, GeneratedTree};

#[test]
fn generated_files_cannot_escape_the_output_directory() {
    assert!(GeneratedFile::new("../outside.ts", "").is_err());
    assert!(GeneratedFile::new("/absolute.ts", "").is_err());
    assert!(GeneratedTree::default().get("missing.ts").is_none());
}

fn tree(entries: &[(&str, &str)]) -> GeneratedTree {
    let mut tree = GeneratedTree::default();
    for (path, contents) in entries {
        tree.insert(GeneratedFile::new(path, *contents).unwrap())
            .unwrap();
    }
    tree
}

fn snapshot(root: &std::path::Path) -> std::collections::BTreeMap<std::path::PathBuf, Vec<u8>> {
    fn visit(
        root: &std::path::Path,
        directory: &std::path::Path,
        result: &mut std::collections::BTreeMap<std::path::PathBuf, Vec<u8>>,
    ) {
        for entry in std::fs::read_dir(directory).unwrap() {
            let path = entry.unwrap().path();
            if path.is_dir() {
                visit(root, &path, result);
            } else {
                result.insert(
                    path.strip_prefix(root).unwrap().into(),
                    std::fs::read(path).unwrap(),
                );
            }
        }
    }
    let mut result = std::collections::BTreeMap::new();
    visit(root, root, &mut result);
    result
}

#[test]
fn edited_stale_file_blocks_all_package_writes_and_can_be_resolved() {
    let root = tempfile::tempdir().unwrap();
    let mut original = tree(&[
        ("typescript/client.ts", "client v1"),
        ("typescript/obsolete.ts", "old operation"),
        ("go/client.go", "client v1"),
    ]);
    original
        .insert_custom(GeneratedFile::new("typescript/custom.ts", "starter").unwrap())
        .unwrap();
    original.write_to(root.path()).unwrap();
    std::fs::write(
        root.path().join("typescript/custom.ts"),
        "customer middleware",
    )
    .unwrap();
    std::fs::write(
        root.path().join("typescript/obsolete.ts"),
        "customer edited operation",
    )
    .unwrap();
    let next = tree(&[
        ("typescript/client.ts", "client v2"),
        ("typescript/new.ts", "new operation"),
        ("go/client.go", "client v2"),
    ]);
    let before = snapshot(root.path());
    assert!(next.write_to(root.path()).is_err());
    assert_eq!(
        snapshot(root.path()),
        before,
        "preflight failure must preserve every package and ownership manifest"
    );
    // Resolve the edit by restoring the previously generated bytes, then regenerate.
    std::fs::write(root.path().join("typescript/obsolete.ts"), "old operation").unwrap();
    next.write_to(root.path()).unwrap();
    assert!(!root.path().join("typescript/obsolete.ts").exists());
    assert_eq!(
        std::fs::read_to_string(root.path().join("go/client.go")).unwrap(),
        "client v2"
    );
    assert_eq!(
        std::fs::read_to_string(root.path().join("typescript/custom.ts")).unwrap(),
        "customer middleware"
    );
    assert!(next.check(root.path()).unwrap().is_empty());
}

#[test]
fn unowned_late_collision_blocks_earlier_updates_additions_and_deletions() {
    let root = tempfile::tempdir().unwrap();
    tree(&[("a/update.ts", "v1"), ("a/obsolete.ts", "remove later")])
        .write_to(root.path())
        .unwrap();
    std::fs::create_dir(root.path().join("z")).unwrap();
    std::fs::write(root.path().join("z/customer.ts"), "handwritten").unwrap();
    let next = tree(&[
        ("a/update.ts", "v2"),
        ("a/new.ts", "new"),
        ("z/customer.ts", "collision"),
    ]);
    let before = snapshot(root.path());
    assert!(next.check(root.path()).is_err());
    assert!(next.write_to(root.path()).is_err());
    assert_eq!(snapshot(root.path()), before);
}

#[test]
fn drift_check_is_read_only_and_missing_owned_files_are_repaired() {
    let root = tempfile::tempdir().unwrap();
    let generated = tree(&[
        ("typescript/client.ts", "typed client"),
        ("go/client.go", "native client"),
    ]);
    generated.write_to(root.path()).unwrap();
    std::fs::remove_file(root.path().join("typescript/client.ts")).unwrap();
    std::fs::write(root.path().join("go/client.go"), "customer edit").unwrap();
    let before = snapshot(root.path());
    let drift = generated.check(root.path()).unwrap();
    assert_eq!(
        drift.added,
        [std::path::PathBuf::from("typescript/client.ts")]
    );
    assert_eq!(drift.modified, [std::path::PathBuf::from("go/client.go")]);
    assert_eq!(snapshot(root.path()), before);
    assert!(generated.write_to(root.path()).is_err());
    assert_eq!(snapshot(root.path()), before);
    std::fs::write(root.path().join("go/client.go"), "native client").unwrap();
    generated.write_to(root.path()).unwrap();
    assert_eq!(
        std::fs::read_to_string(root.path().join("typescript/client.ts")).unwrap(),
        "typed client"
    );
    assert!(generated.check(root.path()).unwrap().is_empty());
}