src/nitsi/test.py

   1 #!/usr/bin/python3
   2
   3 import configparser
   4 import libvirt
   5 import logging
   6 import os
   7 import time
   8
   9 from . import recipe
  10 from . import virtual_environ
  11 from . import settings
  12 from . import cmd
  13
  14 logger = logging.getLogger("nitsi.test")
  15
  16
  17 class TestException(Exception):
  18     def __init__(self, message):
  19         self.message = message
  20
  21 class Test():
  22     def __init__(self, log_path, dir=None, recipe_file=None, settings_file=None, settings=None):
  23         # init settings var
  24         self.settings = settings
  25
  26         self.log_path = log_path
  27
  28         # Init all vars with None
  29         self.settings_file = None
  30         self.recipe_file = None
  31         self.path = None
  32
  33         # We need at least a path to a recipe file or a dir to a test
  34         if not dir and not recipe:
  35             raise TestException("Did not get a path to a test or to a recipe file")
  36
  37         # We cannot decide which to use when we get both
  38         if (dir and recipe_file) or (dir and settings_file):
  39             raise TestException("Get dir and path to recipe or settings file")
  40
  41         if dir:
  42             try:
  43                 if not os.path.isabs(dir):
  44                     self.path = os.path.abspath(dir)
  45             except BaseException as e:
  46                 logger.error("Could not get absolute path")
  47                 raise e
  48
  49             logger.debug("Path of this test is: {}".format(self.path))
  50
  51             self.recipe_file = "{}/recipe".format(self.path)
  52             self.settings_file = "{}/settings".format(self.path)
  53
  54
  55         # We can also go on without a settings file
  56         if self.settings_file:
  57             if not os.path.isfile(self.settings_file):
  58                 logger.error("No such file: {}".format(self.settings_file))
  59                 raise TestException("No settings file found")
  60
  61         # os.path.isfile fails if self.recipe_file is None so we cannot use an and statement
  62         if self.recipe_file:
  63             if not os.path.isfile(self.recipe_file):
  64                 logger.error("No such file: {}".format(self.recipe_file))
  65                 raise TestException("No recipe file found")
  66         else:
  67             logger.error("No such file: {}".format(self.recipe_file))
  68             raise TestException("No recipe file found")
  69
  70         if recipe_file:
  71             if not os.path.isabs(recipe_file):
  72                 self.recipe_file = os.path.abspath(recipe_file)
  73             else:
  74                 self.recipe_file = recipe_file
  75
  76         if settings_file:
  77             if not os.path.isabs(settings_file):
  78                 self.settings_file = os.path.abspath(settings_file)
  79             else:
  80                 self.settings_file = settings_file
  81
  82
  83         # Init logging
  84         if dir:
  85             self.log = logger.getChild(os.path.basename(self.path))
  86         # We get a recipe when we get here
  87         else:
  88             self.log = logger.getChild(os.path.basename(self.recipe_file))
  89
  90         # Parse config and settings:
  91         if self.settings_file:
  92             self.settings.set_config_values_from_file(self.settings_file, type="settings-file")#
  93
  94         # Check settings
  95         self.settings.check_config_values()
  96
  97     def virtual_environ_setup_stage_1(self):
  98         self.virtual_environ = virtual_environ.VirtualEnviron(self.settings.get_config_value("virtual_environ_path"))
  99
 100         self.virtual_networks = self.virtual_environ.get_networks()
 101
 102         self.virtual_machines = self.virtual_environ.get_machines()
 103
 104     def virtual_environ_setup_stage_2(self):
 105         # built up which machines which are used in our recipe
 106         used_machines = []
 107
 108         for line in self.recipe.recipe:
 109             if not line[0] in used_machines:
 110                 used_machines.append(line[0])
 111
 112         self.log.debug("Machines used in this recipe {}".format(used_machines))
 113
 114         self.used_machine_names = used_machines
 115
 116         for machine in self.used_machine_names:
 117             if not machine in self.virtual_environ.machine_names:
 118                 raise TestException("{} is listed as machine in the recipe, but the virtual environmet does not have such a machine".format(machine))
 119
 120
 121     def virtual_environ_start(self):
 122         for name in self.virtual_environ.network_names:
 123             self.virtual_networks[name].define()
 124             self.virtual_networks[name].start()
 125
 126         for name in self.used_machine_names:
 127             self.virtual_machines[name].define()
 128             self.virtual_machines[name].create_snapshot()
 129             # We can only copy files when we know which and to which dir
 130             if self.settings.get_config_value("copy_from") and self.settings.get_config_value("copy_to"):
 131                 self.virtual_machines[name].copy_in(self.settings.get_config_value("copy_from"), self.settings.get_config_value("copy_to"))
 132             self.virtual_machines[name].start()
 133
 134         # Time to which all serial output log entries are relativ
 135         log_start_time = time.time()
 136
 137         # Number of chars of the longest machine name
 138         longest_machine_name = self.virtual_environ.longest_machine_name
 139
 140         self.log.info("Try to intialize the serial connection, connect and login on all machines")
 141         for name in self.used_machine_names:
 142             self.log.info("Try to initialize the serial connection connect and login on {}".format(name))
 143             self.virtual_machines[name].serial_init(log_file="{}/test.log".format(self.log_path),
 144                                                 log_start_time=log_start_time,
 145                                                 longest_machine_name=longest_machine_name)
 146             self.virtual_machines[name].serial_connect()
 147
 148     def load_recipe(self):
 149         self.log.info("Going to load the recipe")
 150         try:
 151             self.recipe = recipe.Recipe(self.recipe_file,
 152                 fallback_machines=self.virtual_environ.machine_names)
 153
 154             for line in self.recipe.recipe:
 155                 self.log.debug(line)
 156
 157             self.log.debug("This was the recipe")
 158         except BaseException as e:
 159             self.log.error("Failed to load recipe")
 160             raise e
 161
 162     # This functions tries to handle an error of the test (eg. when 'echo "Hello World"' failed)
 163     # in an interactive way
 164     # returns False when the test should exit right now, and True when the test should go on
 165     def interactive_error_handling(self):
 166         if not self.settings.get_config_value("interactive_error_handling"):
 167             return False
 168
 169         _cmd = cmd.CMD(intro="You are droppped into an interative debugging shell because of the previous errors",
 170             help={"exit": "Exit the test rigth now",
 171                 "continue": "Continues the test without any error handling, so do not expect that the test succeeds.",
 172                 "debug": "Disconnects from the serial console and prints the devices to manually connect to the virtual machines." \
 173                     "This is useful when you can fix th error with some manual commands. Please disconnect from the serial consoles and " \
 174                     "choose 'exit or 'continue'  when you are done"})
 175
 176         command = _cmd.get_input(valid_commands=["continue", "exit", "debug"])
 177
 178         if command == "continue":
 179             # The test should go on but we do not any debugging, so we return True
 180             return True
 181         elif command == "exit":
 182             # The test should exit right now (normal behaviour)
 183             return False
 184
 185         # If we get here we are in debugging mode
 186         # Disconnect from the serial console:
 187
 188         for name in self.used_machine_names:
 189             _cmd.print_to_cmd("Disconnect from the serial console of {}".format(name))
 190             self.virtual_machines[name].serial_disconnect()
 191
 192         # Print the serial device for each machine
 193         for name in self.used_machine_names:
 194             device  = self.virtual_machines[name].get_serial_device()
 195             _cmd.print_to_cmd("Serial device of {} is {}".format(name, device))
 196
 197         _cmd.print_to_cmd("You can now connect to all serial devices, and send custom commands to the virtual machines." \
 198             "Please type 'continue' or 'exit' when you disconnected from als serial devices and want to go on.")
 199
 200         command = _cmd.get_input(valid_commands=["continue", "exit"])
 201
 202         if command == "exit":
 203             return False
 204
 205         # We should continue whit the test
 206         # Reconnect to the serial devices
 207
 208         for name in self.used_machine_names:
 209             self.log.info("Try to reconnect to {}".format(name))
 210             self.virtual_machines[name].serial_connect()
 211
 212         return True
 213
 214     def run_recipe(self):
 215         for line in self.recipe.recipe:
 216             return_value = self.virtual_machines[line[0]].cmd(line[2])
 217             self.log.debug("Return value is: {}".format(return_value))
 218             if return_value != "0" and line[1] == "":
 219                 err_msg = "Failed to execute command '{}' on {}, return code: {}".format(line[2],line[0], return_value)
 220                 # Try to handle this error in an interactive way, if we cannot go on
 221                 # raise an exception and exit
 222                 if not self.interactive_error_handling():
 223                     raise TestException(err_msg)
 224
 225             elif return_value == "0" and line[1] == "!":
 226                 err_msg = "Succeded to execute command '{}' on {}, return code: {}".format(line[2],line[0],return_value)
 227                 self.log.error(err_msg)
 228                 # Try to handle this error in an interactive way, if we cannot go on
 229                 # raise an exception and exit
 230                 if not self.interactive_error_handling():
 231                     raise TestException(err_msg)
 232             else:
 233                 self.log.debug("Command '{}' on {} returned with: {}".format(line[2],line[0],return_value))
 234
 235     def virtual_environ_stop(self):
 236         for name in self.used_machine_names:
 237             # We just catch exception here to avoid
 238             # that we stop the cleanup process if only  one command fails
 239             try:
 240                 self.virtual_machines[name].shutdown()
 241                 self.virtual_machines[name].revert_snapshot()
 242                 self.virtual_machines[name].undefine()
 243             except BaseException as e:
 244                 self.log.exception(e)
 245
 246         for name in self.virtual_environ.network_names:
 247             try:
 248                 self.virtual_networks[name].undefine()
 249             except BaseException as e:
 250                  self.log.exception(e)
 251