multi-ssh/src/main.rs

304 lines
7.9 KiB
Rust
Raw Normal View History

2024-12-11 14:13:32 +01:00
use clap::{Parser, Subcommand, ValueEnum};
2024-12-11 21:27:13 +01:00
use std::cell::LazyCell;
2024-12-11 10:42:44 +01:00
use std::env;
use std::error::Error;
use std::fmt::{Display, Formatter};
use std::hash::{Hash, Hasher};
2024-12-11 21:27:13 +01:00
use std::ops::Deref;
2024-12-11 10:42:44 +01:00
use std::path::PathBuf;
use std::str::FromStr;
2024-12-11 10:42:44 +01:00
2024-12-11 14:13:32 +01:00
const SERVERS_ENV_VAR: &str = "MSSH_SERVERS";
2024-12-11 10:42:44 +01:00
2024-12-11 14:13:32 +01:00
/// Uploads a file or executes a command on multiple configured servers
2024-12-11 10:42:44 +01:00
///
2024-12-11 14:13:32 +01:00
/// Servers must either be configured via environment variable or denote their server directory with
/// a double colon: crea:home/crea.
2024-12-11 10:42:44 +01:00
///
2024-12-11 14:13:32 +01:00
/// --- Configuration via environment variable ---
2024-12-11 10:42:44 +01:00
///
2024-12-11 14:13:32 +01:00
/// Use MSSH_SERVERS="crea:home/crea,sky:sky,lobby:,city:city2" to configure servers.
2024-12-11 10:42:44 +01:00
#[derive(Parser, Debug)]
#[command(version, about, long_about)]
struct Args {
2024-12-11 14:13:32 +01:00
/// The action to perform
#[command(subcommand)]
command: Command,
/// The ssh names and optionally home directories of the servers to perform the action on
#[arg(num_args = 1.., value_parser = ServerReference::from_str)]
servers: Vec<ServerReference>,
2024-12-11 14:13:32 +01:00
}
#[derive(Subcommand, Debug)]
enum Command {
/// Upload a file to the servers
#[command(visible_short_flag_alias = 'u')]
Upload {
/// The file to upload
file: PathBuf,
/// How to handle older versions of the file
#[arg(short = 'a', long, default_value = "delete", default_missing_value = "archive", num_args = 0..1)]
old_version_policy: OldVersionPolicy,
/// The directory where to upload to
2024-12-12 09:50:32 +01:00
#[arg(short = 'p', long, default_value = "plugins")]
upload_directory: PathBuf,
2024-12-11 14:13:32 +01:00
},
/// Execute a command on the servers
#[command(visible_short_flag_alias = 'c')]
Command {
/// The command to execute
command: String,
},
}
#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash, Default, ValueEnum)]
enum OldVersionPolicy {
/// Ignore the existence of older versions
Ignore,
/// Rename older versions: foo.jar -> foo.jarr
Archive,
/// Delete older versions
#[default]
Delete,
2024-12-11 10:42:44 +01:00
}
#[derive(Debug, Clone)]
enum ServerReference {
Resolved(Server),
Name(String),
}
impl ServerReference {
pub fn get_name(&self) -> &str {
match self {
ServerReference::Resolved(server) => &server.ssh_name,
ServerReference::Name(name) => name,
}
2024-12-11 21:27:13 +01:00
}
#[allow(dead_code)]
pub fn resolve(self, configured_servers: &[Server]) -> Option<Server> {
match self {
ServerReference::Resolved(server) => Some(server),
ServerReference::Name(name) => Self::resolve_server_name(&name, configured_servers),
}
}
#[allow(dead_code)]
2024-12-11 21:27:13 +01:00
pub fn resolve_lazy<S, F>(self, provider: &mut LazyCell<S, F>) -> Option<Server>
where
S: Deref<Target = [Server]>,
F: FnOnce() -> S,
2024-12-11 21:27:13 +01:00
{
match self {
ServerReference::Resolved(server) => Some(server),
ServerReference::Name(name) => Self::resolve_server_name(&name, provider),
}
}
pub fn try_resolve_lazy<S, F, E>(
self,
provider: &mut LazyCell<Result<S, E>, F>,
) -> Result<Option<Server>, E>
where
S: Deref<Target = [Server]>,
F: FnOnce() -> Result<S, E>,
E: Clone,
{
match self {
ServerReference::Resolved(server) => Ok(Some(server)),
2024-12-11 21:27:13 +01:00
ServerReference::Name(name) => provider
.as_ref()
.map_err(|e| e.clone())
.map(|servers| Self::resolve_server_name(&name, servers)),
}
}
fn resolve_server_name(name: &str, servers: &[Server]) -> Option<Server> {
servers
.iter()
.find(|server| server.ssh_name == name)
.cloned()
}
}
impl FromStr for ServerReference {
type Err = ServerReferenceParseError;
fn from_str(s: &str) -> Result<Self, Self::Err> {
Server::from_str(s)
.map(Self::Resolved)
.or_else(|_| Ok(Self::Name(s.to_string())))
}
}
impl PartialEq for ServerReference {
fn eq(&self, other: &Self) -> bool {
self.get_name() == other.get_name()
}
}
impl Eq for ServerReference {}
impl Hash for ServerReference {
fn hash<H: Hasher>(&self, state: &mut H) {
self.get_name().hash(state);
}
}
impl Display for ServerReference {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
match self {
ServerReference::Resolved(server) => write!(f, "{}", server),
ServerReference::Name(name) => write!(f, "{}", name),
}
}
}
#[derive(Debug)]
enum ServerReferenceParseError {}
impl Display for ServerReferenceParseError {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(f, "{:?}", self) //replace that with an actual implementation if there ever are any variants
}
}
impl Error for ServerReferenceParseError {}
2024-12-11 10:42:44 +01:00
#[derive(Debug, Clone, Eq, PartialEq, Hash)]
struct Server {
pub ssh_name: String,
pub server_directory_path: PathBuf,
}
impl FromStr for Server {
type Err = ServerParseError;
fn from_str(s: &str) -> Result<Self, Self::Err> {
s.split_once(':')
.ok_or(ServerParseError::MissingServerDirectory)
.map(|(name, directory)| Self {
ssh_name: name.to_string(),
server_directory_path: PathBuf::from(directory),
})
}
}
impl Display for Server {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(f, "{}:{:?}", self.ssh_name, self.server_directory_path)
}
}
#[derive(Debug)]
enum ServerParseError {
MissingServerDirectory,
}
impl Display for ServerParseError {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
match self {
ServerParseError::MissingServerDirectory => {
write!(
f,
"String is not specifying a server directory. Please use an empty string after a \
double colon to point to the home directory, e.g: 'lobby:'"
)
}
}
}
}
impl Error for ServerParseError {}
2024-12-11 10:42:44 +01:00
#[derive(Debug, Clone, Eq, PartialEq, Hash)]
struct PluginInfo {
pub name: String,
pub version: Option<String>,
}
fn main() -> Result<(), String> {
let args = Args::parse();
dbg!(&args);
let mut configured_servers = LazyCell::new(parse_server_configuration_from_env);
let servers = args
.servers
.iter()
.map(|server_reference| {
let server_name = server_reference.get_name();
server_reference
.clone()
.try_resolve_lazy(&mut configured_servers)
.map_err(|msg| format!("Can't resolve server directory for '{server_name}': {msg}"))
.and_then(|opt_server| {
opt_server.ok_or(format!(
"no server directory has been configured for server '{server_name}'"
))
})
})
.collect::<Result<Vec<_>, _>>()?;
dbg!(&servers);
2024-12-11 14:13:32 +01:00
2024-12-11 10:42:44 +01:00
Ok(())
}
fn parse_server_configuration_from_env() -> Result<Vec<Server>, String> {
env::var(SERVERS_ENV_VAR)
.map_err(|_| format!("Missing environment variable {}", SERVERS_ENV_VAR))
.and_then(|value| parse_server_configuration(&value))
}
fn parse_server_configuration(config_str: &str) -> Result<Vec<Server>, String> {
config_str
.split(',')
.map(|server_entry| {
Server::from_str(server_entry)
.map_err(|e| format!("Invalid server entry '{server_entry}': {e}"))
2024-12-11 10:42:44 +01:00
})
.collect()
2024-12-11 10:42:44 +01:00
}
#[cfg(test)]
mod test {
use crate::{parse_server_configuration, Server, ServerReference};
2024-12-11 10:42:44 +01:00
use std::path::PathBuf;
use std::str::FromStr;
2024-12-11 10:42:44 +01:00
#[test]
fn test_parse_server_configuration() {
2024-12-11 14:13:32 +01:00
let servers =
parse_server_configuration("foo:bar,fizz:buzz/bizz").expect("valid server configuration");
assert_eq!(
vec![
Server {
ssh_name: "foo".to_string(),
server_directory_path: PathBuf::from("bar"),
},
Server {
ssh_name: "fizz".to_string(),
server_directory_path: PathBuf::from("buzz/bizz"),
}
],
servers
);
2024-12-11 10:42:44 +01:00
}
#[test]
fn test_server_reference_from_str() {
assert_eq!(
ServerReference::Name("foo".to_string()),
ServerReference::from_str("foo").unwrap()
);
assert_eq!(
ServerReference::Resolved(Server {
ssh_name: "crea".to_string(),
server_directory_path: PathBuf::from("server/creative2")
}),
ServerReference::from_str("crea:server/creative2").unwrap()
);
}
2024-12-11 10:42:44 +01:00
}