Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1 | # BB Class inspired by ebuild.sh |
| 2 | # |
| 3 | # This class will test files after installation for certain |
| 4 | # security issues and other kind of issues. |
| 5 | # |
| 6 | # Checks we do: |
| 7 | # -Check the ownership and permissions |
| 8 | # -Check the RUNTIME path for the $TMPDIR |
| 9 | # -Check if .la files wrongly point to workdir |
| 10 | # -Check if .pc files wrongly point to workdir |
| 11 | # -Check if packages contains .debug directories or .so files |
| 12 | # where they should be in -dev or -dbg |
| 13 | # -Check if config.log contains traces to broken autoconf tests |
| 14 | # -Check invalid characters (non-utf8) on some package metadata |
| 15 | # -Ensure that binaries in base_[bindir|sbindir|libdir] do not link |
| 16 | # into exec_prefix |
| 17 | # -Check that scripts in base_[bindir|sbindir|libdir] do not reference |
| 18 | # files under exec_prefix |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 19 | # -Check if the package name is upper case |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 20 | |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 21 | # Elect whether a given type of error is a warning or error, they may |
| 22 | # have been set by other files. |
Andrew Geissler | c182c62 | 2020-05-15 14:13:32 -0500 | [diff] [blame] | 23 | WARN_QA ?= " libdir xorg-driver-abi \ |
| 24 | textrel incompatible-license files-invalid \ |
| 25 | infodir build-deps src-uri-bad symlink-to-sysroot multilib \ |
Brad Bishop | d89cb5f | 2019-04-10 09:02:41 -0400 | [diff] [blame] | 26 | invalid-packageconfig host-user-contaminated uppercase-pn patch-fuzz \ |
Andrew Geissler | 5a43b43 | 2020-06-13 10:46:56 -0500 | [diff] [blame] | 27 | mime mime-xdg unlisted-pkg-lics unhandled-features-check \ |
Andrew Geissler | d159c7f | 2021-09-02 21:05:58 -0500 | [diff] [blame] | 28 | missing-update-alternatives native-last missing-ptest \ |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 29 | license-exists license-no-generic license-syntax license-format \ |
| 30 | license-incompatible license-file-missing \ |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 31 | " |
| 32 | ERROR_QA ?= "dev-so debug-deps dev-deps debug-files arch pkgconfig la \ |
| 33 | perms dep-cmp pkgvarcheck perm-config perm-line perm-link \ |
| 34 | split-strip packages-list pkgv-undefined var-undefined \ |
| 35 | version-going-backwards expanded-d invalid-chars \ |
Brad Bishop | 1932369 | 2019-04-05 15:28:33 -0400 | [diff] [blame] | 36 | license-checksum dev-elf file-rdeps configure-unsafe \ |
Andrew Geissler | 82c905d | 2020-04-13 13:39:40 -0500 | [diff] [blame] | 37 | configure-gettext perllocalpod shebang-size \ |
Andrew Geissler | c182c62 | 2020-05-15 14:13:32 -0500 | [diff] [blame] | 38 | already-stripped installed-vs-shipped ldflags compile-host-path \ |
| 39 | install-host-path pn-overrides unknown-configure-option \ |
| 40 | useless-rpaths rpaths staticdev \ |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 41 | " |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 42 | # Add usrmerge QA check based on distro feature |
Patrick Williams | 213cb26 | 2021-08-07 19:21:33 -0500 | [diff] [blame] | 43 | ERROR_QA:append = "${@bb.utils.contains('DISTRO_FEATURES', 'usrmerge', ' usrmerge', '', d)}" |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 44 | |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 45 | FAKEROOT_QA = "host-user-contaminated" |
| 46 | FAKEROOT_QA[doc] = "QA tests which need to run under fakeroot. If any \ |
| 47 | enabled tests are listed here, the do_package_qa task will run under fakeroot." |
| 48 | |
| 49 | ALL_QA = "${WARN_QA} ${ERROR_QA}" |
| 50 | |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 51 | UNKNOWN_CONFIGURE_WHITELIST ?= "--enable-nls --disable-nls --disable-silent-rules --disable-dependency-tracking --with-libtool-sysroot --disable-static" |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 52 | |
Patrick Williams | c0f7c04 | 2017-02-23 20:41:17 -0600 | [diff] [blame] | 53 | def package_qa_clean_path(path, d, pkg=None): |
| 54 | """ |
| 55 | Remove redundant paths from the path for display. If pkg isn't set then |
| 56 | TMPDIR is stripped, otherwise PKGDEST/pkg is stripped. |
| 57 | """ |
| 58 | if pkg: |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 59 | path = path.replace(os.path.join(d.getVar("PKGDEST"), pkg), "/") |
| 60 | return path.replace(d.getVar("TMPDIR"), "/").replace("//", "/") |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 61 | |
Andrew Geissler | 82c905d | 2020-04-13 13:39:40 -0500 | [diff] [blame] | 62 | QAPATHTEST[shebang-size] = "package_qa_check_shebang_size" |
| 63 | def package_qa_check_shebang_size(path, name, d, elf, messages): |
Andrew Geissler | d1e8949 | 2021-02-12 15:35:20 -0600 | [diff] [blame] | 64 | import stat |
| 65 | if os.path.islink(path) or stat.S_ISFIFO(os.stat(path).st_mode) or elf: |
Andrew Geissler | 82c905d | 2020-04-13 13:39:40 -0500 | [diff] [blame] | 66 | return |
| 67 | |
| 68 | try: |
| 69 | with open(path, 'rb') as f: |
| 70 | stanza = f.readline(130) |
| 71 | except IOError: |
| 72 | return |
| 73 | |
| 74 | if stanza.startswith(b'#!'): |
| 75 | #Shebang not found |
| 76 | try: |
| 77 | stanza = stanza.decode("utf-8") |
| 78 | except UnicodeDecodeError: |
| 79 | #If it is not a text file, it is not a script |
| 80 | return |
| 81 | |
| 82 | if len(stanza) > 129: |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 83 | oe.qa.add_message(messages, "shebang-size", "%s: %s maximum shebang size exceeded, the maximum size is 128." % (name, package_qa_clean_path(path, d))) |
Andrew Geissler | 82c905d | 2020-04-13 13:39:40 -0500 | [diff] [blame] | 84 | return |
| 85 | |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 86 | QAPATHTEST[libexec] = "package_qa_check_libexec" |
| 87 | def package_qa_check_libexec(path,name, d, elf, messages): |
| 88 | |
| 89 | # Skip the case where the default is explicitly /usr/libexec |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 90 | libexec = d.getVar('libexecdir') |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 91 | if libexec == "/usr/libexec": |
| 92 | return True |
| 93 | |
| 94 | if 'libexec' in path.split(os.path.sep): |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 95 | oe.qa.add_message(messages, "libexec", "%s: %s is using libexec please relocate to %s" % (name, package_qa_clean_path(path, d), libexec)) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 96 | return False |
| 97 | |
| 98 | return True |
| 99 | |
| 100 | QAPATHTEST[rpaths] = "package_qa_check_rpath" |
| 101 | def package_qa_check_rpath(file,name, d, elf, messages): |
| 102 | """ |
| 103 | Check for dangerous RPATHs |
| 104 | """ |
| 105 | if not elf: |
| 106 | return |
| 107 | |
| 108 | if os.path.islink(file): |
| 109 | return |
| 110 | |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 111 | bad_dirs = [d.getVar('BASE_WORKDIR'), d.getVar('STAGING_DIR_TARGET')] |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 112 | |
| 113 | phdrs = elf.run_objdump("-p", d) |
| 114 | |
| 115 | import re |
Brad Bishop | 977dc1a | 2019-02-06 16:01:43 -0500 | [diff] [blame] | 116 | rpath_re = re.compile(r"\s+RPATH\s+(.*)") |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 117 | for line in phdrs.split("\n"): |
| 118 | m = rpath_re.match(line) |
| 119 | if m: |
| 120 | rpath = m.group(1) |
| 121 | for dir in bad_dirs: |
| 122 | if dir in rpath: |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 123 | oe.qa.add_message(messages, "rpaths", "package %s contains bad RPATH %s in file %s" % (name, rpath, file)) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 124 | |
| 125 | QAPATHTEST[useless-rpaths] = "package_qa_check_useless_rpaths" |
| 126 | def package_qa_check_useless_rpaths(file, name, d, elf, messages): |
| 127 | """ |
| 128 | Check for RPATHs that are useless but not dangerous |
| 129 | """ |
| 130 | def rpath_eq(a, b): |
| 131 | return os.path.normpath(a) == os.path.normpath(b) |
| 132 | |
| 133 | if not elf: |
| 134 | return |
| 135 | |
| 136 | if os.path.islink(file): |
| 137 | return |
| 138 | |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 139 | libdir = d.getVar("libdir") |
| 140 | base_libdir = d.getVar("base_libdir") |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 141 | |
| 142 | phdrs = elf.run_objdump("-p", d) |
| 143 | |
| 144 | import re |
Brad Bishop | 977dc1a | 2019-02-06 16:01:43 -0500 | [diff] [blame] | 145 | rpath_re = re.compile(r"\s+RPATH\s+(.*)") |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 146 | for line in phdrs.split("\n"): |
| 147 | m = rpath_re.match(line) |
| 148 | if m: |
| 149 | rpath = m.group(1) |
| 150 | if rpath_eq(rpath, libdir) or rpath_eq(rpath, base_libdir): |
| 151 | # The dynamic linker searches both these places anyway. There is no point in |
| 152 | # looking there again. |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 153 | oe.qa.add_message(messages, "useless-rpaths", "%s: %s contains probably-redundant RPATH %s" % (name, package_qa_clean_path(file, d, name), rpath)) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 154 | |
| 155 | QAPATHTEST[dev-so] = "package_qa_check_dev" |
| 156 | def package_qa_check_dev(path, name, d, elf, messages): |
| 157 | """ |
| 158 | Check for ".so" library symlinks in non-dev packages |
| 159 | """ |
| 160 | |
| 161 | if not name.endswith("-dev") and not name.endswith("-dbg") and not name.endswith("-ptest") and not name.startswith("nativesdk-") and path.endswith(".so") and os.path.islink(path): |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 162 | oe.qa.add_message(messages, "dev-so", "non -dev/-dbg/nativesdk- package %s contains symlink .so '%s'" % \ |
Andrew Geissler | c926e17 | 2021-05-07 16:11:35 -0500 | [diff] [blame] | 163 | (name, package_qa_clean_path(path, d, name))) |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 164 | |
| 165 | QAPATHTEST[dev-elf] = "package_qa_check_dev_elf" |
| 166 | def package_qa_check_dev_elf(path, name, d, elf, messages): |
| 167 | """ |
| 168 | Check that -dev doesn't contain real shared libraries. The test has to |
| 169 | check that the file is not a link and is an ELF object as some recipes |
| 170 | install link-time .so files that are linker scripts. |
| 171 | """ |
| 172 | if name.endswith("-dev") and path.endswith(".so") and not os.path.islink(path) and elf: |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 173 | oe.qa.add_message(messages, "dev-elf", "-dev package %s contains non-symlink .so '%s'" % \ |
Andrew Geissler | c926e17 | 2021-05-07 16:11:35 -0500 | [diff] [blame] | 174 | (name, package_qa_clean_path(path, d, name))) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 175 | |
| 176 | QAPATHTEST[staticdev] = "package_qa_check_staticdev" |
| 177 | def package_qa_check_staticdev(path, name, d, elf, messages): |
| 178 | """ |
| 179 | Check for ".a" library in non-staticdev packages |
| 180 | There are a number of exceptions to this rule, -pic packages can contain |
| 181 | static libraries, the _nonshared.a belong with their -dev packages and |
| 182 | libgcc.a, libgcov.a will be skipped in their packages |
| 183 | """ |
| 184 | |
Andrew Geissler | 82c905d | 2020-04-13 13:39:40 -0500 | [diff] [blame] | 185 | if not name.endswith("-pic") and not name.endswith("-staticdev") and not name.endswith("-ptest") and path.endswith(".a") and not path.endswith("_nonshared.a") and not '/usr/lib/debug-static/' in path and not '/.debug-static/' in path: |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 186 | oe.qa.add_message(messages, "staticdev", "non -staticdev package contains static .a library: %s path '%s'" % \ |
Andrew Geissler | c926e17 | 2021-05-07 16:11:35 -0500 | [diff] [blame] | 187 | (name, package_qa_clean_path(path,d, name))) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 188 | |
Andrew Geissler | 82c905d | 2020-04-13 13:39:40 -0500 | [diff] [blame] | 189 | QAPATHTEST[mime] = "package_qa_check_mime" |
| 190 | def package_qa_check_mime(path, name, d, elf, messages): |
| 191 | """ |
| 192 | Check if package installs mime types to /usr/share/mime/packages |
| 193 | while no inheriting mime.bbclass |
| 194 | """ |
| 195 | |
| 196 | if d.getVar("datadir") + "/mime/packages" in path and path.endswith('.xml') and not bb.data.inherits_class("mime", d): |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 197 | oe.qa.add_message(messages, "mime", "package contains mime types but does not inherit mime: %s path '%s'" % \ |
Andrew Geissler | 82c905d | 2020-04-13 13:39:40 -0500 | [diff] [blame] | 198 | (name, package_qa_clean_path(path,d))) |
| 199 | |
| 200 | QAPATHTEST[mime-xdg] = "package_qa_check_mime_xdg" |
| 201 | def package_qa_check_mime_xdg(path, name, d, elf, messages): |
| 202 | """ |
| 203 | Check if package installs desktop file containing MimeType and requires |
| 204 | mime-types.bbclass to create /usr/share/applications/mimeinfo.cache |
| 205 | """ |
| 206 | |
| 207 | if d.getVar("datadir") + "/applications" in path and path.endswith('.desktop') and not bb.data.inherits_class("mime-xdg", d): |
| 208 | mime_type_found = False |
| 209 | try: |
| 210 | with open(path, 'r') as f: |
| 211 | for line in f.read().split('\n'): |
| 212 | if 'MimeType' in line: |
| 213 | mime_type_found = True |
| 214 | break; |
| 215 | except: |
| 216 | # At least libreoffice installs symlinks with absolute paths that are dangling here. |
| 217 | # We could implement some magic but for few (one) recipes it is not worth the effort so just warn: |
| 218 | wstr = "%s cannot open %s - is it a symlink with absolute path?\n" % (name, package_qa_clean_path(path,d)) |
| 219 | wstr += "Please check if (linked) file contains key 'MimeType'.\n" |
| 220 | pkgname = name |
| 221 | if name == d.getVar('PN'): |
| 222 | pkgname = '${PN}' |
Patrick Williams | 213cb26 | 2021-08-07 19:21:33 -0500 | [diff] [blame] | 223 | wstr += "If yes: add \'inhert mime-xdg\' and \'MIME_XDG_PACKAGES += \"%s\"\' / if no add \'INSANE_SKIP:%s += \"mime-xdg\"\' to recipe." % (pkgname, pkgname) |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 224 | oe.qa.add_message(messages, "mime-xdg", wstr) |
Andrew Geissler | 82c905d | 2020-04-13 13:39:40 -0500 | [diff] [blame] | 225 | if mime_type_found: |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 226 | oe.qa.add_message(messages, "mime-xdg", "package contains desktop file with key 'MimeType' but does not inhert mime-xdg: %s path '%s'" % \ |
Andrew Geissler | 82c905d | 2020-04-13 13:39:40 -0500 | [diff] [blame] | 227 | (name, package_qa_clean_path(path,d))) |
| 228 | |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 229 | def package_qa_check_libdir(d): |
| 230 | """ |
| 231 | Check for wrong library installation paths. For instance, catch |
| 232 | recipes installing /lib/bar.so when ${base_libdir}="lib32" or |
| 233 | installing in /usr/lib64 when ${libdir}="/usr/lib" |
| 234 | """ |
| 235 | import re |
| 236 | |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 237 | pkgdest = d.getVar('PKGDEST') |
| 238 | base_libdir = d.getVar("base_libdir") + os.sep |
| 239 | libdir = d.getVar("libdir") + os.sep |
| 240 | libexecdir = d.getVar("libexecdir") + os.sep |
| 241 | exec_prefix = d.getVar("exec_prefix") + os.sep |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 242 | |
| 243 | messages = [] |
| 244 | |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 245 | # The re's are purposely fuzzy, as some there are some .so.x.y.z files |
| 246 | # that don't follow the standard naming convention. It checks later |
| 247 | # that they are actual ELF files |
Brad Bishop | 977dc1a | 2019-02-06 16:01:43 -0500 | [diff] [blame] | 248 | lib_re = re.compile(r"^/lib.+\.so(\..+)?$") |
| 249 | exec_re = re.compile(r"^%s.*/lib.+\.so(\..+)?$" % exec_prefix) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 250 | |
| 251 | for root, dirs, files in os.walk(pkgdest): |
| 252 | if root == pkgdest: |
| 253 | # Skip subdirectories for any packages with libdir in INSANE_SKIP |
| 254 | skippackages = [] |
| 255 | for package in dirs: |
Patrick Williams | 213cb26 | 2021-08-07 19:21:33 -0500 | [diff] [blame] | 256 | if 'libdir' in (d.getVar('INSANE_SKIP:' + package) or "").split(): |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 257 | bb.note("Package %s skipping libdir QA test" % (package)) |
| 258 | skippackages.append(package) |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 259 | elif d.getVar('PACKAGE_DEBUG_SPLIT_STYLE') == 'debug-file-directory' and package.endswith("-dbg"): |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 260 | bb.note("Package %s skipping libdir QA test for PACKAGE_DEBUG_SPLIT_STYLE equals debug-file-directory" % (package)) |
| 261 | skippackages.append(package) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 262 | for package in skippackages: |
| 263 | dirs.remove(package) |
| 264 | for file in files: |
| 265 | full_path = os.path.join(root, file) |
| 266 | rel_path = os.path.relpath(full_path, pkgdest) |
| 267 | if os.sep in rel_path: |
| 268 | package, rel_path = rel_path.split(os.sep, 1) |
| 269 | rel_path = os.sep + rel_path |
| 270 | if lib_re.match(rel_path): |
| 271 | if base_libdir not in rel_path: |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 272 | # make sure it's an actual ELF file |
| 273 | elf = oe.qa.ELFFile(full_path) |
| 274 | try: |
| 275 | elf.open() |
| 276 | messages.append("%s: found library in wrong location: %s" % (package, rel_path)) |
| 277 | except (oe.qa.NotELFFileError): |
| 278 | pass |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 279 | if exec_re.match(rel_path): |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 280 | if libdir not in rel_path and libexecdir not in rel_path: |
| 281 | # make sure it's an actual ELF file |
| 282 | elf = oe.qa.ELFFile(full_path) |
| 283 | try: |
| 284 | elf.open() |
| 285 | messages.append("%s: found library in wrong location: %s" % (package, rel_path)) |
| 286 | except (oe.qa.NotELFFileError): |
| 287 | pass |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 288 | |
| 289 | if messages: |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 290 | oe.qa.handle_error("libdir", "\n".join(messages), d) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 291 | |
| 292 | QAPATHTEST[debug-files] = "package_qa_check_dbg" |
| 293 | def package_qa_check_dbg(path, name, d, elf, messages): |
| 294 | """ |
| 295 | Check for ".debug" files or directories outside of the dbg package |
| 296 | """ |
| 297 | |
| 298 | if not "-dbg" in name and not "-ptest" in name: |
| 299 | if '.debug' in path.split(os.path.sep): |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 300 | oe.qa.add_message(messages, "debug-files", "non debug package contains .debug directory: %s path %s" % \ |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 301 | (name, package_qa_clean_path(path,d))) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 302 | |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 303 | QAPATHTEST[arch] = "package_qa_check_arch" |
| 304 | def package_qa_check_arch(path,name,d, elf, messages): |
| 305 | """ |
| 306 | Check if archs are compatible |
| 307 | """ |
Brad Bishop | 1a4b7ee | 2018-12-16 17:11:34 -0800 | [diff] [blame] | 308 | import re, oe.elf |
Patrick Williams | c0f7c04 | 2017-02-23 20:41:17 -0600 | [diff] [blame] | 309 | |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 310 | if not elf: |
| 311 | return |
| 312 | |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 313 | target_os = d.getVar('TARGET_OS') |
| 314 | target_arch = d.getVar('TARGET_ARCH') |
| 315 | provides = d.getVar('PROVIDES') |
| 316 | bpn = d.getVar('BPN') |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 317 | |
| 318 | if target_arch == "allarch": |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 319 | pn = d.getVar('PN') |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 320 | oe.qa.add_message(messages, "arch", pn + ": Recipe inherits the allarch class, but has packaged architecture-specific binaries") |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 321 | return |
| 322 | |
| 323 | # FIXME: Cross package confuse this check, so just skip them |
| 324 | for s in ['cross', 'nativesdk', 'cross-canadian']: |
| 325 | if bb.data.inherits_class(s, d): |
| 326 | return |
| 327 | |
| 328 | # avoid following links to /usr/bin (e.g. on udev builds) |
| 329 | # we will check the files pointed to anyway... |
| 330 | if os.path.islink(path): |
| 331 | return |
| 332 | |
| 333 | #if this will throw an exception, then fix the dict above |
| 334 | (machine, osabi, abiversion, littleendian, bits) \ |
Brad Bishop | 1a4b7ee | 2018-12-16 17:11:34 -0800 | [diff] [blame] | 335 | = oe.elf.machine_dict(d)[target_os][target_arch] |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 336 | |
| 337 | # Check the architecture and endiannes of the binary |
Patrick Williams | c0f7c04 | 2017-02-23 20:41:17 -0600 | [diff] [blame] | 338 | is_32 = (("virtual/kernel" in provides) or bb.data.inherits_class("module", d)) and \ |
Brad Bishop | 1a4b7ee | 2018-12-16 17:11:34 -0800 | [diff] [blame] | 339 | (target_os == "linux-gnux32" or target_os == "linux-muslx32" or \ |
Brad Bishop | 977dc1a | 2019-02-06 16:01:43 -0500 | [diff] [blame] | 340 | target_os == "linux-gnu_ilp32" or re.match(r'mips64.*32', d.getVar('DEFAULTTUNE'))) |
Brad Bishop | 1a4b7ee | 2018-12-16 17:11:34 -0800 | [diff] [blame] | 341 | is_bpf = (oe.qa.elf_machine_to_string(elf.machine()) == "BPF") |
| 342 | if not ((machine == elf.machine()) or is_32 or is_bpf): |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 343 | oe.qa.add_message(messages, "arch", "Architecture did not match (%s, expected %s) in %s" % \ |
Andrew Geissler | b7d2861 | 2020-07-24 16:15:54 -0500 | [diff] [blame] | 344 | (oe.qa.elf_machine_to_string(elf.machine()), oe.qa.elf_machine_to_string(machine), package_qa_clean_path(path, d, name))) |
Brad Bishop | 1932369 | 2019-04-05 15:28:33 -0400 | [diff] [blame] | 345 | elif not ((bits == elf.abiSize()) or is_32 or is_bpf): |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 346 | oe.qa.add_message(messages, "arch", "Bit size did not match (%d, expected %d) in %s" % \ |
Andrew Geissler | b7d2861 | 2020-07-24 16:15:54 -0500 | [diff] [blame] | 347 | (elf.abiSize(), bits, package_qa_clean_path(path, d, name))) |
Brad Bishop | 1932369 | 2019-04-05 15:28:33 -0400 | [diff] [blame] | 348 | elif not ((littleendian == elf.isLittleEndian()) or is_bpf): |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 349 | oe.qa.add_message(messages, "arch", "Endiannes did not match (%d, expected %d) in %s" % \ |
Andrew Geissler | b7d2861 | 2020-07-24 16:15:54 -0500 | [diff] [blame] | 350 | (elf.isLittleEndian(), littleendian, package_qa_clean_path(path,d, name))) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 351 | |
| 352 | QAPATHTEST[desktop] = "package_qa_check_desktop" |
| 353 | def package_qa_check_desktop(path, name, d, elf, messages): |
| 354 | """ |
| 355 | Run all desktop files through desktop-file-validate. |
| 356 | """ |
| 357 | if path.endswith(".desktop"): |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 358 | desktop_file_validate = os.path.join(d.getVar('STAGING_BINDIR_NATIVE'),'desktop-file-validate') |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 359 | output = os.popen("%s %s" % (desktop_file_validate, path)) |
| 360 | # This only produces output on errors |
| 361 | for l in output: |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 362 | oe.qa.add_message(messages, "desktop", "Desktop file issue: " + l.strip()) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 363 | |
| 364 | QAPATHTEST[textrel] = "package_qa_textrel" |
| 365 | def package_qa_textrel(path, name, d, elf, messages): |
| 366 | """ |
| 367 | Check if the binary contains relocations in .text |
| 368 | """ |
| 369 | |
| 370 | if not elf: |
| 371 | return |
| 372 | |
| 373 | if os.path.islink(path): |
| 374 | return |
| 375 | |
| 376 | phdrs = elf.run_objdump("-p", d) |
| 377 | sane = True |
| 378 | |
| 379 | import re |
Brad Bishop | 977dc1a | 2019-02-06 16:01:43 -0500 | [diff] [blame] | 380 | textrel_re = re.compile(r"\s+TEXTREL\s+") |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 381 | for line in phdrs.split("\n"): |
| 382 | if textrel_re.match(line): |
| 383 | sane = False |
Brad Bishop | 1d80a2e | 2019-11-15 16:35:03 -0500 | [diff] [blame] | 384 | break |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 385 | |
| 386 | if not sane: |
Brad Bishop | 1d80a2e | 2019-11-15 16:35:03 -0500 | [diff] [blame] | 387 | path = package_qa_clean_path(path, d, name) |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 388 | oe.qa.add_message(messages, "textrel", "%s: ELF binary %s has relocations in .text" % (name, path)) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 389 | |
| 390 | QAPATHTEST[ldflags] = "package_qa_hash_style" |
| 391 | def package_qa_hash_style(path, name, d, elf, messages): |
| 392 | """ |
| 393 | Check if the binary has the right hash style... |
| 394 | """ |
| 395 | |
| 396 | if not elf: |
| 397 | return |
| 398 | |
| 399 | if os.path.islink(path): |
| 400 | return |
| 401 | |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 402 | gnu_hash = "--hash-style=gnu" in d.getVar('LDFLAGS') |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 403 | if not gnu_hash: |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 404 | gnu_hash = "--hash-style=both" in d.getVar('LDFLAGS') |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 405 | if not gnu_hash: |
| 406 | return |
| 407 | |
| 408 | sane = False |
| 409 | has_syms = False |
| 410 | |
| 411 | phdrs = elf.run_objdump("-p", d) |
| 412 | |
| 413 | # If this binary has symbols, we expect it to have GNU_HASH too. |
| 414 | for line in phdrs.split("\n"): |
| 415 | if "SYMTAB" in line: |
| 416 | has_syms = True |
Andrew Geissler | c9f7865 | 2020-09-18 14:11:35 -0500 | [diff] [blame] | 417 | if "GNU_HASH" in line or "DT_MIPS_XHASH" in line: |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 418 | sane = True |
Andrew Geissler | 82c905d | 2020-04-13 13:39:40 -0500 | [diff] [blame] | 419 | if ("[mips32]" in line or "[mips64]" in line) and d.getVar('TCLIBC') == "musl": |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 420 | sane = True |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 421 | if has_syms and not sane: |
Andrew Geissler | c9f7865 | 2020-09-18 14:11:35 -0500 | [diff] [blame] | 422 | path = package_qa_clean_path(path, d, name) |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 423 | oe.qa.add_message(messages, "ldflags", "File %s in package %s doesn't have GNU_HASH (didn't pass LDFLAGS?)" % (path, name)) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 424 | |
| 425 | |
| 426 | QAPATHTEST[buildpaths] = "package_qa_check_buildpaths" |
| 427 | def package_qa_check_buildpaths(path, name, d, elf, messages): |
| 428 | """ |
| 429 | Check for build paths inside target files and error if not found in the whitelist |
| 430 | """ |
| 431 | # Ignore .debug files, not interesting |
| 432 | if path.find(".debug") != -1: |
| 433 | return |
| 434 | |
| 435 | # Ignore symlinks |
| 436 | if os.path.islink(path): |
| 437 | return |
| 438 | |
Brad Bishop | d5ae7d9 | 2018-06-14 09:52:03 -0700 | [diff] [blame] | 439 | tmpdir = bytes(d.getVar('TMPDIR'), encoding="utf-8") |
Brad Bishop | 37a0e4d | 2017-12-04 01:01:44 -0500 | [diff] [blame] | 440 | with open(path, 'rb') as f: |
Brad Bishop | d5ae7d9 | 2018-06-14 09:52:03 -0700 | [diff] [blame] | 441 | file_content = f.read() |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 442 | if tmpdir in file_content: |
Brad Bishop | f3fd288 | 2019-06-21 08:06:37 -0400 | [diff] [blame] | 443 | trimmed = path.replace(os.path.join (d.getVar("PKGDEST"), name), "") |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 444 | oe.qa.add_message(messages, "buildpaths", "File %s in package %s contains reference to TMPDIR" % (trimmed, name)) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 445 | |
| 446 | |
| 447 | QAPATHTEST[xorg-driver-abi] = "package_qa_check_xorg_driver_abi" |
| 448 | def package_qa_check_xorg_driver_abi(path, name, d, elf, messages): |
| 449 | """ |
| 450 | Check that all packages containing Xorg drivers have ABI dependencies |
| 451 | """ |
| 452 | |
| 453 | # Skip dev, dbg or nativesdk packages |
| 454 | if name.endswith("-dev") or name.endswith("-dbg") or name.startswith("nativesdk-"): |
| 455 | return |
| 456 | |
| 457 | driverdir = d.expand("${libdir}/xorg/modules/drivers/") |
| 458 | if driverdir in path and path.endswith(".so"): |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 459 | mlprefix = d.getVar('MLPREFIX') or '' |
Patrick Williams | 213cb26 | 2021-08-07 19:21:33 -0500 | [diff] [blame] | 460 | for rdep in bb.utils.explode_deps(d.getVar('RDEPENDS:' + name) or ""): |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 461 | if rdep.startswith("%sxorg-abi-" % mlprefix): |
| 462 | return |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 463 | oe.qa.add_message(messages, "xorg-driver-abi", "Package %s contains Xorg driver (%s) but no xorg-abi- dependencies" % (name, os.path.basename(path))) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 464 | |
| 465 | QAPATHTEST[infodir] = "package_qa_check_infodir" |
| 466 | def package_qa_check_infodir(path, name, d, elf, messages): |
| 467 | """ |
| 468 | Check that /usr/share/info/dir isn't shipped in a particular package |
| 469 | """ |
| 470 | infodir = d.expand("${infodir}/dir") |
| 471 | |
| 472 | if infodir in path: |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 473 | oe.qa.add_message(messages, "infodir", "The /usr/share/info/dir file is not meant to be shipped in a particular package.") |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 474 | |
| 475 | QAPATHTEST[symlink-to-sysroot] = "package_qa_check_symlink_to_sysroot" |
| 476 | def package_qa_check_symlink_to_sysroot(path, name, d, elf, messages): |
| 477 | """ |
| 478 | Check that the package doesn't contain any absolute symlinks to the sysroot. |
| 479 | """ |
| 480 | if os.path.islink(path): |
| 481 | target = os.readlink(path) |
| 482 | if os.path.isabs(target): |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 483 | tmpdir = d.getVar('TMPDIR') |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 484 | if target.startswith(tmpdir): |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 485 | trimmed = path.replace(os.path.join (d.getVar("PKGDEST"), name), "") |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 486 | oe.qa.add_message(messages, "symlink-to-sysroot", "Symlink %s in %s points to TMPDIR" % (trimmed, name)) |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 487 | |
Patrick Williams | c0f7c04 | 2017-02-23 20:41:17 -0600 | [diff] [blame] | 488 | # Check license variables |
| 489 | do_populate_lic[postfuncs] += "populate_lic_qa_checksum" |
| 490 | python populate_lic_qa_checksum() { |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 491 | """ |
Patrick Williams | c0f7c04 | 2017-02-23 20:41:17 -0600 | [diff] [blame] | 492 | Check for changes in the license files. |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 493 | """ |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 494 | |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 495 | lic_files = d.getVar('LIC_FILES_CHKSUM') or '' |
| 496 | lic = d.getVar('LICENSE') |
| 497 | pn = d.getVar('PN') |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 498 | |
| 499 | if lic == "CLOSED": |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 500 | return |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 501 | |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 502 | if not lic_files and d.getVar('SRC_URI'): |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 503 | oe.qa.handle_error("license-checksum", pn + ": Recipe file fetches files and does not have license file information (LIC_FILES_CHKSUM)", d) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 504 | |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 505 | srcdir = d.getVar('S') |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 506 | corebase_licensefile = d.getVar('COREBASE') + "/LICENSE" |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 507 | for url in lic_files.split(): |
| 508 | try: |
| 509 | (type, host, path, user, pswd, parm) = bb.fetch.decodeurl(url) |
| 510 | except bb.fetch.MalformedUrl: |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 511 | oe.qa.handle_error("license-checksum", pn + ": LIC_FILES_CHKSUM contains an invalid URL: " + url, d) |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 512 | continue |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 513 | srclicfile = os.path.join(srcdir, path) |
| 514 | if not os.path.isfile(srclicfile): |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 515 | oe.qa.handle_error("license-checksum", pn + ": LIC_FILES_CHKSUM points to an invalid file: " + srclicfile, d) |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 516 | continue |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 517 | |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 518 | if (srclicfile == corebase_licensefile): |
| 519 | bb.warn("${COREBASE}/LICENSE is not a valid license file, please use '${COMMON_LICENSE_DIR}/MIT' for a MIT License file in LIC_FILES_CHKSUM. This will become an error in the future") |
| 520 | |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 521 | recipemd5 = parm.get('md5', '') |
| 522 | beginline, endline = 0, 0 |
| 523 | if 'beginline' in parm: |
| 524 | beginline = int(parm['beginline']) |
| 525 | if 'endline' in parm: |
| 526 | endline = int(parm['endline']) |
| 527 | |
| 528 | if (not beginline) and (not endline): |
| 529 | md5chksum = bb.utils.md5_file(srclicfile) |
Brad Bishop | 1932369 | 2019-04-05 15:28:33 -0400 | [diff] [blame] | 530 | with open(srclicfile, 'r', errors='replace') as f: |
| 531 | license = f.read().splitlines() |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 532 | else: |
Brad Bishop | 1932369 | 2019-04-05 15:28:33 -0400 | [diff] [blame] | 533 | with open(srclicfile, 'rb') as f: |
| 534 | import hashlib |
| 535 | lineno = 0 |
| 536 | license = [] |
| 537 | m = hashlib.md5() |
| 538 | for line in f: |
| 539 | lineno += 1 |
| 540 | if (lineno >= beginline): |
| 541 | if ((lineno <= endline) or not endline): |
| 542 | m.update(line) |
| 543 | license.append(line.decode('utf-8', errors='replace').rstrip()) |
| 544 | else: |
| 545 | break |
| 546 | md5chksum = m.hexdigest() |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 547 | if recipemd5 == md5chksum: |
| 548 | bb.note (pn + ": md5 checksum matched for ", url) |
| 549 | else: |
| 550 | if recipemd5: |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 551 | msg = pn + ": The LIC_FILES_CHKSUM does not match for " + url |
| 552 | msg = msg + "\n" + pn + ": The new md5 checksum is " + md5chksum |
Brad Bishop | 1932369 | 2019-04-05 15:28:33 -0400 | [diff] [blame] | 553 | max_lines = int(d.getVar('QA_MAX_LICENSE_LINES') or 20) |
| 554 | if not license or license[-1] != '': |
| 555 | # Ensure that our license text ends with a line break |
| 556 | # (will be added with join() below). |
| 557 | license.append('') |
| 558 | remove = len(license) - max_lines |
| 559 | if remove > 0: |
| 560 | start = max_lines // 2 |
| 561 | end = start + remove - 1 |
| 562 | del license[start:end] |
| 563 | license.insert(start, '...') |
| 564 | msg = msg + "\n" + pn + ": Here is the selected license text:" + \ |
| 565 | "\n" + \ |
| 566 | "{:v^70}".format(" beginline=%d " % beginline if beginline else "") + \ |
| 567 | "\n" + "\n".join(license) + \ |
| 568 | "{:^^70}".format(" endline=%d " % endline if endline else "") |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 569 | if beginline: |
| 570 | if endline: |
| 571 | srcfiledesc = "%s (lines %d through to %d)" % (srclicfile, beginline, endline) |
| 572 | else: |
| 573 | srcfiledesc = "%s (beginning on line %d)" % (srclicfile, beginline) |
| 574 | elif endline: |
| 575 | srcfiledesc = "%s (ending on line %d)" % (srclicfile, endline) |
| 576 | else: |
| 577 | srcfiledesc = srclicfile |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 578 | msg = msg + "\n" + pn + ": Check if the license information has changed in %s to verify that the LICENSE value \"%s\" remains valid" % (srcfiledesc, lic) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 579 | |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 580 | else: |
| 581 | msg = pn + ": LIC_FILES_CHKSUM is not specified for " + url |
| 582 | msg = msg + "\n" + pn + ": The md5 checksum is " + md5chksum |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 583 | oe.qa.handle_error("license-checksum", msg, d) |
Patrick Williams | c0f7c04 | 2017-02-23 20:41:17 -0600 | [diff] [blame] | 584 | |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 585 | oe.qa.exit_if_errors(d) |
Patrick Williams | c0f7c04 | 2017-02-23 20:41:17 -0600 | [diff] [blame] | 586 | } |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 587 | |
Brad Bishop | 1932369 | 2019-04-05 15:28:33 -0400 | [diff] [blame] | 588 | def qa_check_staged(path,d): |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 589 | """ |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 590 | Check staged la and pc files for common problems like references to the work |
| 591 | directory. |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 592 | |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 593 | As this is run after every stage we should be able to find the one |
| 594 | responsible for the errors easily even if we look at every .pc and .la file. |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 595 | """ |
| 596 | |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 597 | tmpdir = d.getVar('TMPDIR') |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 598 | workdir = os.path.join(tmpdir, "work") |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 599 | recipesysroot = d.getVar("RECIPE_SYSROOT") |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 600 | |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 601 | if bb.data.inherits_class("native", d) or bb.data.inherits_class("cross", d): |
| 602 | pkgconfigcheck = workdir |
| 603 | else: |
| 604 | pkgconfigcheck = tmpdir |
| 605 | |
Brad Bishop | 1932369 | 2019-04-05 15:28:33 -0400 | [diff] [blame] | 606 | skip = (d.getVar('INSANE_SKIP') or "").split() |
| 607 | skip_la = False |
| 608 | if 'la' in skip: |
| 609 | bb.note("Recipe %s skipping qa checking: la" % d.getVar('PN')) |
| 610 | skip_la = True |
| 611 | |
| 612 | skip_pkgconfig = False |
| 613 | if 'pkgconfig' in skip: |
| 614 | bb.note("Recipe %s skipping qa checking: pkgconfig" % d.getVar('PN')) |
| 615 | skip_pkgconfig = True |
| 616 | |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 617 | # find all .la and .pc files |
| 618 | # read the content |
| 619 | # and check for stuff that looks wrong |
| 620 | for root, dirs, files in os.walk(path): |
| 621 | for file in files: |
| 622 | path = os.path.join(root,file) |
Brad Bishop | 1932369 | 2019-04-05 15:28:33 -0400 | [diff] [blame] | 623 | if file.endswith(".la") and not skip_la: |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 624 | with open(path) as f: |
| 625 | file_content = f.read() |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 626 | file_content = file_content.replace(recipesysroot, "") |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 627 | if workdir in file_content: |
| 628 | error_msg = "%s failed sanity test (workdir) in path %s" % (file,root) |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 629 | oe.qa.handle_error("la", error_msg, d) |
Brad Bishop | 1932369 | 2019-04-05 15:28:33 -0400 | [diff] [blame] | 630 | elif file.endswith(".pc") and not skip_pkgconfig: |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 631 | with open(path) as f: |
| 632 | file_content = f.read() |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 633 | file_content = file_content.replace(recipesysroot, "") |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 634 | if pkgconfigcheck in file_content: |
| 635 | error_msg = "%s failed sanity test (tmpdir) in path %s" % (file,root) |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 636 | oe.qa.handle_error("pkgconfig", error_msg, d) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 637 | |
Brad Bishop | 37a0e4d | 2017-12-04 01:01:44 -0500 | [diff] [blame] | 638 | # Run all package-wide warnfuncs and errorfuncs |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 639 | def package_qa_package(warnfuncs, errorfuncs, package, d): |
Brad Bishop | 37a0e4d | 2017-12-04 01:01:44 -0500 | [diff] [blame] | 640 | warnings = {} |
| 641 | errors = {} |
| 642 | |
| 643 | for func in warnfuncs: |
| 644 | func(package, d, warnings) |
| 645 | for func in errorfuncs: |
| 646 | func(package, d, errors) |
| 647 | |
| 648 | for w in warnings: |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 649 | oe.qa.handle_error(w, warnings[w], d) |
Brad Bishop | 37a0e4d | 2017-12-04 01:01:44 -0500 | [diff] [blame] | 650 | for e in errors: |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 651 | oe.qa.handle_error(e, errors[e], d) |
Brad Bishop | 37a0e4d | 2017-12-04 01:01:44 -0500 | [diff] [blame] | 652 | |
| 653 | return len(errors) == 0 |
| 654 | |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 655 | # Run all recipe-wide warnfuncs and errorfuncs |
| 656 | def package_qa_recipe(warnfuncs, errorfuncs, pn, d): |
| 657 | warnings = {} |
| 658 | errors = {} |
| 659 | |
| 660 | for func in warnfuncs: |
| 661 | func(pn, d, warnings) |
| 662 | for func in errorfuncs: |
| 663 | func(pn, d, errors) |
| 664 | |
| 665 | for w in warnings: |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 666 | oe.qa.handle_error(w, warnings[w], d) |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 667 | for e in errors: |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 668 | oe.qa.handle_error(e, errors[e], d) |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 669 | |
| 670 | return len(errors) == 0 |
| 671 | |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 672 | # Walk over all files in a directory and call func |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 673 | def package_qa_walk(warnfuncs, errorfuncs, package, d): |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 674 | #if this will throw an exception, then fix the dict above |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 675 | target_os = d.getVar('TARGET_OS') |
| 676 | target_arch = d.getVar('TARGET_ARCH') |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 677 | |
| 678 | warnings = {} |
| 679 | errors = {} |
| 680 | for path in pkgfiles[package]: |
Andrew Geissler | c9f7865 | 2020-09-18 14:11:35 -0500 | [diff] [blame] | 681 | elf = None |
| 682 | if os.path.isfile(path): |
| 683 | elf = oe.qa.ELFFile(path) |
| 684 | try: |
| 685 | elf.open() |
| 686 | except oe.qa.NotELFFileError: |
| 687 | elf = None |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 688 | for func in warnfuncs: |
| 689 | func(path, package, d, elf, warnings) |
| 690 | for func in errorfuncs: |
| 691 | func(path, package, d, elf, errors) |
| 692 | |
| 693 | for w in warnings: |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 694 | oe.qa.handle_error(w, warnings[w], d) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 695 | for e in errors: |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 696 | oe.qa.handle_error(e, errors[e], d) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 697 | |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 698 | def package_qa_check_rdepends(pkg, pkgdest, skip, taskdeps, packages, d): |
| 699 | # Don't do this check for kernel/module recipes, there aren't too many debug/development |
| 700 | # packages and you can get false positives e.g. on kernel-module-lirc-dev |
| 701 | if bb.data.inherits_class("kernel", d) or bb.data.inherits_class("module-base", d): |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 702 | return |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 703 | |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 704 | if not "-dbg" in pkg and not "packagegroup-" in pkg and not "-image" in pkg: |
| 705 | localdata = bb.data.createCopy(d) |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 706 | localdata.setVar('OVERRIDES', localdata.getVar('OVERRIDES') + ':' + pkg) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 707 | |
| 708 | # Now check the RDEPENDS |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 709 | rdepends = bb.utils.explode_deps(localdata.getVar('RDEPENDS') or "") |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 710 | |
| 711 | # Now do the sanity check!!! |
| 712 | if "build-deps" not in skip: |
| 713 | for rdepend in rdepends: |
| 714 | if "-dbg" in rdepend and "debug-deps" not in skip: |
| 715 | error_msg = "%s rdepends on %s" % (pkg,rdepend) |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 716 | oe.qa.handle_error("debug-deps", error_msg, d) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 717 | if (not "-dev" in pkg and not "-staticdev" in pkg) and rdepend.endswith("-dev") and "dev-deps" not in skip: |
| 718 | error_msg = "%s rdepends on %s" % (pkg, rdepend) |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 719 | oe.qa.handle_error("dev-deps", error_msg, d) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 720 | if rdepend not in packages: |
| 721 | rdep_data = oe.packagedata.read_subpkgdata(rdepend, d) |
| 722 | if rdep_data and 'PN' in rdep_data and rdep_data['PN'] in taskdeps: |
| 723 | continue |
| 724 | if not rdep_data or not 'PN' in rdep_data: |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 725 | pkgdata_dir = d.getVar("PKGDATA_DIR") |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 726 | try: |
| 727 | possibles = os.listdir("%s/runtime-rprovides/%s/" % (pkgdata_dir, rdepend)) |
| 728 | except OSError: |
| 729 | possibles = [] |
| 730 | for p in possibles: |
| 731 | rdep_data = oe.packagedata.read_subpkgdata(p, d) |
| 732 | if rdep_data and 'PN' in rdep_data and rdep_data['PN'] in taskdeps: |
| 733 | break |
| 734 | if rdep_data and 'PN' in rdep_data and rdep_data['PN'] in taskdeps: |
| 735 | continue |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 736 | if rdep_data and 'PN' in rdep_data: |
| 737 | error_msg = "%s rdepends on %s, but it isn't a build dependency, missing %s in DEPENDS or PACKAGECONFIG?" % (pkg, rdepend, rdep_data['PN']) |
| 738 | else: |
| 739 | error_msg = "%s rdepends on %s, but it isn't a build dependency?" % (pkg, rdepend) |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 740 | oe.qa.handle_error("build-deps", error_msg, d) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 741 | |
| 742 | if "file-rdeps" not in skip: |
| 743 | ignored_file_rdeps = set(['/bin/sh', '/usr/bin/env', 'rtld(GNU_HASH)']) |
| 744 | if bb.data.inherits_class('nativesdk', d): |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 745 | ignored_file_rdeps |= set(['/bin/bash', '/usr/bin/perl', 'perl']) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 746 | # For Saving the FILERDEPENDS |
| 747 | filerdepends = {} |
| 748 | rdep_data = oe.packagedata.read_subpkgdata(pkg, d) |
| 749 | for key in rdep_data: |
Andrew Geissler | 5199d83 | 2021-09-24 16:47:35 -0500 | [diff] [blame] | 750 | if key.startswith("FILERDEPENDS:"): |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 751 | for subkey in bb.utils.explode_deps(rdep_data[key]): |
| 752 | if subkey not in ignored_file_rdeps and \ |
| 753 | not subkey.startswith('perl('): |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 754 | # We already know it starts with FILERDEPENDS_ |
| 755 | filerdepends[subkey] = key[13:] |
| 756 | |
| 757 | if filerdepends: |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 758 | done = rdepends[:] |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 759 | # Add the rprovides of itself |
| 760 | if pkg not in done: |
| 761 | done.insert(0, pkg) |
| 762 | |
| 763 | # The python is not a package, but python-core provides it, so |
| 764 | # skip checking /usr/bin/python if python is in the rdeps, in |
Patrick Williams | 213cb26 | 2021-08-07 19:21:33 -0500 | [diff] [blame] | 765 | # case there is a RDEPENDS:pkg = "python" in the recipe. |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 766 | for py in [ d.getVar('MLPREFIX') + "python", "python" ]: |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 767 | if py in done: |
| 768 | filerdepends.pop("/usr/bin/python",None) |
| 769 | done.remove(py) |
| 770 | for rdep in done: |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 771 | # The file dependencies may contain package names, e.g., |
| 772 | # perl |
| 773 | filerdepends.pop(rdep,None) |
| 774 | |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 775 | # For Saving the FILERPROVIDES, RPROVIDES and FILES_INFO |
| 776 | rdep_data = oe.packagedata.read_subpkgdata(rdep, d) |
| 777 | for key in rdep_data: |
Andrew Geissler | d159c7f | 2021-09-02 21:05:58 -0500 | [diff] [blame] | 778 | if key.startswith("FILERPROVIDES:") or key.startswith("RPROVIDES:"): |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 779 | for subkey in bb.utils.explode_deps(rdep_data[key]): |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 780 | filerdepends.pop(subkey,None) |
| 781 | # Add the files list to the rprovides |
Andrew Geissler | d159c7f | 2021-09-02 21:05:58 -0500 | [diff] [blame] | 782 | if key.startswith("FILES_INFO:"): |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 783 | # Use eval() to make it as a dict |
| 784 | for subkey in eval(rdep_data[key]): |
| 785 | filerdepends.pop(subkey,None) |
| 786 | if not filerdepends: |
| 787 | # Break if all the file rdepends are met |
| 788 | break |
| 789 | if filerdepends: |
| 790 | for key in filerdepends: |
Patrick Williams | 213cb26 | 2021-08-07 19:21:33 -0500 | [diff] [blame] | 791 | error_msg = "%s contained in package %s requires %s, but no providers found in RDEPENDS:%s?" % \ |
| 792 | (filerdepends[key].replace(":%s" % pkg, "").replace("@underscore@", "_"), pkg, key, pkg) |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 793 | oe.qa.handle_error("file-rdeps", error_msg, d) |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 794 | package_qa_check_rdepends[vardepsexclude] = "OVERRIDES" |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 795 | |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 796 | def package_qa_check_deps(pkg, pkgdest, d): |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 797 | |
| 798 | localdata = bb.data.createCopy(d) |
| 799 | localdata.setVar('OVERRIDES', pkg) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 800 | |
| 801 | def check_valid_deps(var): |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 802 | try: |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 803 | rvar = bb.utils.explode_dep_versions2(localdata.getVar(var) or "") |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 804 | except ValueError as e: |
Patrick Williams | 0ca19cc | 2021-08-16 14:03:13 -0500 | [diff] [blame] | 805 | bb.fatal("%s:%s: %s" % (var, pkg, e)) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 806 | for dep in rvar: |
| 807 | for v in rvar[dep]: |
| 808 | if v and not v.startswith(('< ', '= ', '> ', '<= ', '>=')): |
Patrick Williams | 0ca19cc | 2021-08-16 14:03:13 -0500 | [diff] [blame] | 809 | error_msg = "%s:%s is invalid: %s (%s) only comparisons <, =, >, <=, and >= are allowed" % (var, pkg, dep, v) |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 810 | oe.qa.handle_error("dep-cmp", error_msg, d) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 811 | |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 812 | check_valid_deps('RDEPENDS') |
| 813 | check_valid_deps('RRECOMMENDS') |
| 814 | check_valid_deps('RSUGGESTS') |
| 815 | check_valid_deps('RPROVIDES') |
| 816 | check_valid_deps('RREPLACES') |
| 817 | check_valid_deps('RCONFLICTS') |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 818 | |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 819 | QAPKGTEST[usrmerge] = "package_qa_check_usrmerge" |
| 820 | def package_qa_check_usrmerge(pkg, d, messages): |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 821 | |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 822 | pkgdest = d.getVar('PKGDEST') |
| 823 | pkg_dir = pkgdest + os.sep + pkg + os.sep |
| 824 | merged_dirs = ['bin', 'sbin', 'lib'] + d.getVar('MULTILIB_VARIANTS').split() |
| 825 | for f in merged_dirs: |
| 826 | if os.path.exists(pkg_dir + f) and not os.path.islink(pkg_dir + f): |
| 827 | msg = "%s package is not obeying usrmerge distro feature. /%s should be relocated to /usr." % (pkg, f) |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 828 | oe.qa.add_message(messages, "usrmerge", msg) |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 829 | return False |
| 830 | return True |
| 831 | |
Brad Bishop | f3f93bb | 2019-10-16 14:33:32 -0400 | [diff] [blame] | 832 | QAPKGTEST[perllocalpod] = "package_qa_check_perllocalpod" |
| 833 | def package_qa_check_perllocalpod(pkg, d, messages): |
| 834 | """ |
| 835 | Check that the recipe didn't ship a perlocal.pod file, which shouldn't be |
| 836 | installed in a distribution package. cpan.bbclass sets NO_PERLLOCAL=1 to |
| 837 | handle this for most recipes. |
| 838 | """ |
| 839 | import glob |
| 840 | pkgd = oe.path.join(d.getVar('PKGDEST'), pkg) |
| 841 | podpath = oe.path.join(pkgd, d.getVar("libdir"), "perl*", "*", "*", "perllocal.pod") |
| 842 | |
| 843 | matches = glob.glob(podpath) |
| 844 | if matches: |
| 845 | matches = [package_qa_clean_path(path, d, pkg) for path in matches] |
| 846 | msg = "%s contains perllocal.pod (%s), should not be installed" % (pkg, " ".join(matches)) |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 847 | oe.qa.add_message(messages, "perllocalpod", msg) |
Brad Bishop | f3f93bb | 2019-10-16 14:33:32 -0400 | [diff] [blame] | 848 | |
Brad Bishop | 37a0e4d | 2017-12-04 01:01:44 -0500 | [diff] [blame] | 849 | QAPKGTEST[expanded-d] = "package_qa_check_expanded_d" |
| 850 | def package_qa_check_expanded_d(package, d, messages): |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 851 | """ |
| 852 | Check for the expanded D (${D}) value in pkg_* and FILES |
| 853 | variables, warn the user to use it correctly. |
| 854 | """ |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 855 | sane = True |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 856 | expanded_d = d.getVar('D') |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 857 | |
Brad Bishop | 37a0e4d | 2017-12-04 01:01:44 -0500 | [diff] [blame] | 858 | for var in 'FILES','pkg_preinst', 'pkg_postinst', 'pkg_prerm', 'pkg_postrm': |
Patrick Williams | 0ca19cc | 2021-08-16 14:03:13 -0500 | [diff] [blame] | 859 | bbvar = d.getVar(var + ":" + package) or "" |
Brad Bishop | 37a0e4d | 2017-12-04 01:01:44 -0500 | [diff] [blame] | 860 | if expanded_d in bbvar: |
| 861 | if var == 'FILES': |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 862 | oe.qa.add_message(messages, "expanded-d", "FILES in %s recipe should not contain the ${D} variable as it references the local build directory not the target filesystem, best solution is to remove the ${D} reference" % package) |
Brad Bishop | 37a0e4d | 2017-12-04 01:01:44 -0500 | [diff] [blame] | 863 | sane = False |
| 864 | else: |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 865 | oe.qa.add_message(messages, "expanded-d", "%s in %s recipe contains ${D}, it should be replaced by $D instead" % (var, package)) |
Brad Bishop | 37a0e4d | 2017-12-04 01:01:44 -0500 | [diff] [blame] | 866 | sane = False |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 867 | return sane |
| 868 | |
Andrew Geissler | 1e34c2d | 2020-05-29 16:02:59 -0500 | [diff] [blame] | 869 | QAPKGTEST[unlisted-pkg-lics] = "package_qa_check_unlisted_pkg_lics" |
| 870 | def package_qa_check_unlisted_pkg_lics(package, d, messages): |
| 871 | """ |
| 872 | Check that all licenses for a package are among the licenses for the recipe. |
| 873 | """ |
Patrick Williams | 213cb26 | 2021-08-07 19:21:33 -0500 | [diff] [blame] | 874 | pkg_lics = d.getVar('LICENSE:' + package) |
Andrew Geissler | 1e34c2d | 2020-05-29 16:02:59 -0500 | [diff] [blame] | 875 | if not pkg_lics: |
| 876 | return True |
| 877 | |
| 878 | recipe_lics_set = oe.license.list_licenses(d.getVar('LICENSE')) |
| 879 | unlisted = oe.license.list_licenses(pkg_lics) - recipe_lics_set |
| 880 | if not unlisted: |
| 881 | return True |
| 882 | |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 883 | oe.qa.add_message(messages, "unlisted-pkg-lics", |
Patrick Williams | 213cb26 | 2021-08-07 19:21:33 -0500 | [diff] [blame] | 884 | "LICENSE:%s includes licenses (%s) that are not " |
Andrew Geissler | 1e34c2d | 2020-05-29 16:02:59 -0500 | [diff] [blame] | 885 | "listed in LICENSE" % (package, ' '.join(unlisted))) |
| 886 | return False |
| 887 | |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 888 | def package_qa_check_encoding(keys, encode, d): |
Patrick Williams | c0f7c04 | 2017-02-23 20:41:17 -0600 | [diff] [blame] | 889 | def check_encoding(key, enc): |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 890 | sane = True |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 891 | value = d.getVar(key) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 892 | if value: |
| 893 | try: |
Patrick Williams | c0f7c04 | 2017-02-23 20:41:17 -0600 | [diff] [blame] | 894 | s = value.encode(enc) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 895 | except UnicodeDecodeError as e: |
| 896 | error_msg = "%s has non %s characters" % (key,enc) |
| 897 | sane = False |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 898 | oe.qa.handle_error("invalid-chars", error_msg, d) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 899 | return sane |
| 900 | |
| 901 | for key in keys: |
| 902 | sane = check_encoding(key, encode) |
| 903 | if not sane: |
| 904 | break |
| 905 | |
| 906 | HOST_USER_UID := "${@os.getuid()}" |
| 907 | HOST_USER_GID := "${@os.getgid()}" |
| 908 | |
| 909 | QAPATHTEST[host-user-contaminated] = "package_qa_check_host_user" |
| 910 | def package_qa_check_host_user(path, name, d, elf, messages): |
| 911 | """Check for paths outside of /home which are owned by the user running bitbake.""" |
| 912 | |
| 913 | if not os.path.lexists(path): |
| 914 | return |
| 915 | |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 916 | dest = d.getVar('PKGDEST') |
| 917 | pn = d.getVar('PN') |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 918 | home = os.path.join(dest, 'home') |
| 919 | if path == home or path.startswith(home + os.sep): |
| 920 | return |
| 921 | |
| 922 | try: |
| 923 | stat = os.lstat(path) |
| 924 | except OSError as exc: |
| 925 | import errno |
| 926 | if exc.errno != errno.ENOENT: |
| 927 | raise |
| 928 | else: |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 929 | check_uid = int(d.getVar('HOST_USER_UID')) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 930 | if stat.st_uid == check_uid: |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 931 | oe.qa.add_message(messages, "host-user-contaminated", "%s: %s is owned by uid %d, which is the same as the user running bitbake. This may be due to host contamination" % (pn, package_qa_clean_path(path, d, name), check_uid)) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 932 | return False |
| 933 | |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 934 | check_gid = int(d.getVar('HOST_USER_GID')) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 935 | if stat.st_gid == check_gid: |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 936 | oe.qa.add_message(messages, "host-user-contaminated", "%s: %s is owned by gid %d, which is the same as the user running bitbake. This may be due to host contamination" % (pn, package_qa_clean_path(path, d, name), check_gid)) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 937 | return False |
| 938 | return True |
| 939 | |
Brad Bishop | 15ae250 | 2019-06-18 21:44:24 -0400 | [diff] [blame] | 940 | QARECIPETEST[src-uri-bad] = "package_qa_check_src_uri" |
| 941 | def package_qa_check_src_uri(pn, d, messages): |
| 942 | import re |
| 943 | |
| 944 | if "${PN}" in d.getVar("SRC_URI", False): |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 945 | oe.qa.handle_error("src-uri-bad", "%s: SRC_URI uses PN not BPN" % pn, d) |
Brad Bishop | 15ae250 | 2019-06-18 21:44:24 -0400 | [diff] [blame] | 946 | |
Andrew Geissler | 82c905d | 2020-04-13 13:39:40 -0500 | [diff] [blame] | 947 | for url in d.getVar("SRC_URI").split(): |
Andrew Geissler | 6ce62a2 | 2020-11-30 19:58:47 -0600 | [diff] [blame] | 948 | if re.search(r"git(hu|la)b\.com/.+/.+/archive/.+", url): |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 949 | oe.qa.handle_error("src-uri-bad", "%s: SRC_URI uses unstable GitHub/GitLab archives, convert recipe to use git protocol" % pn, d) |
Brad Bishop | 15ae250 | 2019-06-18 21:44:24 -0400 | [diff] [blame] | 950 | |
Andrew Geissler | 5a43b43 | 2020-06-13 10:46:56 -0500 | [diff] [blame] | 951 | QARECIPETEST[unhandled-features-check] = "package_qa_check_unhandled_features_check" |
| 952 | def package_qa_check_unhandled_features_check(pn, d, messages): |
| 953 | if not bb.data.inherits_class('features_check', d): |
| 954 | var_set = False |
| 955 | for kind in ['DISTRO', 'MACHINE', 'COMBINED']: |
| 956 | for var in ['ANY_OF_' + kind + '_FEATURES', 'REQUIRED_' + kind + '_FEATURES', 'CONFLICT_' + kind + '_FEATURES']: |
| 957 | if d.getVar(var) is not None or d.overridedata.get(var) is not None: |
| 958 | var_set = True |
| 959 | if var_set: |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 960 | oe.qa.handle_error("unhandled-features-check", "%s: recipe doesn't inherit features_check" % pn, d) |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 961 | |
Andrew Geissler | c9f7865 | 2020-09-18 14:11:35 -0500 | [diff] [blame] | 962 | QARECIPETEST[missing-update-alternatives] = "package_qa_check_missing_update_alternatives" |
| 963 | def package_qa_check_missing_update_alternatives(pn, d, messages): |
| 964 | # Look at all packages and find out if any of those sets ALTERNATIVE variable |
| 965 | # without inheriting update-alternatives class |
| 966 | for pkg in (d.getVar('PACKAGES') or '').split(): |
Patrick Williams | 213cb26 | 2021-08-07 19:21:33 -0500 | [diff] [blame] | 967 | if d.getVar('ALTERNATIVE:%s' % pkg) and not bb.data.inherits_class('update-alternatives', d): |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 968 | oe.qa.handle_error("missing-update-alternatives", "%s: recipe defines ALTERNATIVE:%s but doesn't inherit update-alternatives. This might fail during do_rootfs later!" % (pn, pkg), d) |
Andrew Geissler | c9f7865 | 2020-09-18 14:11:35 -0500 | [diff] [blame] | 969 | |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 970 | # The PACKAGE FUNC to scan each package |
| 971 | python do_package_qa () { |
| 972 | import subprocess |
| 973 | import oe.packagedata |
| 974 | |
| 975 | bb.note("DO PACKAGE QA") |
| 976 | |
| 977 | bb.build.exec_func("read_subpackage_metadata", d) |
| 978 | |
| 979 | # Check non UTF-8 characters on recipe's metadata |
| 980 | package_qa_check_encoding(['DESCRIPTION', 'SUMMARY', 'LICENSE', 'SECTION'], 'utf-8', d) |
| 981 | |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 982 | logdir = d.getVar('T') |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 983 | pn = d.getVar('PN') |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 984 | |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 985 | # Scan the packages... |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 986 | pkgdest = d.getVar('PKGDEST') |
| 987 | packages = set((d.getVar('PACKAGES') or '').split()) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 988 | |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 989 | global pkgfiles |
| 990 | pkgfiles = {} |
| 991 | for pkg in packages: |
| 992 | pkgfiles[pkg] = [] |
Andrew Geissler | b7d2861 | 2020-07-24 16:15:54 -0500 | [diff] [blame] | 993 | pkgdir = os.path.join(pkgdest, pkg) |
| 994 | for walkroot, dirs, files in os.walk(pkgdir): |
| 995 | # Don't walk into top-level CONTROL or DEBIAN directories as these |
| 996 | # are temporary directories created by do_package. |
| 997 | if walkroot == pkgdir: |
| 998 | for control in ("CONTROL", "DEBIAN"): |
| 999 | if control in dirs: |
| 1000 | dirs.remove(control) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1001 | for file in files: |
Andrew Geissler | 82c905d | 2020-04-13 13:39:40 -0500 | [diff] [blame] | 1002 | pkgfiles[pkg].append(os.path.join(walkroot, file)) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1003 | |
| 1004 | # no packages should be scanned |
| 1005 | if not packages: |
| 1006 | return |
| 1007 | |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1008 | import re |
| 1009 | # The package name matches the [a-z0-9.+-]+ regular expression |
Brad Bishop | 977dc1a | 2019-02-06 16:01:43 -0500 | [diff] [blame] | 1010 | pkgname_pattern = re.compile(r"^[a-z0-9.+-]+$") |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1011 | |
| 1012 | taskdepdata = d.getVar("BB_TASKDEPDATA", False) |
| 1013 | taskdeps = set() |
| 1014 | for dep in taskdepdata: |
| 1015 | taskdeps.add(taskdepdata[dep][0]) |
| 1016 | |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 1017 | def parse_test_matrix(matrix_name): |
| 1018 | testmatrix = d.getVarFlags(matrix_name) or {} |
| 1019 | g = globals() |
| 1020 | warnchecks = [] |
| 1021 | for w in (d.getVar("WARN_QA") or "").split(): |
| 1022 | if w in skip: |
| 1023 | continue |
| 1024 | if w in testmatrix and testmatrix[w] in g: |
| 1025 | warnchecks.append(g[testmatrix[w]]) |
| 1026 | |
| 1027 | errorchecks = [] |
| 1028 | for e in (d.getVar("ERROR_QA") or "").split(): |
| 1029 | if e in skip: |
| 1030 | continue |
| 1031 | if e in testmatrix and testmatrix[e] in g: |
| 1032 | errorchecks.append(g[testmatrix[e]]) |
| 1033 | return warnchecks, errorchecks |
| 1034 | |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1035 | for package in packages: |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 1036 | skip = set((d.getVar('INSANE_SKIP') or "").split() + |
Patrick Williams | 213cb26 | 2021-08-07 19:21:33 -0500 | [diff] [blame] | 1037 | (d.getVar('INSANE_SKIP:' + package) or "").split()) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1038 | if skip: |
| 1039 | bb.note("Package %s skipping QA tests: %s" % (package, str(skip))) |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 1040 | |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1041 | bb.note("Checking Package: %s" % package) |
| 1042 | # Check package name |
| 1043 | if not pkgname_pattern.match(package): |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 1044 | oe.qa.handle_error("pkgname", |
Patrick Williams | f1e5d69 | 2016-03-30 15:21:19 -0500 | [diff] [blame] | 1045 | "%s doesn't match the [a-z0-9.+-]+ regex" % package, d) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1046 | |
Brad Bishop | 37a0e4d | 2017-12-04 01:01:44 -0500 | [diff] [blame] | 1047 | warn_checks, error_checks = parse_test_matrix("QAPATHTEST") |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 1048 | package_qa_walk(warn_checks, error_checks, package, d) |
Brad Bishop | 37a0e4d | 2017-12-04 01:01:44 -0500 | [diff] [blame] | 1049 | |
| 1050 | warn_checks, error_checks = parse_test_matrix("QAPKGTEST") |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 1051 | package_qa_package(warn_checks, error_checks, package, d) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1052 | |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 1053 | package_qa_check_rdepends(package, pkgdest, skip, taskdeps, packages, d) |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 1054 | package_qa_check_deps(package, pkgdest, d) |
| 1055 | |
| 1056 | warn_checks, error_checks = parse_test_matrix("QARECIPETEST") |
| 1057 | package_qa_recipe(warn_checks, error_checks, pn, d) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1058 | |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 1059 | if 'libdir' in d.getVar("ALL_QA").split(): |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1060 | package_qa_check_libdir(d) |
| 1061 | |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 1062 | oe.qa.exit_if_errors(d) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1063 | } |
| 1064 | |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 1065 | # binutils is used for most checks, so need to set as dependency |
| 1066 | # POPULATESYSROOTDEPS is defined in staging class. |
| 1067 | do_package_qa[depends] += "${POPULATESYSROOTDEPS}" |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 1068 | do_package_qa[vardepsexclude] = "BB_TASKDEPDATA" |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1069 | do_package_qa[rdeptask] = "do_packagedata" |
| 1070 | addtask do_package_qa after do_packagedata do_package before do_build |
| 1071 | |
Brad Bishop | 1932369 | 2019-04-05 15:28:33 -0400 | [diff] [blame] | 1072 | # Add the package specific INSANE_SKIPs to the sstate dependencies |
| 1073 | python() { |
| 1074 | pkgs = (d.getVar('PACKAGES') or '').split() |
| 1075 | for pkg in pkgs: |
Patrick Williams | 213cb26 | 2021-08-07 19:21:33 -0500 | [diff] [blame] | 1076 | d.appendVarFlag("do_package_qa", "vardeps", " INSANE_SKIP:{}".format(pkg)) |
Brad Bishop | 1932369 | 2019-04-05 15:28:33 -0400 | [diff] [blame] | 1077 | } |
| 1078 | |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1079 | SSTATETASKS += "do_package_qa" |
| 1080 | do_package_qa[sstate-inputdirs] = "" |
| 1081 | do_package_qa[sstate-outputdirs] = "" |
| 1082 | python do_package_qa_setscene () { |
| 1083 | sstate_setscene(d) |
| 1084 | } |
| 1085 | addtask do_package_qa_setscene |
| 1086 | |
| 1087 | python do_qa_staging() { |
| 1088 | bb.note("QA checking staging") |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 1089 | qa_check_staged(d.expand('${SYSROOT_DESTDIR}${libdir}'), d) |
| 1090 | oe.qa.exit_with_message_if_errors("QA staging was broken by the package built above", d) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1091 | } |
| 1092 | |
Brad Bishop | d89cb5f | 2019-04-10 09:02:41 -0400 | [diff] [blame] | 1093 | python do_qa_patch() { |
| 1094 | import subprocess |
| 1095 | |
| 1096 | ########################################################################### |
| 1097 | # Check patch.log for fuzz warnings |
| 1098 | # |
| 1099 | # Further information on why we check for patch fuzz warnings: |
| 1100 | # http://lists.openembedded.org/pipermail/openembedded-core/2018-March/148675.html |
| 1101 | # https://bugzilla.yoctoproject.org/show_bug.cgi?id=10450 |
| 1102 | ########################################################################### |
| 1103 | |
| 1104 | logdir = d.getVar('T') |
| 1105 | patchlog = os.path.join(logdir,"log.do_patch") |
| 1106 | |
| 1107 | if os.path.exists(patchlog): |
| 1108 | fuzzheader = '--- Patch fuzz start ---' |
| 1109 | fuzzfooter = '--- Patch fuzz end ---' |
| 1110 | statement = "grep -e '%s' %s > /dev/null" % (fuzzheader, patchlog) |
| 1111 | if subprocess.call(statement, shell=True) == 0: |
| 1112 | msg = "Fuzz detected:\n\n" |
| 1113 | fuzzmsg = "" |
| 1114 | inFuzzInfo = False |
| 1115 | f = open(patchlog, "r") |
| 1116 | for line in f: |
| 1117 | if fuzzheader in line: |
| 1118 | inFuzzInfo = True |
| 1119 | fuzzmsg = "" |
| 1120 | elif fuzzfooter in line: |
| 1121 | fuzzmsg = fuzzmsg.replace('\n\n', '\n') |
| 1122 | msg += fuzzmsg |
| 1123 | msg += "\n" |
| 1124 | inFuzzInfo = False |
| 1125 | elif inFuzzInfo and not 'Now at patch' in line: |
| 1126 | fuzzmsg += line |
| 1127 | f.close() |
| 1128 | msg += "The context lines in the patches can be updated with devtool:\n" |
| 1129 | msg += "\n" |
| 1130 | msg += " devtool modify %s\n" % d.getVar('PN') |
| 1131 | msg += " devtool finish --force-patch-refresh %s <layer_path>\n\n" % d.getVar('PN') |
| 1132 | msg += "Don't forget to review changes done by devtool!\n" |
| 1133 | if 'patch-fuzz' in d.getVar('ERROR_QA'): |
| 1134 | bb.error(msg) |
| 1135 | elif 'patch-fuzz' in d.getVar('WARN_QA'): |
| 1136 | bb.warn(msg) |
| 1137 | msg = "Patch log indicates that patches do not apply cleanly." |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 1138 | oe.qa.handle_error("patch-fuzz", msg, d) |
Brad Bishop | d89cb5f | 2019-04-10 09:02:41 -0400 | [diff] [blame] | 1139 | } |
| 1140 | |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1141 | python do_qa_configure() { |
| 1142 | import subprocess |
| 1143 | |
| 1144 | ########################################################################### |
| 1145 | # Check config.log for cross compile issues |
| 1146 | ########################################################################### |
| 1147 | |
| 1148 | configs = [] |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 1149 | workdir = d.getVar('WORKDIR') |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 1150 | |
Brad Bishop | 1932369 | 2019-04-05 15:28:33 -0400 | [diff] [blame] | 1151 | skip = (d.getVar('INSANE_SKIP') or "").split() |
| 1152 | skip_configure_unsafe = False |
| 1153 | if 'configure-unsafe' in skip: |
| 1154 | bb.note("Recipe %s skipping qa checking: configure-unsafe" % d.getVar('PN')) |
| 1155 | skip_configure_unsafe = True |
| 1156 | |
| 1157 | if bb.data.inherits_class('autotools', d) and not skip_configure_unsafe: |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 1158 | bb.note("Checking autotools environment for common misconfiguration") |
| 1159 | for root, dirs, files in os.walk(workdir): |
Andrew Geissler | 95ac1b8 | 2021-03-31 14:34:31 -0500 | [diff] [blame] | 1160 | statement = "grep -q -F -e 'is unsafe for cross-compilation' %s" % \ |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 1161 | os.path.join(root,"config.log") |
| 1162 | if "config.log" in files: |
| 1163 | if subprocess.call(statement, shell=True) == 0: |
Brad Bishop | 1932369 | 2019-04-05 15:28:33 -0400 | [diff] [blame] | 1164 | error_msg = """This autoconf log indicates errors, it looked at host include and/or library paths while determining system capabilities. |
| 1165 | Rerun configure task after fixing this.""" |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 1166 | oe.qa.handle_error("configure-unsafe", error_msg, d) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1167 | |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 1168 | if "configure.ac" in files: |
| 1169 | configs.append(os.path.join(root,"configure.ac")) |
| 1170 | if "configure.in" in files: |
| 1171 | configs.append(os.path.join(root, "configure.in")) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1172 | |
| 1173 | ########################################################################### |
| 1174 | # Check gettext configuration and dependencies are correct |
| 1175 | ########################################################################### |
| 1176 | |
Brad Bishop | 1932369 | 2019-04-05 15:28:33 -0400 | [diff] [blame] | 1177 | skip_configure_gettext = False |
| 1178 | if 'configure-gettext' in skip: |
| 1179 | bb.note("Recipe %s skipping qa checking: configure-gettext" % d.getVar('PN')) |
| 1180 | skip_configure_gettext = True |
| 1181 | |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 1182 | cnf = d.getVar('EXTRA_OECONF') or "" |
Brad Bishop | 1932369 | 2019-04-05 15:28:33 -0400 | [diff] [blame] | 1183 | if not ("gettext" in d.getVar('P') or "gcc-runtime" in d.getVar('P') or \ |
| 1184 | "--disable-nls" in cnf or skip_configure_gettext): |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 1185 | ml = d.getVar("MLPREFIX") or "" |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 1186 | if bb.data.inherits_class('cross-canadian', d): |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1187 | gt = "nativesdk-gettext" |
| 1188 | else: |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 1189 | gt = "gettext-native" |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 1190 | deps = bb.utils.explode_deps(d.getVar('DEPENDS') or "") |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1191 | if gt not in deps: |
| 1192 | for config in configs: |
| 1193 | gnu = "grep \"^[[:space:]]*AM_GNU_GETTEXT\" %s >/dev/null" % config |
| 1194 | if subprocess.call(gnu, shell=True) == 0: |
Brad Bishop | d89cb5f | 2019-04-10 09:02:41 -0400 | [diff] [blame] | 1195 | error_msg = "AM_GNU_GETTEXT used but no inherit gettext" |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 1196 | oe.qa.handle_error("configure-gettext", error_msg, d) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1197 | |
| 1198 | ########################################################################### |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1199 | # Check unrecognised configure options (with a white list) |
| 1200 | ########################################################################### |
Brad Bishop | c342db3 | 2019-05-15 21:57:59 -0400 | [diff] [blame] | 1201 | if bb.data.inherits_class("autotools", d) or bb.data.inherits_class("meson", d): |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1202 | bb.note("Checking configure output for unrecognised options") |
| 1203 | try: |
Brad Bishop | c342db3 | 2019-05-15 21:57:59 -0400 | [diff] [blame] | 1204 | if bb.data.inherits_class("autotools", d): |
| 1205 | flag = "WARNING: unrecognized options:" |
| 1206 | log = os.path.join(d.getVar('B'), 'config.log') |
| 1207 | if bb.data.inherits_class("meson", d): |
| 1208 | flag = "WARNING: Unknown options:" |
| 1209 | log = os.path.join(d.getVar('T'), 'log.do_configure') |
| 1210 | output = subprocess.check_output(['grep', '-F', flag, log]).decode("utf-8").replace(', ', ' ').replace('"', '') |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1211 | options = set() |
| 1212 | for line in output.splitlines(): |
| 1213 | options |= set(line.partition(flag)[2].split()) |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 1214 | whitelist = set(d.getVar("UNKNOWN_CONFIGURE_WHITELIST").split()) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1215 | options -= whitelist |
| 1216 | if options: |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 1217 | pn = d.getVar('PN') |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1218 | error_msg = pn + ": configure was passed unrecognised options: " + " ".join(options) |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 1219 | oe.qa.handle_error("unknown-configure-option", error_msg, d) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1220 | except subprocess.CalledProcessError: |
| 1221 | pass |
| 1222 | |
| 1223 | # Check invalid PACKAGECONFIG |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 1224 | pkgconfig = (d.getVar("PACKAGECONFIG") or "").split() |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1225 | if pkgconfig: |
| 1226 | pkgconfigflags = d.getVarFlags("PACKAGECONFIG") or {} |
| 1227 | for pconfig in pkgconfig: |
| 1228 | if pconfig not in pkgconfigflags: |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 1229 | pn = d.getVar('PN') |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1230 | error_msg = "%s: invalid PACKAGECONFIG: %s" % (pn, pconfig) |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 1231 | oe.qa.handle_error("invalid-packageconfig", error_msg, d) |
Patrick Williams | d8c66bc | 2016-06-20 12:57:21 -0500 | [diff] [blame] | 1232 | |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 1233 | oe.qa.exit_if_errors(d) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1234 | } |
| 1235 | |
| 1236 | python do_qa_unpack() { |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 1237 | src_uri = d.getVar('SRC_URI') |
| 1238 | s_dir = d.getVar('S') |
Patrick Williams | c0f7c04 | 2017-02-23 20:41:17 -0600 | [diff] [blame] | 1239 | if src_uri and not os.path.exists(s_dir): |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 1240 | bb.warn('%s: the directory %s (%s) pointed to by the S variable doesn\'t exist - please set S within the recipe to point to where the source has been unpacked to' % (d.getVar('PN'), d.getVar('S', False), s_dir)) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1241 | } |
| 1242 | |
| 1243 | # The Staging Func, to check all staging |
| 1244 | #addtask qa_staging after do_populate_sysroot before do_build |
| 1245 | do_populate_sysroot[postfuncs] += "do_qa_staging " |
| 1246 | |
Brad Bishop | d89cb5f | 2019-04-10 09:02:41 -0400 | [diff] [blame] | 1247 | # Check for patch fuzz |
| 1248 | do_patch[postfuncs] += "do_qa_patch " |
| 1249 | |
Patrick Williams | c0f7c04 | 2017-02-23 20:41:17 -0600 | [diff] [blame] | 1250 | # Check broken config.log files, for packages requiring Gettext which |
| 1251 | # don't have it in DEPENDS. |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1252 | #addtask qa_configure after do_configure before do_compile |
| 1253 | do_configure[postfuncs] += "do_qa_configure " |
| 1254 | |
| 1255 | # Check does S exist. |
| 1256 | do_unpack[postfuncs] += "do_qa_unpack" |
| 1257 | |
| 1258 | python () { |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 1259 | import re |
| 1260 | |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 1261 | tests = d.getVar('ALL_QA').split() |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1262 | if "desktop" in tests: |
| 1263 | d.appendVar("PACKAGE_DEPENDS", " desktop-file-utils-native") |
| 1264 | |
| 1265 | ########################################################################### |
| 1266 | # Check various variables |
| 1267 | ########################################################################### |
| 1268 | |
| 1269 | # Checking ${FILESEXTRAPATHS} |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 1270 | extrapaths = (d.getVar("FILESEXTRAPATHS") or "") |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1271 | if '__default' not in extrapaths.split(":"): |
Patrick Williams | 213cb26 | 2021-08-07 19:21:33 -0500 | [diff] [blame] | 1272 | msg = "FILESEXTRAPATHS-variable, must always use :prepend (or :append)\n" |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1273 | msg += "type of assignment, and don't forget the colon.\n" |
| 1274 | msg += "Please assign it with the format of:\n" |
Patrick Williams | 213cb26 | 2021-08-07 19:21:33 -0500 | [diff] [blame] | 1275 | msg += " FILESEXTRAPATHS:append := \":${THISDIR}/Your_Files_Path\" or\n" |
| 1276 | msg += " FILESEXTRAPATHS:prepend := \"${THISDIR}/Your_Files_Path:\"\n" |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1277 | msg += "in your bbappend file\n\n" |
| 1278 | msg += "Your incorrect assignment is:\n" |
| 1279 | msg += "%s\n" % extrapaths |
| 1280 | bb.warn(msg) |
| 1281 | |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 1282 | overrides = d.getVar('OVERRIDES').split(':') |
| 1283 | pn = d.getVar('PN') |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1284 | if pn in overrides: |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 1285 | msg = 'Recipe %s has PN of "%s" which is in OVERRIDES, this can result in unexpected behaviour.' % (d.getVar("FILE"), pn) |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 1286 | oe.qa.handle_error("pn-overrides", msg, d) |
Brad Bishop | 977dc1a | 2019-02-06 16:01:43 -0500 | [diff] [blame] | 1287 | prog = re.compile(r'[A-Z]') |
Brad Bishop | d7bf8c1 | 2018-02-25 22:55:05 -0500 | [diff] [blame] | 1288 | if prog.search(pn): |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 1289 | oe.qa.handle_error("uppercase-pn", 'PN: %s is upper case, this can result in unexpected behavior.' % pn, d) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1290 | |
Patrick Williams | 0ca19cc | 2021-08-16 14:03:13 -0500 | [diff] [blame] | 1291 | # Some people mistakenly use DEPENDS:${PN} instead of DEPENDS and wonder |
Brad Bishop | 08902b0 | 2019-08-20 09:16:51 -0400 | [diff] [blame] | 1292 | # why it doesn't work. |
Patrick Williams | 0ca19cc | 2021-08-16 14:03:13 -0500 | [diff] [blame] | 1293 | if (d.getVar(d.expand('DEPENDS:${PN}'))): |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 1294 | oe.qa.handle_error("pkgvarcheck", "recipe uses DEPENDS:${PN}, should use DEPENDS", d) |
Brad Bishop | 08902b0 | 2019-08-20 09:16:51 -0400 | [diff] [blame] | 1295 | |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1296 | issues = [] |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 1297 | if (d.getVar('PACKAGES') or "").split(): |
| 1298 | for dep in (d.getVar('QADEPENDS') or "").split(): |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1299 | d.appendVarFlag('do_package_qa', 'depends', " %s:do_populate_sysroot" % dep) |
| 1300 | for var in 'RDEPENDS', 'RRECOMMENDS', 'RSUGGESTS', 'RCONFLICTS', 'RPROVIDES', 'RREPLACES', 'FILES', 'pkg_preinst', 'pkg_postinst', 'pkg_prerm', 'pkg_postrm', 'ALLOW_EMPTY': |
| 1301 | if d.getVar(var, False): |
| 1302 | issues.append(var) |
| 1303 | |
Brad Bishop | 6e60e8b | 2018-02-01 10:27:11 -0500 | [diff] [blame] | 1304 | fakeroot_tests = d.getVar('FAKEROOT_QA').split() |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1305 | if set(tests) & set(fakeroot_tests): |
| 1306 | d.setVarFlag('do_package_qa', 'fakeroot', '1') |
| 1307 | d.appendVarFlag('do_package_qa', 'depends', ' virtual/fakeroot-native:do_populate_sysroot') |
| 1308 | else: |
| 1309 | d.setVarFlag('do_package_qa', 'rdeptask', '') |
| 1310 | for i in issues: |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 1311 | oe.qa.handle_error("pkgvarcheck", "%s: Variable %s is set as not being package specific, please fix this." % (d.getVar("FILE"), i), d) |
Andrew Geissler | d1e8949 | 2021-02-12 15:35:20 -0600 | [diff] [blame] | 1312 | |
| 1313 | if 'native-last' not in (d.getVar('INSANE_SKIP') or "").split(): |
| 1314 | for native_class in ['native', 'nativesdk']: |
| 1315 | if bb.data.inherits_class(native_class, d): |
| 1316 | |
| 1317 | inherited_classes = d.getVar('__inherit_cache', False) or [] |
| 1318 | needle = os.path.join('classes', native_class) |
| 1319 | |
| 1320 | bbclassextend = (d.getVar('BBCLASSEXTEND') or '').split() |
| 1321 | # BBCLASSEXTEND items are always added in the end |
| 1322 | skip_classes = bbclassextend |
| 1323 | if bb.data.inherits_class('native', d) or 'native' in bbclassextend: |
| 1324 | # native also inherits nopackages and relocatable bbclasses |
| 1325 | skip_classes.extend(['nopackages', 'relocatable']) |
| 1326 | |
| 1327 | broken_order = [] |
| 1328 | for class_item in reversed(inherited_classes): |
| 1329 | if needle not in class_item: |
| 1330 | for extend_item in skip_classes: |
| 1331 | if os.path.join('classes', '%s.bbclass' % extend_item) in class_item: |
| 1332 | break |
| 1333 | else: |
| 1334 | pn = d.getVar('PN') |
| 1335 | broken_order.append(os.path.basename(class_item)) |
| 1336 | else: |
| 1337 | break |
| 1338 | if broken_order: |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 1339 | oe.qa.handle_error("native-last", "%s: native/nativesdk class is not inherited last, this can result in unexpected behaviour. " |
Andrew Geissler | d1e8949 | 2021-02-12 15:35:20 -0600 | [diff] [blame] | 1340 | "Classes inherited after native/nativesdk: %s" % (pn, " ".join(broken_order)), d) |
| 1341 | |
Andrew Geissler | eff2747 | 2021-10-29 15:35:00 -0500 | [diff] [blame] | 1342 | oe.qa.exit_if_errors(d) |
Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1343 | } |