56547781349d8b0facde4883ff948cac7162287f
[WebKit-https.git] / Tools / Scripts / webkitpy / common / net / statusserver.py
1 # Copyright (C) 2009 Google Inc. All rights reserved.
2 #
3 # Redistribution and use in source and binary forms, with or without
4 # modification, are permitted provided that the following conditions are
5 # met:
6 #
7 #     * Redistributions of source code must retain the above copyright
8 # notice, this list of conditions and the following disclaimer.
9 #     * Redistributions in binary form must reproduce the above
10 # copyright notice, this list of conditions and the following disclaimer
11 # in the documentation and/or other materials provided with the
12 # distribution.
13 #     * Neither the name of Google Inc. nor the names of its
14 # contributors may be used to endorse or promote products derived from
15 # this software without specific prior written permission.
16 #
17 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 #
29 # This the client designed to talk to Tools/QueueStatusServer.
30
31 from webkitpy.common.net.networktransaction import NetworkTransaction
32 from webkitpy.thirdparty.BeautifulSoup import BeautifulSoup
33 from webkitpy.common.config.urls import statusserver_default_host
34
35 import logging
36 import urllib2
37
38 _log = logging.getLogger(__name__)
39
40
41 class StatusServer:
42     def __init__(self, host=statusserver_default_host, browser=None, bot_id=None):
43         self.set_host(host)
44         from webkitpy.thirdparty.autoinstalled.mechanize import Browser
45         self._browser = browser or Browser()
46         self._browser.set_handle_robots(False)
47         self.set_bot_id(bot_id)
48
49     def set_host(self, host):
50         self.host = host
51         self.url = "http://%s" % self.host
52
53     def set_bot_id(self, bot_id):
54         self.bot_id = bot_id
55
56     def results_url_for_status(self, status_id):
57         return "%s/results/%s" % (self.url, status_id)
58
59     def _add_patch(self, patch):
60         if not patch:
61             return
62         if patch.bug_id():
63             self._browser["bug_id"] = unicode(patch.bug_id())
64         if patch.id():
65             self._browser["patch_id"] = unicode(patch.id())
66
67     def _add_results_file(self, results_file):
68         if not results_file:
69             return
70         self._browser.add_file(results_file, "text/plain", "results.txt", 'results_file')
71
72     # 500 is the AppEngine limit for TEXT fields (which most of our fields are).
73     # Exceeding the limit will result in a 500 error from the server.
74     def _set_field(self, field_name, value, limit=500):
75         if len(value) > limit:
76             _log.warn("Attempted to set %s to value exceeding %s characters, truncating." % (field_name, limit))
77         self._browser[field_name] = value[:limit]
78
79     def _post_status_to_server(self, queue_name, status, patch, results_file):
80         if results_file:
81             # We might need to re-wind the file if we've already tried to post it.
82             results_file.seek(0)
83
84         update_status_url = "%s/update-status" % self.url
85         self._browser.open(update_status_url)
86         self._browser.select_form(name="update_status")
87         self._browser["queue_name"] = queue_name
88         if self.bot_id:
89             self._browser["bot_id"] = self.bot_id
90         self._add_patch(patch)
91         self._set_field("status", status, limit=500)
92         self._add_results_file(results_file)
93         return self._browser.submit().read()  # This is the id of the newly created status object.
94
95     def _post_svn_revision_to_server(self, svn_revision_number, broken_bot):
96         update_svn_revision_url = "%s/update-svn-revision" % self.url
97         self._browser.open(update_svn_revision_url)
98         self._browser.select_form(name="update_svn_revision")
99         self._browser["number"] = unicode(svn_revision_number)
100         self._browser["broken_bot"] = broken_bot
101         return self._browser.submit().read()
102
103     def _post_work_items_to_server(self, queue_name, high_priority_work_items, work_items):
104         update_work_items_url = "%s/update-work-items" % self.url
105         self._browser.open(update_work_items_url)
106         self._browser.select_form(name="update_work_items")
107         self._browser["queue_name"] = queue_name
108         work_items = map(unicode, work_items)  # .join expects strings
109         self._browser["work_items"] = " ".join(work_items)
110         high_priority_work_items = map(unicode, high_priority_work_items)
111         self._browser["high_priority_work_items"] = " ".join(high_priority_work_items)
112         return self._browser.submit().read()
113
114     def _post_work_item_to_ews(self, attachment_id):
115         submit_to_ews_url = "%s/submit-to-ews" % self.url
116         self._browser.open(submit_to_ews_url)
117         self._browser.select_form(name="submit_to_ews")
118         self._browser["attachment_id"] = unicode(attachment_id)
119         self._browser.submit()
120
121     def submit_to_ews(self, attachment_id):
122         _log.info("Submitting attachment %s to EWS queues" % attachment_id)
123         return NetworkTransaction().run(lambda: self._post_work_item_to_ews(attachment_id))
124
125     def next_work_item(self, queue_name):
126         _log.info("Fetching next work item for %s" % queue_name)
127         next_patch_url = "%s/next-patch/%s" % (self.url, queue_name)
128         return self._fetch_url(next_patch_url)
129
130     def _post_release_work_item(self, queue_name, patch):
131         release_patch_url = "%s/release-patch" % (self.url)
132         self._browser.open(release_patch_url)
133         self._browser.select_form(name="release_patch")
134         self._browser["queue_name"] = queue_name
135         self._browser["attachment_id"] = unicode(patch.id())
136         self._browser.submit()
137
138     def release_work_item(self, queue_name, patch):
139         _log.info("Releasing work item %s from %s" % (patch.id(), queue_name))
140         return NetworkTransaction(convert_404_to_None=True).run(lambda: self._post_release_work_item(queue_name, patch))
141
142     def _post_release_lock(self, queue_name, patch):
143         release_lock_url = "%s/release-lock" % (self.url)
144         self._browser.open(release_lock_url)
145         self._browser.select_form(name="release_lock")
146         self._browser["queue_name"] = queue_name
147         self._browser["attachment_id"] = unicode(patch.id())
148         self._browser.submit()
149
150     def release_lock(self, queue_name, patch):
151         _log.info("Releasing lock for work item %s from %s" % (patch.id(), queue_name))
152         return NetworkTransaction(convert_404_to_None=True).run(lambda: self._post_release_lock(queue_name, patch))
153
154     def update_work_items(self, queue_name, high_priority_work_items, work_items):
155         _log.info("Recording work items: %s for %s" % (high_priority_work_items + work_items, queue_name))
156         return NetworkTransaction().run(lambda: self._post_work_items_to_server(queue_name, high_priority_work_items, work_items))
157
158     def update_status(self, queue_name, status, patch=None, results_file=None):
159         _log.info(status)
160         return NetworkTransaction().run(lambda: self._post_status_to_server(queue_name, status, patch, results_file))
161
162     def update_svn_revision(self, svn_revision_number, broken_bot):
163         _log.info("SVN revision: %s broke %s" % (svn_revision_number, broken_bot))
164         return NetworkTransaction().run(lambda: self._post_svn_revision_to_server(svn_revision_number, broken_bot))
165
166     def _fetch_url(self, url):
167         # FIXME: This should use NetworkTransaction's 404 handling instead.
168         try:
169             return urllib2.urlopen(url).read()
170         except urllib2.HTTPError, e:
171             if e.code == 404:
172                 return None
173             raise e
174
175     def patch_status(self, queue_name, patch_id):
176         patch_status_url = "%s/patch-status/%s/%s" % (self.url, queue_name, patch_id)
177         return self._fetch_url(patch_status_url)
178
179     def svn_revision(self, svn_revision_number):
180         svn_revision_url = "%s/svn-revision/%s" % (self.url, svn_revision_number)
181         return self._fetch_url(svn_revision_url)