/
models.py
863 lines (689 loc) · 28.5 KB
/
models.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
# -*- coding: utf-8 -*-
from datetime import datetime
from django.conf import settings
from django.core.urlresolvers import reverse
from django.db import models
from django.db.models import ObjectDoesNotExist
from django.db.models.signals import post_save, post_delete, pre_save
from django.contrib.contenttypes.fields import GenericRelation
from tcms.core.models import TCMSActionModel
from tcms.core.models import TCMSContentTypeBaseModel
from tcms.core.models.fields import DurationField
from tcms.core.utils.checksum import checksum
from tcms.core.utils.timedeltaformat import format_timedelta
from tcms.testcases import signals as case_watchers
from tcms.issuetracker.types import IssueTrackerType
try:
from tcms.core.contrib.plugins_support.signals import register_model
except ImportError:
register_model = None
AUTOMATED_CHOICES = (
(0, 'Manual'),
(1, 'Auto'),
(2, 'Both'),
)
class NoneText:
author = None
case_text_version = 0
action = ''
effect = ''
setup = ''
breakdown = ''
create_date = datetime.now()
@classmethod
def serialize(cls):
return {}
class TestCaseStatus(TCMSActionModel):
id = models.AutoField(
db_column='case_status_id', max_length=6, primary_key=True
)
# FIXME: if name has unique value for each status, give unique constraint
# to this field. Otherwise, all SQL queries filtering upon this
# field will cost much time in the database side.
name = models.CharField(max_length=255)
description = models.TextField(null=True, blank=True)
class Meta:
db_table = u'test_case_status'
verbose_name = "Test case status"
verbose_name_plural = "Test case status"
def __unicode__(self):
return self.name
@classmethod
def get_PROPOSED(cls):
try:
return cls.objects.get(name='PROPOSED')
except cls.DoesNotExist:
return None
@classmethod
def get_CONFIRMED(cls):
try:
return cls.objects.get(name='CONFIRMED')
except cls.DoesNotExist:
return None
@classmethod
def string_to_instance(cls, name):
return cls.objects.get(name=name)
@classmethod
def id_to_string(cls, id):
try:
return cls.objects.get(id=id).name
except cls.DoesNotExist:
return None
def is_confirmed(self):
return self.name == 'CONFIRMED'
class TestCaseCategory(TCMSActionModel):
id = models.AutoField(db_column='category_id', primary_key=True)
name = models.CharField(max_length=255)
product = models.ForeignKey('management.Product', related_name="category")
description = models.TextField(blank=True)
class Meta:
db_table = u'test_case_categories'
verbose_name_plural = u'test case categories'
unique_together = ('product', 'name')
def __unicode__(self):
return self.name
class TestCase(TCMSActionModel):
case_id = models.AutoField(max_length=10, primary_key=True)
create_date = models.DateTimeField(db_column='creation_date', auto_now_add=True)
is_automated = models.IntegerField(db_column='isautomated', default=0)
is_automated_proposed = models.BooleanField(default=False)
script = models.TextField(blank=True)
arguments = models.TextField(blank=True)
extra_link = models.CharField(max_length=1024, default=None, blank=True, null=True)
summary = models.CharField(max_length=255, blank=True)
requirement = models.CharField(max_length=255, blank=True)
alias = models.CharField(max_length=255, blank=True)
estimated_time = DurationField(db_column='estimated_time', default=0)
notes = models.TextField(blank=True)
case_status = models.ForeignKey(TestCaseStatus)
category = models.ForeignKey(TestCaseCategory, related_name='category_case')
priority = models.ForeignKey('management.Priority', related_name='priority_case')
author = models.ForeignKey('auth.User', related_name='cases_as_author')
default_tester = models.ForeignKey('auth.User',
related_name='cases_as_default_tester',
blank=True,
null=True)
reviewer = models.ForeignKey('auth.User',
related_name='cases_as_reviewer',
null=True)
attachment = models.ManyToManyField('management.TestAttachment', related_name='cases',
through='testcases.TestCaseAttachment')
# FIXME: related_name should be cases instead of case. But now keep it
# named case due to historical reason.
plan = models.ManyToManyField('testplans.TestPlan', related_name='case',
through='testcases.TestCasePlan')
component = models.ManyToManyField('management.Component', related_name='cases',
through='testcases.TestCaseComponent')
tag = models.ManyToManyField('management.TestTag', related_name='cases',
through='testcases.TestCaseTag')
# Auto-generated attributes from back-references:
# 'texts' : list of TestCaseTexts (from TestCaseTexts.case)
class Meta:
db_table = u'test_cases'
def __unicode__(self):
return self.summary
@classmethod
def to_xmlrpc(cls, query=None):
from tcms.xmlrpc.serializer import TestCaseXMLRPCSerializer
from tcms.xmlrpc.utils import distinct_filter
_query = query or {}
qs = distinct_filter(TestCase, _query).order_by('pk')
s = TestCaseXMLRPCSerializer(model_class=cls, queryset=qs)
return s.serialize_queryset()
@classmethod
def create(cls, author, values):
"""
Create the case element based on models/forms.
"""
case = cls.objects.create(
author=author,
is_automated=values['is_automated'],
is_automated_proposed=values['is_automated_proposed'],
# sortkey = values['sortkey'],
script=values['script'],
arguments=values['arguments'],
extra_link=values['extra_link'],
summary=values['summary'],
requirement=values['requirement'],
alias=values['alias'],
estimated_time=values['estimated_time'],
case_status=values['case_status'],
category=values['category'],
priority=values['priority'],
default_tester=values['default_tester'],
notes=values['notes'],
)
tags = values.get('tag')
if tags:
map(lambda c: case.add_tag(c), tags)
return case
@classmethod
def update(cls, case_ids, values):
if isinstance(case_ids, int):
case_ids = [case_ids, ]
fields = [field.name for field in cls._meta.fields]
tcs = cls.objects.filter(pk__in=case_ids)
_values = dict((k, v) for k, v in values.items() if
k in fields and v is not None and v != u'')
if values['notes'] == u'':
_values['notes'] = u''
if values['script'] == u'':
_values['script'] = u''
tcs.update(**_values)
return tcs
@classmethod
def list(cls, query, plan=None):
"""List the cases with request"""
from django.db.models import Q
if not plan:
q = cls.objects
else:
q = cls.objects.filter(plan=plan)
if query.get('case_id_set'):
q = q.filter(pk__in=query['case_id_set'])
if query.get('search'):
q = q.filter(
Q(pk__icontains=query['search']) |
Q(summary__icontains=query['search']) |
Q(author__email__startswith=query['search'])
)
if query.get('summary'):
q = q.filter(Q(summary__icontains=query['summary']))
if query.get('author'):
q = q.filter(
Q(author__first_name__startswith=query['author']) |
Q(author__last_name__startswith=query['author']) |
Q(author__username__icontains=query['author']) |
Q(author__email__startswith=query['author'])
)
if query.get('default_tester'):
q = q.filter(
Q(default_tester__first_name__startswith=query[
'default_tester']) |
Q(default_tester__last_name__startswith=query[
'default_tester']) |
Q(default_tester__username__icontains=query[
'default_tester']) |
Q(default_tester__email__startswith=query[
'default_tester'])
)
if query.get('tag__name__in'):
q = q.filter(tag__name__in=query['tag__name__in'])
if query.get('category'):
q = q.filter(category__name=query['category'].name)
if query.get('priority'):
q = q.filter(priority__in=query['priority'])
if query.get('case_status'):
q = q.filter(case_status__in=query['case_status'])
# If plan exists, remove leading and trailing whitespace from it.
plan_str = query.get('plan', '').strip()
if plan_str:
try:
# Is it an integer? If so treat as a plan_id:
plan_id = int(plan_str)
q = q.filter(plan__plan_id=plan_id)
except ValueError:
# Not an integer - treat plan_str as a plan name:
q = q.filter(plan__name__icontains=plan_str)
del plan_str
if query.get('product'):
q = q.filter(category__product=query['product'])
if query.get('component'):
q = q.filter(component=query['component'])
if query.get('bug_id'):
q = q.filter(case_bug__bug_id__in=query['bug_id'])
if query.get('is_automated'):
q = q.filter(is_automated=query['is_automated'])
if query.get('is_automated_proposed'):
q = q.filter(
is_automated_proposed=query['is_automated_proposed'])
return q.distinct()
@classmethod
def list_confirmed(cls):
confirmed_case_status = TestCaseStatus.get_CONFIRMED()
query = {
'case_status_id': confirmed_case_status.case_status_id,
}
return cls.list(query)
@classmethod
def mail_scene(cls, objects, field=None, value=None, ctype=None, object_pk=None):
tcs = objects.select_related()
scence_templates = {
'reviewer': {
'template_name': 'mail/change_case_reviewer.txt',
'subject': 'You have been speicific to be the reviewer of cases',
'recipients': list(set(tcs.values_list('reviewer__email', flat=True))),
'context': {'test_cases': tcs},
}
}
return scence_templates.get(field)
def add_bug(self, bug_id, bug_system_id, summary=None, description=None,
case_run=None, bz_external_track=False):
bug, created = self.case_bug.get_or_create(
bug_id=bug_id,
case_run=case_run,
bug_system_id=bug_system_id,
summary=summary,
description=description,
)
if created:
if bz_external_track:
bug_system = TestCaseBugSystem.objects.get(pk=bug_system_id)
it = IssueTrackerType.from_name(bug_system.tracker_type)(bug_system)
it.add_testcase_to_issue([self], bug)
else:
raise ValueError('Bug %s already exist.' % bug_id)
def add_component(self, component):
try:
return TestCaseComponent.objects.create(
case=self,
component=component,
)
except:
raise
def add_tag(self, tag):
try:
return TestCaseTag.objects.get_or_create(
case=self,
tag=tag
)
except:
raise
def update_tags(self, new_tags):
'''
Update case.tag
so that case.tag == new_tags
'''
if new_tags is None or not isinstance(new_tags, list):
return
owning_tags = set(self.tag.iterator())
new_tags = set(new_tags)
tags_to_remove = owning_tags.difference(new_tags)
tags_to_add = new_tags.difference(owning_tags)
map(lambda c: self.add_tag(c), tags_to_add)
map(lambda c: self.remove_tag(c), tags_to_remove)
def add_text(
self,
action,
effect,
setup,
breakdown,
author=None,
create_date=datetime.now(),
case_text_version=1,
action_checksum=None,
effect_checksum=None,
setup_checksum=None,
breakdown_checksum=None):
if not author:
author = self.author
new_action_checksum = checksum(action)
new_effect_checksum = checksum(effect)
new_setup_checksum = checksum(setup)
new_breakdown_checksum = checksum(breakdown)
old_action, old_effect, old_setup, old_breakdown = self.text_checksum()
if old_action != new_action_checksum \
or old_effect != new_effect_checksum \
or old_setup != new_setup_checksum \
or old_breakdown != new_breakdown_checksum:
case_text_version = self.latest_text_version() + 1
try:
latest_text = TestCaseText.objects.create(
case=self,
case_text_version=case_text_version,
create_date=create_date,
author=author,
action=action,
effect=effect,
setup=setup,
breakdown=breakdown,
action_checksum=action_checksum or new_action_checksum,
effect_checksum=effect_checksum or new_effect_checksum,
setup_checksum=setup_checksum or new_setup_checksum,
breakdown_checksum=breakdown_checksum or
new_breakdown_checksum)
except:
raise
else:
latest_text = self.latest_text()
return latest_text
def add_to_plan(self, plan):
TestCasePlan.objects.get_or_create(case=self, plan=plan)
def clear_components(self):
try:
return TestCaseComponent.objects.filter(
case=self,
).delete()
except:
raise
def clear_estimated_time(self):
"""Converts a integer to time"""
return format_timedelta(self.estimated_time)
def get_bugs(self):
return TestCaseBug.objects.select_related(
'case_run', 'bug_system__url_reg_exp'
).filter(case__case_id=self.case_id)
def get_components(self):
return self.component.all()
def get_component_names(self):
return self.component.values_list('name', flat=True)
def get_choiced(self, obj_value, choices):
for x in choices:
if x[0] == obj_value:
return x[1]
def get_is_automated(self):
return self.get_choiced(self.is_automated, AUTOMATED_CHOICES)
def get_is_automated_form_value(self):
if self.is_automated == 2:
return [0, 1]
return (self.is_automated, )
def get_is_automated_status(self):
return self.get_is_automated() + (
self.is_automated_proposed and ' (Autoproposed)' or '')
def get_previous_and_next(self, pk_list):
pk_list = list(pk_list)
current_idx = pk_list.index(self.pk)
prev = TestCase.objects.get(pk=pk_list[current_idx - 1])
try:
next = TestCase.objects.get(pk=pk_list[current_idx + 1])
except IndexError:
next = TestCase.objects.get(pk=pk_list[0])
return (prev, next)
def get_text_with_version(self, case_text_version=None):
if case_text_version:
try:
return TestCaseText.objects.get(
case__case_id=self.case_id,
case_text_version=case_text_version
)
except TestCaseText.DoesNotExist:
return NoneText
return self.latest_text()
def latest_text(self, text_required=True):
text = self.text
if not text_required:
text = text.defer('action', 'effect', 'setup', 'breakdown')
qs = text.order_by('-case_text_version')[0:1]
return NoneText if len(qs) == 0 else qs[0]
def latest_text_version(self):
qs = self.text.order_by('-case_text_version').only('case_text_version')[0:1]
return 0 if len(qs) == 0 else qs[0].case_text_version
def text_exist(self):
return self.text.exists()
def text_checksum(self):
qs = self.text.order_by('-case_text_version').only('action_checksum',
'effect_checksum',
'setup_checksum',
'breakdown_checksum')[0:1]
if len(qs) == 0:
return None, None, None, None
else:
text = qs[0]
return (text.action_checksum,
text.effect_checksum,
text.setup_checksum,
text.breakdown_checksum)
def mail(self, template, subject, context={}, to=[], request=None):
from tcms.core.utils.mailto import mailto
if not to:
to = self.author.email
to = list(set(to))
mailto(template, subject, to, context, request)
def remove_bug(self, bug_id, run_id=None):
query = TestCaseBug.objects.filter(
bug_id=bug_id,
case=self.pk
)
if run_id:
query = query.filter(case_run=run_id)
else:
query = query.filter(case_run__isnull=True)
query.delete()
def remove_component(self, component):
# note: cannot use self.component.remove(component) on a ManyToManyField
# which specifies an intermediary model so we use the model manager!
self.component.through.objects.filter(case=self.pk, component=component.pk).delete()
def remove_plan(self, plan):
self.plan.through.objects.filter(case=self.pk, plan=plan.pk).delete()
def remove_tag(self, tag):
self.tag.through.objects.filter(case=self.pk, tag=tag.pk).delete()
def get_url_path(self, request=None):
return reverse('testcases-get', args=[self.pk, ])
def _get_email_conf(self):
try:
return self.email_settings
except ObjectDoesNotExist:
return TestCaseEmailSettings.objects.create(case=self)
emailing = property(_get_email_conf)
class TestCaseText(TCMSActionModel):
case = models.ForeignKey(TestCase, related_name='text')
case_text_version = models.IntegerField()
author = models.ForeignKey('auth.User', db_column='who')
create_date = models.DateTimeField(db_column='creation_ts', auto_now_add=True)
action = models.TextField(blank=True)
effect = models.TextField(blank=True)
setup = models.TextField(blank=True)
breakdown = models.TextField(blank=True)
action_checksum = models.CharField(max_length=32)
effect_checksum = models.CharField(max_length=32)
setup_checksum = models.CharField(max_length=32)
breakdown_checksum = models.CharField(max_length=32)
class Meta:
db_table = u'test_case_texts'
ordering = ['case', '-case_text_version']
unique_together = ('case', 'case_text_version')
def get_plain_text(self):
from tcms.core.utils.html import html2text
from django.utils.encoding import smart_str
self.action = html2text(smart_str(self.action))
self.effect = html2text(smart_str(self.effect))
self.setup = html2text(smart_str(self.setup))
self.breakdown = html2text(smart_str(self.breakdown))
return self
class TestCasePlan(models.Model):
plan = models.ForeignKey('testplans.TestPlan')
case = models.ForeignKey(TestCase)
sortkey = models.IntegerField(null=True, blank=True)
# TODO: create FOREIGN KEY constraint on plan_id and case_id individually
# in database.
class Meta:
db_table = u'test_case_plans'
unique_together = ('plan', 'case')
class TestCaseAttachment(models.Model):
attachment = models.ForeignKey('management.TestAttachment')
case = models.ForeignKey(TestCase, default=None, related_name='case_attachment')
case_run = models.ForeignKey('testruns.TestCaseRun', default=None,
null=True, blank=True,
related_name='case_run_attachment')
class Meta:
db_table = u'test_case_attachments'
# FIXME: what unique constraints are needed against this model?
class TestCaseComponent(models.Model):
case = models.ForeignKey(TestCase) # case_id
component = models.ForeignKey('management.Component') # component_id
class Meta:
db_table = u'test_case_components'
class TestCaseTag(models.Model):
tag = models.ForeignKey('management.TestTag')
case = models.ForeignKey(TestCase)
user = models.IntegerField(db_column='userid', default='0')
class Meta:
db_table = u'test_case_tags'
class TestCaseBugSystem(TCMSActionModel):
name = models.CharField(max_length=255, unique=True)
description = models.TextField(blank=True)
url_reg_exp = models.CharField(
max_length=8192,
verbose_name='URL format string',
help_text='A valid Python format string such as http://bugs.example.com/%s'
)
validate_reg_exp = models.CharField(
max_length=128,
verbose_name='RegExp for ID validation',
help_text='A valid JavaScript regular expression such as ^\d$',
)
tracker_type = models.CharField(
max_length=128,
verbose_name='Type',
help_text='This determines how KiwiTestPad integrates with the IT system',
default='IssueTrackerType',
)
report_url = models.CharField(
max_length=1024,
null=True,
blank=True,
verbose_name='Report URL',
help_text='''For Bugzilla the report URL looks like
<strong>https://bugzilla.example.com/buglist.cgi?bugidtype=include&bug_id=1,2,3</strong>
<br/>so the value of this field must be <strong>https://bugzilla.example.com</strong>!
Leave empty to disable!
''')
api_url = models.CharField(
max_length=1024,
null=True,
blank=True,
verbose_name='API URL',
help_text='This is the URL to which API requests will be sent. Leave empty to disable!')
api_username = models.CharField(
max_length=256,
null=True,
blank=True,
verbose_name='API username')
api_password = models.CharField(
max_length=256,
null=True,
blank=True,
verbose_name='API password or token')
class Meta:
db_table = u'test_case_bug_systems'
verbose_name = 'Bug tracker'
verbose_name_plural = 'Bug trackers'
def __unicode__(self):
return self.name
@classmethod
def get_by_id(cls, system_id):
return cls.objects.get(pk=system_id)
class TestCaseBug(TCMSActionModel):
bug_id = models.CharField(max_length=25)
case_run = models.ForeignKey('testruns.TestCaseRun', default=None, blank=True, null=True,
related_name='case_run_bug')
case = models.ForeignKey(TestCase, related_name='case_bug')
bug_system = models.ForeignKey(TestCaseBugSystem, default=1)
summary = models.CharField(max_length=255, blank=True, null=True)
description = models.TextField(blank=True, null=True)
class Meta:
db_table = u'test_case_bugs'
unique_together = (('bug_id', 'case_run', 'case'),
('bug_id', 'case_run'))
def unique_error_message(self, model_class, unique_check):
'''Specific to invalid bug id'''
bug_id_uniques = (('bug_id', 'case_run', 'case'),
('bug_id', 'case_run'))
if unique_check in bug_id_uniques:
return 'Bug %d exists in run %d already.' % (self.bug_id, self.case_run.pk)
else:
return super(TestCaseBug, self).unique_error_message(model_class, unique_check)
def __unicode__(self):
return str(self.bug_id)
def get_name(self):
if self.summary:
return self.summary
return self.bug_id
def get_absolute_url(self):
# Upward compatibility code
return self.get_url()
def get_url(self):
return self.bug_system.url_reg_exp % self.bug_id
class Contact(TCMSContentTypeBaseModel):
''' A Contact that can be added into Email settings' CC list '''
name = models.CharField(max_length=50)
email = models.EmailField(db_index=True)
date_joined = models.DateTimeField(auto_now_add=True)
def __unicode__(self):
return self.name
class Meta:
db_table = u'tcms_contacts'
index_together = (('content_type', 'object_pk', 'site'),)
@classmethod
def create(cls, email, content_object, name=None):
''' Factory method to create a new Contact '''
if not name:
store_name = email.split('@')[0]
else:
store_name = name
c = cls(name=store_name,
email=email,
content_object=content_object,
site_id=settings.SITE_ID)
c.save()
return c
class TestCaseEmailSettings(models.Model):
case = models.OneToOneField(TestCase, related_name='email_settings')
notify_on_case_update = models.BooleanField(default=False)
notify_on_case_delete = models.BooleanField(default=False)
auto_to_case_author = models.BooleanField(default=False)
auto_to_case_tester = models.BooleanField(default=False)
auto_to_run_manager = models.BooleanField(default=False)
auto_to_run_tester = models.BooleanField(default=False)
auto_to_case_run_assignee = models.BooleanField(default=False)
cc_list = GenericRelation(Contact, object_id_field='object_pk')
class Meta:
pass
def add_cc(self, email_addrs):
'''Add email addresses to CC list
Arguments:
- email_addrs: str or list, holding one or more email addresses
'''
emailaddr_list = []
if not isinstance(email_addrs, list):
emailaddr_list.append(email_addrs)
else:
emailaddr_list = list(email_addrs)
for email_addr in emailaddr_list:
Contact.create(email=email_addr, content_object=self)
def get_cc_list(self):
''' Return the whole CC list '''
return [c.email for c in self.cc_list.all()]
def remove_cc(self, email_addrs):
'''Remove one or more email addresses from EmailSettings' CC list
If any email_addr is unknown, remove_cc will keep quiet.
Arguments:
- email_addrs: str or list, holding one or more email addresses
'''
emailaddr_list = []
if not isinstance(email_addrs, list):
emailaddr_list.append(email_addrs)
else:
emailaddr_list = list(email_addrs)
self.cc_list.filter(email__in=emailaddr_list).delete()
def filter_new_emails(self, origin_emails, new_emails):
''' Find out the new email addresses to be added '''
return list(set(new_emails) - set(origin_emails))
def filter_unnecessary_emails(self, origin_emails, new_emails):
''' Find out the unnecessary addresses to be delete '''
return list(set(origin_emails) - set(new_emails))
def update_cc_list(self, email_addrs):
'''Add the new emails and delete unnecessary ones
Arguments:
- email_addrs: list, a instance of list holding emails user
input via UI
'''
origin_emails = self.get_cc_list()
emails_to_delete = self.filter_unnecessary_emails(origin_emails,
email_addrs)
self.remove_cc(emails_to_delete)
self.add_cc(self.filter_new_emails(origin_emails, email_addrs))
def _listen():
""" signals listen """
# case save/delete listen for email notify
post_save.connect(case_watchers.on_case_save, TestCase)
post_delete.connect(case_watchers.on_case_delete, TestCase)
pre_save.connect(case_watchers.pre_save_clean, TestCase)
if settings.LISTENING_MODEL_SIGNAL:
_listen()
if register_model:
register_model(TestCase)
register_model(TestCaseText)
register_model(TestCasePlan)
register_model(TestCaseBug)
register_model(TestCaseComponent)