Merge #26: test: Add testenv module

f1db39a ci: Run `test_rpc_client` integration tests (valued mammal)
ee52af4 test: Improve unit, integration tests (valued mammal)
d77416c error: Unimplement `Error::source` (valued mammal)

Pull request description:

  ### Description

  This is a follow up to #5 that introduces a `TestEnv` struct used for integration tests and fixes a number of nitpicks that were previously left out.

  Summary:

  - Add simple `TestEnv` struct with convenient interface for improved ergonomics
  - Avoid manually implementing RPC calls (e.g. `generate_to_address`)
  - Move auth tests to `client::test_auth` module
  - Ignore (or remove) test using potentially insecure `std::env::tempdir`
  - Don't call `node.stop()`, as this is handled by the `Drop` implementation of `Node`
  - Add missing tests for existing RPC methods `get_block_verbose`, `get_block_header_verbose`
  - Don't print to stdout
  - Have more effective test assertions. For example it's sufficient to check that the RPC method returns the expected type. Keep some basic "sanity check" assertions, but try to avoid testing functionality that is defined outside of this library (e.g. the length of a `BlockHash`, and Bitcoin Core itself).

  ### Checklists

  #### All Submissions:

  * [x] I've signed all my commits
  * [x] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk/blob/master/CONTRIBUTING.md)
  * [x] I ran `cargo fmt` and `cargo clippy` before committing

ACKs for top commit:
  ValuedMammal:
    self-ACK f1db39a

Tree-SHA512: 3634e0e00ed910b979eb998ad13b6a786f827a679495a12237c543a9a8e291eb04602cf0105753fa56dc542cdb57471d87bf630b8afee3bd1564d558cb1b016b

Author: ValuedMammal

.github/workflows/cont_integration.yml

@@ -79,6 +79,9 @@ jobs:
       - name: Run doc tests
         run: cargo test ${{ matrix.features }} --doc --verbose
 
+      - name: Run RPC client tests
+        run: cargo test --test test_rpc_client --verbose -- --test-threads=2
+
   # MSRV
   msrv:
     name: MSRV

Cargo.lock

@@ -22,4 +22,5 @@ default = ["30_0"]
 28_0 = []
 
 [dev-dependencies]
+anyhow = "1"
 corepc-node = { version = "0.10.1", features = ["download", "29_0"] }

Cargo.toml

@@ -284,6 +284,7 @@ mod test_auth {
     }
 
     #[test]
+    #[ignore = "modifies the local filesystem"]
     fn test_auth_cookie_file_get_user_pass() {
         let temp_dir = std::env::temp_dir();
         let cookie_path = temp_dir.join("test_auth_cookie");
@@ -299,4 +300,14 @@ mod test_auth {
 
         std::fs::remove_file(cookie_path).ok();
     }
+
+    #[test]
+    fn test_auth_invalid_cookie_file() {
+        let dummy_url = "http://127.0.0.1:18443";
+        let cookie_path = PathBuf::from("/nonexistent/path/to/cookie");
+
+        let result = Client::with_auth(dummy_url, Auth::CookieFile(cookie_path));
+
+        assert!(matches!(result, Err(Error::InvalidCookieFile)));
+    }
 }

src/client.rs

@@ -67,22 +67,7 @@ impl fmt::Display for Error {
     }
 }
 
-impl std::error::Error for Error {
-    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
-        match self {
-            Error::DecodeHex(e) => Some(e),
-            Error::JsonRpc(e) => Some(e),
-            Error::HexToArray(e) => Some(e),
-            Error::Json(e) => Some(e),
-            Error::Io(e) => Some(e),
-            Error::TryFromInt(e) => Some(e),
-            Error::GetBlockVerboseOne(e) => Some(e),
-            Error::GetBlockHeaderVerbose(e) => Some(e),
-            Error::GetBlockFilter(e) => Some(e),
-            _ => None,
-        }
-    }
-}
+impl std::error::Error for Error {}
 
 // Conversions from other error types
 impl From<jsonrpc::Error> for Error {