Added DocEvent rev= parameter througout the code.

 - Legacy-Id: 12978

Author: levkowetz

PLAN

@@ -7,13 +7,10 @@ Updated: $Date$
 Planned work in rough order
 ===========================
 
-* Add a 'rev' field to DocEvent, migrate 'rev' information from New
-  Revision and Submit DocEvents, and infer 'rev' information for others
-
-* Break out the htmlzation code used on tools in a library, and use that
-  in the datatracker rendering, replacing the simpler code currently in use.
-  This is also going to require some fancy caching, to avoid re-building the
-  html if not needed, as it takes quite some time.
+* Break out the htmlzation code used on tools.ietf.org in a library, and use
+  that in the datatracker rendering, replacing the simpler code currently in
+  use.  This is also going to require some fancy caching, to avoid re-building
+  the html if not needed, as it takes quite some time.
 
 * Use the htmlization lib to improve the rendering of draft text in the
   datatracker's /doc/draft-foo-bar/ pages.

ietf/doc/expire.py

@@ -143,7 +143,7 @@ def expire_draft(doc):
             if e:
                 events.append(e)
 
-    events.append(DocEvent.objects.create(doc=doc, by=system, type="expired_document", desc="Document has expired"))
+    events.append(DocEvent.objects.create(doc=doc, rev=doc.rev, by=system, type="expired_document", desc="Document has expired"))
 
     doc.set_state(State.objects.get(used=True, type="draft", slug="expired"))
     doc.save_with_history(events)

ietf/doc/factories.py

@@ -79,6 +79,10 @@ class Meta:
     doc = factory.SubFactory(DocumentFactory)
     desc = factory.Faker('sentence',nb_words=6)
 
+    @factory.lazy_attribute
+    def rev(self):
+        return self.doc.rev
+
 class NewRevisionDocEventFactory(DocEventFactory):
     class Meta:
         model = NewRevisionDocEvent

ietf/doc/lastcall.py

@@ -28,6 +28,7 @@ def request_last_call(request, doc):
     e.type = "requested_last_call"
     e.by = request.user.person
     e.doc = doc
+    e.rev = doc.rev
     e.desc = "Last call was requested"
     e.save()
 

ietf/doc/mails.py

@@ -112,6 +112,7 @@ def generate_ballot_writeup(request, doc):
     e.type = "changed_ballot_writeup_text"
     e.by = request.user.person
     e.doc = doc
+    e.rev = doc.rev
     e.desc = u"Ballot writeup was generated"
     e.text = unicode(render_to_string("doc/mail/ballot_writeup.txt", {'iana': iana}))
 
@@ -123,6 +124,7 @@ def generate_ballot_rfceditornote(request, doc):
     e.type = "changed_ballot_rfceditornote_text"
     e.by = request.user.person
     e.doc = doc
+    e.rev = doc.rev
     e.desc = u"RFC Editor Note for ballot was generated"
     e.text = unicode(render_to_string("doc/mail/ballot_rfceditornote.txt"))
     e.save()
@@ -167,6 +169,7 @@ def generate_last_call_announcement(request, doc):
     e.type = "changed_last_call_text"
     e.by = request.user.person
     e.doc = doc
+    e.rev = doc.rev
     e.desc = u"Last call announcement was generated"
     e.text = unicode(mail)
 
@@ -186,6 +189,7 @@ def generate_approval_mail(request, doc):
     e.type = "changed_ballot_approval_text"
     e.by = request.user.person
     e.doc = doc
+    e.rev = doc.rev
     e.desc = u"Ballot approval text was generated"
     e.text = unicode(mail)
 

ietf/doc/models.py

@@ -17,6 +17,7 @@
 from ietf.name.models import ( DocTypeName, DocTagName, StreamName, IntendedStdLevelName, StdLevelName,
     DocRelationshipName, DocReminderTypeName, BallotPositionName, ReviewRequestStateName )
 from ietf.person.models import Email, Person
+from ietf.utils import log
 from ietf.utils.admin import admin_link
 from ietf.utils.validators import validate_no_control_chars
 
@@ -760,7 +761,7 @@ class DocEvent(models.Model):
     type = models.CharField(max_length=50, choices=EVENT_TYPES)
     by = models.ForeignKey(Person)
     doc = models.ForeignKey('doc.Document')
-    rev = models.CharField(verbose_name="revision", max_length=16, blank=True)
+    rev = models.CharField(verbose_name="revision", max_length=16, null=True, blank=True)
     desc = models.TextField()
 
     def for_current_revision(self):
@@ -773,6 +774,10 @@ def get_dochistory(self):
     def __unicode__(self):
         return u"%s %s by %s at %s" % (self.doc.name, self.get_type_display().lower(), self.by.plain_name(), self.time)
 
+    def save(self, *args, **kwargs):
+        super(DocEvent, self).save(*args, **kwargs)        
+        log.assertion('self.rev != None')
+
     class Meta:
         ordering = ['-time', '-id']
 
@@ -854,7 +859,7 @@ def all_positions(self):
             norecord = BallotPositionName.objects.get(slug="norecord")
             for ad in active_ads:
                 if ad not in seen:
-                    e = BallotPositionDocEvent(type="changed_ballot_position", doc=self.doc, ad=ad)
+                    e = BallotPositionDocEvent(type="changed_ballot_position", doc=self.doc, rev=self.doc.rev, ad=ad)
                     e.by = ad
                     e.pos = norecord
                     e.old_ad = False

ietf/doc/resources.py

@@ -162,6 +162,7 @@ class Meta:
             "id": ALL,
             "time": ALL,
             "type": ALL,
+            "rev": ALL,
             "desc": ALL,
             "by": ALL_WITH_RELATIONS,
             "doc": ALL_WITH_RELATIONS,
@@ -184,6 +185,7 @@ class Meta:
             "id": ALL,
             "time": ALL,
             "type": ALL,
+            "rev": ALL,
             "desc": ALL,
             "by": ALL_WITH_RELATIONS,
             "doc": ALL_WITH_RELATIONS,
@@ -255,6 +257,7 @@ class Meta:
             "id": ALL,
             "time": ALL,
             "type": ALL,
+            "rev": ALL,
             "desc": ALL,
             "consensus": ALL,
             "by": ALL_WITH_RELATIONS,
@@ -290,6 +293,7 @@ class Meta:
             "id": ALL,
             "time": ALL,
             "type": ALL,
+            "rev": ALL,
             "desc": ALL,
             "telechat_date": ALL,
             "returning_item": ALL,
@@ -331,6 +335,7 @@ class Meta:
             "id": ALL,
             "time": ALL,
             "type": ALL,
+            "rev": ALL,
             "desc": ALL,
             "expires": ALL,
             "by": ALL_WITH_RELATIONS,
@@ -375,6 +380,7 @@ class Meta:
             "id": ALL,
             "time": ALL,
             "type": ALL,
+            "rev": ALL,
             "desc": ALL,
             "text": ALL,
             "by": ALL_WITH_RELATIONS,
@@ -397,6 +403,7 @@ class Meta:
             "id": ALL,
             "time": ALL,
             "type": ALL,
+            "rev": ALL,
             "desc": ALL,
             "expires": ALL,
             "by": ALL_WITH_RELATIONS,
@@ -437,6 +444,7 @@ class Meta:
             "id": ALL,
             "time": ALL,
             "type": ALL,
+            "rev": ALL,
             "desc": ALL,
             "by": ALL_WITH_RELATIONS,
             "doc": ALL_WITH_RELATIONS,
@@ -499,6 +507,7 @@ class Meta:
             "id": ALL,
             "time": ALL,
             "type": ALL,
+            "rev": ALL,
             "desc": ALL,
             "discuss": ALL,
             "discuss_time": ALL,
@@ -530,6 +539,7 @@ class Meta:
             "id": ALL,
             "time": ALL,
             "type": ALL,
+            "rev": ALL,
             "desc": ALL,
             "msgtype": ALL,
             "by": ALL_WITH_RELATIONS,
@@ -582,6 +592,7 @@ class Meta:
             "id": ALL,
             "time": ALL,
             "type": ALL,
+            "rev": ALL,
             "desc": ALL,
             "by": ALL_WITH_RELATIONS,
             "doc": ALL_WITH_RELATIONS,

ietf/doc/tests.py

@@ -119,11 +119,11 @@ def test_search(self):
     def test_search_for_name(self):
         draft = make_test_data()
         make_meeting_test_data()
-        draft.save_with_history([DocEvent.objects.create(doc=draft, type="changed_document", by=Person.objects.get(user__username="secretary"), desc="Test")])
+        draft.save_with_history([DocEvent.objects.create(doc=draft, rev=draft.rev, type="changed_document", by=Person.objects.get(user__username="secretary"), desc="Test")])
 
         prev_rev = draft.rev
         draft.rev = "%02d" % (int(prev_rev) + 1)
-        draft.save_with_history([DocEvent.objects.create(doc=draft, type="changed_document", by=Person.objects.get(user__username="secretary"), desc="Test")])
+        draft.save_with_history([DocEvent.objects.create(doc=draft, rev=draft.rev, type="changed_document", by=Person.objects.get(user__username="secretary"), desc="Test")])
 
         # exact match
         r = self.client.get(urlreverse('ietf.doc.views_search.search_for_name', kwargs=dict(name=draft.name)))
@@ -526,7 +526,7 @@ def test_document_draft(self):
         # draft published as RFC
         draft.set_state(State.objects.get(type="draft", slug="rfc"))
         draft.std_level_id = "bcp"
-        draft.save_with_history([DocEvent.objects.create(doc=draft, type="published_rfc", by=Person.objects.get(name="(System)"))])
+        draft.save_with_history([DocEvent.objects.create(doc=draft, rev=draft.rev, type="published_rfc", by=Person.objects.get(name="(System)"))])
 
 
         rfc_alias = DocAlias.objects.create(name="rfc123456", document=draft)
@@ -577,10 +577,10 @@ def test_document_primary_and_history_views(self):
                        ]:
             doc = Document.objects.get(name=docname)
             # give it some history
-            doc.save_with_history([DocEvent.objects.create(doc=doc, type="changed_document", by=Person.objects.get(user__username="secretary"), desc="Test")])
+            doc.save_with_history([DocEvent.objects.create(doc=doc, rev=doc.rev, type="changed_document", by=Person.objects.get(user__username="secretary"), desc="Test")])
 
             doc.rev = "01"
-            doc.save_with_history([DocEvent.objects.create(doc=doc, type="changed_document", by=Person.objects.get(user__username="secretary"), desc="Test")])
+            doc.save_with_history([DocEvent.objects.create(doc=doc, rev=doc.rev, type="changed_document", by=Person.objects.get(user__username="secretary"), desc="Test")])
 
             r = self.client.get(urlreverse("ietf.doc.views_doc.document_main", kwargs=dict(name=doc.name)))
             self.assertEqual(r.status_code, 200)
@@ -638,10 +638,11 @@ def test_document_ballot(self):
         ballot = doc.active_ballot()
 
         # make sure we have some history
-        doc.save_with_history([DocEvent.objects.create(doc=doc, type="changed_document", by=Person.objects.get(user__username="secretary"), desc="Test")])
+        doc.save_with_history([DocEvent.objects.create(doc=doc, rev=doc.rev, type="changed_document", by=Person.objects.get(user__username="secretary"), desc="Test")])
 
         pos = BallotPositionDocEvent.objects.create(
             doc=doc,
+            rev=doc.rev,
             ballot=ballot,
             type="changed_ballot_position",
             pos_id="yes",
@@ -715,20 +716,23 @@ def test_writeup(self):
 
         appr = WriteupDocEvent.objects.create(
             doc=doc,
+            rev=doc.rev,
             desc="Changed text",
             type="changed_ballot_approval_text",
             text="This is ballot approval text.",
             by=Person.objects.get(name="(System)"))
 
         notes = WriteupDocEvent.objects.create(
             doc=doc,
+            rev=doc.rev,
             desc="Changed text",
             type="changed_ballot_writeup_text",
             text="This is ballot writeup notes.",
             by=Person.objects.get(name="(System)"))
 
         rfced_note = WriteupDocEvent.objects.create(
             doc=doc,
+            rev=doc.rev,
             desc="Changed text",
             type="changed_rfc_editor_note_text",
             text="This is a note for the RFC Editor.",
@@ -746,6 +750,7 @@ def test_history(self):
 
         e = DocEvent.objects.create(
             doc=doc,
+            rev=doc.rev,
             desc="Something happened.",
             type="added_comment",
             by=Person.objects.get(name="(System)"))
@@ -760,6 +765,7 @@ def test_document_feed(self):
 
         e = DocEvent.objects.create(
             doc=doc,
+            rev=doc.rev,
             desc="Something happened.",
             type="added_comment",
             by=Person.objects.get(name="(System)"))
@@ -775,6 +781,7 @@ def test_last_call_feed(self):
 
         LastCallDocEvent.objects.create(
             doc=doc,
+            rev=doc.rev,
             desc="Last call",
             type="sent_last_call",
             by=Person.objects.get(user__username="secretary"),