Add new function settings_parse_copy_from
[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():
ab5b8849 20 def __init__(self, log_path, dir=None, recipe_file=None, settings_file=None, cmd_settings=None):
978854bf
JS
21 # init settings var
22 self.settings = {}
23
1ec6548b
JS
24 # Set default values for the settings dict
25 self.settings["name"] = ""
26 self.settings["description"] = ""
27 self.settings["copy_from"] = None
28 self.settings["copy_to"] = None
29 self.settings["virtual_environ_path"] = None
30
ab5b8849
JS
31 self.cmd_settings = cmd_settings
32 self.log_path = log_path
5e7f6db7 33
ab5b8849
JS
34 # Init all vars with None
35 self.settings_file = None
36 self.recipe_file = None
37 self.path = None
5e7f6db7 38
ab5b8849
JS
39 # We need at least a path to a recipe file or a dir to a test
40 if not dir and not recipe:
41 raise TestException("Did not get a path to a test or to a recipe file")
42
43 # We cannot decide which to use when we get both
44 if (dir and recipe_file) or (dir and settings_file):
45 raise TestException("Get dir and path to recipe or settings file")
46
47 if dir:
48 try:
49 if not os.path.isabs(dir):
50 self.path = os.path.abspath(dir)
51 except BaseException as e:
52 logger.error("Could not get absolute path")
53 raise e
54
55 logger.debug("Path of this test is: {}".format(self.path))
56
57 self.recipe_file = "{}/recipe".format(self.path)
58 self.settings_file = "{}/settings".format(self.path)
59
60 if recipe_file:
61 if not os.path.isabs(recipe_file):
62 self.recipe_file = os.path.abspath(recipe_file)
63 else:
64 self.recipe_file = recipe_file
65
66 if settings_file:
67 if not os.path.isabs(settings_file):
68 self.settings_file = os.path.abspath(settings_file)
69 else:
70 self.settings_file = settings_file
b4936764 71
5e7f6db7 72 if not os.path.isfile(self.settings_file):
ab5b8849 73 logger.error("No such file: {}".format(self.settings_file))
250db3b1 74 raise TestException("No settings file found")
5e7f6db7 75
5e7f6db7 76 if not os.path.isfile(self.recipe_file):
ab5b8849 77 logger.error("No such file: {}".format(self.recipe_file))
250db3b1 78 raise TestException("No recipe file found")
5e7f6db7 79
ab5b8849
JS
80 # Init logging
81 if dir:
82 self.log = logger.getChild(os.path.basename(self.path))
83
84 if recipe:
85 self.log = logger.getChild(os.path.basename(self.recipe_file))
978854bf 86
5e7f6db7 87 def read_settings(self):
ab5b8849
JS
88 if self.settings_file:
89 self.log.debug("Going to read all settings from the ini file")
90 try:
91 self.config = configparser.ConfigParser()
92 self.config.read(self.settings_file)
93 except BaseException as e:
94 self.log.error("Failed to parse the config")
95 raise e
96
97 self.settings["name"] = self.config.get("GENERAL","name", fallback="")
98 self.settings["description"] = self.config.get("GENERAL", "description", fallback="")
99 self.settings["copy_to"] = self.config.get("GENERAL", "copy_to", fallback=None)
100 self.settings["copy_from"] = self.config.get("GENERAL", "copy_from", fallback=None)
101 self.settings["virtual_environ_path"] = self.config.get("VIRTUAL_ENVIRONMENT", "path", fallback=None)
8428a452 102
978854bf 103 if not self.settings["virtual_environ_path"]:
8428a452
JS
104 self.log.error("No path for virtual environment found.")
105 raise TestException("No path for virtual environment found.")
106
978854bf 107 self.settings["virtual_environ_path"] = os.path.normpath(self.path + "/" + self.settings["virtual_environ_path"])
129c0b0f
JS
108
109 # Parse copy_from setting
978854bf 110 if self.settings["copy_from"]:
8428a452 111 self.log.debug("Going to parse the copy_from setting.")
978854bf 112 self.settings["copy_from"] = self.settings["copy_from"].split(",")
14cd493f 113
8428a452 114 tmp = []
978854bf 115 for file in self.settings["copy_from"]:
8428a452
JS
116 file = file.strip()
117 # If file is empty we do not want to add it to the list
118 if not file == "":
119 # If we get an absolut path we do nothing
120 # If not we add self.path to get an absolut path
121 if not os.path.isabs(file):
122 file = os.path.normpath(self.path + "/" + file)
f010720b 123
8428a452
JS
124 # We need to check if file is a valid file or dir
125 if not (os.path.isdir(file) or os.path.isfile(file)):
126 raise TestException("'{}' is not a valid file nor a valid directory".format(file))
f010720b 127
8428a452
JS
128 self.log.debug("'{}' will be copied into all images".format(file))
129 tmp.append(file)
14cd493f 130
978854bf 131 self.settings["copy_from"] = tmp
5e7f6db7 132
129c0b0f 133
5e7f6db7
JS
134
135 def virtual_environ_setup(self):
978854bf 136 self.virtual_environ = virtual_environ.Virtual_environ(self.settings["virtual_environ_path"])
5e7f6db7
JS
137
138 self.virtual_networks = self.virtual_environ.get_networks()
139
140 self.virtual_machines = self.virtual_environ.get_machines()
141
142 def virtual_environ_start(self):
3fa89b7c
JS
143 for name in self.virtual_environ.network_names:
144 self.virtual_networks[name].define()
145 self.virtual_networks[name].start()
5e7f6db7 146
3fa89b7c
JS
147 for name in self.virtual_environ.machine_names:
148 self.virtual_machines[name].define()
149 self.virtual_machines[name].create_snapshot()
8428a452 150 # We can only copy files when we know which and to which dir
978854bf
JS
151 if self.settings["copy_from"] and self.settings["copy_to"]:
152 self.virtual_machines[name].copy_in(self.settings["copy_from"], self.settings["copy_to"])
3fa89b7c 153 self.virtual_machines[name].start()
5e7f6db7 154
6c352a80
JS
155 # Time to which all serial output log entries are relativ
156 log_start_time = time.time()
157
fc35cba1
JS
158 # Number of chars of the longest machine name
159 longest_machine_name = self.virtual_environ.longest_machine_name
160
5ff14f2d 161 self.log.info("Try to login on all machines")
3fa89b7c 162 for name in self.virtual_environ.machine_names:
5ff14f2d 163 self.log.info("Try to login on {}".format(name))
fc35cba1
JS
164 self.virtual_machines[name].login("{}/test.log".format(self.log_path),
165 log_start_time=log_start_time,
166 longest_machine_name=longest_machine_name)
5e7f6db7 167
3fa89b7c 168 def load_recipe(self):
2fa4467d 169 self.log.info("Going to load the recipe")
3fa89b7c 170 try:
ee227ea1 171 self.recipe = recipe.Recipe(self.recipe_file, machines=self.virtual_environ.machine_names)
4bc54b45
JS
172 for line in self.recipe.recipe:
173 self.log.debug(line)
2fa4467d
JS
174
175 self.log.debug("This was the recipe")
4bc54b45 176 except BaseException as e:
3fa89b7c 177 self.log.error("Failed to load recipe")
4bc54b45 178 raise e
3fa89b7c
JS
179
180 def run_recipe(self):
181 for line in self.recipe.recipe:
182 return_value = self.virtual_machines[line[0]].cmd(line[2])
bce7d520
JS
183 self.log.debug("Return value is: {}".format(return_value))
184 if return_value != "0" and line[1] == "":
61b44c10 185 raise TestException("Failed to execute command '{}' on {}, return code: {}".format(line[2],line[0], return_value))
bce7d520 186 elif return_value == "0" and line[1] == "!":
61b44c10 187 raise TestException("Succeded to execute command '{}' on {}, return code: {}".format(line[2],line[0],return_value))
bce7d520
JS
188 else:
189 self.log.debug("Command '{}' on {} returned with: {}".format(line[2],line[0],return_value))
3fa89b7c
JS
190
191 def virtual_environ_stop(self):
192 for name in self.virtual_environ.machine_names:
f9178ad3
JS
193 # We just catch exception here to avoid
194 # that we stop the cleanup process if only one command fails
195 try:
196 self.virtual_machines[name].shutdown()
197 self.virtual_machines[name].revert_snapshot()
198 self.virtual_machines[name].undefine()
199 except BaseException as e:
200 self.log.exception(e)
3fa89b7c
JS
201
202 for name in self.virtual_environ.network_names:
f9178ad3
JS
203 try:
204 self.virtual_networks[name].undefine()
205 except BaseException as e:
206 self.log.exception(e)
207