Add new function line_in_buffer
[nitsi.git] / test.py
CommitLineData
5e7f6db7
JS
1#!/usr/bin/python3
2
3import serial
4
5import re
6from time import sleep
7import sys
8
9import libvirt
10
11import xml.etree.ElementTree as ET
12
5e7f6db7
JS
13import os
14
15import configparser
16
17class log():
18 def __init__(self, log_level):
19 self.log_level = log_level
20
21 def debug(self, string):
22 if self.log_level >= 4:
23 print("DEBUG: {}".format(string))
24
25 def error(self, string):
26 print("ERROR: {}".format(string))
27
28class libvirt_con():
29 def __init__(self, uri):
30 self.log = log(4)
31 self.uri = uri
32 self.connection = None
33
34 def get_domain_from_name(self, name):
35 dom = self.con.lookupByName(name)
36
37 if dom == None:
38 raise BaseException
39 return dom
40
41 @property
42 def con(self):
43 if self.connection == None:
44 try:
45 self.connection = libvirt.open(self.uri)
46 except BaseException as error:
47 self.log.error("Could not connect to: {}".format(self.uri))
48
49 self.log.debug("Connected to: {}".format(self.uri))
50 return self.connection
51
52 return self.connection
53
54
55class vm():
9bd4af37 56 def __init__(self, vm_xml_file, snapshot_xml_file, image, root_uid, username, password):
5e7f6db7
JS
57 self.log = log(4)
58 self.con = libvirt_con("qemu:///system")
59 try:
60 with open(vm_xml_file) as fobj:
61 self.vm_xml = fobj.read()
62 except FileNotFoundError as error:
63 self.log.error("No such file: {}".format(vm_xml_file))
64
65 try:
66 with open(snapshot_xml_file) as fobj:
67 self.snapshot_xml = fobj.read()
68 except FileNotFoundError as error:
69 self.log.error("No such file: {}".format(snapshot_xml_file))
70
71 self.image = image
72
73 if not os.path.isfile(self.image):
dd542251 74 self.log.error("No such file: {}".format(self.image))
5e7f6db7
JS
75
76 self.root_uid = root_uid
77
9bd4af37
JS
78 self.username = username
79 self.password = password
80
5e7f6db7
JS
81 def define(self):
82 self.dom = self.con.con.defineXML(self.vm_xml)
83 if self.dom == None:
84 self.log.error("Could not define VM")
85 raise BaseException
86
87 def start(self):
88 if self.dom.create() < 0:
89 self.log.error("Could not start VM")
90 raise BaseException
91
92 def shutdown(self):
93 if self.is_running():
94 if self.dom.shutdown() < 0:
95 self.log.error("Could not shutdown VM")
96 raise BaseException
97 else:
98 self.log.error("Domain is not running")
99
100 def undefine(self):
101 self.dom.undefine()
102
103 def create_snapshot(self):
104
105 self.snapshot = self.dom.snapshotCreateXML(self.snapshot_xml)
106
107 if not self.snapshot:
108 self.log.error("Could not create snapshot")
109 raise BaseException
110
111 def revert_snapshot(self):
5e7f6db7 112 self.dom.revertToSnapshot(self.snapshot)
ec6e622d 113 self.snapshot.delete()
5e7f6db7
JS
114
115 def is_running(self):
116
117 state, reason = self.dom.state()
118
119 if state == libvirt.VIR_DOMAIN_RUNNING:
120 return True
121 else:
122 return False
123
124 def get_serial_device(self):
125
126 if not self.is_running():
127 raise BaseException
128
129 xml_root = ET.fromstring(self.dom.XMLDesc(0))
130
131 elem = xml_root.find("./devices/serial/source")
132 return elem.get("path")
133
134 def check_is_booted_up(self):
135 serial_con = connection(self.get_serial_device())
136
137 serial_con.write("\n")
138 # This will block till the domain is booted up
139 serial_con.read(1)
140
141 #serial_con.close()
142
9bd4af37 143 def login(self):
5e7f6db7 144 try:
9bd4af37
JS
145 self.serial_con = connection(self.get_serial_device(), username=self.username)
146 self.serial_con.login(self.password)
5e7f6db7
JS
147 except BaseException as e:
148 self.log.error("Could not connect to the domain via serial console")
149
150 def cmd(self, cmd):
151 return self.serial_con.command(cmd)
152
153
5e7f6db7
JS
154class connection():
155 def __init__(self, device, username=None):
156 self.buffer = b""
157 self.back_at_prompt_pattern = None
158 self.username = username
159 self.log = log(1)
160 self.con = serial.Serial(device)
5e7f6db7
JS
161
162 def read(self, size=1):
163 if len(self.buffer) >= size:
164 # throw away first size bytes in buffer
165 data = self.buffer[:size]
166 # Set the buffer to the non used bytes
167 self.buffer = self.buffer[size:]
168 return data
169 else:
170 data = self.buffer
171 # Set the size to the value we have to read now
172 size = size - len(self.buffer)
173 # Set the buffer empty
174 self.buffer = b""
175 return data + self.con.read(size)
176
177 def peek(self, size=1):
178 if len(self.buffer) <= size:
179 self.buffer += self.con.read(size=size - len(self.buffer))
180
181 return self.buffer[:size]
182
183 def readline(self):
184 self.log.debug(self.buffer)
185 self.buffer = self.buffer + self.con.read(self.con.in_waiting)
186 if b"\n" in self.buffer:
187 size = self.buffer.index(b"\n") + 1
188 self.log.debug("We have a whole line in the buffer")
189 self.log.debug(self.buffer)
190 self.log.debug("We split at {}".format(size))
191 data = self.buffer[:size]
192 self.buffer = self.buffer[size:]
193 self.log.debug(data)
194 self.log.debug(self.buffer)
195 return data
196
197 data = self.buffer
198 self.buffer = b""
199 return data + self.con.readline()
200
201 def back_at_prompt(self):
202 data = self.peek()
203 if not data == b"[":
204 return False
205
206 # We need to use self.in_waiting because with self.con.in_waiting we get
207 # not the complete string
208 size = len(self.buffer) + self.in_waiting
209 data = self.peek(size)
210
211
212 if self.back_at_prompt_pattern == None:
213 #self.back_at_prompt_pattern = r"^\[{}@.+\]#".format(self.username)
214 self.back_at_prompt_pattern = re.compile(r"^\[{}@.+\]#".format(self.username), re.MULTILINE)
215
216 if self.back_at_prompt_pattern.search(data.decode()):
217 return True
218 else:
219 return False
220
221 def log_console_line(self, line):
222 self.log.debug("Get in function log_console_line()")
223 sys.stdout.write(line)
224
225 @property
226 def in_waiting(self):
227 in_waiting_before = 0
228 sleep(0.5)
229
230 while in_waiting_before != self.con.in_waiting:
231 in_waiting_before = self.con.in_waiting
232 sleep(0.5)
233
234 return self.con.in_waiting
235
e54f9c23
JS
236 def line_in_buffer(self):
237 if b"\n" in self.buffer:
238 return True
239
240 return False
5e7f6db7
JS
241
242 def readline2(self, pattern=None):
243 string = ""
244 string2 = b""
245 if pattern:
246 pattern = re.compile(pattern)
247
248 while 1:
249 char = self.con.read(1)
250 string = string + char.decode("utf-8")
251 string2 = string2 + char
252 #print(char)
253 print(char.decode("utf-8"), end="")
254
255 #print(string2)
256 if pattern and pattern.match(string):
257 #print("get here1")
258 #print(string2)
259 return {"string" : string, "return-code" : 1}
260
261 if char == b"\n":
262 #print(char)
263 #print(string2)
264 #print("get here2")
265 return {"return-code" : 0}
266
267 def check_logged_in(self, username):
268 pattern = "^\[" + username + "@.+\]#"
269 data = self.readline(pattern=pattern)
270 if data["return-code"] == 1:
271 print("We are logged in")
272 return True
273 else:
274 print("We are not logged in")
275 return False
276
277 def login(self, password):
278 if self.username == None:
279 self.log.error("Username cannot be blank")
280 return False
281
282 # Hit enter to see what we get
283 self.con.write(b'\n')
284 # We get two new lines \r\n ?
285 data = self.readline()
286 self.log_console_line(data.decode())
287
288
289 if self.back_at_prompt():
290 self.log.debug("We are already logged in.")
291 return True
292
293 # Read all line till we get login:
294 while 1:
295 data = self.peek()
296 if not data.decode() == "l":
297 self.log.debug("We get no l at the start")
298 self.log_console_line(self.readline().decode())
299
300 # We need to use self.in_waiting because with self.con.in_waiting we get
301 # not the complete string
302 size = len(self.buffer) + self.in_waiting
303 data = self.peek(size)
304
305 pattern = r"^.*login: "
306 pattern = re.compile(pattern)
307
308 if pattern.search(data.decode()):
309 break
310 else:
311 self.log.debug("The pattern does not match")
312 self.log_console_line(self.readline().decode())
313
314 # We can login
315 string = "{}\n".format(self.username)
316 self.con.write(string.encode())
317 self.con.flush()
318 # read the login out of the buffer
319 data = self.readline()
320 self.log.debug("This is the login:{}".format(data))
321 self.log_console_line(data.decode())
322
323 # We need to wait her till we get the full string "Password:"
324 #This is useless but self.in_waiting will wait the correct amount of time
325 size = self.in_waiting
326
327 string = "{}\n".format(password)
328 self.con.write(string.encode())
329 self.con.flush()
330 # Print the 'Password:' line
331 data = self.readline()
332 self.log_console_line(data.decode())
333
334 while not self.back_at_prompt():
335 # This will fail if the login failed so we need to look for the failed keyword
336 data = self.readline()
337 self.log_console_line(data.decode())
338
339 return True
340
341 def write(self, string):
342 self.log.debug(string)
343 self.con.write(string.encode())
344 self.con.flush()
345
346 def command(self, command):
347 self.write("{}\n".format(command))
348
349 # We need to read out the prompt for this command first
350 # If we do not do this we will break the loop immediately
351 # because the prompt for this command is still in the buffer
352 data = self.readline()
353 self.log_console_line(data.decode())
354
355 while not self.back_at_prompt():
356 data = self.readline()
357 self.log_console_line(data.decode())
358
359
5e7f6db7
JS
360# A class which define and undefine a virtual network based on an xml file
361class network():
48d5fb0a 362 def __init__(self, network_xml_file):
5e7f6db7 363 self.log = log(4)
48d5fb0a
JS
364 self.con = libvirt_con("qemu:///system")
365 try:
366 with open(network_xml_file) as fobj:
367 self.network_xml = fobj.read()
368 except FileNotFoundError as error:
369 self.log.error("No such file: {}".format(vm_xml_file))
370
371 def define(self):
372 self.network = self.con.con.networkDefineXML(self.network_xml)
373
374 if network == None:
375 self.log.error("Failed to define virtual network")
376
377 def start(self):
378 self.network.create()
379
380 def undefine(self):
381 self.network.destroy()
382
383
5e7f6db7 384
41ab240e
JS
385class RecipeExeption(Exception):
386 pass
387
388
389
5e7f6db7
JS
390# Should read the test, check if the syntax are valid
391# and return tuples with the ( host, command ) structure
392class recipe():
393 def __init__(self, path):
394 self.log = log(4)
395 self.recipe_file = path
41ab240e
JS
396 self._recipe = None
397
5e7f6db7
JS
398 if not os.path.isfile(self.recipe_file):
399 self.log.error("No such file: {}".format(self.recipe_file))
400
401 try:
402 with open(self.recipe_file) as fobj:
403 self.raw_recipe = fobj.readlines()
404 except FileNotFoundError as error:
405 self.log.error("No such file: {}".format(vm_xml_file))
406
41ab240e
JS
407 @property
408 def recipe(self):
409 if not self._recipe:
410 self.parse()
411
412 return self._recipe
413
414 def parse(self):
415 self._recipe = []
416 i = 1
5e7f6db7 417 for line in self.raw_recipe:
41ab240e
JS
418 raw_line = line.split(":")
419 if len(raw_line) < 2:
420 self.log.error("Error parsing the recipe in line {}".format(i))
421 raise RecipeExeption
422 cmd = raw_line[1]
423 raw_line = raw_line[0].strip().split(" ")
424 if len(raw_line) == 0:
425 self.log.error("Failed to parse the recipe in line {}".format(i))
426 raise RecipeExeption
427 elif len(raw_line) == 1:
428 if raw_line[0] == "":
429 self.log.error("Failed to parse the recipe in line {}".format(i))
430 raise RecipeExeption
431 machine = raw_line[0]
432 extra = ""
433 elif len(raw_line) == 2:
434 machine = raw_line[0]
435 extra = raw_line[1]
436
437 self._recipe.append((machine.strip(), extra.strip(), cmd.strip()))
438 i = i + 1
5e7f6db7
JS
439
440
5e7f6db7
JS
441class test():
442 def __init__(self, path):
443 self.log = log(4)
444 try:
445 self.path = os.path.abspath(path)
446 except BaseException as e:
447 self.log.error("Could not get absolute path")
448
449 self.log.debug(self.path)
450
451 self.settings_file = "{}/settings".format(self.path)
452 if not os.path.isfile(self.settings_file):
453 self.log.error("No such file: {}".format(self.settings_file))
454
455 self.recipe_file = "{}/recipe".format(self.path)
456 if not os.path.isfile(self.recipe_file):
457 self.log.error("No such file: {}".format(self.recipe_file))
458
459 def read_settings(self):
460 self.config = configparser.ConfigParser()
461 self.config.read(self.settings_file)
462 self.name = self.config["DEFAULT"]["Name"]
463 self.description = self.config["DEFAULT"]["Description"]
464
465 self.virtual_environ_name = self.config["VIRTUAL_ENVIRONMENT"]["Name"]
466 self.virtual_environ_path = self.config["VIRTUAL_ENVIRONMENT"]["Path"]
467 self.virtual_environ_path = os.path.normpath(self.path + "/" + self.virtual_environ_path)
468
469 def virtual_environ_setup(self):
470 self.virtual_environ = virtual_environ(self.virtual_environ_path)
471
472 self.virtual_networks = self.virtual_environ.get_networks()
473
474 self.virtual_machines = self.virtual_environ.get_machines()
475
476 def virtual_environ_start(self):
3fa89b7c
JS
477 for name in self.virtual_environ.network_names:
478 self.virtual_networks[name].define()
479 self.virtual_networks[name].start()
5e7f6db7 480
3fa89b7c
JS
481 for name in self.virtual_environ.machine_names:
482 self.virtual_machines[name].define()
483 self.virtual_machines[name].create_snapshot()
484 self.virtual_machines[name].start()
5e7f6db7 485
3fa89b7c
JS
486 self.log.debug("Try to login on all machines")
487 for name in self.virtual_environ.machine_names:
488 self.virtual_machines[name].login()
5e7f6db7 489
3fa89b7c
JS
490 def load_recipe(self):
491 try:
492 self.recipe = recipe(self.recipe_file)
493 except BaseException:
494 self.log.error("Failed to load recipe")
495 exit(1)
496
497 def run_recipe(self):
498 for line in self.recipe.recipe:
499 return_value = self.virtual_machines[line[0]].cmd(line[2])
500 if not return_value and line[1] == "":
501 self.log.error("Failed to execute command '{}' on {}".format(line[2],line[0]))
502 return False
503 elif return_value == True and line[1] == "!":
504 self.log.error("Succeded to execute command '{}' on {}".format(line[2],line[0]))
505 return False
506
507 def virtual_environ_stop(self):
508 for name in self.virtual_environ.machine_names:
509 self.virtual_machines[name].shutdown()
510 self.virtual_machines[name].revert_snapshot()
511 self.virtual_machines[name].undefine()
512
513 for name in self.virtual_environ.network_names:
514 self.virtual_networks[name].undefine()
5e7f6db7
JS
515
516
5e7f6db7
JS
517# Should return all vms and networks in a list
518# and should provide the path to the necessary xml files
519class virtual_environ():
520 def __init__(self, path):
521 self.log = log(4)
522 try:
523 self.path = os.path.abspath(path)
524 except BaseException as e:
525 self.log.error("Could not get absolute path")
526
527 self.log.debug(self.path)
528
529 self.settings_file = "{}/settings".format(self.path)
530 if not os.path.isfile(self.settings_file):
531 self.log.error("No such file: {}".format(self.settings_file))
532
533 self.log.debug(self.settings_file)
534 self.config = configparser.ConfigParser()
535 self.config.read(self.settings_file)
536 self.name = self.config["DEFAULT"]["name"]
537 self.machines_string = self.config["DEFAULT"]["machines"]
538 self.networks_string = self.config["DEFAULT"]["networks"]
539
540 self.machines = []
541 for machine in self.machines_string.split(","):
542 self.machines.append(machine.strip())
543
544 self.networks = []
545 for network in self.networks_string.split(","):
546 self.networks.append(network.strip())
547
548 self.log.debug(self.machines)
549 self.log.debug(self.networks)
550
551 def get_networks(self):
552 networks = {}
553 for _network in self.networks:
554 self.log.debug(_network)
555 networks.setdefault(_network, network(os.path.normpath(self.path + "/" + self.config[_network]["xml_file"])))
556 return networks
557
558 def get_machines(self):
559 machines = {}
560 for _machine in self.machines:
561 self.log.debug(_machine)
562 machines.setdefault(_machine, vm(
563 os.path.normpath(self.path + "/" + self.config[_machine]["xml_file"]),
2d53bc4f
JS
564 os.path.normpath(self.path + "/" + self.config[_machine]["snapshot_xml_file"]),
565 self.config[_machine]["image"],
566 self.config[_machine]["root_uid"],
567 self.config[_machine]["username"],
568 self.config[_machine]["password"]))
5e7f6db7
JS
569
570 return machines
571
2d53bc4f
JS
572 @property
573 def machine_names(self):
574 return self.machines
575
576 @property
577 def network_names(self):
578 return self.networks
579
5e7f6db7 580
5e7f6db7
JS
581if __name__ == "__main__":
582 import argparse
583
584 parser = argparse.ArgumentParser()
585
586 parser.add_argument("-d", "--directory", dest="dir")
587
588 args = parser.parse_args()
589
5e7f6db7
JS
590 currenttest = test(args.dir)
591 currenttest.read_settings()
10f65154
JS
592 currenttest.virtual_environ_setup()
593 currenttest.load_recipe()
594 currenttest.virtual_environ_start()
595 currenttest.run_recipe()
596 currenttest.virtual_environ_stop()