1# 2# Copyright OpenEmbedded Contributors 3# 4# SPDX-License-Identifier: MIT 5# 6 7import os 8import re 9 10import oeqa.utils.ftools as ftools 11from oeqa.utils.commands import runCmd, get_bb_var, get_bb_vars, bitbake 12 13from oeqa.selftest.case import OESelftestTestCase 14 15class BitbakeLayers(OESelftestTestCase): 16 17 @classmethod 18 def setUpClass(cls): 19 super(BitbakeLayers, cls).setUpClass() 20 bitbake("python3-jsonschema-native") 21 bitbake("-c addto_recipe_sysroot python3-jsonschema-native") 22 23 def test_bitbakelayers_layerindexshowdepends(self): 24 result = runCmd('bitbake-layers layerindex-show-depends meta-poky') 25 find_in_contents = re.search("openembedded-core", result.output) 26 self.assertTrue(find_in_contents, msg = "openembedded-core should have been listed at this step. bitbake-layers layerindex-show-depends meta-poky output: %s" % result.output) 27 28 def test_bitbakelayers_showcrossdepends(self): 29 result = runCmd('bitbake-layers show-cross-depends') 30 self.assertIn('aspell', result.output) 31 32 def test_bitbakelayers_showlayers(self): 33 result = runCmd('bitbake-layers show-layers') 34 self.assertIn('meta-selftest', result.output) 35 36 def test_bitbakelayers_showappends(self): 37 recipe = "xcursor-transparent-theme" 38 bb_file = self.get_recipe_basename(recipe) 39 result = runCmd('bitbake-layers show-appends') 40 self.assertIn(bb_file, result.output) 41 42 def test_bitbakelayers_showoverlayed(self): 43 result = runCmd('bitbake-layers show-overlayed') 44 self.assertIn('aspell', result.output) 45 46 def test_bitbakelayers_flatten(self): 47 recipe = "xcursor-transparent-theme" 48 recipe_path = "recipes-graphics/xcursor-transparent-theme" 49 recipe_file = self.get_recipe_basename(recipe) 50 testoutdir = os.path.join(self.builddir, 'test_bitbakelayers_flatten') 51 self.assertFalse(os.path.isdir(testoutdir), msg = "test_bitbakelayers_flatten should not exist at this point in time") 52 self.track_for_cleanup(testoutdir) 53 result = runCmd('bitbake-layers flatten %s' % testoutdir) 54 bb_file = os.path.join(testoutdir, recipe_path, recipe_file) 55 self.assertTrue(os.path.isfile(bb_file), msg = "Cannot find xcursor-transparent-theme_0.1.1.bb in the test_bitbakelayers_flatten local dir.") 56 contents = ftools.read_file(bb_file) 57 find_in_contents = re.search(r"##### bbappended from meta-selftest #####\n(.*\n)*include test_recipe.inc", contents) 58 self.assertTrue(find_in_contents, msg = "Flattening layers did not work. bitbake-layers flatten output: %s" % result.output) 59 60 def test_bitbakelayers_add_remove(self): 61 test_layer = os.path.join(get_bb_var('COREBASE'), 'meta-skeleton') 62 result = runCmd('bitbake-layers show-layers') 63 self.assertNotIn('meta-skeleton', result.output, "This test cannot run with meta-skeleton in bblayers.conf. bitbake-layers show-layers output: %s" % result.output) 64 result = runCmd('bitbake-layers add-layer %s' % test_layer) 65 result = runCmd('bitbake-layers show-layers') 66 self.assertIn('meta-skeleton', result.output, msg = "Something wrong happened. meta-skeleton layer was not added to conf/bblayers.conf. bitbake-layers show-layers output: %s" % result.output) 67 result = runCmd('bitbake-layers remove-layer %s' % test_layer) 68 result = runCmd('bitbake-layers show-layers') 69 self.assertNotIn('meta-skeleton', result.output, msg = "meta-skeleton should have been removed at this step. bitbake-layers show-layers output: %s" % result.output) 70 result = runCmd('bitbake-layers add-layer %s' % test_layer) 71 result = runCmd('bitbake-layers show-layers') 72 self.assertIn('meta-skeleton', result.output, msg = "Something wrong happened. meta-skeleton layer was not added to conf/bblayers.conf. bitbake-layers show-layers output: %s" % result.output) 73 result = runCmd('bitbake-layers remove-layer */meta-skeleton') 74 result = runCmd('bitbake-layers show-layers') 75 self.assertNotIn('meta-skeleton', result.output, msg = "meta-skeleton should have been removed at this step. bitbake-layers show-layers output: %s" % result.output) 76 77 def test_bitbakelayers_showrecipes(self): 78 result = runCmd('bitbake-layers show-recipes') 79 self.assertIn('aspell:', result.output) 80 self.assertIn('mtd-utils:', result.output) 81 self.assertIn('core-image-minimal:', result.output) 82 result = runCmd('bitbake-layers show-recipes mtd-utils') 83 self.assertIn('mtd-utils:', result.output) 84 self.assertNotIn('aspell:', result.output) 85 result = runCmd('bitbake-layers show-recipes -i image') 86 self.assertIn('core-image-minimal', result.output) 87 self.assertNotIn('mtd-utils:', result.output) 88 result = runCmd('bitbake-layers show-recipes -i meson,pkgconfig') 89 self.assertIn('libproxy:', result.output) 90 result = runCmd('bitbake-layers show-recipes -i cmake,pkgconfig') 91 self.assertNotIn('mtd-utils:', result.output) # doesn't inherit either 92 self.assertNotIn('wget:', result.output) # doesn't inherit cmake 93 self.assertNotIn('waffle:', result.output) # doesn't inherit pkgconfig 94 result = runCmd('bitbake-layers show-recipes -i nonexistentclass', ignore_status=True) 95 self.assertNotEqual(result.status, 0, 'bitbake-layers show-recipes -i nonexistentclass should have failed') 96 self.assertIn('ERROR:', result.output) 97 98 def test_bitbakelayers_createlayer(self): 99 priority = 10 100 layername = 'test-bitbakelayer-layercreate' 101 layerpath = os.path.join(self.builddir, layername) 102 self.assertFalse(os.path.exists(layerpath), '%s should not exist at this point in time' % layerpath) 103 result = runCmd('bitbake-layers create-layer --priority=%d %s' % (priority, layerpath)) 104 self.track_for_cleanup(layerpath) 105 result = runCmd('bitbake-layers add-layer %s' % layerpath) 106 self.add_command_to_tearDown('bitbake-layers remove-layer %s' % layerpath) 107 result = runCmd('bitbake-layers show-layers') 108 find_in_contents = re.search(re.escape(layername) + r'\s+' + re.escape(layerpath) + r'\s+' + re.escape(str(priority)), result.output) 109 self.assertTrue(find_in_contents, "%s not found in layers\n%s" % (layername, result.output)) 110 111 layervars = ['BBFILE_PRIORITY', 'BBFILE_PATTERN', 'LAYERDEPENDS', 'LAYERSERIES_COMPAT'] 112 bb_vars = get_bb_vars(['BBFILE_COLLECTIONS'] + ['%s_%s' % (v, layername) for v in layervars]) 113 114 for v in layervars: 115 varname = '%s_%s' % (v, layername) 116 self.assertIsNotNone(bb_vars[varname], "%s not found" % varname) 117 118 find_in_contents = re.search(r'(^|\s)' + re.escape(layername) + r'($|\s)', bb_vars['BBFILE_COLLECTIONS']) 119 self.assertTrue(find_in_contents, "%s not in BBFILE_COLLECTIONS" % layername) 120 121 self.assertEqual(bb_vars['BBFILE_PRIORITY_%s' % layername], str(priority), 'BBFILE_PRIORITY_%s != %d' % (layername, priority)) 122 123 result = runCmd('bitbake-layers save-build-conf {} {}'.format(layerpath, "buildconf-1")) 124 for f in ('local.conf.sample', 'bblayers.conf.sample', 'conf-summary.txt', 'conf-notes.txt'): 125 fullpath = os.path.join(layerpath, "conf", "templates", "buildconf-1", f) 126 self.assertTrue(os.path.exists(fullpath), "Template configuration file {} not found".format(fullpath)) 127 128 def get_recipe_basename(self, recipe): 129 recipe_file = "" 130 result = runCmd("bitbake-layers show-recipes -f %s" % recipe) 131 for line in result.output.splitlines(): 132 if recipe in line: 133 recipe_file = line 134 break 135 136 self.assertTrue(os.path.isfile(recipe_file), msg = "Can't find recipe file for %s" % recipe) 137 return os.path.basename(recipe_file) 138 139 def validate_layersjson(self, json): 140 python = os.path.join(get_bb_var('STAGING_BINDIR', 'python3-jsonschema-native'), 'nativepython3') 141 jsonvalidator = os.path.join(get_bb_var('STAGING_BINDIR', 'python3-jsonschema-native'), 'jsonschema') 142 jsonschema = os.path.join(get_bb_var('COREBASE'), 'meta/files/layers.schema.json') 143 result = runCmd("{} {} -i {} {}".format(python, jsonvalidator, json, jsonschema)) 144 145 def test_validate_examplelayersjson(self): 146 json = os.path.join(get_bb_var('COREBASE'), "meta/files/layers.example.json") 147 self.validate_layersjson(json) 148 149 def test_bitbakelayers_setup(self): 150 result = runCmd('bitbake-layers create-layers-setup {}'.format(self.testlayer_path)) 151 jsonfile = os.path.join(self.testlayer_path, "setup-layers.json") 152 self.validate_layersjson(jsonfile) 153 154 # The revision-under-test may not necessarily be available on the remote server, 155 # so replace it with a revision that has a yocto-4.1 tag. 156 import json 157 with open(jsonfile) as f: 158 data = json.load(f) 159 for s in data['sources']: 160 data['sources'][s]['git-remote']['rev'] = '5200799866b92259e855051112520006e1aaaac0' 161 with open(jsonfile, 'w') as f: 162 json.dump(data, f) 163 164 testcheckoutdir = os.path.join(self.builddir, 'test-layer-checkout') 165 result = runCmd('{}/setup-layers --destdir {}'.format(self.testlayer_path, testcheckoutdir)) 166 layers_json = os.path.join(testcheckoutdir, ".oe-layers.json") 167 self.assertTrue(os.path.exists(layers_json), "File {} not found in test layer checkout".format(layers_json)) 168 169 # As setup-layers checkout out an old revision of poky, there is no setup-build symlink, 170 # and we need to run oe-setup-build directly from the current poky tree under test 171 oe_setup_build = os.path.join(get_bb_var('COREBASE'), 'scripts/oe-setup-build') 172 oe_setup_build_l = os.path.join(testcheckoutdir, 'setup-build') 173 os.symlink(oe_setup_build,oe_setup_build_l) 174 175 cmd = '{} --layerlist {} list -v'.format(oe_setup_build_l, layers_json) 176 result = runCmd(cmd) 177 cond = "conf/templates/default" in result.output 178 self.assertTrue(cond, "Incorrect output from {}: {}".format(cmd, result.output)) 179 180 # rather than hardcode the build setup cmdline here, let's actually run what the tool suggests to the user 181 conf = None 182 if 'poky-default' in result.output: 183 conf = 'poky-default' 184 elif 'meta-default' in result.output: 185 conf = 'meta-default' 186 self.assertIsNotNone(conf, "Could not find the configuration to set up a build in the output: {}".format(result.output)) 187 188 cmd = '{} --layerlist {} setup -c {} --no-shell'.format(oe_setup_build_l, layers_json, conf) 189 result = runCmd(cmd) 190 191 def test_bitbakelayers_updatelayer(self): 192 result = runCmd('bitbake-layers create-layers-setup {}'.format(self.testlayer_path)) 193 jsonfile = os.path.join(self.testlayer_path, "setup-layers.json") 194 self.validate_layersjson(jsonfile) 195 196 import json 197 with open(jsonfile) as f: 198 data = json.load(f) 199 repos = [] 200 for s in data['sources']: 201 repos.append(s) 202 203 self.assertTrue(len(repos) > 1, "Not enough repositories available") 204 self.validate_layersjson(jsonfile) 205 206 test_ref_1 = 'ref_1' 207 test_ref_2 = 'ref_2' 208 209 # Create a new layers setup using custom references 210 result = runCmd('bitbake-layers create-layers-setup --use-custom-reference {first_repo}:{test_ref} --use-custom-reference {second_repo}:{test_ref} {path}' 211 .format(first_repo=repos[0], second_repo=repos[1], test_ref=test_ref_1, path=self.testlayer_path)) 212 self.validate_layersjson(jsonfile) 213 214 with open(jsonfile) as f: 215 data = json.load(f) 216 first_rev_1 = data['sources'][repos[0]]['git-remote']['rev'] 217 first_desc_1 = data['sources'][repos[0]]['git-remote']['describe'] 218 second_rev_1 = data['sources'][repos[1]]['git-remote']['rev'] 219 second_desc_1 = data['sources'][repos[1]]['git-remote']['describe'] 220 221 self.assertEqual(first_rev_1, test_ref_1, "Revision not set correctly: '{}'".format(first_rev_1)) 222 self.assertEqual(first_desc_1, '', "Describe not cleared: '{}'".format(first_desc_1)) 223 self.assertEqual(second_rev_1, test_ref_1, "Revision not set correctly: '{}'".format(second_rev_1)) 224 self.assertEqual(second_desc_1, '', "Describe not cleared: '{}'".format(second_desc_1)) 225 226 # Update one of the repositories in the layers setup using a different custom reference 227 # This should only update the selected repository, everything else should remain as is 228 result = runCmd('bitbake-layers create-layers-setup --update --use-custom-reference {first_repo}:{test_ref} {path}' 229 .format(first_repo=repos[0], test_ref=test_ref_2, path=self.testlayer_path)) 230 self.validate_layersjson(jsonfile) 231 232 with open(jsonfile) as f: 233 data = json.load(f) 234 first_rev_2 = data['sources'][repos[0]]['git-remote']['rev'] 235 first_desc_2 = data['sources'][repos[0]]['git-remote']['describe'] 236 second_rev_2 = data['sources'][repos[1]]['git-remote']['rev'] 237 second_desc_2 = data['sources'][repos[1]]['git-remote']['describe'] 238 239 self.assertEqual(first_rev_2, test_ref_2, "Revision not set correctly: '{}'".format(first_rev_2)) 240 self.assertEqual(first_desc_2, '', "Describe not cleared: '{}'".format(first_desc_2)) 241 self.assertEqual(second_rev_2, second_rev_1, "Revision should not be updated: '{}'".format(second_rev_2)) 242 self.assertEqual(second_desc_2, second_desc_1, "Describe should not be updated: '{}'".format(second_desc_2)) 243 244class BitbakeConfigBuild(OESelftestTestCase): 245 def test_enable_disable_fragments(self): 246 self.assertEqual(get_bb_var('SELFTEST_FRAGMENT_VARIABLE'), None) 247 self.assertEqual(get_bb_var('SELFTEST_FRAGMENT_ANOTHER_VARIABLE'), None) 248 249 runCmd('bitbake-config-build enable-fragment selftest/test-fragment') 250 self.assertEqual(get_bb_var('SELFTEST_FRAGMENT_VARIABLE'), 'somevalue') 251 self.assertEqual(get_bb_var('SELFTEST_FRAGMENT_ANOTHER_VARIABLE'), None) 252 253 runCmd('bitbake-config-build enable-fragment selftest/more-fragments-here/test-another-fragment') 254 self.assertEqual(get_bb_var('SELFTEST_FRAGMENT_VARIABLE'), 'somevalue') 255 self.assertEqual(get_bb_var('SELFTEST_FRAGMENT_ANOTHER_VARIABLE'), 'someothervalue') 256 257 fragment_metadata_command = "bitbake-getvar -f {} --value {}" 258 result = runCmd(fragment_metadata_command.format("selftest/test-fragment", "BB_CONF_FRAGMENT_SUMMARY")) 259 self.assertIn("This is a configuration fragment intended for testing in oe-selftest context", result.output) 260 result = runCmd(fragment_metadata_command.format("selftest/test-fragment", "BB_CONF_FRAGMENT_DESCRIPTION")) 261 self.assertIn("It defines a variable that can be checked inside the test.", result.output) 262 result = runCmd(fragment_metadata_command.format("selftest/more-fragments-here/test-another-fragment", "BB_CONF_FRAGMENT_SUMMARY")) 263 self.assertIn("This is a second configuration fragment intended for testing in oe-selftest context", result.output) 264 result = runCmd(fragment_metadata_command.format("selftest/more-fragments-here/test-another-fragment", "BB_CONF_FRAGMENT_DESCRIPTION")) 265 self.assertIn("It defines another variable that can be checked inside the test.", result.output) 266 267 runCmd('bitbake-config-build disable-fragment selftest/test-fragment') 268 self.assertEqual(get_bb_var('SELFTEST_FRAGMENT_VARIABLE'), None) 269 self.assertEqual(get_bb_var('SELFTEST_FRAGMENT_ANOTHER_VARIABLE'), 'someothervalue') 270 271 runCmd('bitbake-config-build disable-fragment selftest/more-fragments-here/test-another-fragment') 272 self.assertEqual(get_bb_var('SELFTEST_FRAGMENT_VARIABLE'), None) 273 self.assertEqual(get_bb_var('SELFTEST_FRAGMENT_ANOTHER_VARIABLE'), None) 274