/usr/lib/python2.7/dist-packages/twext/web2/test/test_stream.py is in calendarserver 5.2+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 | # Copyright (c) 2008 Twisted Matrix Laboratories.
# See LICENSE for details.
"""
Tests for the stream implementations in L{twext.web2}.
"""
import tempfile, sys, os
from zope.interface import implements
from twisted.python.util import sibpath
sibpath # sibpath is *not* unused - the doctests use it.
from twisted.python.hashlib import md5
from twisted.internet import reactor, defer, interfaces
from twisted.trial import unittest
from twext.web2 import stream
def bufstr(data):
try:
return str(buffer(data))
except TypeError:
raise TypeError("%s doesn't conform to the buffer interface" % (data,))
class SimpleStreamTests:
text = '1234567890'
def test_split(self):
for point in range(10):
s = self.makeStream(0)
a,b = s.split(point)
if point > 0:
self.assertEquals(bufstr(a.read()), self.text[:point])
self.assertEquals(a.read(), None)
if point < len(self.text):
self.assertEquals(bufstr(b.read()), self.text[point:])
self.assertEquals(b.read(), None)
for point in range(7):
s = self.makeStream(2, 6)
self.assertEquals(s.length, 6)
a,b = s.split(point)
if point > 0:
self.assertEquals(bufstr(a.read()), self.text[2:point+2])
self.assertEquals(a.read(), None)
if point < 6:
self.assertEquals(bufstr(b.read()), self.text[point+2:8])
self.assertEquals(b.read(), None)
def test_read(self):
s = self.makeStream()
self.assertEquals(s.length, len(self.text))
self.assertEquals(bufstr(s.read()), self.text)
self.assertEquals(s.read(), None)
s = self.makeStream(0, 4)
self.assertEquals(s.length, 4)
self.assertEquals(bufstr(s.read()), self.text[0:4])
self.assertEquals(s.read(), None)
self.assertEquals(s.length, 0)
s = self.makeStream(4, 6)
self.assertEquals(s.length, 6)
self.assertEquals(bufstr(s.read()), self.text[4:10])
self.assertEquals(s.read(), None)
self.assertEquals(s.length, 0)
class FileStreamTest(SimpleStreamTests, unittest.TestCase):
def makeStream(self, *args, **kw):
return stream.FileStream(self.f, *args, **kw)
def setUp(self):
"""
Create a file containing C{self.text} to be streamed.
"""
f = tempfile.TemporaryFile('w+')
f.write(self.text)
f.seek(0, 0)
self.f = f
def test_close(self):
s = self.makeStream()
s.close()
self.assertEquals(s.length, 0)
# Make sure close doesn't close file
# would raise exception if f is closed
self.f.seek(0, 0)
def test_read2(self):
s = self.makeStream(0)
s.CHUNK_SIZE = 6
self.assertEquals(s.length, 10)
self.assertEquals(bufstr(s.read()), self.text[0:6])
self.assertEquals(bufstr(s.read()), self.text[6:10])
self.assertEquals(s.read(), None)
s = self.makeStream(0)
s.CHUNK_SIZE = 5
self.assertEquals(s.length, 10)
self.assertEquals(bufstr(s.read()), self.text[0:5])
self.assertEquals(bufstr(s.read()), self.text[5:10])
self.assertEquals(s.read(), None)
s = self.makeStream(0, 20)
self.assertEquals(s.length, 20)
self.assertEquals(bufstr(s.read()), self.text)
self.assertRaises(RuntimeError, s.read) # ran out of data
class MMapFileStreamTest(SimpleStreamTests, unittest.TestCase):
text = SimpleStreamTests.text
text = text * (stream.MMAP_THRESHOLD // len(text) + 1)
def makeStream(self, *args, **kw):
return stream.FileStream(self.f, *args, **kw)
def setUp(self):
"""
Create a file containing C{self.text}, which should be long enough to
trigger the mmap-case in L{stream.FileStream}.
"""
f = tempfile.TemporaryFile('w+')
f.write(self.text)
f.seek(0, 0)
self.f = f
def test_mmapwrapper(self):
self.assertRaises(TypeError, stream.mmapwrapper)
self.assertRaises(TypeError, stream.mmapwrapper, offset = 0)
self.assertRaises(TypeError, stream.mmapwrapper, offset = None)
if not stream.mmap:
test_mmapwrapper.skip = 'mmap not supported here'
class MemoryStreamTest(SimpleStreamTests, unittest.TestCase):
def makeStream(self, *args, **kw):
return stream.MemoryStream(self.text, *args, **kw)
def test_close(self):
s = self.makeStream()
s.close()
self.assertEquals(s.length, 0)
def test_read2(self):
self.assertRaises(ValueError, self.makeStream, 0, 20)
testdata = """I was angry with my friend:
I told my wrath, my wrath did end.
I was angry with my foe:
I told it not, my wrath did grow.
And I water'd it in fears,
Night and morning with my tears;
And I sunned it with smiles,
And with soft deceitful wiles.
And it grew both day and night,
Till it bore an apple bright;
And my foe beheld it shine,
And he knew that is was mine,
And into my garden stole
When the night had veil'd the pole:
In the morning glad I see
My foe outstretch'd beneath the tree"""
class TestBufferedStream(unittest.TestCase):
def setUp(self):
self.data = testdata.replace('\n', '\r\n')
s = stream.MemoryStream(self.data)
self.s = stream.BufferedStream(s)
def _cbGotData(self, data, expected):
self.assertEqual(data, expected)
def test_readline(self):
"""Test that readline reads a line."""
d = self.s.readline()
d.addCallback(self._cbGotData, 'I was angry with my friend:\r\n')
return d
def test_readlineWithSize(self):
"""Test the size argument to readline"""
d = self.s.readline(size = 5)
d.addCallback(self._cbGotData, 'I was')
return d
def test_readlineWithBigSize(self):
"""Test the size argument when it's bigger than the length of the line."""
d = self.s.readline(size = 40)
d.addCallback(self._cbGotData, 'I was angry with my friend:\r\n')
return d
def test_readlineWithZero(self):
"""Test readline with size = 0."""
d = self.s.readline(size = 0)
d.addCallback(self._cbGotData, '')
return d
def test_readlineFinished(self):
"""Test readline on a finished stream."""
nolines = len(self.data.split('\r\n'))
for i in range(nolines):
self.s.readline()
d = self.s.readline()
d.addCallback(self._cbGotData, '')
return d
def test_readlineNegSize(self):
"""Ensure that readline with a negative size raises an exception."""
self.assertRaises(ValueError, self.s.readline, size = -1)
def test_readlineSizeInDelimiter(self):
"""
Test behavior of readline when size falls inside the
delimiter.
"""
d = self.s.readline(size=28)
d.addCallback(self._cbGotData, "I was angry with my friend:\r")
d.addCallback(lambda _: self.s.readline())
d.addCallback(self._cbGotData, "\nI told my wrath, my wrath did end.\r\n")
def test_readExactly(self):
"""Make sure readExactly with no arg reads all the data."""
d = self.s.readExactly()
d.addCallback(self._cbGotData, self.data)
return d
def test_readExactlyLimited(self):
"""
Test readExactly with a number.
"""
d = self.s.readExactly(10)
d.addCallback(self._cbGotData, self.data[:10])
return d
def test_readExactlyBig(self):
"""
Test readExactly with a number larger than the size of the
datastream.
"""
d = self.s.readExactly(100000)
d.addCallback(self._cbGotData, self.data)
return d
def test_read(self):
"""
Make sure read() also functions. (note that this test uses
an implementation detail of this particular stream. s.read()
isn't guaranteed to return self.data on all streams.)
"""
self.assertEqual(str(self.s.read()), self.data)
class TestStreamer:
implements(stream.IStream, stream.IByteStream)
length = None
readCalled=0
closeCalled=0
def __init__(self, list):
self.list = list
def read(self):
self.readCalled+=1
if self.list:
return self.list.pop(0)
return None
def close(self):
self.closeCalled+=1
self.list = []
class FallbackSplitTest(unittest.TestCase):
def test_split(self):
s = TestStreamer(['abcd', defer.succeed('efgh'), 'ijkl'])
left,right = stream.fallbackSplit(s, 5)
self.assertEquals(left.length, 5)
self.assertEquals(right.length, None)
self.assertEquals(bufstr(left.read()), 'abcd')
d = left.read()
d.addCallback(self._cbSplit, left, right)
return d
def _cbSplit(self, result, left, right):
self.assertEquals(bufstr(result), 'e')
self.assertEquals(left.read(), None)
self.assertEquals(bufstr(right.read().result), 'fgh')
self.assertEquals(bufstr(right.read()), 'ijkl')
self.assertEquals(right.read(), None)
def test_split2(self):
s = TestStreamer(['abcd', defer.succeed('efgh'), 'ijkl'])
left,right = stream.fallbackSplit(s, 4)
self.assertEquals(left.length, 4)
self.assertEquals(right.length, None)
self.assertEquals(bufstr(left.read()), 'abcd')
self.assertEquals(left.read(), None)
self.assertEquals(bufstr(right.read().result), 'efgh')
self.assertEquals(bufstr(right.read()), 'ijkl')
self.assertEquals(right.read(), None)
def test_splitsplit(self):
s = TestStreamer(['abcd', defer.succeed('efgh'), 'ijkl'])
left,right = stream.fallbackSplit(s, 5)
left,middle = left.split(3)
self.assertEquals(left.length, 3)
self.assertEquals(middle.length, 2)
self.assertEquals(right.length, None)
self.assertEquals(bufstr(left.read()), 'abc')
self.assertEquals(left.read(), None)
self.assertEquals(bufstr(middle.read().result), 'd')
self.assertEquals(bufstr(middle.read().result), 'e')
self.assertEquals(middle.read(), None)
self.assertEquals(bufstr(right.read().result), 'fgh')
self.assertEquals(bufstr(right.read()), 'ijkl')
self.assertEquals(right.read(), None)
def test_closeboth(self):
s = TestStreamer(['abcd', defer.succeed('efgh'), 'ijkl'])
left,right = stream.fallbackSplit(s, 5)
left.close()
self.assertEquals(s.closeCalled, 0)
right.close()
# Make sure nothing got read
self.assertEquals(s.readCalled, 0)
self.assertEquals(s.closeCalled, 1)
def test_closeboth_rev(self):
s = TestStreamer(['abcd', defer.succeed('efgh'), 'ijkl'])
left,right = stream.fallbackSplit(s, 5)
right.close()
self.assertEquals(s.closeCalled, 0)
left.close()
# Make sure nothing got read
self.assertEquals(s.readCalled, 0)
self.assertEquals(s.closeCalled, 1)
def test_closeleft(self):
s = TestStreamer(['abcd', defer.succeed('efgh'), 'ijkl'])
left,right = stream.fallbackSplit(s, 5)
left.close()
d = right.read()
d.addCallback(self._cbCloseleft, right)
return d
def _cbCloseleft(self, result, right):
self.assertEquals(bufstr(result), 'fgh')
self.assertEquals(bufstr(right.read()), 'ijkl')
self.assertEquals(right.read(), None)
def test_closeright(self):
s = TestStreamer(['abcd', defer.succeed('efgh'), 'ijkl'])
left,right = stream.fallbackSplit(s, 3)
right.close()
self.assertEquals(bufstr(left.read()), 'abc')
self.assertEquals(left.read(), None)
self.assertEquals(s.closeCalled, 1)
class ProcessStreamerTest(unittest.TestCase):
if interfaces.IReactorProcess(reactor, None) is None:
skip = "Platform lacks spawnProcess support, can't test process streaming."
def runCode(self, code, inputStream=None):
if inputStream is None:
inputStream = stream.MemoryStream("")
return stream.ProcessStreamer(inputStream, sys.executable,
[sys.executable, "-u", "-c", code],
os.environ)
def test_output(self):
p = self.runCode("import sys\nfor i in range(100): sys.stdout.write('x' * 1000)")
l = []
d = stream.readStream(p.outStream, l.append)
def verify(_):
self.assertEquals("".join(l), ("x" * 1000) * 100)
d2 = p.run()
return d.addCallback(verify).addCallback(lambda _: d2)
def test_errouput(self):
p = self.runCode("import sys\nfor i in range(100): sys.stderr.write('x' * 1000)")
l = []
d = stream.readStream(p.errStream, l.append)
def verify(_):
self.assertEquals("".join(l), ("x" * 1000) * 100)
p.run()
return d.addCallback(verify)
def test_input(self):
p = self.runCode("import sys\nsys.stdout.write(sys.stdin.read())",
"hello world")
l = []
d = stream.readStream(p.outStream, l.append)
d2 = p.run()
def verify(_):
self.assertEquals("".join(l), "hello world")
return d2
return d.addCallback(verify)
def test_badexit(self):
p = self.runCode("raise ValueError")
l = []
from twisted.internet.error import ProcessTerminated
def verify(_):
self.assertEquals(l, [1])
self.assert_(p.outStream.closed)
self.assert_(p.errStream.closed)
return p.run().addErrback(lambda _: _.trap(ProcessTerminated) and l.append(1)).addCallback(verify)
def test_inputerror(self):
p = self.runCode("import sys\nsys.stdout.write(sys.stdin.read())",
TestStreamer(["hello", defer.fail(ZeroDivisionError())]))
l = []
d = stream.readStream(p.outStream, l.append)
d2 = p.run()
def verify(_):
self.assertEquals("".join(l), "hello")
return d2
def cbVerified(ignored):
excs = self.flushLoggedErrors(ZeroDivisionError)
self.assertEqual(len(excs), 1)
return d.addCallback(verify).addCallback(cbVerified)
def test_processclosedinput(self):
p = self.runCode("import sys; sys.stdout.write(sys.stdin.read(3));" +
"sys.stdin.close(); sys.stdout.write('def')",
"abc123")
l = []
d = stream.readStream(p.outStream, l.append)
def verify(_):
self.assertEquals("".join(l), "abcdef")
d2 = p.run()
return d.addCallback(verify).addCallback(lambda _: d2)
class AdapterTestCase(unittest.TestCase):
def test_adapt(self):
fName = self.mktemp()
f = file(fName, "w")
f.write("test")
f.close()
for i in ("test", buffer("test"), file(fName)):
s = stream.IByteStream(i)
self.assertEquals(str(s.read()), "test")
self.assertEquals(s.read(), None)
class ReadStreamTestCase(unittest.TestCase):
def test_pull(self):
l = []
s = TestStreamer(['abcd', defer.succeed('efgh'), 'ijkl'])
return stream.readStream(s, l.append).addCallback(
lambda _: self.assertEquals(l, ["abcd", "efgh", "ijkl"]))
def test_pullFailure(self):
l = []
s = TestStreamer(['abcd', defer.fail(RuntimeError()), 'ijkl'])
def test(result):
result.trap(RuntimeError)
self.assertEquals(l, ["abcd"])
return stream.readStream(s, l.append).addErrback(test)
def test_pullException(self):
class Failer:
def read(self): raise RuntimeError
return stream.readStream(Failer(), lambda _: None).addErrback(
lambda _: _.trap(RuntimeError))
def test_processingException(self):
s = TestStreamer(['abcd', defer.succeed('efgh'), 'ijkl'])
return stream.readStream(s, lambda x: 1/0).addErrback(
lambda _: _.trap(ZeroDivisionError))
class ProducerStreamTestCase(unittest.TestCase):
def test_failfinish(self):
p = stream.ProducerStream()
p.write("hello")
p.finish(RuntimeError())
self.assertEquals(p.read(), "hello")
d = p.read()
l = []
d.addErrback(lambda _: (l.append(1), _.trap(RuntimeError))).addCallback(
lambda _: self.assertEquals(l, [1]))
return d
class CompoundStreamTest:
"""
CompoundStream lets you combine many streams into one continuous stream.
For example, let's make a stream:
>>> s = stream.CompoundStream()
Then, add a couple streams:
>>> s.addStream(stream.MemoryStream("Stream1"))
>>> s.addStream(stream.MemoryStream("Stream2"))
The length is the sum of all the streams:
>>> s.length
14
We can read data from the stream:
>>> str(s.read())
'Stream1'
After having read some data, length is now smaller, as you might expect:
>>> s.length
7
So, continue reading...
>>> str(s.read())
'Stream2'
Now that the stream is exhausted:
>>> s.read() is None
True
>>> s.length
0
We can also create CompoundStream more easily like so:
>>> s = stream.CompoundStream(['hello', stream.MemoryStream(' world')])
>>> str(s.read())
'hello'
>>> str(s.read())
' world'
For a more complicated example, let's try reading from a file:
>>> s = stream.CompoundStream()
>>> s.addStream(stream.FileStream(open(sibpath(__file__, "stream_data.txt"))))
>>> s.addStream("================")
>>> s.addStream(stream.FileStream(open(sibpath(__file__, "stream_data.txt"))))
Again, the length is the sum:
>>> int(s.length)
58
>>> str(s.read())
"We've got some text!\\n"
>>> str(s.read())
'================'
What if you close the stream?
>>> s.close()
>>> s.read() is None
True
>>> s.length
0
Error handling works using Deferreds:
>>> m = stream.MemoryStream("after")
>>> s = stream.CompoundStream([TestStreamer([defer.fail(ZeroDivisionError())]), m]) # z<
>>> l = []; x = s.read().addErrback(lambda _: l.append(1))
>>> l
[1]
>>> s.length
0
>>> m.length # streams after the failed one got closed
0
"""
class AsynchronousDummyStream(object):
"""
An L{IByteStream} implementation which always returns a
L{defer.Deferred} from C{read} and lets an external driver fire
them.
"""
def __init__(self):
self._readResults = []
def read(self):
result = defer.Deferred()
self._readResults.append(result)
return result
def _write(self, bytes):
self._readResults.pop(0).callback(bytes)
class MD5StreamTest(unittest.TestCase):
"""
Tests for L{stream.MD5Stream}.
"""
data = "I am sorry Dave, I can't do that.\n--HAL 9000"
digest = md5(data).hexdigest()
def test_synchronous(self):
"""
L{stream.MD5Stream} computes the MD5 hash of the contents of the stream
around which it is wrapped. It supports L{IByteStream} providers which
return C{str} from their C{read} method.
"""
dataStream = stream.MemoryStream(self.data)
md5Stream = stream.MD5Stream(dataStream)
self.assertEquals(str(md5Stream.read()), self.data)
self.assertIdentical(md5Stream.read(), None)
md5Stream.close()
self.assertEquals(self.digest, md5Stream.getMD5())
def test_asynchronous(self):
"""
L{stream.MD5Stream} also supports L{IByteStream} providers which return
L{Deferreds} from their C{read} method.
"""
dataStream = AsynchronousDummyStream()
md5Stream = stream.MD5Stream(dataStream)
result = md5Stream.read()
dataStream._write(self.data)
result.addCallback(self.assertEquals, self.data)
def cbRead(ignored):
result = md5Stream.read()
dataStream._write(None)
result.addCallback(self.assertIdentical, None)
return result
result.addCallback(cbRead)
def cbClosed(ignored):
md5Stream.close()
self.assertEquals(md5Stream.getMD5(), self.digest)
result.addCallback(cbClosed)
return result
def test_getMD5FailsBeforeClose(self):
"""
L{stream.MD5Stream.getMD5} raises L{RuntimeError} if called before
L{stream.MD5Stream.close}.
"""
dataStream = stream.MemoryStream(self.data)
md5Stream = stream.MD5Stream(dataStream)
self.assertRaises(RuntimeError, md5Stream.getMD5)
def test_initializationFailsWithoutStream(self):
"""
L{stream.MD5Stream.__init__} raises L{ValueError} if passed C{None} as
the stream to wrap.
"""
self.assertRaises(ValueError, stream.MD5Stream, None)
def test_readAfterClose(self):
"""
L{stream.MD5Stream.read} raises L{RuntimeError} if called after
L{stream.MD5Stream.close}.
"""
dataStream = stream.MemoryStream(self.data)
md5Stream = stream.MD5Stream(dataStream)
md5Stream.close()
self.assertRaises(RuntimeError, md5Stream.read)
__doctests__ = ['twext.web2.test.test_stream', 'twext.web2.stream']
# TODO:
# CompoundStreamTest
# more tests for ProducerStreamTest
# StreamProducerTest
|