forked from dougn/python-testtrackpro
-
Notifications
You must be signed in to change notification settings - Fork 1
/
testtrackpro.py
1054 lines (871 loc) · 39.6 KB
/
testtrackpro.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
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""TestTrack Python Interface
`TestTrack Pro`_ is the Issue Management software from `Seapine Software`_.
`TestTrack`_ is a registered trademark of `Seapine Software`_.
This library uses the `suds`_ library to talk to the TestTrack SDK SOAP API
and includes some helpful extensions for managing your client code and
interactions.
Seapine documentation provides a number of python samples for interacting
with the `TestTrack SOAP API`_, but there are a number of problems with their
`TestTrack Python Tutorial`_.
The sample tutorial has syntax and functional errors, and does not work with
the latest versions of `TestTrack`_ and `suds`_. Even with the versions of
python and the `suds`_ library mentioned, the code will crash due to WSDL
non-compliance issues when custom fields are used.
This module addresses these issues as well as provides a more managed interface
to simplify development.
TestTrack API 'cookie' Management
---------------------------------
The `TestTrack SDK`_ SOAP API uses a client cookie argument on almost every
call. You end up writting code where every API call starts with ``cookie``.
.. code:: python
# What object types can I query?
adt = server.service.getTableList(cookie)
# What field data is available for a given object type?
atc = server.service.getColumnsForTable(cookie, tablename)
# What filters are available?
af = server.service.getFilterList(cookie)
# Get defect 42
d = server.service.getDefect(cookie, 42)
# log out
server.service.DatabaseLogoff(cookie)
You can view this argument as an implicit self for this python interface to
that API. That is you do not need to supply the cookie argument, as it will
be managed for you in the client object.
.. code:: python
import testtrackpro
ttp = testtrackpro.TTP('http://hostname/', 'Project', 'username', 'password')
adt = ttp.getTableList()
atc = ttp.getColumnsForTable(tablename)
defect = ttp.getDefect(42) # maps to getDefect(cookie, 42)
ttp.DatabaseLogoff()
Python Contexts
---------------
Due to the implicit write locks (with 15 min timeout) on all edit API calls,
clients normally would have to be very careful to trap all exceptions and
capture any and all locked entities and un lock them as part of the exception
handling. Thankfully python provides contexts via the 'with' statement that
are designed for exactly this problem.
All `suds`_ objects returned be API calls which start with the string 'edit'
will return `suds`_ objects which have been extended to be python contexts
which can be used with the ``with`` statement:
.. code:: python
with ttp.editDefect(42) as defect:
defect.priority = "Immediate"
At the end of the ``with`` block, a call to ``ttp.saveDefect(defect)`` will be
made automatically, saving any pending edits, and releasing the lock.
Explicit calls to ``saveDefect`` or ``cancelSaveDefect`` also work within
the context block.
If an exception occurs, then a call to ``ttp.cancelSaveDefect(defect.recordid)``
will be made automatically to release the lock, without saving the defect.
Also the TTP instance object is also a context object, and will log the session
out when used in a ``with`` statement.
.. code:: python
with testtrackpro.TTP('http://hostname/', 'Project', 'username', 'password') as ttp:
defect = ttp.getDefect(42)
## ttp.DatabaseLogOff() implicitly called on success or error
Edit Locks
----------
As mentioned above, only one person can be editing an entity at a time on the
TestTrack server. This means that you will often get an error trying to edit
an entity, and there is no clean way of detecting if an entity is currently
locked or not; due to race conditions.
This leads to some painful defensive programming for this very common
occurance.
.. code:: python
failed_to_edit = []
for id in defect_ids_to_edit:
try:
with ttp.editDefect(id) as defect:
defect.summary = "new changed title"
## bunch of other code
except TTPAPIError, e:
## the edit lock error is code 22, and it is a string.
if e.fault and e.fault.detail == "22":
failed_to_edit.append(id)
else:
## unexpected error, re-raise it.
raise e
This is much more work than it should be. and the try/except work being done
here is again what contexts are supposed to simplify. So every edit API call
has been extended to have a new keyword argument ``ignoreEditLockError`` that
defaults to ``False``. When set to ``True`` it will swallow the TTPAPIError
code ``"22"``. The object returned will be an empty entity of the proper type.
This will be a context entity, just as if the call had succeeded. This means
that the edit entity status functions will work on the entity.
.. code:: python
failed_to_edit = []
for id in defect_ids_to_edit:
with ttp.editDefect(id, ignoreEditLockError=True) as defect:
## helper to immediatly stop processing
break_context_on_edit_lock_failure(defect)
defect.summary = "new changed title"
## bunch of other code
if edit_lock_failed(defect):
failed_to_edit.append(id)
.. note:: Only the edit lock error ``"22"`` is captured. All other errors must
be handled explictly in your code.
.. warning::
A new empty entity is returned when ``ignoreEditLockError`` is
set to ``True``. This means you MUST test to see if you have the
real entity to work with.
>>> d = ttp.editDefect(1, ignoreEditLockError=True)
>>> print d.recordid
None
>>> edit_lock_failed(d)
True
>>> have_edit_lock(d)
False
>>>
.. _suds: https://fedorahosted.org/suds/
.. _suds plugins: https://fedorahosted.org/suds/wiki/Documentation#PLUGINS
.. _Seapine Software: http://www.seapine.com/
.. _TestTrack: http://www.seapine.com/testtrack.html
.. _TestTrack Pro: http://www.seapine.com/ttpro.html
.. _TestTrack SOAP API: http://labs.seapine.com/TestTrackSDK.php
.. _TestTrack SDK: http://labs.seapine.com/TestTrackSDK.php
.. _TestTrack Python Tutorial: http://labs.seapine.com/wiki/index.php/TestTrack_SOAP_SDK_Tutorial_-_Python
Module Documentation
--------------------
"""
import logging
import re
import suds
import contextlib
import functools
import urlparse
## Exception Error Transformations
import urllib2 #.URLError
import xml.sax._exceptions #.SAXParseException
## Deal with TestTrackPro WSDL non-conformities
import suds.plugin ## cleanup TestTrack data vs dateTime WSDL errors
import suds.mx.encoded ## monkey patch for polymorphic arrays
__version__ = [1,0,2]
__version_string__ = '.'.join(str(x) for x in __version__)
__author__ = 'Anthony Burchette'
__email__ = '[email protected]'
__original_author__ = 'Doug Napoleone'
__original_author_email__ = '[email protected]'
_bad_date_as_datetime_re = re.compile(
'\<element name="(?P<name>date(?!time)[a-z]+|[a-z]+date|date)" type="xsd:dateTime"')
_bad_date_as_datetime_replace = '<element name="\g<name>" type="xsd:date"'
# Modification by: Anthony Burchette (Technical Support Specialist at Seapine Software)
# Modification: Removed this plugin from the plugins list on line 316.
# As of TestTrack 2014.0.1 (possibly earlier) this fix is longer needed as xsd:date and xsd:dateTime are now in the correct locations in the ttsoapcgi.wsdl
class _TTPWSDLFixPlugin(suds.plugin.DocumentPlugin):
"""There is a very bad bug in the TestTrack WSDL. There are a number
of entries that set the type to be 'dateTime' when the data returned
is always just of type 'date'. This causes SUDS to crash in parsing
the result (like for a getDefect!) To fix this we use a plugin
that will pre-processes the WSDL result. We are also not using
the cache for loading the WSDL because of this, so we do not cause
problems for other clients, just in case.
"""
def loaded(self, context):
if not context.url.endswith('ttsoapcgi.wsdl'):
return
context.document = _bad_date_as_datetime_re.sub(
_bad_date_as_datetime_replace, context.document)
_ttpwsdlfixplugin = _TTPWSDLFixPlugin()
class TTPAPIError(Exception):
"""Base Exception for all API errors.
"""
def __init__(self, *args, **kwdargs):
super(TTPAPIError, self).__init__(*args, **kwdargs)
self._fault = None
self._reason = ""
self._document = None
if len(self.args):
if hasattr(self.args[0], 'fault'):
self._fault = self.args[0].fault
self._reason = self.args[0].fault.faultstring
if hasattr(self.args[0], 'document'):
self._document = self.args[0].document
if hasattr(self.args[0], 'reason'):
self._reason = self.args[0].reason
if isinstance(self.args[0], basestring):
self._reason = self.args[0]
self._reason = self.message
@property
def fault(self):
"""Soap fault Envelope, if there is one, else will be None
"""
return self._fault
@property
def document(self):
"""SOAP document associated with the error if there is one, else will
be None.
"""
return self._document
@property
def reason(self):
"""Low level SOAP or HTTP reason for the error. Will always be a
valid string, but may be empty if no reason can be determined.
Will back off to exception message.
"""
return self._reason
class TTPConnectionError(TTPAPIError):
"""Errors communicating with the TestTrack SOAP Service.
"""
pass
class TTPLogonError(TTPAPIError):
"""Errors with authentication against the TestTrack SOAP Service.
"""
pass
class TTP(object):
"""Client for communicating with the TestTrack SOAP Service.
:param str url: [required] URL to the TestTrack SOAP WSDL File, or CGI EXE.
should be a url which looks like
``http://127.0.0.1/ttsoapcgi.wsdl`` or can be the base
website url ``http://hostname/``.
:param str database_name: Name of the database (Project) to login to.
May be supplied later in the :py:meth:`DatabaseLogon` or
:py:meth:`ProjectLogon` methods.
:param str username: Username to authenticate with.
May be supplied later in the :py:meth:`DatabaseLogon` or
:py:meth:`ProjectLogon` methods.
:param str password: Password to authenticate with.
May be supplied later in the :py:meth:`DatabaseLogon` or
:py:meth:`ProjectLogon` methods.
:param long cookie: Cookie value from another SOAP client session. Useful
for cloning a client session. If you use this argument,
you should not supply the ``database_name``, ``username``,
or ``password`` arguments.
:param list plugins: List of optional `suds plugins`_.
"""
def __init__(self, url,
database_name=None, username=None, password=None,
cookie=None, plugins=None):
self.__method_cache = {}
if not url.endswith('ttsoapcgi.wsdl'):
if url.endswith('ttsoapcgi.exe'):
url = urlparse.urlunsplit(urlparse.urlparse(url)[:2]+('',)*3)
if not url.endswith('/'):
url += '/'
url += 'ttsoapcgi.wsdl'
self._wsdl_url = url
self._cookie = cookie
self._database_name = database_name
self._username = username
self._password = password
self._client = None
if not plugins:
plugins = []
# plugins.append(_ttpwsdlfixplugin) # See note on line 201
try:
self._client = suds.client.Client(
self._wsdl_url, cache=None, plugins=plugins)
except urllib2.URLError, e:
raise TTPConnectionError(e)
except xml.sax._exceptions.SAXParseException, e:
raise TTPConnectionError(
"Library could not connect to the TestTrackPro Soap API. "
"Either this installation of TestTrackPro does not support "
"the API, or the url, %s, is incorrect.\n\nError: %s" % (
self._wsdl_url, e))
if not cookie and database_name and username and password:
self.DatabaseLogon()
def _call_method(self, method, *args, **kwdargs):
try:
return method(self._cookie, *args, **kwdargs)
except urllib2.URLError, e:
raise TTPConnectionError(e)
except suds.WebFault, e:
raise TTPAPIError(e)
def _call_context_method(self, method_name, table, modifier, method,
entity, *args, **kwdargs):
## allow for non-context entities for save and record id's for cancel
context = None
if hasattr(entity, '__context__'):
context = self._get_edit_context(entity)
if context.table != table:
raise TTPAPIError("Wrong type. Calling "+method_name+
' on a '+context.cname+' '+modifier+'.')
res = self._call_method(method, entity, *args, **kwdargs)
if context:
context._locked = False
return res
def _get_edit_context(self, entity):
if not hasattr(entity, '__context__'):
raise TTPAPIError("entity does not have an edit context.")
context = entity.__context__()
if context._ttp is not self:
raise TTPAPIError("entity is not from this client instance.")
return context
def _build_partial(self, method_name):
try:
method = getattr(self._client.service, method_name)
except suds.MethodNotFound, e:
raise TTPAPIError(e)
return functools.partial(self._call_method, method)
def __build_method(self, method_name, method):
if method_name.startswith('edit'):
return functools.partial(_TTPEditContext.call_method,
self, method_name, method)
if method_name.startswith('save'):
return functools.partial(self._call_context_method,
method_name, method_name[4:], 'entity', method)
if method_name.startswith('cancelSave'):
return functools.partial(self._call_context_method,
method_name, method_name[10:], 'recordid', method)
return functools.partial(self._call_method, method)
def __getattr__(self, name):
if name.startswith('__'):
## prevents people from accessing '__len__' and other names which
## would overload things badly. Access through _client for those
raise AttributeError("'%s' Object has no such attribute '%s'" %
self.__class__.__name__, name)
try:
if not self.__method_cache.has_key(name):
method = getattr(self._client.service, name)
self.__method_cache[name] = self.__build_method(name, method)
except suds.MethodNotFound, e:
raise TTPAPIError(e)
return self.__method_cache[name]
def __enter__(self):
return self
def __exit__(self, exc_type, exc_value, traceback):
self.DatabaseLogoff(ignore_exceptions=True)
def create(self, name):
"""Factory Creation for TTPAPI structures
:param str name: SOAP Entity type name.
.. code:: python
## Create a new defect
# Create the CDefect object.
defect = ttp.create("CDefect")
#suds doesn't automatically initialize the record id
defect.recordid = 0;
defect.summary = "This is a new defect"
defect.product = "My Product"
defect.priority = "Immediate"
# Add the defect to TestTrack.
lNewNum = ttp.addDefect(defect)
## Create a new project
project = ttp.create("CProject")
project.database = ttp.create("CDatabase")
project.database.name = "MyProject"
project.options = ttp.create("ArrayOfCProjectDataOption")
project.options.append(ttp.create("CProjectDataOption"))
project.options.append(ttp.create("CProjectDataOption"))
project.options.append(ttp.create("CProjectDataOption"))
project.options[0].name = "TestTrack Pro" # add TTP functionality.
project.options[1].name = "TestTrack TCM" # add TCM functionality.
project.options[2].name = "TestTrack RM" # add RM functionality.
# Add the project to TestTrack.
ttp.ProjectLogon(project, username, password)
"""
return self._client.factory.create(name)
def save(self, entity, *args, **kwdargs):
"""Save the edit locked context entity.
:param CType entity: edit entity returned by a editXXXX method call.
This is handy when you have a an entity but can not easilly get to it's
type programatically. This is useful when you recieve polymorphic
array data back from the TestTrack SOAP API.
In ortherwords you can do this:
.. code:: python
with ttp.editDefect(a) as defecta, ttp.editDefect(b) as defectb:
defecta.something = "value"
ttp.save(defect) ## release the lock immediatly
defectb.other = defecta.other
## defectb is saved
Calling ``ttp.saveDefect(defecta)`` is also safe and
will prevent the call to ``saveDefect(defecta)`` at the end of the
context block.
.. WARNING:: If you are using edit contexts then calls to
``saveDefect`` with a ``CDefect`` for the same defect
from a different API call will result in ``saveDefect``
being called again at the end of the context causing
an error.
Example of errorful code:
.. code:: python
def bad():
getdefect = ttp.getDefect(24)
with ttp.editDefectBeRecordId(getdefect.recordid) as defect:
getdefect.priority = "Immediate"
ttp.saveDefect(getdefect)
## at this point saveDefect(defect) will be called and will
## cause an error as there is no longer an edit lock on
## the defect.
Correct way:
.. code:: python
def good(recordid):
with ttp.editDefectByRecordId(recordid) as defect:
ttp.cancelSave(defect)
## or
with ttp.editDefectByRecordId(recordid) as defect:
ttp.cancelSaveDefect(defect.recordid)
"""
return self._get_edit_context(entity).save(*args, **kwdargs)
def cancelSave(self, entity):
"""Cancel the save of the edit locked context entity.
:param CType entity: edit entity returned by a editXXXX method call.
This is handy when you have a an entity but can not easilly get to it's
type programatically. This is useful when you recieve polymorphic
array data back from the TestTrack SOAP API.
In ortherwords you can do this:
.. code:: python
with ttp.editDefect(defectnum) as defect:
defect.something = "value"
if badthing:
ttp.cancelSave(defect)
Calling ``ttp.cancelSaveDefect(defect.recordid)`` is also safe and
will prevent the call to ``saveDefect`` at the end of the context
block.
.. WARNING:: If you are using edit contexts then calls to
``cancelSaveDefect`` with a ``recordid`` for the entity
in the context which comes from a different structure
will cause an error.
Example of errorful code:
.. code:: python
def bad(recordid):
with ttp.editDefectBeRecordId(recordid) as defect:
ttp.cancelSaveDefect(recordid) ## bad
## at this point saveDefect(defect) will be called
Correct way:
.. code:: python
def good(recordid):
with ttp.editDefectByRecordId(recordid) as defect:
ttp.cancelSave(defect)
## or
with ttp.editDefectByRecordId(recordid) as defect:
ttp.cancelSaveDefect(defect.recordid)
"""
return self._get_edit_context(entity).cancelSave()
def getProjectList(self, username=None, password=None):
"""Return a list of CProject entities which the user has access to
on the server.
:param str username: Username to authenticate with. If not supplied,
and one was supplied on client construction, the client
stored version will be used. This will not update the
client state.
:param str password: PAssword to authenticate with. If not supplied,
and one was supplied on client construction, the client
stored version will be used. This will not update the
client state.
The ``username`` and ``password`` are only required if
they were not supplied on client creation. If supplied they will NOT
replace the client stored username, password, or client cookie.
"""
if not username and self._username:
username = self._username
if not password and self._password:
password = self._password
if not username or not password:
raise TTPAPIError("Must supply a username and password")
try:
result = self._client.service.getProjectList(username, password)
except urllib2.URLError, e:
raise TTPConnectionError(e)
except suds.WebFault, e:
raise TTPLogonError(e)
return result
def ProjectLogon(self, CProject=None, username=None, password=None):
"""Logon to the SOAP API and retrieve a new client cookie.
:param CProject CProject: CProject entity describing a TestTrack
Project Database. It is recommended to use the
:py:meth:`getProjectList` method to retrieve a
valid CProject entity.
:param str username: Username to authenticate with. If supplied, this
will update the client stored ``username``. If not
supplied, it will use the client stored value if one
exists, and error otherwise.
:param str password: Password to authenticate with. If supplied, this
will update the client stored ``username``. If not
supplied, it will use the client stored value if one
exists, and error otherwise.
The appropriate CProject entity can be retrieved using the
:py:meth:`getProjectList` method, of constructing one using the
:py:meth:`create` method.
If the client is currently logged on, it will first logoff. If the
``username`` and or ``password`` are supplied they will update the
client stored versions of these values. If they are not supplied, then
the versions supplied on construction will be used.
This is now the prefered way to logon to TestTrack now that the
:py:meth:`DatabaseLogon` method has been depricated.
"""
if self._cookie:
self.DatabaseLogoff()
database_name = CProject.database.name
if database_name:
self._database_name = database_name
if username:
self._username = username
if password:
self._password = username
if not self._database_name or not self._username or not self._password:
raise TTPAPIError(
"Must supply a valid CProject, username, and password.")
try:
self._cookie = self._client.service.ProjectLogon(
CProject, self._username, self._password)
except urllib2.URLError, e:
raise TTPConnectionError(e)
except suds.WebFault, e:
raise TTPLogonError(e)
def DatabaseLogon(self, database_name=None, username=None, password=None):
"""Logon to the SOAP API and retrieve a new client cookie.
:param str database_name: Project database name to login to.
:param str username: Username to authenticate with. If supplied, this
will update the client stored ``username``. If not
supplied, it will use the client stored value if one
exists, and error otherwise.
:param str password: Password to authenticate with. If supplied, this
will update the client stored ``username``. If not
supplied, it will use the client stored value if one
exists, and error otherwise.
If the client is currently logged on, it will first logoff. If the
``username`` and or ``password`` are supplied they will update the
client stored versions of these values. If they are not supplied, then
the versions supplied on construction will be used.
.. warning:: The :py:meth:`DatabaseLogon` API method has been
depricated by Seapine, and should no longer be used.
The :py:meth:`ProjectLogon` API method should be used
instead.
"""
if self._cookie:
self.DatabaseLogoff()
if database_name:
self._database_name = database_name
if username:
self._username = username
if password:
self._password = username
if not self._database_name or not self._username or not self._password:
raise TTPAPIError(
"Must supply a valid database_name, username, and password.")
try:
self._cookie = self._client.service.DatabaseLogon(
self._database_name, self._username, self._password)
except urllib2.URLError, e:
raise TTPConnectionError(e)
except suds.WebFault, e:
raise TTPLogonError(e)
def DatabaseLogoff(self, ignore_exceptions=False):
"""Log out of the SOAP API session, and release the stored client
cookie.
:param bool ignore_exceptions: Set this to true to ignore connection
and authentication based API errors.
It can be useful to ignore connection and authenticaiton based errors
when logging out, especially when using the client as a context.
If there was an error communicating with the client, we want to ignore
further errors due to the implicit logoff at the end of the context
to preserve the ogitional initial connection error.
"""
if not self._cookie or not self._client:
return
try:
self._client.service.DatabaseLogoff(self._cookie)
self._cookie = None
except Exception, e:
self._cookie = None
if str(e) != "Server raised fault: 'Session Dropped.'":
if not ignore_exceptions:
raise TTPLogonError(e)
else:
logging.warn(
"Exception while attempting to logout "
"with a call to: DatabaseLogoff\dError: " + str(e))
def _get_context(edit_context_entity):
context = getattr(edit_context_entity, '__context__', lambda : None)()
if not context:
raise TTPAPIError("Not an edit context entity object.")
return context
def is_edit_context_entity(edit_context_entity):
"""Is this an edit context entity (object returned by ttp.editXXX())
that can be safely used with the status functions in this module,
and use in contexts.
"""
return hasattr(edit_context_entity, '__context__')
def edit_lock_failed(edit_context_entity):
"""Helper function to check if an edit context entity errored on getting
the edit lock. This is useful in conjunction with the special edit API
argument ignoreEditLockError=True, which will supress the failed edit lock
exception.
.. code:: python
with ttp.editDefect(1, ignoreEditLockError=True) as defect:
defect.priority = "Immediate"
if edit_lock_failed(defect):
# deal with the issue
pass
"""
return _get_context(edit_context_entity).lock_failed
def break_context_on_edit_lock_failure(*edit_context_entities):
"""Force immediate break in the with context if the edit lock failed.
.. code:: python
with ttp.editDefect(1, ignoreEditLockError=True) as defect:
break_context_on_edit_lock_failure(defect) ## stop processing here
defect.priority = "Immediate"
if edit_lock_failed(defect):
# deal with the issue
pass
for multiple with statements:
.. code:: python
with ttp.editDefect(1, ignoreEditLockError=True) as a:
with ttp.editDefect(2, ignoreEditLockError=True) as b, ttp.editDefect(3, ignoreEditLockError=True) as c:
## will break out to top if a failed lock
break_context_on_edit_lock_failure(a,b,c)
"""
for entity in edit_context_entities:
error = _get_context(entity).lock_error
if error:
raise error
## return true so it can be used in an all call.
return True
def have_edit_lock(edit_context_entity):
"""Helper function to check if an edit context entity is still open
for edit.
.. code:: python
with ttp.editDefect(1) as defect:
if defect.priority == "Immediate":
ttp.cancelSave(defect)
# ...
# more code
# ...
if have_edit_lock(defect):
defect.Summary = "Updated Summary"
assert not have_edit_lock(defect)
"""
return _get_context(edit_context_entity).locked
def has_errored(edit_context_entity):
"""Helper function to check if an edit context entity errored.
This is useful when you capture and ignore an error, or as part of error
handling.
.. code:: python
try:
with ttp.editDefect(1) as defect:
defect.priority = "Immediate"
raise RuntimeError('some error')
except:
# This is bad code, please do not do this.
pass
if has_errored(defect):
# deal with the issue
pass
"""
return _get_context(edit_context_entity).errored
def was_saved(edit_context_entity):
"""Helper function to check if an edit context entity was saved.
This is useful in conjunction with the special edit API argument
ignoreEditLockError=True, which will supress the failed edit lock
exception, and when the potential for a cancelSave was issued.
.. code:: python
with ttp.editDefect(1, ignoreEditLockError=True) as defect:
if defect.priority == "Immediate":
ttp.cancelSave(defect)
defect.priority = "Immediate"
if was_saved(defect):
# The priority was changed
pass
elif has_errored(defect):
# It was not saved due to an error
if edit_lock_failed(defect):
# because the edit lock failed
pass
else:
# because of some other error
pass
"""
return _get_context(edit_context_entity).saved
class _long(long):
pass
class _TTPEditContext(object):
@classmethod
def call_method(cls, ttp, method_name, method,
*args, **kwdargs):
context = cls(ttp, method_name, method,
*args, **kwdargs)
entity = context.entity
entity.__enter__ = context.__enter__
entity.__exit__ = context.__exit__
entity.__context__ = context.__context__
if entity.recordid is not None:
entity.recordid = _long(entity.recordid)
entity.recordid.__context__ = context.__context__
return entity
def __init__(self, ttp, method_name, method,
*args, **kwdargs):
self._locked = False
self._ttp = ttp
self._method_name = method_name
ignoreEditLockError = False
if 'ignoreEditLockError' in kwdargs:
ignoreEditLockError = kwdargs.pop('ignoreEditLockError')
self._ignore_lock_error = ignoreEditLockError
if method_name.endswith('ByRecordID'):
self._editbyid_name = method_name
self._edit_name = method_name[:-10]
else:
self._editbyid_name = method_name + 'ByRecordID'
self._edit_name = method_name
self._table = self._edit_name[4:]
self._name = 'C' + self._table
self._cancel_name = 'cancelSave' + self._table
self._save_name = 'save' + self._table
self._save = ttp._build_partial(self._save_name)
self._cancel = ttp._build_partial(self._cancel_name)
self._errored = False
self._success = False
self._saved = False
self._lock_failed = True
self._lock_error = None
try:
self._entity = ttp._call_method(method, *args, **kwdargs)
except TTPAPIError, e:
self._lock_error = e
if (ignoreEditLockError and e.fault and e.fault.detail == '22'):
## Someone else has this entity locked.
logging.warn(str(e))
self._entity = ttp.create(self._name)
else:
raise e
else:
self._lock_failed = False
self._locked = True
def __context__(self):
return self
def __enter__(self):
return self._entity
def __exit__(self, exc_type, exc_value, traceback):
if exc_type:
self._errored = True
if not self._locked:
if self._ignore_lock_error and exc_value is self._lock_error:
## swallow the lock error, but only if it the one we raised
## and not some other lock error.
return True
return False
if exc_type:
try:
self.cancelSave()
except Exception, e:
logging.warn(
"Exception while attempting to release an edit lock "
"with a call to: " + self._cancel_name +
"\n Error: " + str(e))
self._success = False
else:
try:
self.save()
except Exception, e:
self._errored = True
logging.warn(
"Exception while attempting to release an edit lock "
"with a call to: " + self._save_name +
"\n Error: " + str(e))
try:
self.cancelSave()
except Exception, ex:
logging.warn(
"Exception while attempting to release an edit lock "
"with a call to: " + self._cancel_name +
"\n After a failed call to: " + self._save_name +
"\n Error: " + str(ex))
## re-raise the exception on the save
raise e
def __getattr__(self, name):
return getattr(self._entity, name)
def __setattr__(self, name, value):
if not name.startswith('_') and hasattr(self._entity, name):
return setattr(self._entity, name, value)
return object.__setattr__(self, name, value)
@property
def entity(self):
return self._entity
@property
def table(self):
return self._table
@property
def cname(self):
return self._name
@property
def succeeded(self):
return self._success
@property
def errored(self):
return self._errored
@property
def saved(self):
return self._saved
@property
def locked(self):
return self._locked
@property
def lock_failed(self):
return self._lock_failed
@property
def lock_error(self):
return self._lock_error
def save(self, *args, **kwdargs):
#print self._save_name,
if not self._locked:
#print "already unlocked"
return
#print "unlocking"
res = self._save(self._entity,*args,**kwdargs)
self._locked = False
self._success = True
self._saved = True
return res
def cancelSave(self):
#print self._cancel_name,
if not self._locked:
#print "already unlocked"
return
#print "unlocking"
res = self._cancel(self._entity.recordid)
self._locked = False
self._success = True
self._saved = False
return res
def _polymprphic_cast(self, content):
"""TestTrack WSDL has polymorphic arrays.