teamcity.py 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396
  1. #
  2. # TeamCity UI Implementation
  3. #
  4. # Implements a TeamCity frontend for the BitBake utility, via service messages.
  5. # See https://www.jetbrains.com/help/teamcity/build-script-interaction-with-teamcity.html
  6. #
  7. # Based on ncurses.py and knotty.py, variously by Michael Lauer and Richard Purdie
  8. #
  9. # Copyright (C) 2006 Michael 'Mickey' Lauer
  10. # Copyright (C) 2006-2012 Richard Purdie
  11. # Copyright (C) 2018-2020 Agilent Technologies, Inc.
  12. #
  13. # SPDX-License-Identifier: GPL-2.0-only
  14. #
  15. # Author: Chris Laplante <chris.laplante@agilent.com>
  16. from __future__ import division
  17. import datetime
  18. import logging
  19. import math
  20. import os
  21. import re
  22. import sys
  23. import xmlrpc.client
  24. from collections import deque
  25. import bb
  26. import bb.build
  27. import bb.command
  28. import bb.cooker
  29. import bb.event
  30. import bb.exceptions
  31. import bb.runqueue
  32. from bb.ui import uihelper
  33. logger = logging.getLogger("BitBake")
  34. class TeamCityUI:
  35. def __init__(self):
  36. self._block_stack = []
  37. self._last_progress_state = None
  38. @classmethod
  39. def escape_service_value(cls, value):
  40. """
  41. Escape a value for inclusion in a service message. TeamCity uses the vertical pipe character for escaping.
  42. See: https://confluence.jetbrains.com/display/TCD10/Build+Script+Interaction+with+TeamCity#BuildScriptInteractionwithTeamCity-Escapedvalues
  43. """
  44. return re.sub(r"(['|\[\]])", r"|\1", value).replace("\n", "|n").replace("\r", "|r")
  45. @classmethod
  46. def emit_service_message(cls, message_type, **kwargs):
  47. print(cls.format_service_message(message_type, **kwargs), flush=True)
  48. @classmethod
  49. def format_service_message(cls, message_type, **kwargs):
  50. payload = " ".join(["{0}='{1}'".format(k, cls.escape_service_value(v)) for k, v in kwargs.items()])
  51. return "##teamcity[{0} {1}]".format(message_type, payload)
  52. @classmethod
  53. def emit_simple_service_message(cls, message_type, message):
  54. print(cls.format_simple_service_message(message_type, message), flush=True)
  55. @classmethod
  56. def format_simple_service_message(cls, message_type, message):
  57. return "##teamcity[{0} '{1}']".format(message_type, cls.escape_service_value(message))
  58. @classmethod
  59. def format_build_message(cls, text, status):
  60. return cls.format_service_message("message", text=text, status=status)
  61. def block_start(self, name):
  62. self._block_stack.append(name)
  63. self.emit_service_message("blockOpened", name=name)
  64. def block_end(self):
  65. if self._block_stack:
  66. name = self._block_stack.pop()
  67. self.emit_service_message("blockClosed", name=name)
  68. def progress(self, message, percent, extra=None):
  69. now = datetime.datetime.now()
  70. percent = "{0: >3.0f}".format(percent)
  71. report = False
  72. if not self._last_progress_state \
  73. or (self._last_progress_state[0] == message
  74. and self._last_progress_state[1] != percent
  75. and (now - self._last_progress_state[2]).microseconds >= 5000) \
  76. or self._last_progress_state[0] != message:
  77. report = True
  78. self._last_progress_state = (message, percent, now)
  79. if report or percent in [0, 100]:
  80. self.emit_simple_service_message("progressMessage", "{0}: {1}%{2}".format(message, percent, extra or ""))
  81. class TeamcityLogFormatter(logging.Formatter):
  82. def format(self, record):
  83. details = ""
  84. if hasattr(record, 'bb_exc_formatted'):
  85. details = ''.join(record.bb_exc_formatted)
  86. elif hasattr(record, 'bb_exc_info'):
  87. etype, value, tb = record.bb_exc_info
  88. formatted = bb.exceptions.format_exception(etype, value, tb, limit=5)
  89. details = ''.join(formatted)
  90. if record.levelno in [bb.msg.BBLogFormatter.ERROR, bb.msg.BBLogFormatter.CRITICAL]:
  91. # ERROR gets a separate errorDetails field
  92. msg = TeamCityUI.format_service_message("message", text=record.getMessage(), status="ERROR",
  93. errorDetails=details)
  94. else:
  95. payload = record.getMessage()
  96. if details:
  97. payload += "\n" + details
  98. if record.levelno == bb.msg.BBLogFormatter.PLAIN:
  99. msg = payload
  100. elif record.levelno == bb.msg.BBLogFormatter.WARNING:
  101. msg = TeamCityUI.format_service_message("message", text=payload, status="WARNING")
  102. else:
  103. msg = TeamCityUI.format_service_message("message", text=payload, status="NORMAL")
  104. return msg
  105. _evt_list = ["bb.runqueue.runQueueExitWait", "bb.event.LogExecTTY", "logging.LogRecord",
  106. "bb.build.TaskFailed", "bb.build.TaskBase", "bb.event.ParseStarted",
  107. "bb.event.ParseProgress", "bb.event.ParseCompleted", "bb.event.CacheLoadStarted",
  108. "bb.event.CacheLoadProgress", "bb.event.CacheLoadCompleted", "bb.command.CommandFailed",
  109. "bb.command.CommandExit", "bb.command.CommandCompleted", "bb.cooker.CookerExit",
  110. "bb.event.MultipleProviders", "bb.event.NoProvider", "bb.runqueue.sceneQueueTaskStarted",
  111. "bb.runqueue.runQueueTaskStarted", "bb.runqueue.runQueueTaskFailed", "bb.runqueue.sceneQueueTaskFailed",
  112. "bb.event.BuildBase", "bb.build.TaskStarted", "bb.build.TaskSucceeded", "bb.build.TaskFailedSilent",
  113. "bb.build.TaskProgress", "bb.event.ProcessStarted", "bb.event.ProcessProgress", "bb.event.ProcessFinished"]
  114. def _log_settings_from_server(server):
  115. # Get values of variables which control our output
  116. includelogs, error = server.runCommand(["getVariable", "BBINCLUDELOGS"])
  117. if error:
  118. logger.error("Unable to get the value of BBINCLUDELOGS variable: %s" % error)
  119. raise BaseException(error)
  120. loglines, error = server.runCommand(["getVariable", "BBINCLUDELOGS_LINES"])
  121. if error:
  122. logger.error("Unable to get the value of BBINCLUDELOGS_LINES variable: %s" % error)
  123. raise BaseException(error)
  124. return includelogs, loglines
  125. def main(server, eventHandler, params):
  126. params.updateToServer(server, os.environ.copy())
  127. includelogs, loglines = _log_settings_from_server(server)
  128. ui = TeamCityUI()
  129. helper = uihelper.BBUIHelper()
  130. console = logging.StreamHandler(sys.stdout)
  131. errconsole = logging.StreamHandler(sys.stderr)
  132. format = TeamcityLogFormatter()
  133. if params.options.quiet == 0:
  134. forcelevel = None
  135. elif params.options.quiet > 2:
  136. forcelevel = bb.msg.BBLogFormatter.ERROR
  137. else:
  138. forcelevel = bb.msg.BBLogFormatter.WARNING
  139. console.setFormatter(format)
  140. errconsole.setFormatter(format)
  141. if not bb.msg.has_console_handler(logger):
  142. logger.addHandler(console)
  143. logger.addHandler(errconsole)
  144. if params.options.remote_server and params.options.kill_server:
  145. server.terminateServer()
  146. return
  147. if params.observe_only:
  148. logger.error("Observe-only mode not supported in this UI")
  149. return 1
  150. llevel, debug_domains = bb.msg.constructLogOptions()
  151. server.runCommand(["setEventMask", server.getEventHandle(), llevel, debug_domains, _evt_list])
  152. try:
  153. params.updateFromServer(server)
  154. cmdline = params.parseActions()
  155. if not cmdline:
  156. logger.error("No task given")
  157. return 1
  158. if 'msg' in cmdline and cmdline['msg']:
  159. logger.error(cmdline['msg'])
  160. return 1
  161. cmdline = cmdline['action']
  162. ret, error = server.runCommand(cmdline)
  163. if error:
  164. logger.error("{0}: {1}".format(cmdline, error))
  165. return 1
  166. elif not ret:
  167. logger.error("Couldn't get default commandline: {0}".format(re))
  168. return 1
  169. except xmlrpc.client.Fault as x:
  170. logger.error("XMLRPC Fault getting commandline: {0}".format(x))
  171. return 1
  172. active_process_total = None
  173. is_tasks_running = False
  174. while True:
  175. try:
  176. event = eventHandler.waitEvent(0.25)
  177. if not event:
  178. continue
  179. helper.eventHandler(event)
  180. if isinstance(event, bb.build.TaskBase):
  181. logger.info(event._message)
  182. if isinstance(event, logging.LogRecord):
  183. # Don't report sstate failures as errors, since Yocto will just run the tasks for real
  184. if event.msg == "No suitable staging package found" or (event.msg.startswith(
  185. "Fetcher failure: Unable to find file") and "downloadfilename" in event.msg and "sstate" in event.msg):
  186. event.levelno = bb.msg.BBLogFormatter.WARNING
  187. if event.taskpid != 0:
  188. # For "normal" logging conditions, don't show note logs from tasks
  189. # but do show them if the user has changed the default log level to
  190. # include verbose/debug messages
  191. if event.levelno <= bb.msg.BBLogFormatter.NOTE and (event.levelno < llevel or (
  192. event.levelno == bb.msg.BBLogFormatter.NOTE and llevel != bb.msg.BBLogFormatter.VERBOSE)):
  193. continue
  194. # Prefix task messages with recipe/task
  195. if event.taskpid in helper.running_tasks and event.levelno != bb.msg.BBLogFormatter.PLAIN:
  196. taskinfo = helper.running_tasks[event.taskpid]
  197. event.msg = taskinfo['title'] + ': ' + event.msg
  198. if hasattr(event, 'fn'):
  199. event.msg = event.fn + ': ' + event.msg
  200. logger.handle(event)
  201. if isinstance(event, bb.build.TaskFailedSilent):
  202. logger.warning("Logfile for failed setscene task is %s" % event.logfile)
  203. continue
  204. if isinstance(event, bb.build.TaskFailed):
  205. rt = "{0}-{1}:{2}".format(event.pn, event.pv.replace("AUTOINC", "0"), event.task)
  206. logfile = event.logfile
  207. if not logfile or not os.path.exists(logfile):
  208. TeamCityUI.emit_service_message("buildProblem", description="{0}\nUnknown failure (no log file available)".format(rt))
  209. if not event.task.endswith("_setscene"):
  210. server.runCommand(["stateForceShutdown"])
  211. continue
  212. details = deque(maxlen=loglines)
  213. error_lines = []
  214. if includelogs and not event.errprinted:
  215. with open(logfile, "r") as f:
  216. while True:
  217. line = f.readline()
  218. if not line:
  219. break
  220. line = line.rstrip()
  221. details.append(' | %s' % line)
  222. # TODO: a less stupid check for errors
  223. if (event.task == "do_compile") and ("error:" in line):
  224. error_lines.append(line)
  225. if error_lines:
  226. TeamCityUI.emit_service_message("compilationStarted", compiler=rt)
  227. for line in error_lines:
  228. TeamCityUI.emit_service_message("message", text=line, status="ERROR")
  229. TeamCityUI.emit_service_message("compilationFinished", compiler=rt)
  230. else:
  231. TeamCityUI.emit_service_message("buildProblem", description=rt)
  232. err = "Logfile of failure stored in: %s" % logfile
  233. if details:
  234. ui.block_start("{0} task log".format(rt))
  235. # TeamCity seems to choke on service messages longer than about 63800 characters, so if error
  236. # details is longer than, say, 60000, batch it up into several messages.
  237. first_message = True
  238. while details:
  239. detail_len = 0
  240. batch = deque()
  241. while details and detail_len < 60000:
  242. # TODO: This code doesn't bother to handle lines that themselves are extremely long.
  243. line = details.popleft()
  244. batch.append(line)
  245. detail_len += len(line)
  246. if first_message:
  247. batch.appendleft("Log data follows:")
  248. first_message = False
  249. TeamCityUI.emit_service_message("message", text=err, status="ERROR",
  250. errorDetails="\n".join(batch))
  251. else:
  252. TeamCityUI.emit_service_message("message", text="[continued]", status="ERROR",
  253. errorDetails="\n".join(batch))
  254. ui.block_end()
  255. else:
  256. TeamCityUI.emit_service_message("message", text=err, status="ERROR", errorDetails="")
  257. if not event.task.endswith("_setscene"):
  258. server.runCommand(["stateForceShutdown"])
  259. if isinstance(event, bb.event.ProcessStarted):
  260. if event.processname in ["Initialising tasks", "Checking sstate mirror object availability"]:
  261. active_process_total = event.total
  262. ui.block_start(event.processname)
  263. if isinstance(event, bb.event.ProcessFinished):
  264. if event.processname in ["Initialising tasks", "Checking sstate mirror object availability"]:
  265. ui.progress(event.processname, 100)
  266. ui.block_end()
  267. if isinstance(event, bb.event.ProcessProgress):
  268. if event.processname in ["Initialising tasks",
  269. "Checking sstate mirror object availability"] and active_process_total != 0:
  270. ui.progress(event.processname, event.progress * 100 / active_process_total)
  271. if isinstance(event, bb.event.CacheLoadStarted):
  272. ui.block_start("Loading cache")
  273. if isinstance(event, bb.event.CacheLoadProgress):
  274. if event.total != 0:
  275. ui.progress("Loading cache", math.floor(event.current * 100 / event.total))
  276. if isinstance(event, bb.event.CacheLoadCompleted):
  277. ui.progress("Loading cache", 100)
  278. ui.block_end()
  279. if isinstance(event, bb.event.ParseStarted):
  280. ui.block_start("Parsing recipes and checking upstream revisions")
  281. if isinstance(event, bb.event.ParseProgress):
  282. if event.total != 0:
  283. ui.progress("Parsing recipes", math.floor(event.current * 100 / event.total))
  284. if isinstance(event, bb.event.ParseCompleted):
  285. ui.progress("Parsing recipes", 100)
  286. ui.block_end()
  287. if isinstance(event, bb.command.CommandCompleted):
  288. return
  289. if isinstance(event, bb.command.CommandFailed):
  290. logger.error(str(event))
  291. return 1
  292. if isinstance(event, bb.event.MultipleProviders):
  293. logger.warning(str(event))
  294. continue
  295. if isinstance(event, bb.event.NoProvider):
  296. logger.error(str(event))
  297. continue
  298. if isinstance(event, bb.command.CommandExit):
  299. return
  300. if isinstance(event, bb.cooker.CookerExit):
  301. return
  302. if isinstance(event, bb.runqueue.sceneQueueTaskStarted):
  303. if not is_tasks_running:
  304. is_tasks_running = True
  305. ui.block_start("Running tasks")
  306. if event.stats.total != 0:
  307. ui.progress("Running setscene tasks", (
  308. event.stats.completed + event.stats.active + event.stats.failed + 1) * 100 / event.stats.total)
  309. if isinstance(event, bb.runqueue.runQueueTaskStarted):
  310. if not is_tasks_running:
  311. is_tasks_running = True
  312. ui.block_start("Running tasks")
  313. if event.stats.total != 0:
  314. pseudo_total = event.stats.total - event.stats.skipped
  315. pseudo_complete = event.stats.completed + event.stats.active - event.stats.skipped + event.stats.failed + 1
  316. # TODO: sometimes this gives over 100%
  317. ui.progress("Running runqueue tasks", (pseudo_complete) * 100 / pseudo_total,
  318. " ({0}/{1})".format(pseudo_complete, pseudo_total))
  319. if isinstance(event, bb.runqueue.sceneQueueTaskFailed):
  320. logger.warning(str(event))
  321. continue
  322. if isinstance(event, bb.runqueue.runQueueTaskFailed):
  323. logger.error(str(event))
  324. return 1
  325. if isinstance(event, bb.event.LogExecTTY):
  326. pass
  327. except EnvironmentError as ioerror:
  328. # ignore interrupted io
  329. if ioerror.args[0] == 4:
  330. pass
  331. except Exception as ex:
  332. logger.error(str(ex))
  333. # except KeyboardInterrupt:
  334. # if shutdown == 2:
  335. # mw.appendText("Third Keyboard Interrupt, exit.\n")
  336. # exitflag = True
  337. # if shutdown == 1:
  338. # mw.appendText("Second Keyboard Interrupt, stopping...\n")
  339. # _, error = server.runCommand(["stateForceShutdown"])
  340. # if error:
  341. # print("Unable to cleanly stop: %s" % error)
  342. # if shutdown == 0:
  343. # mw.appendText("Keyboard Interrupt, closing down...\n")
  344. # _, error = server.runCommand(["stateShutdown"])
  345. # if error:
  346. # print("Unable to cleanly shutdown: %s" % error)
  347. # shutdown = shutdown + 1
  348. # pass