Added an API for draft submission, at /api/submit. Added an urls.py file under api/ to hold api urls, and moved those from ietf/urls.py. Refactored out many parts of the regular submission forms and functions in submit/forms.py and submit/views.py in order to re-use the appropriate parts for the submission API. Moved support functions to submit/utils.py. Added a new validation errors for missing docName in xml-based submissions. Updated the submission test document templates to use insert additional values. Added failure and success test cases for automated API submissions, and refactored some test utility functions.

 - Legacy-Id: 14125

Author: levkowetz

ietf/api/urls.py

@@ -0,0 +1,24 @@
+# Copyright The IETF Trust 2017, All Rights Reserved
+
+from django.conf.urls import include
+
+from ietf import api
+from ietf.meeting import views as meeting_views
+from ietf.submit import views as submit_views
+from ietf.utils.urls import url
+
+api.autodiscover()
+
+urlpatterns = [
+    # Top endpoint for Tastypie's REST API (this isn't standard Tastypie):
+    url(r'^v1/?$', api.top_level),
+    # Custom API endpoints
+    url(r'^notify/meeting/import_recordings/(?P<number>[a-z0-9-]+)/?$', meeting_views.api_import_recordings),
+    url(r'^submit/?$', submit_views.api_submit),
+]
+# Additional (standard) Tastypie endpoints
+for n,a in api._api_list:
+    urlpatterns += [
+        url(r'^v1/', include(a.urls)),
+    ]
+

ietf/submit/forms.py

@@ -31,14 +31,11 @@
 from ietf.submit.parsers.xml_parser import XMLParser
 from ietf.utils.draft import Draft
 
-class SubmissionUploadForm(forms.Form):
-    txt = forms.FileField(label=u'.txt format', required=False)
-    xml = forms.FileField(label=u'.xml format', required=False)
-    pdf = forms.FileField(label=u'.pdf format', required=False)
-    ps  = forms.FileField(label=u'.ps format', required=False)
+class SubmissionBaseUploadForm(forms.Form):
+    xml = forms.FileField(label=u'.xml format', required=True)
 
     def __init__(self, request, *args, **kwargs):
-        super(SubmissionUploadForm, self).__init__(*args, **kwargs)
+        super(SubmissionBaseUploadForm, self).__init__(*args, **kwargs)
 
         self.remote_ip = request.META.get('REMOTE_ADDR', None)
 
@@ -56,6 +53,14 @@ def __init__(self, request, *args, **kwargs):
         self.authors = []
         self.parsed_draft = None
         self.file_types = []
+        # No code currently (14 Sep 2017) uses this class directly; it is
+        # only used through its subclasses.  The two assignments below are
+        # set to trigger an exception if it is used directly only to make
+        # sure that adequate consideration is made if it is decided to use it
+        # directly in the future.  Feel free to set these appropriately to
+        # avoid the exceptions in that case:
+        self.formats = None             # None will raise an exception in clean() if this isn't changed in a subclass
+        self.base_formats = None        # None will raise an exception in clean() if this isn't changed in a subclass
 
     def set_cutoff_warnings(self):
         now = datetime.datetime.now(pytz.utc)
@@ -96,6 +101,7 @@ def set_cutoff_warnings(self):
                 'The last submission time for the I-D submission was %s.<br/><br>'
                 'The I-D submission tool will be reopened after %s (IETF-meeting local time).' % (cutoff_01_str, reopen_str))
             self.shutdown = True
+
     def clean_file(self, field_name, parser_class):
         f = self.cleaned_data[field_name]
         if not f:
@@ -107,29 +113,20 @@ def clean_file(self, field_name, parser_class):
 
         return f
 
-    def clean_txt(self):
-        return self.clean_file("txt", PlainParser)
-
-    def clean_pdf(self):
-        return self.clean_file("pdf", PDFParser)
-
-    def clean_ps(self):
-        return self.clean_file("ps",  PSParser)
-
     def clean_xml(self):
         return self.clean_file("xml", XMLParser)
 
     def clean(self):
         if self.shutdown and not has_role(self.request.user, "Secretariat"):
             raise forms.ValidationError('The submission tool is currently shut down')
 
-        for ext in ['txt', 'pdf', 'xml', 'ps']:
+        for ext in self.formats:
             f = self.cleaned_data.get(ext, None)
             if not f:
                 continue
             self.file_types.append('.%s' % ext)
         if not ('.txt' in self.file_types or '.xml' in self.file_types):
-            raise forms.ValidationError('You must submit at least a valid .txt or a valid .xml file; didn\'t find either.')
+            raise forms.ValidationError('Unexpected submission file types; found %s, but %s is required' % (', '.join(self.file_types), ' or '.join(self.base_formats)))
 
         #debug.show('self.cleaned_data["xml"]')
         if self.cleaned_data.get('xml'):
@@ -168,6 +165,8 @@ def clean(self):
                         )
                 self.xmlroot = self.xmltree.getroot()
                 draftname = self.xmlroot.attrib.get('docName')
+                if draftname is None:
+                    raise forms.ValidationError("No docName attribute found in the xml root element")
                 revmatch = re.search("-[0-9][0-9]$", draftname)
                 if revmatch:
                     self.revision = draftname[-2:]
@@ -273,7 +272,7 @@ def clean(self):
                 settings.IDSUBMIT_MAX_DAILY_SUBMISSIONS, settings.IDSUBMIT_MAX_DAILY_SUBMISSIONS_SIZE,
             )
 
-        return super(SubmissionUploadForm, self).clean()
+        return super(SubmissionBaseUploadForm, self).clean()
 
     def check_submissions_tresholds(self, which, filter_kwargs, max_amount, max_size):
         submissions = Submission.objects.filter(**filter_kwargs)
@@ -332,6 +331,34 @@ def deduce_group(self):
             else:
                 return None
 
+class SubmissionManualUploadForm(SubmissionBaseUploadForm):
+    xml = forms.FileField(label=u'.xml format', required=False) # xml field with required=False instead of True
+    txt = forms.FileField(label=u'.txt format', required=False)
+    pdf = forms.FileField(label=u'.pdf format', required=False)
+    ps  = forms.FileField(label=u'.ps format', required=False)
+
+    def __init__(self, request, *args, **kwargs):
+        super(SubmissionManualUploadForm, self).__init__(request, *args, **kwargs)
+        self.formats = ['txt', 'pdf', 'xml', 'ps', ]
+        self.base_formats = ['txt', 'xml', ]
+
+    def clean_txt(self):
+        return self.clean_file("txt", PlainParser)
+
+    def clean_pdf(self):
+        return self.clean_file("pdf", PDFParser)
+
+    def clean_ps(self):
+        return self.clean_file("ps",  PSParser)
+
+class SubmissionAutoUploadForm(SubmissionBaseUploadForm):
+    user = forms.EmailField(required=True)
+
+    def __init__(self, request, *args, **kwargs):
+        super(SubmissionAutoUploadForm, self).__init__(request, *args, **kwargs)
+        self.formats = ['xml', ]
+        self.base_formats = ['xml', ]
+
 class NameEmailForm(forms.Form):
     name = forms.CharField(required=True)
     email = forms.EmailField(label=u'Email address', required=True)

ietf/submit/test_submission.txt

@@ -2,7 +2,7 @@
 
 
 
-Network Working Group                                            A. Name
+Network Working Group                                            %(initials)s %(surname)s
 Internet-Draft                                          Test Centre Inc.
 Intended status: Informational                                %(month)s %(year)s
 Expires: %(expiration)s
@@ -180,13 +180,13 @@ Table of Contents
 
 Author's Address
 
-   Author Name
+   %(author)s
    Test Centre Inc.
    42 Some Road
    Some Where 12345
    UK
 
-   Email: author@example.com
+   Email: %(email)s
 
 
 

ietf/submit/test_submission.xml

@@ -3,8 +3,8 @@
 <?rfc toc="yes"?>
 <rfc category="info" docName="%(name)s" ipr="trust200902">
   <front>
-    <title>Testing&nbsp;Tests</title>
-    <author fullname="Author Name" initials="A." surname="Name">
+    <title>%(title)s</title>
+    <author fullname="%(author)s" initials="%(initials)s" surname="%(surname)s">
       <organization>Test Centre Inc.</organization>
 
       <address>
@@ -13,7 +13,7 @@
           <city>Some Where 12345</city>
           <country>UK</country>
         </postal>
-        <email>author@example.com</email>
+        <email>%(email)s</email>
       </address>
     </author>
     <date month="%(month)s" year="%(year)s" />

ietf/submit/test_submission_invalid_yang.txt

@@ -180,13 +180,13 @@ Table of Contents
 
 Author's Address
 
-   Author Name
+   %(author)s
    Test Centre Inc.
    42 Some Road
    Some Where 12345
    UK
 
-   Email: author@example.com
+   Email: %(email)s