fluzzi32/connpy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

working in automation upgrade

Browse Source
This commit is contained in:
fluzzi 2022-04-23 17:11:38 -03:00
parent c706ac893c
commit b4660254cd
2 changed files with 187 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

255
connpy/core.py
View File

@ -23,6 +23,11 @@ class node:
- result(bool): True if expected value is found after running - result(bool): True if expected value is found after running
the commands using test method. the commands using test method.
- status (int): 0 if the method run or test run succesfully.
1 if connection failed.
2 if expect timeouts without prompt or EOF.
''' '''
def __init__(self, unique, host, options='', logs='', password='', port='', protocol='', user='', config=''): def __init__(self, unique, host, options='', logs='', password='', port='', protocol='', user='', config=''):
@ -171,14 +176,23 @@ class node:
print(connect) print(connect)
exit(1) exit(1)
def run(self, commands,*, folder = '', prompt = r'>$|#$|\$$|>.$|#.$|\$.$', stdout = False): def run(self, commands, vars = None,*, folder = '', prompt = r'>$|#$|\$$|>.$|#.$|\$.$', stdout = False, timeout = 10):
''' '''
Run a command or list of commands on the node and return the output. Run a command or list of commands on the node and return the output.
### Parameters: ### Parameters:
- commands (str/list): Commands to run on the node. Should be - commands (str/list): Commands to run on the node. Should be
str or a list of str. str or a list of str. You can use variables
as {varname} and defining them in optional
parameter vars.
### Optional Parameters:
- vars (dict): Dictionary containing the definition of variables
used in commands parameter.
Keys: Variable names.
Values: strings.
### Optional Named Parameters: ### Optional Named Parameters:
@ -194,35 +208,42 @@ class node:
- stdout (bool):Set True to send the command output to stdout. - stdout (bool):Set True to send the command output to stdout.
default False. default False.
- timeout (int):Time in seconds for expect to wait for prompt/EOF.
default 10.
### Returns: ### Returns:
str: Output of the commands you ran on the node. str: Output of the commands you ran on the node.
''' '''
connect = self._connect() connect = self._connect(timeout = timeout)
if connect == True: if connect == True:
expects = [prompt, pexpect.EOF] expects = [prompt, pexpect.EOF, pexpect.TIMEOUT]
output = '' output = ''
if isinstance(commands, list): if not isinstance(commands, list):
for c in commands: commands = [commands]
result = self.child.expect(expects) for c in commands:
self.child.sendline(c) if vars is not None:
if result == 0: c = c.format(**vars)
output = output + self.child.before.decode() + self.child.after.decode() result = self.child.expect(expects, timeout = timeout)
if result == 1: self.child.sendline(c)
output = output + self.child.before.decode()
else:
result = self.child.expect(expects)
self.child.sendline(commands)
if result == 0: if result == 0:
output = output + self.child.before.decode() + self.child.after.decode() output = output + self.child.before.decode() + self.child.after.decode()
if result == 1: if result == 1:
output = output + self.child.before.decode() output = output + self.child.before.decode()
result = self.child.expect(expects) if result == 2:
self.output = output + self.child.before.decode()
self.status = 2
return self.output
result = self.child.expect(expects, timeout = timeout)
if result == 0: if result == 0:
output = output + self.child.before.decode() + self.child.after.decode() output = output + self.child.before.decode() + self.child.after.decode()
if result == 1: if result == 1:
output = output + self.child.before.decode() output = output + self.child.before.decode()
if result == 2:
self.output = output + self.child.before.decode()
self.status = 2
return self.output
self.child.close() self.child.close()
output = output.lstrip() output = output.lstrip()
if stdout == True: if stdout == True:
@ -233,22 +254,35 @@ class node:
f.close() f.close()
self._logclean(folder + "/" + self.unique) self._logclean(folder + "/" + self.unique)
self.output = output self.output = output
self.status = 0
return output return output
else: else:
self.output = connect self.output = connect
self.status = 1
return connect return connect
def test(self, commands, expected, *, prompt = r'>$|#$|\$$|>.$|#.$|\$.$'): def test(self, commands, expected, vars = None,*, prompt = r'>$|#$|\$$|>.$|#.$|\$.$', timeout = 10):
''' '''
Run a command or list of commands on the node, then check if expected value appears on the output after the last command. Run a command or list of commands on the node, then check if expected value appears on the output after the last command.
### Parameters: ### Parameters:
- commands (str/list): Commands to run on the node. Should be - commands (str/list): Commands to run on the node. Should be
str or list of str. str or a list of str. You can use variables
as {varname} and defining them in optional
parameter vars.
- expected (str) : Expected text to appear after running - expected (str) : Expected text to appear after running
all the commands on the node. all the commands on the node.You can use
variables as {varname} and defining them
in optional parameter vars.
### Optional Parameters:
- vars (dict): Dictionary containing the definition of variables
used in commands and expected parameters.
Keys: Variable names.
Values: strings.
### Optional Named Parameters: ### Optional Named Parameters:
@ -258,38 +292,47 @@ class node:
work for most nodes. Change it if your connection work for most nodes. Change it if your connection
need some special symbol. need some special symbol.
- timeout (int):Time in seconds for expect to wait for prompt/EOF.
default 10.
### Returns: ### Returns:
bool: true if expected value is found after running the commands bool: true if expected value is found after running the commands
false if prompt is found before. false if prompt is found before.
''' '''
connect = self._connect() connect = self._connect(timeout = timeout)
if connect == True: if connect == True:
expects = [prompt, pexpect.EOF] expects = [prompt, pexpect.EOF, pexpect.TIMEOUT]
output = '' output = ''
if isinstance(commands, list): if not isinstance(commands, list):
for c in commands: commands = [commands]
result = self.child.expect(expects) for c in commands:
self.child.sendline(c) if vars is not None:
if result == 0: c = c.format(**vars)
output = output + self.child.before.decode() + self.child.after.decode() result = self.child.expect(expects, timeout = timeout)
if result == 1: self.child.sendline(c)
output = output + self.child.before.decode() if result == 0:
else: output = output + self.child.before.decode() + self.child.after.decode()
self.child.expect(expects) if result == 1:
self.child.sendline(commands) output = output + self.child.before.decode()
output = output + self.child.before.decode() + self.child.after.decode() if result == 2:
expects = [expected, prompt, pexpect.EOF] self.result = None
results = self.child.expect(expects) self.output = output + self.child.before.decode()
self.status = 2
return self.output
if vars is not None:
expected = expected.format(**vars)
expects = [expected, prompt, pexpect.EOF, pexpect.TIMEOUT]
results = self.child.expect(expects, timeout = timeout)
self.child.close()
if results == 0: if results == 0:
self.child.close()
self.result = True self.result = True
output = output + self.child.before.decode() + self.child.after.decode() output = output + self.child.before.decode() + self.child.after.decode()
output = output.lstrip() output = output.lstrip()
self.output = output self.output = output
self.status = 0
return True return True
if results in [1, 2]: if results in [1, 2]:
self.child.close()
self.result = False self.result = False
if results == 1: if results == 1:
output = output + self.child.before.decode() + self.child.after.decode() output = output + self.child.before.decode() + self.child.after.decode()
@ -297,13 +340,22 @@ class node:
output = output + self.child.before.decode() output = output + self.child.before.decode()
output = output.lstrip() output = output.lstrip()
self.output = output self.output = output
self.status = 0
return False return False
if results == 3:
self.result = None
output = output + self.child.before.decode()
output = output.lstrip()
self.output = output
self.status = 2
return output
else: else:
self.result = None self.result = None
self.output = connect self.output = connect
self.status = 1
return connect return connect
def _connect(self, debug = False): def _connect(self, debug = False, timeout = 10):
# Method to connect to the node, it parse all the information, create the ssh/telnet command and login to the node. # Method to connect to the node, it parse all the information, create the ssh/telnet command and login to the node.
if self.protocol == "ssh": if self.protocol == "ssh":
cmd = "ssh" cmd = "ssh"
@ -323,7 +375,7 @@ class node:
passwords = self.__passtx(self.password) passwords = self.__passtx(self.password)
else: else:
passwords = [] passwords = []
expects = ['yes/no', 'refused', 'supported', 'cipher', 'sage', 'timeout', 'unavailable', 'closed', '[p|P]assword:|[u|U]sername:', r'>$|#$|\$$|>.$|#.$|\$.$', 'suspend', pexpect.EOF, "No route to host", "resolve hostname", "no matching host key"] expects = ['yes/no', 'refused', 'supported', 'cipher', 'sage', 'timeout', 'unavailable', 'closed', '[p|P]assword:|[u|U]sername:', r'>$|#$|\$$|>.$|#.$|\$.$', 'suspend', pexpect.EOF, pexpect.TIMEOUT, "No route to host", "resolve hostname", "no matching host key"]
elif self.protocol == "telnet": elif self.protocol == "telnet":
cmd = "telnet " + self.host cmd = "telnet " + self.host
if self.port != '': if self.port != '':
@ -336,11 +388,12 @@ class node:
passwords = self.__passtx(self.password) passwords = self.__passtx(self.password)
else: else:
passwords = [] passwords = []
expects = ['[u|U]sername:', 'refused', 'supported', 'cipher', 'sage', 'timeout', 'unavailable', 'closed', '[p|P]assword:', r'>$|#$|\$$|>.$|#.$|\$.$', 'suspend', pexpect.EOF, "No route to host", "resolve hostname", "no matching host key"] expects = ['[u|U]sername:', 'refused', 'supported', 'cipher', 'sage', 'timeout', 'unavailable', 'closed', '[p|P]assword:', r'>$|#$|\$$|>.$|#.$|\$.$', 'suspend', pexpect.EOF, pexpect.TIMEOUT, "No route to host", "resolve hostname", "no matching host key"]
else: else:
raise ValueError("Invalid protocol: " + self.protocol) raise ValueError("Invalid protocol: " + self.protocol)
child = pexpect.spawn(cmd) child = pexpect.spawn(cmd)
if debug: if debug:
print(cmd)
child.logfile_read = sys.stdout.buffer child.logfile_read = sys.stdout.buffer
if len(passwords) > 0: if len(passwords) > 0:
loops = len(passwords) loops = len(passwords)
@ -349,7 +402,7 @@ class node:
endloop = False endloop = False
for i in range(0, loops): for i in range(0, loops):
while True: while True:
results = child.expect(expects) results = child.expect(expects, timeout=timeout)
if results == 0: if results == 0:
if self.protocol == "ssh": if self.protocol == "ssh":
child.sendline('yes') child.sendline('yes')
@ -359,7 +412,7 @@ class node:
else: else:
self.missingtext = True self.missingtext = True
break break
if results in [1, 2, 3, 4, 5, 6, 7, 12, 13, 14]: if results in [1, 2, 3, 4, 5, 6, 7, 12, 13, 14, 15]:
child.close() child.close()
return "Connection failed code:" + str(results) return "Connection failed code:" + str(results)
if results == 8: if results == 8:
@ -398,6 +451,11 @@ class nodes:
the commands, False if prompt is found before. the commands, False if prompt is found before.
Created after running method test. Created after running method test.
- status (dict): Dictionary formed by nodes unique as keys, value:
0 if method run or test ended succesfully.
1 if connection failed.
2 if expect timeouts without prompt or EOF.
- <unique> (obj): For each item in nodelist, there is an attribute - <unique> (obj): For each item in nodelist, there is an attribute
generated with the node unique. generated with the node unique.
''' '''
@ -433,33 +491,46 @@ class nodes:
yield lst[i:i + n] yield lst[i:i + n]
def run(self, commands,*, folder = None, prompt = None, stdout = None, parallel = 10): def run(self, commands, vars = None,*, folder = None, prompt = None, stdout = None, parallel = 10, timeout = None):
''' '''
Run a command or list of commands on all the nodes in nodelist. Run a command or list of commands on all the nodes in nodelist.
### Parameters: ### Parameters:
commands (str/list): Commands to run on the node. Should be str or - commands (str/list): Commands to run on the nodes. Should be str or
list of str. list of str. You can use variables as {varname}
and defining them in optional parameter vars.
### Optional Parameters:
- vars (dict): Dictionary containing the definition of variables for
each node, used in commands parameter.
Keys should be formed by nodes unique names. Use
special key name __global__ for global variables.
Subkeys: Variable names.
Values: strings.
### Optional Named Parameters: ### Optional Named Parameters:
folder (str): Path where output log should be stored, leave empty - folder (str): Path where output log should be stored, leave empty
to disable logging. to disable logging.
prompt (str): Prompt to be expected after a command is finished - prompt (str): Prompt to be expected after a command is finished
running. Usually linux uses ">" or EOF while routers running. Usually linux uses ">" or EOF while routers
use ">" or "#". The default value should work for use ">" or "#". The default value should work for
most nodes. Change it if your connection need some most nodes. Change it if your connection need some
special symbol. special symbol.
stdout (bool): Set True to send the command output to stdout. - stdout (bool): Set True to send the command output to stdout.
Default False. Default False.
parallel (int): Number of nodes to run the commands simultaneously. - parallel (int): Number of nodes to run the commands simultaneously.
Default is 10, if there are more nodes that this Default is 10, if there are more nodes that this
value, nodes are groups in groups with max this value, nodes are groups in groups with max this
number of members. number of members.
- timeout (int): Time in seconds for expect to wait for prompt/EOF.
default 10.
###Returns: ###Returns:
@ -468,6 +539,7 @@ class nodes:
''' '''
args = {} args = {}
nodesargs = {}
args["commands"] = commands args["commands"] = commands
if folder != None: if folder != None:
args["folder"] = folder args["folder"] = folder
@ -475,10 +547,20 @@ class nodes:
args["prompt"] = prompt args["prompt"] = prompt
if stdout != None: if stdout != None:
args["stdout"] = stdout args["stdout"] = stdout
if timeout != None:
args["timeout"] = timeout
output = {} output = {}
status = {}
tasks = [] tasks = []
for n in self.nodelist: for n in self.nodelist:
tasks.append(threading.Thread(target=n.run, kwargs=args)) nodesargs[n.unique] = args.copy()
if vars != None:
nodesargs[n.unique]["vars"] = {}
if "__global__" in vars.keys():
nodesargs[n.unique]["vars"].update(vars["__global__"])
if n.unique in vars.keys():
nodesargs[n.unique]["vars"].update(vars[n.unique])
tasks.append(threading.Thread(target=n.run, kwargs=nodesargs[n.unique]))
taskslist = list(self._splitlist(tasks, parallel)) taskslist = list(self._splitlist(tasks, parallel))
for t in taskslist: for t in taskslist:
for i in t: for i in t:
@ -487,28 +569,48 @@ class nodes:
i.join() i.join()
for i in self.nodelist: for i in self.nodelist:
output[i.unique] = i.output output[i.unique] = i.output
status[i.unique] = i.status
self.output = output self.output = output
self.status = status
return output return output
def test(self, commands, expected, *, prompt = None, parallel = 10): def test(self, commands, expected, vars = None,*, prompt = None, parallel = 10, timeout = None):
''' '''
Run a command or list of commands on all the nodes in nodelist, then check if expected value appears on the output after the last command. Run a command or list of commands on all the nodes in nodelist, then check if expected value appears on the output after the last command.
### Parameters: ### Parameters:
commands (str/list): Commands to run on the node. Should be str or - commands (str/list): Commands to run on the node. Should be str or
list of str. list of str.
expected (str) : Expected text to appear after running all the - expected (str) : Expected text to appear after running all the
commands on the node. commands on the node.
### Optional Parameters:
- vars (dict): Dictionary containing the definition of variables for
each node, used in commands and expected parameters.
Keys should be formed by nodes unique names. Use
special key name __global__ for global variables.
Subkeys: Variable names.
Values: strings.
### Optional Named Parameters: ### Optional Named Parameters:
prompt (str): Prompt to be expected after a command is finished - prompt (str): Prompt to be expected after a command is finished
running. Usually linux uses ">" or EOF while running. Usually linux uses ">" or EOF while
routers use ">" or "#". The default value should routers use ">" or "#". The default value should
work for most nodes. Change it if your connection work for most nodes. Change it if your connection
need some special symbol. need some special symbol.
- parallel (int): Number of nodes to run the commands simultaneously.
Default is 10, if there are more nodes that this
value, nodes are groups in groups with max this
number of members.
- timeout (int): Time in seconds for expect to wait for prompt/EOF.
default 10.
### Returns: ### Returns:
@ -518,15 +620,26 @@ class nodes:
''' '''
args = {} args = {}
nodesargs = {}
args["commands"] = commands args["commands"] = commands
args["expected"] = expected args["expected"] = expected
if prompt != None: if prompt != None:
args["prompt"] = prompt args["prompt"] = prompt
if timeout != None:
args["timeout"] = timeout
output = {} output = {}
result = {} result = {}
status = {}
tasks = [] tasks = []
for n in self.nodelist: for n in self.nodelist:
tasks.append(threading.Thread(target=n.test, kwargs=args)) nodesargs[n.unique] = args.copy()
if vars != None:
nodesargs[n.unique]["vars"] = {}
if "__global__" in vars.keys():
nodesargs[n.unique]["vars"].update(vars["__global__"])
if n.unique in vars.keys():
nodesargs[n.unique]["vars"].update(vars[n.unique])
tasks.append(threading.Thread(target=n.test, kwargs=nodesargs[n.unique]))
taskslist = list(self._splitlist(tasks, parallel)) taskslist = list(self._splitlist(tasks, parallel))
for t in taskslist: for t in taskslist:
for i in t: for i in t:
@ -536,8 +649,10 @@ class nodes:
for i in self.nodelist: for i in self.nodelist:
result[i.unique] = i.result result[i.unique] = i.result
output[i.unique] = i.output output[i.unique] = i.output
status[i.unique] = i.status
self.output = output self.output = output
self.result = result self.result = result
self.status = status
return result return result
# script # script

4
requirements.txt
View File

@ -1,5 +1,5 @@
inquirer~=2.9.2 inquirer~=2.9.2
pexpect~=4.8.0 pexpect~=4.8.0
pycryptodome~=3.14.1 pycryptodome~=3.14.1
setuptools~=59.4.0 pyfzf~=0.3.1
myst-parser setuptools~=59.5.0