[Checkins] SVN: z3c.form/trunk/src/z3c/form/browser/ add special file testing widget template and data converter to fake file uploads in selenium.

[Paul Carduner]

Log message for revision 86815:
  add special file testing widget template and data converter to fake file uploads in selenium.

Changed:
  A   z3c.form/trunk/src/z3c/form/browser/file-testing.txt
  A   z3c.form/trunk/src/z3c/form/browser/file_testing_input.pt
  U   z3c.form/trunk/src/z3c/form/browser/tests.py

-=-
Added: z3c.form/trunk/src/z3c/form/browser/file-testing.txt
===================================================================
--- z3c.form/trunk/src/z3c/form/browser/file-testing.txt	                        (rev 0)
+++ z3c.form/trunk/src/z3c/form/browser/file-testing.txt	2008-05-17 00:53:17 UTC (rev 86815)
@@ -0,0 +1,114 @@
+===================
+File Testing Widget
+===================
+
+The File Testing widget is just like the file widget except it has
+another hidden field where the contents of a would be file can be
+uploaded in a textarea.
+As for all widgets, the file widget must provide the new ``IWidget``
+interface:
+
+  >>> from zope.interface.verify import verifyClass
+  >>> from z3c.form import interfaces
+  >>> from z3c.form.browser import file
+
+The widget can be instantiated only using the request:
+
+  >>> from z3c.form.testing import TestRequest
+  >>> request = TestRequest()
+
+  >>> widget = file.FileWidget(request)
+
+Before rendering the widget, one has to set the name and id of the widget:
+
+  >>> widget.id = 'widget.id'
+  >>> widget.name = 'widget.name'
+
+We also need to register the template for the widget:
+
+  >>> import zope.component
+  >>> from zope.pagetemplate.interfaces import IPageTemplate
+  >>> from z3c.form.testing import getPath
+  >>> from z3c.form.widget import WidgetTemplateFactory
+
+  >>> zope.component.provideAdapter(
+  ...     WidgetTemplateFactory(getPath('file_testing_input.pt'), 'text/html'),
+  ...     (None, None, None, None, interfaces.IFileWidget),
+  ...     IPageTemplate, name=interfaces.INPUT_MODE)
+
+If we render the widget we get a text area element instead of a simple
+input element, but also with a text area:
+
+  >>> print widget.render()
+  <input type="file" id="widget.id" name="widget.name"
+         class="file-widget" />
+  <textarea name="widget.name.testing" style="display: none;"></textarea>
+
+Let's now make sure that we can extract user entered data from a widget:
+
+  >>> import cStringIO
+  >>> myfile = cStringIO.StringIO('My file contents.')
+
+  >>> widget.request = TestRequest(form={'widget.name': myfile})
+  >>> widget.update()
+  >>> widget.extract()
+  <cStringIO.StringI object at ...>
+
+If nothing is found in the request, the default is returned:
+
+  >>> widget.request = TestRequest()
+  >>> widget.update()
+  >>> widget.extract()
+  <NOVALUE>
+
+Make also sure that we can handle FileUpload objects given from a file upload.
+
+  >>> import cStringIO
+  >>> from zope.publisher.browser import FileUpload
+
+Let's define a FieldStorage stub:
+
+  >>> class FieldStorageStub:
+  ...     def __init__(self, file):
+  ...         self.file = file
+  ...         self.headers = {}
+  ...         self.filename = 'foo.bar'
+
+Now build a FileUpload:
+
+  >>> myfile = cStringIO.StringIO('File upload contents.')
+  >>> aFieldStorage = FieldStorageStub(myfile)
+  >>> myUpload = FileUpload(aFieldStorage)
+
+  >>> widget.request = TestRequest(form={'widget.name': myUpload})
+  >>> widget.update()
+  >>> widget.extract()
+  <zope.publisher.browser.FileUpload object at ...>
+
+If we render them, we get a regular file upload widget:
+
+  >>> print widget.render()
+  <input type="file" id="widget.id" name="widget.name"
+         class="file-widget" />
+  <textarea name="widget.name.testing" style="display: none;"></textarea>
+
+Alternatively, we can also pass in the file upload content via the
+testing text area:
+
+  >>> widget.request = TestRequest(
+  ...     form={'widget.name.testing': 'File upload contents.'})
+  >>> widget.update()
+  >>> widget.extract()
+  <NOVALUE>
+
+The extract method uses the request directly, but we can get the value
+using the data converter.
+
+  >>> from z3c.form import testing
+  >>> import zope.schema
+  >>> conv = testing.TestingFileUploadDataConverter(
+  ...     zope.schema.Bytes(), widget)
+  >>> conv
+  <TestingFileUploadDataConverter converts from Bytes to FileWidget>
+  >>> conv.toFieldValue("")
+  u'File upload contents.'

Added: z3c.form/trunk/src/z3c/form/browser/file_testing_input.pt
===================================================================
--- z3c.form/trunk/src/z3c/form/browser/file_testing_input.pt	                        (rev 0)
+++ z3c.form/trunk/src/z3c/form/browser/file_testing_input.pt	2008-05-17 00:53:17 UTC (rev 86815)
@@ -0,0 +1,31 @@
+<input type="file" id="" name="" class="" title="" lang="" disabled=""
+       readonly="" alt="" tabindex="" accesskey="" size="" maxlength=""
+       tal:attributes="id view/id;
+                       name view/name;
+                       class view/klass;
+                       style view/style;
+                       title view/title;
+                       lang view/lang;
+                       onclick view/onclick;
+                       ondblclick view/ondblclick;
+                       onmousedown view/onmousedown;
+                       onmouseup view/onmouseup;
+                       onmouseover view/onmouseover;
+                       onmousemove view/onmousemove;
+                       onmouseout view/onmouseout;
+                       onkeypress view/onkeypress;
+                       onkeydown view/onkeydown;
+                       onkeyup view/onkeyup;
+                       disabled view/disabled;
+                       tabindex view/tabindex;
+                       onfocus view/onfocus;
+                       onblur view/onblur;
+                       onchange view/onchange;
+                       readonly view/readonly;
+                       alt view/alt;
+                       accesskey view/accesskey;
+                       onselect view/onselect;
+                       size view/size;
+                       maxlength view/maxlength" />
+<textarea name="" style="display: none;"
+       tal:attributes="name string:${view/name}.testing"></textarea>

Modified: z3c.form/trunk/src/z3c/form/browser/tests.py
===================================================================
--- z3c.form/trunk/src/z3c/form/browser/tests.py	2008-05-17 00:22:24 UTC (rev 86814)
+++ z3c.form/trunk/src/z3c/form/browser/tests.py	2008-05-17 00:53:17 UTC (rev 86815)
@@ -33,6 +33,10 @@
                      setUp=testing.setUp, tearDown=testing.tearDown,
                      optionflags=doctest.NORMALIZE_WHITESPACE|doctest.ELLIPSIS,
                      ),
+        DocFileSuite('file-testing.txt',
+                     setUp=testing.setUp, tearDown=testing.tearDown,
+                     optionflags=doctest.NORMALIZE_WHITESPACE|doctest.ELLIPSIS,
+                     ),
         DocFileSuite('image.txt',
                      setUp=testing.setUp, tearDown=testing.tearDown,
                      optionflags=doctest.NORMALIZE_WHITESPACE|doctest.ELLIPSIS,