cli: Add a human readable format to status #738
Conversation
|
Updated with most recent progress, still in draft status.
|
djach7
force-pushed
the
human-readable
branch
3 times, most recently
from
e0de226
to
a296b12
Compare
There was a problem hiding this comment.
Thanks for working on this!
I think this is getting close. I'd like to consider how to make the output even prettier (I know there's a lot of bikeshedding potential there). Some other projects use emojis (sometimes controversial), but maybe some ascii-art line drawing for associated data (like systemctl status does?)
lib/src/status.rs
Outdated
| Image version: stream9.20240807.0 (No timestamp present) | ||
| Image transport: registry | ||
| Image digest: sha256:47e5ed613a970b6574bfa954ab25bb6e85656552899aa518b5961d9645102b38 | ||
| No booted image present, checksum defined |
There was a problem hiding this comment.
We could probably phrase this in a way more understandable to the user. One may very well feel that they are in a "booted image", just not a container image right?
Hmm...how about: "Booted state is native ostree" ?
We could also actually go a step farther and detect the situation of rpm-ostree generated content, though that'd be a good bit more work.
There was a problem hiding this comment.
Updated the output line to match what you suggested, if you'd like me to dig in further let me know
lib/src/status.rs
Outdated
| #[test] | ||
| fn test_human_readable_base_spec() { | ||
| // Tests Staged and Booted, null Rollback | ||
| let spec_fixture: &str = include_str!("fixtures/spec-staged-booted.yaml"); |
There was a problem hiding this comment.
One thing I think would help here is to factor out a helper function like
fn human_status_from_spec_fixture(&str) -> Result<String> or so
that gets used in each test.
There was a problem hiding this comment.
Implemented a helper function, Following my interpretation of what you suggested. I used .expect to handled the result, should I instead be using the .unwrap_or that I used to handle the option types?
Implements a human readable output format as the primary `bootc status` output. Also implements associated testing using specs from systems in various stages of bootc deployment. Co-authored-by: Huijing Hei <[email protected]> Co-authored-by: Yasmin de Souza <[email protected]> Co-authored-by: Steven Presti <[email protected]> Co-authored-by: Luke Yang <[email protected]> Co-authored-by: Joseph Marrero <[email protected]> Signed-off-by: djach7 <[email protected]>
djach7
force-pushed
the
human-readable
branch
from
a296b12
to
bc20565
Compare
| let expected = indoc::indoc! { r" | ||
| Current staged image: quay.io/example/someimage:latest | ||
| Image version: nightly (2023-10-14 19:22:15 UTC) | ||
| Image transport: registry |
There was a problem hiding this comment.
How about omitting this when it's registry? That's the 95% case I think.
| Ok(()) | ||
| } | ||
|
|
||
| fn human_status_from_spec_fixture(spec_fixture: &str) -> Result<String> { |
There was a problem hiding this comment.
Don't we get an unused function warning?
It may help to put everything here under a
#[cfg(test)]
mod tests {
...
}
as is done elsewhere in the code
supersedes #602 and builds on top of #639