meta/lib/oeqa/selftest/cases/bbtests.py

   1 #
   2 # SPDX-License-Identifier: MIT
   3 #
   4
   5 import os
   6 import re
   7
   8 import oeqa.utils.ftools as ftools
   9 from oeqa.utils.commands import runCmd, bitbake, get_bb_var, get_bb_vars
  10
  11 from oeqa.selftest.case import OESelftestTestCase
  12
  13 class 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* shown", result.output)
  67         find_errors = re.search("Summary: There w.{2,3}? [1-9][0-9]* ERROR messages* shown", 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\"
 143 SSTATE_DIR = \"${TOPDIR}/download-selftest\"
 144 INHERIT_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         line = self.getline(result, 'Fetcher failure for URL: \'file://invalid\'. Unable to fetch URL from any source.')
 155         self.assertTrue(line and line.startswith("ERROR:"), msg = "\"invalid\" file \
 156 doesn't exist, yet fetcher didn't report any error. bitbake output: %s" % result.output)
 157
 158     def test_rename_downloaded_file(self):
 159         # TODO unique dldir instead of using cleanall
 160         # TODO: need to set sstatedir?
 161         self.write_config("""DL_DIR = \"${TOPDIR}/download-selftest\"
 162 SSTATE_DIR = \"${TOPDIR}/download-selftest\"
 163 """)
 164         self.track_for_cleanup(os.path.join(self.builddir, "download-selftest"))
 165
 166         data = 'SRC_URI = "https://downloads.yoctoproject.org/mirror/sources/aspell-${PV}.tar.gz;downloadfilename=test-aspell.tar.gz"'
 167         self.write_recipeinc('aspell', data)
 168         result = bitbake('-f -c fetch aspell', ignore_status=True)
 169         self.delete_recipeinc('aspell')
 170         self.assertEqual(result.status, 0, msg = "Couldn't fetch aspell. %s" % result.output)
 171         dl_dir = get_bb_var("DL_DIR")
 172         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)
 173         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)
 174
 175     def test_environment(self):
 176         self.write_config("TEST_ENV=\"localconf\"")
 177         result = runCmd('bitbake -e | grep TEST_ENV=')
 178         self.assertIn('localconf', result.output)
 179
 180     def test_dry_run(self):
 181         result = runCmd('bitbake -n m4-native')
 182         self.assertEqual(0, result.status, "bitbake dry run didn't run as expected. %s" % result.output)
 183
 184     def test_just_parse(self):
 185         result = runCmd('bitbake -p')
 186         self.assertEqual(0, result.status, "errors encountered when parsing recipes. %s" % result.output)
 187
 188     def test_version(self):
 189         result = runCmd('bitbake -s | grep wget')
 190         find = re.search(r"wget *:([0-9a-zA-Z\.\-]+)", result.output)
 191         self.assertTrue(find, "No version returned for searched recipe. bitbake output: %s" % result.output)
 192
 193     def test_prefile(self):
 194         preconf = os.path.join(self.builddir, 'conf/prefile.conf')
 195         self.track_for_cleanup(preconf)
 196         ftools.write_file(preconf ,"TEST_PREFILE=\"prefile\"")
 197         result = runCmd('bitbake -r conf/prefile.conf -e | grep TEST_PREFILE=')
 198         self.assertIn('prefile', result.output)
 199         self.write_config("TEST_PREFILE=\"localconf\"")
 200         result = runCmd('bitbake -r conf/prefile.conf -e | grep TEST_PREFILE=')
 201         self.assertIn('localconf', result.output)
 202
 203     def test_postfile(self):
 204         postconf = os.path.join(self.builddir, 'conf/postfile.conf')
 205         self.track_for_cleanup(postconf)
 206         ftools.write_file(postconf , "TEST_POSTFILE=\"postfile\"")
 207         self.write_config("TEST_POSTFILE=\"localconf\"")
 208         result = runCmd('bitbake -R conf/postfile.conf -e | grep TEST_POSTFILE=')
 209         self.assertIn('postfile', result.output)
 210
 211     def test_checkuri(self):
 212         result = runCmd('bitbake -c checkuri m4')
 213         self.assertEqual(0, result.status, msg = "\"checkuri\" task was not executed. bitbake output: %s" % result.output)
 214
 215     def test_continue(self):
 216         self.write_config("""DL_DIR = \"${TOPDIR}/download-selftest\"
 217 SSTATE_DIR = \"${TOPDIR}/download-selftest\"
 218 INHERIT_remove = \"report-error\"
 219 """)
 220         self.track_for_cleanup(os.path.join(self.builddir, "download-selftest"))
 221         self.write_recipeinc('man-db',"\ndo_fail_task () {\nexit 1 \n}\n\naddtask do_fail_task before do_fetch\n" )
 222         runCmd('bitbake -c cleanall man-db xcursor-transparent-theme')
 223         result = runCmd('bitbake -c unpack -k man-db xcursor-transparent-theme', ignore_status=True)
 224         errorpos = result.output.find('ERROR: Function failed: do_fail_task')
 225         manver = re.search("NOTE: recipe xcursor-transparent-theme-(.*?): task do_unpack: Started", result.output)
 226         continuepos = result.output.find('NOTE: recipe xcursor-transparent-theme-%s: task do_unpack: Started' % manver.group(1))
 227         self.assertLess(errorpos,continuepos, msg = "bitbake didn't pass do_fail_task. bitbake output: %s" % result.output)
 228
 229     def test_non_gplv3(self):
 230         self.write_config('INCOMPATIBLE_LICENSE = "GPLv3"')
 231         result = bitbake('selftest-ed', ignore_status=True)
 232         self.assertEqual(result.status, 0, "Bitbake failed, exit code %s, output %s" % (result.status, result.output))
 233         lic_dir = get_bb_var('LICENSE_DIRECTORY')
 234         self.assertFalse(os.path.isfile(os.path.join(lic_dir, 'selftest-ed/generic_GPLv3')))
 235         self.assertTrue(os.path.isfile(os.path.join(lic_dir, 'selftest-ed/generic_GPLv2')))
 236
 237     def test_setscene_only(self):
 238         """ Bitbake option to restore from sstate only within a build (i.e. execute no real tasks, only setscene)"""
 239         test_recipe = 'ed'
 240
 241         bitbake(test_recipe)
 242         bitbake('-c clean %s' % test_recipe)
 243         ret = bitbake('--setscene-only %s' % test_recipe)
 244
 245         tasks = re.findall(r'task\s+(do_\S+):', ret.output)
 246
 247         for task in tasks:
 248             self.assertIn('_setscene', task, 'A task different from _setscene ran: %s.\n'
 249                                              'Executed tasks were: %s' % (task, str(tasks)))
 250
 251     def test_skip_setscene(self):
 252         test_recipe = 'ed'
 253
 254         bitbake(test_recipe)
 255         bitbake('-c clean %s' % test_recipe)
 256
 257         ret = bitbake('--setscene-only %s' % test_recipe)
 258         tasks = re.findall(r'task\s+(do_\S+):', ret.output)
 259
 260         for task in tasks:
 261             self.assertIn('_setscene', task, 'A task different from _setscene ran: %s.\n'
 262                                              'Executed tasks were: %s' % (task, str(tasks)))
 263
 264         # Run without setscene. Should do nothing
 265         ret = bitbake('--skip-setscene %s' % test_recipe)
 266         tasks = re.findall(r'task\s+(do_\S+):', ret.output)
 267
 268         self.assertFalse(tasks, 'Tasks %s ran when they should not have' % (str(tasks)))
 269
 270         # Clean (leave sstate cache) and run with --skip-setscene. No setscene
 271         # tasks should run
 272         bitbake('-c clean %s' % test_recipe)
 273
 274         ret = bitbake('--skip-setscene %s' % test_recipe)
 275         tasks = re.findall(r'task\s+(do_\S+):', ret.output)
 276
 277         for task in tasks:
 278             self.assertNotIn('_setscene', task, 'A _setscene task ran: %s.\n'
 279                                                 'Executed tasks were: %s' % (task, str(tasks)))
 280
 281     def test_bbappend_order(self):
 282         """ Bitbake should bbappend to recipe in a predictable order """
 283         test_recipe = 'ed'
 284         bb_vars = get_bb_vars(['SUMMARY', 'PV'], test_recipe)
 285         test_recipe_summary_before = bb_vars['SUMMARY']
 286         test_recipe_pv = bb_vars['PV']
 287         recipe_append_file = test_recipe + '_' + test_recipe_pv + '.bbappend'
 288         expected_recipe_summary = test_recipe_summary_before
 289
 290         for i in range(5):
 291             recipe_append_dir = test_recipe + '_test_' + str(i)
 292             recipe_append_path = os.path.join(self.testlayer_path, 'recipes-test', recipe_append_dir, recipe_append_file)
 293             os.mkdir(os.path.join(self.testlayer_path, 'recipes-test', recipe_append_dir))
 294             feature = 'SUMMARY += "%s"\n' % i
 295             ftools.write_file(recipe_append_path, feature)
 296             expected_recipe_summary += ' %s' % i
 297
 298         self.add_command_to_tearDown('rm -rf %s' % os.path.join(self.testlayer_path, 'recipes-test',
 299                                                                test_recipe + '_test_*'))
 300
 301         test_recipe_summary_after = get_bb_var('SUMMARY', test_recipe)
 302         self.assertEqual(expected_recipe_summary, test_recipe_summary_after)
 303
 304     def test_git_patchtool(self):
 305         """ PATCHTOOL=git should work with non-git sources like tarballs
 306             test recipe for the test must NOT containt git:// repository in SRC_URI
 307         """
 308         test_recipe = "man-db"
 309         self.write_recipeinc(test_recipe, 'PATCHTOOL=\"git\"')
 310         src = get_bb_var("SRC_URI",test_recipe)
 311         gitscm = re.search("git://", src)
 312         self.assertFalse(gitscm, "test_git_patchtool pre-condition failed: {} test recipe contains git repo!".format(test_recipe))
 313         result = bitbake('{} -c patch'.format(test_recipe), ignore_status=False)
 314         fatal = re.search("fatal: not a git repository (or any of the parent directories)", result.output)
 315         self.assertFalse(fatal, "Failed to patch using PATCHTOOL=\"git\"")
 316         self.delete_recipeinc(test_recipe)
 317         bitbake('-cclean {}'.format(test_recipe))
 318
 319     def test_git_patchtool2(self):
 320         """ Test if PATCHTOOL=git works with git repo and doesn't reinitialize it
 321         """
 322         test_recipe = "gitrepotest"
 323         src = get_bb_var("SRC_URI",test_recipe)
 324         gitscm = re.search("git://", src)
 325         self.assertTrue(gitscm, "test_git_patchtool pre-condition failed: {} test recipe doesn't contains git repo!".format(test_recipe))
 326         result = bitbake('{} -c patch'.format(test_recipe), ignore_status=False)
 327         srcdir = get_bb_var('S', test_recipe)
 328         result = runCmd("git log", cwd = srcdir)
 329         self.assertFalse("bitbake_patching_started" in result.output, msg = "Repository has been reinitialized. {}".format(srcdir))
 330         self.delete_recipeinc(test_recipe)
 331         bitbake('-cclean {}'.format(test_recipe))