1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
//! hm is a commandline program to help with dotfile (and more) management. //! //! It can handle putting configuration files where they should go, but its real //! strength lies in the solutions it'll execute - shell scripts, usually - to //! pull a git repository, compile something from source, etc. //! //! hm exists because I bring along a few utilities to all Linux boxes I regularly //! use, and those are often built from source. So rather than manually install //! all dependency libraries, then build each dependent piece, then finally the //! top-level dependent program, I built hm. //! It also provides functionality to thread off heavier operations //! into task threads, which regularly report back their status with //! Worker objects over a `std::sync::mpsc`. //! //! `hm` can also perform dependency resolution, thanks to the solvent crate. You can //! provide a big ol' list of tasks to complete, each with their own dependencies, and //! as long as you have a solveable dependency graph, you can get workable batches from //! get_task_batches(). They will be in *some* order that will resolve your dependencies, //! but that order is non-deterministic - if there's multiple ways to solve a graph, //! you'll probably get all those different ways back if you run it multiple times. //! //! The crate provides this library, which is in turn used by the bin `hm` (in `src/bin/main.rs`). //! `hm` is a commandline program to help with dotfile (and more) management. //! //! It can handle putting configuration files where they should go, but its real //! strength lies in the solutions it'll execute - shell scripts, usually - to //! pull a git repository, compile something from source, etc. //! //! `hm` exists because I bring along a few utilities to all Linux boxes I regularly //! use, and those are often built from source. So rather than manually install //! all dependency libraries, then build each dependent piece, then finally the //! top-level dependent program, I built hm. //! //! //! [gfycat of it in action](https://gfycat.com/skinnywarmheartedafricanpiedkingfisher) //! //! //! 1. create a config.toml file either anywhere or in ~/.config/homemaker/. //! 2. enter things to do things to in the file. //! example: //! ``` text //! ## config.toml //! //! [[obj]] //! file = 'tmux.conf' //! source = '~/dotfiles/.tmux.conf' //! destination = '~/.tmux.conf' //! method = 'symlink' //! //! [[obj]] //! task = 'zt' //! solution = 'cd ~/dotfiles/zt && git pull' //! dependencies = 'maim, slop' //! //! [[obj]] //! task = 'slop' //! source = '~/dotfiles/zt/slop' //! solution = 'cd ~/dotfiles/zt/slop; make clean; cmake -DCMAKE_INSTALL_PREFIX="/usr" ./ && make && sudo make install' //! method = 'execute' //! ``` //! 3. `hm ~/path/to/your/config.toml` //! //! [![built with spacemacs](https://cdn.rawgit.com/syl20bnr/spacemacs/442d025779da2f62fc86c2082703697714db6514/assets/spacemacs-badge.svg)](http://spacemacs.org) //! //! thanks to actual good code: //! serde //! toml //! symlink //! solvent //! indicatif //! console #![allow(dead_code)] #![allow(unused_macros)] extern crate console; extern crate indicatif; extern crate shellexpand; extern crate solvent; extern crate symlink; extern crate sys_info; pub mod config; mod hm_macro; pub mod hmerror; use config::{ManagedObject, Worker}; use hmerror::{ErrorKind as hmek, HMError}; use console::{pad_str, style, Alignment}; use indicatif::{MultiProgress, ProgressBar, ProgressStyle}; use solvent::DepGraph; use std::{ collections::{HashMap, HashSet}, fmt, fs::{metadata, remove_dir_all}, io::{BufRead, BufReader, Error, ErrorKind}, path::Path, process::{exit, Command, Stdio}, sync::mpsc::{self, Sender}, {thread, time}, }; use symlink::{symlink_dir as sd, symlink_file as sf}; /// I just wanna borrow one to look at it for a minute. /// use me with std::mem::transmute() /// absolutely not pub struct. don't look at me. #[derive(Debug, Clone)] struct SneakyDepGraphImposter<String> { nodes: Vec<String>, dependencies: HashMap<usize, HashSet<usize>>, satisfied: HashSet<usize>, } impl fmt::Display for SneakyDepGraphImposter<String> { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { let mut i: usize = 0; for n in self.nodes.clone() { if self.dependencies.get(&i).is_some() { let _ = write!(f, "[ {} -> ", n); for d in self.dependencies.get(&i) { if d.len() == 0 { write!(f, "<no deps> ")?; } let mut j: usize = 1; for m in d { if j == d.len() { write!(f, "{} ", self.nodes[*m])?; } else { write!(f, "{}, ", self.nodes[*m])?; } j += 1; } } } i += 1; if i != self.nodes.len() { write!(f, "], ")?; } else { write!(f, "]")?; } } Ok(()) } } /// /// Either create a symlink to a file or directory. Generally /// we'll be doing this in a tilde'd home subdirectory, so /// we need to be careful to get our Path right. /// pub fn symlink_file(source: String, target: String, force: bool) -> Result<(), HMError> { let _lsource: String = shellexpand::tilde(&source).to_string(); let _ltarget: String = shellexpand::tilde(&target).to_string(); let md = match metadata(_lsource.clone()) { Ok(a) => a, Err(e) => return Err(HMError::Io(e)), }; if force { if Path::new(_ltarget.as_str()).exists() { remove_dir_all(_ltarget.clone())?; } } if md.is_dir() { sd(Path::new(_lsource.as_str()), Path::new(_ltarget.as_str()))?; } else if md.is_file() { sf(Path::new(_lsource.as_str()), Path::new(_ltarget.as_str()))?; } Ok(()) } /// /// Take a ManagedObject task, an mpsc tx, and a Progressbar. Execute task and regularly inform the rx /// (all the way over back in `main()`)about our status using config::Worker. /// /// TODO: allow the `verbose` bool to show the output of the tasks as they go. /// /// Return () or io::Error (something went wrong in our task). /// pub fn send_tasks_off_to_college( mo: &ManagedObject, tx: &Sender<Worker>, p: ProgressBar, ) -> Result<(), Error> { let s: String = mo.solution.clone().to_string(); let s1: String = mo.solution.clone().to_string(); let n: String = mo.name.clone().to_string(); let tx1: Sender<Worker> = Sender::clone(tx); let _: thread::JoinHandle<Result<(), HMError>> = thread::spawn(move || { let mut c = Command::new("bash") .arg("-c") .arg(s) .stdout(Stdio::piped()) .stderr(Stdio::piped()) .spawn() .unwrap(); //let output = c.stdout.take().unwrap(); //let reader = BufReader::new(output); /* reader .lines() .filter_map(|line| line.ok()) .for_each(|line| println!("{}", line)); } */ //p.println(s1); p.set_style( ProgressStyle::default_spinner() .template("[{elapsed:4}] {prefix:.bold.dim} {spinner} {wide_msg}"), ); p.enable_steady_tick(200); p.set_prefix( pad_str(format!("task {}", n).as_str(), 30, Alignment::Left, None) .into_owned() .as_str(), ); loop { let mut w: Worker = Worker { name: n.clone(), status: None, completed: false, }; match c.try_wait() { Ok(Some(status)) => { if status.success() { p.finish_with_message(console::style("✓").green().to_string().as_str()); w.status = status.code(); w.completed = true; tx1.send(w).unwrap(); return Ok(()); } else { drop(tx1); p.abandon_with_message(console::style("✗").red().to_string().as_str()); return Err(HMError::Regular(hmek::SolutionError { solution: String::from(s1), })); } } Ok(None) => { tx1.send(w).unwrap(); thread::sleep(time::Duration::from_millis(200)); } Err(_e) => { drop(tx1); p.abandon_with_message(console::style("✗").red().to_string().as_str()); return Err(HMError::Regular(hmek::SolutionError { solution: String::from(s1), })); } } } }); Ok(()) } /* */ /// /// Create a non-cyclical dependency graph and give it back as a Vec<Vec<ManagedObject>>. /// Will return a CyclicalDependencyError if the graph is unsolveable. /// Intended to be used with either mgmt::execute_solution or mgmt::send_tasks_off_to_college. /// /// /// Example: /// /// ``` /// extern crate indicatif; /// use std::sync::mpsc; /// use std::collections::HashMap; /// use indicatif::{MultiProgress, ProgressBar}; /// use hm::config::ManagedObject; /// use hm::{get_task_batches, send_tasks_off_to_college}; /// let nodes: HashMap<String, ManagedObject> = HashMap::new(); /// let (tx, rx) = mpsc::channel(); /// let mp: MultiProgress = MultiProgress::new(); /// let v: Vec<Vec<ManagedObject>> = get_task_batches(nodes).unwrap(); /// for a in v { /// for b in a { /// let _p: ProgressBar = mp.add(ProgressBar::new_spinner()); /// send_tasks_off_to_college(&b, &tx, _p); /// } /// } /// ``` /// pub fn get_task_batches( nodes: HashMap<String, ManagedObject>, ) -> Result<Vec<Vec<ManagedObject>>, HMError> { let our_os = config::determine_os(); let mut our_nodes = nodes.clone(); let mut depgraph: DepGraph<String> = DepGraph::new(); let mut nodes_to_remove: Vec<String> = Vec::new(); let mut wrong_platforms: HashMap<String, config::OS> = HashMap::new(); for (name, node) in &our_nodes { if node.os.is_none() || node.os.clone().unwrap() == our_os { depgraph.register_dependencies(name.to_owned(), node.dependencies.clone()); } else { nodes_to_remove.push(name.to_string()); wrong_platforms.insert(name.clone(), node.os.clone().unwrap()); } } for n in nodes_to_remove { our_nodes.remove(&n); } let mut tasks: Vec<Vec<ManagedObject>> = Vec::new(); let mut _dedup: HashSet<String> = HashSet::new(); for (name, _node) in &our_nodes { let mut q: Vec<ManagedObject> = Vec::new(); let dg: solvent::DepGraphIterator<String> = depgraph.dependencies_of(&name).unwrap(); for n in dg { match n { Ok(r) => { let c = String::from(r.as_str()); // returns true if the set DID NOT have c in it already if _dedup.insert(c) { let mut a = match our_nodes.get(r) { Some(a) => a, None => { /* if we have a dependency, but it can't be solved because it's for the incorrect platform, let's complain about it. doing it this way is necessary because we DO still want our dependency graph to get run. */ if wrong_platforms.contains_key(r) { return Err(HMError::Regular(hmek::IncorrectPlatformError { dependency: String::from(r), platform: our_os, target_platform: wrong_platforms.get(r).cloned().unwrap(), })); } else { return Err(HMError::Regular(hmek::DependencyUndefinedError { dependency: String::from(r), })); } } } .to_owned(); a.set_satisfied(); q.push(a); } } Err(_e) => unsafe { // we'll just borrow this for a second // just to look // i'm not gonna touch it i promise let my_sneaky_depgraph: SneakyDepGraphImposter<String> = std::mem::transmute(depgraph); return Err(HMError::Regular(hmek::CyclicalDependencyError { // we can do this because we've implemented fmt::Display for SneakyDepGraphImposter dependency_graph: my_sneaky_depgraph.to_string(), })); }, } } tasks.push(q); } Ok(tasks) } /// /// Execute the shell commands specified in the MO's solution in a thread, so as not to block. /// fn execute_solution(solution: String) -> Result<(), HMError> { // marginally adapted but mostly stolen from // https://rust-lang-nursery.github.io/rust-cookbook/os/external.html let child: thread::JoinHandle<Result<(), HMError>> = thread::spawn(|| { let output = Command::new("bash") .arg("-c") .arg(solution) .stdout(Stdio::piped()) .spawn()? .stdout .ok_or_else(|| Error::new(ErrorKind::Other, "Couldn't capture stdout"))?; if cfg!(debug_assertions) { let reader = BufReader::new(output); reader .lines() .filter_map(|line| line.ok()) .for_each(|line| println!("{}", line)); } Ok(()) }); child.join().unwrap() } /// /// Pretty simple. We currently support only symlinking, but copying would be trivial. /// Hand off to the actual function that does the work. /// pub fn perform_operation_on(mo: ManagedObject) -> Result<(), HMError> { let _s = mo.method.as_str(); match _s { "symlink" => { let source: String = mo.source; let destination: String = mo.destination; symlink_file(source, destination, mo.force) } _ => { println!("{}", style(format!("{}", _s)).red()); Ok(()) } } } /// /// Take our list of ManagedObjects to do stuff to, and determine /// if they're simple or complex (simple is symlink or copy, complex /// maybe compilation or pulling a git repo). We just do the simple ones, as they /// won't be computationally expensive. /// /// For complex ones we get a list of list of MOs that we can do in some order that /// satisfies their dependencies, then we hand them off to send_tasks_off_to_college(). /// pub fn do_tasks(a: HashMap<String, config::ManagedObject>) -> Result<(), HMError> { let mut complex_operations = a.clone(); let mut simple_operations = a.clone(); complex_operations.retain(|_, v| v.is_task()); // all the things that aren't just symlink/copy simple_operations.retain(|_, v| !v.is_task()); // all the things that are quick (don't need to thread off) for (_name, _mo) in simple_operations.into_iter() { let _ = perform_operation_on(_mo).map_err(|e| { hmerror::error( format!("Failed to perform operation on {:#?}", _name).as_str(), e.to_string().as_str(), ) }); } let (tx, rx) = mpsc::channel(); let mp: MultiProgress = MultiProgress::new(); let mut t: HashSet<String> = HashSet::new(); let _v = get_task_batches(complex_operations).unwrap_or_else(|er| { hmerror::error( "Error occurred attempting to get task batches", format!("{}{}", "\n", er.to_string().as_str()).as_str(), ); exit(3); }); for _a in _v { for _b in _a { t.insert(_b.name.to_string()); let _p: ProgressBar = mp.add(ProgressBar::new_spinner()); send_tasks_off_to_college(&_b, &tx, _p).expect("ohtehnoes"); } } let mut v: HashMap<String, config::Worker> = HashMap::new(); // create a map of each Worker, and just poll them until they're done // the hashmap ensures we have only one of each worker loop { match rx.try_recv() { Ok(_t) => { v.insert(_t.name.clone(), _t.clone()); } Err(_) => {} } std::thread::sleep(time::Duration::from_millis(10)); if !all_workers_done(&v) { continue; } break; } mp.join().unwrap(); Ok(()) } /// /// Iterate through all the workers passed in. If any isn't marked as complete, `return false;`. /// Let's take a reference, because we're only reading, and don't need ownership. /// fn all_workers_done(workers: &HashMap<String, config::Worker>) -> bool { for (_n, w) in workers { if !w.completed { return false; } } true }