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
|
# -*- coding: utf-8 -*-
#
# Copyright (C) 2020 Radim Rehurek <me@radimrehurek.com>
#
# This code is distributed under the terms and conditions
# from the MIT License (MIT).
#
"""Integration tests ported from our old unit tests.
Before running these tests against a real bucket, make sure its initialized
with initialize_s3_bucket.py.
"""
import contextlib
import gzip
import io
import os
import unittest
import uuid
import warnings
import boto3
import pytest
import smart_open
import smart_open.concurrency
import smart_open.constants
from initialize_s3_bucket import CONTENTS
BUCKET_NAME = 'smartopen-integration-tests'
def setUpModule():
assert boto3.resource('s3').Bucket(BUCKET_NAME).creation_date, 'see initialize_s3_bucket.py'
def ignore_resource_warnings():
warnings.filterwarnings("ignore", category=ResourceWarning, message="unclosed.*<ssl.SSLSocket.*>") # noqa
class ReaderTest(unittest.TestCase):
def setUp(self):
ignore_resource_warnings()
def test_iter(self):
"""Are S3 files iterated over correctly?"""
key_name = 'hello.txt'
expected = CONTENTS[key_name].split(b'\n')
fin = smart_open.s3.Reader(BUCKET_NAME, key_name)
actual = [line.rstrip(b'\n') for line in fin]
self.assertEqual(expected, actual)
def test_iter_context_manager(self):
# same thing but using a context manager
key_name = 'hello.txt'
expected = CONTENTS[key_name].split(b'\n')
with smart_open.s3.Reader(BUCKET_NAME, key_name) as fin:
actual = [line.rstrip(b'\n') for line in fin]
self.assertEqual(expected, actual)
def test_read(self):
"""Are S3 files read correctly?"""
key_name = 'hello.txt'
expected = CONTENTS[key_name]
fin = smart_open.s3.Reader(BUCKET_NAME, key_name)
self.assertEqual(expected[:6], fin.read(6))
self.assertEqual(expected[6:14], fin.read(8)) # ř is 2 bytes
self.assertEqual(expected[14:], fin.read()) # read the rest
def test_seek_beginning(self):
"""Does seeking to the beginning of S3 files work correctly?"""
key_name = 'hello.txt'
expected = CONTENTS[key_name]
fin = smart_open.s3.Reader(BUCKET_NAME, key_name)
self.assertEqual(expected[:6], fin.read(6))
self.assertEqual(expected[6:14], fin.read(8)) # ř is 2 bytes
fin.seek(0)
self.assertEqual(expected, fin.read()) # no size given => read whole file
fin.seek(0)
self.assertEqual(expected, fin.read(-1)) # same thing
def test_seek_start(self):
"""Does seeking from the start of S3 files work correctly?"""
fin = smart_open.s3.Reader(BUCKET_NAME, 'hello.txt')
seek = fin.seek(6)
self.assertEqual(seek, 6)
self.assertEqual(fin.tell(), 6)
self.assertEqual(fin.read(6), u'wořld'.encode('utf-8'))
def test_seek_current(self):
"""Does seeking from the middle of S3 files work correctly?"""
fin = smart_open.s3.Reader(BUCKET_NAME, 'hello.txt')
self.assertEqual(fin.read(5), b'hello')
seek = fin.seek(1, whence=smart_open.constants.WHENCE_CURRENT)
self.assertEqual(seek, 6)
self.assertEqual(fin.read(6), u'wořld'.encode('utf-8'))
def test_seek_end(self):
"""Does seeking from the end of S3 files work correctly?"""
key_name = 'hello.txt'
expected = CONTENTS[key_name]
fin = smart_open.s3.Reader(BUCKET_NAME, key_name)
seek = fin.seek(-4, whence=smart_open.constants.WHENCE_END)
self.assertEqual(seek, len(expected) - 4)
self.assertEqual(fin.read(), b'you?')
def test_detect_eof(self):
key_name = 'hello.txt'
expected = CONTENTS[key_name]
fin = smart_open.s3.Reader(BUCKET_NAME, key_name)
fin.read()
eof = fin.tell()
self.assertEqual(eof, len(expected))
fin.seek(0, whence=smart_open.constants.WHENCE_END)
self.assertEqual(eof, fin.tell())
def test_read_gzip(self):
key_name = 'hello.txt.gz'
with gzip.GzipFile(fileobj=io.BytesIO(CONTENTS[key_name])) as fin:
expected = fin.read()
with smart_open.s3.Reader(BUCKET_NAME, key_name) as fin:
with gzip.GzipFile(fileobj=fin) as zipfile:
actual = zipfile.read()
self.assertEqual(expected, actual)
def test_readline(self):
key_name = 'multiline.txt'
expected = CONTENTS[key_name]
with smart_open.s3.Reader(BUCKET_NAME, key_name) as fin:
fin.readline()
self.assertEqual(fin.tell(), expected.index(b'\n')+1)
fin.seek(0)
actual = list(fin)
self.assertEqual(fin.tell(), len(expected))
expected = [b'englishman\n', b'in\n', b'new\n', b'york\n']
self.assertEqual(expected, actual)
def test_readline_tiny_buffer(self):
key_name = 'multiline.txt'
expected = CONTENTS[key_name]
with smart_open.s3.Reader(BUCKET_NAME, key_name, buffer_size=8) as fin:
actual = list(fin)
expected = [b'englishman\n', b'in\n', b'new\n', b'york\n']
self.assertEqual(expected, actual)
def test_read0_does_not_return_data(self):
with smart_open.s3.Reader(BUCKET_NAME, 'hello.txt') as fin:
data = fin.read(0)
self.assertEqual(data, b'')
def test_to_boto3(self):
key_name = 'multiline.txt'
expected = CONTENTS[key_name]
with smart_open.s3.Reader(BUCKET_NAME, key_name) as fin:
returned_obj = fin.to_boto3(boto3.resource('s3'))
boto3_body = returned_obj.get()['Body'].read()
self.assertEqual(expected, boto3_body)
def read_key(key):
return boto3.resource('s3').Object(BUCKET_NAME, key).get()['Body'].read()
class WriterTest(unittest.TestCase):
def setUp(self):
#
# Write to a unique key each time to avoid cross-talk between
# simultaneous test runs.
#
self.key = 'writer-test/' + uuid.uuid4().hex
def tearDown(self):
boto3.resource('s3').Object(BUCKET_NAME, self.key).delete()
def test_write(self):
"""Does writing into s3 work correctly?"""
test_string = u"žluťoučký koníček".encode('utf8')
with smart_open.s3.MultipartWriter(BUCKET_NAME, self.key) as fout:
fout.write(test_string)
data = read_key(self.key)
self.assertEqual(data, test_string)
def test_multipart(self):
"""Does s3 multipart chunking work correctly?"""
data_dir = os.path.join(os.path.dirname(__file__), "../tests/test_data")
with open(os.path.join(data_dir, "crime-and-punishment.txt"), "rb") as fin:
crime = fin.read()
data = b''
ps = 5 * 1024 * 1024
while len(data) < ps:
data += crime
title = "Преступление и наказание\n\n".encode()
to_be_continued = "\n\n... продолжение следует ...\n\n".encode()
key = "WriterTest.test_multipart"
with smart_open.s3.MultipartWriter(BUCKET_NAME, key, part_size=ps) as fout:
#
# Write some data without triggering an upload
#
fout.write(title)
assert fout._total_parts == 0
assert fout._buf.tell() == 48
#
# Trigger a part upload
#
fout.write(data)
assert fout._total_parts == 1
assert fout._buf.tell() == 661
#
# Write _without_ triggering a part upload
#
fout.write(to_be_continued)
assert fout._total_parts == 1
assert fout._buf.tell() == 710
#
# We closed the writer, so the final part must have been uploaded
#
assert fout._buf.tell() == 0
assert fout._total_parts == 2
#
# read back the same key and check its content
#
with smart_open.s3.open(BUCKET_NAME, key, 'rb') as fin:
got = fin.read()
want = title + data + to_be_continued
assert want == got
def test_empty_key(self):
"""Does writing no data cause key with an empty value to be created?"""
smart_open_write = smart_open.s3.MultipartWriter(BUCKET_NAME, self.key)
with smart_open_write as fout: # noqa
pass
# read back the same key and check its content
data = read_key(self.key)
self.assertEqual(data, b'')
def test_buffered_writer_wrapper_works(self):
"""
Ensure that we can wrap a smart_open s3 stream in a BufferedWriter, which
passes a memoryview object to the underlying stream in python >= 2.7
"""
expected = u'не думай о секундах свысока'
with smart_open.s3.MultipartWriter(BUCKET_NAME, self.key) as fout:
with io.BufferedWriter(fout) as sub_out:
sub_out.write(expected.encode('utf-8'))
text = read_key(self.key).decode('utf-8')
self.assertEqual(expected, text)
def test_double_close(self):
text = u'там за туманами, вечными, пьяными'.encode('utf-8')
fout = smart_open.s3.open(BUCKET_NAME, self.key, 'wb')
fout.write(text)
fout.close()
fout.close()
result = read_key(self.key)
self.assertEqual(result, text)
def test_flush_close(self):
text = u'там за туманами, вечными, пьяными'.encode('utf-8')
fout = smart_open.s3.open(BUCKET_NAME, self.key, 'wb')
fout.write(text)
fout.flush()
fout.close()
result = read_key(self.key)
self.assertEqual(result, text)
class IterBucketTest(unittest.TestCase):
def setUp(self):
self.expected = [
(key, value)
for (key, value) in CONTENTS.items()
if key.startswith('iter_bucket/')
]
self.expected.sort()
def test_multithreading(self):
actual = list(smart_open.s3.iter_bucket(BUCKET_NAME, prefix='iter_bucket'))
self.assertEqual(len(self.expected), len(actual))
self.assertEqual(self.expected, sorted(actual))
def test_accept_key(self):
expected = [(key, value) for (key, value) in self.expected if '4' in key]
actual = list(
smart_open.s3.iter_bucket(
BUCKET_NAME,
prefix='iter_bucket',
accept_key=lambda key: '4' in key
)
)
self.assertEqual(len(expected), len(actual))
self.assertEqual(expected, sorted(actual))
@pytest.mark.parametrize('workers', [1, 4, 8, 16, 64])
def test_workers(workers):
expected = sorted([
(key, value)
for (key, value) in CONTENTS.items()
if key.startswith('iter_bucket/')
])
actual = sorted(smart_open.s3.iter_bucket(BUCKET_NAME, prefix='iter_bucket', workers=workers))
assert len(expected) == len(actual)
assert expected == actual
|