<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[12767] CalendarServer/trunk/calendarserver/webadmin</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.calendarserver.org//changeset/12767">12767</a></dd>
<dt>Author</dt> <dd>wsanchez@apple.com</dd>
<dt>Date</dt> <dd>2014-02-27 12:17:30 -0800 (Thu, 27 Feb 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Start tests.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#CalendarServertrunkcalendarserverwebadmineventsourcepy">CalendarServer/trunk/calendarserver/webadmin/eventsource.py</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#CalendarServertrunkcalendarserverwebadmintesttest_eventsourcepy">CalendarServer/trunk/calendarserver/webadmin/test/test_eventsource.py</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="CalendarServertrunkcalendarserverwebadmineventsourcepy"></a>
<div class="modfile"><h4>Modified: CalendarServer/trunk/calendarserver/webadmin/eventsource.py (12766 => 12767)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/trunk/calendarserver/webadmin/eventsource.py 2014-02-27 18:31:01 UTC (rev 12766)
+++ CalendarServer/trunk/calendarserver/webadmin/eventsource.py 2014-02-27 20:17:30 UTC (rev 12767)
</span><span class="lines">@@ -46,6 +46,11 @@
</span><span class="cx"> binary data should be encoded as text if it is to be used in an EventSource
</span><span class="cx"> stream.
</span><span class="cx">
</span><ins>+ UTF-8 encoded L{bytes} are returned because
+ http://www.w3.org/TR/eventsource/ states that the only allowed encoding
+ for C{text/event-stream} is UTF-8.
+
+
</ins><span class="cx"> @param text: The text (ie. the message) to send in the event.
</span><span class="cx"> @type text: L{unicode}
</span><span class="cx">
</span><span class="lines">@@ -56,8 +61,11 @@
</span><span class="cx"> @type eventClass: L{unicode}
</span><span class="cx">
</span><span class="cx"> @return: An HTML5 EventSource event as text.
</span><del>- @rtype: L{unicode}
</del><ins>+ @rtype: UTF-8 encoded L{bytes}
</ins><span class="cx"> """
</span><ins>+ if text is None:
+ raise TypeError("text may not be None")
+
</ins><span class="cx"> event = []
</span><span class="cx">
</span><span class="cx"> if eventID is not None:
</span><span class="lines">@@ -70,7 +78,7 @@
</span><span class="cx"> u"data: {0}".format(l) for l in text.split("\n")
</span><span class="cx"> )
</span><span class="cx">
</span><del>- return u"\n".join(event) + u"\n\n"
</del><ins>+ return (u"\n".join(event) + u"\n\n").encode("utf-8")
</ins><span class="cx">
</span><span class="cx">
</span><span class="cx">
</span><span class="lines">@@ -122,9 +130,14 @@
</span><span class="cx"> """
</span><span class="cx"> Resource.__init__(self)
</span><span class="cx">
</span><ins>+ self._eventDecoder = eventDecoder
</ins><span class="cx"> self._events = deque(maxlen=bufferSize)
</span><span class="cx">
</span><span class="cx">
</span><ins>+ def addEvent(self, event):
+ self._events.append(event)
+
+
</ins><span class="cx"> def render(self, request):
</span><span class="cx"> lastID = request.headers.getRawHeaders(u"last-event-id")
</span><span class="cx">
</span><span class="lines">@@ -167,10 +180,6 @@
</span><span class="cx"> self._closed = False
</span><span class="cx">
</span><span class="cx">
</span><del>- def addEvent(self, event):
- self._events.append(event)
-
-
</del><span class="cx"> def read(self):
</span><span class="cx"> if self._closed:
</span><span class="cx"> return None
</span><span class="lines">@@ -178,9 +187,9 @@
</span><span class="cx"> lastID = self._lastID
</span><span class="cx"> eventID = None
</span><span class="cx">
</span><del>- idForEvent = self.eventDecoder.idForEvent
- classForEvent = self.eventDecoder.classForEvent
- textForEvent = self.eventDecoder.textForEvent
</del><ins>+ idForEvent = self._eventDecoder.idForEvent
+ classForEvent = self._eventDecoder.classForEvent
+ textForEvent = self._eventDecoder.textForEvent
</ins><span class="cx">
</span><span class="cx"> for event in self._events:
</span><span class="cx"> eventID = idForEvent(event)
</span><span class="lines">@@ -197,6 +206,8 @@
</span><span class="cx"> eventClass = classForEvent(event)
</span><span class="cx"> eventText = textForEvent(event)
</span><span class="cx">
</span><ins>+ self._lastID = eventID
+
</ins><span class="cx"> return succeed(
</span><span class="cx"> textAsEvent(eventText, eventID, eventClass).encode("utf-8")
</span><span class="cx"> )
</span></span></pre></div>
<a id="CalendarServertrunkcalendarserverwebadmintesttest_eventsourcepy"></a>
<div class="addfile"><h4>Added: CalendarServer/trunk/calendarserver/webadmin/test/test_eventsource.py (0 => 12767)</h4>
<pre class="diff"><span>
<span class="info">--- CalendarServer/trunk/calendarserver/webadmin/test/test_eventsource.py (rev 0)
+++ CalendarServer/trunk/calendarserver/webadmin/test/test_eventsource.py 2014-02-27 20:17:30 UTC (rev 12767)
</span><span class="lines">@@ -0,0 +1,229 @@
</span><ins>+##
+# Copyright (c) 2011-2014 Apple Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+##
+
+"""
+Tests for L{calendarserver.webadmin.eventsource}.
+"""
+
+from __future__ import print_function
+
+from twisted.internet.defer import inlineCallbacks
+from twisted.trial.unittest import TestCase
+
+from txweb2.http import Request
+from txweb2.http_headers import Headers
+
+from ..eventsource import textAsEvent, EventSourceResource
+
+
+
+class EventGenerationTests(TestCase):
+ """
+ Tests for emitting HTML5 EventSource events.
+ """
+
+ def test_textAsEvent(self):
+ """
+ Generate an event from some text.
+ """
+ self.assertEquals(
+ textAsEvent(u"Hello, World!"),
+ b"data: Hello, World!\n\n"
+ )
+
+
+ def test_textAsEvent_newlines(self):
+ """
+ Text with newlines generates multiple C{data:} lines in event.
+ """
+ self.assertEquals(
+ textAsEvent(u"AAPL\nApple Inc.\n527.10"),
+ b"data: AAPL\ndata: Apple Inc.\ndata: 527.10\n\n"
+ )
+
+
+ def test_textAsEvent_newlineTrailing(self):
+ """
+ Text with trailing newline generates trailing blank C{data:} line.
+ """
+ self.assertEquals(
+ textAsEvent(u"AAPL\nApple Inc.\n527.10\n"),
+ b"data: AAPL\ndata: Apple Inc.\ndata: 527.10\ndata: \n\n"
+ )
+
+
+ def test_textAsEvent_encoding(self):
+ """
+ Event text is encoded as UTF-8.
+ """
+ self.assertEquals(
+ textAsEvent(u"S\xe1nchez"),
+ b"data: S\xc3\xa1nchez\n\n"
+ )
+
+
+ def test_textAsEvent_emptyText(self):
+ """
+ Text may not be L{None}.
+ """
+ self.assertEquals(
+ textAsEvent(u""),
+ b"data: \n\n" # Note that b"data\n\n" is a valid result here also
+ )
+
+
+ def test_textAsEvent_NoneText(self):
+ """
+ Text may not be L{None}.
+ """
+ self.assertRaises(TypeError, textAsEvent, None)
+
+
+ def test_textAsEvent_eventID(self):
+ """
+ Event ID goes into the C{id} field.
+ """
+ self.assertEquals(
+ textAsEvent(u"", eventID=u"1234"),
+ b"id: 1234\ndata: \n\n" # Note order is allowed to vary
+ )
+
+
+ def test_textAsEvent_eventClass(self):
+ """
+ Event class goes into the C{event} field.
+ """
+ self.assertEquals(
+ textAsEvent(u"", eventClass=u"buckets"),
+ b"event: buckets\ndata: \n\n" # Note order is allowed to vary
+ )
+
+
+
+class EventSourceResourceTests(TestCase):
+ """
+ Tests for L{EventSourceResource}.
+ """
+
+ def eventSourceResource(self, events=()):
+ resource = EventSourceResource(DictionaryEventDecoder)
+
+ for event in events:
+ resource.addEvent(event)
+
+ return resource
+
+
+ def render(self, resource):
+ headers = Headers()
+
+ request = Request(
+ chanRequest=None,
+ command=None,
+ path="/",
+ version=None,
+ contentLength=None,
+ headers=headers
+ )
+
+ return resource.render(request)
+
+
+ def test_status(self):
+ """
+ Response status is C{200}.
+ """
+ resource = self.eventSourceResource()
+ response = self.render(resource)
+
+ self.assertEquals(response.code, 200)
+
+
+ def test_contentType(self):
+ """
+ Response content type is C{text/event-stream}.
+ """
+ resource = self.eventSourceResource()
+ response = self.render(resource)
+
+ self.assertEquals(
+ response.headers.getRawHeaders(b"Content-Type"),
+ ["text/event-stream"]
+ )
+
+
+ def test_contentLength(self):
+ """
+ Response content length is not provided.
+ """
+ resource = self.eventSourceResource()
+ response = self.render(resource)
+
+ self.assertEquals(
+ response.headers.getRawHeaders(b"Content-Length"),
+ None
+ )
+
+
+ @inlineCallbacks
+ def test_streamBufferedEvents(self):
+ """
+ Events already buffered are vended immediately, then we get EOF.
+ """
+ events = (
+ dict(eventID=u"1", eventText=u"A"),
+ dict(eventID=u"2", eventText=u"B"),
+ dict(eventID=u"3", eventText=u"C"),
+ dict(eventID=u"4", eventText=u"D"),
+ )
+
+ resource = self.eventSourceResource(events)
+ response = self.render(resource)
+
+ # Each result from read() is another event
+ for i in range(4):
+ result = yield response.stream.read()
+ self.assertEquals(
+ result,
+ textAsEvent(
+ text=events[i]["eventText"],
+ eventID=events[i]["eventID"]
+ )
+ )
+
+ result = yield response.stream.read()
+ self.assertEquals(result, None)
+
+
+
+class DictionaryEventDecoder(object):
+ """
+ Decodes events represented as dictionaries.
+ """
+
+ @staticmethod
+ def idForEvent(event):
+ return event.get("eventID")
+
+
+ @staticmethod
+ def classForEvent(event):
+ return event.get("eventClass")
+
+
+ @staticmethod
+ def textForEvent(event):
+ return event.get("eventText")
</ins></span></pre>
</div>
</div>
</body>
</html>