tricorder 0.10.0

Automation, the KISS way, no YAML involved.
Documentation 
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

use super::{host_id::HostId, host_tag::HostTag};
use crate::prelude::Result;

use serde_derive::{Deserialize, Serialize};
use serde_json::Value;

use ssh2::Session;
use std::{collections::HashMap, net::TcpStream};

/// Abstraction of a host found in the inventory
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct Host {
    /// Host identifier
    pub id: HostId,
    /// SSH host address in the form of `hostname:port`
    pub address: String,
    /// SSH user to authenticate with (defaults to `root`)
    #[serde(default = "default_user")]
    pub user: String,
    /// Tags used to apply commands on a subset of hosts from the inventory (defaults to `[]`)
    #[serde(default = "default_tags")]
    pub tags: Vec<HostTag>,
    /// Variables specific to this host, used by templates (defaults to `{}`)
    #[serde(default = "default_vars")]
    pub vars: HashMap<String, Value>,
}

impl Host {
    /// Shortcut to `HostId::new()`
    pub fn id(src: &str) -> Result<HostId> {
        HostId::new(src)
    }

    /// Shortcut to `HostTag::new()`
    pub fn tag(src: &str) -> Result<HostTag> {
        HostTag::new(src)
    }

    /// Create a new host
    pub fn new(id: HostId, address: String) -> Self {
        Self {
            id,
            address,
            user: default_user(),
            tags: default_tags(),
            vars: default_vars(),
        }
    }

    /// Override this host's user
    pub fn set_user(&mut self, user: String) -> &mut Self {
        self.user = user;
        self
    }

    /// Add tag to this host
    pub fn add_tag(&mut self, tag: HostTag) -> &mut Self {
        self.tags.push(tag);
        self
    }

    /// Remove tag from this host
    pub fn remove_tag(&mut self, tag: HostTag) -> &mut Self {
        self.tags.retain(|current_tag| *current_tag != tag);
        self
    }

    /// Set host variable
    pub fn set_var(&mut self, key: String, val: Value) -> &mut Self {
        self.vars.insert(key, val);
        self
    }

    /// Remove host variable
    pub fn remove_var(&mut self, key: String) -> &mut Self {
        self.vars.remove(&key);
        self
    }

    /// Open SSH session to host and authenticate using `ssh-agent`
    pub fn get_session(&self) -> Result<Session> {
        let sock = TcpStream::connect(self.address.clone())?;
        let mut sess = Session::new()?;

        sess.set_tcp_stream(sock);
        sess.handshake()?;
        sess.userauth_agent(&self.user)?;

        Ok(sess)
    }
}

fn default_user() -> String {
    String::from("root")
}

fn default_tags() -> Vec<HostTag> {
    vec![]
}

fn default_vars() -> HashMap<String, Value> {
    HashMap::new()
}