yocto-check-layer 8.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224
  1. #!/usr/bin/env python3
  2. # Yocto Project layer checking tool
  3. #
  4. # Copyright (C) 2017 Intel Corporation
  5. #
  6. # SPDX-License-Identifier: MIT
  7. #
  8. import os
  9. import sys
  10. import argparse
  11. import logging
  12. import time
  13. import signal
  14. import shutil
  15. import collections
  16. scripts_path = os.path.dirname(os.path.realpath(__file__))
  17. lib_path = scripts_path + '/lib'
  18. sys.path = sys.path + [lib_path]
  19. import scriptutils
  20. import scriptpath
  21. scriptpath.add_oe_lib_path()
  22. scriptpath.add_bitbake_lib_path()
  23. from checklayer import LayerType, detect_layers, add_layers, add_layer_dependencies, get_signatures, check_bblayers
  24. from oeqa.utils.commands import get_bb_vars
  25. PROGNAME = 'yocto-check-layer'
  26. CASES_PATHS = [os.path.join(os.path.abspath(os.path.dirname(__file__)),
  27. 'lib', 'checklayer', 'cases')]
  28. logger = scriptutils.logger_create(PROGNAME, stream=sys.stdout)
  29. def test_layer(td, layer, test_software_layer_signatures):
  30. from checklayer.context import CheckLayerTestContext
  31. logger.info("Starting to analyze: %s" % layer['name'])
  32. logger.info("----------------------------------------------------------------------")
  33. tc = CheckLayerTestContext(td=td, logger=logger, layer=layer, test_software_layer_signatures=test_software_layer_signatures)
  34. tc.loadTests(CASES_PATHS)
  35. return tc.runTests()
  36. def main():
  37. parser = argparse.ArgumentParser(
  38. description="Yocto Project layer checking tool",
  39. add_help=False)
  40. parser.add_argument('layers', metavar='LAYER_DIR', nargs='+',
  41. help='Layer to check')
  42. parser.add_argument('-o', '--output-log',
  43. help='File to output log (optional)', action='store')
  44. parser.add_argument('--dependency', nargs="+",
  45. help='Layers to process for dependencies', action='store')
  46. parser.add_argument('--machines', nargs="+",
  47. help='List of MACHINEs to be used during testing', action='store')
  48. parser.add_argument('--additional-layers', nargs="+",
  49. help='List of additional layers to add during testing', action='store')
  50. group = parser.add_mutually_exclusive_group()
  51. group.add_argument('--with-software-layer-signature-check', action='store_true', dest='test_software_layer_signatures',
  52. default=True,
  53. help='check that software layers do not change signatures (on by default)')
  54. group.add_argument('--without-software-layer-signature-check', action='store_false', dest='test_software_layer_signatures',
  55. help='disable signature checking for software layers')
  56. parser.add_argument('-n', '--no-auto', help='Disable auto layer discovery',
  57. action='store_true')
  58. parser.add_argument('-d', '--debug', help='Enable debug output',
  59. action='store_true')
  60. parser.add_argument('-q', '--quiet', help='Print only errors',
  61. action='store_true')
  62. parser.add_argument('-h', '--help', action='help',
  63. default=argparse.SUPPRESS,
  64. help='show this help message and exit')
  65. args = parser.parse_args()
  66. if args.output_log:
  67. fh = logging.FileHandler(args.output_log)
  68. fh.setFormatter(logging.Formatter("%(levelname)s: %(message)s"))
  69. logger.addHandler(fh)
  70. if args.debug:
  71. logger.setLevel(logging.DEBUG)
  72. elif args.quiet:
  73. logger.setLevel(logging.ERROR)
  74. if not 'BUILDDIR' in os.environ:
  75. logger.error("You must source the environment before running this script.")
  76. logger.error("$ source oe-init-build-env")
  77. return 1
  78. builddir = os.environ['BUILDDIR']
  79. bblayersconf = os.path.join(builddir, 'conf', 'bblayers.conf')
  80. layers = detect_layers(args.layers, args.no_auto)
  81. if not layers:
  82. logger.error("Failed to detect layers")
  83. return 1
  84. if args.additional_layers:
  85. additional_layers = detect_layers(args.additional_layers, args.no_auto)
  86. else:
  87. additional_layers = []
  88. if args.dependency:
  89. dep_layers = detect_layers(args.dependency, args.no_auto)
  90. dep_layers = dep_layers + layers
  91. else:
  92. dep_layers = layers
  93. logger.info("Detected layers:")
  94. for layer in layers:
  95. if layer['type'] == LayerType.ERROR_BSP_DISTRO:
  96. logger.error("%s: Can't be DISTRO and BSP type at the same time."\
  97. " Both conf/distro and conf/machine folders were found."\
  98. % layer['name'])
  99. layers.remove(layer)
  100. elif layer['type'] == LayerType.ERROR_NO_LAYER_CONF:
  101. logger.error("%s: Don't have conf/layer.conf file."\
  102. % layer['name'])
  103. layers.remove(layer)
  104. else:
  105. logger.info("%s: %s, %s" % (layer['name'], layer['type'],
  106. layer['path']))
  107. if not layers:
  108. return 1
  109. shutil.copyfile(bblayersconf, bblayersconf + '.backup')
  110. def cleanup_bblayers(signum, frame):
  111. shutil.copyfile(bblayersconf + '.backup', bblayersconf)
  112. os.unlink(bblayersconf + '.backup')
  113. signal.signal(signal.SIGTERM, cleanup_bblayers)
  114. signal.signal(signal.SIGINT, cleanup_bblayers)
  115. td = {}
  116. results = collections.OrderedDict()
  117. results_status = collections.OrderedDict()
  118. layers_tested = 0
  119. for layer in layers:
  120. if layer['type'] == LayerType.ERROR_NO_LAYER_CONF or \
  121. layer['type'] == LayerType.ERROR_BSP_DISTRO:
  122. continue
  123. if check_bblayers(bblayersconf, layer['path'], logger):
  124. logger.info("%s already in %s. To capture initial signatures, layer under test should not present "
  125. "in BBLAYERS. Please remove %s from BBLAYERS." % (layer['name'], bblayersconf, layer['name']))
  126. results[layer['name']] = None
  127. results_status[layer['name']] = 'SKIPPED (Layer under test should not present in BBLAYERS)'
  128. continue
  129. logger.info('')
  130. logger.info("Setting up for %s(%s), %s" % (layer['name'], layer['type'],
  131. layer['path']))
  132. shutil.copyfile(bblayersconf + '.backup', bblayersconf)
  133. missing_dependencies = not add_layer_dependencies(bblayersconf, layer, dep_layers, logger)
  134. if not missing_dependencies:
  135. for additional_layer in additional_layers:
  136. if not add_layer_dependencies(bblayersconf, additional_layer, dep_layers, logger):
  137. missing_dependencies = True
  138. break
  139. if not add_layer_dependencies(bblayersconf, layer, dep_layers, logger) or \
  140. any(map(lambda additional_layer: not add_layer_dependencies(bblayersconf, additional_layer, dep_layers, logger),
  141. additional_layers)):
  142. logger.info('Skipping %s due to missing dependencies.' % layer['name'])
  143. results[layer['name']] = None
  144. results_status[layer['name']] = 'SKIPPED (Missing dependencies)'
  145. layers_tested = layers_tested + 1
  146. continue
  147. if any(map(lambda additional_layer: not add_layers(bblayersconf, [additional_layer], logger),
  148. additional_layers)):
  149. logger.info('Skipping %s due to missing additional layers.' % layer['name'])
  150. results[layer['name']] = None
  151. results_status[layer['name']] = 'SKIPPED (Missing additional layers)'
  152. layers_tested = layers_tested + 1
  153. continue
  154. logger.info('Getting initial bitbake variables ...')
  155. td['bbvars'] = get_bb_vars()
  156. logger.info('Getting initial signatures ...')
  157. td['builddir'] = builddir
  158. try:
  159. td['sigs'], td['tunetasks'] = get_signatures(td['builddir'])
  160. except RuntimeError as e:
  161. logger.info(str(e))
  162. results[layer['name']] = None
  163. results_status[layer['name']] = 'FAIL (Generating world signatures)'
  164. layers_tested = layers_tested + 1
  165. continue
  166. td['machines'] = args.machines
  167. if not add_layers(bblayersconf, [layer], logger):
  168. logger.info('Skipping %s ???.' % layer['name'])
  169. results[layer['name']] = None
  170. results_status[layer['name']] = 'SKIPPED (Unknown)'
  171. layers_tested = layers_tested + 1
  172. continue
  173. result = test_layer(td, layer, args.test_software_layer_signatures)
  174. results[layer['name']] = result
  175. results_status[layer['name']] = 'PASS' if results[layer['name']].wasSuccessful() else 'FAIL'
  176. layers_tested = layers_tested + 1
  177. ret = 0
  178. if layers_tested:
  179. logger.info('')
  180. logger.info('Summary of results:')
  181. logger.info('')
  182. for layer_name in results_status:
  183. logger.info('%s ... %s' % (layer_name, results_status[layer_name]))
  184. if not results[layer_name] or not results[layer_name].wasSuccessful():
  185. ret = 2 # ret = 1 used for initialization errors
  186. cleanup_bblayers(None, None)
  187. return ret
  188. if __name__ == '__main__':
  189. try:
  190. ret = main()
  191. except Exception:
  192. ret = 1
  193. import traceback
  194. traceback.print_exc()
  195. sys.exit(ret)