Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit db43e47

Browse files
ByronByron
committed
share and pass cli arguments for pack verification (#287)
1 parent 4b4f9f8 commit db43e47

3 files changed

Lines changed: 99 additions & 42 deletions

File tree

‎gitoxide-core/src/repository.rs‎

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,49 @@ pub fn init(directory: Option<PathBuf>) -> Result<git_repository::Path> {
88
}
99

1010
pub mod verify {
11+
use crate::pack;
12+
use crate::OutputFormat;
1113
use std::{path::PathBuf, sync::atomic::AtomicBool};
1214

1315
use git_repository::Progress;
1416

15-
use crate::OutputFormat;
17+
/// A general purpose context for many operations provided here
18+
pub struct Context {
19+
/// If set, provide statistics to `out` in the given format
20+
pub output_statistics: Option<OutputFormat>,
21+
/// If set, don't use more than this amount of threads.
22+
/// Otherwise, usually use as many threads as there are logical cores.
23+
/// A value of 0 is interpreted as no-limit
24+
pub thread_limit: Option<usize>,
25+
pub verify_mode: pack::verify::Mode,
26+
pub algorithm: pack::verify::Algorithm,
27+
}
1628

1729
pub const PROGRESS_RANGE: std::ops::RangeInclusive<u8> = 1..=3;
1830

1931
pub fn integrity(
2032
repo: PathBuf,
21-
_format: OutputFormat,
2233
_out: impl std::io::Write,
2334
progress: impl Progress,
2435
should_interrupt: &AtomicBool,
36+
Context {
37+
output_statistics: _,
38+
thread_limit,
39+
verify_mode,
40+
algorithm,
41+
}: Context,
2542
) -> anyhow::Result<()> {
2643
let repo = git_repository::open(repo)?;
27-
// TODO: a way to get the pack cache from a handle
2844
repo.objects.verify_integrity(
2945
progress,
3046
should_interrupt,
31-
git_repository::odb::pack::index::verify::integrity::Options::default(),
47+
git_repository::odb::pack::index::verify::integrity::Options {
48+
verify_mode,
49+
traversal: algorithm.into(),
50+
thread_limit,
51+
// TODO: a way to get the pack cache from a handle
52+
make_pack_lookup_cache: || git_repository::odb::pack::cache::Never,
53+
},
3254
)?;
3355
Ok(())
3456
}

‎src/plumbing/main.rs‎

Lines changed: 38 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -74,14 +74,34 @@ pub fn main() -> Result<()> {
7474

7575
match cmd {
7676
Subcommands::Repository(subcommands) => match subcommands {
77-
repo::Subcommands::Verify { repository } => prepare_and_run(
77+
repo::Subcommands::Verify {
78+
args:
79+
pack::VerifyOptions {
80+
statistics,
81+
algorithm,
82+
decode,
83+
re_encode,
84+
},
85+
repository,
86+
} => prepare_and_run(
7887
"repository-verify",
7988
verbose,
8089
progress,
8190
progress_keep_open,
8291
core::repository::verify::PROGRESS_RANGE,
8392
move |progress, out, _err| {
84-
core::repository::verify::integrity(repository, format, out, progress, &should_interrupt)
93+
core::repository::verify::integrity(
94+
repository,
95+
out,
96+
progress,
97+
&should_interrupt,
98+
core::repository::verify::Context {
99+
output_statistics: statistics.then(|| format),
100+
algorithm,
101+
verify_mode: verify_mode(decode, re_encode),
102+
thread_limit,
103+
},
104+
)
85105
},
86106
),
87107
},
@@ -223,23 +243,22 @@ pub fn main() -> Result<()> {
223243
},
224244
),
225245
pack::Subcommands::Verify {
246+
args:
247+
pack::VerifyOptions {
248+
algorithm,
249+
decode,
250+
re_encode,
251+
statistics,
252+
},
226253
path,
227-
algorithm,
228-
decode,
229-
re_encode,
230-
statistics,
231254
} => prepare_and_run(
232255
"pack-verify",
233256
verbose,
234257
progress,
235258
progress_keep_open,
236259
verify::PROGRESS_RANGE,
237260
move |progress, out, err| {
238-
let mode = match (decode, re_encode) {
239-
(true, false) => verify::Mode::HashCrc32Decode,
240-
(true, true) | (false, true) => verify::Mode::HashCrc32DecodeEncode,
241-
(false, false) => verify::Mode::HashCrc32,
242-
};
261+
let mode = verify_mode(decode, re_encode);
243262
let output_statistics = if statistics { Some(format) } else { None };
244263
verify::pack_or_pack_index(
245264
path,
@@ -396,3 +415,11 @@ pub fn main() -> Result<()> {
396415
}?;
397416
Ok(())
398417
}
418+
419+
fn verify_mode(decode: bool, re_encode: bool) -> verify::Mode {
420+
match (decode, re_encode) {
421+
(true, false) => verify::Mode::HashCrc32Decode,
422+
(true, true) | (false, true) => verify::Mode::HashCrc32DecodeEncode,
423+
(false, false) => verify::Mode::HashCrc32,
424+
}
425+
}

‎src/plumbing/options.rs‎

Lines changed: 35 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -210,40 +210,46 @@ pub mod pack {
210210
/// Verify the integrity of a pack, index or multi-index file
211211
#[clap(setting = AppSettings::DisableVersionFlag)]
212212
Verify {
213-
/// output statistical information about the pack
214-
#[clap(long, short = 's')]
215-
statistics: bool,
216-
/// The algorithm used to verify the pack. They differ in costs.
217-
#[clap(
218-
long,
219-
short = 'a',
220-
default_value = "less-time",
221-
possible_values(core::pack::verify::Algorithm::variants())
222-
)]
223-
algorithm: core::pack::verify::Algorithm,
224-
225-
#[clap(long, conflicts_with("re-encode"))]
226-
/// Decode and parse tags, commits and trees to validate their correctness beyond hashing correctly.
227-
///
228-
/// Malformed objects should not usually occur, but could be injected on purpose or accident.
229-
/// This will reduce overall performance.
230-
decode: bool,
231-
232-
#[clap(long)]
233-
/// Decode and parse tags, commits and trees to validate their correctness, and re-encode them.
234-
///
235-
/// This flag is primarily to test the implementation of encoding, and requires to decode the object first.
236-
/// Encoding an object after decoding it should yield exactly the same bytes.
237-
/// This will reduce overall performance even more, as re-encoding requires to transform zero-copy objects into
238-
/// owned objects, causing plenty of allocation to occour.
239-
re_encode: bool,
213+
#[clap(flatten)]
214+
args: VerifyOptions,
240215

241216
/// The '.pack', '.idx' or 'multi-pack-index' file to validate.
242217
#[clap(parse(from_os_str))]
243218
path: PathBuf,
244219
},
245220
}
246221

222+
#[derive(Debug, clap::Parser)]
223+
pub struct VerifyOptions {
224+
/// output statistical information
225+
#[clap(long, short = 's')]
226+
pub statistics: bool,
227+
/// The algorithm used to verify packs. They differ in costs.
228+
#[clap(
229+
long,
230+
short = 'a',
231+
default_value = "less-time",
232+
possible_values(core::pack::verify::Algorithm::variants())
233+
)]
234+
pub algorithm: core::pack::verify::Algorithm,
235+
236+
#[clap(long, conflicts_with("re-encode"))]
237+
/// Decode and parse tags, commits and trees to validate their correctness beyond hashing correctly.
238+
///
239+
/// Malformed objects should not usually occur, but could be injected on purpose or accident.
240+
/// This will reduce overall performance.
241+
pub decode: bool,
242+
243+
#[clap(long)]
244+
/// Decode and parse tags, commits and trees to validate their correctness, and re-encode them.
245+
///
246+
/// This flag is primarily to test the implementation of encoding, and requires to decode the object first.
247+
/// Encoding an object after decoding it should yield exactly the same bytes.
248+
/// This will reduce overall performance even more, as re-encoding requires to transform zero-copy objects into
249+
/// owned objects, causing plenty of allocation to occour.
250+
pub re_encode: bool,
251+
}
252+
247253
///
248254
pub mod multi_index {
249255
use std::path::PathBuf;
@@ -330,6 +336,8 @@ pub mod repo {
330336
/// Verify the integrity of the entire repository
331337
#[clap(setting = AppSettings::DisableVersionFlag)]
332338
Verify {
339+
#[clap(flatten)]
340+
args: super::pack::VerifyOptions,
333341
#[clap(short = 'r', long, default_value = ".")]
334342
repository: PathBuf,
335343
},

0 commit comments

Comments
 (0)