Provide fallback value if we fail to read the setting
[nitsi.git] / src / nitsi / test.py
CommitLineData
5e7f6db7
JS
1#!/usr/bin/python3
2
6632e137 3import configparser
5e7f6db7 4import libvirt
6632e137 5import logging
5e7f6db7 6import os
6c352a80
JS
7import time
8
b560f31a
JS
9from . import recipe
10from . import virtual_environ
5e7f6db7 11
1ed8ca9f 12logger = logging.getLogger("nitsi.test")
5e7f6db7 13
61b44c10
JS
14
15class TestException(Exception):
16 def __init__(self, message):
17 self.message = message
18
ee227ea1 19class Test():
d7036f7b 20 def __init__(self, path, log_path):
5e7f6db7
JS
21 try:
22 self.path = os.path.abspath(path)
1ed8ca9f 23 self.log = logger.getChild(os.path.basename(self.path))
5e7f6db7 24 except BaseException as e:
1ed8ca9f 25 logger.error("Could not get absolute path")
5addee87 26 raise e
5e7f6db7 27
2fa4467d 28 self.log.debug("Path of this test is: {}".format(self.path))
5e7f6db7 29
b4936764
JS
30 self.log_path = log_path
31
5e7f6db7
JS
32 self.settings_file = "{}/settings".format(self.path)
33 if not os.path.isfile(self.settings_file):
34 self.log.error("No such file: {}".format(self.settings_file))
250db3b1 35 raise TestException("No settings file found")
5e7f6db7
JS
36
37 self.recipe_file = "{}/recipe".format(self.path)
38 if not os.path.isfile(self.recipe_file):
39 self.log.error("No such file: {}".format(self.recipe_file))
250db3b1 40 raise TestException("No recipe file found")
5e7f6db7
JS
41
42 def read_settings(self):
8428a452 43 self.log.debug("Going to read all settings from the ini file")
c02dd9a9
JS
44 try:
45 self.config = configparser.ConfigParser()
46 self.config.read(self.settings_file)
47 except BaseException as e:
48 self.log.error("Failed to parse the config")
49 raise e
50
8428a452
JS
51 self.name = self.config.get("GENERAL","name", fallback="")
52 self.description = self.config.get("GENERAL", "description", fallback="")
53 self.copy_to = self.config.get("GENERAL", "copy_to", fallback=None)
54 self.copy_from = self.config.get("GENERAL", "copy_from", fallback=None)
55 self.virtual_environ_path = self.config.get("VIRTUAL_ENVIRONMENT", "path", fallback=None)
56
57 if not self.virtual_environ_path:
58 self.log.error("No path for virtual environment found.")
59 raise TestException("No path for virtual environment found.")
60
129c0b0f
JS
61 self.virtual_environ_path = os.path.normpath(self.path + "/" + self.virtual_environ_path)
62
63 # Parse copy_from setting
8428a452
JS
64 if self.copy_from:
65 self.log.debug("Going to parse the copy_from setting.")
66 self.copy_from = self.copy_from.split(",")
14cd493f 67
8428a452
JS
68 tmp = []
69 for file in self.copy_from:
70 file = file.strip()
71 # If file is empty we do not want to add it to the list
72 if not file == "":
73 # If we get an absolut path we do nothing
74 # If not we add self.path to get an absolut path
75 if not os.path.isabs(file):
76 file = os.path.normpath(self.path + "/" + file)
f010720b 77
8428a452
JS
78 # We need to check if file is a valid file or dir
79 if not (os.path.isdir(file) or os.path.isfile(file)):
80 raise TestException("'{}' is not a valid file nor a valid directory".format(file))
f010720b 81
8428a452
JS
82 self.log.debug("'{}' will be copied into all images".format(file))
83 tmp.append(file)
14cd493f 84
8428a452 85 self.copy_from = tmp
5e7f6db7 86
129c0b0f 87
5e7f6db7
JS
88
89 def virtual_environ_setup(self):
ee227ea1 90 self.virtual_environ = virtual_environ.Virtual_environ(self.virtual_environ_path)
5e7f6db7
JS
91
92 self.virtual_networks = self.virtual_environ.get_networks()
93
94 self.virtual_machines = self.virtual_environ.get_machines()
95
96 def virtual_environ_start(self):
3fa89b7c
JS
97 for name in self.virtual_environ.network_names:
98 self.virtual_networks[name].define()
99 self.virtual_networks[name].start()
5e7f6db7 100
3fa89b7c
JS
101 for name in self.virtual_environ.machine_names:
102 self.virtual_machines[name].define()
103 self.virtual_machines[name].create_snapshot()
8428a452
JS
104 # We can only copy files when we know which and to which dir
105 if self.copy_from and self.copy_to:
106 self.virtual_machines[name].copy_in(self.copy_from, self.copy_to)
3fa89b7c 107 self.virtual_machines[name].start()
5e7f6db7 108
6c352a80
JS
109 # Time to which all serial output log entries are relativ
110 log_start_time = time.time()
111
fc35cba1
JS
112 # Number of chars of the longest machine name
113 longest_machine_name = self.virtual_environ.longest_machine_name
114
5ff14f2d 115 self.log.info("Try to login on all machines")
3fa89b7c 116 for name in self.virtual_environ.machine_names:
5ff14f2d 117 self.log.info("Try to login on {}".format(name))
fc35cba1
JS
118 self.virtual_machines[name].login("{}/test.log".format(self.log_path),
119 log_start_time=log_start_time,
120 longest_machine_name=longest_machine_name)
5e7f6db7 121
3fa89b7c 122 def load_recipe(self):
2fa4467d 123 self.log.info("Going to load the recipe")
3fa89b7c 124 try:
ee227ea1 125 self.recipe = recipe.Recipe(self.recipe_file, machines=self.virtual_environ.machine_names)
4bc54b45
JS
126 for line in self.recipe.recipe:
127 self.log.debug(line)
2fa4467d
JS
128
129 self.log.debug("This was the recipe")
4bc54b45 130 except BaseException as e:
3fa89b7c 131 self.log.error("Failed to load recipe")
4bc54b45 132 raise e
3fa89b7c
JS
133
134 def run_recipe(self):
135 for line in self.recipe.recipe:
136 return_value = self.virtual_machines[line[0]].cmd(line[2])
bce7d520
JS
137 self.log.debug("Return value is: {}".format(return_value))
138 if return_value != "0" and line[1] == "":
61b44c10 139 raise TestException("Failed to execute command '{}' on {}, return code: {}".format(line[2],line[0], return_value))
bce7d520 140 elif return_value == "0" and line[1] == "!":
61b44c10 141 raise TestException("Succeded to execute command '{}' on {}, return code: {}".format(line[2],line[0],return_value))
bce7d520
JS
142 else:
143 self.log.debug("Command '{}' on {} returned with: {}".format(line[2],line[0],return_value))
3fa89b7c
JS
144
145 def virtual_environ_stop(self):
146 for name in self.virtual_environ.machine_names:
f9178ad3
JS
147 # We just catch exception here to avoid
148 # that we stop the cleanup process if only one command fails
149 try:
150 self.virtual_machines[name].shutdown()
151 self.virtual_machines[name].revert_snapshot()
152 self.virtual_machines[name].undefine()
153 except BaseException as e:
154 self.log.exception(e)
3fa89b7c
JS
155
156 for name in self.virtual_environ.network_names:
f9178ad3
JS
157 try:
158 self.virtual_networks[name].undefine()
159 except BaseException as e:
160 self.log.exception(e)
161