Skip to content

Commit 7711c6b

Browse files
Suggest pattern in meaningful test diagnostic
As the reason for tidy failing the test name may seem slightly opaque, provide a suggestion on how to rename the file. There are some tests which merely would require reordering of the name according to the rule. I could modify the diagnostic further to identify those, but doing such would make it prone to bad suggestions. I have opted to trust contributors to recognize the diagnostic is robotic, as the pattern we are linting on is easier to match if we do not speculate on what parts of the name are meaningful: sometimes a word is a reason, but sometimes it is a mere "tag", such as with a pair like: issue-314159265-blue.rs issue-314159265-red.rs Starting them with `red-` and `blue-` means they do not sort together, despite being related, and the color names are still not very descriptive. Recognizing a good name is an open-ended task, though this pair might be: colored-circle-gen-blue.rs colored-circle-gen-red.rs Deciding exactly how to solve this is not the business of tidy, only recognizing a what.
1 parent 742a9c1 commit 7711c6b

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/tools/tidy/src/ui_tests.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -148,17 +148,17 @@ pub fn check(path: &Path, bad: &mut bool) {
148148
if ext == "rs" {
149149
lazy_static! {
150150
static ref ISSUE_NAME_REGEX: Regex =
151-
Regex::new(r"^issues?[-_]?\d{3,}").unwrap();
151+
Regex::new(r"^issues?[-_]?(\d{3,})").unwrap();
152152
}
153153

154-
if ISSUE_NAME_REGEX.is_match(testname) {
154+
if let Some(test_name) = ISSUE_NAME_REGEX.captures(testname) {
155155
// these paths are always relative to the passed `path` and always UTF8
156156
let stripped_path = file_path.strip_prefix(path).unwrap().to_str().unwrap();
157157
if !allowed_issue_filenames.remove(stripped_path) {
158158
tidy_error!(
159159
bad,
160-
"UI test `{}` should use a name that describes the test and link the issue in a comment instead.",
161-
file_path.display(),
160+
"file `{stripped_path}` must begin with a descriptive name, consider `{{reason}}-issue-{issue_n}.rs`",
161+
issue_n = &test_name[1],
162162
);
163163
}
164164
}

0 commit comments

Comments
 (0)