summaryrefslogtreecommitdiffstats
path: root/scripts/yocto-check-layer
diff options
context:
space:
mode:
authorRichard Purdie <richard.purdie@linuxfoundation.org>2025-11-07 13:31:53 +0000
committerRichard Purdie <richard.purdie@linuxfoundation.org>2025-11-07 13:31:53 +0000
commit8c22ff0d8b70d9b12f0487ef696a7e915b9e3173 (patch)
treeefdc32587159d0050a69009bdf2330a531727d95 /scripts/yocto-check-layer
parentd412d2747595c1cc4a5e3ca975e3adc31b2f7891 (diff)
downloadpoky-8c22ff0d8b70d9b12f0487ef696a7e915b9e3173.tar.gz
The poky repository master branch is no longer being updated.
You can either: a) switch to individual clones of bitbake, openembedded-core, meta-yocto and yocto-docs b) use the new bitbake-setup You can find information about either approach in our documentation: https://docs.yoctoproject.org/ Note that "poky" the distro setting is still available in meta-yocto as before and we continue to use and maintain that. Long live Poky! Some further information on the background of this change can be found in: https://lists.openembedded.org/g/openembedded-architecture/message/2179 Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'scripts/yocto-check-layer')
-rwxr-xr-xscripts/yocto-check-layer257
1 files changed, 0 insertions, 257 deletions
diff --git a/scripts/yocto-check-layer b/scripts/yocto-check-layer
deleted file mode 100755
index 8c8b4dbcad..0000000000
--- a/scripts/yocto-check-layer
+++ /dev/null
@@ -1,257 +0,0 @@
1#!/usr/bin/env python3
2
3# Yocto Project layer checking tool
4#
5# Copyright (C) 2017 Intel Corporation
6#
7# SPDX-License-Identifier: MIT
8#
9
10import os
11import sys
12import argparse
13import logging
14import time
15import signal
16import shutil
17import collections
18
19scripts_path = os.path.dirname(os.path.realpath(__file__))
20lib_path = scripts_path + '/lib'
21sys.path = sys.path + [lib_path]
22import scriptutils
23import scriptpath
24scriptpath.add_oe_lib_path()
25scriptpath.add_bitbake_lib_path()
26
27from checklayer import LayerType, detect_layers, add_layers, add_layer_dependencies, get_layer_dependencies, get_signatures, check_bblayers, sanity_check_layers
28from oeqa.utils.commands import get_bb_vars
29
30PROGNAME = 'yocto-check-layer'
31CASES_PATHS = [os.path.join(os.path.abspath(os.path.dirname(__file__)),
32 'lib', 'checklayer', 'cases')]
33logger = scriptutils.logger_create(PROGNAME, stream=sys.stdout)
34
35def test_layer(td, layer, test_software_layer_signatures):
36 from checklayer.context import CheckLayerTestContext
37 logger.info("Starting to analyze: %s" % layer['name'])
38 logger.info('Distro: %s' % td['bbvars']["DISTRO"])
39 logger.info("----------------------------------------------------------------------")
40
41 tc = CheckLayerTestContext(td=td, logger=logger, layer=layer, test_software_layer_signatures=test_software_layer_signatures)
42 tc.loadTests(CASES_PATHS)
43 return tc.runTests()
44
45def dump_layer_debug(layer):
46 logger.debug("Found layer %s (%s)" % (layer["name"], layer["path"]))
47 collections = layer.get("collections", {})
48 if collections:
49 logger.debug("%s collections: %s" % (layer["name"], ", ".join(collections)))
50
51def main():
52 parser = argparse.ArgumentParser(
53 description="Yocto Project layer checking tool",
54 add_help=False)
55 parser.add_argument('layers', metavar='LAYER_DIR', nargs='+',
56 help='Layer to check')
57 parser.add_argument('-o', '--output-log',
58 help='File to output log (optional)', action='store')
59 parser.add_argument('--dependency', nargs="+",
60 help='Layers to process for dependencies', action='store')
61 parser.add_argument('--no-auto-dependency', help='Disable automatic testing of dependencies',
62 action='store_true')
63 parser.add_argument('--machines', nargs="+",
64 help='List of MACHINEs to be used during testing', action='store')
65 parser.add_argument('--additional-layers', nargs="+",
66 help='List of additional layers to add during testing', action='store')
67 group = parser.add_mutually_exclusive_group()
68 group.add_argument('--with-software-layer-signature-check', action='store_true', dest='test_software_layer_signatures',
69 default=True,
70 help='check that software layers do not change signatures (on by default)')
71 group.add_argument('--without-software-layer-signature-check', action='store_false', dest='test_software_layer_signatures',
72 help='disable signature checking for software layers')
73 parser.add_argument('-n', '--no-auto', help='Disable auto layer discovery',
74 action='store_true')
75 parser.add_argument('-d', '--debug', help='Enable debug output',
76 action='store_true')
77 parser.add_argument('-q', '--quiet', help='Print only errors',
78 action='store_true')
79
80 parser.add_argument('-h', '--help', action='help',
81 default=argparse.SUPPRESS,
82 help='show this help message and exit')
83
84 args = parser.parse_args()
85
86 if args.output_log:
87 fh = logging.FileHandler(args.output_log)
88 fh.setFormatter(logging.Formatter("%(levelname)s: %(message)s"))
89 logger.addHandler(fh)
90 if args.debug:
91 logger.setLevel(logging.DEBUG)
92 elif args.quiet:
93 logger.setLevel(logging.ERROR)
94
95 if not 'BUILDDIR' in os.environ:
96 logger.error("You must source the environment before running this script.")
97 logger.error("$ source oe-init-build-env")
98 return 1
99 builddir = os.environ['BUILDDIR']
100 bblayersconf = os.path.join(builddir, 'conf', 'bblayers.conf')
101
102 layers = detect_layers(args.layers, args.no_auto)
103 if not layers:
104 logger.error("Failed to detect layers")
105 return 1
106 if args.additional_layers:
107 additional_layers = detect_layers(args.additional_layers, args.no_auto)
108 else:
109 additional_layers = []
110 if args.dependency:
111 dep_layers = detect_layers(args.dependency, args.no_auto)
112 dep_layers = dep_layers + layers
113 else:
114 dep_layers = layers
115
116 logger.debug("Found additional layers:")
117 for l in additional_layers:
118 dump_layer_debug(l)
119 logger.debug("Found dependency layers:")
120 for l in dep_layers:
121 dump_layer_debug(l)
122
123 if not sanity_check_layers(additional_layers + dep_layers, logger):
124 logger.error("Failed layer validation")
125 return 1
126
127 logger.info("Detected layers:")
128 for layer in layers:
129 if layer['type'] == LayerType.ERROR_BSP_DISTRO:
130 logger.error("%s: Can't be DISTRO and BSP type at the same time."\
131 " Both conf/distro and conf/machine folders were found."\
132 % layer['name'])
133 layers.remove(layer)
134 elif layer['type'] == LayerType.ERROR_NO_LAYER_CONF:
135 logger.info("%s: Doesn't have conf/layer.conf file, so ignoring"\
136 % layer['name'])
137 layers.remove(layer)
138 else:
139 logger.info("%s: %s, %s" % (layer['name'], layer['type'],
140 layer['path']))
141 if not layers:
142 return 1
143
144 # Find all dependencies, and get them checked too
145 if not args.no_auto_dependency:
146 depends = []
147 for layer in layers:
148 layer_depends = get_layer_dependencies(layer, dep_layers, logger)
149 if layer_depends:
150 for d in layer_depends:
151 if d not in depends:
152 depends.append(d)
153
154 for d in depends:
155 if d not in layers:
156 logger.info("Adding %s to the list of layers to test, as a dependency", d['name'])
157 layers.append(d)
158
159 shutil.copyfile(bblayersconf, bblayersconf + '.backup')
160 def cleanup_bblayers(signum, frame):
161 shutil.copyfile(bblayersconf + '.backup', bblayersconf)
162 os.unlink(bblayersconf + '.backup')
163 signal.signal(signal.SIGTERM, cleanup_bblayers)
164 signal.signal(signal.SIGINT, cleanup_bblayers)
165
166 td = {}
167 results = collections.OrderedDict()
168 results_status = collections.OrderedDict()
169
170 layers_tested = 0
171 for layer in layers:
172 if layer['type'] in (LayerType.ERROR_NO_LAYER_CONF, LayerType.ERROR_BSP_DISTRO):
173 continue
174
175 # Reset to a clean backup copy for each run
176 shutil.copyfile(bblayersconf + '.backup', bblayersconf)
177
178 if layer['type'] not in (LayerType.CORE, ) and check_bblayers(bblayersconf, layer['path'], logger):
179 logger.info("%s already in %s. To capture initial signatures, layer under test should not present "
180 "in BBLAYERS. Please remove %s from BBLAYERS." % (layer['name'], bblayersconf, layer['name']))
181 results[layer['name']] = None
182 results_status[layer['name']] = 'SKIPPED (Layer under test should not present in BBLAYERS)'
183 continue
184
185 logger.info('')
186 logger.info("Setting up for %s(%s), %s" % (layer['name'], layer['type'],
187 layer['path']))
188
189 missing_dependencies = not add_layer_dependencies(bblayersconf, layer, dep_layers, logger)
190 if not missing_dependencies:
191 for additional_layer in additional_layers:
192 if not add_layer_dependencies(bblayersconf, additional_layer, dep_layers, logger):
193 missing_dependencies = True
194 break
195 if missing_dependencies:
196 logger.info('Skipping %s due to missing dependencies.' % layer['name'])
197 results[layer['name']] = None
198 results_status[layer['name']] = 'SKIPPED (Missing dependencies)'
199 layers_tested = layers_tested + 1
200 continue
201
202 if any(map(lambda additional_layer: not add_layers(bblayersconf, [additional_layer], logger),
203 additional_layers)):
204 logger.info('Skipping %s due to missing additional layers.' % layer['name'])
205 results[layer['name']] = None
206 results_status[layer['name']] = 'SKIPPED (Missing additional layers)'
207 layers_tested = layers_tested + 1
208 continue
209
210 logger.info('Getting initial bitbake variables ...')
211 td['bbvars'] = get_bb_vars()
212 logger.info('Getting initial signatures ...')
213 td['builddir'] = builddir
214 try:
215 td['sigs'], td['tunetasks'] = get_signatures(td['builddir'])
216 except RuntimeError as e:
217 logger.info(str(e))
218 results[layer['name']] = None
219 results_status[layer['name']] = 'FAIL (Generating world signatures)'
220 layers_tested = layers_tested + 1
221 continue
222 td['machines'] = args.machines
223
224 if not add_layers(bblayersconf, [layer], logger):
225 logger.info('Skipping %s ???.' % layer['name'])
226 results[layer['name']] = None
227 results_status[layer['name']] = 'SKIPPED (Unknown)'
228 layers_tested = layers_tested + 1
229 continue
230
231 result = test_layer(td, layer, args.test_software_layer_signatures)
232 results[layer['name']] = result
233 results_status[layer['name']] = 'PASS' if results[layer['name']].wasSuccessful() else 'FAIL'
234 layers_tested = layers_tested + 1
235
236 ret = 0
237 if layers_tested:
238 logger.info('')
239 logger.info('Summary of results:')
240 logger.info('')
241 for layer_name in results_status:
242 logger.info('%s ... %s' % (layer_name, results_status[layer_name]))
243 if not results[layer_name] or not results[layer_name].wasSuccessful():
244 ret = 2 # ret = 1 used for initialization errors
245
246 cleanup_bblayers(None, None)
247
248 return ret
249
250if __name__ == '__main__':
251 try:
252 ret = main()
253 except Exception:
254 ret = 1
255 import traceback
256 traceback.print_exc()
257 sys.exit(ret)