opendal 0.1.6.pre.rc.1

data/test/blocking_op_test.rb

@@ -0,0 +1,112 @@
+# 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.
+
+# frozen_string_literal: true
+
+require "test_helper"
+require "tmpdir"
+
+class OpenDalTest < ActiveSupport::TestCase
+  setup do
+    @root = Dir.mktmpdir
+    File.write("#{@root}/sample", "Sample data for testing")
+    @op = OpenDal::Operator.new("fs", {"root" => @root})
+  end
+
+  teardown do
+    FileUtils.remove_entry(@root) if File.exist?(@root)
+  end
+
+  test "write writes to a file" do
+    @op.write("/file", "OpenDAL Ruby is ready.")
+
+    assert_equal "OpenDAL Ruby is ready.", File.read("/#{@root}/file")
+  end
+
+  test "write writes binary" do
+    # writes 32-bit signed integers
+    @op.write("/file", [67305985, -50462977].pack("l*"))
+
+    assert_equal [67305985, -50462977], File.binread("/#{@root}/file").unpack("l*")
+  end
+
+  test "read reads file data" do
+    data = @op.read("/sample")
+
+    assert_equal "Sample data for testing", data
+  end
+
+  test "stat returns file metadata" do
+    stat = @op.stat("sample")
+
+    assert stat.is_a?(OpenDal::Metadata)
+    assert_equal 23, stat.content_length
+    assert stat.file?
+  end
+
+  test "create_dir creates directory" do
+    @op.create_dir("/new/directory/")
+    assert File.directory?("#{@root}/new/directory/")
+  end
+
+  test "exists returns existence" do
+    assert @op.exist?("sample")
+  end
+
+  test "delete removes file" do
+    @op.delete("/sample")
+
+    assert_not File.exist?("#{@root}/sample")
+  end
+
+  test "rename renames file" do
+    @op.rename("/sample", "/new_name")
+
+    assert_not File.exist?("#{@root}/sample")
+    assert File.exist?("#{@root}/new_name")
+  end
+
+  test "remove_all removes files" do
+    @op.create_dir("/nested/directory/")
+    @op.write("/nested/directory/text", "content")
+
+    @op.remove_all("/")
+
+    assert_not File.exist?(@root)
+  end
+
+  test "copy copies file" do
+    @op.copy("/sample", "/new_name")
+
+    assert File.exist?("#{@root}/sample")
+    assert File.exist?("#{@root}/new_name")
+  end
+
+  test "opens an IO" do
+    io = @op.open("/sample", "rb")
+
+    assert_not io.closed?
+
+    io.close
+  end
+
+  test "middleware applies a middleware" do
+    @op.middleware(OpenDal::Middleware::Retry.new)
+
+    assert @op.is_a?(OpenDal::Operator)
+  end
+end

data/test/capability_test.rb

@@ -0,0 +1,42 @@
+# 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.
+
+# frozen_string_literal: true
+
+require "test_helper"
+
+class CapabilityTest < ActiveSupport::TestCase
+  setup do
+    @op = OpenDal::Operator.new("memory", nil)
+  end
+
+  test "has read capability" do
+    capability = @op.capability
+
+    assert_not capability.nil?
+    assert capability.read
+  end
+
+  test "doesn't respond to undefined capability" do
+    capability = @op.capability
+
+    assert_not capability.nil?
+    assert_raises(NoMethodError) do
+      capability.not_exist
+    end
+  end
+end

data/test/io_test.rb

@@ -0,0 +1,172 @@
+# 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.
+
+# frozen_string_literal: true
+
+require "test_helper"
+require "tmpdir"
+
+class IOTest < ActiveSupport::TestCase
+  setup do
+    @root = Dir.mktmpdir
+    File.write(
+      "#{@root}/sample",
+      <<~EOF
+        Sample data for testing
+        A line after title
+      EOF
+    )
+    @op = OpenDal::Operator.new("fs", {"root" => @root})
+    @io_read = @op.open("sample", "r")
+    @io_write = @op.open("sample_write", "w")
+  end
+
+  teardown do
+    @io_read.close
+    @io_write.close
+    FileUtils.remove_entry(@root) if File.exist?(@root)
+  end
+
+  test "#binmode? returns" do
+    assert_not @io_read.binmode?
+  end
+
+  test "#binmode returns" do
+    assert_nothing_raised do
+      @io_read.binmode
+    end
+  end
+
+  test "#close closes IO" do
+    assert_nothing_raised do
+      @io_read.close
+    end
+  end
+
+  test "#close_read closes reader" do
+    assert_nothing_raised do
+      @io_read.close_read
+    end
+  end
+
+  test "#close_write closes writer" do
+    assert_nothing_raised do
+      @io_read.close_write
+    end
+  end
+
+  test "#closed? returns" do
+    assert_not @io_read.closed?
+  end
+
+  test "#closed_read? returns" do
+    assert_not @io_read.closed_read?
+  end
+
+  test "#closed_write? returns" do
+    assert @io_read.closed_write?
+  end
+
+  test "#read reads" do
+    result = @io_read.read
+
+    assert_equal "Sample data for testing\nA line after title\n", result
+    # should be `assert_equal Encoding::UTF_8, result.encoding`
+  end
+
+  test "#read reads with nil" do
+    result = @io_read.read(nil)
+
+    assert_equal "Sample data for testing\nA line after title\n", result
+  end
+
+  test "#read reads with size" do
+    result = @io_read.read(6)
+
+    assert_equal "Sample", result
+  end
+
+  test "#read raises ArgumentError with -1" do
+    assert_raise(ArgumentError) do |err|
+      @io_read.read(-1)
+
+      assert_equal "negative length -1 given", err.message
+    end
+  end
+
+  test "#read reads to a buffer" do
+    buffer = +"hi " # unfreezes string literal
+    result = @io_read.read(6, buffer)
+
+    assert_equal "Sample", result
+    assert_equal "hi Sample", buffer
+  end
+
+  test "#write writes" do
+    @io_write.write("This is a sentence.")
+    @io_write.close
+    assert_equal "This is a sentence.", File.read("#{@root}/sample_write")
+  end
+
+  test "#readline reads a line" do
+    line = @io_read.readline
+
+    assert_equal "Sample data for testing\n", line
+    # should be `assert_equal Encoding::UTF_8, line.encoding`
+  end
+
+  test "#readlines reads all lines" do
+    lines = @io_read.readlines
+
+    assert_equal ["Sample data for testing\n", "A line after title\n"], lines
+    # should be `assert_equal Encoding::UTF_8, lines.first.encoding`
+  end
+
+  test "#tell returns position" do
+    assert_equal 0, @io_read.tell
+  end
+
+  test "#pos= moves position" do
+    @io_read.pos = 5
+
+    assert_equal 5, @io_read.pos
+  end
+
+  test "#rewind moves position to start" do
+    @io_read.pos = 5
+    @io_read.rewind
+
+    assert_equal 0, @io_read.pos
+  end
+
+  test "#eof returns" do
+    assert_not @io_read.eof
+  end
+
+  test "#eof? returns" do
+    @io_read.read
+    assert @io_read.eof?
+  end
+
+  test "#length returns" do
+    assert_equal 43, @io_read.length
+  end
+
+  test "#size returns" do
+    assert_equal 43, @io_read.size
+  end
+end

data/test/lister_test.rb

@@ -0,0 +1,77 @@
+# 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.
+
+# frozen_string_literal: true
+
+require "test_helper"
+require "tmpdir"
+
+class ListerTest < ActiveSupport::TestCase
+  setup do
+    @root = Dir.mktmpdir
+    File.write("#{@root}/sample", "Sample data for testing")
+    Dir.mkdir("#{@root}/sub")
+    File.write("#{@root}/sub/sample", "Sample data for testing")
+    @op = OpenDal::Operator.new("fs", {"root" => @root})
+  end
+
+  test "lists the directory" do
+    lister = @op.list("")
+
+    lists = lister.map(&:to_h).map { |e| e[:path] }.sort
+
+    assert_equal ["/", "sample", "sub/"], lists
+  end
+
+  test "list returns the entry" do
+    entry = @op.list("/").first
+
+    assert entry.is_a?(OpenDal::Entry)
+    assert entry.name.length > 0
+  end
+
+  test "entry has the metadata" do
+    metadata = @op.list("sample").first.metadata
+
+    assert metadata.file?
+    assert !metadata.dir?
+  end
+
+  test "lists the directory recursively" do
+    lister = @op.list("", recursive: true)
+
+    lists = lister.map(&:to_h).map { |e| e[:path] }.sort
+
+    assert_equal ["/", "sample", "sub/", "sub/sample"], lists
+  end
+
+  test "lists the directory with limit" do
+    lister = @op.list("", limit: 1)
+
+    lists = lister.map(&:to_h).map { |e| e[:path] }.sort
+
+    assert_equal ["/", "sample", "sub/"], lists
+  end
+
+  test "lists the directory with start_after" do
+    lister = @op.list("", start_after: "sub/")
+
+    lists = lister.map(&:to_h).map { |e| e[:path] }.sort
+
+    assert_equal ["/", "sample", "sub/"], lists # fs backend doesn't support start_after
+  end
+end

data/test/metadata_test.rb

@@ -0,0 +1,78 @@
+# 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.
+
+# frozen_string_literal: true
+
+require "test_helper"
+
+class MetadataTest < ActiveSupport::TestCase
+  setup do
+    @op = OpenDal::Operator.new("memory", {})
+    @op.write("/file", "OpenDAL Ruby is ready.")
+  end
+
+  test "returns metadata" do
+    metadata = @op.stat("file")
+
+    assert_nothing_raised do
+      metadata.inspect
+    end
+  end
+
+  test "#file? works" do
+    metadata = @op.stat("file")
+
+    assert metadata.file?
+  end
+
+  test "#dir? works" do
+    metadata = @op.stat("/")
+    assert metadata.dir?
+
+    assert !@op.stat("file").dir?
+  end
+
+  test "#mode works" do
+    metadata = @op.stat("file")
+    assert_equal OpenDal::Metadata::FILE, metadata.mode
+  end
+
+  test "#content_disposition works" do
+    metadata = @op.stat("file")
+    assert_nil metadata.content_disposition
+  end
+
+  test "#content_length works" do
+    metadata = @op.stat("file")
+    assert_equal 22, metadata.content_length
+  end
+
+  test "#content_md5 works" do
+    metadata = @op.stat("file")
+    assert_nil metadata.content_md5
+  end
+
+  test "#content_type works" do
+    metadata = @op.stat("file")
+    assert_nil metadata.content_type
+  end
+
+  test "#etag works" do
+    metadata = @op.stat("file")
+    assert_nil metadata.etag
+  end
+end

data/test/middlewares_test.rb

@@ -0,0 +1,46 @@
+# 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.
+
+# frozen_string_literal: true
+
+require "test_helper"
+
+class MiddlewaresTest < ActiveSupport::TestCase
+  test "builds a retry middleware" do
+    assert_nothing_raised do
+      OpenDal::Middleware::Retry.new
+    end
+  end
+
+  test "builds a concurrent limit middleware" do
+    assert_nothing_raised do
+      OpenDal::Middleware::ConcurrentLimit.new(10)
+    end
+  end
+
+  test "builds a throttle middleware" do
+    assert_nothing_raised do
+      OpenDal::Middleware::Throttle.new(100, 10)
+    end
+  end
+
+  test "builds a timeout middleware" do
+    assert_nothing_raised do
+      OpenDal::Middleware::Timeout.new(1.23, 1.0)
+    end
+  end
+end

data/test/operator_info_test.rb

@@ -0,0 +1,35 @@
+# 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.
+
+# frozen_string_literal: true
+
+require "test_helper"
+
+class OperatorInfoTest < ActiveSupport::TestCase
+  setup do
+    @op = OpenDal::Operator.new("memory", {})
+  end
+
+  test "returns meta information" do
+    info = @op.info
+
+    assert_equal "memory", info.scheme
+    assert_equal "/", info.root
+    assert info.name.length > 0
+    assert info.capability.stat
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,36 @@
+# 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.
+
+# frozen_string_literal: true
+
+require "active_support"
+require "minitest/autorun"
+require "minitest/reporters"
+
+Minitest::Reporters.use!([Minitest::Reporters::DefaultReporter.new(color: true)])
+
+require "opendal"
+
+# Uses `ActiveSupport::TestCase` for additional features including:
+# - additional assertions
+# - file fixtures
+# - parallel worker
+#
+# Read more https://edgeapi.rubyonrails.org/classes/ActiveSupport/TestCase.html
+class ActiveSupport::TestCase
+  parallelize(workers: :number_of_processors)
+end