1# 2# SPDX-License-Identifier: MIT 3# 4 5import os 6import re 7 8import oeqa.utils.ftools as ftools 9from oeqa.utils.commands import runCmd, bitbake, get_bb_var, get_bb_vars 10 11from oeqa.selftest.case import OESelftestTestCase 12 13class BitbakeTests(OESelftestTestCase): 14 15 def getline(self, res, line): 16 for l in res.output.split('\n'): 17 if line in l: 18 return l 19 20 # Test bitbake can run from the <builddir>/conf directory 21 def test_run_bitbake_from_dir_1(self): 22 os.chdir(os.path.join(self.builddir, 'conf')) 23 self.assertEqual(bitbake('-e').status, 0, msg = "bitbake couldn't run from \"conf\" dir") 24 25 # Test bitbake can run from the <builddir>'s parent directory 26 def test_run_bitbake_from_dir_2(self): 27 my_env = os.environ.copy() 28 my_env['BBPATH'] = my_env['BUILDDIR'] 29 os.chdir(os.path.dirname(os.environ['BUILDDIR'])) 30 self.assertEqual(bitbake('-e', env=my_env).status, 0, msg = "bitbake couldn't run from builddir's parent directory") 31 32 # Test bitbake can run from some other random system location (we use /tmp/) 33 def test_run_bitbake_from_dir_3(self): 34 my_env = os.environ.copy() 35 my_env['BBPATH'] = my_env['BUILDDIR'] 36 os.chdir("/tmp/") 37 self.assertEqual(bitbake('-e', env=my_env).status, 0, msg = "bitbake couldn't run from /tmp/") 38 39 40 def test_event_handler(self): 41 self.write_config("INHERIT += \"test_events\"") 42 result = bitbake('m4-native') 43 find_build_started = re.search(r"NOTE: Test for bb\.event\.BuildStarted(\n.*)*NOTE: Executing.*Tasks", result.output) 44 find_build_completed = re.search(r"Tasks Summary:.*(\n.*)*NOTE: Test for bb\.event\.BuildCompleted", result.output) 45 self.assertTrue(find_build_started, msg = "Match failed in:\n%s" % result.output) 46 self.assertTrue(find_build_completed, msg = "Match failed in:\n%s" % result.output) 47 self.assertNotIn('Test for bb.event.InvalidEvent', result.output) 48 49 def test_local_sstate(self): 50 bitbake('m4-native') 51 bitbake('m4-native -cclean') 52 result = bitbake('m4-native') 53 find_setscene = re.search("m4-native.*do_.*_setscene", result.output) 54 self.assertTrue(find_setscene, msg = "No \"m4-native.*do_.*_setscene\" message found during bitbake m4-native. bitbake output: %s" % result.output ) 55 56 def test_bitbake_invalid_recipe(self): 57 result = bitbake('-b asdf', ignore_status=True) 58 self.assertTrue("ERROR: Unable to find any recipe file matching 'asdf'" in result.output, msg = "Though asdf recipe doesn't exist, bitbake didn't output any err. message. bitbake output: %s" % result.output) 59 60 def test_bitbake_invalid_target(self): 61 result = bitbake('asdf', ignore_status=True) 62 self.assertIn("ERROR: Nothing PROVIDES 'asdf'", result.output) 63 64 def test_warnings_errors(self): 65 result = bitbake('-b asdf', ignore_status=True) 66 find_warnings = re.search("Summary: There w.{2,3}? [1-9][0-9]* WARNING messages*", result.output) 67 find_errors = re.search("Summary: There w.{2,3}? [1-9][0-9]* ERROR messages*", result.output) 68 self.assertTrue(find_warnings, msg="Did not find the mumber of warnings at the end of the build:\n" + result.output) 69 self.assertTrue(find_errors, msg="Did not find the mumber of errors at the end of the build:\n" + result.output) 70 71 def test_invalid_patch(self): 72 # This patch should fail to apply. 73 self.write_recipeinc('man-db', 'FILESEXTRAPATHS:prepend := "${THISDIR}/files:"\nSRC_URI += "file://0001-Test-patch-here.patch"') 74 self.write_config("INHERIT:remove = \"report-error\"") 75 result = bitbake('man-db -c patch', ignore_status=True) 76 self.delete_recipeinc('man-db') 77 bitbake('-cclean man-db') 78 found = False 79 for l in result.output.split('\n'): 80 if l.startswith("ERROR:") and "failed" in l and "do_patch" in l: 81 found = l 82 self.assertTrue(found and found.startswith("ERROR:"), msg = "Incorrectly formed patch application didn't fail. bitbake output: %s" % result.output) 83 84 def test_force_task_1(self): 85 # test 1 from bug 5875 86 import uuid 87 test_recipe = 'zlib' 88 # Need to use uuid otherwise hash equivlance would change the workflow 89 test_data = "Microsoft Made No Profit From Anyone's Zunes Yo %s" % uuid.uuid1() 90 bb_vars = get_bb_vars(['D', 'PKGDEST', 'mandir'], test_recipe) 91 image_dir = bb_vars['D'] 92 pkgsplit_dir = bb_vars['PKGDEST'] 93 man_dir = bb_vars['mandir'] 94 self.write_config("PACKAGE_CLASSES = \"package_rpm\"") 95 96 bitbake('-c clean %s' % test_recipe) 97 bitbake('-c package -f %s' % test_recipe) 98 self.add_command_to_tearDown('bitbake -c clean %s' % test_recipe) 99 100 man_file = os.path.join(image_dir + man_dir, 'man3/zlib.3') 101 ftools.append_file(man_file, test_data) 102 bitbake('-c package -f %s' % test_recipe) 103 104 man_split_file = os.path.join(pkgsplit_dir, 'zlib-doc' + man_dir, 'man3/zlib.3') 105 man_split_content = ftools.read_file(man_split_file) 106 self.assertIn(test_data, man_split_content, 'The man file has not changed in packages-split.') 107 108 ret = bitbake(test_recipe) 109 self.assertIn('task do_package_write_rpm:', ret.output, 'Task do_package_write_rpm did not re-executed.') 110 111 def test_force_task_2(self): 112 # test 2 from bug 5875 113 test_recipe = 'zlib' 114 115 bitbake(test_recipe) 116 self.add_command_to_tearDown('bitbake -c clean %s' % test_recipe) 117 118 result = bitbake('-C compile %s' % test_recipe) 119 look_for_tasks = ['do_compile:', 'do_install:', 'do_populate_sysroot:', 'do_package:'] 120 for task in look_for_tasks: 121 self.assertIn(task, result.output, msg="Couldn't find %s task.") 122 123 def test_bitbake_g(self): 124 recipe = 'base-files' 125 result = bitbake('-g %s' % recipe) 126 for f in ['pn-buildlist', 'task-depends.dot']: 127 self.addCleanup(os.remove, f) 128 self.assertTrue('Task dependencies saved to \'task-depends.dot\'' in result.output, msg = "No task dependency \"task-depends.dot\" file was generated for the given task target. bitbake output: %s" % result.output) 129 self.assertIn(recipe, ftools.read_file(os.path.join(self.builddir, 'task-depends.dot'))) 130 131 def test_image_manifest(self): 132 bitbake('core-image-minimal') 133 bb_vars = get_bb_vars(["DEPLOY_DIR_IMAGE", "IMAGE_LINK_NAME"], "core-image-minimal") 134 deploydir = bb_vars["DEPLOY_DIR_IMAGE"] 135 imagename = bb_vars["IMAGE_LINK_NAME"] 136 manifest = os.path.join(deploydir, imagename + ".manifest") 137 self.assertTrue(os.path.islink(manifest), msg="No manifest file created for image. It should have been created in %s" % manifest) 138 139 def test_invalid_recipe_src_uri(self): 140 data = 'SRC_URI = "file://invalid"' 141 self.write_recipeinc('man-db', data) 142 self.write_config("""DL_DIR = \"${TOPDIR}/download-selftest\" 143SSTATE_DIR = \"${TOPDIR}/download-selftest\" 144INHERIT:remove = \"report-error\" 145""") 146 self.track_for_cleanup(os.path.join(self.builddir, "download-selftest")) 147 148 bitbake('-ccleanall man-db') 149 result = bitbake('-c fetch man-db', ignore_status=True) 150 bitbake('-ccleanall man-db') 151 self.delete_recipeinc('man-db') 152 self.assertEqual(result.status, 1, msg="Command succeded when it should have failed. bitbake output: %s" % result.output) 153 self.assertIn('Fetcher failure: Unable to find file file://invalid anywhere. The paths that were searched were:', result.output) 154 155 def test_rename_downloaded_file(self): 156 # TODO unique dldir instead of using cleanall 157 # TODO: need to set sstatedir? 158 self.write_config("""DL_DIR = \"${TOPDIR}/download-selftest\" 159SSTATE_DIR = \"${TOPDIR}/download-selftest\" 160""") 161 self.track_for_cleanup(os.path.join(self.builddir, "download-selftest")) 162 163 data = 'SRC_URI = "https://downloads.yoctoproject.org/mirror/sources/aspell-${PV}.tar.gz;downloadfilename=test-aspell.tar.gz"' 164 self.write_recipeinc('aspell', data) 165 result = bitbake('-f -c fetch aspell', ignore_status=True) 166 self.delete_recipeinc('aspell') 167 self.assertEqual(result.status, 0, msg = "Couldn't fetch aspell. %s" % result.output) 168 dl_dir = get_bb_var("DL_DIR") 169 self.assertTrue(os.path.isfile(os.path.join(dl_dir, 'test-aspell.tar.gz')), msg = "File rename failed. No corresponding test-aspell.tar.gz file found under %s" % dl_dir) 170 self.assertTrue(os.path.isfile(os.path.join(dl_dir, 'test-aspell.tar.gz.done')), "File rename failed. No corresponding test-aspell.tar.gz.done file found under %s" % dl_dir) 171 172 def test_environment(self): 173 self.write_config("TEST_ENV=\"localconf\"") 174 result = runCmd('bitbake -e | grep TEST_ENV=') 175 self.assertIn('localconf', result.output) 176 177 def test_dry_run(self): 178 result = runCmd('bitbake -n m4-native') 179 self.assertEqual(0, result.status, "bitbake dry run didn't run as expected. %s" % result.output) 180 181 def test_just_parse(self): 182 result = runCmd('bitbake -p') 183 self.assertEqual(0, result.status, "errors encountered when parsing recipes. %s" % result.output) 184 185 def test_version(self): 186 result = runCmd('bitbake -s | grep wget') 187 find = re.search(r"wget *:([0-9a-zA-Z\.\-]+)", result.output) 188 self.assertTrue(find, "No version returned for searched recipe. bitbake output: %s" % result.output) 189 190 def test_prefile(self): 191 preconf = os.path.join(self.builddir, 'conf/prefile.conf') 192 self.track_for_cleanup(preconf) 193 ftools.write_file(preconf ,"TEST_PREFILE=\"prefile\"") 194 result = runCmd('bitbake -r conf/prefile.conf -e | grep TEST_PREFILE=') 195 self.assertIn('prefile', result.output) 196 self.write_config("TEST_PREFILE=\"localconf\"") 197 result = runCmd('bitbake -r conf/prefile.conf -e | grep TEST_PREFILE=') 198 self.assertIn('localconf', result.output) 199 200 def test_postfile(self): 201 postconf = os.path.join(self.builddir, 'conf/postfile.conf') 202 self.track_for_cleanup(postconf) 203 ftools.write_file(postconf , "TEST_POSTFILE=\"postfile\"") 204 self.write_config("TEST_POSTFILE=\"localconf\"") 205 result = runCmd('bitbake -R conf/postfile.conf -e | grep TEST_POSTFILE=') 206 self.assertIn('postfile', result.output) 207 208 def test_checkuri(self): 209 result = runCmd('bitbake -c checkuri m4') 210 self.assertEqual(0, result.status, msg = "\"checkuri\" task was not executed. bitbake output: %s" % result.output) 211 212 def test_continue(self): 213 self.write_config("""DL_DIR = \"${TOPDIR}/download-selftest\" 214SSTATE_DIR = \"${TOPDIR}/download-selftest\" 215INHERIT:remove = \"report-error\" 216""") 217 self.track_for_cleanup(os.path.join(self.builddir, "download-selftest")) 218 self.write_recipeinc('man-db',"\ndo_fail_task () {\nexit 1 \n}\n\naddtask do_fail_task before do_fetch\n" ) 219 runCmd('bitbake -c cleanall man-db xcursor-transparent-theme') 220 result = runCmd('bitbake -c unpack -k man-db xcursor-transparent-theme', ignore_status=True) 221 errorpos = result.output.find('ERROR: Function failed: do_fail_task') 222 manver = re.search("NOTE: recipe xcursor-transparent-theme-(.*?): task do_unpack: Started", result.output) 223 continuepos = result.output.find('NOTE: recipe xcursor-transparent-theme-%s: task do_unpack: Started' % manver.group(1)) 224 self.assertLess(errorpos,continuepos, msg = "bitbake didn't pass do_fail_task. bitbake output: %s" % result.output) 225 226 def test_non_gplv3(self): 227 self.write_config('INCOMPATIBLE_LICENSE = "GPL-3.0-or-later"') 228 result = bitbake('selftest-ed', ignore_status=True) 229 self.assertEqual(result.status, 0, "Bitbake failed, exit code %s, output %s" % (result.status, result.output)) 230 lic_dir = get_bb_var('LICENSE_DIRECTORY') 231 self.assertFalse(os.path.isfile(os.path.join(lic_dir, 'selftest-ed/generic_GPL-3.0-or-later'))) 232 self.assertTrue(os.path.isfile(os.path.join(lic_dir, 'selftest-ed/generic_GPL-2.0-or-later'))) 233 234 def test_setscene_only(self): 235 """ Bitbake option to restore from sstate only within a build (i.e. execute no real tasks, only setscene)""" 236 test_recipe = 'ed' 237 238 bitbake(test_recipe) 239 bitbake('-c clean %s' % test_recipe) 240 ret = bitbake('--setscene-only %s' % test_recipe) 241 242 tasks = re.findall(r'task\s+(do_\S+):', ret.output) 243 244 for task in tasks: 245 self.assertIn('_setscene', task, 'A task different from _setscene ran: %s.\n' 246 'Executed tasks were: %s' % (task, str(tasks))) 247 248 def test_skip_setscene(self): 249 test_recipe = 'ed' 250 251 bitbake(test_recipe) 252 bitbake('-c clean %s' % test_recipe) 253 254 ret = bitbake('--setscene-only %s' % test_recipe) 255 tasks = re.findall(r'task\s+(do_\S+):', ret.output) 256 257 for task in tasks: 258 self.assertIn('_setscene', task, 'A task different from _setscene ran: %s.\n' 259 'Executed tasks were: %s' % (task, str(tasks))) 260 261 # Run without setscene. Should do nothing 262 ret = bitbake('--skip-setscene %s' % test_recipe) 263 tasks = re.findall(r'task\s+(do_\S+):', ret.output) 264 265 self.assertFalse(tasks, 'Tasks %s ran when they should not have' % (str(tasks))) 266 267 # Clean (leave sstate cache) and run with --skip-setscene. No setscene 268 # tasks should run 269 bitbake('-c clean %s' % test_recipe) 270 271 ret = bitbake('--skip-setscene %s' % test_recipe) 272 tasks = re.findall(r'task\s+(do_\S+):', ret.output) 273 274 for task in tasks: 275 self.assertNotIn('_setscene', task, 'A _setscene task ran: %s.\n' 276 'Executed tasks were: %s' % (task, str(tasks))) 277 278 def test_bbappend_order(self): 279 """ Bitbake should bbappend to recipe in a predictable order """ 280 test_recipe = 'ed' 281 bb_vars = get_bb_vars(['SUMMARY', 'PV'], test_recipe) 282 test_recipe_summary_before = bb_vars['SUMMARY'] 283 test_recipe_pv = bb_vars['PV'] 284 recipe_append_file = test_recipe + '_' + test_recipe_pv + '.bbappend' 285 expected_recipe_summary = test_recipe_summary_before 286 287 for i in range(5): 288 recipe_append_dir = test_recipe + '_test_' + str(i) 289 recipe_append_path = os.path.join(self.testlayer_path, 'recipes-test', recipe_append_dir, recipe_append_file) 290 os.mkdir(os.path.join(self.testlayer_path, 'recipes-test', recipe_append_dir)) 291 feature = 'SUMMARY += "%s"\n' % i 292 ftools.write_file(recipe_append_path, feature) 293 expected_recipe_summary += ' %s' % i 294 295 self.add_command_to_tearDown('rm -rf %s' % os.path.join(self.testlayer_path, 'recipes-test', 296 test_recipe + '_test_*')) 297 298 test_recipe_summary_after = get_bb_var('SUMMARY', test_recipe) 299 self.assertEqual(expected_recipe_summary, test_recipe_summary_after) 300 301 def test_git_patchtool(self): 302 """ PATCHTOOL=git should work with non-git sources like tarballs 303 test recipe for the test must NOT containt git:// repository in SRC_URI 304 """ 305 test_recipe = "man-db" 306 self.write_recipeinc(test_recipe, 'PATCHTOOL=\"git\"') 307 src = get_bb_var("SRC_URI",test_recipe) 308 gitscm = re.search("git://", src) 309 self.assertFalse(gitscm, "test_git_patchtool pre-condition failed: {} test recipe contains git repo!".format(test_recipe)) 310 result = bitbake('{} -c patch'.format(test_recipe), ignore_status=False) 311 fatal = re.search("fatal: not a git repository (or any of the parent directories)", result.output) 312 self.assertFalse(fatal, "Failed to patch using PATCHTOOL=\"git\"") 313 self.delete_recipeinc(test_recipe) 314 bitbake('-cclean {}'.format(test_recipe)) 315 316 def test_git_patchtool2(self): 317 """ Test if PATCHTOOL=git works with git repo and doesn't reinitialize it 318 """ 319 test_recipe = "gitrepotest" 320 src = get_bb_var("SRC_URI",test_recipe) 321 gitscm = re.search("git://", src) 322 self.assertTrue(gitscm, "test_git_patchtool pre-condition failed: {} test recipe doesn't contains git repo!".format(test_recipe)) 323 result = bitbake('{} -c patch'.format(test_recipe), ignore_status=False) 324 srcdir = get_bb_var('S', test_recipe) 325 result = runCmd("git log", cwd = srcdir) 326 self.assertFalse("bitbake_patching_started" in result.output, msg = "Repository has been reinitialized. {}".format(srcdir)) 327 self.delete_recipeinc(test_recipe) 328 bitbake('-cclean {}'.format(test_recipe)) 329 330 331 def test_git_unpack_nonetwork(self): 332 """ 333 Test that a recipe with a floating tag that needs to be resolved upstream doesn't 334 access the network in a patch task run in a separate builld invocation 335 """ 336 337 # Enable the recipe to float using a distro override 338 self.write_config("DISTROOVERRIDES .= \":gitunpack-enable-recipe\"") 339 340 bitbake('gitunpackoffline -c fetch') 341 bitbake('gitunpackoffline -c patch') 342 343 def test_git_unpack_nonetwork_fail(self): 344 """ 345 Test that a recipe with a floating tag which doesn't call get_srcrev() in the fetcher 346 raises an error when the fetcher is called. 347 """ 348 349 # Enable the recipe to float using a distro override 350 self.write_config("DISTROOVERRIDES .= \":gitunpack-enable-recipe\"") 351 352 result = bitbake('gitunpackoffline-fail -c fetch', ignore_status=True) 353 self.assertTrue(re.search("Recipe uses a floating tag/branch .* for repo .* without a fixed SRCREV yet doesn't call bb.fetch2.get_srcrev()", result.output), msg = "Recipe without PV set to SRCPV should have failed: %s" % result.output) 354