18574: Fixes key_aliases/value_aliases indexing. Adds dict-style indexing.
[arvados.git] / sdk / python / tests / test_stream.py
index 2f4fc700976911c754c2222f22daa0694cf80c4a..dc84a037f85947baa43896e58aec65d9a370c297 100644 (file)
@@ -1,5 +1,9 @@
-#!/usr/bin/env python
+# Copyright (C) The Arvados Authors. All rights reserved.
+#
+# SPDX-License-Identifier: Apache-2.0
 
+from __future__ import absolute_import
+from builtins import object
 import bz2
 import gzip
 import io
@@ -9,10 +13,11 @@ import unittest
 import hashlib
 
 import arvados
-from arvados import StreamReader, StreamFileReader, Range
+from arvados import StreamReader, StreamFileReader
+from arvados._ranges import Range
 
-import arvados_testutil as tutil
-import run_test_server
+from . import arvados_testutil as tutil
+from . import run_test_server
 
 class StreamFileReaderTestCase(unittest.TestCase):
     def make_count_reader(self):
@@ -20,62 +25,65 @@ class StreamFileReaderTestCase(unittest.TestCase):
         return StreamFileReader(stream, [Range(1, 0, 3), Range(6, 3, 3), Range(11, 6, 3)],
                                 'count.txt')
 
-    def test_read_returns_first_block(self):
+    def test_read_block_crossing_behavior(self):
         # read() calls will be aligned on block boundaries - see #3663.
         sfile = self.make_count_reader()
-        self.assertEqual('123', sfile.read(10))
+        self.assertEqual(b'123', sfile.read(10))
 
     def test_small_read(self):
         sfile = self.make_count_reader()
-        self.assertEqual('12', sfile.read(2))
+        self.assertEqual(b'12', sfile.read(2))
 
     def test_successive_reads(self):
         sfile = self.make_count_reader()
-        for expect in ['123', '456', '789', '']:
+        for expect in [b'123', b'456', b'789', b'']:
             self.assertEqual(expect, sfile.read(10))
 
     def test_readfrom_spans_blocks(self):
         sfile = self.make_count_reader()
-        self.assertEqual('6789', sfile.readfrom(5, 12))
+        self.assertEqual(b'6789', sfile.readfrom(5, 12))
 
     def test_small_readfrom_spanning_blocks(self):
         sfile = self.make_count_reader()
-        self.assertEqual('2345', sfile.readfrom(1, 4))
+        self.assertEqual(b'2345', sfile.readfrom(1, 4))
 
     def test_readall(self):
         sfile = self.make_count_reader()
-        self.assertEqual('123456789', ''.join(sfile.readall()))
+        self.assertEqual(b'123456789', b''.join(sfile.readall()))
 
     def test_one_arg_seek(self):
-        self.test_relative_seek([])
+        self.test_absolute_seek([])
 
     def test_absolute_seek(self, args=[os.SEEK_SET]):
         sfile = self.make_count_reader()
         sfile.seek(6, *args)
-        self.assertEqual('78', sfile.read(2))
+        self.assertEqual(b'78', sfile.read(2))
         sfile.seek(4, *args)
-        self.assertEqual('56', sfile.read(2))
+        self.assertEqual(b'56', sfile.read(2))
 
     def test_relative_seek(self, args=[os.SEEK_CUR]):
         sfile = self.make_count_reader()
-        self.assertEqual('12', sfile.read(2))
+        self.assertEqual(b'12', sfile.read(2))
         sfile.seek(2, *args)
-        self.assertEqual('56', sfile.read(2))
+        self.assertEqual(b'56', sfile.read(2))
 
     def test_end_seek(self):
         sfile = self.make_count_reader()
         sfile.seek(-6, os.SEEK_END)
-        self.assertEqual('45', sfile.read(2))
+        self.assertEqual(b'45', sfile.read(2))
 
     def test_seek_min_zero(self):
         sfile = self.make_count_reader()
-        sfile.seek(-2, os.SEEK_SET)
+        self.assertEqual(0, sfile.tell())
+        with self.assertRaises(IOError):
+            sfile.seek(-2, os.SEEK_SET)
         self.assertEqual(0, sfile.tell())
 
     def test_seek_max_size(self):
         sfile = self.make_count_reader()
         sfile.seek(2, os.SEEK_END)
-        self.assertEqual(9, sfile.tell())
+        # POSIX permits seeking past end of file.
+        self.assertEqual(11, sfile.tell())
 
     def test_size(self):
         self.assertEqual(9, self.make_count_reader().size())
@@ -98,7 +106,7 @@ class StreamFileReaderTestCase(unittest.TestCase):
     def test_context(self):
         with self.make_count_reader() as sfile:
             self.assertFalse(sfile.closed, "reader is closed inside context")
-            self.assertEqual('12', sfile.read(2))
+            self.assertEqual(b'12', sfile.read(2))
         self.assertTrue(sfile.closed, "reader is open after context")
 
     def make_newlines_reader(self):
@@ -145,13 +153,27 @@ class StreamFileReaderTestCase(unittest.TestCase):
         self.assertEqual('nametest', sfile.name)
         self.assertEqual('nametest', sfile.name())
 
+    def check_decompressed_name(self, filename, expect):
+        stream = tutil.MockStreamReader('.', '')
+        reader = StreamFileReader(stream, [Range(0, 0, 0)], filename)
+        self.assertEqual(expect, reader.decompressed_name())
+
+    def test_decompressed_name_uncompressed_file(self):
+        self.check_decompressed_name('test.log', 'test.log')
+
+    def test_decompressed_name_gzip_file(self):
+        self.check_decompressed_name('test.log.gz', 'test.log')
+
+    def test_decompressed_name_bz2_file(self):
+        self.check_decompressed_name('test.log.bz2', 'test.log')
+
     def check_decompression(self, compress_ext, compress_func):
-        test_text = 'decompression\ntest\n'
+        test_text = b'decompression\ntest\n'
         test_data = compress_func(test_text)
         stream = tutil.MockStreamReader('.', test_data)
         reader = StreamFileReader(stream, [Range(0, 0, len(test_data))],
                                   'test.' + compress_ext)
-        self.assertEqual(test_text, ''.join(reader.readall_decompressed()))
+        self.assertEqual(test_text, b''.join(reader.readall_decompressed()))
 
     @staticmethod
     def gzip_compress(data):
@@ -169,6 +191,19 @@ class StreamFileReaderTestCase(unittest.TestCase):
     def test_bz2_decompression(self):
         self.check_decompression('bz2', bz2.compress)
 
+    def test_readline_then_readlines(self):
+        reader = self.make_newlines_reader()
+        data = reader.readline()
+        self.assertEqual('one\n', data)
+        data = reader.readlines()
+        self.assertEqual(['two\n', '\n', 'three\n', 'four\n', '\n'], data)
+
+    def test_readline_then_readall(self):
+        reader = self.make_newlines_reader()
+        data = reader.readline()
+        self.assertEqual('one\n', data)
+        self.assertEqual(b''.join([b'two\n', b'\n', b'three\n', b'four\n', b'\n']), b''.join(reader.readall()))
+
 
 class StreamRetryTestMixin(object):
     # Define reader_for(coll_name, **kwargs)
@@ -184,48 +219,48 @@ class StreamRetryTestMixin(object):
 
     @tutil.skip_sleep
     def test_success_without_retries(self):
-        reader = self.reader_for('bar_file')
-        with tutil.mock_get_responses('bar', 200):
-            self.assertEqual('bar', self.read_for_test(reader, 3))
+        with tutil.mock_keep_responses('bar', 200):
+            reader = self.reader_for('bar_file')
+            self.assertEqual(b'bar', self.read_for_test(reader, 3))
 
     @tutil.skip_sleep
     def test_read_no_default_retry(self):
-        reader = self.reader_for('user_agreement')
-        with tutil.mock_get_responses('', 500):
+        with tutil.mock_keep_responses('', 500):
+            reader = self.reader_for('user_agreement')
             with self.assertRaises(arvados.errors.KeepReadError):
                 self.read_for_test(reader, 10)
 
     @tutil.skip_sleep
     def test_read_with_instance_retries(self):
-        reader = self.reader_for('foo_file', num_retries=3)
-        with tutil.mock_get_responses('foo', 500, 200):
-            self.assertEqual('foo', self.read_for_test(reader, 3))
+        with tutil.mock_keep_responses('foo', 500, 200):
+            reader = self.reader_for('foo_file', num_retries=3)
+            self.assertEqual(b'foo', self.read_for_test(reader, 3))
 
     @tutil.skip_sleep
     def test_read_with_method_retries(self):
-        reader = self.reader_for('foo_file')
-        with tutil.mock_get_responses('foo', 500, 200):
-            self.assertEqual('foo',
+        with tutil.mock_keep_responses('foo', 500, 200):
+            reader = self.reader_for('foo_file')
+            self.assertEqual(b'foo',
                              self.read_for_test(reader, 3, num_retries=3))
 
     @tutil.skip_sleep
     def test_read_instance_retries_exhausted(self):
-        reader = self.reader_for('bar_file', num_retries=3)
-        with tutil.mock_get_responses('bar', 500, 500, 500, 500, 200):
+        with tutil.mock_keep_responses('bar', 500, 500, 500, 500, 200):
+            reader = self.reader_for('bar_file', num_retries=3)
             with self.assertRaises(arvados.errors.KeepReadError):
                 self.read_for_test(reader, 3)
 
     @tutil.skip_sleep
     def test_read_method_retries_exhausted(self):
-        reader = self.reader_for('bar_file')
-        with tutil.mock_get_responses('bar', 500, 500, 500, 500, 200):
+        with tutil.mock_keep_responses('bar', 500, 500, 500, 500, 200):
+            reader = self.reader_for('bar_file')
             with self.assertRaises(arvados.errors.KeepReadError):
                 self.read_for_test(reader, 3, num_retries=3)
 
     @tutil.skip_sleep
     def test_method_retries_take_precedence(self):
-        reader = self.reader_for('user_agreement', num_retries=10)
-        with tutil.mock_get_responses('', 500, 500, 500, 200):
+        with tutil.mock_keep_responses('', 500, 500, 500, 200):
+            reader = self.reader_for('user_agreement', num_retries=10)
             with self.assertRaises(arvados.errors.KeepReadError):
                 self.read_for_test(reader, 10, num_retries=1)
 
@@ -261,162 +296,17 @@ class StreamFileReadFromTestCase(StreamFileReadTestCase):
 
 class StreamFileReadAllTestCase(StreamFileReadTestCase):
     def read_for_test(self, reader, byte_count, **kwargs):
-        return ''.join(reader.readall(**kwargs))
+        return b''.join(reader.readall(**kwargs))
 
 
 class StreamFileReadAllDecompressedTestCase(StreamFileReadTestCase):
     def read_for_test(self, reader, byte_count, **kwargs):
-        return ''.join(reader.readall_decompressed(**kwargs))
+        return b''.join(reader.readall_decompressed(**kwargs))
 
 
 class StreamFileReadlinesTestCase(StreamFileReadTestCase):
     def read_for_test(self, reader, byte_count, **kwargs):
-        return ''.join(reader.readlines(**kwargs))
-
-# class StreamWriterTestCase(unittest.TestCase):
-#     class MockKeep(object):
-#         def __init__(self, blocks):
-#             self.blocks = blocks
-#         def get(self, locator, num_retries=0):
-#             return self.blocks[locator]
-#         def put(self, data):
-#             pdh = "%s+%i" % (hashlib.md5(data).hexdigest(), len(data))
-#             self.blocks[pdh] = str(data)
-#             return pdh
-
-#     def test_init(self):
-#         stream = StreamWriter(['.', '781e5e245d69b566979b86e28d23f2c7+10', '0:10:count.txt'],
-#                               keep=StreamWriterTestCase.MockKeep({"781e5e245d69b566979b86e28d23f2c7+10": "0123456789"}))
-#         self.assertEqual("01234", stream.readfrom(0, 5))
-
-#     def test_append(self):
-#         stream = StreamWriter(['.', '781e5e245d69b566979b86e28d23f2c7+10', '0:10:count.txt'],
-#                               keep=StreamWriterTestCase.MockKeep({"781e5e245d69b566979b86e28d23f2c7+10": "0123456789"}))
-#         self.assertEqual("56789", stream.readfrom(5, 8))
-#         stream.append("foo")
-#         self.assertEqual("56789foo", stream.readfrom(5, 8))
-
-
-# class StreamFileWriterTestCase(unittest.TestCase):
-#     def test_truncate(self):
-#         stream = StreamWriter(['.', '781e5e245d69b566979b86e28d23f2c7+10', '0:10:count.txt'],
-#                               keep=StreamWriterTestCase.MockKeep({"781e5e245d69b566979b86e28d23f2c7+10": "0123456789"}))
-#         writer = stream.files()["count.txt"]
-#         self.assertEqual("56789", writer.readfrom(5, 8))
-#         writer.truncate(8)
-#         self.assertEqual("567", writer.readfrom(5, 8))
-
-#     def test_append(self):
-#         stream = StreamWriter(['.', '781e5e245d69b566979b86e28d23f2c7+10', '0:10:count.txt'],
-#                               keep=StreamWriterTestCase.MockKeep({"781e5e245d69b566979b86e28d23f2c7+10": "0123456789"}))
-#         writer = stream.files()["count.txt"]
-#         self.assertEqual("56789", writer.readfrom(5, 8))
-#         writer.seek(10)
-#         writer.write("foo")
-#         self.assertEqual(writer.size(), 13)
-#         self.assertEqual("56789foo", writer.readfrom(5, 8))
-
-#     def test_write0(self):
-#         stream = StreamWriter(['.', '781e5e245d69b566979b86e28d23f2c7+10', '0:10:count.txt'],
-#                               keep=StreamWriterTestCase.MockKeep({"781e5e245d69b566979b86e28d23f2c7+10": "0123456789"}))
-#         writer = stream.files()["count.txt"]
-#         self.assertEqual("0123456789", writer.readfrom(0, 13))
-#         writer.seek(0)
-#         writer.write("foo")
-#         self.assertEqual(writer.size(), 10)
-#         self.assertEqual("foo3456789", writer.readfrom(0, 13))
-#         self.assertEqual(". 781e5e245d69b566979b86e28d23f2c7+10 bufferblock0 10:3:count.txt 3:7:count.txt\n", stream.manifest_text())
-
-#     def test_write1(self):
-#         stream = StreamWriter(['.', '781e5e245d69b566979b86e28d23f2c7+10', '0:10:count.txt'],
-#                               keep=StreamWriterTestCase.MockKeep({"781e5e245d69b566979b86e28d23f2c7+10": "0123456789"}))
-#         writer = stream.files()["count.txt"]
-#         self.assertEqual("0123456789", writer.readfrom(0, 13))
-#         writer.seek(3)
-#         writer.write("foo")
-#         self.assertEqual(writer.size(), 10)
-#         self.assertEqual("012foo6789", writer.readfrom(0, 13))
-#         self.assertEqual(". 781e5e245d69b566979b86e28d23f2c7+10 bufferblock0 0:3:count.txt 10:3:count.txt 6:4:count.txt\n", stream.manifest_text())
-
-#     def test_write2(self):
-#         stream = StreamWriter(['.', '781e5e245d69b566979b86e28d23f2c7+10', '0:10:count.txt'],
-#                               keep=StreamWriterTestCase.MockKeep({"781e5e245d69b566979b86e28d23f2c7+10": "0123456789"}))
-#         writer = stream.files()["count.txt"]
-#         self.assertEqual("0123456789", writer.readfrom(0, 13))
-#         writer.seek(7)
-#         writer.write("foo")
-#         self.assertEqual(writer.size(), 10)
-#         self.assertEqual("0123456foo", writer.readfrom(0, 13))
-#         self.assertEqual(". 781e5e245d69b566979b86e28d23f2c7+10 bufferblock0 0:7:count.txt 10:3:count.txt\n", stream.manifest_text())
-
-#     def test_write3(self):
-#         stream = StreamWriter(['.', '781e5e245d69b566979b86e28d23f2c7+10', '0:10:count.txt', '0:10:count.txt'],
-#                               keep=StreamWriterTestCase.MockKeep({"781e5e245d69b566979b86e28d23f2c7+10": "0123456789"}))
-#         writer = stream.files()["count.txt"]
-#         self.assertEqual("012345678901234", writer.readfrom(0, 15))
-#         writer.seek(7)
-#         writer.write("foobar")
-#         self.assertEqual(writer.size(), 20)
-#         self.assertEqual("0123456foobar34", writer.readfrom(0, 15))
-#         self.assertEqual(". 781e5e245d69b566979b86e28d23f2c7+10 bufferblock0 0:7:count.txt 10:6:count.txt 3:7:count.txt\n", stream.manifest_text())
-
-#     def test_write4(self):
-#         stream = StreamWriter(['.', '781e5e245d69b566979b86e28d23f2c7+10', '0:4:count.txt', '0:4:count.txt', '0:4:count.txt'],
-#                               keep=StreamWriterTestCase.MockKeep({"781e5e245d69b566979b86e28d23f2c7+10": "0123456789"}))
-#         writer = stream.files()["count.txt"]
-#         self.assertEqual("012301230123", writer.readfrom(0, 15))
-#         writer.seek(2)
-#         writer.write("abcdefg")
-#         self.assertEqual(writer.size(), 12)
-#         self.assertEqual("01abcdefg123", writer.readfrom(0, 15))
-#         self.assertEqual(". 781e5e245d69b566979b86e28d23f2c7+10 bufferblock0 0:2:count.txt 10:7:count.txt 1:3:count.txt\n", stream.manifest_text())
-
-#     def test_write_large(self):
-#         stream = StreamWriter(['.', arvados.config.EMPTY_BLOCK_LOCATOR, '0:0:count.txt'],
-#                               keep=StreamWriterTestCase.MockKeep({}))
-#         writer = stream.files()["count.txt"]
-#         text = ''.join(["0123456789" for a in xrange(0, 100)])
-#         for b in xrange(0, 100000):
-#             writer.write(text)
-#         self.assertEqual(writer.size(), 100000000)
-#         stream.commit()
-#         self.assertEqual(". a5de24f4417cfba9d5825eadc2f4ca49+67108000 598cc1a4ccaef8ab6e4724d87e675d78+32892000 0:100000000:count.txt\n", stream.manifest_text())
-
-#     def test_write_rewrite0(self):
-#         stream = StreamWriter(['.', arvados.config.EMPTY_BLOCK_LOCATOR, '0:0:count.txt'],
-#                               keep=StreamWriterTestCase.MockKeep({}))
-#         writer = stream.files()["count.txt"]
-#         for b in xrange(0, 10):
-#             writer.seek(0, os.SEEK_SET)
-#             writer.write("0123456789")
-#         stream.commit()
-#         self.assertEqual(writer.size(), 10)
-#         self.assertEqual("0123456789", writer.readfrom(0, 20))
-#         self.assertEqual(". 781e5e245d69b566979b86e28d23f2c7+10 0:10:count.txt\n", stream.manifest_text())
-
-#     def test_write_rewrite1(self):
-#         stream = StreamWriter(['.', '781e5e245d69b566979b86e28d23f2c7+10', '0:10:count.txt'],
-#                               keep=StreamWriterTestCase.MockKeep({"781e5e245d69b566979b86e28d23f2c7+10": "0123456789"}))
-#         writer = stream.files()["count.txt"]
-#         for b in xrange(0, 10):
-#             writer.seek(10, os.SEEK_SET)
-#             writer.write("abcdefghij")
-#         stream.commit()
-#         self.assertEqual(writer.size(), 20)
-#         self.assertEqual("0123456789abcdefghij", writer.readfrom(0, 20))
-#         self.assertEqual(". 781e5e245d69b566979b86e28d23f2c7+10 a925576942e94b2ef57a066101b48876+10 0:10:count.txt 10:10:count.txt\n", stream.manifest_text())
-
-#     def test_write_rewrite2(self):
-#         stream = StreamWriter(['.', '781e5e245d69b566979b86e28d23f2c7+10', '0:10:count.txt'],
-#                               keep=StreamWriterTestCase.MockKeep({"781e5e245d69b566979b86e28d23f2c7+10": "0123456789"}))
-#         writer = stream.files()["count.txt"]
-#         for b in xrange(0, 10):
-#             writer.seek(5, os.SEEK_SET)
-#             writer.write("abcdefghij")
-#         stream.commit()
-#         self.assertEqual(writer.size(), 15)
-#         self.assertEqual("01234abcdefghij", writer.readfrom(0, 20))
-#         self.assertEqual(". 781e5e245d69b566979b86e28d23f2c7+10 a925576942e94b2ef57a066101b48876+10 0:5:count.txt 10:10:count.txt\n", stream.manifest_text())
+        return ''.join(reader.readlines(**kwargs)).encode()
 
 if __name__ == '__main__':
     unittest.main()