yocto-check-layer 8.2 KB

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