ctest: Revise generate function to return Result #4430
Conversation
…Add anyhow error handling. Revert expect call in generate API
ctest/src/lib.rs
Outdated
| use std::collections::{HashMap, HashSet}; | ||
| use std::env; | ||
| use std::fs::File; | ||
| use std::io::prelude::*; | ||
| use std::io::BufWriter; | ||
| use std::panic::{catch_unwind, AssertUnwindSafe}; |
There was a problem hiding this comment.
Unfortunately we can't use catch_unwind; if somebody has panic = abort in their Cargo.toml or if run on a target/backend that doesn't support unwinding, the program will stop and catch_unwind won't actually catch anything. All functions that may return an error need to change their signature then update .unwrap() / .expect() to ?.
Everything else looks pretty good to me, but I'll re-review after the changes.
(basically my same comment from #4424 (comment))
There was a problem hiding this comment.
Thanks. I've removed the remaining catch_unwind logic.
ctest/src/lib.rs
Outdated
| match cfg.try_compile(&format!("lib{stem}.a")) { | ||
| Ok(_) => Ok(out), | ||
| Err(e) => Err(anyhow::anyhow!("Compilation failed").context(format!("Error: {}", e))), | ||
| } |
There was a problem hiding this comment.
I think the error handling could be a bit simplified here:
let name = format!("lib{stem}.a");
cfg.try_compile(&name)
.context("failed to compile `{name}`")?
.map(|()| out)
ctest/src/lib.rs
Outdated
| // Check if all specified header files exist in the include paths | ||
| for header in &self.headers { | ||
| // Check if header exists in any of the include paths | ||
| for include_path in &self.includes { | ||
| let header_path = include_path.join(header); | ||
| if !header_path.exists() { | ||
| return Err(anyhow::anyhow!("Header file not found")) | ||
| .with_context(|| format!("Path {} does not exist", header_path.display())); | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
Where do the header files actually get read? There is a TOCTOU error here (albeit mild). It would be better to just add an error message wherever they are opened, and this block can be removed.
There was a problem hiding this comment.
Indeed. I've removed this block. Thanks!
ctest/src/lib.rs
Outdated
| if !out_dir.is_dir() { | ||
| return Err(anyhow::anyhow!( | ||
| "Output directory does not exist: {}", | ||
| out_dir.display() | ||
| )); | ||
| } |
There was a problem hiding this comment.
Similar to the above, we shouldn't really need this check.
ctest/src/lib.rs
Outdated
| let diag_info = format!("{:?}", d); | ||
| // Emit the diagnostic to properly handle it and show error to the user | ||
| d.emit(); | ||
| anyhow::anyhow!("failed to parse crate").context(format!("Diagnostic: {}", diag_info)) |
There was a problem hiding this comment.
d.emit();
anyhow!("failed to parse crate: {d:?}")No need to put the diagnostic in context since it goes with the error, or to format! it separately. Also you can import anyhow::anyhow since it's used a few times.
There was a problem hiding this comment.
Actually, why .emit() the diagnostic at all? Does that give different output compared to printing it with either Debug or Display?
There was a problem hiding this comment.
the emit() is necessary becoz without the emit call, the DiagnosticBuilder will panic on drop:
https://github.com/JohnTitor/garando/blob/master/garando_errors/src/diagnostic_builder.rs#L157
tgross35
changed the title
|
Looks like there is a flaky test : https://github.com/rust-lang/libc/runs/41604457695 I re-trigger the CI and it passes |
Description
As per #4369 , the generate function should return a Result instead of returning nothing.
This PR is a continuation of #4424 which was closed due to bad rebase.
Checklist
libc-test/semverhave been updated*LASTor*MAXareincluded (see rust-lang/libc#3131)
cd libc-test && cargo test --target mytarget);especially relevant for platforms that may not be checked in CI