Skip to content

Commit c7be9e4

Browse files
borsbors
committed
Auto merge of #14196 - lschuermann:dev/config-include-enable-in-config, r=weihanglo
Allow enabling `config-include` feature in config ### What does this PR try to resolve? Prior to this change, it is not possible to enable the unstable `config-include` flag from within a config file itself. This is due to the fact that, while cargo does reload configuration files if this flag is set, it does not parse the top-level configuration file's unstable flags before checking whether this flag is present. This commit forces cargo to load unstable features before this check, and if the flag is present, re-loads configuration files with `config-include` enabled. Addresses #7723 (comment). ### How should we test and review this PR? This PR adds a testcase for this behavior to cargo's testsuite. In general, it can be replicated with a config similar to that in the testcase, or as illustrated in #7723 (comment). ### Additional information ~I'm not sure whether this is the right(TM) fix, or whether the second `self.load_unstable_flags_from_config()?;` at the bottom of `configure()` would still be required. I have a feeling it might not be, as `reload_rooted_at` also calls out to `load_unstable_flags_from_config`, to collect flags from any newly included configs. If that is not called, no other file was loaded, and thus there should not be a need to re-load unstable flags.~ Resolved: #14196 (comment)
2 parents 83a5ff4 + 0e35bea commit c7be9e4

File tree

2 files changed

+170
-2
lines changed

2 files changed

+170
-2
lines changed

‎src/cargo/util/context/mod.rs

+5-2
Original file line numberDiff line numberDiff line change
@@ -1035,6 +1035,11 @@ impl GlobalContext {
10351035
self.cli_config = Some(cli_config.iter().map(|s| s.to_string()).collect());
10361036
self.merge_cli_args()?;
10371037
}
1038+
1039+
// Load the unstable flags from config file here first, as the config
1040+
// file itself may enable inclusion of other configs. In that case, we
1041+
// want to re-load configs with includes enabled:
1042+
self.load_unstable_flags_from_config()?;
10381043
if self.unstable_flags.config_include {
10391044
// If the config was already loaded (like when fetching the
10401045
// `[alias]` table), it was loaded with includes disabled because
@@ -1091,8 +1096,6 @@ impl GlobalContext {
10911096
let cli_target_dir = target_dir.as_ref().map(|dir| Filesystem::new(dir.clone()));
10921097
self.target_dir = cli_target_dir;
10931098

1094-
self.load_unstable_flags_from_config()?;
1095-
10961099
Ok(())
10971100
}
10981101

‎tests/testsuite/config_include.rs

+165
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,171 @@ fn simple() {
4848
assert_eq!(gctx.get::<i32>("key3").unwrap(), 4);
4949
}
5050

51+
#[cargo_test]
52+
fn enable_in_unstable_config() {
53+
// config-include enabled in the unstable config table:
54+
write_config_at(
55+
".cargo/config.toml",
56+
"
57+
include = 'other.toml'
58+
key1 = 1
59+
key2 = 2
60+
61+
[unstable]
62+
config-include = true
63+
",
64+
);
65+
write_config_at(
66+
".cargo/other.toml",
67+
"
68+
key2 = 3
69+
key3 = 4
70+
",
71+
);
72+
let gctx = GlobalContextBuilder::new()
73+
.nightly_features_allowed(true)
74+
.build();
75+
assert_eq!(gctx.get::<i32>("key1").unwrap(), 1);
76+
assert_eq!(gctx.get::<i32>("key2").unwrap(), 2);
77+
assert_eq!(gctx.get::<i32>("key3").unwrap(), 4);
78+
}
79+
80+
#[cargo_test]
81+
fn mix_of_hierarchy_and_include() {
82+
write_config_at(
83+
"foo/.cargo/config.toml",
84+
"
85+
include = 'other.toml'
86+
key1 = 1
87+
88+
# also make sure unstable flags merge in the correct order
89+
[unstable]
90+
features = ['1']
91+
",
92+
);
93+
write_config_at(
94+
"foo/.cargo/other.toml",
95+
"
96+
key1 = 2
97+
key2 = 2
98+
99+
[unstable]
100+
features = ['2']
101+
",
102+
);
103+
write_config_at(
104+
".cargo/config.toml",
105+
"
106+
include = 'other.toml'
107+
key1 = 3
108+
key2 = 3
109+
key3 = 3
110+
111+
[unstable]
112+
features = ['3']
113+
",
114+
);
115+
write_config_at(
116+
".cargo/other.toml",
117+
"
118+
key1 = 4
119+
key2 = 4
120+
key3 = 4
121+
key4 = 4
122+
123+
[unstable]
124+
features = ['4']
125+
",
126+
);
127+
let gctx = GlobalContextBuilder::new()
128+
.unstable_flag("config-include")
129+
.cwd("foo")
130+
.nightly_features_allowed(true)
131+
.build();
132+
assert_eq!(gctx.get::<i32>("key1").unwrap(), 1);
133+
assert_eq!(gctx.get::<i32>("key2").unwrap(), 2);
134+
assert_eq!(gctx.get::<i32>("key3").unwrap(), 3);
135+
assert_eq!(gctx.get::<i32>("key4").unwrap(), 4);
136+
assert_eq!(
137+
gctx.get::<Vec<String>>("unstable.features").unwrap(),
138+
vec![
139+
"4".to_string(),
140+
"3".to_string(),
141+
"2".to_string(),
142+
"1".to_string()
143+
]
144+
);
145+
}
146+
147+
#[cargo_test]
148+
fn mix_of_hierarchy_and_include_with_enable_in_unstable_config() {
149+
// `mix_of_hierarchy_and_include`, but with the config-include
150+
// feature itself enabled in the unstable config table:
151+
write_config_at(
152+
"foo/.cargo/config.toml",
153+
"
154+
include = 'other.toml'
155+
key1 = 1
156+
157+
# also make sure unstable flags merge in the correct order
158+
[unstable]
159+
features = ['1']
160+
config-include = true
161+
",
162+
);
163+
write_config_at(
164+
"foo/.cargo/other.toml",
165+
"
166+
key1 = 2
167+
key2 = 2
168+
169+
[unstable]
170+
features = ['2']
171+
",
172+
);
173+
write_config_at(
174+
".cargo/config.toml",
175+
"
176+
include = 'other.toml'
177+
key1 = 3
178+
key2 = 3
179+
key3 = 3
180+
181+
[unstable]
182+
features = ['3']
183+
",
184+
);
185+
write_config_at(
186+
".cargo/other.toml",
187+
"
188+
key1 = 4
189+
key2 = 4
190+
key3 = 4
191+
key4 = 4
192+
193+
[unstable]
194+
features = ['4']
195+
",
196+
);
197+
let gctx = GlobalContextBuilder::new()
198+
.cwd("foo")
199+
.nightly_features_allowed(true)
200+
.build();
201+
assert_eq!(gctx.get::<i32>("key1").unwrap(), 1);
202+
assert_eq!(gctx.get::<i32>("key2").unwrap(), 2);
203+
assert_eq!(gctx.get::<i32>("key3").unwrap(), 3);
204+
assert_eq!(gctx.get::<i32>("key4").unwrap(), 4);
205+
assert_eq!(
206+
gctx.get::<Vec<String>>("unstable.features").unwrap(),
207+
vec![
208+
"4".to_string(),
209+
"3".to_string(),
210+
"2".to_string(),
211+
"1".to_string()
212+
]
213+
);
214+
}
215+
51216
#[cargo_test]
52217
fn works_with_cli() {
53218
write_config_at(

0 commit comments

Comments
 (0)