In order that document states (which may be used by old documents) should not need to be removed when state machines change and states go out of use, all document states have a 'used' field. The code which accesses the state fields have not been requiring that used=True for the states returned, which is an error. Fixed this by adding 'used=True' to all State.objects.get() and State.objects.filter() call where it's relevant.

 - Legacy-Id: 5486

Author: levkowetz

ietf/doc/admin.py

@@ -42,7 +42,7 @@ def render(self, name, value, attrs=None, choices=()):
 
         categorized_choices = []
         for t in types:
-            states = State.objects.filter(type=t).select_related()
+            states = State.objects.filter(used=True, type=t).select_related()
             if states:
                 categorized_choices.append((t.label, states))
 

ietf/doc/tests_conflict_review.py

@@ -61,7 +61,7 @@ def test_start_review(self):
 
         # successful review start
         ad_strpk = str(Person.objects.get(name='Aread Irector').pk)
-        state_strpk = str(State.objects.get(slug='needshep',type__slug='conflrev').pk)        
+        state_strpk = str(State.objects.get(used=True, slug='needshep',type__slug='conflrev').pk)        
         r = self.client.post(url,dict(ad=ad_strpk,create_in_state=state_strpk,notify='ipu@ietf.org'))
         self.assertEquals(r.status_code, 302)
         review_doc = Document.objects.get(name='conflict-review-imaginary-independent-submission')
@@ -99,7 +99,7 @@ def test_change_state(self):
         self.assertTrue(len(q('form ul.errorlist')) > 0)
 
         # successful change to AD Review
-        adrev_pk = str(State.objects.get(slug='adrev',type__slug='conflrev').pk)
+        adrev_pk = str(State.objects.get(used=True, slug='adrev',type__slug='conflrev').pk)
         r = self.client.post(url,dict(review_state=adrev_pk,comment='RDNK84ZD'))
         self.assertEquals(r.status_code, 302)
         review_doc = Document.objects.get(name='conflict-review-imaginary-irtf-submission')
@@ -108,7 +108,7 @@ def test_change_state(self):
         self.assertFalse(review_doc.active_ballot())
 
         # successful change to IESG Evaluation 
-        iesgeval_pk = str(State.objects.get(slug='iesgeval',type__slug='conflrev').pk)
+        iesgeval_pk = str(State.objects.get(used=True, slug='iesgeval',type__slug='conflrev').pk)
         r = self.client.post(url,dict(review_state=iesgeval_pk,comment='TGmZtEjt'))
         self.assertEquals(r.status_code, 302)
         review_doc = Document.objects.get(name='conflict-review-imaginary-irtf-submission')
@@ -214,7 +214,7 @@ def approve_test_helper(self,approve_type):
 
         # Some additional setup
         create_ballot_if_not_open(doc,Person.objects.get(name="Sec Retary"),"conflrev")
-        doc.set_state(State.objects.get(slug=approve_type+'-pend',type='conflrev'))
+        doc.set_state(State.objects.get(used=True, slug=approve_type+'-pend',type='conflrev'))
         doc.save()
 
         # get

ietf/doc/views_conflict_review.py

@@ -26,7 +26,7 @@
 from ietf.group.models import Role, Group
 
 class ChangeStateForm(forms.Form):
-    review_state = forms.ModelChoiceField(State.objects.filter(type="conflrev", used=True), label="Conflict review state", empty_label=None, required=True)
+    review_state = forms.ModelChoiceField(State.objects.filter(used=True, type="conflrev"), label="Conflict review state", empty_label=None, required=True)
     comment = forms.CharField(widget=forms.Textarea, help_text="Optional comment for the review history", required=False)
     def __init__(self, *args, **kwargs):
         self.hide = kwargs.pop('hide', None)
@@ -329,7 +329,7 @@ def approve(request, name):
         if form.is_valid():
 
             new_state_slug = 'appr-reqnopub-sent' if review.get_state('conflrev').slug=='appr-reqnopub-pend' else 'appr-noprob-sent'
-            new_review_state = State.objects.get(type="conflrev", slug=new_state_slug)
+            new_review_state = State.objects.get(used=True, type="conflrev", slug=new_state_slug)
             save_document_in_history(review)
             old_description = review.friendly_state()
             review.set_state(new_review_state)
@@ -372,7 +372,7 @@ def approve(request, name):
 class StartReviewForm(forms.Form):
     ad = forms.ModelChoiceField(Person.objects.filter(role__name="ad", role__group__state="active").order_by('name'), 
                                 label="Shepherding AD", empty_label="(None)", required=True)
-    create_in_state = forms.ModelChoiceField(State.objects.filter(type="conflrev", slug__in=("needshep", "adrev")), empty_label=None, required=False)
+    create_in_state = forms.ModelChoiceField(State.objects.filter(used=True, type="conflrev", slug__in=("needshep", "adrev")), empty_label=None, required=False)
     notify = forms.CharField(max_length=255, label="Notice emails", help_text="Separate email addresses with commas", required=False)
     telechat_date = forms.TypedChoiceField(coerce=lambda x: datetime.datetime.strptime(x, '%Y-%m-%d').date(), empty_value=None, required=False, widget=forms.Select(attrs={'onchange':'make_bold()'}))
 

ietf/help/views.py

@@ -12,7 +12,7 @@ def state(request, doc, type=None):
     slug = "%s-%s" % (doc,type) if type else doc
     debug.show('slug')
     statetype = get_object_or_404(StateType, slug=slug)
-    states = State.objects.filter(type=statetype).order_by('order')
+    states = State.objects.filter(used=True, type=statetype).order_by('order')
     return render_to_response('help/states.html', {"doc": doc, "type": statetype, "states":states},
         context_instance=RequestContext(request))
 

ietf/idrfc/expire.py

@@ -41,10 +41,10 @@ def expirable_documents():
 
     nonexpirable_states = []
     # all IESG states except AD Watching and Dead block expiry
-    nonexpirable_states += list(State.objects.filter(type="draft-iesg").exclude(slug__in=("watching", "dead")))
+    nonexpirable_states += list(State.objects.filter(used=True, type="draft-iesg").exclude(slug__in=("watching", "dead")))
     # Sent to RFC Editor and RFC Published block expiry (the latter
     # shouldn't be possible for an active draft, though)
-    nonexpirable_states += list(State.objects.filter(type__in=("draft-stream-iab", "draft-stream-irtf", "draft-stream-ise"), slug__in=("rfc-edit", "pub")))
+    nonexpirable_states += list(State.objects.filter(used=True, type__in=("draft-stream-iab", "draft-stream-irtf", "draft-stream-ise"), slug__in=("rfc-edit", "pub")))
 
     return d.exclude(states__in=nonexpirable_states).distinct()
 
@@ -220,7 +220,7 @@ def expire_idREDESIGN(doc):
 
     save_document_in_history(doc)
     if doc.latest_event(type='started_iesg_process'):
-        dead_state = State.objects.get(type="draft-iesg", slug="dead")
+        dead_state = State.objects.get(used=True, type="draft-iesg", slug="dead")
         prev = doc.get_state("draft-iesg")
         prev_tag = doc.tags.filter(slug__in=('point', 'ad-f-up', 'need-rev', 'extpty'))
         prev_tag = prev_tag[0] if prev_tag else None
@@ -235,7 +235,7 @@ def expire_idREDESIGN(doc):
         e.desc = "Document has expired"
         e.save()
 
-    doc.set_state(State.objects.get(type="draft", slug="expired"))
+    doc.set_state(State.objects.get(used=True, type="draft", slug="expired"))
     doc.time = datetime.datetime.now()
     doc.save()
 

ietf/idrfc/lastcall.py

@@ -70,13 +70,13 @@ def expire_last_call(doc):
     email_last_call_expired(doc)
 
 def expire_last_callREDESIGN(doc):
-    state = State.objects.get(type="draft-iesg", slug="writeupw")
+    state = State.objects.get(used=True, type="draft-iesg", slug="writeupw")
 
     e = doc.latest_event(WriteupDocEvent, type="changed_ballot_writeup_text")
     if e and "What does this protocol do and why" not in e.text:
         # if boiler-plate text has been removed, we assume the
         # write-up has been written
-        state = State.objects.get(type="draft-iesg", slug="goaheadw")
+        state = State.objects.get(used=True, type="draft-iesg", slug="goaheadw")
 
     save_document_in_history(doc)
 

ietf/idrfc/testsREDESIGN.py

@@ -63,7 +63,7 @@ class ChangeStateTestCase(django.test.TestCase):
 
     def test_change_state(self):
         draft = make_test_data()
-        draft.set_state(State.objects.get(type="draft-iesg", slug="ad-eval"))
+        draft.set_state(State.objects.get(used=True, type="draft-iesg", slug="ad-eval"))
 
         url = urlreverse('doc_change_state', kwargs=dict(name=draft.name))
         login_testing_unauthorized(self, "secretary", url)
@@ -82,7 +82,7 @@ def test_change_state(self):
 
 
         # faulty post
-        r = self.client.post(url, dict(state=State.objects.get(type="draft", slug="active").pk))
+        r = self.client.post(url, dict(state=State.objects.get(used=True, type="draft", slug="active").pk))
         self.assertEquals(r.status_code, 200)
         q = PyQuery(r.content)
         self.assertTrue(len(q('form ul.errorlist')) > 0)
@@ -96,7 +96,7 @@ def test_change_state(self):
         draft.tags.add("ad-f-up")
 
         r = self.client.post(url,
-                             dict(state=State.objects.get(type="draft-iesg", slug="review-e").pk,
+                             dict(state=State.objects.get(used=True, type="draft-iesg", slug="review-e").pk,
                                   substate="point",
                                   comment="Test comment"))
         self.assertEquals(r.status_code, 302)
@@ -121,7 +121,7 @@ def test_change_state(self):
 
     def test_pull_from_rfc_queue(self):
         draft = make_test_data()
-        draft.set_state(State.objects.get(type="draft-iesg", slug="rfcqueue"))
+        draft.set_state(State.objects.get(used=True, type="draft-iesg", slug="rfcqueue"))
 
         url = urlreverse('doc_change_state', kwargs=dict(name=draft.name))
         login_testing_unauthorized(self, "secretary", url)
@@ -130,7 +130,7 @@ def test_pull_from_rfc_queue(self):
         mailbox_before = len(outbox)
 
         r = self.client.post(url,
-                             dict(state=State.objects.get(type="draft-iesg", slug="review-e").pk,
+                             dict(state=State.objects.get(used=True, type="draft-iesg", slug="review-e").pk,
                                   substate="",
                                   comment="Test comment"))
         self.assertEquals(r.status_code, 302)
@@ -146,8 +146,8 @@ def test_pull_from_rfc_queue(self):
     def test_change_iana_state(self):
         draft = make_test_data()
 
-        first_state = State.objects.get(type="draft-iana-review", slug="need-rev")
-        next_state = State.objects.get(type="draft-iana-review", slug="ok-noact")
+        first_state = State.objects.get(used=True, type="draft-iana-review", slug="need-rev")
+        next_state = State.objects.get(used=True, type="draft-iana-review", slug="ok-noact")
         draft.set_state(first_state)
 
         url = urlreverse('doc_change_iana_state', kwargs=dict(name=draft.name, state_type="iana-review"))
@@ -176,15 +176,15 @@ def test_change_iana_state(self):
 
     def test_request_last_call(self):
         draft = make_test_data()
-        draft.set_state(State.objects.get(type="draft-iesg", slug="ad-eval"))
+        draft.set_state(State.objects.get(used=True, type="draft-iesg", slug="ad-eval"))
 
         self.client.login(remote_user="secretary")
         url = urlreverse('doc_change_state', kwargs=dict(name=draft.name))
 
         mailbox_before = len(outbox)
 
         self.assertTrue(not draft.latest_event(type="changed_ballot_writeup_text"))
-        r = self.client.post(url, dict(state=State.objects.get(type="draft-iesg", slug="lc-req").pk))
+        r = self.client.post(url, dict(state=State.objects.get(used=True, type="draft-iesg", slug="lc-req").pk))
         self.assertContains(r, "Your request to issue the Last Call")
 
         # last call text
@@ -348,7 +348,7 @@ def test_start_iesg_process_on_draft(self):
         r = self.client.post(url,
                              dict(intended_std_level=str(draft.intended_std_level_id),
                                   ad=ad.pk,
-                                  create_in_state=State.objects.get(type="draft-iesg", slug="watching").pk,
+                                  create_in_state=State.objects.get(used=True, type="draft-iesg", slug="watching").pk,
                                   notify="test@example.com",
                                   note="This is a note",
                                   telechat_date="",
@@ -383,7 +383,7 @@ class ResurrectTestCase(django.test.TestCase):
 
     def test_request_resurrect(self):
         draft = make_test_data()
-        draft.set_state(State.objects.get(type="draft", slug="expired"))
+        draft.set_state(State.objects.get(used=True, type="draft", slug="expired"))
 
         url = urlreverse('doc_request_resurrect', kwargs=dict(name=draft.name))
 
@@ -414,7 +414,7 @@ def test_request_resurrect(self):
 
     def test_resurrect(self):
         draft = make_test_data()
-        draft.set_state(State.objects.get(type="draft", slug="expired"))
+        draft.set_state(State.objects.get(used=True, type="draft", slug="expired"))
 
         DocEvent.objects.create(doc=draft,
                              type="requested_resurrect",
@@ -636,7 +636,7 @@ class DeferBallotTestCase(django.test.TestCase):
 
     def test_defer_ballot(self):
         draft = make_test_data()
-        draft.set_state(State.objects.get(type="draft-iesg", slug="iesg-eva"))
+        draft.set_state(State.objects.get(used=True, type="draft-iesg", slug="iesg-eva"))
 
         url = urlreverse('doc_defer_ballot', kwargs=dict(name=draft.name))
         login_testing_unauthorized(self, "ad", url)
@@ -661,7 +661,7 @@ def test_defer_ballot(self):
 
     def test_undefer_ballot(self):
         draft = make_test_data()
-        draft.set_state(State.objects.get(type="draft-iesg", slug="defer"))
+        draft.set_state(State.objects.get(used=True, type="draft-iesg", slug="defer"))
 
         url = urlreverse('doc_undefer_ballot', kwargs=dict(name=draft.name))
         login_testing_unauthorized(self, "ad", url)
@@ -747,7 +747,7 @@ def test_edit_ballot_writeup(self):
         login_testing_unauthorized(self, "secretary", url)
 
         # add a IANA review note
-        draft.set_state(State.objects.get(type="draft-iana-review", slug="not-ok"))
+        draft.set_state(State.objects.get(used=True, type="draft-iana-review", slug="not-ok"))
         DocEvent.objects.create(type="iana_review",
                                 doc=draft,
                                 by=Person.objects.get(user__username="iana"),
@@ -850,7 +850,7 @@ def test_edit_approval_text(self):
         self.assertTrue("Subject: Protocol Action" in draft.latest_event(WriteupDocEvent, type="changed_ballot_approval_text").text)
 
         # test regenerate when it's a disapprove
-        draft.set_state(State.objects.get(type="draft-iesg", slug="nopubadw"))
+        draft.set_state(State.objects.get(used=True, type="draft-iesg", slug="nopubadw"))
 
         r = self.client.post(url, dict(regenerate_approval_text="1"))
         self.assertEquals(r.status_code, 200)
@@ -861,7 +861,7 @@ def test_edit_approval_text(self):
         draft.group = Group.objects.get(type="individ")
         draft.stream_id = "irtf"
         draft.save()
-        draft.set_state(State.objects.get(type="draft-iesg", slug="iesg-eva"))
+        draft.set_state(State.objects.get(used=True, type="draft-iesg", slug="iesg-eva"))
 
         r = self.client.post(url, dict(regenerate_approval_text="1"))
         self.assertEquals(r.status_code, 200)
@@ -873,7 +873,7 @@ class ApproveBallotTestCase(django.test.TestCase):
 
     def test_approve_ballot(self):
         draft = make_test_data()
-        draft.set_state(State.objects.get(type="draft-iesg", slug="iesg-eva")) # make sure it's approvable
+        draft.set_state(State.objects.get(used=True, type="draft-iesg", slug="iesg-eva")) # make sure it's approvable
 
         url = urlreverse('doc_approve_ballot', kwargs=dict(name=draft.name))
         login_testing_unauthorized(self, "secretary", url)
@@ -901,7 +901,7 @@ def test_approve_ballot(self):
 
     def test_disapprove_ballot(self):
         draft = make_test_data()
-        draft.set_state(State.objects.get(type="draft-iesg", slug="nopubadw"))
+        draft.set_state(State.objects.get(used=True, type="draft-iesg", slug="nopubadw"))
 
         url = urlreverse('doc_approve_ballot', kwargs=dict(name=draft.name))
         login_testing_unauthorized(self, "secretary", url)
@@ -922,7 +922,7 @@ class MakeLastCallTestCase(django.test.TestCase):
 
     def test_make_last_call(self):
         draft = make_test_data()
-        draft.set_state(State.objects.get(type="draft-iesg", slug="lc-req"))
+        draft.set_state(State.objects.get(used=True, type="draft-iesg", slug="lc-req"))
 
         url = urlreverse('doc_make_last_call', kwargs=dict(name=draft.name))
         login_testing_unauthorized(self, "secretary", url)
@@ -963,7 +963,7 @@ def test_request_publication(self):
         draft.group = Group.objects.get(acronym="iab")
         draft.intended_std_level = IntendedStdLevelName.objects.get(slug="inf")
         draft.save()
-        draft.set_state(State.objects.get(type="draft-stream-iab", slug="approved"))
+        draft.set_state(State.objects.get(used=True, type="draft-stream-iab", slug="approved"))
 
         url = urlreverse('doc_request_publication', kwargs=dict(name=draft.name))
         login_testing_unauthorized(self, "iabchair", url)
@@ -1068,11 +1068,11 @@ def test_expire_ids(self):
 
         self.assertEquals(len(list(get_expired_ids())), 1)
 
-        draft.set_state(State.objects.get(type="draft-iesg", slug="watching"))
+        draft.set_state(State.objects.get(used=True, type="draft-iesg", slug="watching"))
 
         self.assertEquals(len(list(get_expired_ids())), 1)
 
-        draft.set_state(State.objects.get(type="draft-iesg", slug="iesg-eva"))
+        draft.set_state(State.objects.get(used=True, type="draft-iesg", slug="iesg-eva"))
 
         self.assertEquals(len(list(get_expired_ids())), 0)
 
@@ -1123,7 +1123,7 @@ def test_clean_up_id_files(self):
 
 
         # RFC draft
-        draft.set_state(State.objects.get(type="draft", slug="rfc"))
+        draft.set_state(State.objects.get(used=True, type="draft", slug="rfc"))
         draft.save()
 
         txt = "%s-%s.txt" % (draft.name, draft.rev)
@@ -1141,7 +1141,7 @@ def test_clean_up_id_files(self):
 
 
         # expire draft
-        draft.set_state(State.objects.get(type="draft", slug="expired"))
+        draft.set_state(State.objects.get(used=True, type="draft", slug="expired"))
         draft.expires = datetime.datetime.now() - datetime.timedelta(days=1)
         draft.save()
 
@@ -1183,7 +1183,7 @@ def test_expire_last_call(self):
         # check that non-expirable drafts aren't expired
 
         draft = make_test_data()
-        draft.set_state(State.objects.get(type="draft-iesg", slug="lc"))
+        draft.set_state(State.objects.get(used=True, type="draft-iesg", slug="lc"))
 
         secretary = Person.objects.get(name="Sec Retary")
 

ietf/idrfc/urls.py

@@ -84,8 +84,8 @@
 )
 
 urlpatterns += patterns('django.views.generic.simple',
-    url(r'^help/state/charter/$', 'direct_to_template', { 'template': 'doc/states.html', 'extra_context': { 'states': State.objects.filter(type="charter"),'title':"Charter" } }, name='help_charter_states'),
-    url(r'^help/state/conflict-review/$', 'direct_to_template', { 'template': 'doc/states.html', 'extra_context': { 'states': State.objects.filter(type="conflrev").order_by("order"),'title':"Conflict Review" } }, name='help_conflict_review_states'),
+    url(r'^help/state/charter/$', 'direct_to_template', { 'template': 'doc/states.html', 'extra_context': { 'states': State.objects.filter(used=True, type="charter"),'title':"Charter" } }, name='help_charter_states'),
+    url(r'^help/state/conflict-review/$', 'direct_to_template', { 'template': 'doc/states.html', 'extra_context': { 'states': State.objects.filter(used=True, type="conflrev").order_by("order"),'title':"Conflict Review" } }, name='help_conflict_review_states'),
 )