~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_http_response.py

  • Committer: John Arbash Meinel
  • Date: 2006-08-18 16:48:53 UTC
  • mto: (1946.2.6 reduce-knit-churn)
  • mto: This revision was merged to the branch mainline in revision 1948.
  • Revision ID: john@arbash-meinel.com-20060818164853-eb25e4db3385e216
Add a couple more sftp benchmarks

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2010, 2012, 2013, 2016 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 by Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
17
 
"""Tests from HTTP response parsing.
18
 
 
19
 
The handle_response method read the response body of a GET request an returns
20
 
the corresponding RangeFile.
21
 
 
22
 
There are four different kinds of RangeFile:
23
 
- a whole file whose size is unknown, seen as a simple byte stream,
24
 
- a whole file whose size is known, we can't read past its end,
25
 
- a single range file, a part of a file with a start and a size,
26
 
- a multiple range file, several consecutive parts with known start offset
27
 
  and size.
28
 
 
29
 
Some properties are common to all kinds:
30
 
- seek can only be forward (its really a socket underneath),
31
 
- read can't cross ranges,
32
 
- successive ranges are taken into account transparently,
33
 
 
34
 
- the expected pattern of use is either seek(offset)+read(size) or a single
35
 
  read with no size specified. For multiple range files, multiple read() will
36
 
  return the corresponding ranges, trying to read further will raise
37
 
  InvalidHttpResponse.
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
"""Tests from HTTP response parsing."""
 
18
 
 
19
from cStringIO import StringIO
 
20
import mimetools
 
21
 
 
22
from bzrlib import errors
 
23
from bzrlib.transport import http
 
24
from bzrlib.transport.http import response
 
25
from bzrlib.tests import TestCase
 
26
 
 
27
 
 
28
class TestResponseRange(TestCase):
 
29
    """Test the ResponseRange class."""
 
30
 
 
31
    def test_cmp(self):
 
32
        RR = response.ResponseRange
 
33
        r1 = RR(0, 10, 0)
 
34
        r2 = RR(15, 20, 10)
 
35
        self.assertTrue(r1 < r2)
 
36
        self.assertFalse(r1 > r2)
 
37
        self.assertTrue(r1 < 5)
 
38
        self.assertFalse(r2 < 5)
 
39
 
 
40
        self.assertEqual(RR(0, 10, 5), RR(0, 10, 5))
 
41
        self.assertNotEqual(RR(0, 10, 5), RR(0, 8, 5))
 
42
        self.assertNotEqual(RR(0, 10, 5), RR(0, 10, 6))
 
43
 
 
44
    def test_sort_list(self):
 
45
        """Ensure longer ranges are sorted after shorter ones"""
 
46
        RR = response.ResponseRange
 
47
        lst = [RR(3, 8, 0), 5, RR(3, 7, 0), 6]
 
48
        lst.sort()
 
49
        self.assertEqual([RR(3,7,0), RR(3,8,0), 5, 6], lst)
 
50
 
 
51
 
 
52
class TestRangeFile(TestCase):
 
53
    """Test RangeFile."""
 
54
 
 
55
    def setUp(self):
 
56
        content = "abcdefghijklmnopqrstuvwxyz"
 
57
        self.fp = response.RangeFile('foo', StringIO(content))
 
58
        self.fp._add_range(0,  9,   0)
 
59
        self.fp._add_range(20, 29, 10)
 
60
        self.fp._add_range(30, 39, 15)
 
61
 
 
62
    def test_valid_accesses(self):
 
63
        """Test so that valid accesses work to the file."""
 
64
        self.fp.seek(0, 0)
 
65
        self.assertEquals(self.fp.read(3), 'abc')
 
66
        self.assertEquals(self.fp.read(3), 'def')
 
67
        self.assertEquals(self.fp.tell(), 6)
 
68
        self.fp.seek(20, 0)
 
69
        self.assertEquals(self.fp.read(3), 'klm')
 
70
        self.assertEquals(self.fp.read(2), 'no')
 
71
        self.assertEquals(self.fp.tell(), 25)
 
72
        # should wrap over to 30-39 entity
 
73
        self.assertEquals(self.fp.read(3), 'pqr')
 
74
        self.fp.seek(3)
 
75
        self.assertEquals(self.fp.read(3), 'def')
 
76
        self.assertEquals(self.fp.tell(), 6)
 
77
 
 
78
    def test_invalid_accesses(self):
 
79
        """Test so that invalid accesses trigger errors."""
 
80
        self.fp.seek(9)
 
81
        self.assertRaises(errors.InvalidRange, self.fp.read, 2)
 
82
        self.fp.seek(39)
 
83
        self.assertRaises(errors.InvalidRange, self.fp.read, 2)
 
84
        self.fp.seek(19)
 
85
        self.assertRaises(errors.InvalidRange, self.fp.read, 2)
 
86
 
 
87
    def test__finish_ranges(self):
 
88
        """Test that after RangeFile._finish_ranges the list is sorted."""
 
89
        self.fp._add_range(1, 2, 3)
 
90
        self.fp._add_range(8, 9, 10)
 
91
        self.fp._add_range(3, 4, 5)
 
92
 
 
93
        # TODO: jam 20060706 If we switch to inserting
 
94
        #       in sorted order, remove this test
 
95
        self.assertNotEqual(self.fp._ranges, sorted(self.fp._ranges))
 
96
 
 
97
        self.fp._finish_ranges()
 
98
        self.assertEqual(self.fp._ranges, sorted(self.fp._ranges))
 
99
 
 
100
    def test_seek_and_tell(self):
 
101
        # Check for seeking before start
 
102
        self.fp.seek(-2, 0)
 
103
        self.assertEqual(0, self.fp.tell())
 
104
 
 
105
        self.fp.seek(5, 0)
 
106
        self.assertEqual(5, self.fp.tell())
 
107
 
 
108
        self.fp.seek(-2, 1)
 
109
        self.assertEqual(3, self.fp.tell())
 
110
 
 
111
        # TODO: jam 20060706 following tests will fail if this 
 
112
        #       is not true, and would be difficult to debug
 
113
        #       but it is a layering violation
 
114
        self.assertEqual(39, self.fp._len)
 
115
 
 
116
        self.fp.seek(0, 2)
 
117
        self.assertEqual(39, self.fp.tell())
 
118
 
 
119
        self.fp.seek(-10, 2)
 
120
        self.assertEqual(29, self.fp.tell())
 
121
 
 
122
        self.assertRaises(ValueError, self.fp.seek, 0, 4)
 
123
        self.assertRaises(ValueError, self.fp.seek, 0, -1)
 
124
 
 
125
 
 
126
class TestRegexes(TestCase):
 
127
 
 
128
    def assertRegexMatches(self, groups, text):
 
129
        """Check that the regex matches and returns the right values"""
 
130
        m = self.regex.match(text)
 
131
        self.assertNotEqual(None, m, "text %s did not match regex" % (text,))
 
132
 
 
133
        self.assertEqual(groups, m.groups())
 
134
 
 
135
    def test_range_re(self):
 
136
        """Test that we match valid ranges."""
 
137
        self.regex = response.HttpRangeResponse._CONTENT_RANGE_RE
 
138
        self.assertRegexMatches(('bytes', '1', '10', '11'),
 
139
                           'bytes 1-10/11')
 
140
        self.assertRegexMatches(('bytes', '1', '10', '11'),
 
141
                           '\tbytes  1-10/11   ')
 
142
        self.assertRegexMatches(('bytes', '2123', '4242', '1231'),
 
143
                           '\tbytes  2123-4242/1231   ')
 
144
        self.assertRegexMatches(('chars', '1', '2', '3'),
 
145
                           ' chars 1-2/3')
 
146
 
 
147
    def test_content_type_re(self):
 
148
        self.regex = response.HttpMultipartRangeResponse._CONTENT_TYPE_RE
 
149
        self.assertRegexMatches(('xxyyzz',),
 
150
                                'multipart/byteranges; boundary = xxyyzz')
 
151
        self.assertRegexMatches(('xxyyzz',),
 
152
                                'multipart/byteranges;boundary=xxyyzz')
 
153
        self.assertRegexMatches(('xx yy zz',),
 
154
                                ' multipart/byteranges ; boundary= xx yy zz ')
 
155
        self.assertEqual(None,
 
156
                self.regex.match('multipart byteranges;boundary=xx'))
 
157
 
 
158
 
 
159
simple_data = """
 
160
--xxyyzz\r
 
161
foo\r
 
162
Content-range: bytes 1-10/20\r
 
163
\r
 
164
1234567890
 
165
--xxyyzz\r
 
166
Content-Range: bytes 21-30/20\r
 
167
bar\r
 
168
\r
 
169
abcdefghij
 
170
--xxyyzz\r
 
171
content-range: bytes 41-50/20\r
 
172
\r
 
173
zyxwvutsrq
 
174
--xxyyzz\r
 
175
content-range: bytes 51-60/20\r
 
176
\r
 
177
xxyyzz fbd
38
178
"""
39
179
 
40
 
from cStringIO import StringIO
41
 
import httplib
42
 
 
43
 
from bzrlib import (
44
 
    errors,
45
 
    tests,
46
 
    )
47
 
from bzrlib.transport.http import (
48
 
    response,
49
 
    _urllib2_wrappers,
50
 
    )
51
 
from bzrlib.tests.file_utils import (
52
 
    FakeReadFile,
53
 
    )
54
 
 
55
 
 
56
 
class ReadSocket(object):
57
 
    """A socket-like object that can be given a predefined content."""
58
 
 
59
 
    def __init__(self, data):
60
 
        self.readfile = StringIO(data)
61
 
 
62
 
    def makefile(self, mode='r', bufsize=None):
63
 
        return self.readfile
64
 
 
65
 
 
66
 
class FakeHTTPConnection(_urllib2_wrappers.HTTPConnection):
67
 
 
68
 
    def __init__(self, sock):
69
 
        _urllib2_wrappers.HTTPConnection.__init__(self, 'localhost')
70
 
        # Set the socket to bypass the connection
71
 
        self.sock = sock
72
 
 
73
 
    def send(self, str):
74
 
        """Ignores the writes on the socket."""
75
 
        pass
76
 
 
77
 
 
78
 
class TestResponseFileIter(tests.TestCase):
79
 
 
80
 
    def test_iter_empty(self):
81
 
        f = response.ResponseFile('empty', StringIO())
82
 
        self.assertEqual([], list(f))
83
 
 
84
 
    def test_iter_many(self):
85
 
        f = response.ResponseFile('many', StringIO('0\n1\nboo!\n'))
86
 
        self.assertEqual(['0\n', '1\n', 'boo!\n'], list(f))
87
 
 
88
 
 
89
 
class TestHTTPConnection(tests.TestCase):
90
 
 
91
 
    def test_cleanup_pipe(self):
92
 
        sock = ReadSocket("""HTTP/1.1 200 OK\r
93
 
Content-Type: text/plain; charset=UTF-8\r
94
 
Content-Length: 18
95
 
\r
96
 
0123456789
97
 
garbage""")
98
 
        conn = FakeHTTPConnection(sock)
99
 
        # Simulate the request sending so that the connection will be able to
100
 
        # read the response.
101
 
        conn.putrequest('GET', 'http://localhost/fictious')
102
 
        conn.endheaders()
103
 
        # Now, get the response
104
 
        resp = conn.getresponse()
105
 
        # Read part of the response
106
 
        self.assertEqual('0123456789\n', resp.read(11))
107
 
        # Override the thresold to force the warning emission
108
 
        conn._range_warning_thresold = 6 # There are 7 bytes pending
109
 
        conn.cleanup_pipe()
110
 
        self.assertContainsRe(self.get_log(), 'Got a 200 response when asking')
111
 
 
112
 
 
113
 
class TestRangeFileMixin(object):
114
 
    """Tests for accessing the first range in a RangeFile."""
115
 
 
116
 
    # A simple string used to represent a file part (also called a range), in
117
 
    # which offsets are easy to calculate for test writers. It's used as a
118
 
    # building block with slight variations but basically 'a' is the first char
119
 
    # of the range and 'z' is the last.
120
 
    alpha = 'abcdefghijklmnopqrstuvwxyz'
121
 
 
122
 
    def test_can_read_at_first_access(self):
123
 
        """Test that the just created file can be read."""
124
 
        self.assertEqual(self.alpha, self._file.read())
125
 
 
126
 
    def test_seek_read(self):
127
 
        """Test seek/read inside the range."""
128
 
        f = self._file
129
 
        start = self.first_range_start
130
 
        # Before any use, tell() should be at the range start
131
 
        self.assertEqual(start, f.tell())
132
 
        cur = start # For an overall offset assertion
133
 
        f.seek(start + 3)
134
 
        cur += 3
135
 
        self.assertEqual('def', f.read(3))
136
 
        cur += len('def')
137
 
        f.seek(4, 1)
138
 
        cur += 4
139
 
        self.assertEqual('klmn', f.read(4))
140
 
        cur += len('klmn')
141
 
        # read(0) in the middle of a range
142
 
        self.assertEqual('', f.read(0))
143
 
        # seek in place
144
 
        here = f.tell()
145
 
        f.seek(0, 1)
146
 
        self.assertEqual(here, f.tell())
147
 
        self.assertEqual(cur, f.tell())
148
 
 
149
 
    def test_read_zero(self):
150
 
        f = self._file
151
 
        self.assertEqual('', f.read(0))
152
 
        f.seek(10, 1)
153
 
        self.assertEqual('', f.read(0))
154
 
 
155
 
    def test_seek_at_range_end(self):
156
 
        f = self._file
157
 
        f.seek(26, 1)
158
 
 
159
 
    def test_read_at_range_end(self):
160
 
        """Test read behaviour at range end."""
161
 
        f = self._file
162
 
        self.assertEqual(self.alpha, f.read())
163
 
        self.assertEqual('', f.read(0))
164
 
        self.assertRaises(errors.InvalidRange, f.read, 1)
165
 
 
166
 
    def test_unbounded_read_after_seek(self):
167
 
        f = self._file
168
 
        f.seek(24, 1)
169
 
        # Should not cross ranges
170
 
        self.assertEqual('yz', f.read())
171
 
 
172
 
    def test_seek_backwards(self):
173
 
        f = self._file
174
 
        start = self.first_range_start
175
 
        f.seek(start)
176
 
        f.read(12)
177
 
        self.assertRaises(errors.InvalidRange, f.seek, start + 5)
178
 
 
179
 
    def test_seek_outside_single_range(self):
180
 
        f = self._file
181
 
        if f._size == -1 or f._boundary is not None:
182
 
            raise tests.TestNotApplicable('Needs a fully defined range')
183
 
        # Will seek past the range and then errors out
184
 
        self.assertRaises(errors.InvalidRange,
185
 
                          f.seek, self.first_range_start + 27)
186
 
 
187
 
    def test_read_past_end_of_range(self):
188
 
        f = self._file
189
 
        if f._size == -1:
190
 
            raise tests.TestNotApplicable("Can't check an unknown size")
191
 
        start = self.first_range_start
192
 
        f.seek(start + 20)
193
 
        self.assertRaises(errors.InvalidRange, f.read, 10)
194
 
 
195
 
    def test_seek_from_end(self):
196
 
       """Test seeking from the end of the file.
197
 
 
198
 
       The semantic is unclear in case of multiple ranges. Seeking from end
199
 
       exists only for the http transports, cannot be used if the file size is
200
 
       unknown and is not used in bzrlib itself. This test must be (and is)
201
 
       overridden by daughter classes.
202
 
 
203
 
       Reading from end makes sense only when a range has been requested from
204
 
       the end of the file (see HttpTransportBase._get() when using the
205
 
       'tail_amount' parameter). The HTTP response can only be a whole file or
206
 
       a single range.
207
 
       """
208
 
       f = self._file
209
 
       f.seek(-2, 2)
210
 
       self.assertEqual('yz', f.read())
211
 
 
212
 
 
213
 
class TestRangeFileSizeUnknown(tests.TestCase, TestRangeFileMixin):
214
 
    """Test a RangeFile for a whole file whose size is not known."""
215
 
 
216
 
    def setUp(self):
217
 
        super(TestRangeFileSizeUnknown, self).setUp()
218
 
        self._file = response.RangeFile('Whole_file_size_known',
219
 
                                        StringIO(self.alpha))
220
 
        # We define no range, relying on RangeFile to provide default values
221
 
        self.first_range_start = 0 # It's the whole file
222
 
 
223
 
    def test_seek_from_end(self):
224
 
        """See TestRangeFileMixin.test_seek_from_end.
225
 
 
226
 
        The end of the file can't be determined since the size is unknown.
227
 
        """
228
 
        self.assertRaises(errors.InvalidRange, self._file.seek, -1, 2)
229
 
 
230
 
    def test_read_at_range_end(self):
231
 
        """Test read behaviour at range end."""
232
 
        f = self._file
233
 
        self.assertEqual(self.alpha, f.read())
234
 
        self.assertEqual('', f.read(0))
235
 
        self.assertEqual('', f.read(1))
236
 
 
237
 
 
238
 
class TestRangeFileSizeKnown(tests.TestCase, TestRangeFileMixin):
239
 
    """Test a RangeFile for a whole file whose size is known."""
240
 
 
241
 
    def setUp(self):
242
 
        super(TestRangeFileSizeKnown, self).setUp()
243
 
        self._file = response.RangeFile('Whole_file_size_known',
244
 
                                        StringIO(self.alpha))
245
 
        self._file.set_range(0, len(self.alpha))
246
 
        self.first_range_start = 0 # It's the whole file
247
 
 
248
 
 
249
 
class TestRangeFileSingleRange(tests.TestCase, TestRangeFileMixin):
250
 
    """Test a RangeFile for a single range."""
251
 
 
252
 
    def setUp(self):
253
 
        super(TestRangeFileSingleRange, self).setUp()
254
 
        self._file = response.RangeFile('Single_range_file',
255
 
                                        StringIO(self.alpha))
256
 
        self.first_range_start = 15
257
 
        self._file.set_range(self.first_range_start, len(self.alpha))
258
 
 
259
 
 
260
 
    def test_read_before_range(self):
261
 
        # This can't occur under normal circumstances, we have to force it
262
 
        f = self._file
263
 
        f._pos = 0 # Force an invalid pos
 
180
 
 
181
class TestHelpers(TestCase):
 
182
    """Test the helper functions"""
 
183
 
 
184
    def test__parse_range(self):
 
185
        """Test that _parse_range acts reasonably."""
 
186
        content = StringIO('')
 
187
        parse_range = response.HttpRangeResponse._parse_range
 
188
        self.assertEqual((1,2), parse_range('bytes 1-2/3'))
 
189
        self.assertEqual((10,20), parse_range('bytes 10-20/2'))
 
190
 
 
191
        self.assertRaises(errors.InvalidHttpRange, parse_range, 'char 1-3/2')
 
192
        self.assertRaises(errors.InvalidHttpRange, parse_range, 'bytes a-3/2')
 
193
 
 
194
        try:
 
195
            parse_range('bytes x-10/3', path='http://foo/bar')
 
196
        except errors.InvalidHttpRange, e:
 
197
            self.assertContainsRe(str(e), 'http://foo/bar')
 
198
            self.assertContainsRe(str(e), 'bytes x-10/3')
 
199
        else:
 
200
            self.fail('Did not raise InvalidHttpRange')
 
201
 
 
202
    def test__parse_boundary_simple(self):
 
203
        """Test that _parse_boundary handles Content-type properly"""
 
204
        parse_boundary = response.HttpMultipartRangeResponse._parse_boundary
 
205
        m = parse_boundary(' multipart/byteranges; boundary=xxyyzz')
 
206
        self.assertNotEqual(None, m)
 
207
        # Check that the returned regex is capable of splitting simple_data
 
208
        matches = list(m.finditer(simple_data))
 
209
        self.assertEqual(4, len(matches))
 
210
 
 
211
        # match.group() should be the content-range entry
 
212
        # and match.end() should be the start of the content
 
213
        self.assertEqual(' bytes 1-10/20', matches[0].group(1))
 
214
        self.assertEqual(simple_data.find('1234567890'), matches[0].end())
 
215
        self.assertEqual(' bytes 21-30/20', matches[1].group(1))
 
216
        self.assertEqual(simple_data.find('abcdefghij'), matches[1].end())
 
217
        self.assertEqual(' bytes 41-50/20', matches[2].group(1))
 
218
        self.assertEqual(simple_data.find('zyxwvutsrq'), matches[2].end())
 
219
        self.assertEqual(' bytes 51-60/20', matches[3].group(1))
 
220
        self.assertEqual(simple_data.find('xxyyzz fbd'), matches[3].end())
 
221
 
 
222
    def test__parse_boundary_invalid(self):
 
223
        parse_boundary = response.HttpMultipartRangeResponse._parse_boundary
 
224
        try:
 
225
            parse_boundary(' multipart/bytes;boundary=xxyyzz',
 
226
                           path='http://foo/bar')
 
227
        except errors.InvalidHttpContentType, e:
 
228
            self.assertContainsRe(str(e), 'http://foo/bar')
 
229
            self.assertContainsRe(str(e), 'multipart/bytes;boundary=xxyyzz')
 
230
        else:
 
231
            self.fail('Did not raise InvalidHttpContentType')
 
232
 
 
233
 
 
234
class TestHttpRangeResponse(TestCase):
 
235
 
 
236
    def test_smoketest(self):
 
237
        """A basic test that HttpRangeResponse is reasonable."""
 
238
        content = StringIO('0123456789')
 
239
        f = response.HttpRangeResponse('http://foo', 'bytes 1-10/9', content)
 
240
        self.assertEqual([response.ResponseRange(1,10,0)], f._ranges)
 
241
 
 
242
        f.seek(0)
264
243
        self.assertRaises(errors.InvalidRange, f.read, 2)
265
 
 
266
 
 
267
 
class TestRangeFileMultipleRanges(tests.TestCase, TestRangeFileMixin):
268
 
    """Test a RangeFile for multiple ranges.
269
 
 
270
 
    The RangeFile used for the tests contains three ranges:
271
 
 
272
 
    - at offset 25: alpha
273
 
    - at offset 100: alpha
274
 
    - at offset 126: alpha.upper()
275
 
 
276
 
    The two last ranges are contiguous. This only rarely occurs (should not in
277
 
    fact) in real uses but may lead to hard to track bugs.
278
 
    """
279
 
 
280
 
    # The following is used to represent the boundary paramter defined
281
 
    # in HTTP response headers and the boundary lines that separate
282
 
    # multipart content.
283
 
 
284
 
    boundary = "separation"
285
 
 
286
 
    def setUp(self):
287
 
        super(TestRangeFileMultipleRanges, self).setUp()
288
 
 
289
 
        boundary = self.boundary
290
 
 
291
 
        content = ''
292
 
        self.first_range_start = 25
293
 
        file_size = 200 # big enough to encompass all ranges
294
 
        for (start, part) in [(self.first_range_start, self.alpha),
295
 
                              # Two contiguous ranges
296
 
                              (100, self.alpha),
297
 
                              (126, self.alpha.upper())]:
298
 
            content += self._multipart_byterange(part, start, boundary,
299
 
                                                 file_size)
300
 
        # Final boundary
301
 
        content += self._boundary_line()
302
 
 
303
 
        self._file = response.RangeFile('Multiple_ranges_file',
304
 
                                        StringIO(content))
305
 
        self.set_file_boundary()
306
 
 
307
 
    def _boundary_line(self):
308
 
        """Helper to build the formatted boundary line."""
309
 
        return '--' + self.boundary + '\r\n'
310
 
 
311
 
    def set_file_boundary(self):
312
 
        # Ranges are set by decoding the range headers, the RangeFile user is
313
 
        # supposed to call the following before using seek or read since it
314
 
        # requires knowing the *response* headers (in that case the boundary
315
 
        # which is part of the Content-Type header).
316
 
        self._file.set_boundary(self.boundary)
317
 
 
318
 
    def _multipart_byterange(self, data, offset, boundary, file_size='*'):
319
 
        """Encode a part of a file as a multipart/byterange MIME type.
320
 
 
321
 
        When a range request is issued, the HTTP response body can be
322
 
        decomposed in parts, each one representing a range (start, size) in a
323
 
        file.
324
 
 
325
 
        :param data: The payload.
326
 
        :param offset: where data starts in the file
327
 
        :param boundary: used to separate the parts
328
 
        :param file_size: the size of the file containing the range (default to
329
 
            '*' meaning unknown)
330
 
 
331
 
        :return: a string containing the data encoded as it will appear in the
332
 
            HTTP response body.
333
 
        """
334
 
        bline = self._boundary_line()
335
 
        # Each range begins with a boundary line
336
 
        range = bline
337
 
        # A range is described by a set of headers, but only 'Content-Range' is
338
 
        # required for our implementation (TestHandleResponse below will
339
 
        # exercise ranges with multiple or missing headers')
340
 
        range += 'Content-Range: bytes %d-%d/%d\r\n' % (offset,
341
 
                                                        offset+len(data)-1,
342
 
                                                        file_size)
343
 
        range += '\r\n'
344
 
        # Finally the raw bytes
345
 
        range += data
346
 
        return range
347
 
 
348
 
    def test_read_all_ranges(self):
349
 
        f = self._file
350
 
        self.assertEqual(self.alpha, f.read()) # Read first range
351
 
        f.seek(100) # Trigger the second range recognition
352
 
        self.assertEqual(self.alpha, f.read()) # Read second range
353
 
        self.assertEqual(126, f.tell())
354
 
        f.seek(126) # Start of third range which is also the current pos !
355
 
        self.assertEqual('A', f.read(1))
356
 
        f.seek(10, 1)
357
 
        self.assertEqual('LMN', f.read(3))
358
 
 
359
 
    def test_seek_from_end(self):
360
 
        """See TestRangeFileMixin.test_seek_from_end."""
361
 
        # The actual implementation will seek from end for the first range only
362
 
        # and then fail. Since seeking from end is intended to be used for a
363
 
        # single range only anyway, this test just document the actual
364
 
        # behaviour.
365
 
        f = self._file
366
 
        f.seek(-2, 2)
367
 
        self.assertEqual('yz', f.read())
368
 
        self.assertRaises(errors.InvalidRange, f.seek, -2, 2)
369
 
 
370
 
    def test_seek_into_void(self):
371
 
        f = self._file
372
 
        start = self.first_range_start
373
 
        f.seek(start)
374
 
        # Seeking to a point between two ranges is possible (only once) but
375
 
        # reading there is forbidden
376
 
        f.seek(start + 40)
377
 
        # We crossed a range boundary, so now the file is positioned at the
378
 
        # start of the new range (i.e. trying to seek below 100 will error out)
379
 
        f.seek(100)
380
 
        f.seek(125)
381
 
 
382
 
    def test_seek_across_ranges(self):
383
 
        f = self._file
384
 
        f.seek(126) # skip the two first ranges
385
 
        self.assertEqual('AB', f.read(2))
386
 
 
387
 
    def test_checked_read_dont_overflow_buffers(self):
388
 
        f = self._file
389
 
        # We force a very low value to exercise all code paths in _checked_read
390
 
        f._discarded_buf_size = 8
391
 
        f.seek(126) # skip the two first ranges
392
 
        self.assertEqual('AB', f.read(2))
393
 
 
394
 
    def test_seek_twice_between_ranges(self):
395
 
        f = self._file
396
 
        start = self.first_range_start
397
 
        f.seek(start + 40) # Past the first range but before the second
398
 
        # Now the file is positioned at the second range start (100)
399
 
        self.assertRaises(errors.InvalidRange, f.seek, start + 41)
400
 
 
401
 
    def test_seek_at_range_end(self):
402
 
        """Test seek behavior at range end."""
403
 
        f = self._file
404
 
        f.seek(25 + 25)
405
 
        f.seek(100 + 25)
406
 
        f.seek(126 + 25)
407
 
 
408
 
    def test_read_at_range_end(self):
409
 
        f = self._file
410
 
        self.assertEqual(self.alpha, f.read())
411
 
        self.assertEqual(self.alpha, f.read())
412
 
        self.assertEqual(self.alpha.upper(), f.read())
413
 
        self.assertRaises(errors.InvalidHttpResponse, f.read, 1)
414
 
 
415
 
 
416
 
class TestRangeFileMultipleRangesQuotedBoundaries(TestRangeFileMultipleRanges):
417
 
    """Perform the same tests as TestRangeFileMultipleRanges, but uses
418
 
    an angle-bracket quoted boundary string like IIS 6.0 and 7.0
419
 
    (but not IIS 5, which breaks the RFC in a different way
420
 
    by using square brackets, not angle brackets)
421
 
 
422
 
    This reveals a bug caused by
423
 
 
424
 
    - The bad implementation of RFC 822 unquoting in Python (angles are not
425
 
      quotes), coupled with
426
 
 
427
 
    - The bad implementation of RFC 2046 in IIS (angles are not permitted chars
428
 
      in boundary lines).
429
 
 
430
 
    """
431
 
    # The boundary as it appears in boundary lines
432
 
    # IIS 6 and 7 use this value
433
 
    _boundary_trimmed = "q1w2e3r4t5y6u7i8o9p0zaxscdvfbgnhmjklkl"
434
 
    boundary = '<' + _boundary_trimmed + '>'
435
 
 
436
 
    def set_file_boundary(self):
437
 
        # Emulate broken rfc822.unquote() here by removing angles
438
 
        self._file.set_boundary(self._boundary_trimmed)
439
 
 
440
 
 
441
 
class TestRangeFileVarious(tests.TestCase):
442
 
    """Tests RangeFile aspects not covered elsewhere."""
443
 
 
444
 
    def test_seek_whence(self):
445
 
        """Test the seek whence parameter values."""
446
 
        f = response.RangeFile('foo', StringIO('abc'))
447
 
        f.set_range(0, 3)
448
 
        f.seek(0)
449
 
        f.seek(1, 1)
450
 
        f.seek(-1, 2)
451
 
        self.assertRaises(ValueError, f.seek, 0, 14)
452
 
 
453
 
    def test_range_syntax(self):
454
 
        """Test the Content-Range scanning."""
455
 
 
456
 
        f = response.RangeFile('foo', StringIO())
457
 
 
458
 
        def ok(expected, header_value):
459
 
            f.set_range_from_header(header_value)
460
 
            # Slightly peek under the covers to get the size
461
 
            self.assertEqual(expected, (f.tell(), f._size))
462
 
 
463
 
        ok((1, 10), 'bytes 1-10/11')
464
 
        ok((1, 10), 'bytes 1-10/*')
465
 
        ok((12, 2), '\tbytes 12-13/*')
466
 
        ok((28, 1), '  bytes 28-28/*')
467
 
        ok((2123, 2120), 'bytes  2123-4242/12310')
468
 
        ok((1, 10), 'bytes 1-10/ttt') # We don't check total (ttt)
469
 
 
470
 
        def nok(header_value):
471
 
            self.assertRaises(errors.InvalidHttpRange,
472
 
                              f.set_range_from_header, header_value)
473
 
 
474
 
        nok('bytes 10-2/3')
475
 
        nok('chars 1-2/3')
476
 
        nok('bytes xx-yyy/zzz')
477
 
        nok('bytes xx-12/zzz')
478
 
        nok('bytes 11-yy/zzz')
479
 
        nok('bytes10-2/3')
 
244
        f.seek(1)
 
245
        self.assertEqual('012345', f.read(6))
 
246
 
 
247
    def test_invalid(self):
 
248
        try:
 
249
            f = response.HttpRangeResponse('http://foo', 'bytes x-10/9',
 
250
                                           StringIO('0123456789'))
 
251
        except errors.InvalidHttpRange, e:
 
252
            self.assertContainsRe(str(e), 'http://foo')
 
253
            self.assertContainsRe(str(e), 'bytes x-10/9')
 
254
        else:
 
255
            self.fail('Failed to raise InvalidHttpRange')
 
256
 
 
257
 
 
258
class TestHttpMultipartRangeResponse(TestCase):
 
259
    """Test the handling of multipart range responses"""
 
260
 
 
261
    def test_simple(self):
 
262
        content = StringIO(simple_data)
 
263
        multi = response.HttpMultipartRangeResponse('http://foo',
 
264
                    'multipart/byteranges; boundary = xxyyzz', content)
 
265
 
 
266
        self.assertEqual(4, len(multi._ranges))
 
267
 
 
268
        multi.seek(1)
 
269
        self.assertEqual('1234567890', multi.read(10))
 
270
        multi.seek(21)
 
271
        self.assertEqual('abcdefghij', multi.read(10))
 
272
        multi.seek(41)
 
273
        self.assertEqual('zyxwvutsrq', multi.read(10))
 
274
        multi.seek(51)
 
275
        self.assertEqual('xxyyzz fbd', multi.read(10))
 
276
        # TODO: jam 20060706 Currently RangeFile does not support
 
277
        #       reading across ranges. Consider adding it.
 
278
        multi.seek(41)
 
279
        # self.assertEqual('zyxwvutsrqxxyyzz fbd', multi.read(20))
 
280
        self.assertRaises(errors.InvalidRange, multi.read, 20)
 
281
 
 
282
        multi.seek(21)
 
283
        self.assertRaises(errors.InvalidRange, multi.read, 11)
 
284
        multi.seek(31)
 
285
        self.assertRaises(errors.InvalidRange, multi.read, 10)
 
286
 
 
287
    def test_invalid(self):
 
288
        content = StringIO('')
 
289
        try:
 
290
            response.HttpMultipartRangeResponse('http://foo',
 
291
                        'multipart/byte;boundary=invalid', content)
 
292
        except errors.InvalidHttpContentType, e:
 
293
            self.assertContainsRe(str(e), 'http://foo')
 
294
            self.assertContainsRe(str(e), 'multipart/byte;')
480
295
 
481
296
 
482
297
# Taken from real request responses
494
309
""")
495
310
 
496
311
 
 
312
_missing_response = (404, """HTTP/1.1 404 Not Found\r
 
313
Date: Tue, 11 Jul 2006 04:32:56 GMT\r
 
314
Server: Apache/2.0.54 (Fedora)\r
 
315
Content-Length: 336\r
 
316
Connection: close\r
 
317
Content-Type: text/html; charset=iso-8859-1\r
 
318
\r
 
319
""", """<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
 
320
<html><head>
 
321
<title>404 Not Found</title>
 
322
</head><body>
 
323
<h1>Not Found</h1>
 
324
<p>The requested URL /branches/bzr/jam-integration/.bzr/repository/format was not found on this server.</p>
 
325
<hr>
 
326
<address>Apache/2.0.54 (Fedora) Server at bzr.arbash-meinel.com Port 80</address>
 
327
</body></html>
 
328
""")
 
329
 
 
330
 
497
331
_single_range_response = (206, """HTTP/1.1 206 Partial Content\r
498
332
Date: Tue, 11 Jul 2006 04:45:22 GMT\r
499
333
Server: Apache/2.0.54 (Fedora)\r
509
343
mbp@sourcefrog.net-20050309040929-eee0eb3e6d1e762""")
510
344
 
511
345
 
512
 
_single_range_no_content_type = (206, """HTTP/1.1 206 Partial Content\r
513
 
Date: Tue, 11 Jul 2006 04:45:22 GMT\r
514
 
Server: Apache/2.0.54 (Fedora)\r
515
 
Last-Modified: Thu, 06 Jul 2006 20:22:05 GMT\r
516
 
ETag: "238a3c-16ec2-805c5540"\r
517
 
Accept-Ranges: bytes\r
518
 
Content-Length: 100\r
519
 
Content-Range: bytes 100-199/93890\r
520
 
Connection: close\r
521
 
\r
522
 
""", """mbp@sourcefrog.net-20050309040815-13242001617e4a06
523
 
mbp@sourcefrog.net-20050309040929-eee0eb3e6d1e762""")
524
 
 
525
 
 
526
346
_multipart_range_response = (206, """HTTP/1.1 206 Partial Content\r
527
347
Date: Tue, 11 Jul 2006 04:49:48 GMT\r
528
348
Server: Apache/2.0.54 (Fedora)\r
569
389
mbp@sourcefrog.net-20050314025737-55eb441f430ab4ba
570
390
mbp@sourcefrog.net-20050314025901-d74aa93bb7ee8f62
571
391
mbp@source\r
572
 
--418470f848b63279b--\r
 
392
--418470f848b63279b--\r\n'
573
393
""")
574
394
 
575
395
 
576
 
_multipart_squid_range_response = (206, """HTTP/1.0 206 Partial Content\r
577
 
Date: Thu, 31 Aug 2006 21:16:22 GMT\r
578
 
Server: Apache/2.2.2 (Unix) DAV/2\r
579
 
Last-Modified: Thu, 31 Aug 2006 17:57:06 GMT\r
 
396
_redirect_response = (206, """HTTP/1.1 301 Moved Permanently\r
 
397
Date: Tue, 18 Jul 2006 20:29:22 GMT\r
 
398
Server: Apache/2.0.54 (Ubuntu) PHP/4.4.0-3ubuntu1 mod_ssl/2.0.54 OpenSSL/0.9.7g\r
 
399
Location: http://bazaar-vcs.org/bzr/bzr.dev/.bzr/repository/inventory.knit\r
 
400
Content-Length: 272\r
 
401
Keep-Alive: timeout=15, max=100\r
 
402
Connection: Keep-Alive\r
 
403
Content-Type: text/html; charset=iso-8859-1\r
 
404
\r
 
405
HTTP/1.1 206 Partial Content\r
 
406
Date: Tue, 18 Jul 2006 20:29:23 GMT\r
 
407
Server: Apache/2.0.54 (Ubuntu) PHP/4.4.0-3ubuntu1 mod_ssl/2.0.54 OpenSSL/0.9.7g\r
 
408
Last-Modified: Tue, 18 Jul 2006 20:24:59 GMT\r
 
409
ETag: "be8213-83958c-f0d3dcc0"\r
580
410
Accept-Ranges: bytes\r
581
 
Content-Type: multipart/byteranges; boundary="squid/2.5.STABLE12:C99323425AD4FE26F726261FA6C24196"\r
582
 
Content-Length: 598\r
583
 
X-Cache: MISS from localhost.localdomain\r
584
 
X-Cache-Lookup: HIT from localhost.localdomain:3128\r
585
 
Proxy-Connection: keep-alive\r
586
 
\r
587
 
""",
588
 
"""\r
589
 
--squid/2.5.STABLE12:C99323425AD4FE26F726261FA6C24196\r
590
 
Content-Type: text/plain\r
591
 
Content-Range: bytes 0-99/18672\r
592
 
\r
593
 
# bzr knit index 8
594
 
 
595
 
scott@netsplit.com-20050708230047-47c7868f276b939f fulltext 0 863  :
596
 
scott@netsp\r
597
 
--squid/2.5.STABLE12:C99323425AD4FE26F726261FA6C24196\r
598
 
Content-Type: text/plain\r
599
 
Content-Range: bytes 300-499/18672\r
600
 
\r
601
 
com-20050708231537-2b124b835395399a :
602
 
scott@netsplit.com-20050820234126-551311dbb7435b51 line-delta 1803 479 .scott@netsplit.com-20050820232911-dc4322a084eadf7e :
603
 
scott@netsplit.com-20050821213706-c86\r
604
 
--squid/2.5.STABLE12:C99323425AD4FE26F726261FA6C24196--\r
 
411
Content-Length: 425\r
 
412
Content-Range: bytes 8623075-8623499/8623500\r
 
413
Keep-Alive: timeout=15, max=100\r
 
414
Connection: Keep-Alive\r
 
415
Content-Type: text/plain; charset=UTF-8\r
 
416
\r
 
417
""", """this data intentionally removed, 
 
418
this is not meant to be tested by
 
419
handle_response, just _extract_headers
605
420
""")
606
421
 
607
422
 
608
423
# This is made up
609
 
_full_text_response_no_content_type = (200, """HTTP/1.1 200 OK\r
610
 
Date: Tue, 11 Jul 2006 04:32:56 GMT\r
611
 
Server: Apache/2.0.54 (Fedora)\r
612
 
Last-Modified: Sun, 23 Apr 2006 19:35:20 GMT\r
613
 
ETag: "56691-23-38e9ae00"\r
614
 
Accept-Ranges: bytes\r
615
 
Content-Length: 35\r
616
 
Connection: close\r
617
 
\r
618
 
""", """Bazaar-NG meta directory, format 1
619
 
""")
620
 
 
621
 
 
622
 
_full_text_response_no_content_length = (200, """HTTP/1.1 200 OK\r
623
 
Date: Tue, 11 Jul 2006 04:32:56 GMT\r
624
 
Server: Apache/2.0.54 (Fedora)\r
625
 
Last-Modified: Sun, 23 Apr 2006 19:35:20 GMT\r
626
 
ETag: "56691-23-38e9ae00"\r
627
 
Accept-Ranges: bytes\r
628
 
Connection: close\r
629
 
Content-Type: text/plain; charset=UTF-8\r
630
 
\r
631
 
""", """Bazaar-NG meta directory, format 1
632
 
""")
633
 
 
634
 
 
635
 
_single_range_no_content_range = (206, """HTTP/1.1 206 Partial Content\r
636
 
Date: Tue, 11 Jul 2006 04:45:22 GMT\r
637
 
Server: Apache/2.0.54 (Fedora)\r
638
 
Last-Modified: Thu, 06 Jul 2006 20:22:05 GMT\r
639
 
ETag: "238a3c-16ec2-805c5540"\r
640
 
Accept-Ranges: bytes\r
641
 
Content-Length: 100\r
642
 
Connection: close\r
643
 
\r
644
 
""", """mbp@sourcefrog.net-20050309040815-13242001617e4a06
645
 
mbp@sourcefrog.net-20050309040929-eee0eb3e6d1e762""")
646
 
 
647
 
 
648
 
_single_range_response_truncated = (206, """HTTP/1.1 206 Partial Content\r
649
 
Date: Tue, 11 Jul 2006 04:45:22 GMT\r
650
 
Server: Apache/2.0.54 (Fedora)\r
651
 
Last-Modified: Thu, 06 Jul 2006 20:22:05 GMT\r
652
 
ETag: "238a3c-16ec2-805c5540"\r
653
 
Accept-Ranges: bytes\r
654
 
Content-Length: 100\r
655
 
Content-Range: bytes 100-199/93890\r
656
 
Connection: close\r
657
 
Content-Type: text/plain; charset=UTF-8\r
658
 
\r
659
 
""", """mbp@sourcefrog.net-20050309040815-13242001617e4a06""")
660
 
 
661
 
 
662
424
_invalid_response = (444, """HTTP/1.1 444 Bad Response\r
663
425
Date: Tue, 11 Jul 2006 04:32:56 GMT\r
664
426
Connection: close\r
675
437
""")
676
438
 
677
439
 
678
 
_multipart_no_content_range = (206, """HTTP/1.0 206 Partial Content\r
679
 
Content-Type: multipart/byteranges; boundary=THIS_SEPARATES\r
680
 
Content-Length: 598\r
681
 
\r
682
 
""",
683
 
"""\r
684
 
--THIS_SEPARATES\r
685
 
Content-Type: text/plain\r
686
 
\r
687
 
# bzr knit index 8
688
 
--THIS_SEPARATES\r
689
 
""")
690
 
 
691
 
 
692
 
_multipart_no_boundary = (206, """HTTP/1.0 206 Partial Content\r
693
 
Content-Type: multipart/byteranges; boundary=THIS_SEPARATES\r
694
 
Content-Length: 598\r
695
 
\r
696
 
""",
697
 
"""\r
698
 
--THIS_SEPARATES\r
699
 
Content-Type: text/plain\r
700
 
Content-Range: bytes 0-18/18672\r
701
 
\r
702
 
# bzr knit index 8
703
 
 
704
 
The range ended at the line above, this text is garbage instead of a boundary
705
 
line
706
 
""")
707
 
 
708
 
 
709
 
class TestHandleResponse(tests.TestCase):
710
 
 
711
 
    def _build_HTTPMessage(self, raw_headers):
712
 
        status_and_headers = StringIO(raw_headers)
713
 
        # Get rid of the status line
714
 
        status_and_headers.readline()
715
 
        msg = httplib.HTTPMessage(status_and_headers)
716
 
        return msg
717
 
 
 
440
# This should be in test_http.py, but the headers we
 
441
# want to parse are here
 
442
class TestExtractHeader(TestCase):
 
443
    
 
444
    def use_response(self, response):
 
445
        self.headers = http._extract_headers(response[1], 'http://foo')
 
446
 
 
447
    def check_header(self, header, value):
 
448
        self.assertEqual(value, self.headers[header])
 
449
        
 
450
    def test_full_text(self):
 
451
        self.use_response(_full_text_response)
 
452
 
 
453
        self.check_header('Date', 'Tue, 11 Jul 2006 04:32:56 GMT')
 
454
        self.check_header('date', 'Tue, 11 Jul 2006 04:32:56 GMT')
 
455
        self.check_header('Content-Length', '35')
 
456
        self.check_header('Content-Type', 'text/plain; charset=UTF-8')
 
457
        self.check_header('content-type', 'text/plain; charset=UTF-8')
 
458
 
 
459
    def test_missing_response(self):
 
460
        self.use_response(_missing_response)
 
461
 
 
462
        self.check_header('Content-Length', '336')
 
463
        self.check_header('Content-Type', 'text/html; charset=iso-8859-1')
 
464
 
 
465
    def test_single_range(self):
 
466
        self.use_response(_single_range_response)
 
467
 
 
468
        self.check_header('Content-Length', '100')
 
469
        self.check_header('Content-Range', 'bytes 100-199/93890')
 
470
        self.check_header('Content-Type', 'text/plain; charset=UTF-8')
 
471
 
 
472
    def test_multi_range(self):
 
473
        self.use_response(_multipart_range_response)
 
474
 
 
475
        self.check_header('Content-Length', '1534')
 
476
        self.check_header('Content-Type',
 
477
                          'multipart/byteranges; boundary=418470f848b63279b')
 
478
 
 
479
    def test_redirect(self):
 
480
        """We default to returning the last group of headers in the file."""
 
481
        self.use_response(_redirect_response)
 
482
        self.check_header('Content-Range', 'bytes 8623075-8623499/8623500')
 
483
        self.check_header('Content-Type', 'text/plain; charset=UTF-8')
 
484
 
 
485
    def test_empty(self):
 
486
        self.assertRaises(errors.InvalidHttpResponse,
 
487
            http._extract_headers, '', 'bad url')
 
488
 
 
489
    def test_no_opening_http(self):
 
490
        # Remove the HTTP line from the header
 
491
        first, txt = _full_text_response[1].split('\r\n', 1)
 
492
        self.assertRaises(errors.InvalidHttpResponse,
 
493
            http._extract_headers, txt, 'missing HTTTP')
 
494
 
 
495
    def test_trailing_whitespace(self):
 
496
        # Test that we ignore bogus whitespace on the end
 
497
        code, txt, body = _full_text_response
 
498
        txt += '\r\n\n\n\n\n'
 
499
        self.use_response((code, txt, body))
 
500
 
 
501
        self.check_header('Date', 'Tue, 11 Jul 2006 04:32:56 GMT')
 
502
        self.check_header('Content-Length', '35')
 
503
        self.check_header('Content-Type', 'text/plain; charset=UTF-8')
 
504
 
 
505
    def test_trailing_non_http(self):
 
506
        # Test that we ignore bogus stuff on the end
 
507
        code, txt, body = _full_text_response
 
508
        txt = txt + 'Foo: Bar\r\nBaz: Bling\r\n\r\n'
 
509
        self.use_response((code, txt, body))
 
510
 
 
511
        self.check_header('Date', 'Tue, 11 Jul 2006 04:32:56 GMT')
 
512
        self.check_header('Content-Length', '35')
 
513
        self.check_header('Content-Type', 'text/plain; charset=UTF-8')
 
514
        self.assertRaises(KeyError, self.headers.__getitem__, 'Foo')
 
515
 
 
516
    def test_extra_whitespace(self):
 
517
        # Test that we read an HTTP response, even with extra whitespace
 
518
        code, txt, body = _redirect_response
 
519
        # Find the second HTTP location
 
520
        loc = txt.find('HTTP', 5)
 
521
        txt = txt[:loc] + '\r\n\n' + txt[loc:]
 
522
        self.use_response((code, txt, body))
 
523
        self.check_header('Content-Range', 'bytes 8623075-8623499/8623500')
 
524
        self.check_header('Content-Type', 'text/plain; charset=UTF-8')
 
525
 
 
526
 
 
527
class TestHandleResponse(TestCase):
 
528
    
718
529
    def get_response(self, a_response):
719
530
        """Process a supplied response, and return the result."""
720
 
        code, raw_headers, body = a_response
721
 
        msg = self._build_HTTPMessage(raw_headers)
722
 
        return response.handle_response('http://foo', code, msg,
 
531
        headers = http._extract_headers(a_response[1], 'http://foo')
 
532
        return response.handle_response('http://foo', a_response[0], headers,
723
533
                                        StringIO(a_response[2]))
724
534
 
725
535
    def test_full_text(self):
727
537
        # It is a StringIO from the original data
728
538
        self.assertEqual(_full_text_response[2], out.read())
729
539
 
 
540
    def test_missing_response(self):
 
541
        self.assertRaises(errors.NoSuchFile,
 
542
            self.get_response, _missing_response)
 
543
 
730
544
    def test_single_range(self):
731
545
        out = self.get_response(_single_range_response)
 
546
        self.assertIsInstance(out, response.HttpRangeResponse)
 
547
 
 
548
        self.assertRaises(errors.InvalidRange, out.read, 20)
732
549
 
733
550
        out.seek(100)
734
551
        self.assertEqual(_single_range_response[2], out.read(100))
735
552
 
736
 
    def test_single_range_no_content(self):
737
 
        out = self.get_response(_single_range_no_content_type)
738
 
 
739
 
        out.seek(100)
740
 
        self.assertEqual(_single_range_no_content_type[2], out.read(100))
741
 
 
742
 
    def test_single_range_truncated(self):
743
 
        out = self.get_response(_single_range_response_truncated)
744
 
        # Content-Range declares 100 but only 51 present
745
 
        self.assertRaises(errors.ShortReadvError, out.seek, out.tell() + 51)
746
 
 
747
553
    def test_multi_range(self):
748
554
        out = self.get_response(_multipart_range_response)
 
555
        self.assertIsInstance(out, response.HttpMultipartRangeResponse)
749
556
 
750
557
        # Just make sure we can read the right contents
751
558
        out.seek(0)
754
561
        out.seek(1000)
755
562
        out.read(1050)
756
563
 
757
 
    def test_multi_squid_range(self):
758
 
        out = self.get_response(_multipart_squid_range_response)
759
 
 
760
 
        # Just make sure we can read the right contents
761
 
        out.seek(0)
762
 
        out.read(100)
763
 
 
764
 
        out.seek(300)
765
 
        out.read(200)
766
 
 
767
564
    def test_invalid_response(self):
768
565
        self.assertRaises(errors.InvalidHttpResponse,
769
 
                          self.get_response, _invalid_response)
 
566
            self.get_response, _invalid_response)
770
567
 
771
568
    def test_full_text_no_content_type(self):
772
569
        # We should not require Content-Type for a full response
773
 
        code, raw_headers, body = _full_text_response_no_content_type
774
 
        msg = self._build_HTTPMessage(raw_headers)
775
 
        out = response.handle_response('http://foo', code, msg, StringIO(body))
776
 
        self.assertEqual(body, out.read())
777
 
 
778
 
    def test_full_text_no_content_length(self):
779
 
        code, raw_headers, body = _full_text_response_no_content_length
780
 
        msg = self._build_HTTPMessage(raw_headers)
781
 
        out = response.handle_response('http://foo', code, msg, StringIO(body))
782
 
        self.assertEqual(body, out.read())
 
570
        a_response = _full_text_response
 
571
        headers = http._extract_headers(a_response[1], 'http://foo')
 
572
        del headers['Content-Type']
 
573
        out = response.handle_response('http://foo', a_response[0], headers,
 
574
                                        StringIO(a_response[2]))
 
575
        self.assertEqual(_full_text_response[2], out.read())
 
576
 
 
577
    def test_missing_no_content_type(self):
 
578
        # Without Content-Type we should still raise NoSuchFile on a 404
 
579
        a_response = _missing_response
 
580
        headers = http._extract_headers(a_response[1], 'http://missing')
 
581
        del headers['Content-Type']
 
582
        self.assertRaises(errors.NoSuchFile,
 
583
            response.handle_response, 'http://missing', a_response[0], headers,
 
584
                                      StringIO(a_response[2]))
 
585
 
 
586
    def test_missing_content_type(self):
 
587
        a_response = _single_range_response
 
588
        headers = http._extract_headers(a_response[1], 'http://nocontent')
 
589
        del headers['Content-Type']
 
590
        self.assertRaises(errors.InvalidHttpContentType,
 
591
            response.handle_response, 'http://nocontent', a_response[0],
 
592
                                      headers, StringIO(a_response[2]))
783
593
 
784
594
    def test_missing_content_range(self):
785
 
        code, raw_headers, body = _single_range_no_content_range
786
 
        msg = self._build_HTTPMessage(raw_headers)
787
 
        self.assertRaises(errors.InvalidHttpResponse,
788
 
                          response.handle_response,
789
 
                          'http://bogus', code, msg, StringIO(body))
790
 
 
791
 
    def test_multipart_no_content_range(self):
792
 
        code, raw_headers, body = _multipart_no_content_range
793
 
        msg = self._build_HTTPMessage(raw_headers)
794
 
        self.assertRaises(errors.InvalidHttpResponse,
795
 
                          response.handle_response,
796
 
                          'http://bogus', code, msg, StringIO(body))
797
 
 
798
 
    def test_multipart_no_boundary(self):
799
 
        out = self.get_response(_multipart_no_boundary)
800
 
        out.read()  # Read the whole range
801
 
        # Fail to find the boundary line
802
 
        self.assertRaises(errors.InvalidHttpResponse, out.seek, 1, 1)
803
 
 
804
 
 
805
 
class TestRangeFileSizeReadLimited(tests.TestCase):
806
 
    """Test RangeFile _max_read_size functionality which limits the size of
807
 
    read blocks to prevent MemoryError messages in socket.recv.
808
 
    """
809
 
 
810
 
    def setUp(self):
811
 
        super(TestRangeFileSizeReadLimited, self).setUp()
812
 
        # create a test datablock larger than _max_read_size.
813
 
        chunk_size = response.RangeFile._max_read_size
814
 
        test_pattern = '0123456789ABCDEF'
815
 
        self.test_data =  test_pattern * (3 * chunk_size / len(test_pattern))
816
 
        self.test_data_len = len(self.test_data)
817
 
 
818
 
    def test_max_read_size(self):
819
 
        """Read data in blocks and verify that the reads are not larger than
820
 
           the maximum read size.
821
 
        """
822
 
        # retrieve data in large blocks from response.RangeFile object
823
 
        mock_read_file = FakeReadFile(self.test_data)
824
 
        range_file = response.RangeFile('test_max_read_size', mock_read_file)
825
 
        response_data = range_file.read(self.test_data_len)
826
 
 
827
 
        # verify read size was equal to the maximum read size
828
 
        self.assertTrue(mock_read_file.get_max_read_size() > 0)
829
 
        self.assertEqual(mock_read_file.get_max_read_size(),
830
 
                         response.RangeFile._max_read_size)
831
 
        self.assertEqual(mock_read_file.get_read_count(), 3)
832
 
 
833
 
        # report error if the data wasn't equal (we only report the size due
834
 
        # to the length of the data)
835
 
        if response_data != self.test_data:
836
 
            message = "Data not equal.  Expected %d bytes, received %d."
837
 
            self.fail(message % (len(response_data), self.test_data_len))
838
 
 
 
595
        a_response = _single_range_response
 
596
        headers = http._extract_headers(a_response[1], 'http://nocontent')
 
597
        del headers['Content-Range']
 
598
        self.assertRaises(errors.InvalidHttpResponse,
 
599
            response.handle_response, 'http://nocontent', a_response[0],
 
600
                                      headers, StringIO(a_response[2]))