Lines
58.59 %
Functions
9.68 %
Branches
100 %
//! BonsaiDb command line tools.
use std::ffi::OsString;
use std::fmt::Debug;
use std::path::PathBuf;
use bonsaidb_client::fabruic::Certificate;
use bonsaidb_client::AsyncClient;
use bonsaidb_core::async_trait::async_trait;
#[cfg(any(feature = "password-hashing", feature = "token-authentication"))]
use bonsaidb_core::connection::AsyncStorageConnection;
use bonsaidb_server::{Backend, CustomServer, NoBackend, ServerConfiguration};
use clap::{Parser, Subcommand};
use url::Url;
use crate::AnyServerConnection;
/// All available command line commands.
#[derive(Subcommand, Debug)]
pub enum Command<Cli: CommandLine> {
/// Execute a BonsaiDb server command.
#[clap(flatten)]
Server(bonsaidb_server::cli::Command<Cli::Backend>),
/// An external command.
External(Cli::Subcommand),
}
impl<Cli> Command<Cli>
where
Cli: CommandLine,
{
/// Executes the command.
// TODO add client builder insetad of server_url
pub async fn execute(
self,
server_url: Option<Url>,
pinned_certificate: Option<Certificate>,
#[cfg(feature = "password-hashing")] username: Option<String>,
#[cfg(feature = "token-authentication")] token_id: Option<u64>,
mut cli: Cli,
) -> anyhow::Result<()> {
match self {
Command::Server(server) => {
if server_url.is_some() {
anyhow::bail!("server url provided for local-only command.")
server.execute_on(cli.open_server().await?).await?;
Command::External(command) => {
let connection = if let Some(server_url) = server_url {
// TODO how does custom API handling work here?
let mut client = AsyncClient::build(server_url);
if let Some(certificate) = pinned_certificate {
client = client.with_certificate(certificate);
AnyServerConnection::Networked(client.build()?)
} else {
AnyServerConnection::Local(cli.open_server().await?)
};
#[cfg(feature = "password-hashing")]
let connection = if let Some(username) = username {
let password = bonsaidb_local::cli::read_password_from_stdin(false)?;
connection
.authenticate_with_password(&username, password)
.await?
#[cfg(feature = "token-authentication")]
let connection = if let Some(token_id) = token_id {
let token = bonsaidb_core::connection::SensitiveString(std::env::var(
"BONSAIDB_TOKEN_SECRET",
)?);
connection.authenticate_with_token(token_id, &token).await?
cli.execute(command, connection).await?;
Ok(())
/// The command line interface for `bonsaidb`.
#[derive(Parser, Debug)]
pub struct Args<Cli: CommandLine> {
/// A url to a remote server.
#[clap(long)]
pub url: Option<Url>,
/// A pinned certificate to use when connecting to `url`.
#[clap(short = 'c', long)]
pub pinned_certificate: Option<PathBuf>,
/// A token ID to authenticate as before executing the command. Use
/// environment variable `BONSAIDB_TOKEN_SECRET` to provide the
#[clap(long = "token", short = 't')]
pub token_id: Option<u64>,
/// A user to authenticate as before executing the command. The password
/// will be prompted for over stdin. When writing a script for headless
/// automation, token authentication should be preferred.
#[clap(long = "username", short = 'u')]
pub username: Option<String>,
/// The command to execute on the connection specified.
#[clap(subcommand)]
pub command: Command<Cli>,
impl<Cli: CommandLine> Args<Cli> {
pub async fn execute(self, cli: Cli) -> anyhow::Result<()> {
let pinned_certificate = if let Some(cert_path) = self.pinned_certificate {
let bytes = tokio::fs::read(cert_path).await?;
Some(Certificate::from_der(bytes)?)
None
self.command
.execute(
self.url,
pinned_certificate,
self.username,
self.token_id,
cli,
)
.await
/// A command line interface that can be executed with either a remote or local
/// connection to a server.
#[async_trait]
pub trait CommandLine: Sized + Send + Sync {
/// The Backend for this command line.
type Backend: Backend;
/// The [`Subcommand`] which is embedded next to the built-in BonsaiDb
/// commands.
type Subcommand: Subcommand + Send + Sync + Debug;
/// Runs the command-line interface using command-line arguments from the
/// environment.
async fn run(self) -> anyhow::Result<()> {
Args::<Self>::parse().execute(self).await
/// Runs the command-line interface using the specified list of arguments.
async fn run_from<I, T>(self, itr: I) -> anyhow::Result<()>
I: IntoIterator<Item = T> + Send,
T: Into<OsString> + Clone + Send,
Args::<Self>::parse_from(itr).execute(self).await
/// Returns a new server initialized based on the same configuration used
/// for [`CommandLine`].
async fn open_server(&mut self) -> anyhow::Result<CustomServer<Self::Backend>> {
Ok(CustomServer::<Self::Backend>::open(self.configuration().await?).await?)
/// Returns the server configuration to use when initializing a local server.
async fn configuration(&mut self) -> anyhow::Result<ServerConfiguration<Self::Backend>>;
/// Execute the command on `connection`.
async fn execute(
&mut self,
command: Self::Subcommand,
connection: AnyServerConnection<Self::Backend>,
) -> anyhow::Result<()>;
impl CommandLine for NoBackend {
type Backend = Self;
type Subcommand = NoSubcommand;
async fn configuration(&mut self) -> anyhow::Result<ServerConfiguration> {
Ok(ServerConfiguration::default())
_connection: AnyServerConnection<Self>,
match command {}
/// Runs the command-line interface with only the built-in commands, using
/// `configuration` to launch a server if running a local command.
pub async fn run<B: Backend>(configuration: ServerConfiguration<B>) -> anyhow::Result<()> {
Args::parse()
.execute(NoCommandLine::<B> {
configuration: Some(configuration),
})
#[derive(Debug)]
struct NoCommandLine<B: Backend> {
configuration: Option<ServerConfiguration<B>>,
impl<B: Backend> CommandLine for NoCommandLine<B> {
type Backend = B;
async fn configuration(&mut self) -> anyhow::Result<ServerConfiguration<B>> {
self.configuration
.take()
.ok_or_else(|| anyhow::anyhow!("configuration already consumed"))
_connection: AnyServerConnection<B>,
/// A [`Subcommand`] implementor that has no options.
#[derive(clap::Subcommand, Debug)]
pub enum NoSubcommand {}