Improved Coffee Verification and CoffeeNurse Functionality

[tareknaser]

Description

This pull request introduces enhancements to coffee command-line tool:

1. Verification Enhancements:

• coffee now checks the status of its configuration before executing each command.
• If the configuration is found to be in an unsatisfactory state, the command will return an error.
• To bypass this verification step, users can employ the --skip-verify flag.

2. CoffeeNurse Improvements:

• Implemented is_sane for CoffeeNurse type to assess the sanity of the coffee configuration.
• Introduced the organize method for CoffeeNurse, ensuring each action is included only once.
• Added a new method, coffee_verify, which allows users to check coffee configuration's status without taking any action.

3. New --verify Flag:

• The coffee nurse command now supports a --verify flag, which invokes the coffee_verify method.

4. Testing and Documentation:

• Included a test case for the coffee_verify method.
• Updated documentation to reflect these enhancements.

Fixes #128

[netlify[bot]]

✅ Deploy Preview for coffee-docs canceled.

Name	Link
🔨 Latest commit	5d7730fb4876ce917260981bcb4d8bc137693a0d
🔍 Latest deploy log	https://app.netlify.com/sites/coffee-docs/deploys/652842147465e70008da0505

[vincenzopalazzo]

2023-10-12T19:08:14.8401429Z coffee_1  | ---- coffee_httpd_integration_tests::httpd_init_add_remote stdout ----
2023-10-12T19:08:14.8402659Z coffee_1  | thread '<unnamed>' panicked at tests/src/coffee_httpd_integration_tests.rs:66:10:
2023-10-12T19:08:14.8404338Z coffee_1  | called `Result::unwrap()` on an `Err` value: Rpc(RpcError { code: -32601, message: "Unknown command 'summary'", data: None })
2023-10-12T19:08:14.8405713Z coffee_1  | stack backtrace:
2023-10-12T19:08:14.8406267Z coffee_1  |    0: rust_begin_unwind
2023-10-12T19:08:14.8407588Z coffee_1  |              at /rustc/cc66ad468955717ab92600c770da8c1601a4ff33/library/std/src/panicking.rs:595:5
2023-10-12T19:08:14.8408688Z coffee_1  |    1: core::panicking::panic_fmt
2023-10-12T19:08:14.8409797Z coffee_1  |              at /rustc/cc66ad468955717ab92600c770da8c1601a4ff33/library/core/src/panicking.rs:67:14
2023-10-12T19:08:14.8410869Z coffee_1  |    2: core::result::unwrap_failed
2023-10-12T19:08:14.8411965Z coffee_1  |              at /rustc/cc66ad468955717ab92600c770da8c1601a4ff33/library/core/src/result.rs:1652:5
2023-10-12T19:08:14.8413060Z coffee_1  |    3: core::result::Result<T,E>::unwrap
2023-10-12T19:08:14.8414168Z coffee_1  |              at /rustc/cc66ad468955717ab92600c770da8c1601a4ff33/library/core/src/result.rs:1077:23
2023-10-12T19:08:14.8415629Z coffee_1  |    4: tests::coffee_httpd_integration_tests::httpd_init_add_remote::ntest_callback::{{closure}}
2023-10-12T19:08:14.8416794Z coffee_1  |              at ./src/coffee_httpd_integration_tests.rs:64:5
2023-10-12T19:08:14.8417800Z coffee_1  |    5: <core::pin::Pin<P> as core::future::future::Future>::poll
2023-10-12T19:08:14.8419081Z coffee_1  |              at /rustc/cc66ad468955717ab92600c770da8c1601a4ff33/library/core/src/future/future.rs:125:9
2023-10-12T19:08:14.8420385Z coffee_1  |    6: tokio::runtime::park::CachedParkThread::block_on::{{closure}}
2023-10-12T19:08:14.8421815Z coffee_1  |              at /root/.cargo/registry/src/index.crates.io-6f17d22bba15001f/tokio-1.29.1/src/runtime/park.rs:283:63
2023-10-12T19:08:14.8423035Z coffee_1  |    7: tokio::runtime::coop::with_budget
2023-10-12T19:08:14.8424286Z coffee_1  |              at /root/.cargo/registry/src/index.crates.io-6f17d22bba15001f/tokio-1.29.1/src/runtime/coop.rs:107:5
2023-10-12T19:08:14.8425477Z coffee_1  |    8: tokio::runtime::coop::budget
2023-10-12T19:08:14.8426851Z coffee_1  |              at /root/.cargo/registry/src/index.crates.io-6f17d22bba15001f/tokio-1.29.1/src/runtime/coop.rs:73:5
2023-10-12T19:08:14.8428178Z coffee_1  |    9: tokio::runtime::park::CachedParkThread::block_on
2023-10-12T19:08:14.8429530Z coffee_1  |              at /root/.cargo/registry/src/index.crates.io-6f17d22bba15001f/tokio-1.29.1/src/runtime/park.rs:283:31
2023-10-12T19:08:14.8430963Z coffee_1  |   10: tokio::runtime::context::blocking::BlockingRegionGuard::block_on
2023-10-12T19:08:14.8432475Z coffee_1  |              at /root/.cargo/registry/src/index.crates.io-6f17d22bba15001f/tokio-1.29.1/src/runtime/context/blocking.rs:66:9
2023-10-12T19:08:14.8434049Z coffee_1  |   11: tokio::runtime::scheduler::multi_thread::MultiThread::block_on::{{closure}}
2023-10-12T19:08:14.8435741Z coffee_1  |              at /root/.cargo/registry/src/index.crates.io-6f17d22bba15001f/tokio-1.29.1/src/runtime/scheduler/multi_thread/mod.rs:87:13
2023-10-12T19:08:14.8437206Z coffee_1  |   12: tokio::runtime::context::runtime::enter_runtime
2023-10-12T19:08:14.8438616Z coffee_1  |              at /root/.cargo/registry/src/index.crates.io-6f17d22bba15001f/tokio-1.29.1/src/runtime/context/runtime.rs:65:16
2023-10-12T19:08:14.8440110Z coffee_1  |   13: tokio::runtime::scheduler::multi_thread::MultiThread::block_on
2023-10-12T19:08:14.8441711Z coffee_1  |              at /root/.cargo/registry/src/index.crates.io-6f17d22bba15001f/tokio-1.29.1/src/runtime/scheduler/multi_thread/mod.rs:86:9
2023-10-12T19:08:14.8443149Z coffee_1  |   14: tokio::runtime::runtime::Runtime::block_on
2023-10-12T19:08:14.8444474Z coffee_1  |              at /root/.cargo/registry/src/index.crates.io-6f17d22bba15001f/tokio-1.29.1/src/runtime/runtime.rs:313:45
2023-10-12T19:08:14.8518051Z coffee_1  |   15: tests::coffee_httpd_integration_tests::httpd_init_add_remote::ntest_callback
2023-10-12T19:08:14.8519205Z coffee_1  |              at ./src/coffee_httpd_integration_tests.rs:68:5
2023-10-12T19:08:14.8520646Z coffee_1  |   16: tests::coffee_httpd_integration_tests::httpd_init_add_remote::{{closure}}
2023-10-12T19:08:14.8521779Z coffee_1  |              at ./src/coffee_httpd_integration_tests.rs:10:1
2023-10-12T19:08:14.8522968Z coffee_1  | note: Some details are omitted, run with `RUST_BACKTRACE=full` for a verbose backtrace.
2023-10-12T19:08:14.8524953Z coffee_1  | thread 'coffee_httpd_integration_tests::httpd_init_add_remote' panicked at tests/src/coffee_httpd_integration_tests.rs:10:1:
2023-10-12T19:08:14.8526121Z coffee_1  | explicit panic
2023-10-12T19:08:14.8529703Z coffee_1  | stack backtrace:
2023-10-12T19:08:14.8530536Z coffee_1  |    0: std::panicking::begin_panic
2023-10-12T19:08:14.8531666Z coffee_1  |              at /rustc/cc66ad468955717ab92600c770da8c1601a4ff33/library/std/src/panicking.rs:627:12
2023-10-12T19:08:14.8532974Z coffee_1  |    1: tests::coffee_httpd_integration_tests::httpd_init_add_remote
2023-10-12T19:08:14.8533980Z coffee_1  |              at ./src/coffee_httpd_integration_tests.rs:10:1
2023-10-12T19:08:14.8535092Z coffee_1  |    2: tests::coffee_httpd_integration_tests::httpd_init_add_remote::{{closure}}
2023-10-12T19:08:14.8536173Z coffee_1  |              at ./src/coffee_httpd_integration_tests.rs:11:38
2023-10-12T19:08:14.8537082Z coffee_1  |    3: core::ops::function::FnOnce::call_once
2023-10-12T19:08:14.8538268Z coffee_1  |              at /rustc/cc66ad468955717ab92600c770da8c1601a4ff33/library/core/src/ops/function.rs:250:5
2023-10-12T19:08:14.8539415Z coffee_1  |    4: core::ops::function::FnOnce::call_once
2023-10-12T19:08:14.8540589Z coffee_1  |              at /rustc/cc66ad468955717ab92600c770da8c1601a4ff33/library/core/src/ops/function.rs:250:5
2023-10-12T19:08:14.8542270Z coffee_1  | note: Some details are omitted, run with `RUST_BACKTRACE=full` for a verbose backtrace.
2023-10-12T19:08:14.8544121Z coffee_1  | 
2023-10-12T19:08:14.8544513Z coffee_1  | 

Unrelated failure but we should debug it @tareknaser

[tareknaser]

Unrelated failure but we should debug it @tareknaser

This is the error we encountered before https://github.com/coffee-tools/coffee/issues/201 and this was an effort to make the tests easier to debug https://github.com/coffee-tools/coffee/pulls?q=is%3Apr+is%3Aclosed

Here is the error: https://github.com/coffee-tools/coffee/actions/runs/6499793279/job/17653875473?pr=207#step:3:4210 seems like a python library cffi is missing but I don't know why it passes sometimes.

[vincenzopalazzo]

Thanks good catch @tareknaser

I open a issue for it