blob: 6866d47370dafa45d9c2b4f4660679f3971770ad [file] [log] [blame]
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001#
2# Collects debug information in order to create error report files.
3#
4# Copyright (C) 2013 Intel Corporation
5# Author: Andreea Brandusa Proca <andreea.b.proca@intel.com>
6#
7# Licensed under the MIT license, see COPYING.MIT for details
8
9ERR_REPORT_DIR ?= "${LOG_DIR}/error-report"
10
11def errorreport_getdata(e):
Patrick Williamsf1e5d692016-03-30 15:21:19 -050012 import codecs
Brad Bishop6e60e8b2018-02-01 10:27:11 -050013 logpath = e.data.getVar('ERR_REPORT_DIR')
Patrick Williamsc124f4f2015-09-15 14:41:29 -050014 datafile = os.path.join(logpath, "error-report.txt")
Patrick Williamsf1e5d692016-03-30 15:21:19 -050015 with codecs.open(datafile, 'r', 'utf-8') as f:
Patrick Williamsc124f4f2015-09-15 14:41:29 -050016 data = f.read()
17 return data
18
19def errorreport_savedata(e, newdata, file):
20 import json
Patrick Williamsf1e5d692016-03-30 15:21:19 -050021 import codecs
Brad Bishop6e60e8b2018-02-01 10:27:11 -050022 logpath = e.data.getVar('ERR_REPORT_DIR')
Patrick Williamsc124f4f2015-09-15 14:41:29 -050023 datafile = os.path.join(logpath, file)
Patrick Williamsf1e5d692016-03-30 15:21:19 -050024 with codecs.open(datafile, 'w', 'utf-8') as f:
Patrick Williamsc124f4f2015-09-15 14:41:29 -050025 json.dump(newdata, f, indent=4, sort_keys=True)
26 return datafile
27
Brad Bishopa34c0302019-09-23 22:34:48 -040028def get_conf_data(e, filename):
29 builddir = e.data.getVar('TOPDIR')
30 filepath = os.path.join(builddir, "conf", filename)
31 jsonstring = ""
32 if os.path.exists(filepath):
33 with open(filepath, 'r') as f:
34 for line in f.readlines():
35 if line.startswith("#") or len(line.strip()) == 0:
36 continue
37 else:
38 jsonstring=jsonstring + line
39 return jsonstring
40
Patrick Williamsc124f4f2015-09-15 14:41:29 -050041python errorreport_handler () {
42 import json
Patrick Williamsf1e5d692016-03-30 15:21:19 -050043 import codecs
Patrick Williamsc124f4f2015-09-15 14:41:29 -050044
Brad Bishopd7bf8c12018-02-25 22:55:05 -050045 def nativelsb():
46 nativelsbstr = e.data.getVar("NATIVELSBSTRING")
47 # provide a bit more host info in case of uninative build
48 if e.data.getVar('UNINATIVE_URL') != 'unset':
49 return '/'.join([nativelsbstr, lsb_distro_identifier(e.data)])
50 return nativelsbstr
51
Brad Bishop6e60e8b2018-02-01 10:27:11 -050052 logpath = e.data.getVar('ERR_REPORT_DIR')
Patrick Williamsc124f4f2015-09-15 14:41:29 -050053 datafile = os.path.join(logpath, "error-report.txt")
54
55 if isinstance(e, bb.event.BuildStarted):
56 bb.utils.mkdirhier(logpath)
57 data = {}
Brad Bishop6e60e8b2018-02-01 10:27:11 -050058 machine = e.data.getVar("MACHINE")
Patrick Williamsc124f4f2015-09-15 14:41:29 -050059 data['machine'] = machine
Brad Bishop6e60e8b2018-02-01 10:27:11 -050060 data['build_sys'] = e.data.getVar("BUILD_SYS")
Brad Bishopd7bf8c12018-02-25 22:55:05 -050061 data['nativelsb'] = nativelsb()
Brad Bishop6e60e8b2018-02-01 10:27:11 -050062 data['distro'] = e.data.getVar("DISTRO")
63 data['target_sys'] = e.data.getVar("TARGET_SYS")
Patrick Williamsc124f4f2015-09-15 14:41:29 -050064 data['failures'] = []
Patrick Williamsc0f7c042017-02-23 20:41:17 -060065 data['component'] = " ".join(e.getPkgs())
Andrew Geissler78b72792022-06-14 06:47:25 -050066 data['branch_commit'] = str(oe.buildcfg.detect_branch(e.data)) + ": " + str(oe.buildcfg.detect_revision(e.data))
Andrew Geissler90fd73c2021-03-05 15:25:55 -060067 data['bitbake_version'] = e.data.getVar("BB_VERSION")
68 data['layer_version'] = get_layers_branch_rev(e.data)
Brad Bishopa34c0302019-09-23 22:34:48 -040069 data['local_conf'] = get_conf_data(e, 'local.conf')
70 data['auto_conf'] = get_conf_data(e, 'auto.conf')
Patrick Williamsc124f4f2015-09-15 14:41:29 -050071 lock = bb.utils.lockfile(datafile + '.lock')
72 errorreport_savedata(e, data, "error-report.txt")
73 bb.utils.unlockfile(lock)
74
75 elif isinstance(e, bb.build.TaskFailed):
76 task = e.task
77 taskdata={}
Brad Bishop6e60e8b2018-02-01 10:27:11 -050078 log = e.data.getVar('BB_LOGFILE')
Patrick Williamsc124f4f2015-09-15 14:41:29 -050079 taskdata['package'] = e.data.expand("${PF}")
80 taskdata['task'] = task
81 if log:
82 try:
Brad Bishop64c979e2019-11-04 13:55:29 -050083 with codecs.open(log, encoding='utf-8') as logFile:
84 logdata = logFile.read()
Patrick Williamsc0f7c042017-02-23 20:41:17 -060085 # Replace host-specific paths so the logs are cleaner
86 for d in ("TOPDIR", "TMPDIR"):
Brad Bishop6e60e8b2018-02-01 10:27:11 -050087 s = e.data.getVar(d)
Patrick Williamsc0f7c042017-02-23 20:41:17 -060088 if s:
89 logdata = logdata.replace(s, d)
Patrick Williamsc124f4f2015-09-15 14:41:29 -050090 except:
91 logdata = "Unable to read log file"
Patrick Williamsc124f4f2015-09-15 14:41:29 -050092 else:
93 logdata = "No Log"
94
95 # server will refuse failures longer than param specified in project.settings.py
96 # MAX_UPLOAD_SIZE = "5242880"
97 # use lower value, because 650 chars can be spent in task, package, version
98 max_logdata_size = 5242000
99 # upload last max_logdata_size characters
100 if len(logdata) > max_logdata_size:
101 logdata = "..." + logdata[-max_logdata_size:]
102 taskdata['log'] = logdata
103 lock = bb.utils.lockfile(datafile + '.lock')
104 jsondata = json.loads(errorreport_getdata(e))
105 jsondata['failures'].append(taskdata)
106 errorreport_savedata(e, jsondata, "error-report.txt")
107 bb.utils.unlockfile(lock)
108
109 elif isinstance(e, bb.event.BuildCompleted):
110 lock = bb.utils.lockfile(datafile + '.lock')
111 jsondata = json.loads(errorreport_getdata(e))
112 bb.utils.unlockfile(lock)
113 failures = jsondata['failures']
114 if(len(failures) > 0):
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500115 filename = "error_report_" + e.data.getVar("BUILDNAME")+".txt"
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500116 datafile = errorreport_savedata(e, jsondata, filename)
117 bb.note("The errors for this build are stored in %s\nYou can send the errors to a reports server by running:\n send-error-report %s [-s server]" % (datafile, datafile))
118 bb.note("The contents of these logs will be posted in public if you use the above command with the default server. Please ensure you remove any identifying or proprietary information when prompted before sending.")
119}
120
121addhandler errorreport_handler
122errorreport_handler[eventmask] = "bb.event.BuildStarted bb.event.BuildCompleted bb.build.TaskFailed"