cabinpkg 0.17.0

A package manager and build system for C/C++
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
164
165
166
167
168
169
170
171
172
173
174
175

//! End-to-end coverage for target-dep reference resolution: the
//! bare-name shorthand (`deps = ["foo"]` means `foo:foo`) and the
//! hard error when a dependency package declares no same-named
//! target.

use super::*;

/// Workspace whose `toolkit` package exports a target named `kit`
/// (not `toolkit`), plus an `app` whose `deps` entry is set by the
/// caller.  `app_dep` is spliced into the array verbatim, so it can
/// be a quoted string (`"\"toolkit:kit\""`) or an inline table.
fn write_shorthand_workspace(root: &Path, app_dep: &str) {
    assert_fs::fixture::ChildPath::new(root.join("cabin.toml"))
        .write_str(
            r#"[workspace]
members = ["packages/*"]
default-members = ["packages/app"]
"#,
        )
        .unwrap();
    assert_fs::fixture::ChildPath::new(root.join("packages/toolkit/cabin.toml"))
        .write_str(
            r#"[package]
name = "toolkit"
version = "0.1.0"
cxx-standard = "c++17"

[target.kit]
type = "library"
sources = ["src/kit.cc"]
include-dirs = ["include"]
"#,
        )
        .unwrap();
    assert_fs::fixture::ChildPath::new(root.join("packages/toolkit/include/kit.h"))
        .write_str("#pragma once\nint kit_value();\n")
        .unwrap();
    assert_fs::fixture::ChildPath::new(root.join("packages/toolkit/src/kit.cc"))
        .write_str("#include \"kit.h\"\nint kit_value() { return 7; }\n")
        .unwrap();
    assert_fs::fixture::ChildPath::new(root.join("packages/app/cabin.toml"))
        .write_str(&format!(
            r#"[package]
name = "app"
version = "0.1.0"
cxx-standard = "c++17"

[dependencies]
toolkit = {{ path = "../toolkit" }}

[target.app]
type = "executable"
sources = ["src/main.cc"]
deps = [{app_dep}]
"#
        ))
        .unwrap();
    assert_fs::fixture::ChildPath::new(root.join("packages/app/src/main.cc"))
        .write_str("#include \"kit.h\"\nint main() { return kit_value() == 7 ? 0 : 1; }\n")
        .unwrap();
}

#[test]
fn bare_name_without_same_name_target_fails_with_suggestion() {
    require_cxx_build_tools();
    let dir = TempDir::new().unwrap();
    // `deps = ["toolkit"]` is shorthand for `toolkit:toolkit`,
    // which does not exist; the error must not silently pick `kit`
    // as a "default library" and must suggest the qualified form.
    write_shorthand_workspace(dir.path(), "\"toolkit\"");
    cabin()
        .args(["build", "-p", "app", "--manifest-path"])
        .arg(dir.path().join("cabin.toml"))
        .arg("--build-dir")
        .arg(dir.path().join("build"))
        .assert()
        .failure()
        .stderr(predicate::str::contains(
            "no library or header-only target named \"toolkit\"",
        ))
        .stderr(predicate::str::contains("toolkit:kit"));
}

#[test]
fn qualified_reference_links_differently_named_target() {
    require_cxx_build_tools();
    let dir = TempDir::new().unwrap();
    write_shorthand_workspace(dir.path(), "\"toolkit:kit\"");
    cabin()
        .args(["build", "-p", "app", "--manifest-path"])
        .arg(dir.path().join("cabin.toml"))
        .arg("--build-dir")
        .arg(dir.path().join("build"))
        .assert()
        .success();
}

#[test]
fn public_table_form_dep_builds_like_a_string_entry() {
    require_cxx_build_tools();
    let dir = TempDir::new().unwrap();
    // `{ name = ..., public = true }` is declarative today: the
    // build must behave exactly like the string spelling.
    write_shorthand_workspace(dir.path(), r#"{ name = "toolkit:kit", public = true }"#);
    cabin()
        .args(["build", "-p", "app", "--manifest-path"])
        .arg(dir.path().join("cabin.toml"))
        .arg("--build-dir")
        .arg(dir.path().join("build"))
        .assert()
        .success();
}

#[test]
fn bare_name_shorthand_links_same_name_target() {
    require_cxx_build_tools();
    let dir = TempDir::new().unwrap();
    // Same fixture, but the dependency exports a target named like
    // the package - the shorthand resolves to `util:util`.
    assert_fs::fixture::ChildPath::new(dir.path().join("cabin.toml"))
        .write_str(
            r#"[workspace]
members = ["packages/*"]
default-members = ["packages/app"]
"#,
        )
        .unwrap();
    assert_fs::fixture::ChildPath::new(dir.path().join("packages/util/cabin.toml"))
        .write_str(
            r#"[package]
name = "util"
version = "0.1.0"
cxx-standard = "c++17"

[target.util]
type = "library"
sources = ["src/util.cc"]
include-dirs = ["include"]
"#,
        )
        .unwrap();
    assert_fs::fixture::ChildPath::new(dir.path().join("packages/util/include/util.h"))
        .write_str("#pragma once\nint util_value();\n")
        .unwrap();
    assert_fs::fixture::ChildPath::new(dir.path().join("packages/util/src/util.cc"))
        .write_str("#include \"util.h\"\nint util_value() { return 9; }\n")
        .unwrap();
    assert_fs::fixture::ChildPath::new(dir.path().join("packages/app/cabin.toml"))
        .write_str(
            r#"[package]
name = "app"
version = "0.1.0"
cxx-standard = "c++17"

[dependencies]
util = { path = "../util" }

[target.app]
type = "executable"
sources = ["src/main.cc"]
deps = ["util"]
"#,
        )
        .unwrap();
    assert_fs::fixture::ChildPath::new(dir.path().join("packages/app/src/main.cc"))
        .write_str("#include \"util.h\"\nint main() { return util_value() == 9 ? 0 : 1; }\n")
        .unwrap();
    cabin()
        .args(["build", "-p", "app", "--manifest-path"])
        .arg(dir.path().join("cabin.toml"))
        .arg("--build-dir")
        .arg(dir.path().join("build"))
        .assert()
        .success();
}