insane.bbclass: add a SUMMARY/HOMEPAGE check (oe-core recipes only)

This was done in a selftest, but that is too late and creates
friction in integration as errors are not seen until autobuilder fails.

Bonus fix: SUMMARY check wasn't even working, as in the absence
of one set in the recipe there is a default value set from bitbake.conf.

I left DESCRIPTION check out for now, as many recipes don't actually
have it, and it's set from SUMMARY (plus a dot) if absent.

(From OE-Core rev: 4144c2f43da39336b03cfd612cbe1694cbf8c7bd)

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Alexander Kanavin
2023-07-27 16:36:10 +02:00
committed by Richard Purdie
parent 2c7a4a8021
commit ba961128e2
2 changed files with 16 additions and 36 deletions

View File

@@ -50,6 +50,7 @@ ERROR_QA ?= "dev-so debug-deps dev-deps debug-files arch pkgconfig la \
# Add usrmerge QA check based on distro feature
ERROR_QA:append = "${@bb.utils.contains('DISTRO_FEATURES', 'usrmerge', ' usrmerge', '', d)}"
ERROR_QA:append:layer-core = " patch-status"
WARN_QA:append:layer-core = " missing-metadata"
FAKEROOT_QA = "host-user-contaminated"
FAKEROOT_QA[doc] = "QA tests which need to run under fakeroot. If any \
@@ -1470,6 +1471,21 @@ python do_qa_unpack() {
}
python do_recipe_qa() {
def test_missing_metadata(d):
fn = d.getVar("FILE")
pn = d.getVar('BPN')
srcfile = d.getVar('SRC_URI').split()
# Check that SUMMARY is not the same as the default from bitbake.conf
if d.getVar('SUMMARY') == d.expand("${PN} version ${PV}-${PR}"):
oe.qa.handle_error("missing-metadata", "Recipe {} in {} does not contain a SUMMARY. Please add an entry.".format(pn, fn), d)
if not d.getVar('HOMEPAGE'):
if srcfile and srcfile[0].startswith('file') or not d.getVar('SRC_URI'):
# We are only interested in recipes SRC_URI fetched from external sources
pass
else:
oe.qa.handle_error("missing-metadata", "Recipe {} in {} does not contain a HOMEPAGE. Please add an entry.".format(pn, fn), d)
test_missing_metadata(d)
oe.qa.exit_if_errors(d)
}

View File

@@ -39,42 +39,6 @@ but their recipes claim otherwise by setting UPSTREAM_VERSION_UNKNOWN. Please re
""" + "\n".join(regressed_successes)
self.assertTrue(len(regressed_failures) == 0 and len(regressed_successes) == 0, msg)
def test_missing_homepg(self):
"""
Summary: Test for oe-core recipes that don't have a HOMEPAGE or DESCRIPTION
Expected: All oe-core recipes should have a DESCRIPTION entry
Expected: All oe-core recipes should have a HOMEPAGE entry except for recipes that are not fetched from external sources.
Product: oe-core
"""
with bb.tinfoil.Tinfoil() as tinfoil:
tinfoil.prepare(config_only=False)
no_description = []
no_homepage = []
for fn in tinfoil.all_recipe_files(variants=False):
if not '/meta/recipes-' in fn:
# We are only interested in OE-Core
continue
rd = tinfoil.parse_recipe_file(fn, appends=False)
pn = rd.getVar('BPN')
srcfile = rd.getVar('SRC_URI').split()
#Since DESCRIPTION defaults to SUMMARY if not set, we are only interested in recipes without DESCRIPTION or SUMMARY
if not (rd.getVar('SUMMARY') or rd.getVar('DESCRIPTION')):
no_description.append((pn, fn))
if not rd.getVar('HOMEPAGE'):
if srcfile and srcfile[0].startswith('file') or not rd.getVar('SRC_URI'):
# We are only interested in recipes SRC_URI fetched from external sources
continue
no_homepage.append((pn, fn))
if no_homepage:
self.fail("""
The following recipes do not have a HOMEPAGE. Please add an entry for HOMEPAGE in the recipe.
""" + "\n".join(['%s (%s)' % i for i in no_homepage]))
if no_description:
self.fail("""
The following recipes do not have a DESCRIPTION. Please add an entry for DESCRIPTION in the recipe.
""" + "\n".join(['%s (%s)' % i for i in no_description]))
def test_maintainers(self):
"""
Summary: Test that oe-core recipes have a maintainer and entries in maintainers list have a recipe