Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(commands): Add option stdin_command to be used in CLI and config file #266

Merged
merged 15 commits into from
Sep 21, 2024

Conversation

aawsome
Copy link
Member

@aawsome aawsome commented Sep 15, 2024

Adds the option stdin_command to BackupOptions. This options starts the given command and reads its output as stdin if - is specified as backup source.

see rustic-rs/rustic#662

Copy link

codecov bot commented Sep 15, 2024

Codecov Report

Attention: Patch coverage is 54.54545% with 25 lines in your changes missing coverage. Please review.

Project coverage is 48.6%. Comparing base (ec3aa46) to head (05d1898).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
crates/core/src/commands/backup.rs 36.8% 12 Missing ⚠️
crates/core/src/backend.rs 50.0% 4 Missing ⚠️
crates/core/src/repository/command_input.rs 60.0% 4 Missing ⚠️
crates/core/src/backend/childstdout.rs 81.2% 3 Missing ⚠️
crates/core/src/backend/stdin.rs 0.0% 2 Missing ⚠️
Additional details and impacted files
Files with missing lines Coverage Δ
crates/core/src/error.rs 57.1% <ø> (ø)
crates/core/tests/integration.rs 77.7% <ø> (+0.8%) ⬆️
crates/core/src/backend/stdin.rs 0.0% <0.0%> (ø)
crates/core/src/backend/childstdout.rs 81.2% <81.2%> (ø)
crates/core/src/backend.rs 57.5% <50.0%> (+0.6%) ⬆️
crates/core/src/repository/command_input.rs 65.9% <60.0%> (+3.1%) ⬆️
crates/core/src/commands/backup.rs 62.5% <36.8%> (+3.4%) ⬆️

... and 20 files with indirect coverage changes

crates/core/src/backend/childstdout.rs Outdated Show resolved Hide resolved
crates/core/src/backend/childstdout.rs Outdated Show resolved Hide resolved
crates/core/src/repository/command_input.rs Outdated Show resolved Hide resolved
crates/core/src/backend/childstdout.rs Outdated Show resolved Hide resolved
crates/core/src/repository/command_input.rs Outdated Show resolved Hide resolved
@simonsan simonsan added A-commands Area: Related to commands in `rustic_core` A-config Area: Related to the configuration file labels Sep 21, 2024
@simonsan simonsan changed the title feat: backup: Add option stdin_command feat(commands): Add option stdin_command to be used in CLI and config file Sep 21, 2024
@simonsan simonsan added this pull request to the merge queue Sep 21, 2024
@simonsan simonsan removed this pull request from the merge queue due to a manual request Sep 21, 2024
@simonsan simonsan merged commit 43fffbe into main Sep 21, 2024
25 checks passed
@simonsan simonsan deleted the stdin-command branch September 21, 2024 14:34
@simonsan simonsan mentioned this pull request Sep 21, 2024
@rustic-release-plz rustic-release-plz bot mentioned this pull request Sep 23, 2024
simonsan pushed a commit that referenced this pull request Sep 23, 2024
## 🤖 New release
* `rustic_backend`: 0.2.1 -> 0.3.0 (⚠️ API breaking changes)
* `rustic_core`: 0.3.1 -> 0.4.0 (⚠️ API breaking changes)
* `rustic_config`: 0.2.0 -> 0.2.1 (✓ API compatible changes)

### ⚠️ `rustic_backend` breaking changes

```
--- failure enum_variant_missing: pub enum variant removed or renamed ---

Description:
A publicly-visible enum has at least one variant that is no longer available under its prior name. It may have been renamed or removed entirely.
        ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove
       impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.35.0/src/lints/enum_variant_missing.ron

Failed in:
  variant LocalBackendErrorKind::FromSplitError, previously in file /tmp/.tmpAmQX0r/rustic_backend/src/error.rs:109
```

### ⚠️ `rustic_core` breaking changes

```
--- failure constructible_struct_adds_field: externally-constructible struct adds field ---

Description:
A pub struct constructible with a struct literal has a new pub field. Existing struct literals must be updated to include the new field.
        ref: https://doc.rust-lang.org/reference/expressions/struct-expr.html
       impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.35.0/src/lints/constructible_struct_adds_field.ron

Failed in:
  field LocalSourceFilterOptions.globs in /tmp/.tmpyfzyFf/rustic_core/crates/core/src/backend/ignore.rs:73
  field LocalSourceFilterOptions.iglobs in /tmp/.tmpyfzyFf/rustic_core/crates/core/src/backend/ignore.rs:78
  field LocalSourceFilterOptions.glob_files in /tmp/.tmpyfzyFf/rustic_core/crates/core/src/backend/ignore.rs:83
  field LocalSourceFilterOptions.iglob_files in /tmp/.tmpyfzyFf/rustic_core/crates/core/src/backend/ignore.rs:88
  field LocalSourceFilterOptions.custom_ignorefiles in /tmp/.tmpyfzyFf/rustic_core/crates/core/src/backend/ignore.rs:106

--- failure inherent_method_missing: pub method removed or renamed ---

Description:
A publicly-visible method or associated fn is no longer available under its prior name. It may have been renamed or removed entirely.
        ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove
       impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.35.0/src/lints/inherent_method_missing.ron

Failed in:
  SnapshotOptions::tag, previously in file /tmp/.tmpAmQX0r/rustic_core/src/repofile/snapshotfile.rs:46
  LocalSourceFilterOptions::glob, previously in file /tmp/.tmpAmQX0r/rustic_core/src/backend/ignore.rs:65
  LocalSourceFilterOptions::iglob, previously in file /tmp/.tmpAmQX0r/rustic_core/src/backend/ignore.rs:65
  LocalSourceFilterOptions::glob_file, previously in file /tmp/.tmpAmQX0r/rustic_core/src/backend/ignore.rs:65
  LocalSourceFilterOptions::iglob_file, previously in file /tmp/.tmpAmQX0r/rustic_core/src/backend/ignore.rs:65
  LocalSourceFilterOptions::custom_ignorefile, previously in file /tmp/.tmpAmQX0r/rustic_core/src/backend/ignore.rs:65

--- failure method_parameter_count_changed: pub method parameter count changed ---

Description:
A publicly-visible method now takes a different number of parameters.
        ref: https://doc.rust-lang.org/cargo/reference/semver.html#fn-change-arity
       impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.35.0/src/lints/method_parameter_count_changed.ron

Failed in:
  rustic_core::Repository::list now takes 1 parameters instead of 2, in /tmp/.tmpyfzyFf/rustic_core/crates/core/src/repository.rs:689
  rustic_core::Repository::get_index_entry now takes 2 parameters instead of 3, in /tmp/.tmpyfzyFf/rustic_core/crates/core/src/repository.rs:1480

--- failure struct_pub_field_missing: pub struct's pub field removed or renamed ---

Description:
A publicly-visible struct has at least one public field that is no longer available under its prior name. It may have been renamed or removed entirely.
        ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove
       impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.35.0/src/lints/struct_pub_field_missing.ron

Failed in:
  field tag of struct SnapshotOptions, previously in file /tmp/.tmpAmQX0r/rustic_core/src/repofile/snapshotfile.rs:59
  field glob of struct LocalSourceFilterOptions, previously in file /tmp/.tmpAmQX0r/rustic_core/src/backend/ignore.rs:74
  field iglob of struct LocalSourceFilterOptions, previously in file /tmp/.tmpAmQX0r/rustic_core/src/backend/ignore.rs:80
  field glob_file of struct LocalSourceFilterOptions, previously in file /tmp/.tmpAmQX0r/rustic_core/src/backend/ignore.rs:86
  field iglob_file of struct LocalSourceFilterOptions, previously in file /tmp/.tmpAmQX0r/rustic_core/src/backend/ignore.rs:92
  field custom_ignorefile of struct LocalSourceFilterOptions, previously in file /tmp/.tmpAmQX0r/rustic_core/src/backend/ignore.rs:108

--- failure trait_associated_type_added: non-sealed public trait added associated type without default value ---

Description:
A non-sealed trait has gained an associated type without a default value, which breaks downstream implementations of the trait
        ref: https://doc.rust-lang.org/cargo/reference/semver.html#trait-new-item-no-default
       impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.35.0/src/lints/trait_associated_type_added.ron

Failed in:
  trait associated type rustic_core::repofile::RepoFile::Id in file /tmp/.tmpyfzyFf/rustic_core/crates/core/src/repofile.rs:16

--- failure trait_no_longer_object_safe: trait no longer object safe ---

Description:
Trait is no longer object safe, which breaks `dyn Trait` usage.
        ref: https://doc.rust-lang.org/stable/reference/items/traits.html#object-safety
       impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.35.0/src/lints/trait_no_longer_object_safe.ron

Failed in:
  trait IndexedIds in file /tmp/.tmpyfzyFf/rustic_core/crates/core/src/repository.rs:1300
  trait IndexedTree in file /tmp/.tmpyfzyFf/rustic_core/crates/core/src/repository.rs:1287
```

<details><summary><i><b>Changelog</b></i></summary><p>

## `rustic_backend`
<blockquote>

##
[0.3.0](rustic_backend-v0.2.1...rustic_backend-v0.3.0)
- 2024-09-23

### Added

- [**breaking**] Use CommandInput for commands
([#269](#269))

### Other

- remove readme versions in usage section for easier release due to
release PR ([#271](#271))
- [**breaking**] Use different Id types
([#256](#256))
- *(deps)* Update opendal
([#268](#268))
</blockquote>

## `rustic_core`
<blockquote>

##
[0.4.0](rustic_core-v0.3.1...rustic_core-v0.4.0)
- 2024-09-23

### Added

- make IndexPack::pack_size() public
- Add Repository::drop_index and ::drop_data_from_index
([#166](#166))
- *(commands)* Add option stdin_command to be used in CLI and config
file ([#266](#266))
- [**breaking**] Use CommandInput for commands
([#269](#269))
- Add CommandInput
([#252](#252))

### Fixed

- de/serialize tags as DisplayFromStr
([#270](#270))
- [**breaking**] use plural names for options
([#267](#267))
- fix clippy lint
- *(test)* shorten snapshot names for windows environment
- [**breaking**] improve password-command error reporting
([#265](#265))
- properly finish progress bar in Repository::get_snapshot_group
([#263](#263))

### Other

- remove readme versions in usage section for easier release due to
release PR ([#271](#271))
- [**breaking**] Use different Id types
([#256](#256))
- Use serde_with::skip_serializing_none instead of manual mapping
([#251](#251))
</blockquote>

## `rustic_config`
<blockquote>

##
[0.2.1](rustic_config-v0.2.0...rustic_config-v0.2.1)
- 2024-09-23

### Other

- remove readme versions in usage section for easier release due to
release PR ([#271](#271))
</blockquote>


</p></details>

---
This PR was generated with
[release-plz](https://github.com/MarcoIeni/release-plz/).

Co-authored-by: rustic-release-plz[bot] <182542030+rustic-release-plz[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-commands Area: Related to commands in `rustic_core` A-config Area: Related to the configuration file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants