tobiko/tools/run_tests.py
Federico Ressi 7207175342 Update pytest reports generation
- Set workflow step name as junit test suite name
- Set HTML report title
- Render HTML report all test case rows collapsed
- Add tobiko release version and Git commit to
  reported environment metadata

Change-Id: Id827146d1f8455047dd5eedfa90171da8be02ea5
2021-02-04 15:07:23 +00:00

160 lines
4.7 KiB
Python
Executable File

#!/usr/bin/env python3
# Copyright 2018 Red Hat
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
from __future__ import absolute_import
import os
import psutil
import signal
import sys
import subprocess
TOP_DIR = os.path.dirname(os.path.dirname(__file__))
if TOP_DIR not in sys.path:
sys.path.insert(0, TOP_DIR)
from tools import common # noqa
LOG = common.get_logger(__name__)
OS_TEST_PATH = common.normalize_path(os.environ['OS_TEST_PATH'])
# Output dirs
TOX_REPORT_DIR = common.normalize_path(
os.environ.get('TOX_REPORT_DIR', os.getcwd()))
TOX_REPORT_NAME = os.environ.get('TOX_REPORT_NAME', 'tobiko_results')
TOX_REPORT_PREFIX = os.path.join(TOX_REPORT_DIR, TOX_REPORT_NAME)
TOX_REPORT_LOG = os.environ.get(
'TOX_REPORT_LOG', TOX_REPORT_PREFIX + '.log')
TOX_REPORT_HTML = os.environ.get(
'TOX_REPORT_HTML', TOX_REPORT_PREFIX + '.html')
TOX_REPORT_XML = os.environ.get(
'TOX_REPORT_XML', TOX_REPORT_PREFIX + '.xml')
TOX_NUM_PROCESSES = os.environ.get('TOX_NUM_PROCESSES') or 'auto'
TOX_RUN_TESTS_TIMEOUT = float(os.environ.get('TOX_RUN_TESTS_TIMEOUT') or 0.)
TOX_RERUNS = int(os.environ.get('TOX_RERUNS') or 0)
TOX_RERUNS_DELAY = int(os.environ.get('TOX_RERUNS_DELAY') or 5)
TOX_COVER = bool(os.environ.get('TOX_COVER', 'false').lower() in ['1', 'yes', 'true'])
def main():
common.setup_logging()
try:
succeeded = run_tests()
if succeeded:
LOG.info('SUCCEEDED')
sys.exit(0)
else:
LOG.info('FAILED')
sys.exit(1)
except Exception:
LOG.exception('ERROR')
sys.exit(2)
def run_tests():
setup_timeout()
cleanup_report_dir()
log_environ()
succeeded = True
try:
run_test_cases()
except (subprocess.CalledProcessError,
subprocess.TimeoutExpired,
ProcessLookupError) as ex:
LOG.error(f"Error while running test cases.\n{ex}")
succeeded = False
return succeeded
def setup_timeout():
if TOX_RUN_TESTS_TIMEOUT > 0.:
def handle_timeout(_signum, _frame):
LOG.error(
f"run_tests.py timeout out after {TOX_RUN_TESTS_TIMEOUT} "
"seconds")
terminate_childs()
raise subprocess.TimeoutExpired("run_tests.py",
TOX_RUN_TESTS_TIMEOUT)
signal.setitimer(signal.ITIMER_REAL, TOX_RUN_TESTS_TIMEOUT)
signal.signal(signal.SIGALRM, handle_timeout)
LOG.debug(f'Run tests timeout set as {TOX_RUN_TESTS_TIMEOUT} seconds')
def terminate_childs():
current_process = psutil.Process()
children = current_process.children(recursive=False)
for child in children:
LOG.debug(f"Interrupt child process execution (pid={child.pid})")
os.kill(child.pid, signal.SIGINT)
for child in children:
LOG.debug("Wait for top-child process termination "
f"(pid={child.pid})...")
os.waitpid(child.pid, 0)
def cleanup_report_dir():
for report_file in [TOX_REPORT_LOG, TOX_REPORT_HTML, TOX_REPORT_XML]:
if not common.make_dir(os.path.dirname(report_file)):
common.remove_file(report_file)
def log_environ():
common.execute('env | sort >> "{log_file}"', log_file=TOX_REPORT_LOG,
capture_stdout=False)
def run_test_cases():
xdist_options = ''
if TOX_NUM_PROCESSES != '1':
xdist_options = f"--numprocesses '{TOX_NUM_PROCESSES}' --dist loadscope"
rerun_options = ''
if TOX_RERUNS:
rerun_options = f"--reruns '{TOX_RERUNS}' --reruns-delay '{TOX_RERUNS_DELAY}'"
cover_options = ''
if TOX_COVER:
cover_options = f"--cov=tobiko"
# Pass environment variables to pytest command
environ = dict(os.environ, TOX_REPORT_NAME=TOX_REPORT_NAME)
common.execute(f"pytest "
f"{xdist_options} "
f"{rerun_options} "
f"{cover_options} "
f"--log-file={TOX_REPORT_LOG} "
f"--junitxml={TOX_REPORT_XML} "
f"--html={TOX_REPORT_HTML} --self-contained-html "
f"{common.get_posargs()}",
environ=environ,
capture_stdout=False)
if __name__ == '__main__':
main()