##// END OF EJS Templates
logging: remove bad logging on slack/hipchat.
marcink -
r936:5e47f887 default
parent child Browse files
Show More
@@ -1,255 +1,254 b''
1 # -*- coding: utf-8 -*-
1 # -*- coding: utf-8 -*-
2
2
3 # Copyright (C) 2012-2016 RhodeCode GmbH
3 # Copyright (C) 2012-2016 RhodeCode GmbH
4 #
4 #
5 # This program is free software: you can redistribute it and/or modify
5 # This program is free software: you can redistribute it and/or modify
6 # it under the terms of the GNU Affero General Public License, version 3
6 # it under the terms of the GNU Affero General Public License, version 3
7 # (only), as published by the Free Software Foundation.
7 # (only), as published by the Free Software Foundation.
8 #
8 #
9 # This program is distributed in the hope that it will be useful,
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU General Public License for more details.
12 # GNU General Public License for more details.
13 #
13 #
14 # You should have received a copy of the GNU Affero General Public License
14 # You should have received a copy of the GNU Affero General Public License
15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
16 #
16 #
17 # This program is dual-licensed. If you wish to learn more about the
17 # This program is dual-licensed. If you wish to learn more about the
18 # RhodeCode Enterprise Edition, including its added features, Support services,
18 # RhodeCode Enterprise Edition, including its added features, Support services,
19 # and proprietary license terms, please see https://rhodecode.com/licenses/
19 # and proprietary license terms, please see https://rhodecode.com/licenses/
20
20
21 from __future__ import unicode_literals
21 from __future__ import unicode_literals
22 import deform
22 import deform
23 import re
23 import re
24 import logging
24 import logging
25 import requests
25 import requests
26 import colander
26 import colander
27 import textwrap
27 import textwrap
28 from celery.task import task
28 from celery.task import task
29 from mako.template import Template
29 from mako.template import Template
30
30
31 from rhodecode import events
31 from rhodecode import events
32 from rhodecode.translation import _
32 from rhodecode.translation import _
33 from rhodecode.lib import helpers as h
33 from rhodecode.lib import helpers as h
34 from rhodecode.lib.celerylib import run_task
34 from rhodecode.lib.celerylib import run_task
35 from rhodecode.lib.colander_utils import strip_whitespace
35 from rhodecode.lib.colander_utils import strip_whitespace
36 from rhodecode.integrations.types.base import IntegrationTypeBase
36 from rhodecode.integrations.types.base import IntegrationTypeBase
37
37
38 log = logging.getLogger(__name__)
38 log = logging.getLogger(__name__)
39
39
40
40
41 class HipchatSettingsSchema(colander.Schema):
41 class HipchatSettingsSchema(colander.Schema):
42 color_choices = [
42 color_choices = [
43 ('yellow', _('Yellow')),
43 ('yellow', _('Yellow')),
44 ('red', _('Red')),
44 ('red', _('Red')),
45 ('green', _('Green')),
45 ('green', _('Green')),
46 ('purple', _('Purple')),
46 ('purple', _('Purple')),
47 ('gray', _('Gray')),
47 ('gray', _('Gray')),
48 ]
48 ]
49
49
50 server_url = colander.SchemaNode(
50 server_url = colander.SchemaNode(
51 colander.String(),
51 colander.String(),
52 title=_('Hipchat server URL'),
52 title=_('Hipchat server URL'),
53 description=_('Hipchat integration url.'),
53 description=_('Hipchat integration url.'),
54 default='',
54 default='',
55 preparer=strip_whitespace,
55 preparer=strip_whitespace,
56 validator=colander.url,
56 validator=colander.url,
57 widget=deform.widget.TextInputWidget(
57 widget=deform.widget.TextInputWidget(
58 placeholder='https://?.hipchat.com/v2/room/?/notification?auth_token=?',
58 placeholder='https://?.hipchat.com/v2/room/?/notification?auth_token=?',
59 ),
59 ),
60 )
60 )
61 notify = colander.SchemaNode(
61 notify = colander.SchemaNode(
62 colander.Bool(),
62 colander.Bool(),
63 title=_('Notify'),
63 title=_('Notify'),
64 description=_('Make a notification to the users in room.'),
64 description=_('Make a notification to the users in room.'),
65 missing=False,
65 missing=False,
66 default=False,
66 default=False,
67 )
67 )
68 color = colander.SchemaNode(
68 color = colander.SchemaNode(
69 colander.String(),
69 colander.String(),
70 title=_('Color'),
70 title=_('Color'),
71 description=_('Background color of message.'),
71 description=_('Background color of message.'),
72 missing='',
72 missing='',
73 validator=colander.OneOf([x[0] for x in color_choices]),
73 validator=colander.OneOf([x[0] for x in color_choices]),
74 widget=deform.widget.Select2Widget(
74 widget=deform.widget.Select2Widget(
75 values=color_choices,
75 values=color_choices,
76 ),
76 ),
77 )
77 )
78
78
79
79
80 repo_push_template = Template('''
80 repo_push_template = Template('''
81 <b>${data['actor']['username']}</b> pushed to repo <a href="${data['repo']['url']}">${data['repo']['repo_name']}</a>:
81 <b>${data['actor']['username']}</b> pushed to repo <a href="${data['repo']['url']}">${data['repo']['repo_name']}</a>:
82 <br>
82 <br>
83 <ul>
83 <ul>
84 %for branch, branch_commits in branches_commits.items():
84 %for branch, branch_commits in branches_commits.items():
85 <li>
85 <li>
86 <a href="${branch_commits['branch']['url']}">branch: ${branch_commits['branch']['name']}</a>
86 <a href="${branch_commits['branch']['url']}">branch: ${branch_commits['branch']['name']}</a>
87 <ul>
87 <ul>
88 %for commit in branch_commits['commits']:
88 %for commit in branch_commits['commits']:
89 <li><a href="${commit['url']}">${commit['short_id']}</a> - ${commit['message_html']}</li>
89 <li><a href="${commit['url']}">${commit['short_id']}</a> - ${commit['message_html']}</li>
90 %endfor
90 %endfor
91 </ul>
91 </ul>
92 </li>
92 </li>
93 %endfor
93 %endfor
94 ''')
94 ''')
95
95
96
96
97 class HipchatIntegrationType(IntegrationTypeBase):
97 class HipchatIntegrationType(IntegrationTypeBase):
98 key = 'hipchat'
98 key = 'hipchat'
99 display_name = _('Hipchat')
99 display_name = _('Hipchat')
100 description = _('Send events such as repo pushes and pull requests to '
100 description = _('Send events such as repo pushes and pull requests to '
101 'your hipchat channel.')
101 'your hipchat channel.')
102 icon = '''<?xml version="1.0" encoding="utf-8"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" viewBox="0 0 1000 1000" enable-background="new 0 0 1000 1000" xml:space="preserve"><g><g transform="translate(0.000000,511.000000) scale(0.100000,-0.100000)"><path fill="#205281" d="M4197.1,4662.4c-1661.5-260.4-3018-1171.6-3682.6-2473.3C219.9,1613.6,100,1120.3,100,462.6c0-1014,376.8-1918.4,1127-2699.4C2326.7-3377.6,3878.5-3898.3,5701-3730.5l486.5,44.5l208.9-123.3c637.2-373.4,1551.8-640.6,2240.4-650.9c304.9-6.9,335.7,0,417.9,75.4c185,174.7,147.3,411.1-89.1,548.1c-315.2,181.6-620,544.7-733.1,870.1l-51.4,157.6l472.7,472.7c349.4,349.4,520.7,551.5,657.7,774.2c784.5,1281.2,784.5,2788.5,0,4052.6c-236.4,376.8-794.8,966-1178.4,1236.7c-572.1,407.7-1264.1,709.1-1993.7,870.1c-267.2,58.2-479.6,75.4-1038,82.2C4714.4,4686.4,4310.2,4679.6,4197.1,4662.4z M5947.6,3740.9c1856.7-380.3,3127.6-1709.4,3127.6-3275c0-1000.3-534.4-1949.2-1466.2-2600.1c-188.4-133.6-287.8-226.1-301.5-284.4c-41.1-157.6,263.8-938.6,397.4-1020.8c20.5-10.3,34.3-44.5,34.3-75.4c0-167.8-811.9,195.3-1363.4,609.8l-181.6,137l-332.3-58.2c-445.3-78.8-1281.2-78.8-1702.6,0C2796-2569.2,1734.1-1832.6,1220.2-801.5C983.8-318.5,905,51.5,929,613.3c27.4,640.6,243.2,1192.1,685.1,1740.3c620,770.8,1661.5,1305.2,2822.8,1452.5C4806.9,3854,5553.7,3819.7,5947.6,3740.9z"/><path fill="#205281" d="M2381.5-345.9c-75.4-106.2-68.5-167.8,34.3-322c332.3-500.2,1010.6-928.4,1760.8-1120.2c417.9-106.2,1226.4-106.2,1644.3,0c712.5,181.6,1270.9,517.3,1685.4,1014C7681-561.7,7715.3-424.7,7616-325.4c-89.1,89.1-167.9,65.1-431.7-133.6c-835.8-630.3-2028-856.4-3086.5-585.8C3683.3-938.6,3142-685,2830.3-448.7C2576.8-253.4,2463.7-229.4,2381.5-345.9z"/></g></g><!-- Svg Vector Icons : http://www.onlinewebfonts.com/icon --></svg>'''
102 icon = '''<?xml version="1.0" encoding="utf-8"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" viewBox="0 0 1000 1000" enable-background="new 0 0 1000 1000" xml:space="preserve"><g><g transform="translate(0.000000,511.000000) scale(0.100000,-0.100000)"><path fill="#205281" d="M4197.1,4662.4c-1661.5-260.4-3018-1171.6-3682.6-2473.3C219.9,1613.6,100,1120.3,100,462.6c0-1014,376.8-1918.4,1127-2699.4C2326.7-3377.6,3878.5-3898.3,5701-3730.5l486.5,44.5l208.9-123.3c637.2-373.4,1551.8-640.6,2240.4-650.9c304.9-6.9,335.7,0,417.9,75.4c185,174.7,147.3,411.1-89.1,548.1c-315.2,181.6-620,544.7-733.1,870.1l-51.4,157.6l472.7,472.7c349.4,349.4,520.7,551.5,657.7,774.2c784.5,1281.2,784.5,2788.5,0,4052.6c-236.4,376.8-794.8,966-1178.4,1236.7c-572.1,407.7-1264.1,709.1-1993.7,870.1c-267.2,58.2-479.6,75.4-1038,82.2C4714.4,4686.4,4310.2,4679.6,4197.1,4662.4z M5947.6,3740.9c1856.7-380.3,3127.6-1709.4,3127.6-3275c0-1000.3-534.4-1949.2-1466.2-2600.1c-188.4-133.6-287.8-226.1-301.5-284.4c-41.1-157.6,263.8-938.6,397.4-1020.8c20.5-10.3,34.3-44.5,34.3-75.4c0-167.8-811.9,195.3-1363.4,609.8l-181.6,137l-332.3-58.2c-445.3-78.8-1281.2-78.8-1702.6,0C2796-2569.2,1734.1-1832.6,1220.2-801.5C983.8-318.5,905,51.5,929,613.3c27.4,640.6,243.2,1192.1,685.1,1740.3c620,770.8,1661.5,1305.2,2822.8,1452.5C4806.9,3854,5553.7,3819.7,5947.6,3740.9z"/><path fill="#205281" d="M2381.5-345.9c-75.4-106.2-68.5-167.8,34.3-322c332.3-500.2,1010.6-928.4,1760.8-1120.2c417.9-106.2,1226.4-106.2,1644.3,0c712.5,181.6,1270.9,517.3,1685.4,1014C7681-561.7,7715.3-424.7,7616-325.4c-89.1,89.1-167.9,65.1-431.7-133.6c-835.8-630.3-2028-856.4-3086.5-585.8C3683.3-938.6,3142-685,2830.3-448.7C2576.8-253.4,2463.7-229.4,2381.5-345.9z"/></g></g><!-- Svg Vector Icons : http://www.onlinewebfonts.com/icon --></svg>'''
103 valid_events = [
103 valid_events = [
104 events.PullRequestCloseEvent,
104 events.PullRequestCloseEvent,
105 events.PullRequestMergeEvent,
105 events.PullRequestMergeEvent,
106 events.PullRequestUpdateEvent,
106 events.PullRequestUpdateEvent,
107 events.PullRequestCommentEvent,
107 events.PullRequestCommentEvent,
108 events.PullRequestReviewEvent,
108 events.PullRequestReviewEvent,
109 events.PullRequestCreateEvent,
109 events.PullRequestCreateEvent,
110 events.RepoPushEvent,
110 events.RepoPushEvent,
111 events.RepoCreateEvent,
111 events.RepoCreateEvent,
112 ]
112 ]
113
113
114 def send_event(self, event):
114 def send_event(self, event):
115 if event.__class__ not in self.valid_events:
115 if event.__class__ not in self.valid_events:
116 log.debug('event not valid: %r' % event)
116 log.debug('event not valid: %r' % event)
117 return
117 return
118
118
119 if event.name not in self.settings['events']:
119 if event.name not in self.settings['events']:
120 log.debug('event ignored: %r' % event)
120 log.debug('event ignored: %r' % event)
121 return
121 return
122
122
123 data = event.as_dict()
123 data = event.as_dict()
124
124
125 text = '<b>%s<b> caused a <b>%s</b> event' % (
125 text = '<b>%s<b> caused a <b>%s</b> event' % (
126 data['actor']['username'], event.name)
126 data['actor']['username'], event.name)
127
127
128 log.debug('handling hipchat event for %s' % event.name)
128 log.debug('handling hipchat event for %s' % event.name)
129
129
130 if isinstance(event, events.PullRequestCommentEvent):
130 if isinstance(event, events.PullRequestCommentEvent):
131 text = self.format_pull_request_comment_event(event, data)
131 text = self.format_pull_request_comment_event(event, data)
132 elif isinstance(event, events.PullRequestReviewEvent):
132 elif isinstance(event, events.PullRequestReviewEvent):
133 text = self.format_pull_request_review_event(event, data)
133 text = self.format_pull_request_review_event(event, data)
134 elif isinstance(event, events.PullRequestEvent):
134 elif isinstance(event, events.PullRequestEvent):
135 text = self.format_pull_request_event(event, data)
135 text = self.format_pull_request_event(event, data)
136 elif isinstance(event, events.RepoPushEvent):
136 elif isinstance(event, events.RepoPushEvent):
137 text = self.format_repo_push_event(data)
137 text = self.format_repo_push_event(data)
138 elif isinstance(event, events.RepoCreateEvent):
138 elif isinstance(event, events.RepoCreateEvent):
139 text = self.format_repo_create_event(data)
139 text = self.format_repo_create_event(data)
140 else:
140 else:
141 log.error('unhandled event type: %r' % event)
141 log.error('unhandled event type: %r' % event)
142
142
143 run_task(post_text_to_hipchat, self.settings, text)
143 run_task(post_text_to_hipchat, self.settings, text)
144
144
145 def settings_schema(self):
145 def settings_schema(self):
146 schema = HipchatSettingsSchema()
146 schema = HipchatSettingsSchema()
147 schema.add(colander.SchemaNode(
147 schema.add(colander.SchemaNode(
148 colander.Set(),
148 colander.Set(),
149 widget=deform.widget.CheckboxChoiceWidget(
149 widget=deform.widget.CheckboxChoiceWidget(
150 values=sorted(
150 values=sorted(
151 [(e.name, e.display_name) for e in self.valid_events]
151 [(e.name, e.display_name) for e in self.valid_events]
152 )
152 )
153 ),
153 ),
154 description="Events activated for this integration",
154 description="Events activated for this integration",
155 name='events'
155 name='events'
156 ))
156 ))
157
157
158 return schema
158 return schema
159
159
160 def format_pull_request_comment_event(self, event, data):
160 def format_pull_request_comment_event(self, event, data):
161 comment_text = data['comment']['text']
161 comment_text = data['comment']['text']
162 if len(comment_text) > 200:
162 if len(comment_text) > 200:
163 comment_text = '{comment_text}<a href="{comment_url}">...<a/>'.format(
163 comment_text = '{comment_text}<a href="{comment_url}">...<a/>'.format(
164 comment_text=h.html_escape(comment_text[:200]),
164 comment_text=h.html_escape(comment_text[:200]),
165 comment_url=data['comment']['url'],
165 comment_url=data['comment']['url'],
166 )
166 )
167
167
168 comment_status = ''
168 comment_status = ''
169 if data['comment']['status']:
169 if data['comment']['status']:
170 comment_status = '[{}]: '.format(data['comment']['status'])
170 comment_status = '[{}]: '.format(data['comment']['status'])
171
171
172 return (textwrap.dedent(
172 return (textwrap.dedent(
173 '''
173 '''
174 {user} commented on pull request <a href="{pr_url}">{number}</a> - {pr_title}:
174 {user} commented on pull request <a href="{pr_url}">{number}</a> - {pr_title}:
175 >>> {comment_status}{comment_text}
175 >>> {comment_status}{comment_text}
176 ''').format(
176 ''').format(
177 comment_status=comment_status,
177 comment_status=comment_status,
178 user=data['actor']['username'],
178 user=data['actor']['username'],
179 number=data['pullrequest']['pull_request_id'],
179 number=data['pullrequest']['pull_request_id'],
180 pr_url=data['pullrequest']['url'],
180 pr_url=data['pullrequest']['url'],
181 pr_status=data['pullrequest']['status'],
181 pr_status=data['pullrequest']['status'],
182 pr_title=h.html_escape(data['pullrequest']['title']),
182 pr_title=h.html_escape(data['pullrequest']['title']),
183 comment_text=h.html_escape(comment_text)
183 comment_text=h.html_escape(comment_text)
184 )
184 )
185 )
185 )
186
186
187 def format_pull_request_review_event(self, event, data):
187 def format_pull_request_review_event(self, event, data):
188 return (textwrap.dedent(
188 return (textwrap.dedent(
189 '''
189 '''
190 Status changed to {pr_status} for pull request <a href="{pr_url}">#{number}</a> - {pr_title}
190 Status changed to {pr_status} for pull request <a href="{pr_url}">#{number}</a> - {pr_title}
191 ''').format(
191 ''').format(
192 user=data['actor']['username'],
192 user=data['actor']['username'],
193 number=data['pullrequest']['pull_request_id'],
193 number=data['pullrequest']['pull_request_id'],
194 pr_url=data['pullrequest']['url'],
194 pr_url=data['pullrequest']['url'],
195 pr_status=data['pullrequest']['status'],
195 pr_status=data['pullrequest']['status'],
196 pr_title=h.html_escape(data['pullrequest']['title']),
196 pr_title=h.html_escape(data['pullrequest']['title']),
197 )
197 )
198 )
198 )
199
199
200 def format_pull_request_event(self, event, data):
200 def format_pull_request_event(self, event, data):
201 action = {
201 action = {
202 events.PullRequestCloseEvent: 'closed',
202 events.PullRequestCloseEvent: 'closed',
203 events.PullRequestMergeEvent: 'merged',
203 events.PullRequestMergeEvent: 'merged',
204 events.PullRequestUpdateEvent: 'updated',
204 events.PullRequestUpdateEvent: 'updated',
205 events.PullRequestCreateEvent: 'created',
205 events.PullRequestCreateEvent: 'created',
206 }.get(event.__class__, str(event.__class__))
206 }.get(event.__class__, str(event.__class__))
207
207
208 return ('Pull request <a href="{url}">#{number}</a> - {title} '
208 return ('Pull request <a href="{url}">#{number}</a> - {title} '
209 '{action} by {user}').format(
209 '{action} by {user}').format(
210 user=data['actor']['username'],
210 user=data['actor']['username'],
211 number=data['pullrequest']['pull_request_id'],
211 number=data['pullrequest']['pull_request_id'],
212 url=data['pullrequest']['url'],
212 url=data['pullrequest']['url'],
213 title=h.html_escape(data['pullrequest']['title']),
213 title=h.html_escape(data['pullrequest']['title']),
214 action=action
214 action=action
215 )
215 )
216
216
217 def format_repo_push_event(self, data):
217 def format_repo_push_event(self, data):
218 branch_data = {branch['name']: branch
218 branch_data = {branch['name']: branch
219 for branch in data['push']['branches']}
219 for branch in data['push']['branches']}
220
220
221 branches_commits = {}
221 branches_commits = {}
222 for commit in data['push']['commits']:
222 for commit in data['push']['commits']:
223 log.critical(commit)
224 if commit['branch'] not in branches_commits:
223 if commit['branch'] not in branches_commits:
225 branch_commits = {'branch': branch_data[commit['branch']],
224 branch_commits = {'branch': branch_data[commit['branch']],
226 'commits': []}
225 'commits': []}
227 branches_commits[commit['branch']] = branch_commits
226 branches_commits[commit['branch']] = branch_commits
228
227
229 branch_commits = branches_commits[commit['branch']]
228 branch_commits = branches_commits[commit['branch']]
230 branch_commits['commits'].append(commit)
229 branch_commits['commits'].append(commit)
231
230
232 result = repo_push_template.render(
231 result = repo_push_template.render(
233 data=data,
232 data=data,
234 branches_commits=branches_commits,
233 branches_commits=branches_commits,
235 )
234 )
236 return result
235 return result
237
236
238 def format_repo_create_event(self, data):
237 def format_repo_create_event(self, data):
239 return '<a href="{}">{}</a> ({}) repository created by <b>{}</b>'.format(
238 return '<a href="{}">{}</a> ({}) repository created by <b>{}</b>'.format(
240 data['repo']['url'],
239 data['repo']['url'],
241 h.html_escape(data['repo']['repo_name']),
240 h.html_escape(data['repo']['repo_name']),
242 data['repo']['repo_type'],
241 data['repo']['repo_type'],
243 data['actor']['username'],
242 data['actor']['username'],
244 )
243 )
245
244
246
245
247 @task(ignore_result=True)
246 @task(ignore_result=True)
248 def post_text_to_hipchat(settings, text):
247 def post_text_to_hipchat(settings, text):
249 log.debug('sending %s to hipchat %s' % (text, settings['server_url']))
248 log.debug('sending %s to hipchat %s' % (text, settings['server_url']))
250 resp = requests.post(settings['server_url'], json={
249 resp = requests.post(settings['server_url'], json={
251 "message": text,
250 "message": text,
252 "color": settings.get('color', 'yellow'),
251 "color": settings.get('color', 'yellow'),
253 "notify": settings.get('notify', False),
252 "notify": settings.get('notify', False),
254 })
253 })
255 resp.raise_for_status() # raise exception on a failed request
254 resp.raise_for_status() # raise exception on a failed request
@@ -1,264 +1,263 b''
1 # -*- coding: utf-8 -*-
1 # -*- coding: utf-8 -*-
2
2
3 # Copyright (C) 2012-2016 RhodeCode GmbH
3 # Copyright (C) 2012-2016 RhodeCode GmbH
4 #
4 #
5 # This program is free software: you can redistribute it and/or modify
5 # This program is free software: you can redistribute it and/or modify
6 # it under the terms of the GNU Affero General Public License, version 3
6 # it under the terms of the GNU Affero General Public License, version 3
7 # (only), as published by the Free Software Foundation.
7 # (only), as published by the Free Software Foundation.
8 #
8 #
9 # This program is distributed in the hope that it will be useful,
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU General Public License for more details.
12 # GNU General Public License for more details.
13 #
13 #
14 # You should have received a copy of the GNU Affero General Public License
14 # You should have received a copy of the GNU Affero General Public License
15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
16 #
16 #
17 # This program is dual-licensed. If you wish to learn more about the
17 # This program is dual-licensed. If you wish to learn more about the
18 # RhodeCode Enterprise Edition, including its added features, Support services,
18 # RhodeCode Enterprise Edition, including its added features, Support services,
19 # and proprietary license terms, please see https://rhodecode.com/licenses/
19 # and proprietary license terms, please see https://rhodecode.com/licenses/
20
20
21 from __future__ import unicode_literals
21 from __future__ import unicode_literals
22 import deform
22 import deform
23 import re
23 import re
24 import logging
24 import logging
25 import requests
25 import requests
26 import colander
26 import colander
27 import textwrap
27 import textwrap
28 from celery.task import task
28 from celery.task import task
29 from mako.template import Template
29 from mako.template import Template
30
30
31 from rhodecode import events
31 from rhodecode import events
32 from rhodecode.translation import _
32 from rhodecode.translation import _
33 from rhodecode.lib import helpers as h
33 from rhodecode.lib import helpers as h
34 from rhodecode.lib.celerylib import run_task
34 from rhodecode.lib.celerylib import run_task
35 from rhodecode.lib.colander_utils import strip_whitespace
35 from rhodecode.lib.colander_utils import strip_whitespace
36 from rhodecode.integrations.types.base import IntegrationTypeBase
36 from rhodecode.integrations.types.base import IntegrationTypeBase
37
37
38 log = logging.getLogger(__name__)
38 log = logging.getLogger(__name__)
39
39
40
40
41 class SlackSettingsSchema(colander.Schema):
41 class SlackSettingsSchema(colander.Schema):
42 service = colander.SchemaNode(
42 service = colander.SchemaNode(
43 colander.String(),
43 colander.String(),
44 title=_('Slack service URL'),
44 title=_('Slack service URL'),
45 description=h.literal(_(
45 description=h.literal(_(
46 'This can be setup at the '
46 'This can be setup at the '
47 '<a href="https://my.slack.com/services/new/incoming-webhook/">'
47 '<a href="https://my.slack.com/services/new/incoming-webhook/">'
48 'slack app manager</a>')),
48 'slack app manager</a>')),
49 default='',
49 default='',
50 preparer=strip_whitespace,
50 preparer=strip_whitespace,
51 validator=colander.url,
51 validator=colander.url,
52 widget=deform.widget.TextInputWidget(
52 widget=deform.widget.TextInputWidget(
53 placeholder='https://hooks.slack.com/services/...',
53 placeholder='https://hooks.slack.com/services/...',
54 ),
54 ),
55 )
55 )
56 username = colander.SchemaNode(
56 username = colander.SchemaNode(
57 colander.String(),
57 colander.String(),
58 title=_('Username'),
58 title=_('Username'),
59 description=_('Username to show notifications coming from.'),
59 description=_('Username to show notifications coming from.'),
60 missing='Rhodecode',
60 missing='Rhodecode',
61 preparer=strip_whitespace,
61 preparer=strip_whitespace,
62 widget=deform.widget.TextInputWidget(
62 widget=deform.widget.TextInputWidget(
63 placeholder='Rhodecode'
63 placeholder='Rhodecode'
64 ),
64 ),
65 )
65 )
66 channel = colander.SchemaNode(
66 channel = colander.SchemaNode(
67 colander.String(),
67 colander.String(),
68 title=_('Channel'),
68 title=_('Channel'),
69 description=_('Channel to send notifications to.'),
69 description=_('Channel to send notifications to.'),
70 missing='',
70 missing='',
71 preparer=strip_whitespace,
71 preparer=strip_whitespace,
72 widget=deform.widget.TextInputWidget(
72 widget=deform.widget.TextInputWidget(
73 placeholder='#general'
73 placeholder='#general'
74 ),
74 ),
75 )
75 )
76 icon_emoji = colander.SchemaNode(
76 icon_emoji = colander.SchemaNode(
77 colander.String(),
77 colander.String(),
78 title=_('Emoji'),
78 title=_('Emoji'),
79 description=_('Emoji to use eg. :studio_microphone:'),
79 description=_('Emoji to use eg. :studio_microphone:'),
80 missing='',
80 missing='',
81 preparer=strip_whitespace,
81 preparer=strip_whitespace,
82 widget=deform.widget.TextInputWidget(
82 widget=deform.widget.TextInputWidget(
83 placeholder=':studio_microphone:'
83 placeholder=':studio_microphone:'
84 ),
84 ),
85 )
85 )
86
86
87
87
88 repo_push_template = Template(r'''
88 repo_push_template = Template(r'''
89 *${data['actor']['username']}* pushed to repo <${data['repo']['url']}|${data['repo']['repo_name']}>:
89 *${data['actor']['username']}* pushed to repo <${data['repo']['url']}|${data['repo']['repo_name']}>:
90 %for branch, branch_commits in branches_commits.items():
90 %for branch, branch_commits in branches_commits.items():
91 branch: <${branch_commits['branch']['url']}|${branch_commits['branch']['name']}>
91 branch: <${branch_commits['branch']['url']}|${branch_commits['branch']['name']}>
92 %for commit in branch_commits['commits']:
92 %for commit in branch_commits['commits']:
93 > <${commit['url']}|${commit['short_id']}> - ${commit['message_html']|html_to_slack_links}
93 > <${commit['url']}|${commit['short_id']}> - ${commit['message_html']|html_to_slack_links}
94 %endfor
94 %endfor
95 %endfor
95 %endfor
96 ''')
96 ''')
97
97
98
98
99 class SlackIntegrationType(IntegrationTypeBase):
99 class SlackIntegrationType(IntegrationTypeBase):
100 key = 'slack'
100 key = 'slack'
101 display_name = _('Slack')
101 display_name = _('Slack')
102 description = _('Send events such as repo pushes and pull requests to '
102 description = _('Send events such as repo pushes and pull requests to '
103 'your slack channel.')
103 'your slack channel.')
104 icon = '''<?xml version="1.0" encoding="UTF-8" standalone="no"?><svg viewBox="0 0 256 256" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" preserveAspectRatio="xMidYMid"><g><path d="M165.963541,15.8384262 C162.07318,3.86308197 149.212328,-2.69009836 137.239082,1.20236066 C125.263738,5.09272131 118.710557,17.9535738 122.603016,29.9268197 L181.550164,211.292328 C185.597902,222.478689 197.682361,228.765377 209.282098,225.426885 C221.381246,221.943607 228.756984,209.093246 224.896,197.21023 C224.749115,196.756984 165.963541,15.8384262 165.963541,15.8384262" fill="#DFA22F"></path><path d="M74.6260984,45.515541 C70.7336393,33.5422951 57.8727869,26.9891148 45.899541,30.8794754 C33.9241967,34.7698361 27.3710164,47.6306885 31.2634754,59.6060328 L90.210623,240.971541 C94.2583607,252.157902 106.34282,258.44459 117.942557,255.104 C130.041705,251.62282 137.417443,238.772459 133.556459,226.887344 C133.409574,226.436197 74.6260984,45.515541 74.6260984,45.515541" fill="#3CB187"></path><path d="M240.161574,166.045377 C252.136918,162.155016 258.688,149.294164 254.797639,137.31882 C250.907279,125.345574 238.046426,118.792393 226.07318,122.682754 L44.7076721,181.632 C33.5213115,185.677639 27.234623,197.762098 30.5731148,209.361836 C34.0563934,221.460984 46.9067541,228.836721 58.7897705,224.975738 C59.2430164,224.828852 240.161574,166.045377 240.161574,166.045377" fill="#CE1E5B"></path><path d="M82.507541,217.270557 C94.312918,213.434754 109.528131,208.491016 125.855475,203.186361 C122.019672,191.380984 117.075934,176.163672 111.76918,159.83423 L68.4191475,173.924721 L82.507541,217.270557" fill="#392538"></path><path d="M173.847082,187.591344 C190.235279,182.267803 205.467279,177.31777 217.195016,173.507148 C213.359213,161.70177 208.413377,146.480262 203.106623,130.146623 L159.75659,144.237115 L173.847082,187.591344" fill="#BB242A"></path><path d="M210.484459,74.7058361 C222.457705,70.8154754 229.010885,57.954623 225.120525,45.9792787 C221.230164,34.0060328 208.369311,27.4528525 196.393967,31.3432131 L15.028459,90.292459 C3.84209836,94.3380984 -2.44459016,106.422557 0.896,118.022295 C4.37718033,130.121443 17.227541,137.49718 29.1126557,133.636197 C29.5638033,133.489311 210.484459,74.7058361 210.484459,74.7058361" fill="#72C5CD"></path><path d="M52.8220328,125.933115 C64.6274098,122.097311 79.8468197,117.151475 96.1762623,111.84682 C90.8527213,95.4565246 85.9026885,80.2245246 82.0920656,68.4946885 L38.731541,82.5872787 L52.8220328,125.933115" fill="#248C73"></path><path d="M144.159475,96.256 C160.551869,90.9303607 175.785967,85.9803279 187.515803,82.1676066 C182.190164,65.7752131 177.240131,50.5390164 173.42741,38.807082 L130.068984,52.8996721 L144.159475,96.256" fill="#62803A"></path></g></svg>'''
104 icon = '''<?xml version="1.0" encoding="UTF-8" standalone="no"?><svg viewBox="0 0 256 256" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" preserveAspectRatio="xMidYMid"><g><path d="M165.963541,15.8384262 C162.07318,3.86308197 149.212328,-2.69009836 137.239082,1.20236066 C125.263738,5.09272131 118.710557,17.9535738 122.603016,29.9268197 L181.550164,211.292328 C185.597902,222.478689 197.682361,228.765377 209.282098,225.426885 C221.381246,221.943607 228.756984,209.093246 224.896,197.21023 C224.749115,196.756984 165.963541,15.8384262 165.963541,15.8384262" fill="#DFA22F"></path><path d="M74.6260984,45.515541 C70.7336393,33.5422951 57.8727869,26.9891148 45.899541,30.8794754 C33.9241967,34.7698361 27.3710164,47.6306885 31.2634754,59.6060328 L90.210623,240.971541 C94.2583607,252.157902 106.34282,258.44459 117.942557,255.104 C130.041705,251.62282 137.417443,238.772459 133.556459,226.887344 C133.409574,226.436197 74.6260984,45.515541 74.6260984,45.515541" fill="#3CB187"></path><path d="M240.161574,166.045377 C252.136918,162.155016 258.688,149.294164 254.797639,137.31882 C250.907279,125.345574 238.046426,118.792393 226.07318,122.682754 L44.7076721,181.632 C33.5213115,185.677639 27.234623,197.762098 30.5731148,209.361836 C34.0563934,221.460984 46.9067541,228.836721 58.7897705,224.975738 C59.2430164,224.828852 240.161574,166.045377 240.161574,166.045377" fill="#CE1E5B"></path><path d="M82.507541,217.270557 C94.312918,213.434754 109.528131,208.491016 125.855475,203.186361 C122.019672,191.380984 117.075934,176.163672 111.76918,159.83423 L68.4191475,173.924721 L82.507541,217.270557" fill="#392538"></path><path d="M173.847082,187.591344 C190.235279,182.267803 205.467279,177.31777 217.195016,173.507148 C213.359213,161.70177 208.413377,146.480262 203.106623,130.146623 L159.75659,144.237115 L173.847082,187.591344" fill="#BB242A"></path><path d="M210.484459,74.7058361 C222.457705,70.8154754 229.010885,57.954623 225.120525,45.9792787 C221.230164,34.0060328 208.369311,27.4528525 196.393967,31.3432131 L15.028459,90.292459 C3.84209836,94.3380984 -2.44459016,106.422557 0.896,118.022295 C4.37718033,130.121443 17.227541,137.49718 29.1126557,133.636197 C29.5638033,133.489311 210.484459,74.7058361 210.484459,74.7058361" fill="#72C5CD"></path><path d="M52.8220328,125.933115 C64.6274098,122.097311 79.8468197,117.151475 96.1762623,111.84682 C90.8527213,95.4565246 85.9026885,80.2245246 82.0920656,68.4946885 L38.731541,82.5872787 L52.8220328,125.933115" fill="#248C73"></path><path d="M144.159475,96.256 C160.551869,90.9303607 175.785967,85.9803279 187.515803,82.1676066 C182.190164,65.7752131 177.240131,50.5390164 173.42741,38.807082 L130.068984,52.8996721 L144.159475,96.256" fill="#62803A"></path></g></svg>'''
105 valid_events = [
105 valid_events = [
106 events.PullRequestCloseEvent,
106 events.PullRequestCloseEvent,
107 events.PullRequestMergeEvent,
107 events.PullRequestMergeEvent,
108 events.PullRequestUpdateEvent,
108 events.PullRequestUpdateEvent,
109 events.PullRequestCommentEvent,
109 events.PullRequestCommentEvent,
110 events.PullRequestReviewEvent,
110 events.PullRequestReviewEvent,
111 events.PullRequestCreateEvent,
111 events.PullRequestCreateEvent,
112 events.RepoPushEvent,
112 events.RepoPushEvent,
113 events.RepoCreateEvent,
113 events.RepoCreateEvent,
114 ]
114 ]
115
115
116 def send_event(self, event):
116 def send_event(self, event):
117 if event.__class__ not in self.valid_events:
117 if event.__class__ not in self.valid_events:
118 log.debug('event not valid: %r' % event)
118 log.debug('event not valid: %r' % event)
119 return
119 return
120
120
121 if event.name not in self.settings['events']:
121 if event.name not in self.settings['events']:
122 log.debug('event ignored: %r' % event)
122 log.debug('event ignored: %r' % event)
123 return
123 return
124
124
125 data = event.as_dict()
125 data = event.as_dict()
126
126
127 text = '*%s* caused a *%s* event' % (
127 text = '*%s* caused a *%s* event' % (
128 data['actor']['username'], event.name)
128 data['actor']['username'], event.name)
129
129
130 log.debug('handling slack event for %s' % event.name)
130 log.debug('handling slack event for %s' % event.name)
131
131
132 if isinstance(event, events.PullRequestCommentEvent):
132 if isinstance(event, events.PullRequestCommentEvent):
133 text = self.format_pull_request_comment_event(event, data)
133 text = self.format_pull_request_comment_event(event, data)
134 elif isinstance(event, events.PullRequestReviewEvent):
134 elif isinstance(event, events.PullRequestReviewEvent):
135 text = self.format_pull_request_review_event(event, data)
135 text = self.format_pull_request_review_event(event, data)
136 elif isinstance(event, events.PullRequestEvent):
136 elif isinstance(event, events.PullRequestEvent):
137 text = self.format_pull_request_event(event, data)
137 text = self.format_pull_request_event(event, data)
138 elif isinstance(event, events.RepoPushEvent):
138 elif isinstance(event, events.RepoPushEvent):
139 text = self.format_repo_push_event(data)
139 text = self.format_repo_push_event(data)
140 elif isinstance(event, events.RepoCreateEvent):
140 elif isinstance(event, events.RepoCreateEvent):
141 text = self.format_repo_create_event(data)
141 text = self.format_repo_create_event(data)
142 else:
142 else:
143 log.error('unhandled event type: %r' % event)
143 log.error('unhandled event type: %r' % event)
144
144
145 run_task(post_text_to_slack, self.settings, text)
145 run_task(post_text_to_slack, self.settings, text)
146
146
147 def settings_schema(self):
147 def settings_schema(self):
148 schema = SlackSettingsSchema()
148 schema = SlackSettingsSchema()
149 schema.add(colander.SchemaNode(
149 schema.add(colander.SchemaNode(
150 colander.Set(),
150 colander.Set(),
151 widget=deform.widget.CheckboxChoiceWidget(
151 widget=deform.widget.CheckboxChoiceWidget(
152 values=sorted(
152 values=sorted(
153 [(e.name, e.display_name) for e in self.valid_events]
153 [(e.name, e.display_name) for e in self.valid_events]
154 )
154 )
155 ),
155 ),
156 description="Events activated for this integration",
156 description="Events activated for this integration",
157 name='events'
157 name='events'
158 ))
158 ))
159
159
160 return schema
160 return schema
161
161
162 def format_pull_request_comment_event(self, event, data):
162 def format_pull_request_comment_event(self, event, data):
163 comment_text = data['comment']['text']
163 comment_text = data['comment']['text']
164 if len(comment_text) > 200:
164 if len(comment_text) > 200:
165 comment_text = '<{comment_url}|{comment_text}...>'.format(
165 comment_text = '<{comment_url}|{comment_text}...>'.format(
166 comment_text=comment_text[:200],
166 comment_text=comment_text[:200],
167 comment_url=data['comment']['url'],
167 comment_url=data['comment']['url'],
168 )
168 )
169
169
170 comment_status = ''
170 comment_status = ''
171 if data['comment']['status']:
171 if data['comment']['status']:
172 comment_status = '[{}]: '.format(data['comment']['status'])
172 comment_status = '[{}]: '.format(data['comment']['status'])
173
173
174 return (textwrap.dedent(
174 return (textwrap.dedent(
175 '''
175 '''
176 *{user}* commented on pull request <{pr_url}|#{number}> - {pr_title}:
176 *{user}* commented on pull request <{pr_url}|#{number}> - {pr_title}:
177 >>> {comment_status}{comment_text}
177 >>> {comment_status}{comment_text}
178 ''').format(
178 ''').format(
179 comment_status=comment_status,
179 comment_status=comment_status,
180 user=data['actor']['username'],
180 user=data['actor']['username'],
181 number=data['pullrequest']['pull_request_id'],
181 number=data['pullrequest']['pull_request_id'],
182 pr_url=data['pullrequest']['url'],
182 pr_url=data['pullrequest']['url'],
183 pr_status=data['pullrequest']['status'],
183 pr_status=data['pullrequest']['status'],
184 pr_title=data['pullrequest']['title'],
184 pr_title=data['pullrequest']['title'],
185 comment_text=comment_text
185 comment_text=comment_text
186 )
186 )
187 )
187 )
188
188
189 def format_pull_request_review_event(self, event, data):
189 def format_pull_request_review_event(self, event, data):
190 return (textwrap.dedent(
190 return (textwrap.dedent(
191 '''
191 '''
192 Status changed to {pr_status} for pull request <{pr_url}|#{number}> - {pr_title}
192 Status changed to {pr_status} for pull request <{pr_url}|#{number}> - {pr_title}
193 ''').format(
193 ''').format(
194 user=data['actor']['username'],
194 user=data['actor']['username'],
195 number=data['pullrequest']['pull_request_id'],
195 number=data['pullrequest']['pull_request_id'],
196 pr_url=data['pullrequest']['url'],
196 pr_url=data['pullrequest']['url'],
197 pr_status=data['pullrequest']['status'],
197 pr_status=data['pullrequest']['status'],
198 pr_title=data['pullrequest']['title'],
198 pr_title=data['pullrequest']['title'],
199 )
199 )
200 )
200 )
201
201
202 def format_pull_request_event(self, event, data):
202 def format_pull_request_event(self, event, data):
203 action = {
203 action = {
204 events.PullRequestCloseEvent: 'closed',
204 events.PullRequestCloseEvent: 'closed',
205 events.PullRequestMergeEvent: 'merged',
205 events.PullRequestMergeEvent: 'merged',
206 events.PullRequestUpdateEvent: 'updated',
206 events.PullRequestUpdateEvent: 'updated',
207 events.PullRequestCreateEvent: 'created',
207 events.PullRequestCreateEvent: 'created',
208 }.get(event.__class__, str(event.__class__))
208 }.get(event.__class__, str(event.__class__))
209
209
210 return ('Pull request <{url}|#{number}> - {title} '
210 return ('Pull request <{url}|#{number}> - {title} '
211 '`{action}` by *{user}*').format(
211 '`{action}` by *{user}*').format(
212 user=data['actor']['username'],
212 user=data['actor']['username'],
213 number=data['pullrequest']['pull_request_id'],
213 number=data['pullrequest']['pull_request_id'],
214 url=data['pullrequest']['url'],
214 url=data['pullrequest']['url'],
215 title=data['pullrequest']['title'],
215 title=data['pullrequest']['title'],
216 action=action
216 action=action
217 )
217 )
218
218
219 def format_repo_push_event(self, data):
219 def format_repo_push_event(self, data):
220 branch_data = {branch['name']: branch
220 branch_data = {branch['name']: branch
221 for branch in data['push']['branches']}
221 for branch in data['push']['branches']}
222
222
223 branches_commits = {}
223 branches_commits = {}
224 for commit in data['push']['commits']:
224 for commit in data['push']['commits']:
225 log.critical(commit)
226 if commit['branch'] not in branches_commits:
225 if commit['branch'] not in branches_commits:
227 branch_commits = {'branch': branch_data[commit['branch']],
226 branch_commits = {'branch': branch_data[commit['branch']],
228 'commits': []}
227 'commits': []}
229 branches_commits[commit['branch']] = branch_commits
228 branches_commits[commit['branch']] = branch_commits
230
229
231 branch_commits = branches_commits[commit['branch']]
230 branch_commits = branches_commits[commit['branch']]
232 branch_commits['commits'].append(commit)
231 branch_commits['commits'].append(commit)
233
232
234 result = repo_push_template.render(
233 result = repo_push_template.render(
235 data=data,
234 data=data,
236 branches_commits=branches_commits,
235 branches_commits=branches_commits,
237 html_to_slack_links=html_to_slack_links,
236 html_to_slack_links=html_to_slack_links,
238 )
237 )
239 return result
238 return result
240
239
241 def format_repo_create_event(self, data):
240 def format_repo_create_event(self, data):
242 return '<{}|{}> ({}) repository created by *{}*'.format(
241 return '<{}|{}> ({}) repository created by *{}*'.format(
243 data['repo']['url'],
242 data['repo']['url'],
244 data['repo']['repo_name'],
243 data['repo']['repo_name'],
245 data['repo']['repo_type'],
244 data['repo']['repo_type'],
246 data['actor']['username'],
245 data['actor']['username'],
247 )
246 )
248
247
249
248
250 def html_to_slack_links(message):
249 def html_to_slack_links(message):
251 return re.compile(r'<a .*?href=["\'](.+?)".*?>(.+?)</a>').sub(
250 return re.compile(r'<a .*?href=["\'](.+?)".*?>(.+?)</a>').sub(
252 r'<\1|\2>', message)
251 r'<\1|\2>', message)
253
252
254
253
255 @task(ignore_result=True)
254 @task(ignore_result=True)
256 def post_text_to_slack(settings, text):
255 def post_text_to_slack(settings, text):
257 log.debug('sending %s to slack %s' % (text, settings['service']))
256 log.debug('sending %s to slack %s' % (text, settings['service']))
258 resp = requests.post(settings['service'], json={
257 resp = requests.post(settings['service'], json={
259 "channel": settings.get('channel', ''),
258 "channel": settings.get('channel', ''),
260 "username": settings.get('username', 'Rhodecode'),
259 "username": settings.get('username', 'Rhodecode'),
261 "text": text,
260 "text": text,
262 "icon_emoji": settings.get('icon_emoji', ':studio_microphone:')
261 "icon_emoji": settings.get('icon_emoji', ':studio_microphone:')
263 })
262 })
264 resp.raise_for_status() # raise exception on a failed request
263 resp.raise_for_status() # raise exception on a failed request
General Comments 0
You need to be logged in to leave comments. Login now