1 //! Tidy check to ensure that unstable features are all in order.
3 //! This check will ensure properties like:
5 //! * All stability attributes look reasonably well formed.
6 //! * The set of library features is disjoint from the set of language features.
7 //! * Library features have at most one stability level.
8 //! * Library features have at most one `since` value.
9 //! * All unstable lang features have tests to ensure they are actually unstable.
10 //! * Language features in a group are sorted by feature name.
12 use std::collections::HashMap;
15 use std::num::NonZeroU32;
26 const FEATURE_GROUP_START_PREFIX: &str = "// feature-group-start";
27 const FEATURE_GROUP_END_PREFIX: &str = "// feature-group-end";
29 #[derive(Debug, PartialEq, Clone)]
36 impl fmt::Display for Status {
37 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
38 let as_str = match *self {
39 Status::Stable => "stable",
40 Status::Unstable => "unstable",
41 Status::Removed => "removed",
43 fmt::Display::fmt(as_str, f)
47 #[derive(Debug, Clone)]
50 pub since: Option<Version>,
51 pub has_gate_test: bool,
52 pub tracking_issue: Option<NonZeroU32>,
55 fn tracking_issue_display(&self) -> impl fmt::Display {
56 match self.tracking_issue {
57 None => "none".to_string(),
58 Some(x) => x.to_string(),
63 pub type Features = HashMap<String, Feature>;
65 pub struct CollectedFeatures {
70 // Currently only used for unstable book generation
71 pub fn collect_lib_features(base_src_path: &Path) -> Features {
72 let mut lib_features = Features::new();
74 map_lib_features(base_src_path, &mut |res, _, _| {
75 if let Ok((name, feature)) = res {
76 lib_features.insert(name.to_owned(), feature);
88 ) -> CollectedFeatures {
89 let mut features = collect_lang_features(compiler_path, bad);
90 assert!(!features.is_empty());
92 let lib_features = get_and_check_lib_features(lib_path, bad, &features);
93 assert!(!lib_features.is_empty());
97 &src_path.join("test/ui"),
98 &src_path.join("test/ui-fulldeps"),
99 &src_path.join("test/rustdoc-ui"),
100 &src_path.join("test/rustdoc"),
102 &mut |path| super::filter_dirs(path),
103 &mut |entry, contents| {
104 let file = entry.path();
105 let filename = file.file_name().unwrap().to_string_lossy();
106 if !filename.ends_with(".rs")
107 || filename == "features.rs"
108 || filename == "diagnostic_list.rs"
113 let filen_underscore = filename.replace('-', "_").replace(".rs", "");
114 let filename_is_gate_test = test_filen_gate(&filen_underscore, &mut features);
116 for (i, line) in contents.lines().enumerate() {
117 let mut err = |msg: &str| {
118 tidy_error!(bad, "{}:{}: {}", file.display(), i + 1, msg);
121 let gate_test_str = "gate-test-";
123 let feature_name = match line.find(gate_test_str) {
124 // NB: the `splitn` always succeeds, even if the delimiter is not present.
125 Some(i) => line[i + gate_test_str.len()..].splitn(2, ' ').next().unwrap(),
128 match features.get_mut(feature_name) {
130 if filename_is_gate_test {
132 "The file is already marked as gate test \
133 through its name, no need for a \
134 'gate-test-{}' comment",
138 f.has_gate_test = true;
142 "gate-test test found referencing a nonexistent feature '{}'",
151 // Only check the number of lang features.
152 // Obligatory testing for library features is dumb.
153 let gate_untested = features
155 .filter(|&(_, f)| f.level == Status::Unstable)
156 .filter(|&(_, f)| !f.has_gate_test)
157 .collect::<Vec<_>>();
159 for &(name, _) in gate_untested.iter() {
160 println!("Expected a gate test for the feature '{}'.", name);
162 "Hint: create a failing test file named 'feature-gate-{}.rs'\
163 \n in the 'ui' test suite, with its failures due to\
164 \n missing usage of `#![feature({})]`.",
168 "Hint: If you already have such a test and don't want to rename it,\
169 \n you can also add a // gate-test-{} line to the test file.",
174 if !gate_untested.is_empty() {
175 tidy_error!(bad, "Found {} features without a gate test.", gate_untested.len());
179 return CollectedFeatures { lib: lib_features, lang: features };
183 let mut lines = Vec::new();
184 lines.extend(format_features(&features, "lang"));
185 lines.extend(format_features(&lib_features, "lib"));
189 println!("* {}", line);
192 println!("* {} features", features.len());
195 CollectedFeatures { lib: lib_features, lang: features }
198 fn format_features<'a>(
199 features: &'a Features,
201 ) -> impl Iterator<Item = String> + 'a {
202 features.iter().map(move |(name, feature)| {
204 "{:<32} {:<8} {:<12} {:<8}",
208 feature.since.map_or("None".to_owned(), |since| since.to_string())
213 fn find_attr_val<'a>(line: &'a str, attr: &str) -> Option<&'a str> {
214 lazy_static::lazy_static! {
215 static ref ISSUE: Regex = Regex::new(r#"issue\s*=\s*"([^"]*)""#).unwrap();
216 static ref FEATURE: Regex = Regex::new(r#"feature\s*=\s*"([^"]*)""#).unwrap();
217 static ref SINCE: Regex = Regex::new(r#"since\s*=\s*"([^"]*)""#).unwrap();
222 "feature" => &*FEATURE,
224 _ => unimplemented!("{} not handled", attr),
227 r.captures(line).and_then(|c| c.get(1)).map(|m| m.as_str())
230 fn test_filen_gate(filen_underscore: &str, features: &mut Features) -> bool {
231 let prefix = "feature_gate_";
232 if filen_underscore.starts_with(prefix) {
233 for (n, f) in features.iter_mut() {
234 // Equivalent to filen_underscore == format!("feature_gate_{}", n)
235 if &filen_underscore[prefix.len()..] == n {
236 f.has_gate_test = true;
244 pub fn collect_lang_features(base_compiler_path: &Path, bad: &mut bool) -> Features {
245 let mut all = collect_lang_features_in(base_compiler_path, "active.rs", bad);
246 all.extend(collect_lang_features_in(base_compiler_path, "accepted.rs", bad));
247 all.extend(collect_lang_features_in(base_compiler_path, "removed.rs", bad));
251 fn collect_lang_features_in(base: &Path, file: &str, bad: &mut bool) -> Features {
252 let path = base.join("rustc_feature").join("src").join(file);
253 let contents = t!(fs::read_to_string(&path));
255 // We allow rustc-internal features to omit a tracking issue.
256 // To make tidy accept omitting a tracking issue, group the list of features
257 // without one inside `// no-tracking-issue` and `// no-tracking-issue-end`.
258 let mut next_feature_omits_tracking_issue = false;
260 let mut in_feature_group = false;
261 let mut prev_names = vec![];
266 .filter_map(|(line, line_number)| {
267 let line = line.trim();
269 // Within -start and -end, the tracking issue can be omitted.
271 "// no-tracking-issue-start" => {
272 next_feature_omits_tracking_issue = true;
275 "// no-tracking-issue-end" => {
276 next_feature_omits_tracking_issue = false;
282 if line.starts_with(FEATURE_GROUP_START_PREFIX) {
283 if in_feature_group {
287 new feature group is started without ending the previous one",
293 in_feature_group = true;
296 } else if line.starts_with(FEATURE_GROUP_END_PREFIX) {
297 in_feature_group = false;
302 let mut parts = line.split(',');
303 let level = match parts.next().map(|l| l.trim().trim_start_matches('(')) {
304 Some("active") => Status::Unstable,
305 Some("incomplete") => Status::Unstable,
306 Some("removed") => Status::Removed,
307 Some("accepted") => Status::Stable,
310 let name = parts.next().unwrap().trim();
312 let since_str = parts.next().unwrap().trim().trim_matches('"');
313 let since = match since_str.parse() {
314 Ok(since) => Some(since),
318 "{}:{}: failed to parse since: {} ({:?})",
327 if in_feature_group {
328 if prev_names.last() > Some(&name) {
329 // This assumes the user adds the feature name at the end of the list, as we're
330 // not looking ahead.
331 let correct_index = match prev_names.binary_search(&name) {
333 // This only occurs when the feature name has already been declared.
336 "{}:{}: duplicate feature {}",
341 // skip any additional checks for this line
347 let correct_placement = if correct_index == 0 {
348 "at the beginning of the feature group".to_owned()
349 } else if correct_index == prev_names.len() {
350 // I don't believe this is reachable given the above assumption, but it
351 // doesn't hurt to be safe.
352 "at the end of the feature group".to_owned()
356 prev_names[correct_index - 1],
357 prev_names[correct_index],
363 "{}:{}: feature {} is not sorted by feature name (should be {})",
370 prev_names.push(name);
373 let issue_str = parts.next().unwrap().trim();
374 let tracking_issue = if issue_str.starts_with("None") {
375 if level == Status::Unstable && !next_feature_omits_tracking_issue {
378 "{}:{}: no tracking issue for feature {}",
386 let s = issue_str.split('(').nth(1).unwrap().split(')').next().unwrap();
387 Some(s.parse().unwrap())
389 Some((name.to_owned(), Feature { level, since, has_gate_test: false, tracking_issue }))
394 fn get_and_check_lib_features(
395 base_src_path: &Path,
397 lang_features: &Features,
399 let mut lib_features = Features::new();
400 map_lib_features(base_src_path, &mut |res, file, line| match res {
402 let mut check_features = |f: &Feature, list: &Features, display: &str| {
403 if let Some(ref s) = list.get(name) {
404 if f.tracking_issue != s.tracking_issue && f.level != Status::Stable {
407 "{}:{}: `issue` \"{}\" mismatches the {} `issue` of \"{}\"",
410 f.tracking_issue_display(),
412 s.tracking_issue_display(),
417 check_features(&f, &lang_features, "corresponding lang feature");
418 check_features(&f, &lib_features, "previous");
419 lib_features.insert(name.to_owned(), f);
422 tidy_error!(bad, "{}:{}: {}", file.display(), line, msg);
429 base_src_path: &Path,
430 mf: &mut dyn FnMut(Result<(&str, Feature), &str>, &Path, usize),
434 &mut |path| super::filter_dirs(path) || path.ends_with("src/test"),
435 &mut |entry, contents| {
436 let file = entry.path();
437 let filename = file.file_name().unwrap().to_string_lossy();
438 if !filename.ends_with(".rs")
439 || filename == "features.rs"
440 || filename == "diagnostic_list.rs"
441 || filename == "error_codes.rs"
446 // This is an early exit -- all the attributes we're concerned with must contain this:
447 // * rustc_const_unstable(
450 if !contents.contains("stable(") {
454 let handle_issue_none = |s| match s {
457 let n = issue.parse().expect("issue number is not a valid integer");
458 assert_ne!(n, 0, "\"none\" should be used when there is no issue, not \"0\"");
462 let mut becoming_feature: Option<(&str, Feature)> = None;
463 let mut iter_lines = contents.lines().enumerate().peekable();
464 while let Some((i, line)) = iter_lines.next() {
467 mf(Err($msg), file, i + 1);
472 lazy_static::lazy_static! {
473 static ref COMMENT_LINE: Regex = Regex::new(r"^\s*//").unwrap();
475 // exclude commented out lines
476 if COMMENT_LINE.is_match(line) {
480 if let Some((ref name, ref mut f)) = becoming_feature {
481 if f.tracking_issue.is_none() {
482 f.tracking_issue = find_attr_val(line, "issue").and_then(handle_issue_none);
484 if line.ends_with(']') {
485 mf(Ok((name, f.clone())), file, i + 1);
486 } else if !line.ends_with(',') && !line.ends_with('\\') && !line.ends_with('"')
488 // We need to bail here because we might have missed the
489 // end of a stability attribute above because the ']'
490 // might not have been at the end of the line.
491 // We could then get into the very unfortunate situation that
492 // we continue parsing the file assuming the current stability
493 // attribute has not ended, and ignoring possible feature
494 // attributes in the process.
495 err!("malformed stability attribute");
500 becoming_feature = None;
501 if line.contains("rustc_const_unstable(") {
502 // `const fn` features are handled specially.
503 let feature_name = match find_attr_val(line, "feature") {
505 None => err!("malformed stability attribute: missing `feature` key"),
507 let feature = Feature {
508 level: Status::Unstable,
510 has_gate_test: false,
511 tracking_issue: find_attr_val(line, "issue").and_then(handle_issue_none),
513 mf(Ok((feature_name, feature)), file, i + 1);
516 let level = if line.contains("[unstable(") {
518 } else if line.contains("[stable(") {
523 let feature_name = match find_attr_val(line, "feature")
524 .or_else(|| iter_lines.peek().and_then(|next| find_attr_val(next.1, "feature")))
527 None => err!("malformed stability attribute: missing `feature` key"),
529 let since = match find_attr_val(line, "since").map(|x| x.parse()) {
530 Some(Ok(since)) => Some(since),
532 err!("malformed stability attribute: can't parse `since` key");
534 None if level == Status::Stable => {
535 err!("malformed stability attribute: missing the `since` key");
539 let tracking_issue = find_attr_val(line, "issue").and_then(handle_issue_none);
541 let feature = Feature { level, since, has_gate_test: false, tracking_issue };
542 if line.contains(']') {
543 mf(Ok((feature_name, feature)), file, i + 1);
545 becoming_feature = Some((feature_name, feature));