Skip to content

Commit 71e463b

Browse files
JonathanBrouwerJonathanBrouwer
authored
Rollup merge of #154041 - ferrocene:jyn/bless-hashes, r=jieyouxu
bootstrap: Allow `--bless`ing changes to editor settings files Previously, on any change you would have to first edit all 4 settings files by hand, then run the tests 4 times in a row to discover what the new hashes are. After this change, you still need to edit the files by hand, but you can now run `x test --bless -- hash` to update the hashes without manually editing them.
2 parents bd9ffab + 1098a9d commit 71e463b

3 files changed

Lines changed: 124 additions & 62 deletions

File tree

‎src/bootstrap/src/core/build_steps/setup.rs‎

Lines changed: 13 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,17 @@
55
//! allows setting up things that cannot be simply captured inside the bootstrap.toml, in addition to
66
//! leading people away from manually editing most of the bootstrap.toml values.
77
8+
use std::collections::BTreeMap;
89
use std::env::consts::EXE_SUFFIX;
910
use std::fmt::Write as _;
1011
use std::fs::File;
1112
use std::io::Write;
1213
use std::path::{MAIN_SEPARATOR_STR, Path, PathBuf};
1314
use std::str::FromStr;
15+
use std::sync::LazyLock;
1416
use std::{fmt, fs, io};
1517

18+
use serde_derive::{Deserialize, Serialize};
1619
use sha2::Digest;
1720

1821
use crate::core::builder::{Builder, RunConfig, ShouldRun, Step};
@@ -529,7 +532,8 @@ undesirable, simply delete the `pre-push` file from .git/hooks."
529532
}
530533

531534
/// Handles editor-specific setup differences
532-
#[derive(Clone, Debug, Eq, PartialEq)]
535+
#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord, Serialize, Deserialize)]
536+
#[serde(rename_all = "lowercase")]
533537
enum EditorKind {
534538
Emacs,
535539
Helix,
@@ -538,6 +542,13 @@ enum EditorKind {
538542
Zed,
539543
}
540544

545+
static PARSED_HASHES: LazyLock<BTreeMap<EditorKind, Vec<&'static str>>> = LazyLock::new(|| {
546+
const ALL_HASHES: &str = include_str!("setup/hashes.json");
547+
let mut map: BTreeMap<_, Vec<_>> = serde_json::from_str(ALL_HASHES).unwrap();
548+
map.insert(EditorKind::Vim, map.get(&EditorKind::VsCode).unwrap().clone());
549+
map
550+
});
551+
541552
impl EditorKind {
542553
// Used in `./tests.rs`.
543554
#[cfg(test)]
@@ -588,59 +599,7 @@ Select which editor you would like to set up [default: None]: ";
588599
/// New entries should be appended whenever this is updated so we can detect
589600
/// outdated vs. user-modified settings files.
590601
fn hashes(&self) -> &'static [&'static str] {
591-
match self {
592-
EditorKind::Emacs => &[
593-
"51068d4747a13732440d1a8b8f432603badb1864fa431d83d0fd4f8fa57039e0",
594-
"d29af4d949bbe2371eac928a3c31cf9496b1701aa1c45f11cd6c759865ad5c45",
595-
"b5dd299b93dca3ceeb9b335f929293cb3d4bf4977866fbe7ceeac2a8a9f99088",
596-
"631c837b0e98ae35fd48b0e5f743b1ca60adadf2d0a2b23566ba25df372cf1a9",
597-
"080955765db84bb6cbf178879f489c4e2369397626a6ecb3debedb94a9d0b3ce",
598-
"f501475c6654187091c924ae26187fa5791d74d4a8ab3fb61fbbe4c0275aade1",
599-
"54bc48fe1996177f5eef86d7231b33978e6d8b737cb0a899e622b7e975c95308",
600-
"08d30e455ceec6e01d9bcef8b9449f2ddd14d278ca8627cdad90e02d9f44e938",
601-
],
602-
EditorKind::Helix => &[
603-
"2d3069b8cf1b977e5d4023965eb6199597755e6c96c185ed5f2854f98b83d233",
604-
"6736d61409fbebba0933afd2e4c44ff2f97c1cb36cf0299a7f4a7819b8775040",
605-
"f252dcc30ca85a193a699581e5e929d5bd6c19d40d7a7ade5e257a9517a124a5",
606-
"198c195ed0c070d15907b279b8b4ea96198ca71b939f5376454f3d636ab54da5",
607-
"1c43ead340b20792b91d02b08494ee68708e7e09f56b6766629b4b72079208f1",
608-
"eec09a09452682060afd23dd5d3536ccac5615b3cdbf427366446901215fb9f6",
609-
"cb653043852d9d5ff4a5be56407b859ff9928be055ad3f307eb309aad04765e6",
610-
"e28b1930d16d3d8bbdeed7bd4a995613e648b49e08c9b6f5271880f520637fed",
611-
],
612-
EditorKind::Vim | EditorKind::VsCode => &[
613-
"ea67e259dedf60d4429b6c349a564ffcd1563cf41c920a856d1f5b16b4701ac8",
614-
"56e7bf011c71c5d81e0bf42e84938111847a810eee69d906bba494ea90b51922",
615-
"af1b5efe196aed007577899db9dae15d6dbc923d6fa42fa0934e68617ba9bbe0",
616-
"3468fea433c25fff60be6b71e8a215a732a7b1268b6a83bf10d024344e140541",
617-
"47d227f424bf889b0d899b9cc992d5695e1b78c406e183cd78eafefbe5488923",
618-
"b526bd58d0262dd4dda2bff5bc5515b705fb668a46235ace3e057f807963a11a",
619-
"828666b021d837a33e78d870b56d34c88a5e2c85de58b693607ec574f0c27000",
620-
"811fb3b063c739d261fd8590dd30242e117908f5a095d594fa04585daa18ec4d",
621-
"4eecb58a2168b252077369da446c30ed0e658301efe69691979d1ef0443928f4",
622-
"c394386e6133bbf29ffd32c8af0bb3d4aac354cba9ee051f29612aa9350f8f8d",
623-
"e53e9129ca5ee5dcbd6ec8b68c2d87376474eb154992deba3c6d9ab1703e0717",
624-
"f954316090936c7e590c253ca9d524008375882fa13c5b41d7e2547a896ff893",
625-
"701b73751efd7abd6487f2c79348dab698af7ac4427b79fa3d2087c867144b12",
626-
"a61df796c0c007cb6512127330564e49e57d558dec715703916a928b072a1054",
627-
"02a49ac2d31f00ef6e4531c44e00dac51cea895112e480553f1ba060b3942a47",
628-
"0aa4748848de0d1cb7ece92a0123c8897fef6de2f58aff8fda1426f098b7a798",
629-
"e5e357862e5d6d0d9da335e9823c07b8a7dc42bbf18d72cc5206ad1049cd8fcc",
630-
"a68fd5828e75f3e921f265e29ce1e9efa554083c3773fdb4b8e1ab3b2d9dc6cd",
631-
],
632-
EditorKind::Zed => &[
633-
"bbce727c269d1bd0c98afef4d612eb4ce27aea3c3a8968c5f10b31affbc40b6c",
634-
"a5380cf5dd9328731aecc5dfb240d16dac46ed272126b9728006151ef42f5909",
635-
"2e96bf0d443852b12f016c8fc9840ab3d0a2b4fe0b0fb3a157e8d74d5e7e0e26",
636-
"4fadd4c87389a601a27db0d3d74a142fa3a2e656ae78982e934dbe24bee32ad6",
637-
"f0bb3d23ab1a49175ab0ef5c4071af95bb03d01d460776cdb716d91333443382",
638-
"5ef83292111d9a8bb63b6afc3abf42d0bc78fe24985f0d2e039e73258b5dab8f",
639-
"74420c13094b530a986b37c4f1d23cb58c0e8e2295f5858ded129fb1574e66f9",
640-
"2d3b592c089b2ad2c528686a1e371af49922edad1c59accd5d5f31612a441568",
641-
"0767a2398ccc253274b184adbb9e018ce931bd0ef45baad06dad19b652c52951",
642-
],
643-
}
602+
PARSED_HASHES.get(self).unwrap()
644603
}
645604

646605
fn settings_path(&self, config: &Config) -> PathBuf {

‎src/bootstrap/src/core/build_steps/setup/hashes.json‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
{
2+
"emacs": [
3+
"51068d4747a13732440d1a8b8f432603badb1864fa431d83d0fd4f8fa57039e0",
4+
"d29af4d949bbe2371eac928a3c31cf9496b1701aa1c45f11cd6c759865ad5c45",
5+
"b5dd299b93dca3ceeb9b335f929293cb3d4bf4977866fbe7ceeac2a8a9f99088",
6+
"631c837b0e98ae35fd48b0e5f743b1ca60adadf2d0a2b23566ba25df372cf1a9",
7+
"080955765db84bb6cbf178879f489c4e2369397626a6ecb3debedb94a9d0b3ce",
8+
"f501475c6654187091c924ae26187fa5791d74d4a8ab3fb61fbbe4c0275aade1",
9+
"54bc48fe1996177f5eef86d7231b33978e6d8b737cb0a899e622b7e975c95308",
10+
"08d30e455ceec6e01d9bcef8b9449f2ddd14d278ca8627cdad90e02d9f44e938"
11+
],
12+
"helix": [
13+
"2d3069b8cf1b977e5d4023965eb6199597755e6c96c185ed5f2854f98b83d233",
14+
"6736d61409fbebba0933afd2e4c44ff2f97c1cb36cf0299a7f4a7819b8775040",
15+
"f252dcc30ca85a193a699581e5e929d5bd6c19d40d7a7ade5e257a9517a124a5",
16+
"198c195ed0c070d15907b279b8b4ea96198ca71b939f5376454f3d636ab54da5",
17+
"1c43ead340b20792b91d02b08494ee68708e7e09f56b6766629b4b72079208f1",
18+
"eec09a09452682060afd23dd5d3536ccac5615b3cdbf427366446901215fb9f6",
19+
"cb653043852d9d5ff4a5be56407b859ff9928be055ad3f307eb309aad04765e6",
20+
"e28b1930d16d3d8bbdeed7bd4a995613e648b49e08c9b6f5271880f520637fed"
21+
],
22+
"vim": [
23+
"ea67e259dedf60d4429b6c349a564ffcd1563cf41c920a856d1f5b16b4701ac8",
24+
"56e7bf011c71c5d81e0bf42e84938111847a810eee69d906bba494ea90b51922",
25+
"af1b5efe196aed007577899db9dae15d6dbc923d6fa42fa0934e68617ba9bbe0",
26+
"3468fea433c25fff60be6b71e8a215a732a7b1268b6a83bf10d024344e140541",
27+
"47d227f424bf889b0d899b9cc992d5695e1b78c406e183cd78eafefbe5488923",
28+
"b526bd58d0262dd4dda2bff5bc5515b705fb668a46235ace3e057f807963a11a",
29+
"828666b021d837a33e78d870b56d34c88a5e2c85de58b693607ec574f0c27000",
30+
"811fb3b063c739d261fd8590dd30242e117908f5a095d594fa04585daa18ec4d",
31+
"4eecb58a2168b252077369da446c30ed0e658301efe69691979d1ef0443928f4",
32+
"c394386e6133bbf29ffd32c8af0bb3d4aac354cba9ee051f29612aa9350f8f8d",
33+
"e53e9129ca5ee5dcbd6ec8b68c2d87376474eb154992deba3c6d9ab1703e0717",
34+
"f954316090936c7e590c253ca9d524008375882fa13c5b41d7e2547a896ff893",
35+
"701b73751efd7abd6487f2c79348dab698af7ac4427b79fa3d2087c867144b12",
36+
"a61df796c0c007cb6512127330564e49e57d558dec715703916a928b072a1054",
37+
"02a49ac2d31f00ef6e4531c44e00dac51cea895112e480553f1ba060b3942a47",
38+
"0aa4748848de0d1cb7ece92a0123c8897fef6de2f58aff8fda1426f098b7a798",
39+
"e5e357862e5d6d0d9da335e9823c07b8a7dc42bbf18d72cc5206ad1049cd8fcc",
40+
"a68fd5828e75f3e921f265e29ce1e9efa554083c3773fdb4b8e1ab3b2d9dc6cd"
41+
],
42+
"vscode": [
43+
"ea67e259dedf60d4429b6c349a564ffcd1563cf41c920a856d1f5b16b4701ac8",
44+
"56e7bf011c71c5d81e0bf42e84938111847a810eee69d906bba494ea90b51922",
45+
"af1b5efe196aed007577899db9dae15d6dbc923d6fa42fa0934e68617ba9bbe0",
46+
"3468fea433c25fff60be6b71e8a215a732a7b1268b6a83bf10d024344e140541",
47+
"47d227f424bf889b0d899b9cc992d5695e1b78c406e183cd78eafefbe5488923",
48+
"b526bd58d0262dd4dda2bff5bc5515b705fb668a46235ace3e057f807963a11a",
49+
"828666b021d837a33e78d870b56d34c88a5e2c85de58b693607ec574f0c27000",
50+
"811fb3b063c739d261fd8590dd30242e117908f5a095d594fa04585daa18ec4d",
51+
"4eecb58a2168b252077369da446c30ed0e658301efe69691979d1ef0443928f4",
52+
"c394386e6133bbf29ffd32c8af0bb3d4aac354cba9ee051f29612aa9350f8f8d",
53+
"e53e9129ca5ee5dcbd6ec8b68c2d87376474eb154992deba3c6d9ab1703e0717",
54+
"f954316090936c7e590c253ca9d524008375882fa13c5b41d7e2547a896ff893",
55+
"701b73751efd7abd6487f2c79348dab698af7ac4427b79fa3d2087c867144b12",
56+
"a61df796c0c007cb6512127330564e49e57d558dec715703916a928b072a1054",
57+
"02a49ac2d31f00ef6e4531c44e00dac51cea895112e480553f1ba060b3942a47",
58+
"0aa4748848de0d1cb7ece92a0123c8897fef6de2f58aff8fda1426f098b7a798",
59+
"e5e357862e5d6d0d9da335e9823c07b8a7dc42bbf18d72cc5206ad1049cd8fcc",
60+
"a68fd5828e75f3e921f265e29ce1e9efa554083c3773fdb4b8e1ab3b2d9dc6cd"
61+
],
62+
"zed": [
63+
"bbce727c269d1bd0c98afef4d612eb4ce27aea3c3a8968c5f10b31affbc40b6c",
64+
"a5380cf5dd9328731aecc5dfb240d16dac46ed272126b9728006151ef42f5909",
65+
"2e96bf0d443852b12f016c8fc9840ab3d0a2b4fe0b0fb3a157e8d74d5e7e0e26",
66+
"4fadd4c87389a601a27db0d3d74a142fa3a2e656ae78982e934dbe24bee32ad6",
67+
"f0bb3d23ab1a49175ab0ef5c4071af95bb03d01d460776cdb716d91333443382",
68+
"5ef83292111d9a8bb63b6afc3abf42d0bc78fe24985f0d2e039e73258b5dab8f",
69+
"74420c13094b530a986b37c4f1d23cb58c0e8e2295f5858ded129fb1574e66f9",
70+
"2d3b592c089b2ad2c528686a1e371af49922edad1c59accd5d5f31612a441568",
71+
"0767a2398ccc253274b184adbb9e018ce931bd0ef45baad06dad19b652c52951"
72+
]
73+
}

‎src/bootstrap/src/core/build_steps/setup/tests.rs‎

Lines changed: 38 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,50 @@
1+
use std::collections::BTreeMap;
2+
use std::fs::File;
3+
use std::io::Write;
4+
use std::path::Path;
5+
16
use sha2::Digest;
27

38
use super::EditorKind;
49
use crate::utils::helpers::hex_encode;
510

611
#[test]
712
fn check_matching_settings_hash() {
13+
// Needs to be a btree so we serialize in a deterministic order.
14+
let mut mismatched = BTreeMap::new();
15+
816
for editor in EditorKind::ALL {
917
let mut hasher = sha2::Sha256::new();
1018
hasher.update(&editor.settings_template());
11-
let hash = hex_encode(hasher.finalize().as_slice());
12-
assert_eq!(
13-
&hash,
14-
editor.hashes().last().unwrap(),
15-
"Update `EditorKind::hashes()` with the new hash of `{}` for `EditorKind::{:?}`",
16-
editor.settings_template(),
17-
editor,
18-
);
19+
let actual = hex_encode(hasher.finalize().as_slice());
20+
let expected = *editor.hashes().last().unwrap();
21+
22+
if expected != actual {
23+
mismatched.insert(editor, (expected, actual));
24+
}
25+
}
26+
27+
if mismatched.is_empty() {
28+
return;
29+
}
30+
31+
if option_env!("INSTA_UPDATE").is_some_and(|s| s != "0") {
32+
let mut updated = super::PARSED_HASHES.clone();
33+
for (editor, (_, actual)) in &mismatched {
34+
*updated.get_mut(editor).unwrap().last_mut().unwrap() = actual;
35+
}
36+
let hash_path =
37+
Path::new(env!("CARGO_MANIFEST_DIR")).join("src/core/build_steps/setup/hashes.json");
38+
let mut hash_file = File::create(hash_path).unwrap();
39+
serde_json::to_writer_pretty(&mut hash_file, &updated).unwrap();
40+
hash_file.write_all(b"\n").unwrap();
41+
} else {
42+
for (editor, (expected, actual)) in &mismatched {
43+
eprintln!("recorded hash did not match actual hash: {expected} != {actual}");
44+
eprintln!(
45+
"Run `x test --bless -- hash`, or manually update `setup/hashes.json` with the new hash of `{actual}` for `EditorKind::{editor:?}`"
46+
);
47+
}
48+
panic!("mismatched hashes");
1949
}
2050
}

0 commit comments

Comments
 (0)