| 1 |
use crate::*; |
| 2 |
|
| 3 |
const ROOTFS: &str = "9b5c2a1e8f3d4e7a6b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a"; |
| 4 |
|
| 5 |
fn doc(body: &str) -> String { |
| 6 |
format!( |
| 7 |
"schema-version 1\n\nsandbox \"alpine\" {{\n runtime \"microvm\"\n rootfs \"cas://blob/{ROOTFS}\"\n memory-limit \"512MiB\"\n cpu-limit 2\n network \"isolated\"\n}}\n\n{body}" |
| 8 |
) |
| 9 |
} |
| 10 |
|
| 11 |
fn problems(src: &str) -> Vec<(usize, String)> { |
| 12 |
Pipeline::parse(src).unwrap_err().0.into_iter().map(|p| (p.line, p.message)).collect() |
| 13 |
} |
| 14 |
|
| 15 |
#[test] |
| 16 |
fn parses_the_m0_example() { |
| 17 |
let p = Pipeline::parse(&doc(r#"job "lint" { |
| 18 |
sandbox "alpine" |
| 19 |
scope "src/**" "README.md" |
| 20 |
env { |
| 21 |
LANG "C.UTF-8" |
| 22 |
} |
| 23 |
exec "grep" "-rn" "TODO" "src" |
| 24 |
} |
| 25 |
|
| 26 |
job "test" { |
| 27 |
sandbox "alpine" |
| 28 |
depends-on "lint" |
| 29 |
exec "sh" "-eu" "test.sh" |
| 30 |
} |
| 31 |
"#)) |
| 32 |
.unwrap(); |
| 33 |
let sb = &p.sandboxes["alpine"]; |
| 34 |
assert_eq!((sb.runtime, sb.memory_mib, sb.cpus, sb.network), (Runtime::Microvm, 512, 2, Network::Isolated)); |
| 35 |
assert_eq!(sb.rootfs, ROOTFS); |
| 36 |
let lint = &p.jobs["lint"]; |
| 37 |
assert_eq!(lint.exec, ["grep", "-rn", "TODO", "src"]); |
| 38 |
assert_eq!(lint.scope, ["src/**", "README.md"]); |
| 39 |
assert_eq!(lint.env["LANG"], "C.UTF-8"); |
| 40 |
assert_eq!(p.jobs["test"].depends_on, ["lint"]); |
| 41 |
assert_eq!(p.order().iter().map(|j| j.name.as_str()).collect::<Vec<_>>(), ["lint", "test"]); |
| 42 |
assert_eq!(p.depths()["test"], 1); |
| 43 |
} |
| 44 |
|
| 45 |
#[test] |
| 46 |
fn defaults_and_gib() { |
| 47 |
let p = Pipeline::parse(&format!( |
| 48 |
"schema-version 1\nsandbox \"s\" {{\n rootfs \"cas://blob/{ROOTFS}\"\n memory-limit \"2GiB\"\n}}\njob \"a\" {{\n sandbox \"s\"\n exec \"true\"\n}}\n" |
| 49 |
)) |
| 50 |
.unwrap(); |
| 51 |
let s = &p.sandboxes["s"]; |
| 52 |
assert_eq!((s.runtime, s.memory_mib, s.cpus, s.network), (Runtime::Microvm, 2048, 1, Network::Isolated)); |
| 53 |
} |
| 54 |
|
| 55 |
#[test] |
| 56 |
fn shell_metacharacters_stay_literal_argv() { |
| 57 |
|
| 58 |
let p = Pipeline::parse(&doc(r#"job "x" { sandbox "alpine"; exec "echo" "a; rm -rf / && $(id) | `x`" "b\nc"; }"#)).unwrap(); |
| 59 |
assert_eq!(p.jobs["x"].exec, ["echo", "a; rm -rf / && $(id) | `x`", "b\nc"]); |
| 60 |
} |
| 61 |
|
| 62 |
#[test] |
| 63 |
fn problems_carry_lines_and_are_all_reported() { |
| 64 |
let src = doc(r#"job "a" { |
| 65 |
sandbox "missing" |
| 66 |
exec "true" |
| 67 |
mount { source "oxy://workspace"; } |
| 68 |
} |
| 69 |
job "b" { |
| 70 |
sandbox "alpine" |
| 71 |
depends-on "nope" |
| 72 |
exec |
| 73 |
} |
| 74 |
flavour "x" |
| 75 |
"#); |
| 76 |
let ps = problems(&src); |
| 77 |
let has = |line: usize, text: &str| ps.iter().any(|(l, m)| *l == line && m.contains(text)); |
| 78 |
assert!(has(11, "which is not declared") && has(11, "\"missing\""), "{ps:?}"); |
| 79 |
assert!(has(14, "mount source \"oxy://workspace\" is not in M0 yet"), "{ps:?}"); |
| 80 |
assert!(has(16, "\"nope\""), "{ps:?}"); |
| 81 |
assert!(has(19, "`exec` needs a program"), "{ps:?}"); |
| 82 |
assert!(has(21, "unknown node `flavour`"), "{ps:?}"); |
| 83 |
} |
| 84 |
|
| 85 |
#[test] |
| 86 |
fn typed_values_are_not_coerced() { |
| 87 |
let src = format!( |
| 88 |
"schema-version 1\nsandbox \"s\" {{\n rootfs \"cas://blob/{ROOTFS}\"\n cpu-limit \"2\"\n memory-limit \"1.5GiB\"\n}}\njob \"a\" {{\n sandbox \"s\"\n exec \"echo\" 1\n}}\n" |
| 89 |
); |
| 90 |
let ps = problems(&src); |
| 91 |
assert!(ps.iter().any(|(l, m)| *l == 4 && m.contains("integer, not a string")), "{ps:?}"); |
| 92 |
assert!(ps.iter().any(|(l, m)| *l == 5 && m.contains("whole number")), "{ps:?}"); |
| 93 |
assert!(ps.iter().any(|(l, m)| *l == 9 && m.contains("strings, not an integer")), "{ps:?}"); |
| 94 |
} |
| 95 |
|
| 96 |
#[test] |
| 97 |
fn m0_refuses_what_it_cannot_honour() { |
| 98 |
let src = format!("schema-version 1\nsandbox \"s\" {{\n runtime \"wasm\"\n rootfs \"cas://blob/{ROOTFS}\"\n network \"egress\"\n}}\njob \"a\" {{ sandbox \"s\"; exec \"true\"; }}\n"); |
| 99 |
let ps = problems(&src); |
| 100 |
assert!(ps.iter().any(|(l, m)| *l == 3 && m.contains("wasm")), "{ps:?}"); |
| 101 |
assert!(ps.iter().any(|(l, m)| *l == 5 && m.contains("isolated")), "{ps:?}"); |
| 102 |
assert!(problems("schema-version 2\n").iter().any(|(_, m)| m.contains("schema-version 2"))); |
| 103 |
assert!(problems(&format!( |
| 104 |
"schema-version 1\nsandbox \"s\" {{ rootfs \"cas://blob/{}\"; }}\njob \"a\" {{ sandbox \"s\"; exec \"true\"; }}", |
| 105 |
&ROOTFS[..60] |
| 106 |
)) |
| 107 |
.iter() |
| 108 |
.any(|(_, m)| m.contains("64 lower-case hex"))); |
| 109 |
} |
| 110 |
|
| 111 |
#[test] |
| 112 |
fn cycles_are_found() { |
| 113 |
let ps = problems(&doc( |
| 114 |
"job \"a\" { sandbox \"alpine\"; depends-on \"c\"; exec \"true\"; }\njob \"b\" { sandbox \"alpine\"; depends-on \"a\"; exec \"true\"; }\njob \"c\" { sandbox \"alpine\"; depends-on \"b\"; exec \"true\"; }\njob \"d\" { sandbox \"alpine\"; depends-on \"d\"; exec \"true\"; }\n", |
| 115 |
)); |
| 116 |
assert!(ps.iter().any(|(_, m)| m.contains("cycle: a → c → b → a")), "{ps:?}"); |
| 117 |
assert!(ps.iter().any(|(_, m)| m.contains("\"d\" depends on itself")), "{ps:?}"); |
| 118 |
} |
| 119 |
|
| 120 |
#[test] |
| 121 |
fn invalid_kdl_has_a_line() { |
| 122 |
let ps = problems("schema-version 1\njob \"a\" {\n exec \"unterminated\n}\n"); |
| 123 |
assert!(!ps.is_empty() && ps[0].0 >= 2, "{ps:?}"); |
| 124 |
} |
| 125 |
|
| 126 |
#[test] |
| 127 |
fn canonical_form_ignores_layout_and_order() { |
| 128 |
let a = Pipeline::parse(&doc( |
| 129 |
"job \"b\" { sandbox \"alpine\"; exec \"true\"; }\njob \"a\" {\n sandbox \"alpine\"\n depends-on \"b\"\n exec \"x\"\n}\n", |
| 130 |
)) |
| 131 |
.unwrap(); |
| 132 |
let b = Pipeline::parse(&doc("// comment\njob \"a\" { exec \"x\"; depends-on \"b\"; sandbox \"alpine\"; }\n\n\njob \"b\" { exec \"true\"; sandbox \"alpine\"; }\n")).unwrap(); |
| 133 |
assert_eq!(a.canonical(), b.canonical()); |
| 134 |
assert_eq!(a.hash(), b.hash()); |
| 135 |
let c = Pipeline::parse(&doc( |
| 136 |
"job \"b\" { sandbox \"alpine\"; exec \"true\"; }\njob \"a\" { sandbox \"alpine\"; depends-on \"b\"; exec \"y\"; }\n", |
| 137 |
)) |
| 138 |
.unwrap(); |
| 139 |
assert_ne!(a.hash(), c.hash()); |
| 140 |
let sb = &a.sandboxes["alpine"]; |
| 141 |
assert_ne!(a.jobs["a"].hash(sb), c.jobs["a"].hash(sb)); |
| 142 |
assert_eq!(a.jobs["b"].hash(sb), c.jobs["b"].hash(sb), "an unchanged job keeps its hash"); |
| 143 |
|
| 144 |
oxy_core::cbor::decode(&a.canonical()).unwrap(); |
| 145 |
} |
| 146 |
|
| 147 |
#[test] |
| 148 |
fn scope_tree_hash_sees_only_the_scope() { |
| 149 |
let f = |b: u8| [b; 32]; |
| 150 |
let scope = vec!["src/**".to_string()]; |
| 151 |
let base = scope_tree_hash(&scope, [("src/a.rs", f(1)), ("README.md", f(2))]); |
| 152 |
assert_eq!(base, scope_tree_hash(&scope, [("README.md", f(9)), ("src/a.rs", f(1))]), "outside the scope, and order, do not count"); |
| 153 |
assert_ne!(base, scope_tree_hash(&scope, [("src/a.rs", f(3)), ("README.md", f(2))])); |
| 154 |
assert_ne!(scope_tree_hash(&[], [("README.md", f(2))]), scope_tree_hash(&[], [("README.md", f(9))]), "no scope is the whole tree"); |
| 155 |
} |
| 156 |
|
| 157 |
#[test] |
| 158 |
fn receipts_hash_as_oxygen_objects() { |
| 159 |
let r = Receipt { |
| 160 |
job_name: "lint".into(), |
| 161 |
pipeline_hash: [1; 32], |
| 162 |
scope_tree_hash: [2; 32], |
| 163 |
inputs: vec![], |
| 164 |
environment: [3; 32], |
| 165 |
outputs: vec![], |
| 166 |
exit_code: 0, |
| 167 |
duration_ms: 1234, |
| 168 |
}; |
| 169 |
let body = r.encode(); |
| 170 |
let mut want = format!("oxy1 receipt {}\0", body.len()).into_bytes(); |
| 171 |
want.extend_from_slice(&body); |
| 172 |
assert_eq!(r.hash(), *blake3::hash(&want).as_bytes()); |
| 173 |
let json = serde_json::to_string(&r).unwrap(); |
| 174 |
assert_eq!(serde_json::from_str::<Receipt>(&json).unwrap(), r); |
| 175 |
|
| 176 |
assert_eq!(r.to_oxy().hash().0, r.hash()); |
| 177 |
assert_eq!(r.to_oxy().encode(), body); |
| 178 |
let mut r2 = r.clone(); |
| 179 |
r2.exit_code = 1; |
| 180 |
assert_ne!(r.hash(), r2.hash()); |
| 181 |
} |
| 182 |
|
| 183 |
#[test] |
| 184 |
fn ephemeral_mounts_parse_sort_and_hash() { |
| 185 |
let plain = Pipeline::parse(&doc("job \"b\" {\n sandbox \"alpine\"\n exec \"cargo\" \"build\"\n}\n")).unwrap(); |
| 186 |
let p = Pipeline::parse(&doc(r#"job "b" { |
| 187 |
sandbox "alpine" |
| 188 |
mount { |
| 189 |
source "ephemeral://tmpfs" |
| 190 |
target "/tmp/cache" |
| 191 |
size "256MiB" |
| 192 |
} |
| 193 |
mount { |
| 194 |
source "ephemeral://disk" |
| 195 |
target "/src/target" |
| 196 |
size "8GiB" |
| 197 |
} |
| 198 |
exec "cargo" "build" |
| 199 |
} |
| 200 |
"#)) |
| 201 |
.unwrap(); |
| 202 |
let b = &p.jobs["b"]; |
| 203 |
assert_eq!( |
| 204 |
b.mounts, |
| 205 |
vec![ |
| 206 |
Mount { source: MountSource::Disk, target: "/src/target".into(), size_mib: 8192 }, |
| 207 |
Mount { source: MountSource::Tmpfs, target: "/tmp/cache".into(), size_mib: 256 }, |
| 208 |
], |
| 209 |
"sorted by target" |
| 210 |
); |
| 211 |
assert_ne!(p.hash(), plain.hash(), "mounts are part of the job"); |
| 212 |
|
| 213 |
let v = oxy_core::cbor::decode(&plain.canonical()).unwrap(); |
| 214 |
let text = format!("{v:?}"); |
| 215 |
assert!(!text.contains("ephemeral"), "{text}"); |
| 216 |
let json = serde_json::to_value(&plain.jobs["b"]).unwrap(); |
| 217 |
assert!(json.get("mounts").is_none(), "absent from the API too"); |
| 218 |
let back: Job = serde_json::from_value(json).unwrap(); |
| 219 |
assert!(back.mounts.is_empty()); |
| 220 |
} |
| 221 |
|
| 222 |
#[test] |
| 223 |
fn mounts_are_checked() { |
| 224 |
let job = |mount: &str| doc(&format!("job \"b\" {{\n sandbox \"alpine\"\n mount {{\n{mount}\n }}\n exec \"true\"\n}}\n")); |
| 225 |
let has = |src: String, want: &str| { |
| 226 |
let ps = problems(&src); |
| 227 |
assert!(ps.iter().any(|(_, m)| m.contains(want)), "{want:?} not in {ps:?}"); |
| 228 |
}; |
| 229 |
has(job("source \"oxy://workspace\"\ntarget \"/src/x\"\nsize \"1GiB\""), "not in M0 yet"); |
| 230 |
has(job("source \"ephemeral://disk\"\ntarget \"/etc/x\"\nsize \"1GiB\""), "under /src or /tmp"); |
| 231 |
has(job("source \"ephemeral://disk\"\ntarget \"/src\"\nsize \"1GiB\""), "under /src or /tmp"); |
| 232 |
has(job("source \"ephemeral://disk\"\ntarget \"/src/../etc\"\nsize \"1GiB\""), "without . or .."); |
| 233 |
has(job("source \"ephemeral://disk\"\ntarget \"/src/x/\"\nsize \"1GiB\""), "trailing /"); |
| 234 |
has(job("source \"ephemeral://disk\"\ntarget \"/src/x\"\nsize \"8MiB\""), "from 16MiB to 64GiB"); |
| 235 |
has(job("source \"ephemeral://disk\"\ntarget \"/src/x\"\nsize \"65GiB\""), "from 16MiB to 64GiB"); |
| 236 |
has(job("source \"ephemeral://disk\"\ntarget \"/src/x\"\nsize \"lots\""), "whole number"); |
| 237 |
has(job("source \"ephemeral://disk\"\ntarget \"/src/x\""), "needs a size"); |
| 238 |
has(job("source \"ephemeral://disk\"\ntarget \"/src/x\"\nsize \"1GiB\"\nreadonly #true"), "`readonly` is not in M0 yet"); |
| 239 |
has(job("source \"ephemeral://disk\"\nsource \"ephemeral://tmpfs\"\ntarget \"/src/x\"\nsize \"1GiB\""), "given twice"); |
| 240 |
let two = |a: &str, b: &str| { |
| 241 |
doc(&format!( |
| 242 |
"job \"b\" {{\n sandbox \"alpine\"\n mount {{ source \"ephemeral://disk\"; target \"{a}\"; size \"1GiB\"; }}\n mount {{ source \"ephemeral://disk\"; target \"{b}\"; size \"1GiB\"; }}\n exec \"true\"\n}}\n" |
| 243 |
)) |
| 244 |
}; |
| 245 |
has(two("/src/t", "/src/t/deps"), "overlaps"); |
| 246 |
has(two("/src/t", "/src/t"), "overlaps"); |
| 247 |
assert!(Pipeline::parse(&two("/src/t", "/src/tt")).is_ok(), "a shared prefix is not nesting"); |
| 248 |
let five: String = |
| 249 |
(0..5).map(|i| format!(" mount {{ source \"ephemeral://tmpfs\"; target \"/tmp/m{i}\"; size \"16MiB\"; }}\n")).collect(); |
| 250 |
has(doc(&format!("job \"b\" {{\n sandbox \"alpine\"\n{five} exec \"true\"\n}}\n")), "at most 4 mounts"); |
| 251 |
} |
| 252 |
|
| 253 |
#[test] |
| 254 |
fn loopback_is_in_m0_and_egress_is_not() { |
| 255 |
let src = |net: &str| { |
| 256 |
format!("schema-version 1\nsandbox \"s\" {{\n rootfs \"cas://blob/{ROOTFS}\"\n network \"{net}\"\n}}\njob \"a\" {{ sandbox \"s\"; exec \"true\"; }}\n") |
| 257 |
}; |
| 258 |
let p = Pipeline::parse(&src("loopback")).unwrap(); |
| 259 |
assert_eq!(p.sandboxes["s"].network, Network::Loopback); |
| 260 |
assert_ne!(p.hash(), Pipeline::parse(&src("isolated")).unwrap().hash(), "the network is part of the sandbox"); |
| 261 |
assert!(problems(&src("egress")).iter().any(|(l, m)| *l == 4 && m.contains("not in M0"))); |
| 262 |
} |
| 263 |
|
| 264 |
#[test] |
| 265 |
fn secrets_mount_as_files_and_are_part_of_the_job() { |
| 266 |
let plain = Pipeline::parse(&doc("job \"d\" {\n sandbox \"alpine\"\n exec \"deploy\"\n}\n")).unwrap(); |
| 267 |
let p = Pipeline::parse(&doc(r#"job "d" { |
| 268 |
sandbox "alpine" |
| 269 |
secret "token" { |
| 270 |
mount-path "/run/secrets/token" |
| 271 |
} |
| 272 |
secret "aws" { |
| 273 |
mount-path "/run/secrets/aws/credentials" |
| 274 |
} |
| 275 |
exec "deploy" |
| 276 |
}"#)) |
| 277 |
.unwrap(); |
| 278 |
let d = &p.jobs["d"]; |
| 279 |
assert_eq!( |
| 280 |
d.secrets, |
| 281 |
vec![ |
| 282 |
Secret { name: "aws".into(), mount_path: "/run/secrets/aws/credentials".into() }, |
| 283 |
Secret { name: "token".into(), mount_path: "/run/secrets/token".into() }, |
| 284 |
], |
| 285 |
"sorted by name" |
| 286 |
); |
| 287 |
assert_ne!(p.hash(), plain.hash(), "secrets are part of the job"); |
| 288 |
for (bad, why) in [ |
| 289 |
("secret \"t\" {\n mount-path \"/tmp/t\"\n}", "under /run/secrets/"), |
| 290 |
("secret \"t\" {\n mount-path \"/run/secrets/../x\"\n}", "under /run/secrets/"), |
| 291 |
("secret \"t\" {\n}", "needs a mount-path"), |
| 292 |
("secret \"t\" {\n mount-path \"/run/secrets/a\"\n}\nsecret \"t\" {\n mount-path \"/run/secrets/b\"\n}", "given twice"), |
| 293 |
( |
| 294 |
"secret \"t\" {\n mount-path \"/run/secrets/a\"\n}\nsecret \"u\" {\n mount-path \"/run/secrets/a\"\n}", |
| 295 |
"two files mount at", |
| 296 |
), |
| 297 |
("secret \"t\" {\n vault-ref \"x\"\n mount-path \"/run/secrets/a\"\n}", "vault-ref"), |
| 298 |
] { |
| 299 |
let e = Pipeline::parse(&doc(&format!("job \"d\" {{\n sandbox \"alpine\"\n {bad}\n exec \"deploy\"\n}}\n"))).unwrap_err(); |
| 300 |
assert!(e.to_string().contains(why), "{bad}: {e}"); |
| 301 |
} |
| 302 |
} |
| 303 |
|
| 304 |
#[test] |
| 305 |
fn identities_are_asked_for_by_audience_and_mount_like_secrets() { |
| 306 |
let plain = Pipeline::parse(&doc("job \"d\" {\n sandbox \"alpine\"\n exec \"deploy\"\n}\n")).unwrap(); |
| 307 |
let p = Pipeline::parse(&doc(r#"job "d" { |
| 308 |
sandbox "alpine" |
| 309 |
identity "sts.amazonaws.com" { |
| 310 |
mount-path "/run/secrets/aws-token" |
| 311 |
} |
| 312 |
identity "https://vault.example" { |
| 313 |
mount-path "/run/secrets/vault-token" |
| 314 |
} |
| 315 |
secret "key" { |
| 316 |
mount-path "/run/secrets/key" |
| 317 |
} |
| 318 |
exec "deploy" |
| 319 |
}"#)) |
| 320 |
.unwrap(); |
| 321 |
let d = &p.jobs["d"]; |
| 322 |
assert_eq!( |
| 323 |
d.identities.iter().map(|i| i.audience.as_str()).collect::<Vec<_>>(), |
| 324 |
["https://vault.example", "sts.amazonaws.com"], |
| 325 |
"sorted" |
| 326 |
); |
| 327 |
assert_ne!(p.hash(), plain.hash(), "identities are part of the job"); |
| 328 |
for (bad, why) in [ |
| 329 |
("identity \"a b\" {\n mount-path \"/run/secrets/x\"\n}", "without spaces"), |
| 330 |
("identity \"a\" {\n mount-path \"/tmp/x\"\n}", "under /run/secrets/"), |
| 331 |
("identity \"a\" {\n}", "needs a mount-path"), |
| 332 |
("identity \"a\" {\n mount-path \"/run/secrets/x\"\n}\nidentity \"a\" {\n mount-path \"/run/secrets/y\"\n}", "given twice"), |
| 333 |
( |
| 334 |
"identity \"a\" {\n mount-path \"/run/secrets/x\"\n}\nsecret \"s\" {\n mount-path \"/run/secrets/x\"\n}", |
| 335 |
"two files mount at", |
| 336 |
), |
| 337 |
] { |
| 338 |
let e = Pipeline::parse(&doc(&format!("job \"d\" {{\n sandbox \"alpine\"\n {bad}\n exec \"deploy\"\n}}\n"))).unwrap_err(); |
| 339 |
assert!(e.to_string().contains(why), "{bad}: {e}"); |
| 340 |
} |
| 341 |
} |
| 342 |
|
| 343 |
#[test] |
| 344 |
fn a_sandbox_may_name_its_architecture() { |
| 345 |
let plain = Pipeline::parse(&doc("job \"b\" {\n sandbox \"alpine\"\n exec \"make\"\n}\n")).unwrap(); |
| 346 |
assert_eq!(plain.sandboxes["alpine"].arch, None); |
| 347 |
let src = |
| 348 |
doc("job \"b\" {\n sandbox \"alpine\"\n exec \"make\"\n}\n").replace("memory-limit", "arch \"riscv64\"\n memory-limit"); |
| 349 |
let p = Pipeline::parse(&src).unwrap(); |
| 350 |
assert_eq!(p.sandboxes["alpine"].arch.as_deref(), Some("riscv64")); |
| 351 |
assert_ne!(p.hash(), plain.hash(), "the architecture is part of the sandbox"); |
| 352 |
let bad = src.replace("riscv64", "RISC V"); |
| 353 |
assert!(Pipeline::parse(&bad).unwrap_err().to_string().contains("not an architecture name")); |
| 354 |
assert!(arch_ok("x86_64") && arch_ok("aarch64") && !arch_ok("x") && !arch_ok("A64")); |
| 355 |
} |
| 356 |
|
| 357 |
#[test] |
| 358 |
fn jobs_are_told_what_they_build() { |
| 359 |
let p = Pipeline::parse(&doc(r#"job "build" { |
| 360 |
sandbox "alpine" |
| 361 |
env { |
| 362 |
FLOW_BOOKMARK "pinned-by-the-pipeline" |
| 363 |
} |
| 364 |
exec "make" |
| 365 |
}"#)) |
| 366 |
.unwrap(); |
| 367 |
let job = p.jobs["build"].clone(); |
| 368 |
let claim = crate::api::Claim { |
| 369 |
job_id: 7, |
| 370 |
run_id: 40, |
| 371 |
repo: "andy/demo".into(), |
| 372 |
clone_url: "https://hub/andy/demo".into(), |
| 373 |
token: "t".into(), |
| 374 |
heads: vec!["aa".into(), "bb".into()], |
| 375 |
pipeline_hash: "00".into(), |
| 376 |
job: job.clone(), |
| 377 |
sandbox: p.sandboxes["alpine"].clone(), |
| 378 |
timeout_s: 60, |
| 379 |
subrepos: vec![], |
| 380 |
state: "cc".into(), |
| 381 |
bookmark: "feature/x".into(), |
| 382 |
run_number: 3, |
| 383 |
env: [("CC".to_string(), "clang".to_string()), ("FLOW_REPO".to_string(), "spoofed".to_string())].into_iter().collect(), |
| 384 |
secrets: vec![], |
| 385 |
}; |
| 386 |
let env = job.with_flow_env(&claim.flow_env()).env; |
| 387 |
assert_eq!(env["CC"], "clang", "the hub's variables reach the job"); |
| 388 |
assert_eq!(env["FLOW_REPO"], "andy/demo", "a hub variable cannot pose as a FLOW_ fact"); |
| 389 |
assert_eq!(env["FLOW_HEADS"], "aa+bb"); |
| 390 |
assert_eq!(env["FLOW_STATE"], "cc"); |
| 391 |
assert_eq!(env["FLOW_RUN"], "3", "the run's number in its repository, not the hub's id"); |
| 392 |
assert_eq!(env["FLOW_JOB"], "build"); |
| 393 |
assert_eq!(env["FLOW_BOOKMARK"], "pinned-by-the-pipeline", "the pipeline's own value wins"); |
| 394 |
|
| 395 |
let old = crate::api::Claim { |
| 396 |
state: String::new(), |
| 397 |
bookmark: String::new(), |
| 398 |
run_number: 0, |
| 399 |
env: Default::default(), |
| 400 |
secrets: vec![], |
| 401 |
..claim |
| 402 |
}; |
| 403 |
let names: Vec<String> = old.flow_env().into_iter().map(|(k, _)| k).collect(); |
| 404 |
assert_eq!(names, ["FLOW_REPO", "FLOW_HEADS", "FLOW_JOB"]); |
| 405 |
} |
| 406 |
|
| 407 |
#[test] |
| 408 |
fn a_sandbox_env_is_where_jobs_start() { |
| 409 |
let src = |sandbox_env: &str| { |
| 410 |
format!( |
| 411 |
"schema-version 1\nsandbox \"mos\" {{\n rootfs \"cas://blob/{ROOTFS}\"\n{sandbox_env}}}\njob \"build\" {{\n sandbox \"mos\"\n env {{\n X16EMU \"/opt/job\"\n }}\n exec \"make\"\n}}\n" |
| 412 |
) |
| 413 |
}; |
| 414 |
let with = |
| 415 |
Pipeline::parse(&src(" env {\n PATH \"/opt/llvm-mos/bin:/usr/bin:/bin\"\n X16EMU \"/opt/x16emu\"\n }\n")) |
| 416 |
.unwrap(); |
| 417 |
let sb = &with.sandboxes["mos"]; |
| 418 |
assert_eq!(sb.env["PATH"], "/opt/llvm-mos/bin:/usr/bin:/bin"); |
| 419 |
let job = with.jobs["build"].in_sandbox(sb); |
| 420 |
assert_eq!(job.env["PATH"], "/opt/llvm-mos/bin:/usr/bin:/bin", "from the sandbox"); |
| 421 |
assert_eq!(job.env["X16EMU"], "/opt/job", "the job's own value wins"); |
| 422 |
|
| 423 |
|
| 424 |
let without = Pipeline::parse(&src("")).unwrap(); |
| 425 |
assert!(without.sandboxes["mos"].env.is_empty()); |
| 426 |
assert_ne!(with.hash(), without.hash()); |
| 427 |
let bad = problems(&src(" env {\n BAD-NAME \"x\"\n }\n")); |
| 428 |
assert!(bad.iter().any(|(_, m)| m.contains("letters, digits and _")), "{bad:?}"); |
| 429 |
} |
| 430 |
|
| 431 |
#[test] |
| 432 |
fn artifacts_are_declared_checked_and_hashed() { |
| 433 |
let src = |out: &str| { |
| 434 |
doc(&format!( |
| 435 |
"job \"build\" {{\n sandbox \"alpine\"\n mount {{\n source \"ephemeral://disk\"\n target \"/src/target\"\n size \"1GiB\"\n }}\n mount {{\n source \"ephemeral://tmpfs\"\n target \"/src/tmp\"\n size \"64MiB\"\n }}\n exec \"make\"\n{out}}}\n" |
| 436 |
)) |
| 437 |
}; |
| 438 |
let p = Pipeline::parse(&src( |
| 439 |
" output {\n artifact \"tool\" {\n path \"/src/target/release/tool\"\n format \"blob\"\n }\n artifact \"docs\" {\n path \"/src/docs/tool.1\"\n }\n }\n", |
| 440 |
)) |
| 441 |
.unwrap(); |
| 442 |
let names: Vec<(&str, &str)> = p.jobs["build"].outputs.iter().map(|o| (o.name.as_str(), o.path.as_str())).collect(); |
| 443 |
assert_eq!(names, [("docs", "/src/docs/tool.1"), ("tool", "/src/target/release/tool")], "sorted by name"); |
| 444 |
|
| 445 |
let plain = Pipeline::parse(&src("")).unwrap(); |
| 446 |
let sb = &p.sandboxes["alpine"]; |
| 447 |
assert_ne!(p.jobs["build"].hash(sb), plain.jobs["build"].hash(sb)); |
| 448 |
assert!(plain.jobs["build"].outputs.is_empty()); |
| 449 |
let json = serde_json::to_string(&plain.jobs["build"]).unwrap(); |
| 450 |
assert!(!json.contains("outputs"), "no outputs field when there are none: {json}"); |
| 451 |
|
| 452 |
let bad = |out: &str| problems(&src(out)).into_iter().map(|(_, m)| m).collect::<Vec<_>>().join("\n"); |
| 453 |
assert!(bad(" output {\n artifact \"x\" {\n path \"/etc/passwd\"\n }\n }\n") |
| 454 |
.contains("must be an absolute path under /src")); |
| 455 |
assert!(bad(" output {\n artifact \"x\" {\n path \"/src/../etc\"\n }\n }\n") |
| 456 |
.contains("must be an absolute path under /src")); |
| 457 |
assert!(bad(" output {\n artifact \"x\" {\n path \"/src/tmp/a\"\n }\n }\n").contains("tmpfs")); |
| 458 |
assert!(bad(" output {\n artifact \"x\" {\n }\n }\n").contains("needs a path")); |
| 459 |
assert!(bad(" output {\n artifact \"x\" {\n path \"/src/a\"\n }\n artifact \"x\" {\n path \"/src/b\"\n }\n }\n") |
| 460 |
.contains("given twice")); |
| 461 |
assert!(bad(" output {\n artifact \"x\" {\n path \"/src/a\"\n format \"tar\"\n }\n }\n") |
| 462 |
.contains("format")); |
| 463 |
} |
| 464 |
|
| 465 |
|
| 466 |
|
| 467 |
#[test] |
| 468 |
fn ansi_escapes_are_written_as_unicode() { |
| 469 |
let bad = problems(&doc("job \"a\" {\n sandbox \"alpine\"\n exec \"printf\" \"\\033[32mok\\033[0m\"\n}\n")); |
| 470 |
assert!(bad.iter().any(|(line, m)| *line == 13 && m.contains("\\u{1b}")), "{bad:?}"); |
| 471 |
let p = Pipeline::parse(&doc("job \"a\" {\n sandbox \"alpine\"\n exec \"printf\" \"\\u{1b}[32mok\\u{1b}[0m\"\n}\n")).unwrap(); |
| 472 |
assert_eq!(p.jobs["a"].exec[1], "\u{1b}[32mok\u{1b}[0m"); |
| 473 |
} |
| 474 |
|
| 475 |
#[test] |
| 476 |
fn runs_on_asks_for_runner_labels() { |
| 477 |
let src = doc("job \"cross\" {\n sandbox \"alpine\"\n runs-on \"riscv64\" \"big-disk\"\n exec \"make\"\n}\n") |
| 478 |
.replace(" network", " runs-on \"gpu\"\n network"); |
| 479 |
let p = Pipeline::parse(&src).unwrap(); |
| 480 |
let job = &p.jobs["cross"]; |
| 481 |
assert_eq!(job.runs_on, vec!["big-disk", "riscv64"], "sorted"); |
| 482 |
let sandbox = &p.sandboxes["alpine"]; |
| 483 |
assert_eq!(sandbox.runs_on, vec!["gpu"]); |
| 484 |
assert_eq!(job.in_sandbox(sandbox).runs_on, vec!["big-disk", "gpu", "riscv64"], "with its sandbox's"); |
| 485 |
|
| 486 |
let plain = Pipeline::parse(&doc("job \"x\" {\n sandbox \"alpine\"\n exec \"true\"\n}\n")).unwrap(); |
| 487 |
assert!(!serde_json::to_string(&plain.jobs["x"]).unwrap().contains("runs_on")); |
| 488 |
let bad = problems(&doc("job \"x\" {\n sandbox \"alpine\"\n runs-on \"RISCV\"\n exec \"true\"\n}\n")); |
| 489 |
assert!(bad.iter().any(|(_, m)| m.contains("a label is lower-case")), "{bad:?}"); |
| 490 |
let none = problems(&doc("job \"y\" {\n sandbox \"alpine\"\n runs-on\n exec \"true\"\n}\n")); |
| 491 |
assert!(none.iter().any(|(_, m)| m.contains("needs one or more labels")), "{none:?}"); |
| 492 |
} |
| 493 |
|
| 494 |
|
| 495 |
|
| 496 |
#[test] |
| 497 |
fn a_job_says_how_long_it_may_run() { |
| 498 |
use crate::pipeline::{parse_duration, Pipeline}; |
| 499 |
assert_eq!(parse_duration("90m"), Some(5400)); |
| 500 |
assert_eq!(parse_duration("1h30m"), Some(5400)); |
| 501 |
assert_eq!(parse_duration("2h"), Some(7200)); |
| 502 |
assert_eq!(parse_duration("45s"), Some(45)); |
| 503 |
for bad in ["", "90", "m", "30m1h", "1h1h", "2d", "-1h"] { |
| 504 |
assert_eq!(parse_duration(bad), None, "{bad:?}"); |
| 505 |
} |
| 506 |
let root = "a".repeat(64); |
| 507 |
let text = format!( |
| 508 |
"schema-version 1\nsandbox \"s\" {{\n runtime \"microvm\"\n rootfs \"cas://blob/{root}\"\n memory-limit \"1GiB\"\n cpu-limit 1\n network \"isolated\"\n timeout \"2h\"\n}}\njob \"long\" {{\n sandbox \"s\"\n timeout \"3h30m\"\n exec \"true\"\n}}\njob \"plain\" {{\n sandbox \"s\"\n exec \"true\"\n}}\n" |
| 509 |
); |
| 510 |
let p = Pipeline::parse(&text).unwrap(); |
| 511 |
let job = |n: &str| p.jobs[n].in_sandbox(&p.sandboxes["s"]); |
| 512 |
assert_eq!(job("long").timeout_s, Some(12600), "the job's own"); |
| 513 |
assert_eq!(job("plain").timeout_s, Some(7200), "the sandbox's"); |
| 514 |
let bad = text.replace("timeout \"3h30m\"", "timeout \"2d\""); |
| 515 |
assert!(Pipeline::parse(&bad).unwrap_err().to_string().contains("timeout")); |
| 516 |
let long = text.replace("timeout \"3h30m\"", "timeout \"25h\""); |
| 517 |
assert!(Pipeline::parse(&long).unwrap_err().to_string().contains("from 1m to 24h")); |
| 518 |
} |
| 519 |
|
| 520 |
|
| 521 |
|
| 522 |
#[test] |
| 523 |
fn on_says_what_starts_a_job() { |
| 524 |
use crate::pipeline::{Event, Pipeline}; |
| 525 |
let root = "a".repeat(64); |
| 526 |
let text = format!( |
| 527 |
"schema-version 1\non {{\n push \"main\" \"feature/*\"\n manual\n}}\nsandbox \"s\" {{\n runtime \"microvm\"\n rootfs \"cas://blob/{root}\"\n memory-limit \"1GiB\"\n cpu-limit 1\n network \"isolated\"\n}}\njob \"test\" {{\n sandbox \"s\"\n exec \"true\"\n}}\njob \"dist\" {{\n sandbox \"s\"\n on {{\n tag \"v*\"\n manual\n }}\n exec \"true\"\n}}\njob \"nightly\" {{\n sandbox \"s\"\n on {{\n schedule \"0 3 * * *\"\n }}\n exec \"true\"\n}}\n" |
| 528 |
); |
| 529 |
let p = Pipeline::parse(&text).unwrap(); |
| 530 |
let runs = |job: &str, e: Event| p.on_of(&p.jobs[job]).matches(e); |
| 531 |
assert!(runs("test", Event::Push("main")) && runs("test", Event::Push("feature/9-x"))); |
| 532 |
assert!(!runs("test", Event::Push("develop")), "not a bookmark the pipeline names"); |
| 533 |
assert!(!runs("test", Event::Tag("v1.0.0")) && runs("test", Event::Manual)); |
| 534 |
assert!(runs("dist", Event::Tag("v0.3.1")) && !runs("dist", Event::Tag("nightly"))); |
| 535 |
assert!(!runs("dist", Event::Push("main")) && runs("dist", Event::Manual)); |
| 536 |
assert!(runs("nightly", Event::Schedule) && !runs("nightly", Event::Manual)); |
| 537 |
|
| 538 |
let plain = text.replace("on {\n push \"main\" \"feature/*\"\n manual\n}\n", ""); |
| 539 |
let p = Pipeline::parse(&plain).unwrap(); |
| 540 |
assert!(p.on_of(&p.jobs["test"]).matches(Event::Push("anything")) && p.on_of(&p.jobs["test"]).matches(Event::Manual)); |
| 541 |
for (bad, why) in [ |
| 542 |
("on {\n}\n", "names no event"), |
| 543 |
("on {\n when \"x\"\n}\n", "unknown `on` event"), |
| 544 |
("on {\n schedule \"0 3 * *\"\n}\n", "five cron fields"), |
| 545 |
] { |
| 546 |
let t = format!("{bad}{plain}"); |
| 547 |
let e = Pipeline::parse(&t).unwrap_err().to_string(); |
| 548 |
assert!(e.contains(why), "{bad:?}: {e}"); |
| 549 |
} |
| 550 |
} |