rdblue commented on a change in pull request #3691: URL: https://github.com/apache/iceberg/pull/3691#discussion_r790316162
########## File path: python/tests/io/test_base.py ########## @@ -0,0 +1,188 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +import os +import tempfile + +import pytest + +from iceberg.io.base import FileIO, InputFile, OutputFile + + +class LocalInputFile(InputFile): + """An InputFile implementation for local files (for test use only)""" + + def __init__(self, location: str): + if not location.startswith("file://"): + raise ValueError("LocalInputFile location must start with `file://`") + super().__init__(location=location.split("file://")[1]) + + def __len__(self): + return os.path.getsize(self.location) + + def exists(self): + return os.path.exists(self.location) + + def open(self): + return open(self.location, "rb") + + +class LocalOutputFile(OutputFile): + """An OutputFile implementation for local files (for test use only)""" + + def __init__(self, location: str): + if not location.startswith("file://"): + raise ValueError("LocalOutputFile location must start with `file://`") + super().__init__(location=location.split("file://")[1]) + + def __len__(self): + return len(self._file_obj) + + def exists(self): + return os.path.exists(self.location) + + def to_input_file(self): + return LocalInputFile(location=f"file://{self.location}") + + def create(self, overwrite: bool = False) -> None: + if not overwrite and self.exists(): + raise FileExistsError(f"{self.location} already exists") + + return open(self.location, "wb") + + +class LocalFileIO(FileIO): + """A FileIO implementation for local files (for test use only)""" + + def new_input(self, location: str): + return LocalInputFile(location=location) + + def new_output(self, location: str): + return LocalOutputFile(location=location) + + def delete(self, location: str): + os.remove(location) + + +@pytest.mark.parametrize("CustomInputFile", [LocalInputFile]) +def test_custom_local_input_file(CustomInputFile): + with tempfile.NamedTemporaryFile("wb") as tmpfilename: + # Write to the temporary file and seek to the beginning + tmpfilename.write(b"foo") + tmpfilename.seek(0) + + # Instantiate the input file + input_file = CustomInputFile(location=f"file://{tmpfilename.name}") + + # Test opening and reading the file + f = input_file.open() + data = f.read() + assert data == b"foo" + + +@pytest.mark.parametrize("CustomOutputFile", [LocalOutputFile]) +def test_custom_local_output_file(CustomOutputFile): + with tempfile.TemporaryDirectory() as tmpdirname: + output_file_location = os.path.join(tmpdirname, "foo.txt") + + # Instantiate an output file + output_file = CustomOutputFile(location=f"file://{output_file_location}") + + # Create the output file and write to it + f = output_file.create() + f.write(b"foo") + + # Confirm that bytes were written + with open(output_file_location, "rb") as f: + assert f.read() == b"foo" + + +@pytest.mark.parametrize("CustomOutputFile", [LocalOutputFile]) +def test_custom_local_output_file_with_overwrite(CustomOutputFile): + with tempfile.TemporaryDirectory() as tmpdirname: + output_file_location = os.path.join(tmpdirname, "foo.txt") + + # Create a file in the temporary directory + with open(output_file_location, "wb") as f: + f.write(b"foo") + + # Instantiate an output file + output_file = CustomOutputFile(location=f"file://{output_file_location}") + + # Confirm that a FileExistsError is raised when overwrite=False + with pytest.raises(FileExistsError): + f = output_file.create(overwrite=False) + f.write(b"foo") + + # Confirm that the file is overwritten with overwrite=True + f = output_file.create(overwrite=True) + f.write(b"bar") + with open(output_file_location, "rb") as f: + assert f.read() == b"bar" + + +@pytest.mark.parametrize("CustomOutputFile", [LocalOutputFile]) +def test_output_file_to_input_file(CustomOutputFile): + with tempfile.TemporaryDirectory() as tmpdirname: + output_file_location = os.path.join(tmpdirname, "foo.txt") + + # Create an output file instance + output_file = CustomOutputFile(location=f"file://{output_file_location}") + + # Create the output file and write to it + f = output_file.create() + f.write(b"foo") + + # Convert to an input file and confirm the contents + input_file = output_file.to_input_file() + with input_file.open() as f: + assert f.read() == b"foo" + + +@pytest.mark.parametrize( + "CustomFileIO,CustomInputFile,CustomOutputFile", + [(LocalFileIO, LocalInputFile, LocalOutputFile)], +) +def test_custom_file_io(CustomFileIO, CustomInputFile, CustomOutputFile): + # Instantiate the file-io and create a new input and output file + file_io = CustomFileIO() + input_file = file_io.new_input(location="file://foo") + output_file = file_io.new_output(location="file://bar") + + assert isinstance(input_file, CustomInputFile) + assert isinstance(output_file, CustomOutputFile) Review comment: I don't think that we need to test the types that are produced by FileIO, other than to ensure that they are InputFile and OutputFile instances. But we should get that with type checking for free without a test. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For additional commands, e-mail: issues-h...@iceberg.apache.org
