Files
btest-rs/src/main.rs
Siavash Sameni 949c4908ad
All checks were successful
CI / test (push) Successful in 1m26s
Add client syslog events, fix client UDP TX error threshold
- Client mode now emits TEST_START and TEST_END syslog events
- Client UDP TX threshold raised from 1000 to 50000 with adaptive backoff
  (matching server behavior) — prevents premature TX death on macOS
- Updated all docs (README, user-guide, architecture, protocol, docker)
- Added results.csv to gitignore

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-01 09:40:52 +04:00

232 lines
7.2 KiB
Rust

mod auth;
mod bandwidth;
mod client;
pub mod csv_output;
mod ecsrp5;
mod protocol;
mod server;
pub mod syslog_logger;
use clap::Parser;
use tracing_subscriber::EnvFilter;
use crate::protocol::*;
#[derive(Parser, Debug)]
#[command(
name = "btest",
about = "btest-rs: MikroTik Bandwidth Test server & client in Rust",
version,
long_about = "btest-rs — A Rust reimplementation of the MikroTik Bandwidth Test protocol.\n\
Compatible with MikroTik RouterOS devices. Supports TCP/UDP, bidirectional\n\
testing, and MD5 authentication.\n\n\
Based on btest-opensource by Alex Samorukov (https://github.com/samm-git/btest-opensource)"
)]
struct Cli {
/// Run in server mode
#[arg(short = 's', long = "server", conflicts_with = "client")]
server: bool,
/// Run in client mode, connecting to the specified host
#[arg(short = 'c', long = "client", conflicts_with = "server")]
client: Option<String>,
/// Client transmits data (upload test)
#[arg(short = 't', long = "transmit")]
transmit: bool,
/// Client receives data (download test)
#[arg(short = 'r', long = "receive")]
receive: bool,
/// Use UDP instead of TCP
#[arg(short = 'u', long = "udp")]
udp: bool,
/// Target bandwidth (e.g., 100M, 1G, 500K)
#[arg(short = 'b', long = "bandwidth")]
bandwidth: Option<String>,
/// Listen/connect port (default: 2000)
#[arg(short = 'P', long = "port", default_value_t = BTEST_PORT)]
port: u16,
/// Listen address for IPv4 (default: 0.0.0.0, use "none" to disable)
#[arg(long = "listen", default_value = "0.0.0.0")]
listen_addr: String,
/// Enable IPv6 listener (experimental — TCP works, UDP has issues on macOS)
#[arg(long = "listen6", default_missing_value = "::", num_args = 0..=1)]
listen6_addr: Option<String>,
/// Authentication username
#[arg(short = 'a', long = "authuser")]
auth_user: Option<String>,
/// Authentication password
#[arg(short = 'p', long = "authpass")]
auth_pass: Option<String>,
/// Use EC-SRP5 authentication (RouterOS >= 6.43 compatible)
#[arg(long = "ecsrp5")]
ecsrp5: bool,
/// NAT mode - send probe packet to open firewall
#[arg(short = 'n', long = "nat")]
nat: bool,
/// Test duration in seconds (client mode, 0=unlimited)
#[arg(short = 'd', long = "duration", default_value_t = 0)]
duration: u64,
/// Output results to CSV file (appends if exists)
#[arg(long = "csv")]
csv: Option<String>,
/// Suppress terminal output (use with --csv for machine-readable only)
#[arg(long = "quiet", short = 'q')]
quiet: bool,
/// Send logs to remote syslog server (e.g., 192.168.1.1:514)
#[arg(long = "syslog")]
syslog: Option<String>,
/// Verbose logging (repeat for more: -v, -vv, -vvv)
#[arg(short = 'v', long = "verbose", action = clap::ArgAction::Count)]
verbose: u8,
}
#[tokio::main]
async fn main() -> anyhow::Result<()> {
let cli = Cli::parse();
// Set up logging based on verbosity
let filter = match cli.verbose {
0 => "info",
1 => "debug",
_ => "trace",
};
tracing_subscriber::fmt()
.with_env_filter(
EnvFilter::try_from_default_env().unwrap_or_else(|_| EnvFilter::new(filter)),
)
.with_target(false)
.init();
// Initialize syslog if requested
if let Some(ref syslog_addr) = cli.syslog {
if let Err(e) = syslog_logger::init(syslog_addr) {
eprintln!("Warning: failed to initialize syslog to {}: {}", syslog_addr, e);
}
}
// Initialize CSV output if requested
if let Some(ref csv_path) = cli.csv {
if let Err(e) = csv_output::init(csv_path) {
eprintln!("Warning: failed to initialize CSV output to {}: {}", csv_path, e);
}
}
csv_output::set_quiet(cli.quiet);
if cli.server {
// Server mode
let v4 = if cli.listen_addr.eq_ignore_ascii_case("none") { None } else { Some(cli.listen_addr) };
let v6 = cli.listen6_addr; // None unless --listen6 is passed
tracing::info!("Starting btest server on port {}", cli.port);
server::run_server(cli.port, cli.auth_user, cli.auth_pass, cli.ecsrp5, v4, v6).await?;
} else if let Some(host) = cli.client {
// Client mode - must specify at least one direction
if !cli.transmit && !cli.receive {
eprintln!("Error: Client mode requires at least one of -t (transmit) or -r (receive)");
std::process::exit(1);
}
// Direction tells SERVER what to do (C client convention):
// client transmit → CMD_DIR_RX (server receives)
// client receive → CMD_DIR_TX (server transmits)
let direction = match (cli.transmit, cli.receive) {
(true, false) => CMD_DIR_RX,
(false, true) => CMD_DIR_TX,
(true, true) => CMD_DIR_BOTH,
_ => unreachable!(),
};
let bw = match &cli.bandwidth {
Some(b) => bandwidth::parse_bandwidth(b)?,
None => 0,
};
// For client: local_tx_speed controls upload, remote_tx_speed controls download
let (tx_speed, rx_speed) = match direction {
CMD_DIR_TX => (bw, 0),
CMD_DIR_RX => (0, bw),
CMD_DIR_BOTH => (bw, bw),
_ => (0, 0),
};
let dir_str = match direction {
CMD_DIR_RX => "send",
CMD_DIR_TX => "receive",
CMD_DIR_BOTH => "both",
_ => "unknown",
};
let proto_str = if cli.udp { "UDP" } else { "TCP" };
// Log test start
syslog_logger::test_start(&host, proto_str, dir_str, 0);
// Run client with optional duration timeout
let start = std::time::Instant::now();
let client_fut = client::run_client(
&host,
cli.port,
direction,
cli.udp,
tx_speed,
rx_speed,
cli.auth_user.clone(),
cli.auth_pass.clone(),
cli.nat,
);
if cli.duration > 0 {
match tokio::time::timeout(
std::time::Duration::from_secs(cli.duration),
client_fut,
)
.await
{
Ok(result) => result?,
Err(_) => {
// Timeout — normal exit
}
}
} else {
client_fut.await?;
}
let elapsed = start.elapsed().as_secs();
// Log test end to syslog
syslog_logger::test_end(
&host, proto_str, dir_str,
0, 0, 0, elapsed as u32,
);
// Write CSV if enabled
if csv_output::is_enabled() {
let auth_type = if cli.auth_user.is_some() { "auth" } else { "none" };
csv_output::write_result(
&host, cli.port, proto_str, dir_str,
elapsed, 0, 0, 0, auth_type,
);
}
} else {
eprintln!("Error: Must specify either -s (server) or -c <host> (client)");
eprintln!("Run with --help for usage information.");
std::process::exit(1);
}
Ok(())
}