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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
import os.path
import pickle
from copy import copy
from datetime import datetime, timedelta
from unittest import mock, skip
from unittest.mock import patch
from dateutil.tz import tzutc
from google.oauth2.credentials import Credentials
from six.moves import configparser
import bugwarrior.services.gmail as gmail
from bugwarrior.config import ServiceConfig
from bugwarrior.services.gmail import GmailService
from .base import AbstractServiceTest, ConfigTest, ServiceTest
TEST_CREDENTIAL = {
"token": "itsatokeneveryone",
"refresh_token": "itsarefreshtokeneveryone",
"token_uri": "https://oauth2.googleapis.com/token",
"client_id": "example.apps.googleusercontent.com",
"client_secret": "itsasecrettoeveryone",
"scopes": ["https://www.googleapis.com/auth/gmail.readonly"],
}
class TestGmailService(ConfigTest):
def setUp(self):
super(TestGmailService, self).setUp()
self.config = configparser.RawConfigParser()
self.config.add_section("general")
self.config.add_section("myservice")
mock_data = mock.Mock()
mock_data.path = self.tempdir
self.config.data = mock_data
self.service_config = ServiceConfig(GmailService.CONFIG_PREFIX, self.config, "myservice")
def test_get_credentials_exists_and_valid(self):
mock_api = mock.Mock()
gmail.GmailService.build_api = mock_api
service = GmailService(self.config, "general", "myservice")
expected = Credentials(**copy(TEST_CREDENTIAL))
self.assertEqual(expected.valid, True)
with open(service.credentials_path, "wb") as token:
pickle.dump(expected, token)
self.assertEqual(service.get_credentials().to_json(), expected.to_json())
@skip('Fails for reproducible builds in expired_credential.valid')
def test_get_credentials_with_refresh(self):
mock_api = mock.Mock()
gmail.GmailService.build_api = mock_api
service = GmailService(self.config, "general", "myservice")
expired_credential = Credentials(**copy(TEST_CREDENTIAL))
expired_credential.expiry = datetime.now()
self.assertEqual(expired_credential.valid, False)
with open(service.credentials_path, "wb") as token:
pickle.dump(expired_credential, token)
with patch("google.oauth2._client.refresh_grant") as mock_refresh_grant:
access_token = "newaccesstoken"
refresh_token = "newrefreshtoken"
expiry = datetime.now() + timedelta(hours=24)
grant_response = {"id_token": "idtoken"}
mock_refresh_grant.return_value = access_token, refresh_token, expiry, grant_response
refreshed_credential = service.get_credentials()
self.assertEqual(refreshed_credential.valid, True)
TEST_THREAD = {
"messages": [
{
"payload": {
"headers": [
{"name": "From", "value": "Foo Bar <foobar@example.com>"},
{"name": "Subject", "value": "Regarding Bugwarrior"},
{"name": "To", "value": "ct@example.com"},
{
"name": "Message-ID",
"value": "<CMCRSF+6r=x5JtW4wlRYR5qdfRq+iAtSoec5NqrHvRpvVgHbHdg@mail.gmail.com>",
},
],
"parts": [{}],
},
"snippet": "Bugwarrior is great",
"internalDate": 1546722467000,
"threadId": "1234",
"labelIds": ["IMPORTANT", "Label_1", "Label_43", "CATEGORY_PERSONAL"],
"id": "9999",
}
],
"id": "1234",
}
TEST_LABELS = [
{"id": "IMPORTANT", "name": "IMPORTANT"},
{"id": "CATEGORY_PERSONAL", "name": "CATEGORY_PERSONAL"},
{"id": "Label_1", "name": "sticky"},
{"id": "Label_43", "name": "postit"},
]
class TestGmailIssue(AbstractServiceTest, ServiceTest):
SERVICE_CONFIG = {
'gmail.add_tags': 'added',
'gmail.login_name': 'test@example.com',
}
def setUp(self):
super(TestGmailIssue, self).setUp()
mock_api = mock.Mock()
mock_api().users().labels().list().execute.return_value = {'labels': TEST_LABELS}
mock_api().users().threads().list().execute.return_value = {'threads': [{'id': TEST_THREAD['id']}]}
mock_api().users().threads().get().execute.return_value = TEST_THREAD
gmail.GmailService.build_api = mock_api
self.service = self.get_mock_service(gmail.GmailService, section='test_section')
def test_config_paths(self):
credentials_path = os.path.join(
self.service.config.data.path,
'gmail_credentials_test_example_com.pickle')
self.assertEqual(self.service.credentials_path, credentials_path)
def test_to_taskwarrior(self):
thread = TEST_THREAD
issue = self.service.get_issue_for_record(
thread,
gmail.thread_extras(thread, self.service.get_labels()))
expected = {
'annotations': [],
'entry': datetime(2019, 1, 5, 21, 7, 47, tzinfo=tzutc()),
'gmailthreadid': '1234',
'gmaillastmessageid': 'CMCRSF+6r=x5JtW4wlRYR5qdfRq+iAtSoec5NqrHvRpvVgHbHdg@mail.gmail.com',
'gmailsnippet': 'Bugwarrior is great',
'gmaillastsender': 'Foo Bar',
'tags': {'postit', 'sticky'},
'gmailsubject': 'Regarding Bugwarrior',
'gmailurl': 'https://mail.google.com/mail/u/0/#all/1234',
'gmaillabels': 'CATEGORY_PERSONAL IMPORTANT postit sticky',
'priority': u'M',
'gmaillastsenderaddr': 'foobar@example.com'}
taskwarrior = issue.to_taskwarrior()
taskwarrior['tags'] = set(taskwarrior['tags'])
self.assertEqual(taskwarrior, expected)
def test_issues(self):
issue = next(self.service.issues())
expected = {
'annotations': ['@Foo Bar - Regarding Bugwarrior'],
'entry': datetime(2019, 1, 5, 21, 7, 47, tzinfo=tzutc()),
'gmailthreadid': '1234',
'gmaillastmessageid': 'CMCRSF+6r=x5JtW4wlRYR5qdfRq+iAtSoec5NqrHvRpvVgHbHdg@mail.gmail.com',
'gmailsnippet': 'Bugwarrior is great',
'gmaillastsender': 'Foo Bar',
'description': u'(bw)Is#1234 - Regarding Bugwarrior .. https://mail.google.com/mail/u/0/#all/1234',
'priority': u'M',
'tags': {'added', 'postit', 'sticky'},
'gmailsubject': 'Regarding Bugwarrior',
'gmailurl': 'https://mail.google.com/mail/u/0/#all/1234',
'gmaillabels': 'CATEGORY_PERSONAL IMPORTANT postit sticky',
'gmaillastsenderaddr': 'foobar@example.com'}
taskwarrior = issue.get_taskwarrior_record()
taskwarrior['tags'] = set(taskwarrior['tags'])
self.assertEqual(taskwarrior, expected)
def test_last_sender(self):
test_thread = {
'messages': [
{
'payload':
{
'headers': [
{'name': 'From', 'value': 'Xyz <xyz@example.com'}
]
}
},
{
'payload':
{
'headers': [
{'name': 'From', 'value': 'Foo Bar <foobar@example.com'}
]
}
},
]
}
self.assertEqual(gmail.thread_last_sender(test_thread), ('Foo Bar', 'foobar@example.com'))
|
