summaryrefslogtreecommitdiffstats
path: root/meta/classes/report-error.bbclass
blob: ff2c98e5d85d9db4ee7ec7cd8a2c963809224074 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
#
# Collects debug information in order to create error report files.
#
# Copyright (C) 2013 Intel Corporation
# Author: Andreea Brandusa Proca <andreea.b.proca@intel.com>
#
# Licensed under the MIT license, see COPYING.MIT for details

ERR_REPORT_DIR ?= "${LOG_DIR}/error-report"
ERR_REPORT_PORT ?= "80"

ERR_REPORT_UPLOAD_FAILURES[type] = "boolean"
ERR_REPORT_UPLOAD_FAILURES ?= "0"
ERR_REPORT_UPLOAD_ALL[type] = "boolean"
ERR_REPORT_UPLOAD_ALL ?= "0"

def errorreport_getdata(e):
    logpath = e.data.getVar('ERR_REPORT_DIR', True)
    datafile = os.path.join(logpath, "error-report.txt")
    with open(datafile) as f:
        data = f.read()
    return data

def errorreport_savedata(e, newdata, file):
    import json
    logpath = e.data.getVar('ERR_REPORT_DIR', True)
    bb.utils.mkdirhier(logpath)
    datafile = os.path.join(logpath, file)
    with open(datafile, "w") as f:
        json.dump(newdata, f, indent=4, sort_keys=True)
    return datafile

def errorreport_get_user_info(e):
    """
    Read user info from variables or from git config
    """
    import subprocess
    username = e.data.getVar('ERR_REPORT_USERNAME', True)
    email = e.data.getVar('ERR_REPORT_EMAIL', True)
    if not username or email:
        # try to read them from git config
        username = subprocess.check_output(['git', 'config', '--get', 'user.name']).strip()
        email = subprocess.check_output(['git', 'config', '--get', 'user.email']).strip()
    return (username, email)

def errorreport_get_submit_info(e):
    """
    Read submit info from ~/.oe-send-error or ask interactively and save it there.
    """
    home = os.path.expanduser("~")
    userfile = os.path.join(home, ".oe-send-error")
    if os.path.isfile(userfile):
        with open(userfile) as g:
            username = g.readline()
            email = g.readline()
    else:
        print("Please enter your name and your email (optionally), they'll be saved in the file you send.")
        username = raw_input("Name: ")
        email = raw_input("E-mail (not required): ")
        server = raw_input("Server: ")
        port = raw_input("Port: ")
        if len(username) > 0 and len(username) < 50:
            with open(userfile, "w") as g:
                g.write(username + "\n")
                g.write(email + "\n")
                g.write(server + "\n")
                g.write(port + "\n")
        else:
            print("Invalid inputs, try again.")
            return errorreport_get_submit_info()
        return (username, email, server, port)

def errorreport_senddata(e, json_file):
    """
    From scripts/send-error-report to automate report submissions.
    """

    import httplib, urllib, os, sys, json, subprocess

    if os.path.isfile(json_file):
        server = e.data.getVar('ERR_REPORT_SERVER', True)
        port = e.data.getVar('ERR_REPORT_PORT', True)
        bb.note("Uploading the report %s to %s:%s" % (json_file, server, port))

        with open(json_file) as f:
            data = f.read()

        try:
            jsondata = json.loads(data)
            if not jsondata['username'] or not server:
                (username, email, server, port) = errorreport_get_submit_info(e)
                jsondata['username'] = username.strip()
                jsondata['email'] = email.strip()
            data = json.dumps(jsondata, indent=4, sort_keys=True)
        except:
            bb.error("Invalid json data")
            return

        try:
            params = urllib.urlencode({'data': data})
            headers = {"Content-type": "application/json"}
            conn = httplib.HTTPConnection(server, port)
            conn.request("POST", "/ClientPost/", params, headers)
            response = conn.getresponse()
            res = response.read()
            if response.status == 200:
                bb.note(res)
            else:
                bb.warn("There was a problem submiting your data, response written in %s.response.html" % json_file)
                with open("%s.response.html" % json_file, "w") as f:
                    f.write(res)
            conn.close()
        except:
            bb.warn("Server connection failed")

    else:
        bb.warn("No data file found.")

python errorreport_handler () {
        import json

        if isinstance(e, bb.event.BuildStarted):
            data = {}
            machine = e.data.getVar("MACHINE")
            data['machine'] = machine
            data['build_sys'] = e.data.getVar("BUILD_SYS", True)
            data['nativelsb'] = e.data.getVar("NATIVELSBSTRING")
            data['distro'] = e.data.getVar("DISTRO")
            data['target_sys'] = e.data.getVar("TARGET_SYS", True)
            data['failures'] = []
            data['component'] = e.getPkgs()[0]
            data['branch_commit'] = base_detect_branch(e.data) + ": " + base_detect_revision(e.data)
            (username, email) = errorreport_get_user_info(e)
            data['username'] = username.strip()
            data['email'] = email.strip()
            errorreport_savedata(e, data, "error-report.txt")

        elif isinstance(e, bb.build.TaskFailed):
            task = e.task
            taskdata={}
            log = e.data.getVar('BB_LOGFILE', True)
            taskdata['package'] = e.data.expand("${PF}")
            taskdata['task'] = task
            if log:
                logFile = open(log, 'r')
                taskdata['log'] = logFile.read()
                logFile.close()
            else:
                taskdata['log'] = "No Log"
            jsondata = json.loads(errorreport_getdata(e))
            jsondata['failures'].append(taskdata)
            errorreport_savedata(e, jsondata, "error-report.txt")

        elif isinstance(e, bb.event.BuildCompleted):
            jsondata = json.loads(errorreport_getdata(e))
            upload_failures = oe.data.typed_value('ERR_REPORT_UPLOAD_FAILURES', e.data)
            upload_all = oe.data.typed_value('ERR_REPORT_UPLOAD_ALL', e.data)
            failures = jsondata['failures']
            if failures or upload_all:
                filename = "error_report_" + e.data.getVar("BUILDNAME")+".txt"
                datafile = errorreport_savedata(e, jsondata, filename)
                if upload_all or (failures and upload_failures):
                    errorreport_senddata(e, datafile)
		else:
                    bb.note("The errors for this build are stored in %s\nYou can send the errors to an upstream server by running:\n  send-error-report %s [server]" % (datafile, datafile))
                    bb.note("The contents of these logs will be posted in public if you use the above command with the default server. If you need to do so, please ensure you remove any identifying or proprietary information before sending.")
}

addhandler errorreport_handler
errorreport_handler[eventmask] = "bb.event.BuildStarted bb.event.BuildCompleted bb.build.TaskFailed"