blob: 908979804ab3ad8867b64b5968ac6576d2d0e352 [file] [log] [blame]
Brad Bishopc342db32019-05-15 21:57:59 -04001#
2# SPDX-License-Identifier: MIT
3#
4
Brad Bishopd7bf8c12018-02-25 22:55:05 -05005from oeqa.selftest.case import OESelftestTestCase
6from oeqa.utils.commands import runCmd, bitbake, get_bb_var, get_bb_vars
7from oeqa.utils.decorators import testcase
8from oeqa.utils.ftools import write_file
Brad Bishopd7bf8c12018-02-25 22:55:05 -05009
Brad Bishop19323692019-04-05 15:28:33 -040010import oe.recipeutils
11
Brad Bishopd7bf8c12018-02-25 22:55:05 -050012class Distrodata(OESelftestTestCase):
13
Brad Bishopd7bf8c12018-02-25 22:55:05 -050014 def test_checkpkg(self):
15 """
16 Summary: Test that upstream version checks do not regress
17 Expected: Upstream version checks should succeed except for the recipes listed in the exception list.
18 Product: oe-core
Brad Bishop1a4b7ee2018-12-16 17:11:34 -080019 Author: Alexander Kanavin <alex.kanavin@gmail.com>
Brad Bishopd7bf8c12018-02-25 22:55:05 -050020 """
Brad Bishop19323692019-04-05 15:28:33 -040021 feature = 'LICENSE_FLAGS_WHITELIST += " commercial"\n'
22 self.write_config(feature)
23
24 pkgs = oe.recipeutils.get_recipe_upgrade_status()
25
26 regressed_failures = [pkg[0] for pkg in pkgs if pkg[1] == 'UNKNOWN_BROKEN']
27 regressed_successes = [pkg[0] for pkg in pkgs if pkg[1] == 'KNOWN_BROKEN']
Brad Bishopd7bf8c12018-02-25 22:55:05 -050028 msg = ""
29 if len(regressed_failures) > 0:
30 msg = msg + """
31The following packages failed upstream version checks. Please fix them using UPSTREAM_CHECK_URI/UPSTREAM_CHECK_REGEX
32(when using tarballs) or UPSTREAM_CHECK_GITTAGREGEX (when using git). If an upstream version check cannot be performed
33(for example, if upstream does not use git tags), you can set UPSTREAM_VERSION_UNKNOWN to '1' in the recipe to acknowledge
34that the check cannot be performed.
35""" + "\n".join(regressed_failures)
36 if len(regressed_successes) > 0:
37 msg = msg + """
38The following packages have been checked successfully for upstream versions,
39but their recipes claim otherwise by setting UPSTREAM_VERSION_UNKNOWN. Please remove that line from the recipes.
40""" + "\n".join(regressed_successes)
41 self.assertTrue(len(regressed_failures) == 0 and len(regressed_successes) == 0, msg)
Brad Bishop316dfdd2018-06-25 12:45:53 -040042
Andrew Geissler95ac1b82021-03-31 14:34:31 -050043 def test_missing_homepg(self):
44 """
45 Summary: Test for oe-core recipes that don't have a HOMEPAGE or DESCRIPTION
46 Expected: All oe-core recipes should have a DESCRIPTION entry
47 Expected: All oe-core recipes should have a HOMEPAGE entry except for recipes that are not fetched from external sources.
48 Product: oe-core
49 """
50 with bb.tinfoil.Tinfoil() as tinfoil:
51 tinfoil.prepare(config_only=False)
52 no_description = []
53 no_homepage = []
54 for fn in tinfoil.all_recipe_files(variants=False):
55 if not '/meta/recipes-' in fn:
56 # We are only interested in OE-Core
57 continue
58 rd = tinfoil.parse_recipe_file(fn, appends=False)
59 pn = rd.getVar('BPN')
60 srcfile = rd.getVar('SRC_URI').split()
61 #Since DESCRIPTION defaults to SUMMARY if not set, we are only interested in recipes without DESCRIPTION or SUMMARY
62 if not (rd.getVar('SUMMARY') or rd.getVar('DESCRIPTION')):
63 no_description.append((pn, fn))
64 if not rd.getVar('HOMEPAGE'):
65 if srcfile and srcfile[0].startswith('file') or not rd.getVar('SRC_URI'):
66 # We are only interested in recipes SRC_URI fetched from external sources
67 continue
68 no_homepage.append((pn, fn))
69 if no_homepage:
70 self.fail("""
71The following recipes do not have a HOMEPAGE. Please add an entry for HOMEPAGE in the recipe.
72""" + "\n".join(['%s (%s)' % i for i in no_homepage]))
73
74 if no_description:
75 self.fail("""
76The following recipes do not have a DESCRIPTION. Please add an entry for DESCRIPTION in the recipe.
77""" + "\n".join(['%s (%s)' % i for i in no_description]))
78
Brad Bishop316dfdd2018-06-25 12:45:53 -040079 def test_maintainers(self):
80 """
Andrew Geissler82c905d2020-04-13 13:39:40 -050081 Summary: Test that oe-core recipes have a maintainer and entries in maintainers list have a recipe
Brad Bishop316dfdd2018-06-25 12:45:53 -040082 Expected: All oe-core recipes (except a few special static/testing ones) should have a maintainer listed in maintainers.inc file.
Andrew Geissler82c905d2020-04-13 13:39:40 -050083 Expected: All entries in maintainers list should have a recipe file that matches them
Brad Bishop316dfdd2018-06-25 12:45:53 -040084 Product: oe-core
Brad Bishop1a4b7ee2018-12-16 17:11:34 -080085 Author: Alexander Kanavin <alex.kanavin@gmail.com>
Brad Bishop316dfdd2018-06-25 12:45:53 -040086 """
87 def is_exception(pkg):
88 exceptions = ["packagegroup-", "initramfs-", "systemd-machine-units", "target-sdk-provides-dummy"]
89 for i in exceptions:
90 if i in pkg:
91 return True
92 return False
93
Andrew Geissler82c905d2020-04-13 13:39:40 -050094 def is_maintainer_exception(entry):
95 exceptions = ["musl", "newlib", "linux-yocto", "linux-dummy", "mesa-gl", "libgfortran",
Andrew Geisslerd159c7f2021-09-02 21:05:58 -050096 "cve-update-db-native", "rust"]
Andrew Geissler82c905d2020-04-13 13:39:40 -050097 for i in exceptions:
98 if i in entry:
99 return True
100 return False
101
Andrew Geisslerc926e172021-05-07 16:11:35 -0500102 feature = 'require conf/distro/include/maintainers.inc\nLICENSE_FLAGS_WHITELIST += " commercial"\nPARSE_ALL_RECIPES = "1"\nPACKAGE_CLASSES = "package_ipk package_deb package_rpm"\n'
Brad Bishop19323692019-04-05 15:28:33 -0400103 self.write_config(feature)
Brad Bishop316dfdd2018-06-25 12:45:53 -0400104
Brad Bishop19323692019-04-05 15:28:33 -0400105 with bb.tinfoil.Tinfoil() as tinfoil:
106 tinfoil.prepare(config_only=False)
Brad Bishop316dfdd2018-06-25 12:45:53 -0400107
Brad Bishop19323692019-04-05 15:28:33 -0400108 with_maintainer_list = []
109 no_maintainer_list = []
Andrew Geissler82c905d2020-04-13 13:39:40 -0500110
111 missing_recipes = []
112 recipes = []
Patrick Williams213cb262021-08-07 19:21:33 -0500113 prefix = "RECIPE_MAINTAINER:pn-"
Andrew Geissler82c905d2020-04-13 13:39:40 -0500114
Brad Bishop19323692019-04-05 15:28:33 -0400115 # We could have used all_recipes() here, but this method will find
116 # every recipe if we ever move to setting RECIPE_MAINTAINER in recipe files
117 # instead of maintainers.inc
118 for fn in tinfoil.all_recipe_files(variants=False):
119 if not '/meta/recipes-' in fn:
120 # We are only interested in OE-Core
121 continue
122 rd = tinfoil.parse_recipe_file(fn, appends=False)
123 pn = rd.getVar('PN')
Andrew Geissler82c905d2020-04-13 13:39:40 -0500124 recipes.append(pn)
Brad Bishop19323692019-04-05 15:28:33 -0400125 if is_exception(pn):
126 continue
127 if rd.getVar('RECIPE_MAINTAINER'):
128 with_maintainer_list.append((pn, fn))
129 else:
130 no_maintainer_list.append((pn, fn))
Brad Bishop316dfdd2018-06-25 12:45:53 -0400131
Andrew Geissler82c905d2020-04-13 13:39:40 -0500132 maintainers = tinfoil.config_data.keys()
133 for key in maintainers:
134 if key.startswith(prefix):
135 recipe = tinfoil.config_data.expand(key[len(prefix):])
136 if is_maintainer_exception(recipe):
137 continue
138 if recipe not in recipes:
139 missing_recipes.append(recipe)
140
Brad Bishop19323692019-04-05 15:28:33 -0400141 if no_maintainer_list:
142 self.fail("""
143The following recipes do not have a maintainer assigned to them. Please add an entry to meta/conf/distro/include/maintainers.inc file.
144""" + "\n".join(['%s (%s)' % i for i in no_maintainer_list]))
Brad Bishop316dfdd2018-06-25 12:45:53 -0400145
Brad Bishop19323692019-04-05 15:28:33 -0400146 if not with_maintainer_list:
147 self.fail("""
148The list of oe-core recipes with maintainers is empty. This may indicate that the test has regressed and needs fixing.
149""")
Andrew Geissler82c905d2020-04-13 13:39:40 -0500150
151 if missing_recipes:
152 self.fail("""
153Unable to find recipes for the following entries in maintainers.inc:
154""" + "\n".join(['%s' % i for i in missing_recipes]))