Feat: add example crate for incremental Cardano database

[jpraynaud]

Content

This PR includes an example crate for the incremental Cardano database.

Pre-submit checklist

• Branch
  • Tests are provided (if possible)
  • Crates versions are updated (if relevant)
  • CHANGELOG file is updated (if relevant)
  • Commit sequence broadly makes sense
  • Key commits have useful messages
• PR
  • No clippy warnings in the CI
  • Self-reviewed the diff
  • Useful pull request description
  • Reviewer requested

Issue(s)

Closes #2330

[github-actions]

Test Results

    3 files  ±0     52 suites  ±0   10m 23s ⏱️ -15s
1 695 tests  - 3  1 695 ✅  - 3  0 💤 ±0  0 ❌ ±0 
2 077 runs   - 9  2 077 ✅  - 9  0 💤 ±0  0 ❌ ±0 

Results for commit d505bb5. ± Comparison against base commit 09ab67d.

This pull request removes 4 and adds 1 tests. Note that renamed tests count towards both.

mithril-client-cli ‑ commands::cardano_db_v2::download::tests::number_of_immutable_files_restored_with_from
mithril-client-cli ‑ commands::cardano_db_v2::download::tests::number_of_immutable_files_restored_with_full_restoration
mithril-client-cli ‑ commands::cardano_db_v2::download::tests::number_of_immutable_files_restored_with_range
mithril-client-cli ‑ commands::cardano_db_v2::download::tests::number_of_immutable_files_restored_with_up_to

mithril-client ‑ cardano_database_client::immutable_file_range::tests::length

♻️ This comment has been updated with latest results.

[dlachaume]

LGTM 🚀
I'm wondering if the CardanoDbV2DownloadCommand::number_of_immutable_files_restored tests in mithril-client-cli are still useful?

mithril/mithril-client-cli/src/commands/cardano_db_v2/download.rs

Lines 584 to 659 in a56fa49

	#[test]
	fn number_of_immutable_files_restored_with_full_restoration() {
	let cardano_database_snapshot = CardanoDatabaseSnapshot {
	beacon: CardanoDbBeacon::new(999, 20),
	..CardanoDatabaseSnapshot::dummy()
	};
	let immutable_file_range = ImmutableFileRange::Full;
	let number_of_immutable_files_restored =
	CardanoDbV2DownloadCommand::number_of_immutable_files_restored(
	&cardano_database_snapshot,
	&immutable_file_range,
	);
	assert_eq!(number_of_immutable_files_restored, 20);
	}
	#[test]
	fn number_of_immutable_files_restored_with_from() {
	let cardano_database_snapshot = CardanoDatabaseSnapshot {
	beacon: CardanoDbBeacon::new(999, 20),
	..CardanoDatabaseSnapshot::dummy()
	};
	let immutable_file_range = ImmutableFileRange::From(12);
	let number_of_immutable_files_restored =
	CardanoDbV2DownloadCommand::number_of_immutable_files_restored(
	&cardano_database_snapshot,
	&immutable_file_range,
	);
	let expected_number_of_immutable_files_restored = 20 - 12 + 1;
	assert_eq!(
	number_of_immutable_files_restored,
	expected_number_of_immutable_files_restored
	);
	}
	#[test]
	fn number_of_immutable_files_restored_with_up_to() {
	let cardano_database_snapshot = CardanoDatabaseSnapshot {
	beacon: CardanoDbBeacon::new(999, 20),
	..CardanoDatabaseSnapshot::dummy()
	};
	let immutable_file_range = ImmutableFileRange::UpTo(14);
	let number_of_immutable_files_restored =
	CardanoDbV2DownloadCommand::number_of_immutable_files_restored(
	&cardano_database_snapshot,
	&immutable_file_range,
	);
	assert_eq!(number_of_immutable_files_restored, 14);
	}
	#[test]
	fn number_of_immutable_files_restored_with_range() {
	let cardano_database_snapshot = CardanoDatabaseSnapshot {
	beacon: CardanoDbBeacon::new(999, 20),
	..CardanoDatabaseSnapshot::dummy()
	};
	let immutable_file_range = ImmutableFileRange::Range(12, 14);
	let number_of_immutable_files_restored =
	CardanoDbV2DownloadCommand::number_of_immutable_files_restored(
	&cardano_database_snapshot,
	&immutable_file_range,
	);
	let expected_number_of_immutable_files_restored = 14 - 12 + 1;
	assert_eq!(
	number_of_immutable_files_restored,
	expected_number_of_immutable_files_restored
	);
	}
	}

[Alenar]

LGTM 🚀

[sfauvel]

LGTM

[jpraynaud]

LGTM 🚀 I'm wondering if the CardanoDbV2DownloadCommand::number_of_immutable_files_restored tests in mithril-client-cli are still useful?

mithril/mithril-client-cli/src/commands/cardano_db_v2/download.rs

Lines 584 to 659 in a56fa49

	#[test]
	fn number_of_immutable_files_restored_with_full_restoration() {
	let cardano_database_snapshot = CardanoDatabaseSnapshot {
	beacon: CardanoDbBeacon::new(999, 20),
	..CardanoDatabaseSnapshot::dummy()
	};
	let immutable_file_range = ImmutableFileRange::Full;
	let number_of_immutable_files_restored =
	CardanoDbV2DownloadCommand::number_of_immutable_files_restored(
	&cardano_database_snapshot,
	&immutable_file_range,
	);
	assert_eq!(number_of_immutable_files_restored, 20);
	}
	#[test]
	fn number_of_immutable_files_restored_with_from() {
	let cardano_database_snapshot = CardanoDatabaseSnapshot {
	beacon: CardanoDbBeacon::new(999, 20),
	..CardanoDatabaseSnapshot::dummy()
	};
	let immutable_file_range = ImmutableFileRange::From(12);
	let number_of_immutable_files_restored =
	CardanoDbV2DownloadCommand::number_of_immutable_files_restored(
	&cardano_database_snapshot,
	&immutable_file_range,
	);
	let expected_number_of_immutable_files_restored = 20 - 12 + 1;
	assert_eq!(
	number_of_immutable_files_restored,
	expected_number_of_immutable_files_restored
	);
	}
	#[test]
	fn number_of_immutable_files_restored_with_up_to() {
	let cardano_database_snapshot = CardanoDatabaseSnapshot {
	beacon: CardanoDbBeacon::new(999, 20),
	..CardanoDatabaseSnapshot::dummy()
	};
	let immutable_file_range = ImmutableFileRange::UpTo(14);
	let number_of_immutable_files_restored =
	CardanoDbV2DownloadCommand::number_of_immutable_files_restored(
	&cardano_database_snapshot,
	&immutable_file_range,
	);
	assert_eq!(number_of_immutable_files_restored, 14);
	}
	#[test]
	fn number_of_immutable_files_restored_with_range() {
	let cardano_database_snapshot = CardanoDatabaseSnapshot {
	beacon: CardanoDbBeacon::new(999, 20),
	..CardanoDatabaseSnapshot::dummy()
	};
	let immutable_file_range = ImmutableFileRange::Range(12, 14);
	let number_of_immutable_files_restored =
	CardanoDbV2DownloadCommand::number_of_immutable_files_restored(
	&cardano_database_snapshot,
	&immutable_file_range,
	);
	let expected_number_of_immutable_files_restored = 14 - 12 + 1;
	assert_eq!(
	number_of_immutable_files_restored,
	expected_number_of_immutable_files_restored
	);
	}
	}

I have removed the function number_of_immutable_files_restored in 7a7768f 👍