aboutsummaryrefslogtreecommitdiff
path: root/transport.py
blob: 91c50295b4022233a8dd0f683e7a8ae6a0047233 (plain)
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
import paramiko

HOLD = 1
THROWAWAY = 2

# Abstract classes to implement
class Transport:
    NAME = 'BASE'
    CONNECTION = HOLD
    #CONNECTION = THROWAWAY

    def __init__(self):
        self._connected = False
        raise NotImplemented

    # Connects to the transport, if CONNECTION == HOLD
    def connect(self):
        raise NotImplemented

    # disconnects to the transport, if CONNECTION == HOLD
    def disconnect(self):
        raise NotImplemented

    # validate that the transport works, if CONNECTION == THROWAWAY
    def check(self):
        raise NotImplemented

    def isConnected(self) -> bool:
        return self._connected

class SshTransport(Transport):
    NAME='SSH'
    CONNECTION=HOLD

    def __init__(self, hostname: str, port=22,  username='root', password = None, id_file = None):
        self._hostname = hostname
        self._port = port
        self._username = username
        self._password = password
        self._id_file = id_file

        self._connected = False
        self._client = None

    def connect(self):
        self._client = paramiko.SSHClient()

        # TODO known hosts
        self._client.set_missing_host_key_policy(paramiko.client.AutoAddPolicy)
        self._client.connect(self._hostname, port=self._port, username=self._username, password=self._password, key_filename=None, allow_agent=True)

        self._connected = True

    # return(str: stdout, str: stderr, int: retcode)
    def exec(self, command: str):
        if not self._connected:
            raise Exception('Not connected')

        output = self._client.exec_command(command, timeout=5)

        retcode = output[1].channel.recv_exit_status()
        return (output[1].read().strip(), output[2].read().strip(), retcode)

    def execHandleStderror(self, command: str):
        out = self.exec(command)

        if out[2] != 0:
            raise Exception(f'Command returned error {out[2]}: {out[1]}')

        return out[0]

    def readFile(self, path: str):
        return self.execHandleStderror(f'cat "{path}"')

    def disconnect(self):
        if self._connected:
            self._client.close()

        self._connected = False
        self._client = None