chore: move out the CLI module from the library (dfinity#3169)

CLIs should belong to the binary target

Author: rumenov

rs/bitcoin/adapter/BUILD.bazel

@@ -1,8 +1,6 @@
 load("@rules_rust//rust:defs.bzl", "rust_binary", "rust_library", "rust_test", "rust_test_suite")
 load("//bazel:defs.bzl", "rust_bench")
 
-package(default_visibility = ["//visibility:private"])
-
 DEPENDENCIES = [
     # Keep sorted.
     "//rs/bitcoin/service",
@@ -12,7 +10,6 @@ DEPENDENCIES = [
     "//rs/monitoring/logger",
     "//rs/monitoring/metrics",
     "@crate_index//:bitcoin",
-    "@crate_index//:clap",
     "@crate_index//:futures",
     "@crate_index//:hashlink",
     "@crate_index//:hex",
@@ -50,39 +47,45 @@ DEV_DEPENDENCIES = [
 
 MACRO_DEV_DEPENDENCIES = []
 
-ALIASES = {}
-
 rust_library(
     name = "adapter",
-    srcs = glob(["src/**"]),
-    aliases = ALIASES,
+    srcs = glob(
+        ["src/**"],
+        exclude = [
+            "src/main.rs",
+            "src/cli.rs",
+            "src/stress_test.rs",
+        ],
+    ),
     crate_name = "ic_btc_adapter",
     proc_macro_deps = MACRO_DEPENDENCIES,
-    version = "0.1.0",
     visibility = ["//rs/pocket_ic_server:__subpackages__"],
     deps = DEPENDENCIES,
 )
 
 rust_binary(
     name = "ic-btc-adapter",
-    srcs = ["src/main.rs"],
-    aliases = ALIASES,
+    srcs = [
+        "src/cli.rs",
+        "src/main.rs",
+    ],
     proc_macro_deps = MACRO_DEPENDENCIES,
     visibility = ["//rs:release-pkg"],
     deps = DEPENDENCIES + [
         ":adapter",
         "//rs/monitoring/adapter_metrics/server",
+        "@crate_index//:clap",
     ],
 )
 
 rust_binary(
     name = "adapter-stress-test",
     srcs = ["src/stress_test.rs"],
-    aliases = ALIASES,
     proc_macro_deps = MACRO_DEPENDENCIES,
     deps = DEPENDENCIES + [
         ":adapter",
         "//rs/monitoring/adapter_metrics/server",
+        "@crate_index//:clap",
         "@crate_index//:hyper-util",
     ],
 )
@@ -102,7 +105,6 @@ rust_test_suite(
     name = "adapter_integration",
     timeout = "long",
     srcs = glob(["tests/**/*.rs"]),
-    aliases = ALIASES,
     data = [
         # Keep sorted.
         "//:bitcoind",
@@ -127,7 +129,6 @@ rust_bench(
     name = "e2e_bench",
     testonly = True,
     srcs = ["benches/e2e.rs"],
-    aliases = ALIASES,
     proc_macro_deps = MACRO_DEPENDENCIES + MACRO_DEV_DEPENDENCIES,
     deps = DEPENDENCIES + DEV_DEPENDENCIES + [":adapter"],
 )

rs/bitcoin/adapter/benches/e2e.rs

@@ -2,9 +2,7 @@ use bitcoin::{
     block::Header as BlockHeader, blockdata::constants::genesis_block, BlockHash, Network,
 };
 use criterion::{criterion_group, criterion_main, Criterion};
-use ic_btc_adapter::config::Config;
-use ic_btc_adapter::config::IncomingSource;
-use ic_btc_adapter::start_server;
+use ic_btc_adapter::{start_server, Config, IncomingSource};
 use ic_btc_adapter_client::setup_bitcoin_adapter_clients;
 use ic_btc_adapter_test_utils::generate_headers;
 use ic_btc_replica_types::BitcoinAdapterRequestWrapper;

rs/bitcoin/adapter/src/cli.rs

@@ -1,7 +1,7 @@
 //! A parser for the command line flags and configuration file.
-use crate::config::{address_limits, Config};
 use clap::Parser;
 use http::Uri;
+use ic_btc_adapter::{address_limits, Config};
 use std::{fs::File, io, path::PathBuf};
 use thiserror::Error;
 
@@ -54,7 +54,7 @@ impl Cli {
 #[cfg(test)]
 pub mod test {
     use super::*;
-    use crate::config::IncomingSource;
+    use crate::IncomingSource;
     use bitcoin::Network;
     use std::io::Write;
     use std::path::PathBuf;

rs/bitcoin/adapter/src/config.rs

@@ -58,7 +58,7 @@ fn default_idle_seconds() -> u64 {
 
 /// This function is used to get the address limits for the `AddressBook`
 /// based on the provided `Network`.
-pub(crate) fn address_limits(network: Network) -> (usize, usize) {
+pub fn address_limits(network: Network) -> (usize, usize) {
     match network {
         Network::Bitcoin => (500, 2000),
         Network::Testnet => (100, 1000),

rs/bitcoin/adapter/src/lib.rs

@@ -25,8 +25,6 @@ mod addressbook;
 mod blockchainmanager;
 /// This module contains the data structure for storing the current state of the Bitcoin ledger
 mod blockchainstate;
-/// This module contains command line arguments parser.
-pub mod cli;
 /// This module contains constants and types that are shared by many modules.
 mod common;
 /// This module contains the basic configuration struct used to start up an
@@ -53,6 +51,8 @@ mod transaction_store;
 // malicious fork can be prioritized by a DFS, thus potentially ignoring honest forks).
 mod get_successors_handler;
 
+pub use config::{address_limits, Config, IncomingSource};
+
 use crate::{
     blockchainstate::BlockchainState, get_successors_handler::GetSuccessorsHandler,
     router::start_main_event_loop, rpc_server::start_grpc_server, stream::StreamEvent,

rs/bitcoin/adapter/src/main.rs

@@ -1,22 +1,23 @@
 use clap::Parser;
 use ic_adapter_metrics_server::start_metrics_grpc;
-use ic_btc_adapter::config::IncomingSource;
-use ic_btc_adapter::{cli::Cli, start_server};
+use ic_btc_adapter::{start_server, IncomingSource};
 use ic_http_endpoints_async_utils::abort_on_panic;
 use ic_http_endpoints_async_utils::incoming_from_nth_systemd_socket;
 use ic_http_endpoints_async_utils::shutdown_signal;
 use ic_logger::{info, new_replica_logger_from_config};
 use ic_metrics::MetricsRegistry;
 use serde_json::to_string_pretty;
 
+mod cli;
+
 #[tokio::main]
 pub async fn main() {
     // We abort the whole program with a core dump if a single thread panics.
     // This way we can capture all the context if a critical error
     // happens.
     abort_on_panic();
 
-    let cli = Cli::parse();
+    let cli = cli::Cli::parse();
     let config = match cli.get_config() {
         Ok(config) => config,
         Err(err) => {

rs/bitcoin/adapter/src/rpc_server.rs

@@ -1,9 +1,9 @@
 use crate::{
     blockchainstate::BlockchainState,
-    config::{Config, IncomingSource},
     get_successors_handler::{GetSuccessorsRequest, GetSuccessorsResponse},
     metrics::{ServiceMetrics, LABEL_GET_SUCCESSOR, LABEL_SEND_TRANSACTION},
-    BlockchainManagerRequest, GetSuccessorsHandler, TransactionManagerRequest,
+    BlockchainManagerRequest, Config, GetSuccessorsHandler, IncomingSource,
+    TransactionManagerRequest,
 };
 use bitcoin::{consensus::Encodable, hashes::Hash, BlockHash};
 use ic_btc_service::{

rs/bitcoin/adapter/src/stress_test.rs

@@ -1,5 +1,6 @@
 use std::{convert::TryFrom, path::PathBuf, time::Duration};
 
+use bitcoin::Network;
 use bitcoin::{blockdata::constants::genesis_block, consensus::Decodable, Block, BlockHash};
 use clap::Parser;
 use ic_btc_service::{
@@ -13,8 +14,6 @@ use tokio::{
 use tonic::transport::{Channel, Endpoint, Uri};
 use tower::service_fn;
 
-use ic_btc_adapter::{cli::Cli, config::IncomingSource};
-
 async fn setup_channel(uds_path: PathBuf) -> Channel {
     Endpoint::try_from("http://[::]:50051")
         .expect("failed to make endpoint")
@@ -36,23 +35,26 @@ async fn setup_client(uds_path: PathBuf) -> BtcServiceClient<Channel> {
     BtcServiceClient::new(channel)
 }
 
+/// This struct is use to provide a command line interface to the adapter.
+#[derive(Parser)]
+#[clap(version = "0.0.0", author = "DFINITY team <[email protected]>")]
+pub struct Cli {
+    /// This field contains the path to the config file.
+    pub network: Network,
+    pub uds_path: PathBuf,
+}
+
 #[tokio::main]
 async fn main() {
     let cli = Cli::parse();
-    let config = cli.get_config().expect("Error while reading config file.");
-    let uds_path = if let IncomingSource::Path(uds_path) = config.incoming_source {
-        uds_path
-    } else {
-        panic!("Cannot use systemd as a incoming source.");
-    };
     let interval_sleep_ms = Duration::from_millis(1000);
     let request_timeout_ms = Duration::from_millis(50);
 
-    let block_0 = genesis_block(config.network);
+    let block_0 = genesis_block(cli.network);
     let mut total_processed_block_hashes: usize = 0;
     let mut processed_block_hashes: Vec<BlockHash> = vec![];
     let mut current_anchor = block_0.block_hash();
-    let mut rpc_client = setup_client(uds_path).await;
+    let mut rpc_client = setup_client(cli.uds_path).await;
     let total_timer = Instant::now();
 
     loop {

rs/bitcoin/adapter/tests/adapter_test.rs

@@ -1,10 +1,7 @@
 use bitcoin::{consensus::encode::deserialize, Address, Amount, Block, BlockHash};
 use bitcoincore_rpc::{bitcoincore_rpc_json::CreateRawTransactionInput, Auth, Client, RpcApi};
 use bitcoind::{BitcoinD, Conf, P2P};
-use ic_btc_adapter::{
-    config::{Config, IncomingSource},
-    start_server,
-};
+use ic_btc_adapter::{start_server, Config, IncomingSource};
 use ic_btc_adapter_client::setup_bitcoin_adapter_clients;
 use ic_btc_interface::Network;
 use ic_btc_replica_types::{

rs/https_outcalls/adapter/BUILD.bazel

@@ -1,7 +1,5 @@
 load("@rules_rust//rust:defs.bzl", "rust_binary", "rust_library", "rust_test", "rust_test_suite")
 
-package(default_visibility = ["//visibility:private"])
-
 DEPENDENCIES = [
     # Keep sorted.
     "//rs/config",