Skip to content

Commit a92b55e

Browse files
jieyouxujieyouxu
committed
Enforce PR CI jobs are a subset of Auto CI jobs (modulo carve-outs)
To prevent possibility of a PR with red PR-only CI passing Auto CI, then all subsequent PR CI runs will be red until that is fixed. Note that this is **not** a "strict" subset relationship: some jobs necessarily have to differ under PR CI and Auto CI environments. For instance: - `x86_64-gnu-tools` will have auto-only env vars like `DEPLOY_TOOLSTATES_JSON: toolstates-linux.json`. - `tidy` will want to `continue_on_error: true` in PR CI to allow for more "useful" compilation errors to also be reported, whereas it needs to `continue_on_error: false` in Auto CI to prevent wasting Auto CI resources. The carve-outs are: 1. `env` variables. 2. `continue_on_error`.
1 parent 460259d commit a92b55e

File tree

3 files changed

+330
-5
lines changed

3 files changed

+330
-5
lines changed

‎src/ci/citool/src/jobs.rs

Lines changed: 109 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
#[cfg(test)]
22
mod tests;
33

4-
use std::collections::BTreeMap;
4+
use std::collections::{BTreeMap, HashSet};
55

6-
use anyhow::Context as _;
6+
use anyhow::{Context as _, anyhow};
77
use serde_yaml::Value;
88

99
use crate::GitHubContext;
@@ -58,6 +58,7 @@ struct JobEnvironments {
5858
auto_env: BTreeMap<String, Value>,
5959
}
6060

61+
/// Raw [`JobDatabase`] that matches the YAML job definition more closely.
6162
#[derive(serde::Deserialize, Debug)]
6263
pub struct JobDatabase {
6364
#[serde(rename = "pr")]
@@ -97,14 +98,118 @@ pub fn load_job_db(db: &str) -> anyhow::Result<JobDatabase> {
9798
db.apply_merge().context("failed to apply merge keys")
9899
};
99100

100-
// Apply merge twice to handle nested merges
101+
// Apply merge twice to handle nested merges up to depth 2.
101102
apply_merge(&mut db)?;
102103
apply_merge(&mut db)?;
103104

104-
let db: JobDatabase = serde_yaml::from_value(db).context("failed to parse job database")?;
105+
let mut db: JobDatabase = serde_yaml::from_value(db).context("failed to parse job database")?;
106+
107+
register_pr_jobs_as_auto_jobs(&mut db)?;
108+
109+
validate_job_database(&db)?;
110+
105111
Ok(db)
106112
}
107113

114+
/// Maintain invariant that PR CI jobs must be a subset of Auto CI jobs modulo carve-outs.
115+
///
116+
/// When PR jobs are auto-registered as Auto jobs, they will have `continue_on_error` overridden to
117+
/// be `false` to avoid wasting Auto CI resources.
118+
///
119+
/// When a job is already both a PR job and a auto job, we will post-validate their "equivalence
120+
/// modulo certain carve-outs" in [`validate_job_database`].
121+
///
122+
/// This invariant is important to make sure that it's not easily possible (without modifying
123+
/// `citool`) to have PRs with red PR-only CI jobs merged into `master`, causing all subsequent PR
124+
/// CI runs to be red until the cause is fixed.
125+
fn register_pr_jobs_as_auto_jobs(db: &mut JobDatabase) -> anyhow::Result<()> {
126+
for pr_job in &db.pr_jobs {
127+
// It's acceptable to "override" a PR job in Auto job, for instance, `x86_64-gnu-tools` will
128+
// receive an additional `DEPLOY_TOOLSTATES_JSON: toolstates-linux.json` env when under Auto
129+
// environment versus PR environment.
130+
if db.auto_jobs.iter().any(|auto_job| auto_job.name == pr_job.name) {
131+
continue;
132+
}
133+
134+
let auto_registered_job = Job { continue_on_error: Some(false), ..pr_job.clone() };
135+
db.auto_jobs.push(auto_registered_job);
136+
}
137+
138+
Ok(())
139+
}
140+
141+
fn validate_job_database(db: &JobDatabase) -> anyhow::Result<()> {
142+
fn ensure_no_duplicate_job_names(section: &str, jobs: &Vec<Job>) -> anyhow::Result<()> {
143+
let mut job_names = HashSet::new();
144+
for job in jobs {
145+
let job_name = job.name.as_str();
146+
if !job_names.insert(job_name) {
147+
return Err(anyhow::anyhow!(
148+
"duplicate job name `{job_name}` in section `{section}`"
149+
));
150+
}
151+
}
152+
Ok(())
153+
}
154+
155+
ensure_no_duplicate_job_names("pr", &db.pr_jobs)?;
156+
ensure_no_duplicate_job_names("auto", &db.auto_jobs)?;
157+
ensure_no_duplicate_job_names("try", &db.try_jobs)?;
158+
ensure_no_duplicate_job_names("optional", &db.optional_jobs)?;
159+
160+
fn equivalent_modulo_carve_out(pr_job: &Job, auto_job: &Job) -> anyhow::Result<()> {
161+
let Job {
162+
name,
163+
os,
164+
only_on_channel,
165+
free_disk,
166+
doc_url,
167+
codebuild,
168+
169+
// Carve-out configs allowed to be different.
170+
env: _,
171+
continue_on_error: _,
172+
} = pr_job;
173+
174+
if *name == auto_job.name
175+
&& *os == auto_job.os
176+
&& *only_on_channel == auto_job.only_on_channel
177+
&& *free_disk == auto_job.free_disk
178+
&& *doc_url == auto_job.doc_url
179+
&& *codebuild == auto_job.codebuild
180+
{
181+
Ok(())
182+
} else {
183+
Err(anyhow!(
184+
"PR job `{}` differs from corresponding Auto job `{}` in configuration other than `continue_on_error` and `env`",
185+
pr_job.name,
186+
auto_job.name
187+
))
188+
}
189+
}
190+
191+
for pr_job in &db.pr_jobs {
192+
let Some(auto_job) = db.auto_jobs.iter().find(|auto_job| auto_job.name == pr_job.name)
193+
else {
194+
continue;
195+
};
196+
197+
equivalent_modulo_carve_out(pr_job, auto_job)?;
198+
}
199+
200+
// Auto CI jobs must all "fail-fast" to avoid wasting Auto CI resources. For instance, `tidy`.
201+
for auto_job in &db.auto_jobs {
202+
if auto_job.continue_on_error == Some(true) {
203+
return Err(anyhow!(
204+
"Auto job `{}` cannot have `continue_on_error: true`",
205+
auto_job.name
206+
));
207+
}
208+
}
209+
210+
Ok(())
211+
}
212+
108213
/// Representation of a job outputted to a GitHub Actions workflow.
109214
#[derive(serde::Serialize, Debug)]
110215
struct GithubActionsJob {

‎src/ci/citool/src/jobs/tests.rs

Lines changed: 220 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
use std::collections::BTreeMap;
12
use std::path::Path;
23

34
use super::Job;
@@ -146,3 +147,222 @@ fn validate_jobs() {
146147
panic!("Job validation failed:\n{error_messages}");
147148
}
148149
}
150+
151+
#[test]
152+
fn pr_job_implies_auto_job() {
153+
let db = load_job_db(
154+
r#"
155+
envs:
156+
pr:
157+
try:
158+
auto:
159+
optional:
160+
161+
pr:
162+
- name: pr-ci-a
163+
os: ubuntu
164+
env: {}
165+
try:
166+
auto:
167+
optional:
168+
"#,
169+
)
170+
.unwrap();
171+
172+
assert_eq!(db.auto_jobs.iter().map(|j| j.name.as_str()).collect::<Vec<_>>(), vec!["pr-ci-a"])
173+
}
174+
175+
#[test]
176+
fn implied_auto_job_keeps_env_and_fails_fast() {
177+
let db = load_job_db(
178+
r#"
179+
envs:
180+
pr:
181+
try:
182+
auto:
183+
optional:
184+
185+
pr:
186+
- name: tidy
187+
env:
188+
DEPLOY_TOOLSTATES_JSON: toolstates-linux.json
189+
continue_on_error: true
190+
os: ubuntu
191+
try:
192+
auto:
193+
optional:
194+
"#,
195+
)
196+
.unwrap();
197+
198+
assert_eq!(db.auto_jobs.iter().map(|j| j.name.as_str()).collect::<Vec<_>>(), vec!["tidy"]);
199+
assert_eq!(db.auto_jobs[0].continue_on_error, Some(false));
200+
assert_eq!(
201+
db.auto_jobs[0].env,
202+
BTreeMap::from([(
203+
"DEPLOY_TOOLSTATES_JSON".to_string(),
204+
serde_yaml::Value::String("toolstates-linux.json".to_string())
205+
)])
206+
);
207+
}
208+
209+
#[test]
210+
#[should_panic = "duplicate"]
211+
fn duplicate_job_name() {
212+
let _ = load_job_db(
213+
r#"
214+
envs:
215+
pr:
216+
try:
217+
auto:
218+
219+
220+
pr:
221+
- name: pr-ci-a
222+
os: ubuntu
223+
env: {}
224+
- name: pr-ci-a
225+
os: ubuntu
226+
env: {}
227+
try:
228+
auto:
229+
optional:
230+
"#,
231+
)
232+
.unwrap();
233+
}
234+
235+
#[test]
236+
fn auto_job_can_override_pr_job_spec() {
237+
let db = load_job_db(
238+
r#"
239+
envs:
240+
pr:
241+
try:
242+
auto:
243+
optional:
244+
245+
pr:
246+
- name: tidy
247+
os: ubuntu
248+
env: {}
249+
try:
250+
auto:
251+
- name: tidy
252+
env:
253+
DEPLOY_TOOLSTATES_JSON: toolstates-linux.json
254+
continue_on_error: false
255+
os: ubuntu
256+
optional:
257+
"#,
258+
)
259+
.unwrap();
260+
261+
assert_eq!(db.auto_jobs.iter().map(|j| j.name.as_str()).collect::<Vec<_>>(), vec!["tidy"]);
262+
assert_eq!(db.auto_jobs[0].continue_on_error, Some(false));
263+
assert_eq!(
264+
db.auto_jobs[0].env,
265+
BTreeMap::from([(
266+
"DEPLOY_TOOLSTATES_JSON".to_string(),
267+
serde_yaml::Value::String("toolstates-linux.json".to_string())
268+
)])
269+
);
270+
}
271+
272+
#[test]
273+
fn compatible_divergence_pr_auto_job() {
274+
let db = load_job_db(
275+
r#"
276+
envs:
277+
pr:
278+
try:
279+
auto:
280+
optional:
281+
282+
pr:
283+
- name: tidy
284+
continue_on_error: true
285+
env:
286+
ENV_ALLOWED_TO_DIFFER: "hello world"
287+
os: ubuntu
288+
try:
289+
auto:
290+
- name: tidy
291+
continue_on_error: false
292+
env:
293+
ENV_ALLOWED_TO_DIFFER: "goodbye world"
294+
os: ubuntu
295+
optional:
296+
"#,
297+
)
298+
.unwrap();
299+
300+
// `continue_on_error` and `env` are carve-outs *allowed* to diverge between PR and Auto job of
301+
// the same name. Should load successfully.
302+
303+
assert_eq!(db.auto_jobs.iter().map(|j| j.name.as_str()).collect::<Vec<_>>(), vec!["tidy"]);
304+
assert_eq!(db.auto_jobs[0].continue_on_error, Some(false));
305+
assert_eq!(
306+
db.auto_jobs[0].env,
307+
BTreeMap::from([(
308+
"ENV_ALLOWED_TO_DIFFER".to_string(),
309+
serde_yaml::Value::String("goodbye world".to_string())
310+
)])
311+
);
312+
}
313+
314+
#[test]
315+
#[should_panic = "differs"]
316+
fn incompatible_divergence_pr_auto_job() {
317+
// `os` is not one of the carve-out options allowed to diverge. This should fail.
318+
let _ = load_job_db(
319+
r#"
320+
envs:
321+
pr:
322+
try:
323+
auto:
324+
optional:
325+
326+
pr:
327+
- name: tidy
328+
continue_on_error: true
329+
env:
330+
ENV_ALLOWED_TO_DIFFER: "hello world"
331+
os: ubuntu
332+
try:
333+
auto:
334+
- name: tidy
335+
continue_on_error: false
336+
env:
337+
ENV_ALLOWED_TO_DIFFER: "goodbye world"
338+
os: windows
339+
optional:
340+
"#,
341+
)
342+
.unwrap();
343+
}
344+
345+
#[test]
346+
#[should_panic = "cannot have `continue_on_error: true`"]
347+
fn auto_job_continue_on_error() {
348+
// Auto CI jobs must fail-fast.
349+
let _ = load_job_db(
350+
r#"
351+
envs:
352+
pr:
353+
try:
354+
auto:
355+
optional:
356+
357+
pr:
358+
try:
359+
auto:
360+
- name: tidy
361+
continue_on_error: true
362+
os: windows
363+
env: {}
364+
optional:
365+
"#,
366+
)
367+
.unwrap();
368+
}

‎src/ci/citool/tests/jobs.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ const TEST_JOBS_YML_PATH: &str = concat!(env!("CARGO_MANIFEST_DIR"), "/tests/tes
66
fn auto_jobs() {
77
let stdout = get_matrix("push", "commit", "refs/heads/auto");
88
insta::assert_snapshot!(stdout, @r#"
9-
jobs=[{"name":"aarch64-gnu","full_name":"auto - aarch64-gnu","os":"ubuntu-22.04-arm","env":{"ARTIFACTS_AWS_ACCESS_KEY_ID":"AKIA46X5W6CZN24CBO55","AWS_REGION":"us-west-1","CACHES_AWS_ACCESS_KEY_ID":"AKIA46X5W6CZI5DHEBFL","DEPLOY_BUCKET":"rust-lang-ci2","TOOLSTATE_PUBLISH":1},"free_disk":true},{"name":"x86_64-gnu-llvm-18-1","full_name":"auto - x86_64-gnu-llvm-18-1","os":"ubuntu-24.04","env":{"ARTIFACTS_AWS_ACCESS_KEY_ID":"AKIA46X5W6CZN24CBO55","AWS_REGION":"us-west-1","CACHES_AWS_ACCESS_KEY_ID":"AKIA46X5W6CZI5DHEBFL","DEPLOY_BUCKET":"rust-lang-ci2","DOCKER_SCRIPT":"stage_2_test_set1.sh","IMAGE":"x86_64-gnu-llvm-18","READ_ONLY_SRC":"0","RUST_BACKTRACE":1,"TOOLSTATE_PUBLISH":1},"free_disk":true},{"name":"aarch64-apple","full_name":"auto - aarch64-apple","os":"macos-14","env":{"ARTIFACTS_AWS_ACCESS_KEY_ID":"AKIA46X5W6CZN24CBO55","AWS_REGION":"us-west-1","CACHES_AWS_ACCESS_KEY_ID":"AKIA46X5W6CZI5DHEBFL","DEPLOY_BUCKET":"rust-lang-ci2","MACOSX_DEPLOYMENT_TARGET":11.0,"MACOSX_STD_DEPLOYMENT_TARGET":11.0,"NO_DEBUG_ASSERTIONS":1,"NO_LLVM_ASSERTIONS":1,"NO_OVERFLOW_CHECKS":1,"RUSTC_RETRY_LINKER_ON_SEGFAULT":1,"RUST_CONFIGURE_ARGS":"--enable-sanitizers --enable-profiler --set rust.jemalloc","SCRIPT":"./x.py --stage 2 test --host=aarch64-apple-darwin --target=aarch64-apple-darwin","SELECT_XCODE":"/Applications/Xcode_15.4.app","TOOLSTATE_PUBLISH":1,"USE_XCODE_CLANG":1}},{"name":"dist-i686-msvc","full_name":"auto - dist-i686-msvc","os":"windows-2022","env":{"ARTIFACTS_AWS_ACCESS_KEY_ID":"AKIA46X5W6CZN24CBO55","AWS_REGION":"us-west-1","CACHES_AWS_ACCESS_KEY_ID":"AKIA46X5W6CZI5DHEBFL","CODEGEN_BACKENDS":"llvm,cranelift","DEPLOY_BUCKET":"rust-lang-ci2","DIST_REQUIRE_ALL_TOOLS":1,"RUST_CONFIGURE_ARGS":"--build=i686-pc-windows-msvc --host=i686-pc-windows-msvc --target=i686-pc-windows-msvc,i586-pc-windows-msvc --enable-full-tools --enable-profiler","SCRIPT":"python x.py dist bootstrap --include-default-paths","TOOLSTATE_PUBLISH":1}}]
9+
jobs=[{"name":"aarch64-gnu","full_name":"auto - aarch64-gnu","os":"ubuntu-22.04-arm","env":{"ARTIFACTS_AWS_ACCESS_KEY_ID":"AKIA46X5W6CZN24CBO55","AWS_REGION":"us-west-1","CACHES_AWS_ACCESS_KEY_ID":"AKIA46X5W6CZI5DHEBFL","DEPLOY_BUCKET":"rust-lang-ci2","TOOLSTATE_PUBLISH":1},"free_disk":true},{"name":"x86_64-gnu-llvm-18-1","full_name":"auto - x86_64-gnu-llvm-18-1","os":"ubuntu-24.04","env":{"ARTIFACTS_AWS_ACCESS_KEY_ID":"AKIA46X5W6CZN24CBO55","AWS_REGION":"us-west-1","CACHES_AWS_ACCESS_KEY_ID":"AKIA46X5W6CZI5DHEBFL","DEPLOY_BUCKET":"rust-lang-ci2","DOCKER_SCRIPT":"stage_2_test_set1.sh","IMAGE":"x86_64-gnu-llvm-18","READ_ONLY_SRC":"0","RUST_BACKTRACE":1,"TOOLSTATE_PUBLISH":1},"free_disk":true},{"name":"aarch64-apple","full_name":"auto - aarch64-apple","os":"macos-14","env":{"ARTIFACTS_AWS_ACCESS_KEY_ID":"AKIA46X5W6CZN24CBO55","AWS_REGION":"us-west-1","CACHES_AWS_ACCESS_KEY_ID":"AKIA46X5W6CZI5DHEBFL","DEPLOY_BUCKET":"rust-lang-ci2","MACOSX_DEPLOYMENT_TARGET":11.0,"MACOSX_STD_DEPLOYMENT_TARGET":11.0,"NO_DEBUG_ASSERTIONS":1,"NO_LLVM_ASSERTIONS":1,"NO_OVERFLOW_CHECKS":1,"RUSTC_RETRY_LINKER_ON_SEGFAULT":1,"RUST_CONFIGURE_ARGS":"--enable-sanitizers --enable-profiler --set rust.jemalloc","SCRIPT":"./x.py --stage 2 test --host=aarch64-apple-darwin --target=aarch64-apple-darwin","SELECT_XCODE":"/Applications/Xcode_15.4.app","TOOLSTATE_PUBLISH":1,"USE_XCODE_CLANG":1}},{"name":"dist-i686-msvc","full_name":"auto - dist-i686-msvc","os":"windows-2022","env":{"ARTIFACTS_AWS_ACCESS_KEY_ID":"AKIA46X5W6CZN24CBO55","AWS_REGION":"us-west-1","CACHES_AWS_ACCESS_KEY_ID":"AKIA46X5W6CZI5DHEBFL","CODEGEN_BACKENDS":"llvm,cranelift","DEPLOY_BUCKET":"rust-lang-ci2","DIST_REQUIRE_ALL_TOOLS":1,"RUST_CONFIGURE_ARGS":"--build=i686-pc-windows-msvc --host=i686-pc-windows-msvc --target=i686-pc-windows-msvc,i586-pc-windows-msvc --enable-full-tools --enable-profiler","SCRIPT":"python x.py dist bootstrap --include-default-paths","TOOLSTATE_PUBLISH":1}},{"name":"pr-check-1","full_name":"auto - pr-check-1","os":"ubuntu-24.04","env":{"ARTIFACTS_AWS_ACCESS_KEY_ID":"AKIA46X5W6CZN24CBO55","AWS_REGION":"us-west-1","CACHES_AWS_ACCESS_KEY_ID":"AKIA46X5W6CZI5DHEBFL","DEPLOY_BUCKET":"rust-lang-ci2","TOOLSTATE_PUBLISH":1},"continue_on_error":false,"free_disk":true},{"name":"pr-check-2","full_name":"auto - pr-check-2","os":"ubuntu-24.04","env":{"ARTIFACTS_AWS_ACCESS_KEY_ID":"AKIA46X5W6CZN24CBO55","AWS_REGION":"us-west-1","CACHES_AWS_ACCESS_KEY_ID":"AKIA46X5W6CZI5DHEBFL","DEPLOY_BUCKET":"rust-lang-ci2","TOOLSTATE_PUBLISH":1},"continue_on_error":false,"free_disk":true},{"name":"tidy","full_name":"auto - tidy","os":"ubuntu-24.04","env":{"ARTIFACTS_AWS_ACCESS_KEY_ID":"AKIA46X5W6CZN24CBO55","AWS_REGION":"us-west-1","CACHES_AWS_ACCESS_KEY_ID":"AKIA46X5W6CZI5DHEBFL","DEPLOY_BUCKET":"rust-lang-ci2","TOOLSTATE_PUBLISH":1},"continue_on_error":false,"free_disk":true,"doc_url":"https://foo.bar"}]
1010
run_type=auto
1111
"#);
1212
}

0 commit comments

Comments
 (0)