yocto-autobuilder-helper/scripts/send_qa_email.py
Alexis Lothoré 76c6b3644c scripts/send_qa_email: guess latest tested revision when dealing with branch
It has been observed that some regression reports generation may failed
when the comparision base is a branch (e.g master) because we can not find
any test results associated to the branch HEAD. This is especially true for
branches which often change, because not all revisions on those branch are
subject to CI tests.

To fix that, whenever we are not dealing with a release, parse the latest
tested revision in test results repository on target branch in order to
guess the corresponding revision in poky repository, so we are sure that
revisions passed to yocto_testresults_query are indeed tested and
regression report can be generated

Signed-off-by: Alexis Lothoré <alexis.lothore@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-10-04 23:39:50 +01:00

255 lines
12 KiB
Python
Executable File

#!/usr/bin/env python3
#
# SPDX-License-Identifier: GPL-2.0-only
#
# Send email about the build to prompt QA to begin testing
#
import json
import os
import sys
import subprocess
import tempfile
import re
import logging
import utils
TEST_RESULTS_REPOSITORY_URL="git@push.yoctoproject.org:yocto-testresults"
exitcode = 0
def is_release_version(version):
p = re.compile('\d{8}-\d+')
return version is not None and p.match(version) is None
def get_previous_tag(targetrepodir, version):
previousversion = None
previousmilestone = None
if version:
if not is_release_version(version):
return subprocess.check_output(["git", "describe", "--abbrev=0"], cwd=targetrepodir).decode('utf-8').strip()
compareversion, comparemilestone, _ = utils.get_version_from_string(version)
compareversionminor = compareversion[-1]
# After ignoring rc part, if we get a minor to 0 on point release (e.g 4.0.0),
# reject last digit since such versions do not exist
if len(compareversion) == 3 and compareversionminor == 0:
compareversion = compareversion[:-1]
# Process milestone if not first in current release
if comparemilestone and comparemilestone > 1:
previousversion = compareversion
previousmilestone = comparemilestone-1
# Process first milestone or release if not first in major release
elif compareversionminor > 0:
previousversion = compareversion[:-1] + [compareversion[-1] - 1]
# Otherwise : format it as tag (which must exist) and search previous tag
else:
comparetagstring = utils.get_tag_from_version(compareversion, comparemilestone)
return subprocess.check_output(["git", "describe", "--abbrev=0", comparetagstring + "^"], cwd=targetrepodir).decode('utf-8').strip()
return utils.get_tag_from_version(previousversion, previousmilestone)
# All other cases : merely check against latest tag reachable
defaultbaseversion, _, _ = utils.get_version_from_string(subprocess.check_output(["git", "describe", "--abbrev=0"], cwd=targetrepodir).decode('utf-8').strip())
return utils.get_tag_from_version(defaultbaseversion, None)
def get_last_tested_rev_on_branch(branch, log):
# Fetch latest test results revision on corresponding branch in test
# results repository
tags_list = subprocess.check_output(["git", "ls-remote", "--refs", "-t", TEST_RESULTS_REPOSITORY_URL, "refs/tags/" + branch + "/*"]).decode('utf-8').strip()
latest_test_tag=tags_list.splitlines()[-1].split()[1]
# From test results tag, extract Poky revision
tested_revision = re.match('refs\/tags\/.*\/\d+-g([a-f0-9]+)\/\d', latest_test_tag).group(1)
log.info(f"Last tested revision on branch {branch} is {tested_revision}")
return tested_revision
def get_regression_base_and_target(targetbranch, basebranch, release, targetrepodir, log):
if not targetbranch:
# Targetbranch/basebranch is an arbitrary configuration (not defined in config.json): do not run regression reporting
return None, None
if is_release_version(release):
# We are on a release: ignore basebranch (which is very likely None),
# regression reporting must be done against previous tag
return get_previous_tag(targetrepodir, release), targetbranch
elif basebranch:
# Basebranch/targetbranch are defined in config.json: regression
# reporting must be done between latest test result available on base branch
# and latest result on targetbranch
latest_tested_rev_on_basebranch = get_last_tested_rev_on_branch(basebranch, log)
return latest_tested_rev_on_basebranch, targetbranch
#Default case: return previous tag as base
return get_previous_tag(targetrepodir, release), targetbranch
def generate_regression_report(querytool, targetrepodir, base, target, resultdir, outputdir, log):
log.info(f"Comparing {target} to {base}")
global exitcode
try:
regreport = subprocess.check_output([querytool, "regression-report", base, target, '-t', resultdir])
with open(outputdir + "/testresult-regressions-report.txt", "wb") as f:
f.write(regreport)
except subprocess.CalledProcessError as e:
error = str(e)
exitcode = 1
log.error(f"Error while generating report between {target} and {base} : {error}")
def send_qa_email():
# Setup logging
logging.basicConfig(level=logging.INFO, format="%(levelname)s: %(message)s")
log = logging.getLogger('send-qa-email')
parser = utils.ArgParser(description='Process test results and optionally send an email about the build to prompt QA to begin testing.')
parser.add_argument('send',
help="True to send email, otherwise the script will display a message and exit")
parser.add_argument('repojson',
help="The json file containing the repositories to use")
parser.add_argument('sharedrepodir',
help="The shared repos directory (to resolve the repo revision hashes)")
parser.add_argument('-p', '--publish-dir',
action='store',
help="Where the artefacts were published")
parser.add_argument('-R', '--results-dir',
action='store',
help="Where the test results were published")
parser.add_argument('-r', '--release',
action='store',
help="The build/release 'name' for release purposes (optional)")
parser.add_argument('--url',
action='store',
help="The url for the build")
args = parser.parse_args()
ourconfig = utils.loadconfig()
with open(args.repojson) as f:
repos = json.load(f)
resulttool = os.path.dirname(args.repojson) + "/build/scripts/resulttool"
querytool = os.path.dirname(args.repojson) + "/build/scripts/yocto_testresults_query.py"
buildtoolsdir = os.path.dirname(args.repojson) + "/build/buildtools"
if os.path.exists(buildtoolsdir):
utils.enable_buildtools_tarball(buildtoolsdir)
repodir = os.path.dirname(args.repojson) + "/build/repos"
if 'poky' in repos and os.path.exists(resulttool) and os.path.exists(querytool) and args.results_dir:
utils.printheader("Processing test report")
# Need the finalised revisions (not 'HEAD')
targetrepodir = "%s/poky" % (repodir)
revision = subprocess.check_output(["git", "rev-parse", "HEAD"], cwd=targetrepodir).decode('utf-8').strip()
branch = repos['poky']['branch']
repo = repos['poky']['url']
targetbranch, basebranch = utils.getcomparisonbranch(ourconfig, repo, branch)
report = subprocess.check_output([resulttool, "report", args.results_dir])
with open(args.results_dir + "/testresult-report.txt", "wb") as f:
f.write(report)
tempdir = tempfile.mkdtemp(prefix='sendqaemail.')
try:
utils.printheader("Importing test results repo data")
cloneopts = []
if basebranch:
cloneopts = ["--branch", basebranch]
elif targetbranch:
cloneopts = ["--branch", targetbranch]
try:
subprocess.check_call(["git", "clone", TEST_RESULTS_REPOSITORY_URL, tempdir, "--depth", "1"] + cloneopts)
except subprocess.CalledProcessError:
log.info("No comparision branch found, falling back to master")
subprocess.check_call(["git", "clone", TEST_RESULTS_REPOSITORY_URL, tempdir, "--depth", "1"])
# If the base comparision branch isn't present regression comparision won't work
# at least until we can tell the tool to ignore internal branch information
if targetbranch:
try:
subprocess.check_call(["git", "rev-parse", "--verify", targetbranch], cwd=tempdir)
except subprocess.CalledProcessError:
# Doesn't exist so base it off master
# some older hosts don't have git branch old new
subprocess.check_call(["git", "checkout", "master"], cwd=tempdir)
subprocess.check_call(["git", "branch", targetbranch], cwd=tempdir)
subprocess.check_call(["git", "checkout", targetbranch], cwd=tempdir)
utils.printheader("Storing results")
subprocess.check_call([resulttool, "store", args.results_dir, tempdir])
if basebranch:
subprocess.check_call(["git", "push", "--all", "--force"], cwd=tempdir)
subprocess.check_call(["git", "push", "--tags", "--force"], cwd=tempdir)
elif targetbranch:
subprocess.check_call(["git", "push", "--all"], cwd=tempdir)
subprocess.check_call(["git", "push", "--tags"], cwd=tempdir)
elif is_release_version(args.release) and not basebranch and not targetbranch:
log.warning("Test results not published on release version. Faulty AB configuration ?")
utils.printheader("Processing regression report")
regression_base, regression_target = get_regression_base_and_target(targetbranch, basebranch, args.release, targetrepodir, log)
if regression_base and regression_target:
generate_regression_report(querytool, targetrepodir, regression_base, regression_target, tempdir, args.results_dir, log)
finally:
subprocess.check_call(["rm", "-rf", tempdir])
pass
if args.send.lower() != 'true' or not args.publish_dir or not args.release:
utils.printheader("Not sending QA email")
sys.exit(exitcode)
utils.printheader("Generating QA email")
buildhashes = ""
for repo in sorted(repos.keys()):
# gplv2 is no longer built/tested in master
if repo == "meta-gplv2":
continue
# Need the finalised revisions (not 'HEAD')
targetrepodir = "%s/%s" % (repodir, repo)
revision = subprocess.check_output(["git", "rev-parse", "HEAD"], cwd=targetrepodir).decode('utf-8').strip()
buildhashes += "%s: %s\n" % (repo, revision)
web_root = utils.getconfig('WEBPUBLISH_DIR', ourconfig)
web_url = utils.getconfig('WEBPUBLISH_URL', ourconfig)
email = ""
mailto = utils.getconfig("QAMAIL_TO", ourconfig)
if mailto:
email += "To: " + mailto + "\n"
mailcc = utils.getconfig("QAMAIL_CC", ourconfig)
if mailcc:
email += "Cc: " + mailcc + "\n"
mailbcc = utils.getconfig("QAMAIL_BCC", ourconfig)
if mailbcc:
email += "Bcc: " + mailbcc + "\n"
email += "Subject: " + "QA notification for completed autobuilder build (%s)\n" % args.release
email += '''\n
A build flagged for QA (%s) was completed on the autobuilder and is available at:\n\n
%s\n\n
Build URL: %s\n
Build hash information: \n
%s
\nThis is an automated message from the Yocto Project Autobuilder\nGit: git://git.yoctoproject.org/yocto-autobuilder2\nEmail: richard.purdie@linuxfoundation.org\n
''' % (args.release, args.publish_dir.replace(web_root, web_url), args.url, buildhashes)
# Store a copy of the email in case it doesn't reach the lists
with open(os.path.join(args.publish_dir, "qa-email"), "wb") as qa_email:
qa_email.write(email.encode('utf-8'))
utils.printheader("Sending QA email")
env = os.environ.copy()
# Many distros have sendmail in */sbin
env["PATH"] = env["PATH"] + ":/usr/sbin:/sbin"
subprocess.check_call('echo "' + email +' " | sendmail -t', shell=True, env=env)
sys.exit(exitcode)
if __name__ == "__main__":
send_qa_email()