chore: merge feat/rfc

Author: rjsparks

.github/workflows/ci-run-tests.yml

@@ -4,7 +4,6 @@ on:
   pull_request:
     branches:
       - 'main'
-      - 'feat/rfc'
     paths:
       - 'client/**'
       - 'ietf/**'

ietf/api/tests.py

@@ -24,7 +24,7 @@
 import ietf
 from ietf.doc.utils import get_unicode_document_content
 from ietf.doc.models import RelatedDocument, State
-from ietf.doc.factories import IndividualDraftFactory, WgDraftFactory
+from ietf.doc.factories import IndividualDraftFactory, WgDraftFactory, WgRfcFactory
 from ietf.group.factories import RoleFactory
 from ietf.meeting.factories import MeetingFactory, SessionFactory
 from ietf.meeting.models import Session
@@ -968,9 +968,9 @@ def do_rfc_test(self, draft_name):
         draft.set_state(State.objects.get(type_id='draft',slug='rfc'))
         draft.set_state(State.objects.get(type_id='draft-iesg', slug='pub'))
         draft = reload_db_objects(draft)
-        rfc = draft
+        rfc = WgRfcFactory(group=draft.group)  # todo link this with its pre-publication draft
 
-        number = rfc.rfc_number()
+        number = rfc.rfc_number
         received = self.getJson(dict(name=number))
         self.assertEqual(
             received,

ietf/api/views.py

@@ -340,10 +340,7 @@ def rfcdiff_latest_json(request, name, rev=None):
             response['name']=doc.canonical_name()
             if doc.name != doc.canonical_name():
                 prev_rev = doc.rev
-                # not sure what to do if non-numeric values come back, so at least log it
-                log.assertion('doc.rfc_number().isdigit()') # .rfc_number() is expensive...
-                log.assertion('doc.rev.isdigit()')
-                if int(doc.rfc_number()) in HAS_TOMBSTONE and prev_rev != '00':
+                if doc.rfc_number in HAS_TOMBSTONE and prev_rev != '00':
                     prev_rev = f'{(int(doc.rev)-1):02d}'
                 response['previous'] = f'{doc.name}-{prev_rev}'
                 response['previous_url'] = get_previous_url(doc.name, prev_rev)

ietf/bin/rfc-editor-index-updates

@@ -84,7 +84,7 @@ for changes, doc, rfc_published in ietf.sync.rfceditor.update_docs_from_rfc_inde
         new_rfcs.append(doc)
 
     for c in changes:
-        log("RFC%s, %s: %s" % (doc.rfcnum, doc.name, c))
+        log("RFC%s, %s: %s" % (doc.rfc_number, doc.name, c))
 
 sys.exit(0)
 

ietf/doc/factories.py

@@ -113,27 +113,11 @@ class DocumentFactory(BaseDocumentFactory):
     group = factory.SubFactory('ietf.group.factories.GroupFactory',acronym='none')
 
 
-class IndividualDraftFactory(BaseDocumentFactory):
-
-    type_id = 'draft'
-    group = factory.SubFactory('ietf.group.factories.GroupFactory',acronym='none')
-
-    @factory.post_generation
-    def states(obj, create, extracted, **kwargs):
-        if not create:
-            return
-        if extracted:
-            for (state_type_id,state_slug) in extracted:
-                obj.set_state(State.objects.get(type_id=state_type_id,slug=state_slug))
-            if not obj.get_state('draft-iesg'):
-                obj.set_state(State.objects.get(type_id='draft-iesg',slug='idexists'))
-        else:
-            obj.set_state(State.objects.get(type_id='draft',slug='active'))
-            obj.set_state(State.objects.get(type_id='draft-iesg',slug='idexists'))
-
-class IndividualRfcFactory(IndividualDraftFactory):
-
-    alias2 = factory.RelatedFactory('ietf.doc.factories.DocAliasFactory','document',name=factory.Sequence(lambda n: 'rfc%04d'%(n+1000)))
+class RfcFactory(BaseDocumentFactory):
+    type_id = "rfc"
+    rfc_number = factory.Sequence(lambda n: n + 1000)
+    name = factory.LazyAttribute(lambda o: f"rfc{o.rfc_number:04d}")
+    expires = None
 
     @factory.post_generation
     def states(obj, create, extracted, **kwargs):
@@ -143,19 +127,19 @@ def states(obj, create, extracted, **kwargs):
             for (state_type_id,state_slug) in extracted:
                 obj.set_state(State.objects.get(type_id=state_type_id,slug=state_slug))
         else:
-            obj.set_state(State.objects.get(type_id='draft',slug='rfc'))
+            obj.set_state(State.objects.get(type_id='rfc',slug='published'))
 
     @factory.post_generation
     def reset_canonical_name(obj, create, extracted, **kwargs): 
         if hasattr(obj, '_canonical_name'):
             del obj._canonical_name
         return None
 
-class WgDraftFactory(BaseDocumentFactory):
+
+class IndividualDraftFactory(BaseDocumentFactory):
 
     type_id = 'draft'
-    group = factory.SubFactory('ietf.group.factories.GroupFactory',type_id='wg')
-    stream_id = 'ietf'
+    group = factory.SubFactory('ietf.group.factories.GroupFactory',acronym='none')
 
     @factory.post_generation
     def states(obj, create, extracted, **kwargs):
@@ -168,14 +152,16 @@ def states(obj, create, extracted, **kwargs):
                 obj.set_state(State.objects.get(type_id='draft-iesg',slug='idexists'))
         else:
             obj.set_state(State.objects.get(type_id='draft',slug='active'))
-            obj.set_state(State.objects.get(type_id='draft-stream-ietf',slug='wg-doc'))
             obj.set_state(State.objects.get(type_id='draft-iesg',slug='idexists'))
 
-class WgRfcFactory(WgDraftFactory):
+class IndividualRfcFactory(RfcFactory):
+    group = factory.SubFactory('ietf.group.factories.GroupFactory',acronym='none')
 
-    alias2 = factory.RelatedFactory('ietf.doc.factories.DocAliasFactory','document',name=factory.Sequence(lambda n: 'rfc%04d'%(n+1000)))
 
-    std_level_id = 'ps'
+class WgDraftFactory(BaseDocumentFactory):
+    type_id = 'draft'
+    group = factory.SubFactory('ietf.group.factories.GroupFactory',type_id='wg')
+    stream_id = 'ietf'
 
     @factory.post_generation
     def states(obj, create, extracted, **kwargs):
@@ -185,16 +171,18 @@ def states(obj, create, extracted, **kwargs):
             for (state_type_id,state_slug) in extracted:
                 obj.set_state(State.objects.get(type_id=state_type_id,slug=state_slug))
             if not obj.get_state('draft-iesg'):
-                obj.set_state(State.objects.get(type_id='draft-iesg', slug='pub'))
+                obj.set_state(State.objects.get(type_id='draft-iesg',slug='idexists'))
         else:
-            obj.set_state(State.objects.get(type_id='draft',slug='rfc'))
-            obj.set_state(State.objects.get(type_id='draft-iesg', slug='pub'))
+            obj.set_state(State.objects.get(type_id='draft',slug='active'))
+            obj.set_state(State.objects.get(type_id='draft-stream-ietf',slug='wg-doc'))
+            obj.set_state(State.objects.get(type_id='draft-iesg',slug='idexists'))
+
+
+class WgRfcFactory(RfcFactory):
+    group = factory.SubFactory('ietf.group.factories.GroupFactory',type_id='wg')
+    stream_id = 'ietf'
+    std_level_id = 'ps'
 
-    @factory.post_generation
-    def reset_canonical_name(obj, create, extracted, **kwargs): 
-        if hasattr(obj, '_canonical_name'):
-            del obj._canonical_name
-        return None
 
 class RgDraftFactory(BaseDocumentFactory):
 
@@ -217,34 +205,11 @@ def states(obj, create, extracted, **kwargs):
             obj.set_state(State.objects.get(type_id='draft-iesg',slug='idexists'))
 
 
-class RgRfcFactory(RgDraftFactory):
-
-    alias2 = factory.RelatedFactory('ietf.doc.factories.DocAliasFactory','document',name=factory.Sequence(lambda n: 'rfc%04d'%(n+1000)))
-
+class RgRfcFactory(RfcFactory):
+    group = factory.SubFactory('ietf.group.factories.GroupFactory',type_id='rg')
+    stream_id = 'irtf'
     std_level_id = 'inf'
 
-    @factory.post_generation
-    def states(obj, create, extracted, **kwargs):
-        if not create:
-            return
-        if extracted:
-            for (state_type_id,state_slug) in extracted:
-                obj.set_state(State.objects.get(type_id=state_type_id,slug=state_slug))
-            if not obj.get_state('draft-stream-irtf'):
-                obj.set_state(State.objects.get(type_id='draft-stream-irtf', slug='pub'))
-            if not obj.get_state('draft-iesg'):
-                obj.set_state(State.objects.get(type_id='draft-iesg',slug='idexists'))
-        else:
-            obj.set_state(State.objects.get(type_id='draft',slug='rfc'))
-            obj.set_state(State.objects.get(type_id='draft-stream-irtf', slug='pub'))
-            obj.set_state(State.objects.get(type_id='draft-iesg',slug='idexists'))
-
-    @factory.post_generation
-    def reset_canonical_name(obj, create, extracted, **kwargs): 
-        if hasattr(obj, '_canonical_name'):
-            del obj._canonical_name
-        return None          
-
 
 class CharterFactory(BaseDocumentFactory):
 
@@ -545,30 +510,5 @@ def states(obj, create, extracted, **kwargs):
             obj.set_state(State.objects.get(type_id='draft-stream-editorial',slug='active'))
             obj.set_state(State.objects.get(type_id='draft-iesg',slug='idexists'))
 
-class EditorialRfcFactory(RgDraftFactory):
-
-    alias2 = factory.RelatedFactory('ietf.doc.factories.DocAliasFactory','document',name=factory.Sequence(lambda n: 'rfc%04d'%(n+1000)))
-
-    std_level_id = 'inf'
-
-    @factory.post_generation
-    def states(obj, create, extracted, **kwargs):
-        if not create:
-            return
-        if extracted:
-            for (state_type_id,state_slug) in extracted:
-                obj.set_state(State.objects.get(type_id=state_type_id,slug=state_slug))
-            if not obj.get_state('draft-stream-editorial'):
-                obj.set_state(State.objects.get(type_id='draft-stream-editorial', slug='pub'))
-            if not obj.get_state('draft-iesg'):
-                obj.set_state(State.objects.get(type_id='draft-iesg',slug='idexists'))
-        else:
-            obj.set_state(State.objects.get(type_id='draft',slug='rfc'))
-            obj.set_state(State.objects.get(type_id='draft-stream-editorial', slug='pub'))
-            obj.set_state(State.objects.get(type_id='draft-iesg',slug='idexists'))
-
-    @factory.post_generation
-    def reset_canonical_name(obj, create, extracted, **kwargs): 
-        if hasattr(obj, '_canonical_name'):
-            del obj._canonical_name
-        return None          
+class EditorialRfcFactory(RgRfcFactory):
+    pass

ietf/doc/forms.py

@@ -175,7 +175,7 @@ def clean(self):
         drafts = self.cleaned_data['drafts']
         for d in drafts:
             if RelatedDocument.objects.filter(source=d, target=rfc, relationship_id='downref-approval'):
-                v_err_pairs.append(d.name + " --> RFC " + rfc.rfc_number())
+                v_err_pairs.append(f"{d.name} --> RFC {rfc.rfc_number}")
         if v_err_pairs:
             raise forms.ValidationError("Downref is already in the registry: " + ", ".join(v_err_pairs))
 
@@ -189,7 +189,8 @@ def clean(self):
                     else:
                         v_err_refnorm = d.name
             if v_err_refnorm:
-                v_err_refnorm_prefix = "There does not seem to be a normative reference to RFC " + rfc.rfc_number() + " by "
+                v_err_refnorm_prefix = f"There does not seem to be a normative reference to RFC {rfc.rfc_number} by "
+                v_err_refnorm_prefix = f"There does not seem to be a normative reference to RFC {rfc.document.rfc_number} by "
                 raise forms.ValidationError(v_err_refnorm_prefix  + v_err_refnorm)
 
 

ietf/doc/migrations/0005_add_rfc_states.py

@@ -0,0 +1,23 @@
+# Generated by Django 4.2.2 on 2023-06-14 20:57
+
+from django.db import migrations
+
+
+def forward(apps, schema_editor):
+    StateType = apps.get_model("doc", "StateType")
+    rfc_statetype, _ = StateType.objects.get_or_create(slug="rfc", label="State")
+
+    State = apps.get_model("doc", "State")
+    State.objects.get_or_create(
+        type=rfc_statetype, slug="published", name="Published", used=True, order=1
+    )
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("doc", "0004_alter_dochistory_ad_alter_dochistory_shepherd_and_more"),
+    ]
+
+    operations = [
+        migrations.RunPython(forward),
+    ]

ietf/doc/migrations/0006_dochistory_rfc_number_document_rfc_number.py

@@ -0,0 +1,22 @@
+# Generated by Django 4.2.2 on 2023-06-14 22:28
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("doc", "0005_add_rfc_states"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="dochistory",
+            name="rfc_number",
+            field=models.PositiveIntegerField(blank=True, null=True),
+        ),
+        migrations.AddField(
+            model_name="document",
+            name="rfc_number",
+            field=models.PositiveIntegerField(blank=True, null=True),
+        ),
+    ]

ietf/doc/migrations/0007_create_rfc_documents.py

@@ -0,0 +1,75 @@
+# Generated by Django 4.2.2 on 2023-06-15 15:27
+
+from django.db import migrations
+
+
+def forward(apps, schema_editor):
+    Document = apps.get_model("doc", "Document")
+    DocAlias = apps.get_model("doc", "DocAlias")
+    DocumentAuthor = apps.get_model("doc", "DocumentAuthor")
+    
+    State = apps.get_model("doc", "State")
+    draft_rfc_state = State.objects.get(type_id="draft", slug="rfc")
+    rfc_published_state = State.objects.get(type_id="rfc", slug="published")
+    
+    DocTypeName = apps.get_model("name", "DocTypeName")
+    rfc_doctype = DocTypeName(slug="rfc")
+    
+    # Find draft Documents in the "rfc" state
+    found_by_state = Document.objects.filter(states=draft_rfc_state).distinct()
+    
+    # Find Documents with an "rfc..." alias and confirm they're the same set
+    rfc_docaliases = DocAlias.objects.filter(name__startswith="rfc")
+    found_by_name = Document.objects.filter(docalias__in=rfc_docaliases).distinct()
+    assert set(found_by_name) == set(found_by_state), "mismatch between rfcs identified by state and docalias"
+    
+    # As of 2023-06-15, there is one Document with two rfc aliases: rfc6312 and rfc6342 are the same Document. This 
+    # was due to a publication error. We'll handle that specially.
+    
+    for rfc_alias in rfc_docaliases.order_by("name"):
+        assert rfc_alias.docs.count() == 1, f"DocAlias {rfc_alias} is linked to more than 1 Document"
+        draft = rfc_alias.docs.first()
+        if draft.name.startswith("rfc"):
+            rfc = draft
+            rfc.type = rfc_doctype
+            rfc.rfc_number = int(draft.name[3:])
+            rfc.save()
+            rfc.states.set([rfc_published_state])
+        else:
+            rfc = Document.objects.create(
+                type=rfc_doctype,
+                name=rfc_alias.name,
+                rfc_number=int(rfc_alias.name[3:]),
+                title=draft.title,
+                abstract=draft.abstract,
+                pages=draft.pages,
+                words=draft.words,
+                std_level=draft.std_level,
+                external_url=draft.external_url,
+                uploaded_filename=draft.uploaded_filename,
+                note=draft.note,
+            )
+            rfc.states.set([rfc_published_state])
+            rfc.formal_languages.set(draft.formal_languages.all())
+            
+            # Copy Authors
+            for da in draft.documentauthor_set.all():
+                DocumentAuthor.objects.create(
+                    document=rfc,
+                    person=da.person,
+                    email=da.email,
+                    affiliation=da.affiliation,
+                    country=da.country,
+                    order=da.order,
+                )
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("doc", "0006_dochistory_rfc_number_document_rfc_number"),
+        ("name", "0004_rfc_doctype_names"),
+    ]
+
+    operations = [
+        migrations.RunPython(forward),
+    ]