diff --git a/.github/workflows/release-ci.yml b/.github/workflows/release-ci.yml index 6f204533..5fb8b2a6 100644 --- a/.github/workflows/release-ci.yml +++ b/.github/workflows/release-ci.yml @@ -5,6 +5,9 @@ on: branches: - "release/**" +env: + BRANCH_NAME: ${{ github.head_ref || github.ref_name }} + jobs: semver-check: name: Check SemVer @@ -25,9 +28,16 @@ jobs: - uses: Swatinem/rust-cache@23bce251a8cd2ffc3c1075eaa2367cf899916d84 # v2 - name: Check semver + if: contains(env.BRANCH_NAME, 'rustic_core') uses: obi1kenobi/cargo-semver-checks-action@e275dda72e250d4df5b564e969e1348d67fefa52 # v2 with: package: rustic_core + + - name: Check semver + if: contains(env.BRANCH_NAME, 'rustic_backend') + uses: obi1kenobi/cargo-semver-checks-action@e275dda72e250d4df5b564e969e1348d67fefa52 # v2 + with: + package: rustic_backend public-api: name: Check for breaking Public API changes @@ -57,7 +67,9 @@ jobs: with: toolchain: stable - uses: Swatinem/rust-cache@23bce251a8cd2ffc3c1075eaa2367cf899916d84 # v2 + # FIXME: For now this is only for rustic core, we need to decide if we want to run this branched for each package - name: Run Cargo Test + if: contains(env.BRANCH_NAME, 'rustic_core') run: cargo test -r --test public_api -- --ignored result: diff --git a/Cargo.toml b/Cargo.toml index 8a227f05..6aaee099 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -6,8 +6,8 @@ resolver = "2" rust-version = "1.71.1" [workspace.dependencies] -rustic_backend = { path = "crates/backend" } -rustic_core = { path = "crates/core" } +rustic_backend = { git = "https://github.com/rustic-rs/rustic_core/" } +rustic_core = { git = "https://github.com/rustic-rs/rustic_core/" } simplelog = "0.12.1" # see: https://nnethercote.github.io/perf-book/build-configuration.html diff --git a/crates/backend/CHANGELOG.md b/crates/backend/CHANGELOG.md new file mode 100644 index 00000000..1286e2c4 --- /dev/null +++ b/crates/backend/CHANGELOG.md @@ -0,0 +1,29 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +## [rustic_backend-v0.1.1] - 2024-02-02 + +### Documentation + +- Fix c&p for SftpBackend +- Update examples and other minor things + +### Features + +- Add options rclone-command, use-password, rest-url to rclone backend + ([#139](https://github.com/rustic-rs/rustic_core/issues/139)) + +### Miscellaneous Tasks + +- Add rustic_backend to release-pr workflow + +### Backend + +- Add sftp backend ([#126](https://github.com/rustic-rs/rustic_core/issues/126)) + +## [rustic_backend-v0.1.0] - 2023-08-10 + +- Reserving name on crates.io + + diff --git a/crates/backend/Cargo.toml b/crates/backend/Cargo.toml index 6b2684c2..e72763a4 100644 --- a/crates/backend/Cargo.toml +++ b/crates/backend/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "rustic_backend" -version = "0.1.0" +version = "0.1.1" authors = ["the rustic-rs team"] categories = ["Algorithms", "Data structures", "Filesystem"] documentation = "https://docs.rs/rustic_backend" @@ -44,7 +44,7 @@ sftp = ["opendal"] [dependencies] # core -rustic_core = { path = "../core" } +rustic_core = "0.2" # errors anyhow = "1.0.79" @@ -58,13 +58,13 @@ log = "0.4.20" bytes = "1.5.0" derive_setters = "0.1.6" humantime = "2.1.0" -itertools = "0.12.0" -strum = "0.25" -strum_macros = "0.25" +itertools = "0.12.1" +strum = "0.26" +strum_macros = "0.26" # general / backend choosing hex = { version = "0.4.3", features = ["serde"] } -serde = { version = "1.0.195" } +serde = { version = "1.0.196" } url = "2.5.0" # cli support @@ -78,7 +78,7 @@ walkdir = "2.4.0" # rest backend backoff = { version = "0.4.0", optional = true } -reqwest = { version = "0.11.23", default-features = false, features = ["json", "rustls-tls-native-roots", "stream", "blocking"], optional = true } +reqwest = { version = "0.11.24", default-features = false, features = ["json", "rustls-tls-native-roots", "stream", "blocking"], optional = true } # rclone backend rand = { version = "0.8.5", optional = true } diff --git a/crates/backend/LICENSE-APACHE b/crates/backend/LICENSE-APACHE new file mode 100644 index 00000000..d6456956 --- /dev/null +++ b/crates/backend/LICENSE-APACHE @@ -0,0 +1,202 @@ + + 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. diff --git a/crates/backend/LICENSE-MIT b/crates/backend/LICENSE-MIT new file mode 100644 index 00000000..593aed5a --- /dev/null +++ b/crates/backend/LICENSE-MIT @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2022 Alexander Weiss + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/crates/backend/README.md b/crates/backend/README.md new file mode 100644 index 00000000..ed421026 --- /dev/null +++ b/crates/backend/README.md @@ -0,0 +1,119 @@ +

+ +

+

Library for supporting various backends in rustic

+

+ + + + +

+ +## About + +This library is a part of the [rustic](https://rustic.cli.rs) project and +provides a set of backends for the +[`rustic_core`](https://crates.io/crates/rustic_core) library. It is used to +interact with various storage backends, such as `s3`, `rclone`, `rest`, `sftp`, +and in general `opendal`. + +The goal of this library is to provide a unified interface for interacting with +various backends, so that the +[`rustic_core`](https://crates.io/crates/rustic_core) library can be used to +interact with them in a consistent way. + +**Note**: `rustic_backend` is in an early development stage and its API is +subject to change in the next releases. If you want to give feedback on that, +please open an [issue](https://github.com/rustic-rs/rustic_core/issues). + +## Contact + +You can ask questions in the +[Discussions](https://github.com/rustic-rs/rustic/discussions) or have a look at +the [FAQ](https://rustic.cli.rs/docs/FAQ.html). + +| Contact | Where? | +| ------------- | --------------------------------------------------------------------------------------------------------------- | +| Issue Tracker | [GitHub Issues](https://github.com/rustic-rs/rustic_core/issues/choose) | +| Discord | [![Discord](https://dcbadge.vercel.app/api/server/WRUWENZnzQ?style=flat-square)](https://discord.gg/WRUWENZnzQ) | +| Discussions | [GitHub Discussions](https://github.com/rustic-rs/rustic/discussions) | + +## Usage + +Add this to your `Cargo.toml`: + +```toml +[dependencies] +rustic_backend = "0.1" +``` + +## Crate features + +This crate exposes a few features for controlling dependency usage: + +- **cli** - Enables support for CLI features by enabling `merge` and `clap` + features. *This feature is disabled by default*. + +- **clap** - Enables a dependency on the `clap` crate and enables parsing from + the commandline. *This feature is disabled by default*. + +- **merge** - Enables support for merging multiple values into one, which + enables the `merge` dependency. This is needed for parsing commandline + arguments and merging them into one (e.g. `config`). *This feature is disabled + by default*. + +### Backend-related features + +- **opendal** - Enables support for the `opendal` backend. *This feature is + enabled by default*. +- **rclone** - Enables support for the `rclone` backend. *This feature is + enabled by default*. + +- **rest** - Enables support for the `rest` backend. *This feature is enabled by + default*. + +- **sftp** - Enables support for the `sftp` backend. Windows is not yet + supported. *This feature is enabled by default*. + +- **s3** - Enables support for the `s3` backend. *This feature is enabled by + default*. + +## Usage & Examples + +Due to being a support crate for +[`rustic_core`](https://crates.io/crates/rustic_core), there are no examples +here. Please check the examples in the +[`rustic_core`](https://crates.io/crates/rustic_core) crate. + +## Contributing + +Found a bug? +[Open an issue!](https://github.com/rustic-rs/rustic_core/issues/choose) + +Got an idea for an improvement? Don't keep it to yourself! + +- [Contribute fixes](https://github.com/rustic-rs/rustic_core/contribute) or new + features via a pull requests! + +Please make sure, that you read the +[contribution guide](https://rustic.cli.rs/docs/contributing-to-rustic.html). + +## Minimum Rust version policy + +This crate's minimum supported `rustc` version is `1.71.1`. + +The current policy is that the minimum Rust version required to use this crate +can be increased in minor version updates. For example, if `crate 1.0` requires +Rust 1.20.0, then `crate 1.0.z` for all values of `z` will also require Rust +1.20.0 or newer. However, `crate 1.y` for `y > 0` may require a newer minimum +version of Rust. + +In general, this crate will be conservative with respect to the minimum +supported version of Rust. + +## License + +Licensed under either of: + +- [Apache License, Version 2.0](./LICENSE-APACHE) +- [MIT license](./LICENSE-MIT) diff --git a/crates/backend/src/choose.rs b/crates/backend/src/choose.rs index 505918d7..6e4b1f1c 100644 --- a/crates/backend/src/choose.rs +++ b/crates/backend/src/choose.rs @@ -1,4 +1,4 @@ -//! This module contains the trait [`BackendChoice`] and the function [`get_backend`] to choose a backend from a given url. +//! This module contains [`BackendOptions`] and helpers to choose a backend from a given url. use anyhow::{anyhow, Result}; use derive_setters::Setters; use std::{collections::HashMap, sync::Arc}; @@ -67,7 +67,7 @@ pub struct BackendOptions { /// Overwrite the left value with the right value /// -/// This is used for merging [`RepositoryOptions`] and [`ConfigOptions`] +/// This is used for merging config values, e.g. [`BackendOptions`]. /// /// # Arguments /// diff --git a/crates/backend/src/lib.rs b/crates/backend/src/lib.rs index 653d5fcc..72863ed5 100644 --- a/crates/backend/src/lib.rs +++ b/crates/backend/src/lib.rs @@ -1,3 +1,64 @@ +/*! +A library for supporting various backends in rustic. + +# Overview + +This section gives a brief overview of the primary types in this crate: + +`rustic_backend` is a support crate for `rustic_core` which provides a way to access a +repository using different backends. + +The primary types in this crate are: + +- `BackendOptions` - A struct for configuring options for a used backend. +- `SupportedBackend` - An enum for the supported backends. + +The following backends are currently supported and can be enabled with features: + +- `LocalBackend` - Backend for accessing a local filesystem. +- `OpenDALBackend` - Backend for accessing a OpenDAL filesystem. +- `RcloneBackend` - Backend for accessing a Rclone filesystem. +- `RestBackend` - Backend for accessing a REST API. +- `SftpBackend` - Backend for accessing a SFTP filesystem. +- `S3Backend` - Backend for accessing a S3 filesystem. + +## Usage & Examples + +Due to being a support crate for `rustic_core`, there are no examples here. +Please check the examples in the [`rustic_core`](https://crates.io/crates/rustic_core) crate. + +## Crate features + +This crate exposes a few features for controlling dependency usage: + +- **cli** - Enables support for CLI features by enabling `merge` and `clap` + features. *This feature is disabled by default*. + +- **clap** - Enables a dependency on the `clap` crate and enables parsing from + the commandline. *This feature is disabled by default*. + +- **merge** - Enables support for merging multiple values into one, which + enables the `merge` dependency. This is needed for parsing commandline + arguments and merging them into one (e.g. `config`). *This feature is disabled + by default*. + +### Backend-related features + +- **opendal** - Enables support for the `opendal` backend. *This feature is + enabled by default*. +- **rclone** - Enables support for the `rclone` backend. *This feature is + enabled by default*. + +- **rest** - Enables support for the `rest` backend. *This feature is enabled by + default*. + +- **sftp** - Enables support for the `sftp` backend. Windows is not yet + supported. *This feature is enabled by default*. + +- **s3** - Enables support for the `s3` backend. *This feature is enabled by + default*. +*/ + pub mod choose; pub mod error; pub mod local;