pint-pkg 0.14.0

The library implementation for Pint package management.
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163

//! Tests for creation of compilation `Plan`s.

#![allow(clippy::disallowed_names)]

use pint_pkg::manifest::PackageKind;
use util::{edit_manifest, insert_dep, new_pkg, with_temp_dir};

mod util;

#[test]
fn one_pkg() {
    with_temp_dir(|dir| {
        // Create a package.
        let name = "foo";
        let manifest = new_pkg(&dir.join(name), PackageKind::Contract);

        // Collect the member manifests (only one).
        let members = [(name.to_string(), manifest)].into_iter().collect();

        // Create the plan.
        let plan = pint_pkg::plan::from_members(&members).unwrap();
        assert_eq!(plan.graph().node_count(), 1);
        let pinned = plan.graph().node_weights().next().unwrap();
        assert_eq!(pinned.name, name);
    });
}

#[test]
fn two_pkgs() {
    with_temp_dir(|dir| {
        // Create two packages.
        let mut foo = new_pkg(&dir.join("foo"), PackageKind::Library);
        let bar = new_pkg(&dir.join("bar"), PackageKind::Library);

        // Create dependency foo -> bar.
        edit_manifest(&mut foo, |m| insert_dep(m, &bar));

        // Create the member map.
        let members = [
            (foo.pkg.name.to_string(), foo.clone()),
            (bar.pkg.name.to_string(), bar),
        ]
        .into_iter()
        .collect();

        // Create the plan.
        let plan = pint_pkg::plan::from_members(&members).unwrap();

        // Bar should be built first as foo depends on it.
        let graph = plan.graph();
        let order = plan.compilation_order();
        assert_eq!(graph[order[0]].name, "bar");
        assert_eq!(graph[order[1]].name, "foo");

        // Check that plan still works with only `foo` as member.
        let members = [(foo.pkg.name.to_string(), foo)].into_iter().collect();
        let _plan = pint_pkg::plan::from_members(&members).unwrap();
    });
}

#[test]
fn three_pkgs() {
    with_temp_dir(|dir| {
        let mut foo = new_pkg(&dir.join("foo"), PackageKind::Library);
        let mut bar = new_pkg(&dir.join("bar"), PackageKind::Library);
        let baz = new_pkg(&dir.join("baz"), PackageKind::Library);

        // Create dependencies foo -> bar -> baz.
        edit_manifest(&mut bar, |m| insert_dep(m, &baz));
        edit_manifest(&mut foo, |m| insert_dep(m, &bar));

        // Create the member map.
        let members = [
            (foo.pkg.name.to_string(), foo.clone()),
            (bar.pkg.name.to_string(), bar),
            (baz.pkg.name.to_string(), baz),
        ]
        .into_iter()
        .collect();

        // Create the plan.
        let plan = pint_pkg::plan::from_members(&members).unwrap();

        // Compilation order should be baz, bar, foo.
        let graph = plan.graph();
        let order = plan.compilation_order();
        assert_eq!(graph[order[0]].name, "baz");
        assert_eq!(graph[order[1]].name, "bar");
        assert_eq!(graph[order[2]].name, "foo");

        // Check that plan still works with only `foo` as member.
        let members = [(foo.pkg.name.to_string(), foo)].into_iter().collect();
        let _plan = pint_pkg::plan::from_members(&members).unwrap();
    });
}

#[test]
fn diamond_pkgs() {
    with_temp_dir(|dir| {
        let mut foo = new_pkg(&dir.join("foo"), PackageKind::Library);
        let mut bar = new_pkg(&dir.join("bar"), PackageKind::Library);
        let mut baz = new_pkg(&dir.join("baz"), PackageKind::Library);
        let qux = new_pkg(&dir.join("qux"), PackageKind::Library);

        // Create dependencies foo -> bar, foo -> baz, bar -> qux, baz -> qux.
        edit_manifest(&mut bar, |m| insert_dep(m, &qux));
        edit_manifest(&mut baz, |m| insert_dep(m, &qux));
        edit_manifest(&mut foo, |m| {
            insert_dep(m, &bar);
            insert_dep(m, &baz);
        });

        // Create the member map.
        let members = [
            (foo.pkg.name.to_string(), foo.clone()),
            (bar.pkg.name.to_string(), bar),
            (baz.pkg.name.to_string(), baz),
            (qux.pkg.name.to_string(), qux),
        ]
        .into_iter()
        .collect();

        // Create the plan.
        let plan = pint_pkg::plan::from_members(&members).unwrap();

        // Compilation order should be qux, bar|baz, foo.
        let graph = plan.graph();
        let order = plan.compilation_order();
        assert_eq!(graph[order[0]].name, "qux");
        assert!(matches!(&graph[order[1]].name[..], "bar" | "baz"));
        assert!(matches!(&graph[order[2]].name[..], "bar" | "baz"));
        assert_eq!(graph[order[3]].name, "foo");

        // Check that plan still works with only `foo` as member.
        let members = [(foo.pkg.name.to_string(), foo)].into_iter().collect();
        let _plan = pint_pkg::plan::from_members(&members).unwrap();
    });
}

#[test]
#[should_panic]
fn cycle() {
    with_temp_dir(|dir| {
        // Create two packages.
        let mut foo = new_pkg(&dir.join("foo"), PackageKind::Library);
        let mut bar = new_pkg(&dir.join("bar"), PackageKind::Library);

        // Create dependencies foo -> bar, bar -> foo.
        edit_manifest(&mut foo, |m| insert_dep(m, &bar));
        edit_manifest(&mut bar, |m| insert_dep(m, &foo));

        // Create the member map.
        let members = [
            (foo.pkg.name.to_string(), foo.clone()),
            (bar.pkg.name.to_string(), bar),
        ]
        .into_iter()
        .collect();

        // Create the plan, fails on detected cycle.
        let _plan = pint_pkg::plan::from_members(&members).unwrap();
    });
}