forked from ewsterrenburg/python-otrs
/
tests.py
319 lines (281 loc) · 11.7 KB
/
tests.py
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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
from unittest import TestCase
import os
import xml.etree.ElementTree as etree
from otrs.client import GenericTicketConnector
from otrs.objects import Ticket, Article
REQUIRED_VARS = 'OTRS_LOGIN', 'OTRS_PASSWORD', 'OTRS_SERVER', 'OTRS_WEBSERVICE'
MISSING_VARS = []
for i in REQUIRED_VARS:
if not i in os.environ.keys():
MISSING_VARS.append(i)
else:
(locals())[i] = os.environ[i]
SAMPLE_TICKET = """<Ticket>
<Age>346654</Age>
<ArchiveFlag>n</ArchiveFlag>
<ChangeBy>2</ChangeBy>
<Changed>2014-05-16 11:24:19</Changed>
<CreateBy>1</CreateBy>
<CreateTimeUnix>1400234702</CreateTimeUnix>
<Created>2014-05-16 10:05:02</Created>
<CustomerID>9</CustomerID>
<CustomerUserID>foo@bar.tld</CustomerUserID>
<EscalationResponseTime>0</EscalationResponseTime>
<EscalationSolutionTime>0</EscalationSolutionTime>
<EscalationTime>0</EscalationTime>
<EscalationUpdateTime>0</EscalationUpdateTime>
<GroupID>1</GroupID>
<Lock>unlock</Lock>
<LockID>1</LockID>
<Owner>fbarman</Owner>
<OwnerID>2</OwnerID>
<Priority>3 normal</Priority>
<PriorityID>3</PriorityID>
<Queue>Support</Queue>
<QueueID>2</QueueID>
<RealTillTimeNotUsed>0</RealTillTimeNotUsed>
<Responsible>admin</Responsible>
<ResponsibleID>1</ResponsibleID>
<SLAID/>
<ServiceID/>
<State>closed unsuccessful</State>
<StateID>3</StateID>
<StateType>closed</StateType>
<TicketID>32</TicketID>
<TicketNumber>515422152827</TicketNumber>
<Title>Foofoo my title</Title>
<Type>Divers</Type>
<TypeID>1</TypeID>
<UnlockTimeout>1400239459</UnlockTimeout>
<UntilTime>0</UntilTime>
</Ticket>
"""
SAMPLE_TICKET_W_ARTICLES = """<Ticket>
<Age>863982</Age>
<ArchiveFlag>n</ArchiveFlag>
<Article>
<Age>863982</Age>
<AgeTimeUnix>863982</AgeTimeUnix>
<ArticleID>101</ArticleID>
<ArticleType>email-external</ArticleType>
<ArticleTypeID>1</ArticleTypeID>
<Body>
Bonjour,
Voir echange ci-dessous.
Cdlt.
</Body>
<Cc>ACME-CORP - John DOE <john.doe@exemple.fr></Cc>
<CcRealname>ACME-CORP - John DOE</CcRealname>
<Changed>2014-05-16 11:24:19</Changed>
<Charset>utf-8</Charset>
<ContentCharset>utf-8</ContentCharset>
<ContentType>text/plain; charset=utf-8</ContentType>
<CreateTimeUnix>1400234702</CreateTimeUnix>
<Created>2014-05-16 10:05:02</Created>
<CreatedBy>1</CreatedBy>
<CustomerID>9</CustomerID>
<CustomerUserID>john.doe@exemple.fr</CustomerUserID>
<EscalationResponseTime>0</EscalationResponseTime>
<EscalationSolutionTime>0</EscalationSolutionTime>
<EscalationTime>0</EscalationTime>
<EscalationUpdateTime>0</EscalationUpdateTime>
<From>John DOE <john.doe@exemple.fr></From>
<FromRealname>John DOE</FromRealname>
<InReplyTo><1586719931.242426547.1400234690351.JavaMail.zimbra@exemple.fr></InReplyTo>
<IncomingTime>1400234702</IncomingTime>
<Lock>unlock</Lock>
<LockID>1</LockID>
<MessageID><1586719931.242426547.1400234690351.JavaMail.zimbra@exemple.fr></MessageID>
<MimeType>text/plain</MimeType>
<Owner>admin</Owner>
<OwnerID>2</OwnerID>
<Priority>3 normal</Priority>
<PriorityID>3</PriorityID>
<Queue>Support</Queue>
<QueueID>2</QueueID>
<RealTillTimeNotUsed>0</RealTillTimeNotUsed>
<References />
<ReplyTo />
<Responsible>admin</Responsible>
<ResponsibleID>1</ResponsibleID>
<SLA />
<SLAID />
<SenderType>customer</SenderType>
<SenderTypeID>3</SenderTypeID>
<Service />
<ServiceID />
<State>closed unsuccessful</State>
<StateID>3</StateID>
<StateType>closed</StateType>
<Subject>Title</Subject>
<TicketID>32</TicketID>
<TicketNumber>515422152827</TicketNumber>
<Title>TEST msg</Title>
<To>support test <support-test@exemple.fr> </To>
<ToRealname>Support test</ToRealname>
<Type>Divers</Type>
<TypeID>1</TypeID>
<UntilTime>0</UntilTime>
</Article>
<ChangeBy>2</ChangeBy>
<Changed>2014-05-16 11:24:19</Changed>
<CreateBy>1</CreateBy>
<CreateTimeUnix>1400234702</CreateTimeUnix>
<Created>2014-05-16 10:05:02
</Created>
<CustomerID>9
</CustomerID>
<CustomerUserID>john.doe@exemple.fr</CustomerUserID>
<EscalationResponseTime>0</EscalationResponseTime>
<EscalationSolutionTime>0</EscalationSolutionTime>
<EscalationTime>0</EscalationTime>
<EscalationUpdateTime>0</EscalationUpdateTime>
<GroupID>1</GroupID>
<Lock>unlock</Lock>
<LockID>1</LockID>
<Owner>admin</Owner>
<OwnerID>2</OwnerID>
<Priority>3 normald</Priority>
<PriorityID>3</PriorityID>
<Queue>Support</Queue>
<QueueID>2</QueueID>
<RealTillTimeNotUsed>0</RealTillTimeNotUsed>
<Responsible>admin</Responsible>
<ResponsibleID>1</ResponsibleID>
<SLAID />
<ServiceID />
<State>closed unsuccessful</State>
<StateID>3</StateID>
<StateType>closed</StateType>
<TicketID>32</TicketID>
<TicketNumber>515422152827</TicketNumber>
<Title>Test ticket</Title>
<Type>Divers</Type>
<TypeID>1</TypeID>
<UnlockTimeout>1400239459</UnlockTimeout>
<UntilTime>0</UntilTime>
</Ticket>"""
if not MISSING_VARS:
class TestOTRSAPI(TestCase):
def setUp(self):
self.c = GenericTicketConnector(OTRS_SERVER, OTRS_WEBSERVICE)
self.c.register_credentials(OTRS_LOGIN, OTRS_PASSWORD)
def test_session_create(self):
sessid = self.c.session_create(user_login = OTRS_LOGIN,
password = OTRS_PASSWORD)
self.assertEqual(len(sessid), 32)
def test_ticket_get(self):
t = self.c.ticket_get(32)
self.assertEqual(t.TicketID, 32)
self.assertEqual(t.StateType, 'closed')
def test_ticket_get_with_articles(self):
t = self.c.ticket_get(32, get_articles=True)
self.assertEqual(t.TicketID, 32)
self.assertEqual(t.StateType, 'closed')
articles = t.articles()
self.assertIsInstance(articles, (list, tuple))
self.assertIsInstance(articles[0], Article)
self.assertEqual(articles[0].SenderType, 'customer')
def test_ticket_search(self):
t_list = self.c.ticket_search(CustomerID=9)
self.assertIsInstance(t_list, list)
self.assertIn(32, t_list)
def test_ticket_create(self):
t = Ticket(State='new', Priority='3 normal', Queue='Support',
Title='Problem test', CustomerUser='foo@exemple.fr',
Type='Divers')
a = Article(Subject='UnitTest', Body='bla', Charset='UTF8',
MimeType='text/plain')
t_id, t_number = self.c.ticket_create(t, a)
self.assertIsInstance(t_id, int)
self.assertIsInstance(t_number, int)
self.assertTrue(len(str(t_number)) >= 12)
def test_ticket_update_attrs_by_id(self):
t = Ticket(State='new', Priority='3 normal', Queue='Support',
Title='Problem test', CustomerUser='foo@exemple.fr',
Type='Divers')
a = Article(Subject='UnitTest', Body='bla', Charset='UTF8',
MimeType='text/plain')
t_id, t_number = self.c.ticket_create(t, a)
t = Ticket(Title='Foubar')
upd_tid, upd_tnumber = self.c.ticket_update(ticket_id=t_id, ticket=t)
self.assertIsInstance(upd_tid, int)
self.assertIsInstance(upd_tnumber, int)
self.assertTrue(len(str(upd_tnumber)) >= 12)
self.assertEqual(upd_tid, t_id)
self.assertEqual(upd_tnumber, t_number)
upd_t = self.c.ticket_get(t_id)
self.assertEqual(upd_t.Title, 'Foubar')
self.assertEqual(upd_t.Queue, 'Support')
def test_ticket_update_attrs_by_number(self):
t = Ticket(State='new', Priority='3 normal', Queue='Support',
Title='Problem test', CustomerUser='foo@exemple.fr',
Type='Divers')
a = Article(Subject='UnitTest', Body='bla', Charset='UTF8',
MimeType='text/plain')
t_id, t_number = self.c.ticket_create(t, a)
t = Ticket(Title='Foubar')
upd_tid, upd_tnumber = self.c.ticket_update(ticket_number=t_number,
ticket=t)
self.assertIsInstance(upd_tid, int)
self.assertIsInstance(upd_tnumber, int)
self.assertTrue(len(str(upd_tnumber)) >= 12)
self.assertEqual(upd_tid, t_id)
self.assertEqual(upd_tnumber, t_number)
upd_t = self.c.ticket_get(t_id)
self.assertEqual(upd_t.Title, 'Foubar')
self.assertEqual(upd_t.Queue, 'Support')
def test_ticket_update_new_article(self):
t = Ticket(State='new', Priority='3 normal', Queue='Support',
Title='Problem test', CustomerUser='foo@exemple.fr',
Type='Divers')
a = Article(Subject='UnitTest', Body='bla', Charset='UTF8',
MimeType='text/plain')
t_id, t_number = self.c.ticket_create(t, a)
a2 = Article(Subject='UnitTest2', Body='bla', Charset='UTF8',
MimeType='text/plain')
a3 = Article(Subject='UnitTest3', Body='bla', Charset='UTF8',
MimeType='text/plain')
self.c.ticket_update(t_id, article=a2)
self.c.ticket_update(t_id, article=a3)
t_upd = self.c.ticket_get(t_id, get_articles=True)
arts_upd = t_upd.articles()
self.assertIsInstance(arts_upd, list)
self.assertEqual(len(arts_upd), 4)
self.assertEqual(arts_upd[0].Subject, 'UnitTest')
# article 1 is an auto response
self.assertEqual(arts_upd[2].Subject, 'UnitTest2')
self.assertEqual(arts_upd[3].Subject, 'UnitTest3')
else:
print 'Set OTRS_LOGIN and OTRS_PASSWORD env vars if you want "real"'+\
'tests against a real OTRS to be run'
class TestObjects(TestCase):
def test_ticket(self):
t = Ticket(TicketID=42, EscalationResponseTime='43')
self.assertEqual(t.TicketID,42)
self.assertEqual(t.EscalationResponseTime, 43)
def test_ticket_from_xml(self):
xml = etree.fromstring(SAMPLE_TICKET)
t = Ticket.from_xml(xml)
self.assertEqual(t.TicketID, 32)
self.assertEqual(t.CustomerUserID, 'foo@bar.tld')
def test_ticket_from_xml_with_articles(self):
xml = etree.fromstring(SAMPLE_TICKET_W_ARTICLES)
t = Ticket.from_xml(xml)
self.assertEqual(t.TicketID, 32)
self.assertEqual(t.CustomerUserID, 'john.doe@exemple.fr')
articles = t.articles()
self.assertIsInstance(articles, list)
self.assertEqual(len(articles), 1)
self.assertIsInstance(articles[0], Article)
self.assertEqual(articles[0].AgeTimeUnix, 863982)
def test_ticket_to_xml(self):
t = Ticket(State='open', Priority='3 normal', Queue='Support')
xml = t.to_xml()
xml_childs = xml.getchildren()
xml_childs_dict = {i.tag: i.text for i in xml_childs}
self.assertEqual(xml.tag, 'Ticket')
self.assertEqual(len(xml_childs), 3)
self.assertEqual(xml_childs_dict['State'], 'open')
self.assertEqual(xml_childs_dict['Priority'], '3 normal')
self.assertEqual(xml_childs_dict['Queue'], 'Support')