Commit 40501fca authored by Jérome Perrin's avatar Jérome Perrin

Better testcase snapshots

Implementing improvements discussed in slapos@1a5df533 (comment 93275) and on  !150 (comment 92471) 

We now only store slapos logs one per `setUpModule` for software and `setupClass` for instances.

There's no de-duplication, but it's still a bit big.

/reviewed-on !156
parents 7923d872 dd8f4b5a
Pipeline #7371 failed with stage
in 0 seconds
...@@ -103,7 +103,7 @@ class SupervisorConfigWriter(ConfigWriter): ...@@ -103,7 +103,7 @@ class SupervisorConfigWriter(ConfigWriter):
redirect_stderr = true redirect_stderr = true
stdout_logfile = {stdout_logfile} stdout_logfile = {stdout_logfile}
stdout_logfile_maxbytes = 5MB stdout_logfile_maxbytes = 5MB
stdout_logfile_backups = 10 stdout_logfile_backups = 0
""").format(**locals()) """).format(**locals())
......
...@@ -28,6 +28,7 @@ ...@@ -28,6 +28,7 @@
import unittest import unittest
import os import os
import fnmatch
import glob import glob
import logging import logging
import shutil import shutil
...@@ -217,12 +218,22 @@ def installSoftwareUrlList(cls, software_url_list, max_retry=2, debug=False): ...@@ -217,12 +218,22 @@ def installSoftwareUrlList(cls, software_url_list, max_retry=2, debug=False):
This also check softwares with `checkSoftware` This also check softwares with `checkSoftware`
""" """
def _storeSoftwareLogSnapshot(name):
for standalone_log in glob.glob(os.path.join(
cls._base_directory,
'var',
'log',
'*',
)):
cls._copySnapshot(standalone_log, name)
try: try:
for software_url in software_url_list: for software_url in software_url_list:
cls.logger.debug("Supplying %s", software_url) cls.logger.debug("Supplying %s", software_url)
cls.slap.supply(software_url) cls.slap.supply(software_url)
cls.logger.debug("Waiting for slapos node software to build") cls.logger.debug("Waiting for slapos node software to build")
cls.slap.waitForSoftware(max_retry=max_retry, debug=debug) cls.slap.waitForSoftware(max_retry=max_retry, debug=debug)
_storeSoftwareLogSnapshot('setupModule')
for software_url in software_url_list: for software_url in software_url_list:
checkSoftware(cls.slap, software_url) checkSoftware(cls.slap, software_url)
except BaseException as e: except BaseException as e:
...@@ -236,8 +247,8 @@ def installSoftwareUrlList(cls, software_url_list, max_retry=2, debug=False): ...@@ -236,8 +247,8 @@ def installSoftwareUrlList(cls, software_url_list, max_retry=2, debug=False):
cls.slap.waitForSoftware(max_retry=max_retry, debug=debug) cls.slap.waitForSoftware(max_retry=max_retry, debug=debug)
except BaseException: except BaseException:
cls.logger.exception("Error removing software") cls.logger.exception("Error removing software")
pass _storeSoftwareLogSnapshot('setupModule removing software')
cls._cleanup() cls._cleanup('setupModule')
raise e raise e
...@@ -292,13 +303,13 @@ class SlapOSInstanceTestCase(unittest.TestCase): ...@@ -292,13 +303,13 @@ class SlapOSInstanceTestCase(unittest.TestCase):
_test_file_snapshot_directory = "" # directory to save snapshot files for inspections _test_file_snapshot_directory = "" # directory to save snapshot files for inspections
# patterns of files to save for inspection, relative to instance directory # patterns of files to save for inspection, relative to instance directory
_save_instance_file_pattern_list = ( _save_instance_file_pattern_list = (
'etc/supervisord.conf', '*/bin/*',
'etc/supervisord.conf.d/*',
'*/etc/*', '*/etc/*',
'*/etc/service/*',
'*/etc/run/*',
'*/var/log/*', '*/var/log/*',
'*/.*log', '*/.*log',
'*/.*cfg',
'*/*cfg',
'etc/',
) )
# Methods to be defined by subclasses. # Methods to be defined by subclasses.
...@@ -335,6 +346,7 @@ class SlapOSInstanceTestCase(unittest.TestCase): ...@@ -335,6 +346,7 @@ class SlapOSInstanceTestCase(unittest.TestCase):
"""Request an instance. """Request an instance.
""" """
cls._instance_parameter_dict = cls.getInstanceParameterDict() cls._instance_parameter_dict = cls.getInstanceParameterDict()
snapshot_name = "{}.{}.setUpClass".format(cls.__module__, cls.__name__)
try: try:
cls.logger.debug("Starting") cls.logger.debug("Starting")
...@@ -375,38 +387,75 @@ class SlapOSInstanceTestCase(unittest.TestCase): ...@@ -375,38 +387,75 @@ class SlapOSInstanceTestCase(unittest.TestCase):
cls.computer_partition_root_path = os.path.join( cls.computer_partition_root_path = os.path.join(
cls.slap._instance_root, cls.computer_partition.getId()) cls.slap._instance_root, cls.computer_partition.getId())
cls.logger.debug("setUpClass done") cls.logger.debug("setUpClass done")
except BaseException: except BaseException:
cls.logger.exception("Error during setUpClass") cls.logger.exception("Error during setUpClass")
cls._storeSnapshot("{}.setUpClass".format(cls.__name__)) cls._storeSystemSnapshot(snapshot_name)
cls._cleanup() cls._cleanup(snapshot_name)
cls.setUp = lambda self: self.fail('Setup Class failed.') cls.setUp = lambda self: self.fail('Setup Class failed.')
raise raise
else:
cls._storeSystemSnapshot(snapshot_name)
@classmethod @classmethod
def tearDownClass(cls): def tearDownClass(cls):
"""Tear down class, stop the processes and destroy instance. """Tear down class, stop the processes and destroy instance.
""" """
cls._cleanup() cls._cleanup("{}.{}.tearDownClass".format(cls.__module__, cls.__name__))
if not cls._debug:
cls.logger.debug("cleaning up slapos log files in %s", cls.slap._log_directory)
for log_file in glob.glob(os.path.join(cls.slap._log_directory, '*')):
os.unlink(log_file)
@classmethod @classmethod
def _storeSnapshot(cls, name): def _storePartitionSnapshot(cls, name):
# copy log files from standalone """Store snapshot of partitions.
for standalone_log in glob.glob(os.path.join(
cls._base_directory, 'var', 'log', '*')):
cls._snapshot_instance_file(standalone_log, name)
This uses the definition from class attribute `_save_instance_file_pattern_list`
"""
# copy config and log files from partitions # copy config and log files from partitions
for pattern in cls._save_instance_file_pattern_list: for (dirpath, dirnames, filenames) in os.walk(cls.slap.instance_directory):
for f in glob.glob(os.path.join(cls.slap.instance_directory, pattern)): for dirname in list(dirnames):
cls._snapshot_instance_file(f, name) dirabspath = os.path.join(dirpath, dirname)
if any(fnmatch.fnmatch(
dirabspath,
pattern,
) for pattern in cls._save_instance_file_pattern_list):
cls._copySnapshot(dirabspath, name)
# don't recurse, since _copySnapshot is already recursive
dirnames.remove(dirname)
for filename in filenames:
fileabspath = os.path.join(dirpath, filename)
if any(fnmatch.fnmatch(
fileabspath,
pattern,
) for pattern in cls._save_instance_file_pattern_list):
cls._copySnapshot(fileabspath, name)
@classmethod
def _storeSystemSnapshot(cls, name):
"""Store a snapshot of standalone slapos
Does not include software log, because this is stored at the end of software
installation and software log is large.
"""
# copy log files from standalone
for standalone_log in glob.glob(os.path.join(
cls._base_directory,
'var',
'log',
'*',
)):
if not standalone_log.startswith('slapos-node-software.log'):
cls._copySnapshot(standalone_log, name)
# store slapproxy database
cls._copySnapshot(cls.slap._proxy_database, name)
def tearDown(self): def tearDown(self):
self._storeSnapshot(self.id()) self._storePartitionSnapshot(self.id())
@classmethod @classmethod
def _snapshot_instance_file(cls, source_file_name, name): def _copySnapshot(cls, source_file_name, name):
"""Save a file for later inspection. """Save a file, symbolic link or directory for later inspection.
The path are made relative to slapos root directory and The path are made relative to slapos root directory and
we keep the same directory structure. we keep the same directory structure.
...@@ -423,27 +472,44 @@ class SlapOSInstanceTestCase(unittest.TestCase): ...@@ -423,27 +472,44 @@ class SlapOSInstanceTestCase(unittest.TestCase):
cls._test_file_snapshot_directory, cls._test_file_snapshot_directory,
cls.software_id, cls.software_id,
name, name,
relative_path) relative_path,
)
destination_dirname = os.path.dirname(destination) destination_dirname = os.path.dirname(destination)
mkdir_p(destination_dirname) mkdir_p(destination_dirname)
if os.path.isfile(source_file_name): if os.path.islink(
source_file_name) and not os.path.exists(source_file_name):
cls.logger.debug(
"copy broken symlink %s as %s", source_file_name, destination)
with open(destination, 'w') as f:
f.write('broken symink to {}\n'.format(os.readlink(source_file_name)))
elif os.path.isfile(source_file_name):
cls.logger.debug("copy %s as %s", source_file_name, destination) cls.logger.debug("copy %s as %s", source_file_name, destination)
shutil.copy(source_file_name, destination) shutil.copy(source_file_name, destination)
elif os.path.isdir(source_file_name):
cls.logger.debug("copy directory %s as %s", source_file_name, destination)
# we copy symlinks as symlinks, so that this does not fail when
# we copy a directory containing broken symlinks.
shutil.copytree(source_file_name, destination, symlinks=True)
# implementation methods # implementation methods
@classmethod @classmethod
def _cleanup(cls): def _cleanup(cls, snapshot_name):
# type: (str) -> None
"""Destroy all instances and stop subsystem. """Destroy all instances and stop subsystem.
Catches and log all exceptions. Catches and log all exceptions and take snapshot named `snapshot_name` + the failing step.
""" """
try: try:
cls.requestDefaultInstance(state='destroyed') cls.requestDefaultInstance(state='destroyed')
except: except:
cls.logger.exception("Error during request destruction") cls.logger.exception("Error during request destruction")
cls._storeSystemSnapshot(
"{}._cleanup request destroy".format(snapshot_name))
try: try:
cls.slap.waitForReport(max_retry=cls.report_max_retry, debug=cls._debug) cls.slap.waitForReport(max_retry=cls.report_max_retry, debug=cls._debug)
except: except:
cls.logger.exception("Error during actual destruction") cls.logger.exception("Error during actual destruction")
cls._storeSystemSnapshot(
"{}._cleanup waitForReport".format(snapshot_name))
leaked_partitions = [ leaked_partitions = [
cp for cp in cls.slap.computer.getComputerPartitionList() cp for cp in cls.slap.computer.getComputerPartitionList()
if cp.getState() != 'destroyed' if cp.getState() != 'destroyed'
...@@ -452,6 +518,8 @@ class SlapOSInstanceTestCase(unittest.TestCase): ...@@ -452,6 +518,8 @@ class SlapOSInstanceTestCase(unittest.TestCase):
cls.logger.critical( cls.logger.critical(
"The following partitions were not cleaned up: %s", "The following partitions were not cleaned up: %s",
[cp.getId() for cp in leaked_partitions]) [cp.getId() for cp in leaked_partitions])
cls._storeSystemSnapshot(
"{}._cleanup leaked_partitions".format(snapshot_name))
for cp in leaked_partitions: for cp in leaked_partitions:
try: try:
cls.slap.request( cls.slap.request(
...@@ -463,14 +531,21 @@ class SlapOSInstanceTestCase(unittest.TestCase): ...@@ -463,14 +531,21 @@ class SlapOSInstanceTestCase(unittest.TestCase):
except: except:
cls.logger.exception( cls.logger.exception(
"Error during request destruction of leaked partition") "Error during request destruction of leaked partition")
cls._storeSystemSnapshot(
"{}._cleanup leaked_partitions request destruction".format(
snapshot_name))
try: try:
cls.slap.waitForReport(max_retry=cls.report_max_retry, debug=cls._debug) cls.slap.waitForReport(max_retry=cls.report_max_retry, debug=cls._debug)
except: except:
cls.logger.exception("Error during leaked partitions actual destruction") cls.logger.exception(
"Error during leaked partitions actual destruction")
cls._storeSystemSnapshot(
"{}._cleanup leaked_partitions waitForReport".format(snapshot_name))
try: try:
cls.slap.stop() cls.slap.stop()
except: except:
cls.logger.exception("Error during stop") cls.logger.exception("Error during stop")
cls._storeSystemSnapshot("{}._cleanup stop".format(snapshot_name))
leaked_supervisor_configs = glob.glob( leaked_supervisor_configs = glob.glob(
os.path.join(cls.slap.instance_directory, 'etc', 'supervisord.conf.d', '*.conf')) os.path.join(cls.slap.instance_directory, 'etc', 'supervisord.conf.d', '*.conf'))
if leaked_supervisor_configs: if leaked_supervisor_configs:
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment