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
|
# -*- coding: utf-8 -*-
#
# Copyright (C) 2019 Radim Rehurek <me@radimrehurek.com>
#
# This code is distributed under the terms and conditions
# from the MIT License (MIT).
#
import functools
import gzip
import unittest
import pytest
import responses
import smart_open.http
import smart_open.s3
import smart_open.constants
import requests
BYTES = b'i tried so hard and got so far but in the end it doesn\'t even matter'
GZIPPED_BYTES = gzip.compress(BYTES)
URL = 'http://localhost'
HTTPS_URL = 'https://localhost'
HEADERS = {
'Accept-Ranges': 'bytes',
}
def request_callback(request, headers=HEADERS, data=BYTES):
headers = headers.copy()
range_string = request.headers.get('range', 'bytes=0-')
start, end = range_string.replace('bytes=', '', 1).split('-', 1)
start = int(start)
end = int(end) if end else len(data)
data = data[start:end]
headers['Content-Length'] = str(len(data))
return (200, headers, data)
class HttpTest(unittest.TestCase):
@responses.activate
def test_read_all(self):
responses.add(responses.GET, URL, body=BYTES)
reader = smart_open.http.SeekableBufferedInputBase(URL)
read_bytes = reader.read()
self.assertEqual(BYTES, read_bytes)
@responses.activate
def test_seek_from_start(self):
responses.add_callback(responses.GET, URL, callback=request_callback)
reader = smart_open.http.SeekableBufferedInputBase(URL)
reader.seek(10)
self.assertEqual(reader.tell(), 10)
read_bytes = reader.read(size=10)
self.assertEqual(reader.tell(), 20)
self.assertEqual(BYTES[10:20], read_bytes)
reader.seek(20)
read_bytes = reader.read(size=10)
self.assertEqual(BYTES[20:30], read_bytes)
reader.seek(0)
read_bytes = reader.read(size=10)
self.assertEqual(BYTES[:10], read_bytes)
@responses.activate
def test_seek_from_current(self):
responses.add_callback(responses.GET, URL, callback=request_callback)
reader = smart_open.http.SeekableBufferedInputBase(URL)
reader.seek(10)
read_bytes = reader.read(size=10)
self.assertEqual(BYTES[10:20], read_bytes)
self.assertEqual(reader.tell(), 20)
reader.seek(10, whence=smart_open.constants.WHENCE_CURRENT)
self.assertEqual(reader.tell(), 30)
read_bytes = reader.read(size=10)
self.assertEqual(reader.tell(), 40)
self.assertEqual(BYTES[30:40], read_bytes)
@responses.activate
def test_seek_from_end(self):
responses.add_callback(responses.GET, URL, callback=request_callback)
reader = smart_open.http.SeekableBufferedInputBase(URL)
reader.seek(-10, whence=smart_open.constants.WHENCE_END)
self.assertEqual(reader.tell(), len(BYTES) - 10)
read_bytes = reader.read(size=10)
self.assertEqual(reader.tell(), len(BYTES))
self.assertEqual(BYTES[-10:], read_bytes)
@responses.activate
def test_headers_are_as_assigned(self):
responses.add_callback(responses.GET, URL, callback=request_callback)
# use default _HEADERS
x = smart_open.http.BufferedInputBase(URL)
# set different ones
x.headers['Accept-Encoding'] = 'compress, gzip'
x.headers['Other-Header'] = 'value'
# use default again, global shoudn't overwritten from x
y = smart_open.http.BufferedInputBase(URL)
# should be default headers
self.assertEqual(y.headers, {'Accept-Encoding': 'identity'})
# should be assigned headers
self.assertEqual(x.headers, {'Accept-Encoding': 'compress, gzip', 'Other-Header': 'value'})
@responses.activate
def test_headers(self):
"""Does the top-level http.open function handle headers correctly?"""
responses.add_callback(responses.GET, URL, callback=request_callback)
reader = smart_open.http.open(URL, 'rb', headers={'Foo': 'bar'})
self.assertEqual(reader.headers['Foo'], 'bar')
@responses.activate
def test_https_seek_start(self):
"""Did the seek start over HTTPS work?"""
responses.add_callback(responses.GET, HTTPS_URL, callback=request_callback)
with smart_open.open(HTTPS_URL, "rb") as fin:
read_bytes_1 = fin.read(size=10)
fin.seek(0)
read_bytes_2 = fin.read(size=10)
self.assertEqual(read_bytes_1, read_bytes_2)
@responses.activate
def test_https_seek_forward(self):
"""Did the seek forward over HTTPS work?"""
responses.add_callback(responses.GET, HTTPS_URL, callback=request_callback)
with smart_open.open(HTTPS_URL, "rb") as fin:
fin.seek(10)
read_bytes = fin.read(size=10)
self.assertEqual(BYTES[10:20], read_bytes)
@responses.activate
def test_https_seek_reverse(self):
"""Did the seek in reverse over HTTPS work?"""
responses.add_callback(responses.GET, HTTPS_URL, callback=request_callback)
with smart_open.open(HTTPS_URL, "rb") as fin:
read_bytes_1 = fin.read(size=10)
fin.seek(-10, whence=smart_open.constants.WHENCE_CURRENT)
read_bytes_2 = fin.read(size=10)
self.assertEqual(read_bytes_1, read_bytes_2)
@responses.activate
def test_timeout_attribute(self):
timeout = 1
responses.add_callback(responses.GET, URL, callback=request_callback)
reader = smart_open.open(URL, "rb", transport_params={'timeout': timeout})
assert hasattr(reader, 'timeout')
assert reader.timeout == timeout
@responses.activate
def test_session_attribute(self):
session = requests.Session()
responses.add_callback(responses.GET, URL, callback=request_callback)
reader = smart_open.open(URL, "rb", transport_params={'session': session})
assert hasattr(reader, 'session')
assert reader.session == session
assert reader.read() == BYTES
@responses.activate
def test_seek_implicitly_enabled(numbytes=10):
"""Can we seek even if the server hasn't explicitly allowed it?"""
callback = functools.partial(request_callback, headers={})
responses.add_callback(responses.GET, HTTPS_URL, callback=callback)
with smart_open.open(HTTPS_URL, 'rb') as fin:
assert fin.seekable()
first = fin.read(size=numbytes)
fin.seek(-numbytes, whence=smart_open.constants.WHENCE_CURRENT)
second = fin.read(size=numbytes)
assert first == second
@responses.activate
def test_seek_implicitly_disabled():
"""Does seeking fail when the server has explicitly disabled it?"""
callback = functools.partial(request_callback, headers={'Accept-Ranges': 'none'})
responses.add_callback(responses.GET, HTTPS_URL, callback=callback)
with smart_open.open(HTTPS_URL, 'rb') as fin:
assert not fin.seekable()
fin.read()
with pytest.raises(OSError):
fin.seek(0)
@responses.activate
def test_gzip_encoding_default_headers():
"""Does Accept-Encoding: identity prevent gzip compression?"""
def callback(request):
# Server respects Accept-Encoding: identity and sends uncompressed
headers = HEADERS.copy()
headers['Content-Length'] = str(len(BYTES))
return (200, headers, BYTES)
responses.add_callback(responses.GET, URL, callback=callback)
reader = smart_open.http.SeekableBufferedInputBase(URL)
read_bytes = reader.read()
assert read_bytes == BYTES
@responses.activate
def test_gzip_encoding_explicit_request():
"""Does Accept-Encoding: gzip properly decompress via response.raw?"""
def callback(request):
# Server sees gzip in Accept-Encoding and returns compressed data
if 'gzip' in request.headers.get('Accept-Encoding', ''):
headers = HEADERS.copy()
headers['Content-Encoding'] = 'gzip'
headers['Content-Length'] = str(len(GZIPPED_BYTES))
return (200, headers, GZIPPED_BYTES)
else:
headers = HEADERS.copy()
headers['Content-Length'] = str(len(BYTES))
return (200, headers, BYTES)
responses.add_callback(responses.GET, URL, callback=callback)
# Explicitly request gzip encoding
reader = smart_open.http.SeekableBufferedInputBase(URL, headers={'Accept-Encoding': 'gzip'})
read_bytes = reader.read()
assert read_bytes == BYTES # Should be decompressed by requests/urllib3
# Combining multiple read calls also works
reader.seek(0)
partial = reader.read(2) + reader.read(1000)
assert partial == BYTES
@responses.activate
def test_read_after_read_to_eof():
"""Reading after reading to EOF should return empty bytes."""
responses.add_callback(responses.GET, URL, callback=request_callback)
reader = smart_open.http.SeekableBufferedInputBase(URL)
# Read to EOF
result = reader.read(-1)
assert len(result) == len(BYTES)
assert reader.tell() == len(BYTES)
# Read should return empty bytes
result = reader.read()
assert result == b""
# Read with size should also return empty bytes
result = reader.read(10)
assert result == b""
@responses.activate
def test_read_after_seek_to_eof():
"""Reading after seeking to EOF should return empty bytes."""
responses.add_callback(responses.GET, URL, callback=request_callback)
reader = smart_open.http.SeekableBufferedInputBase(URL)
# Seek to EOF
reader.seek(0, whence=smart_open.constants.WHENCE_END)
assert reader.tell() == len(BYTES)
# Read should return empty bytes
result = reader.read()
assert result == b""
# Read with size should also return empty bytes
result = reader.read(10)
assert result == b""
@responses.activate
def test_read_with_invalid_size():
"""Read with size < -1 should raise ValueError."""
responses.add_callback(responses.GET, URL, callback=request_callback)
reader = smart_open.http.SeekableBufferedInputBase(URL)
with pytest.raises(ValueError, match='size must be >= -1'):
reader.read(-2)
|