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

Skip to content

Commit bcde935

Browse files
ByronByron
committed
Fast-path multi-pack index verification in the CLI (#279)
1 parent 7517482 commit bcde935

5 files changed

Lines changed: 50 additions & 18 deletions

File tree

‎gitoxide-core/src/pack/multi_index.rs‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ use git_repository as git;
77

88
pub const PROGRESS_RANGE: std::ops::RangeInclusive<u8> = 1..=3;
99

10+
pub fn verify(multi_index_path: PathBuf, progress: impl Progress, should_interrupt: &AtomicBool) -> anyhow::Result<()> {
11+
git::odb::pack::multi_index::File::at(multi_index_path)?.verify_integrity_fast(progress, should_interrupt)?;
12+
Ok(())
13+
}
14+
1015
pub fn create(
1116
index_paths: Vec<PathBuf>,
1217
output_path: PathBuf,

‎src/plumbing/main.rs‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -243,6 +243,20 @@ pub fn main() -> Result<()> {
243243
)
244244
.map(|_| ()),
245245
pack::Subcommands::MultiIndex(subcommands) => match subcommands {
246+
pack::multi_index::Subcommands::Verify { multi_index_path } => prepare_and_run(
247+
"pack-multi-index-verify",
248+
verbose,
249+
progress,
250+
progress_keep_open,
251+
core::pack::multi_index::PROGRESS_RANGE,
252+
move |progress, _out, _err| {
253+
core::pack::multi_index::verify(
254+
multi_index_path,
255+
progress,
256+
&git_repository::interrupt::IS_INTERRUPTED,
257+
)
258+
},
259+
),
246260
pack::multi_index::Subcommands::Create {
247261
output_path,
248262
index_paths,

‎src/plumbing/options.rs‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,13 @@ pub mod pack {
248248

249249
#[derive(Debug, clap::Parser)]
250250
pub enum Subcommands {
251-
/// create a multi-pack index from one or more pack index files
251+
/// Verify a multi-index quickly without inspecting objects themselves
252+
#[clap(setting = AppSettings::DisableVersionFlag)]
253+
Verify {
254+
/// The path to the multi-pack-index to verify.
255+
multi_index_path: PathBuf,
256+
},
257+
/// Create a multi-pack index from one or more pack index files
252258
#[clap(setting = AppSettings::DisableVersionFlag)]
253259
Create {
254260
/// The path to which the multi-index file should be written, overwriting any possibly existing file.

‎tests/journey/gix.sh‎

Lines changed: 24 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -384,99 +384,106 @@ title "gix pack"
384384
}
385385
)
386386
(with "a valid pack INDEX file"
387-
PACK_INDEX_FILE="$fixtures/packs/pack-11fdfa9e156ab73caae3b6da867192221f2089c2.idx"
387+
MULTI_PACK_INDEX="$fixtures/packs/pack-11fdfa9e156ab73caae3b6da867192221f2089c2.idx"
388388
(with "no statistics"
389389
it "verifies the pack index successfully and with desired output" && {
390390
WITH_SNAPSHOT="$snapshot/index-success" \
391-
expect_run $SUCCESSFULLY "$exe_plumbing" pack verify "$PACK_INDEX_FILE"
391+
expect_run $SUCCESSFULLY "$exe_plumbing" pack verify "$MULTI_PACK_INDEX"
392392
}
393393
)
394394
(with "statistics"
395395
it "verifies the pack index successfully and with desired output" && {
396396
WITH_SNAPSHOT="$snapshot/index-with-statistics-success" \
397-
expect_run $SUCCESSFULLY "$exe_plumbing" pack verify --statistics "$PACK_INDEX_FILE"
397+
expect_run $SUCCESSFULLY "$exe_plumbing" pack verify --statistics "$MULTI_PACK_INDEX"
398398
}
399399

400400
(with "and the less-memory algorithm"
401401
it "verifies the pack index successfully and with desired output" && {
402402
WITH_SNAPSHOT="$snapshot/index-with-statistics-success" \
403-
expect_run $SUCCESSFULLY "$exe_plumbing" pack verify --algorithm less-memory --statistics "$PACK_INDEX_FILE"
403+
expect_run $SUCCESSFULLY "$exe_plumbing" pack verify --algorithm less-memory --statistics "$MULTI_PACK_INDEX"
404404
}
405405
)
406406
)
407407
(with "decode"
408408
it "verifies the pack index successfully and with desired output, and decodes all objects" && {
409409
WITH_SNAPSHOT="$snapshot/index-success" \
410-
expect_run $SUCCESSFULLY "$exe_plumbing" pack verify --algorithm less-memory --decode "$PACK_INDEX_FILE"
410+
expect_run $SUCCESSFULLY "$exe_plumbing" pack verify --algorithm less-memory --decode "$MULTI_PACK_INDEX"
411411
}
412412
)
413413
(with "re-encode"
414414
it "verifies the pack index successfully and with desired output, and re-encodes all objects" && {
415415
WITH_SNAPSHOT="$snapshot/index-success" \
416-
expect_run $SUCCESSFULLY "$exe_plumbing" pack verify --algorithm less-time --re-encode "$PACK_INDEX_FILE"
416+
expect_run $SUCCESSFULLY "$exe_plumbing" pack verify --algorithm less-time --re-encode "$MULTI_PACK_INDEX"
417417
}
418418
)
419419
if test "$kind" = "max"; then
420420
(with "statistics (JSON)"
421421
it "verifies the pack index successfully and with desired output" && {
422422
WITH_SNAPSHOT="$snapshot/index-with-statistics-json-success" \
423-
expect_run $SUCCESSFULLY "$exe_plumbing" --format json --threads 1 pack verify --statistics "$PACK_INDEX_FILE"
423+
expect_run $SUCCESSFULLY "$exe_plumbing" --format json --threads 1 pack verify --statistics "$MULTI_PACK_INDEX"
424424
}
425425
)
426426
fi
427427
)
428428
(with "a valid multi-pack index"
429429
snapshot="$snapshot/multi-index"
430430
(sandbox
431-
PACK_INDEX_FILE=multi-pack-index
431+
MULTI_PACK_INDEX=multi-pack-index
432432
cp $fixtures/packs/pack-* .
433-
$exe_plumbing pack multi-index create *.idx -o $PACK_INDEX_FILE
433+
$exe_plumbing pack multi-index create *.idx -o $MULTI_PACK_INDEX
434+
435+
(when "using fast validation via 'pack multi-index verify'"
436+
it "verifies the pack index successfully and with desired output" && {
437+
WITH_SNAPSHOT="$snapshot/fast-index-success" \
438+
expect_run $SUCCESSFULLY "$exe_plumbing" pack multi-index verify "$MULTI_PACK_INDEX"
439+
}
440+
)
434441

435442
(with "no statistics"
436443
it "verifies the pack index successfully and with desired output" && {
437444
WITH_SNAPSHOT="$snapshot/index-success" \
438-
expect_run $SUCCESSFULLY "$exe_plumbing" pack verify "$PACK_INDEX_FILE"
445+
expect_run $SUCCESSFULLY "$exe_plumbing" pack verify "$MULTI_PACK_INDEX"
439446
}
440447
)
441448
(with "statistics"
442449
it "verifies the pack index successfully and with desired output" && {
443450
WITH_SNAPSHOT="$snapshot/index-with-statistics-success" \
444-
expect_run $SUCCESSFULLY "$exe_plumbing" pack verify --statistics "$PACK_INDEX_FILE"
451+
expect_run $SUCCESSFULLY "$exe_plumbing" pack verify --statistics "$MULTI_PACK_INDEX"
445452
}
446453

447454
(with "and the less-memory algorithm"
448455
it "verifies the pack index successfully and with desired output" && {
449456
WITH_SNAPSHOT="$snapshot/index-with-statistics-success" \
450-
expect_run $SUCCESSFULLY "$exe_plumbing" pack verify --algorithm less-memory --statistics "$PACK_INDEX_FILE"
457+
expect_run $SUCCESSFULLY "$exe_plumbing" pack verify --algorithm less-memory --statistics "$MULTI_PACK_INDEX"
451458
}
452459
)
453460
)
454461
(with "decode"
455462
it "verifies the pack index successfully and with desired output, and decodes all objects" && {
456463
WITH_SNAPSHOT="$snapshot/index-success" \
457-
expect_run $SUCCESSFULLY "$exe_plumbing" pack verify --algorithm less-memory --decode "$PACK_INDEX_FILE"
464+
expect_run $SUCCESSFULLY "$exe_plumbing" pack verify --algorithm less-memory --decode "$MULTI_PACK_INDEX"
458465
}
459466
)
460467
(with "re-encode"
461468
it "verifies the pack index successfully and with desired output, and re-encodes all objects" && {
462469
WITH_SNAPSHOT="$snapshot/index-success" \
463-
expect_run $SUCCESSFULLY "$exe_plumbing" pack verify --algorithm less-time --re-encode "$PACK_INDEX_FILE"
470+
expect_run $SUCCESSFULLY "$exe_plumbing" pack verify --algorithm less-time --re-encode "$MULTI_PACK_INDEX"
464471
}
465472
)
466473
if test "$kind" = "max"; then
467474
(with "statistics (JSON)"
468475
it "verifies the pack index successfully and with desired output" && {
469476
WITH_SNAPSHOT="$snapshot/index-with-statistics-json-success" \
470-
expect_run $SUCCESSFULLY "$exe_plumbing" --format json --threads 1 pack verify --statistics "$PACK_INDEX_FILE"
477+
expect_run $SUCCESSFULLY "$exe_plumbing" --format json --threads 1 pack verify --statistics "$MULTI_PACK_INDEX"
471478
}
472479
)
473480
fi
474481
)
475482
)
476483
(sandbox
477484
(with "an INvalid pack INDEX file"
478-
PACK_INDEX_FILE="$fixtures/packs/pack-11fdfa9e156ab73caae3b6da867192221f2089c2.idx"
479-
cp $PACK_INDEX_FILE index.idx
485+
MULTI_PACK_INDEX="$fixtures/packs/pack-11fdfa9e156ab73caae3b6da867192221f2089c2.idx"
486+
cp $MULTI_PACK_INDEX index.idx
480487
echo $'\0' >> index.idx
481488
it "fails to verify the pack index and with desired output" && {
482489
WITH_SNAPSHOT="$snapshot/index-failure" \

‎tests/snapshots/plumbing/pack/verify/multi-index/fast-index-success‎

Whitespace-only changes.

0 commit comments

Comments
 (0)