add shell completion

This commit is contained in:
Oystein Kristoffer Tveit 2024-08-19 02:22:18 +02:00
parent 0e38fbb7e9
commit 807017ea70
Signed by: oysteikt
GPG Key ID: 9F2F7D8250F35146
6 changed files with 143 additions and 41 deletions

10
Cargo.lock generated
View File

@ -265,6 +265,15 @@ dependencies = [
"strsim", "strsim",
] ]
[[package]]
name = "clap_complete"
version = "4.5.18"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "1ee158892bd7ce77aa15c208abbdb73e155d191c287a659b57abd5adb92feb03"
dependencies = [
"clap",
]
[[package]] [[package]]
name = "clap_derive" name = "clap_derive"
version = "4.5.13" version = "4.5.13"
@ -1055,6 +1064,7 @@ dependencies = [
"async-bincode", "async-bincode",
"bincode", "bincode",
"clap", "clap",
"clap_complete",
"derive_more", "derive_more",
"dialoguer", "dialoguer",
"env_logger", "env_logger",

View File

@ -8,6 +8,7 @@ anyhow = "1.0.86"
async-bincode = "0.7.2" async-bincode = "0.7.2"
bincode = "1.3.3" bincode = "1.3.3"
clap = { version = "4.5.16", features = ["derive"] } clap = { version = "4.5.16", features = ["derive"] }
clap_complete = "4.5.18"
derive_more = { version = "1.0.0", features = ["display", "error"] } derive_more = { version = "1.0.0", features = ["display", "error"] }
dialoguer = "0.11.0" dialoguer = "0.11.0"
env_logger = "0.11.5" env_logger = "0.11.5"

View File

@ -4,8 +4,10 @@
, cargoToml , cargoToml
, cargoLock , cargoLock
, src , src
, installShellFiles
}: }:
let let
mainProgram = (lib.head cargoToml.bin).name;
in in
rustPlatform.buildRustPackage { rustPlatform.buildRustPackage {
pname = cargoToml.package.name; pname = cargoToml.package.name;
@ -14,9 +16,20 @@ rustPlatform.buildRustPackage {
cargoLock.lockFile = cargoLock; cargoLock.lockFile = cargoLock;
nativeBuildInputs = [ installShellFiles ];
postInstall = let
commands = lib.mapCartesianProduct ({ shell, command }: ''
"$out/bin/${mainProgram}" generate-completions --shell "${shell}" --command "${command}" > "$TMP/mysqladm.${shell}"
installShellCompletion "--${shell}" --cmd "${command}" "$TMP/mysqladm.${shell}"
'') {
shell = [ "bash" "zsh" "fish" ];
command = [ "mysqladm" "mysql-dbadm" "mysql-useradm" ];
};
in lib.concatStringsSep "\n" commands;
meta = with lib; { meta = with lib; {
license = licenses.mit; license = licenses.mit;
platforms = platforms.linux ++ platforms.darwin; platforms = platforms.linux ++ platforms.darwin;
mainProgram = (lib.head cargoToml.bin).name; inherit mainProgram;
}; };
} }

View File

@ -49,7 +49,19 @@ The Y/N-values corresponds to the following mysql privileges:
References - Enables use of REFERENCES References - Enables use of REFERENCES
"#; "#;
/// Create, drop or edit permissions for the DATABASE(s),
/// as determined by the COMMAND.
///
/// This is a compatibility layer for the mysql-dbadm command.
/// Please consider using the newer mysqladm command instead.
#[derive(Parser)] #[derive(Parser)]
#[command(
bin_name = "mysql-dbadm",
version,
about,
disable_help_subcommand = true,
verbatim_doc_comment,
)]
pub struct Args { pub struct Args {
#[command(subcommand)] #[command(subcommand)]
pub command: Option<Command>, pub command: Option<Command>,
@ -82,14 +94,7 @@ pub struct Args {
// NOTE: mysql-dbadm explicitly calls privileges "permissions". // NOTE: mysql-dbadm explicitly calls privileges "permissions".
// This is something we're trying to move away from. // This is something we're trying to move away from.
// See https://git.pvv.ntnu.no/Projects/mysqladm-rs/issues/29 // See https://git.pvv.ntnu.no/Projects/mysqladm-rs/issues/29
/// Create, drop or edit permissions for the DATABASE(s),
/// as determined by the COMMAND.
///
/// This is a compatibility layer for the mysql-dbadm command.
/// Please consider using the newer mysqladm command instead.
#[derive(Parser)] #[derive(Parser)]
#[command(version, about, disable_help_subcommand = true, verbatim_doc_comment)]
pub enum Command { pub enum Command {
/// create the DATABASE(s). /// create the DATABASE(s).
Create(CreateArgs), Create(CreateArgs),

View File

@ -25,7 +25,19 @@ use crate::{
server::sql::user_operations::DatabaseUser, server::sql::user_operations::DatabaseUser,
}; };
/// Create, delete or change password for the USER(s),
/// as determined by the COMMAND.
///
/// This is a compatibility layer for the mysql-useradm command.
/// Please consider using the newer mysqladm command instead.
#[derive(Parser)] #[derive(Parser)]
#[command(
bin_name = "mysql-useradm",
version,
about,
disable_help_subcommand = true,
verbatim_doc_comment,
)]
pub struct Args { pub struct Args {
#[command(subcommand)] #[command(subcommand)]
pub command: Option<Command>, pub command: Option<Command>,
@ -51,13 +63,7 @@ pub struct Args {
config: Option<PathBuf>, config: Option<PathBuf>,
} }
/// Create, delete or change password for the USER(s),
/// as determined by the COMMAND.
///
/// This is a compatibility layer for the mysql-useradm command.
/// Please consider using the newer mysqladm command instead.
#[derive(Parser)] #[derive(Parser)]
#[command(version, about, disable_help_subcommand = true, verbatim_doc_comment)]
pub enum Command { pub enum Command {
/// create the USER(s). /// create the USER(s).
Create(CreateArgs), Create(CreateArgs),

View File

@ -1,7 +1,8 @@
#[macro_use] #[macro_use]
extern crate prettytable; extern crate prettytable;
use clap::Parser; use clap::{CommandFactory, Parser, ValueEnum};
use clap_complete::{generate, Shell};
use std::path::PathBuf; use std::path::PathBuf;
@ -27,7 +28,14 @@ mod core;
#[cfg(feature = "tui")] #[cfg(feature = "tui")]
mod tui; mod tui;
/// Database administration tool for non-admin users to manage their own MySQL databases and users.
///
/// This tool allows you to manage users and databases in MySQL.
///
/// You are only allowed to manage databases and users that are prefixed with
/// either your username, or a group that you are a member of.
#[derive(Parser, Debug)] #[derive(Parser, Debug)]
#[command(bin_name = "mysqladm", version, about, disable_help_subcommand = true)]
struct Args { struct Args {
#[command(subcommand)] #[command(subcommand)]
command: Command, command: Command,
@ -57,14 +65,7 @@ struct Args {
interactive: bool, interactive: bool,
} }
// Database administration tool for non-admin users to manage their own MySQL databases and users.
//
// This tool allows you to manage users and databases in MySQL.
//
// You are only allowed to manage databases and users that are prefixed with
// either your username, or a group that you are a member of.
#[derive(Parser, Debug, Clone)] #[derive(Parser, Debug, Clone)]
#[command(version, about, disable_help_subcommand = true)]
enum Command { enum Command {
#[command(flatten)] #[command(flatten)]
Db(cli::database_command::DatabaseCommand), Db(cli::database_command::DatabaseCommand),
@ -74,6 +75,26 @@ enum Command {
#[command(hide = true)] #[command(hide = true)]
Server(server::command::ServerArgs), Server(server::command::ServerArgs),
#[command(hide = true)]
GenerateCompletions(GenerateCompletionArgs),
}
#[derive(Parser, Debug, Clone)]
struct GenerateCompletionArgs {
#[arg(long, default_value = "bash")]
shell: Shell,
#[arg(long, default_value = "mysqladm")]
command: ToplevelCommands,
}
#[cfg(feature = "mysql-admutils-compatibility")]
#[derive(ValueEnum, Debug, Clone)]
enum ToplevelCommands {
Mysqladm,
MysqlDbadm,
MysqlUseradm,
} }
// TODO: tag all functions that are run with elevated privileges with // TODO: tag all functions that are run with elevated privileges with
@ -86,28 +107,18 @@ fn main() -> anyhow::Result<()> {
env_logger::init(); env_logger::init();
#[cfg(feature = "mysql-admutils-compatibility")] #[cfg(feature = "mysql-admutils-compatibility")]
{ if let Some(_) = handle_mysql_admutils_command()? {
let argv0 = std::env::args().next().and_then(|s| { return Ok(());
PathBuf::from(s)
.file_name()
.map(|s| s.to_string_lossy().to_string())
});
match argv0.as_deref() {
Some("mysql-dbadm") => return mysql_dbadm::main(),
Some("mysql-useradm") => return mysql_useradm::main(),
_ => { /* fall through */ }
}
} }
let args: Args = Args::parse(); let args: Args = Args::parse();
match args.command {
Command::Server(ref command) => { if let Some(_) = handle_server_command(&args)? {
drop_privs()?; return Ok(());
tokio_start_server(args.server_socket_path, args.config, command.clone())?; }
return Ok(());
} if let Some(_) = handle_generate_completions_command(&args)? {
_ => { /* fall through */ } return Ok(());
} }
let server_connection = let server_connection =
@ -118,6 +129,61 @@ fn main() -> anyhow::Result<()> {
Ok(()) Ok(())
} }
fn handle_mysql_admutils_command() -> anyhow::Result<Option<()>> {
let argv0 = std::env::args().next().and_then(|s| {
PathBuf::from(s)
.file_name()
.map(|s| s.to_string_lossy().to_string())
});
match argv0.as_deref() {
Some("mysql-dbadm") => mysql_dbadm::main().map(|result| Some(result)),
Some("mysql-useradm") => mysql_useradm::main().map(|result| Some(result)),
_ => Ok(None),
}
}
fn handle_server_command(args: &Args) -> anyhow::Result<Option<()>> {
match args.command {
Command::Server(ref command) => {
drop_privs()?;
tokio_start_server(
args.server_socket_path.clone(),
args.config.clone(),
command.clone(),
)?;
Ok(Some(()))
}
_ => Ok(None),
}
}
fn handle_generate_completions_command(args: &Args) -> anyhow::Result<Option<()>> {
match args.command {
Command::GenerateCompletions(ref completion_args) => {
let mut cmd = match completion_args.command {
ToplevelCommands::Mysqladm => Args::command(),
#[cfg(feature = "mysql-admutils-compatibility")]
ToplevelCommands::MysqlDbadm => mysql_dbadm::Args::command(),
#[cfg(feature = "mysql-admutils-compatibility")]
ToplevelCommands::MysqlUseradm => mysql_useradm::Args::command(),
};
let binary_name = cmd.get_bin_name().unwrap().to_owned();
generate(
completion_args.shell,
&mut cmd,
binary_name,
&mut std::io::stdout(),
);
Ok(Some(()))
}
_ => Ok(None),
}
}
fn tokio_start_server( fn tokio_start_server(
server_socket_path: Option<PathBuf>, server_socket_path: Option<PathBuf>,
config_path: Option<PathBuf>, config_path: Option<PathBuf>,
@ -148,6 +214,7 @@ fn tokio_run_command(command: Command, server_connection: StdUnixStream) -> anyh
cli::database_command::handle_command(db_args, message_stream).await cli::database_command::handle_command(db_args, message_stream).await
} }
Command::Server(_) => unreachable!(), Command::Server(_) => unreachable!(),
Command::GenerateCompletions(_) => unreachable!(),
} }
}) })
} }