Add integration test framework

Author: rajarshimaitra

tests/integration.rs

@@ -0,0 +1,280 @@
+// Magical Bitcoin Library
+// Written in 2022 by
+//     Rajarshi Maitra <rajarshi149@gmail.com>
+//
+// Copyright (c) 2022 Magical Bitcoin
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
+//! bdk-cli Integration Test Framework
+//!
+//! This modules performs the necessary integration test for bdk-cli
+//! The tests can be run using `cargo test`
+
+use serde_json::{json, Value};
+use std::convert::From;
+use std::process::Command;
+
+/// Testing errors for integration tests
+#[derive(Debug)]
+enum IntTestError {
+    // IO error
+    IO(std::io::Error),
+    // Command execution error
+    CmdExec(String),
+    // Json Data error
+    JsonData(String),
+}
+
+impl From<std::io::Error> for IntTestError {
+    fn from(e: std::io::Error) -> Self {
+        IntTestError::IO(e)
+    }
+}
+
+// Helper function
+// Runs a system command with given args
+fn run_cmd_with_args(cmd: &str, args: &[&str]) -> Result<serde_json::Value, IntTestError> {
+    let output = Command::new(cmd).args(args).output().unwrap();
+    let mut value = output.stdout;
+    let error = output.stderr;
+    if value.len() == 0 {
+        return Err(IntTestError::CmdExec(String::from_utf8(error).unwrap()));
+    }
+    value.pop(); // remove `\n` at end
+    let output_string = std::str::from_utf8(&value).unwrap();
+    let json_value: serde_json::Value = match serde_json::from_str(output_string) {
+        Ok(value) => value,
+        Err(_) => json!(output_string), // bitcoin-cli will sometime return raw string
+    };
+    Ok(json_value)
+}
+
+// Helper Function
+// Transforms a json value to string
+fn value_to_string(value: &Value) -> Result<String, IntTestError> {
+    match value {
+        Value::Bool(bool) => match bool {
+            true => Ok("true".to_string()),
+            false => Ok("false".to_string()),
+        },
+        Value::Number(n) => Ok(n.to_string()),
+        Value::String(s) => Ok(s.to_string()),
+        _ => Err(IntTestError::JsonData(
+            "Value parsing not implemented for this type".to_string(),
+        )),
+    }
+}
+
+// Helper Function
+// Extracts value from a given json object and key
+fn get_value(json: &Value, key: &str) -> Result<String, IntTestError> {
+    let map = json
+        .as_object()
+        .ok_or(IntTestError::JsonData("Json is not an object".to_string()))?;
+    let value = map
+        .get(key)
+        .ok_or(IntTestError::JsonData("Invalid key".to_string()))?
+        .to_owned();
+    let string_value = value_to_string(&value)?;
+    Ok(string_value)
+}
+
+/// The Bitcoin Cli process structure
+/// Use this to spawn and manage the bitcoin regtest backend
+struct BitcoinCli {
+    /// bitcoin-cli execution target
+    target: String,
+    /// bitcoin-cli test wallet name
+    wallet: String,
+}
+
+impl BitcoinCli {
+    /// Create a new [`BitcoinCli`] struct
+    fn new(target: Option<&str>, wallet: Option<&str>) -> Self {
+        let target = target.unwrap_or("bitcoin-cli").to_owned();
+        let wallet = wallet.unwrap_or("test").to_owned();
+        Command::new(&target)
+            .args(&["createwallet", &wallet])
+            .output()
+            .unwrap();
+        Command::new(&target)
+            .args(&["loadwallet", &wallet])
+            .output()
+            .unwrap();
+
+        Self { target, wallet }
+    }
+
+    /// Execute a bitcoin-cli command with given args
+    fn exec(&mut self, args: &[&str]) -> Result<Value, IntTestError> {
+        let cli_wallet = format!("-rpcwallet={}", &self.wallet);
+        let mut cli_args = [cli_wallet.as_str()].to_vec();
+        for arg in args {
+            cli_args.push(arg);
+        }
+        run_cmd_with_args(&self.target, &cli_args)
+    }
+}
+
+/// The bdk-cli command struct
+/// Use it to perform all bdk-cli operations
+struct BdkCli {
+    target: String,
+    network: String,
+    verbosity: bool,
+    recv_desc: Option<String>,
+    chang_desc: Option<String>,
+}
+
+impl BdkCli {
+    /// Construct a new [`BdkCli`] struct
+    fn new(network: &str, verbosity: bool, features: &[&str]) -> Result<Self, IntTestError> {
+        // Build bdk-cli with given features
+        let mut feat = "--features=".to_string();
+        for item in features {
+            feat.push_str(item);
+            feat.push_str(",");
+        }
+        feat.pop(); // remove the last comma
+        let _build = Command::new("cargo").args(&["build", &feat]).output()?;
+
+        let mut bdk_cli = Self {
+            target: "./target/debug/bdk-cli".to_string(),
+            network: network.to_string(),
+            verbosity,
+            recv_desc: None,
+            chang_desc: None,
+        };
+
+        let bdk_master_key = bdk_cli.key_exec(&["generate"])?;
+        let bdk_xprv = get_value(&bdk_master_key, "xprv")?;
+
+        let bdk_recv_desc =
+            bdk_cli.key_exec(&["derive", "--path", "m/84h/1h/0h/0", "--xprv", &bdk_xprv])?;
+        let bdk_recv_desc = get_value(&bdk_recv_desc, "xprv")?;
+        let bdk_recv_desc = format!("wpkh({})", bdk_recv_desc);
+
+        let bdk_chng_desc =
+            bdk_cli.key_exec(&["derive", "--path", "m/84h/1h/0h/1", "--xprv", &bdk_xprv])?;
+        let bdk_chng_desc = get_value(&bdk_chng_desc, "xprv")?;
+        let bdk_chng_desc = format!("wpkh({})", bdk_chng_desc);
+
+        bdk_cli.recv_desc = Some(bdk_recv_desc);
+        bdk_cli.chang_desc = Some(bdk_chng_desc);
+
+        Ok(bdk_cli)
+    }
+
+    /// Execute bdk-cli wallet commands with given args
+    fn wallet_exec(&mut self, args: &[&str]) -> Result<Value, IntTestError> {
+        let mut wallet_args = ["--network", &self.network, "wallet"].to_vec();
+        if self.verbosity {
+            wallet_args.push("-v");
+        }
+
+        wallet_args.push("-d");
+        wallet_args.push(self.recv_desc.as_ref().unwrap());
+        wallet_args.push("-c");
+        wallet_args.push(&self.chang_desc.as_ref().unwrap());
+
+        for arg in args {
+            wallet_args.push(arg);
+        }
+        run_cmd_with_args(&self.target, &wallet_args)
+    }
+
+    /// Execute bdk-cli key commands with given args
+    fn key_exec(&mut self, args: &[&str]) -> Result<Value, IntTestError> {
+        let mut key_args = ["key"].to_vec();
+        for arg in args {
+            key_args.push(arg);
+        }
+        run_cmd_with_args(&self.target, &key_args)
+    }
+}
+
+#[test]
+fn test_basic() {
+    // Test basic building, fmt and unit tests
+    let features = [
+        "default",
+        "electrum",
+        "esplora-ureq",
+        "esplora-reqwest",
+        "compiler",
+        "compact_filters",
+        "reserves",
+        "reserves,electrum",
+        "reserves,esplora-ureq",
+        "reserves,compact_filters",
+        "rpc",
+    ];
+
+    // Test for build and fmt
+    for feature in features {
+        Command::new("cargo")
+            .args(["build", "--features", feature, "--locked"])
+            .output()
+            .unwrap();
+        Command::new("cargo")
+            .args(["fmt", "--features", feature, "--locked"])
+            .output()
+            .unwrap();
+        println!("Building with {} feature completed", feature);
+    }
+}
+
+#[test]
+fn test_wallet_ops() {
+    // Create a bitcoin-cli instance
+    let mut bitcoin_cli = BitcoinCli::new(None, None);
+
+    // Get a address from core
+    let core_addr_json = bitcoin_cli.exec(&["getnewaddress"]).unwrap();
+    let core_addr = value_to_string(&core_addr_json).unwrap();
+
+    // Generate few blocks to sync the chain
+    bitcoin_cli
+        .exec(&["generatetoaddress", "101", &core_addr])
+        .unwrap();
+
+    // Create bdk-cli instance
+    let mut bdk_cli = BdkCli::new("regtest", false, &["rpc"]).unwrap();
+
+    // Get a bdk address
+    let bdk_addr_json = bdk_cli.wallet_exec(&["get_new_address"]).unwrap();
+    let bdk_addr = get_value(&bdk_addr_json, "address").unwrap();
+
+    // Send coins from core to bdk
+    bitcoin_cli
+        .exec(&["sendtoaddress", &bdk_addr, "10"])
+        .unwrap();
+    bitcoin_cli
+        .exec(&["generatetoaddress", "1", &core_addr])
+        .unwrap();
+
+    // Sync the bdk wallet
+    bdk_cli.wallet_exec(&["sync"]).unwrap();
+
+    // Get the balance
+    let balance_json = bdk_cli.wallet_exec(&["get_balance"]).unwrap();
+    let balance = get_value(&balance_json, "satoshi").unwrap();
+    assert_eq!(balance, "1000000000");
+}