opendal 0.1.8 → 0.1.9

data/core/testkit/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed 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.

data/core/testkit/NOTICE

@@ -0,0 +1,5 @@
+Apache OpenDAL
+Copyright 2023-2026 The Apache Software Foundation
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).

data/core/testkit/README.md

@@ -0,0 +1,25 @@
+# Apache OpenDAL™ Testkit
+
+`opendal-testkit` provides reusable test actions, data checkers, runtime setup,
+and service initialization helpers for Apache OpenDAL™ storage implementations.
+
+This crate is intended for service and integration tests. It is not required by
+applications using an OpenDAL operator.
+
+Add it as a development dependency:
+
+```shell
+cargo add --dev opendal-testkit
+```
+
+The `opendal` facade also re-exports the testkit behind its `tests` feature.
+
+## Documentation
+
+- [Rust API documentation](https://docs.rs/opendal-testkit)
+- [Behavior test guide](https://github.com/apache/opendal/tree/main/core/tests/behavior)
+- [Apache OpenDAL documentation](https://opendal.apache.org/docs/)
+
+## License
+
+Licensed under the Apache License, Version 2.0.

data/core/testkit/src/lib.rs

@@ -15,8 +15,10 @@
 // specific language governing permissions and limitations
 // under the License.
 
-//! Test harness and utilities for Apache OpenDAL.
-
+#![doc = include_str!("../README.md")]
+#![cfg_attr(docsrs, feature(doc_cfg))]
+#![cfg_attr(docsrs, doc(auto_cfg))]
+#![deny(missing_docs)]
 mod read;
 pub use read::ReadAction;
 pub use read::ReadChecker;

data/core/testkit/src/read.rs

@@ -22,28 +22,27 @@ use rand::rng;
 
 use crate::utils::sha256_digest;
 
-/// ReadAction represents a read action.
+/// A reader operation executed by [`ReadChecker`].
 #[derive(Debug, Clone, Copy, Eq, PartialEq)]
 pub enum ReadAction {
-    /// Read represents a read action with given input buf size.
+    /// Read `size` bytes beginning at `offset`.
     ///
-    /// # NOTE
-    ///
-    /// The size is the input buf size, it's possible that the actual read size is smaller.
+    /// The first field is the offset and the second field is the requested
+    /// size. A reader can return fewer bytes at the end of an object.
     Read(usize, usize),
 }
 
-/// ReadChecker is used to check the correctness of the read process.
+/// Generates reference data and verifies reads against it.
 pub struct ReadChecker {
-    /// Raw Data is the data we write to the storage.
+    /// Data that callers write to the storage before checking reads.
     raw_data: Bytes,
 }
 
 impl ReadChecker {
-    /// Create a new read checker by given size and range.
+    /// Create a checker containing `size` bytes of random reference data.
     ///
-    /// It's by design that we use a random generator to generate the raw data. The content of data
-    /// is not important, we only care about the correctness of the read process.
+    /// Random input makes the checker sensitive to misplaced or repeated data;
+    /// callers should not depend on the generated content.
     pub fn new(size: usize) -> Self {
         let mut rng = rng();
         let mut data = vec![0; size];
@@ -54,7 +53,7 @@ impl ReadChecker {
         Self { raw_data }
     }
 
-    /// Return the raw data of this read checker.
+    /// Return the reference data that should be written before a check.
     pub fn data(&self) -> Bytes {
         self.raw_data.clone()
     }
@@ -100,9 +99,9 @@ impl ReadChecker {
         }
     }
 
-    /// Check will check the correctness of the read process via given actions.
+    /// Execute `actions` and verify each result against the reference data.
     ///
-    /// Check will panic if any check failed.
+    /// This method panics if a read fails or returns incorrect data.
     pub async fn check(&mut self, r: Reader, actions: &[ReadAction]) {
         for action in actions {
             match *action {

data/core/testkit/src/write.rs

@@ -22,32 +22,31 @@ use rand::rng;
 
 use crate::utils::sha256_digest;
 
-/// WriteAction represents a read action.
+/// A writer operation used by write behavior tests.
 #[derive(Debug, Clone, Eq, PartialEq)]
 pub enum WriteAction {
-    /// Write represents a write action with given input buf size.
+    /// Write a buffer with the given size.
     ///
-    /// # NOTE
-    ///
-    /// The size is the input buf size, it's possible that the actual write size is smaller.
+    /// A writer can accept the buffer incrementally even though the action
+    /// supplies it as one logical chunk.
     Write(usize),
 }
 
-/// WriteAction is used to check the correctness of the write process.
+/// Generates write chunks and verifies the combined stored data.
 pub struct WriteChecker {
     chunks: Vec<Bytes>,
     data: Bytes,
 }
 
 impl WriteChecker {
-    /// Create a new WriteChecker with given size.
-    pub fn new(size: Vec<usize>) -> Self {
+    /// Create random chunks with the requested `sizes`.
+    pub fn new(sizes: Vec<usize>) -> Self {
         let mut rng = rng();
 
-        let mut chunks = Vec::with_capacity(size.len());
+        let mut chunks = Vec::with_capacity(sizes.len());
 
-        for i in size {
-            let mut bs = vec![0u8; i];
+        for size in sizes {
+            let mut bs = vec![0u8; size];
             rng.fill_bytes(&mut bs);
             chunks.push(Bytes::from(bs));
         }
@@ -63,12 +62,12 @@ impl WriteChecker {
         }
     }
 
-    /// Get the check's chunks.
+    /// Return the chunks to write, in order.
     pub fn chunks(&self) -> &[Bytes] {
         &self.chunks
     }
 
-    /// Check the correctness of the write process.
+    /// Verify that `actual` equals the concatenated generated chunks.
     pub fn check(&self, actual: &[u8]) {
         if actual != self.data.as_ref() {
             assert_eq!(

data/core/tests/behavior/async_list.rs

@@ -81,7 +81,7 @@ pub async fn test_check(op: Operator) -> Result<()> {
 pub async fn test_list_dir(op: Operator) -> Result<()> {
     let parent = uuid::Uuid::new_v4().to_string();
     let path = format!("{parent}/{}", uuid::Uuid::new_v4());
-    debug!("Generate a random file: {}", &path);
+    debug!("Generate a random file: {}", path);
     let (content, size) = gen_bytes(op.info().capability());
 
     op.write(&path, content).await.expect("write must succeed");
@@ -106,7 +106,7 @@ pub async fn test_list_dir(op: Operator) -> Result<()> {
 /// List prefix should return newly created file.
 pub async fn test_list_prefix(op: Operator) -> Result<()> {
     let path = uuid::Uuid::new_v4().to_string();
-    debug!("Generate a random file: {}", &path);
+    debug!("Generate a random file: {}", path);
     let (content, _) = gen_bytes(op.info().capability());
 
     op.write(&path, content).await.expect("write must succeed");

data/core/tests/behavior/async_presign.rs

@@ -43,7 +43,7 @@ pub fn tests(op: &Operator, tests: &mut Vec<Trial>) {
 /// Presign write should succeed.
 pub async fn test_presign_write(op: Operator) -> Result<()> {
     let path = uuid::Uuid::new_v4().to_string();
-    debug!("Generate a random file: {}", &path);
+    debug!("Generate a random file: {}", path);
     let (content, size) = gen_bytes(op.info().capability());
 
     let signed_req = op.presign_write(&path, Duration::from_secs(3600)).await?;
@@ -75,7 +75,7 @@ pub async fn test_presign_write(op: Operator) -> Result<()> {
 
 pub async fn test_presign_stat(op: Operator) -> Result<()> {
     let path = uuid::Uuid::new_v4().to_string();
-    debug!("Generate a random file: {}", &path);
+    debug!("Generate a random file: {}", path);
     let (content, size) = gen_bytes(op.info().capability());
     op.write(&path, content.clone())
         .await
@@ -105,7 +105,7 @@ pub async fn test_presign_stat(op: Operator) -> Result<()> {
 // Presign read should read content successfully.
 pub async fn test_presign_read(op: Operator) -> Result<()> {
     let path = uuid::Uuid::new_v4().to_string();
-    debug!("Generate a random file: {}", &path);
+    debug!("Generate a random file: {}", path);
     let (content, size) = gen_bytes(op.info().capability());
 
     op.write(&path, content.clone())
@@ -142,7 +142,7 @@ pub async fn test_presign_delete(op: Operator) -> Result<()> {
     }
 
     let path = uuid::Uuid::new_v4().to_string();
-    debug!("Generate a random file: {}", &path);
+    debug!("Generate a random file: {}", path);
     let (content, _size) = gen_bytes(op.info().capability());
     // create a file
     op.write(&path, content.clone())

data/core/tests/behavior/async_stat.rs

@@ -148,7 +148,7 @@ pub async fn test_stat_not_cleaned_path(op: Operator) -> Result<()> {
 
     op.write(&path, content).await.expect("write must succeed");
 
-    let meta = op.stat(&format!("//{}", &path)).await?;
+    let meta = op.stat(&format!("//{}", path)).await?;
     assert_eq!(meta.mode(), EntryMode::FILE);
     assert_eq!(meta.content_length(), size as u64);
 

data/core/tests/behavior/async_write.rs

@@ -119,7 +119,7 @@ pub async fn test_write_with_special_chars(op: Operator) -> Result<()> {
         return Ok(());
     }
 
-    let path = format!("{} !@#$%^&()_+-=;',.txt", uuid::Uuid::new_v4());
+    let path = format!("nested/{} !@#$%^&()_+-=;',.txt", uuid::Uuid::new_v4());
     let (path, content, size) = TEST_FIXTURE.new_file_with_path(op.clone(), &path);
 
     op.write(&path, content).await?;

data/core/users.md

@@ -5,6 +5,8 @@
 - [Databend](https://github.com/datafuselabs/databend/): A modern Elasticity and Performance cloud data warehouse.
 - [deepeth/mars](https://github.com/deepeth/mars): The powerful analysis platform to explore and visualize data from blockchain.
 - [GreptimeDB](https://github.com/GreptimeTeam/greptimedb): An open-source, cloud-native, distributed time-series database.
+- [kunobi-kache](https://github.com/kunobi-ninja/kache): Zero-copy, content-addressed Rust build cache for Rust, C/C++ and more.
+- [kvcache-ai/AgentENV](https://github.com/kvcache-ai/AgentENV): A distributed platform for running agent environments at scale.
 - [mozilla/sccache](https://github.com/mozilla/sccache/): `sccache` is [`ccache`](https://github.com/ccache/ccache) with cloud storage
 - [Noorle](https://noorle.com/): A managed runtime for AI agents; OpenDAL backs agents' files and memories on different storage providers.
 - [OctoBase](https://github.com/toeverything/OctoBase): the open-source database behind [AFFiNE](https://github.com/toeverything/affine), local-first, yet collaborative.

data/opendal.gemspec

@@ -65,8 +65,12 @@ Gem::Specification.new do |spec|
   # the unpacked files when Bundler loads this gemspec from an installed gem.
   spec.files = Dir.chdir(__dir__) do
     git_files = tracked_files_or_glob.call(__dir__).reject do |f|
-      f.start_with?(*%w[.bundle/ gems/ pkg/ target/ tmp/ .git/ vendor/]) || f.end_with?(*%w[.log .lock .tmp .bak]) || f == "."
+      f.start_with?(*%w[.bundle/ gems/ pkg/ target/ tmp/ .git/ vendor/]) ||
+        f.end_with?(*%w[.log .tmp .bak]) ||
+        (f.end_with?(".lock") && f != "Cargo.lock") ||
+        f == "."
     end
+    git_files |= ["Cargo.lock"] if File.file?("Cargo.lock")
 
     # When building release package, include core directory files for rake build
     distributed_core_dir = "core"