Refactored editing the notify field to remove redundant code.

Changed the default notification list to include .all for documents, and the wg list for wg documents.
Allowed recalculating the notification list for all document types.
Improved the calculated notification list value for charters, conflict-reviews, and status-changes.
Adds shepherds to the notification list when they are assigned to a document.
Adds the working group email list to the notification list when a document is adopted.

Fixes ietf-tools#1438
Commit ready for merge.
 - Legacy-Id: 8293

Author: rjsparks

ietf/doc/forms.py

@@ -34,4 +34,8 @@ def __init__(self, *args, **kwargs):
             self.fields['ad'].choices = list(choices) + [("", "-------"), (ad_pk, Person.objects.get(pk=ad_pk).plain_name())]
 
 class NotifyForm(forms.Form):
-    notify = forms.CharField(max_length=255, label="Notice emails", help_text="Separate email addresses with commas", required=False)
+    notify = forms.CharField(max_length=255, help_text="List of email addresses to receive state notifications, separated by comma", label="Notification list", required=False)
+
+    def clean_notify(self):
+        addrspecs = [x.strip() for x in self.cleaned_data["notify"].split(',')]
+        return ', '.join(addrspecs)

ietf/doc/models.py

@@ -178,6 +178,8 @@ def meeting_related(self):
     class Meta:
         abstract = True
 
+STATUSCHANGE_RELATIONS = ('tops','tois','tohist','toinf','tobcp','toexp')
+
 class RelatedDocument(models.Model):
     source = models.ForeignKey('Document')
     target = models.ForeignKey('DocAlias')

ietf/doc/tests_charter.py

@@ -181,11 +181,23 @@ def test_edit_notify(self):
 
         # post
         self.assertTrue(not charter.notify)
-        r = self.client.post(url, dict(notify="someone@example.com, someoneelse@example.com"))
+        newlist = "someone@example.com, someoneelse@example.com"
+        r = self.client.post(url, dict(notify=newlist,save_addresses="1"))
         self.assertEqual(r.status_code, 302)
 
         charter = Document.objects.get(name=charter.name)
-        self.assertEqual(charter.notify, "someone@example.com, someoneelse@example.com")
+        self.assertEqual(charter.notify, newlist)
+
+        # Ask the form to regenerate the list
+        r = self.client.post(url,dict(regenerate_addresses="1"))
+        self.assertEqual(r.status_code,200)
+        charter= Document.objects.get(name=charter.name)
+        # Regenerate does not save!
+        self.assertEqual(charter.notify,newlist)
+        q = PyQuery(r.content)
+        formlist = q('form input[name=notify]')[0].value
+        self.assertTrue('marschairman@ietf.org' in formlist)
+        self.assertFalse('someone@example.com' in formlist)
 
     def test_edit_ad(self):
         make_test_data()

ietf/doc/tests_conflict_review.py

@@ -176,12 +176,22 @@ def test_edit_notices(self):
 
         # change notice list
         newlist = '"Foo Bar" <foo@bar.baz.com>'
-        r = self.client.post(url,dict(notify=newlist))
+        r = self.client.post(url,dict(notify=newlist,save_addresses="1"))
         self.assertEqual(r.status_code,302)
         doc = Document.objects.get(name='conflict-review-imaginary-irtf-submission')
         self.assertEqual(doc.notify,newlist)
         self.assertTrue(doc.latest_event(DocEvent,type="added_comment").desc.startswith('Notification list changed'))       
 
+        # Ask the form to regenerate the list
+        r = self.client.post(url,dict(regenerate_addresses="1"))
+        self.assertEqual(r.status_code,200)
+        doc = Document.objects.get(name='conflict-review-imaginary-irtf-submission')
+        # Regenerate does not save!
+        self.assertEqual(doc.notify,newlist)
+        q = PyQuery(r.content)
+        self.assertTrue('draft-imaginary-irtf-submission@tools.ietf.org' in q('form input[name=notify]')[0].value)
+        self.assertTrue('irtf-chair@ietf.org' in q('form input[name=notify]')[0].value)
+        self.assertTrue('foo@bar.baz.com' not in q('form input[name=notify]')[0].value)
 
     def test_edit_ad(self):
         doc = Document.objects.get(name='conflict-review-imaginary-irtf-submission')

ietf/doc/tests_draft.py

@@ -841,7 +841,9 @@ def test_doc_change_shepherd(self):
         self.assertEqual(r.status_code,302)
         self.doc = Document.objects.get(name=self.docname)
         self.assertEqual(self.doc.shepherd,plain)
-        self.assertTrue(self.doc.latest_event(DocEvent,type="added_comment").desc.startswith('Document shepherd changed to Plain Man'))
+        comments = '::'.join([x.desc for x in self.doc.docevent_set.filter(time=self.doc.time,type="added_comment")])
+        self.assertTrue('Document shepherd changed to Plain Man' in comments)
+        self.assertTrue('Notification list changed' in comments)
 
         ad = Person.objects.get(name='Aread Irector')
         two_answers = "%s,%s" % (plain_email, ad.email_set.all()[0])
@@ -1021,16 +1023,19 @@ def test_adopt_document(self):
         # adopt in mars WG
         mailbox_before = len(outbox)
         events_before = draft.docevent_set.count()
+        mars = Group.objects.get(acronym="mars")
         r = self.client.post(url,
                              dict(comment="some comment",
-                                  group=Group.objects.get(acronym="mars").pk,
+                                  group=mars.pk,
                                   weeks="10"))
         self.assertEqual(r.status_code, 302)
 
         draft = Document.objects.get(pk=draft.pk)
         self.assertEqual(draft.group.acronym, "mars")
         self.assertEqual(draft.stream_id, "ietf")
-        self.assertEqual(draft.docevent_set.count() - events_before, 4)
+        self.assertEqual(draft.docevent_set.count() - events_before, 5)
+        self.assertTrue(mars.list_email in draft.notify)
+        self.assertTrue('draft-ietf-mars-test.all@tools.ietf.org' in draft.notify)
         self.assertEqual(len(outbox), mailbox_before + 1)
         self.assertTrue("state changed" in outbox[-1]["Subject"].lower())
         self.assertTrue("marschairman@ietf.org" in unicode(outbox[-1]))

ietf/doc/tests_status_change.py

@@ -139,12 +139,28 @@ def test_edit_notices(self):
 
         # change notice list
         newlist = '"Foo Bar" <foo@bar.baz.com>'
-        r = self.client.post(url,dict(notify=newlist))
+        r = self.client.post(url,dict(notify=newlist,save_addresses="1"))
         self.assertEqual(r.status_code,302)
         doc = Document.objects.get(name='status-change-imaginary-mid-review')
         self.assertEqual(doc.notify,newlist)
         self.assertTrue(doc.latest_event(DocEvent,type="added_comment").desc.startswith('Notification list changed'))       
 
+        # Some additional setup so there's something to put in a generated notify list
+        doc.relateddocument_set.create(target=DocAlias.objects.get(name='rfc9999'),relationship_id='tois')
+        doc.relateddocument_set.create(target=DocAlias.objects.get(name='rfc9998'),relationship_id='tohist')
+
+        # Ask the form to regenerate the list
+        r = self.client.post(url,dict(regenerate_addresses="1"))
+        self.assertEqual(r.status_code,200)
+        doc = Document.objects.get(name='status-change-imaginary-mid-review')
+        # Regenerate does not save!
+        self.assertEqual(doc.notify,newlist)
+        q = PyQuery(r.content)
+        formlist = q('form input[name=notify]')[0].value
+        self.assertTrue('draft-ietf-random-thing@ietf.org' in formlist)
+        self.assertTrue('draft-ietf-random-otherthing@ietf.org' in formlist)
+        self.assertFalse('foo@bar.baz.com' in formlist)
+
     def test_edit_title(self):
         doc = Document.objects.get(name='status-change-imaginary-mid-review')
         url = urlreverse('status_change_title',kwargs=dict(name=doc.name))

ietf/doc/urls.py

@@ -74,7 +74,7 @@
 
     url(r'^(?P<name>[A-Za-z0-9._+-]+)/edit/stream/$', views_draft.change_stream, name='doc_change_stream'),
     url(r'^(?P<name>[A-Za-z0-9._+-]+)/edit/replaces/$', views_draft.replaces, name='doc_change_replaces'),
-    url(r'^(?P<name>[A-Za-z0-9._+-]+)/edit/notify/$', views_draft.edit_notices, name='doc_change_notify'),
+    url(r'^(?P<name>[A-Za-z0-9._+-]+)/edit/notify/$', views_doc.edit_notify, name='doc_change_notify'),
     url(r'^(?P<name>[A-Za-z0-9._+-]+)/edit/status/$', views_draft.change_intention, name='doc_change_intended_status'),
     url(r'^(?P<name>[A-Za-z0-9._+-]+)/edit/telechat/$', views_doc.telechat_date, name='doc_change_telechat_date'),
     url(r'^(?P<name>[A-Za-z0-9._+-]+)/edit/iesgnote/$', views_draft.edit_iesg_note, name='doc_change_iesg_note'),

ietf/doc/urls_charter.py

@@ -6,7 +6,7 @@
     url(r'^state/$', "ietf.doc.views_charter.change_state", name='charter_change_state'),
     url(r'^(?P<option>initcharter|recharter|abandon)/$', "ietf.doc.views_charter.change_state", name='charter_startstop_process'),
     url(r'^telechat/$', "ietf.doc.views_doc.telechat_date", name='charter_telechat_date'),
-    url(r'^notify/$', "ietf.doc.views_charter.edit_notify", name='charter_edit_notify'),
+    url(r'^notify/$', "ietf.doc.views_doc.edit_notify", name='charter_edit_notify'),
     url(r'^ad/$', "ietf.doc.views_charter.edit_ad", name='charter_edit_ad'),
     url(r'^(?P<ann>action|review)/$', "ietf.doc.views_charter.announcement_text", name="charter_edit_announcement"),
     url(r'^ballotwriteupnotes/$', "ietf.doc.views_charter.ballot_writeupnotes"),

ietf/doc/urls_conflict_review.py

@@ -3,14 +3,14 @@
 urlpatterns = patterns('ietf.doc.views_conflict_review',
     url(r'^state/$',                 "change_state",  name='conflict_review_change_state'),
     url(r'^submit/$',                "submit",        name='conflict_review_submit'),
-    url(r'^notices/$',               "edit_notices",  name='conflict_review_notices'),
     url(r'^ad/$',                    "edit_ad",       name='conflict_review_ad'),
     url(r'^approve/$',               "approve",       name='conflict_review_approve'),
     url(r'^start_conflict_review/$', "start_review",  name='conflict_review_start'),
 )
 
 urlpatterns += patterns('ietf.doc.views_doc',
     url(r'^telechat/$',              "telechat_date", name='conflict_review_telechat_date'),
+    url(r'^notices/$',               "edit_notify",  name='conflict_review_notices'),
 )
 
 

ietf/doc/urls_status_change.py

@@ -3,7 +3,6 @@
 urlpatterns = patterns('ietf.doc.views_status_change',
     url(r'^state/$',                 "change_state",   name='status_change_change_state'),
     url(r'^submit/$',                "submit",         name='status_change_submit'),
-    url(r'^notices/$',               "edit_notices",   name='status_change_notices'),
     url(r'^ad/$',                    "edit_ad",        name='status_change_ad'),
     url(r'^title/$',                 "edit_title",     name='status_change_title'),
     url(r'^approve/$',               "approve",        name='status_change_approve'),
@@ -13,6 +12,7 @@
 
 urlpatterns += patterns('ietf.doc.views_doc',
     url(r'^telechat/$',              "telechat_date",  name='status_change_telechat_date'),
+    url(r'^notices/$',               "edit_notify",   name='status_change_notices'),
 )