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.

Sign up for GitHub

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

Minor test / formatting tweaks/fixes #1879

Merged
merged 3 commits into from
Aug 20, 2024
Merged

Minor test / formatting tweaks/fixes #1879

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
01a022d
fix: Fix receipt substate formatting
dhedey Aug 18, 2024
7d8395f
fix: Regenerate all the scenario receipts
dhedey Aug 18, 2024
875f129
fix: Fix code format
dhedey Aug 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions radix-common/src/data/scrypto/definitions.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ pub type ScryptoDecoder<'a> = VecDecoder<'a, ScryptoCustomValueKind>;
pub type ScryptoTraverser<'a> = VecTraverser<'a, ScryptoCustomTraversal>;
pub type ScryptoValueKind = ValueKind<ScryptoCustomValueKind>;
pub type ScryptoValue = Value<ScryptoCustomValueKind, ScryptoCustomValue>;
pub type RawScryptoValue<'a> = RawValue<'a, ScryptoCustomExtension>;
pub type RawScryptoPayload<'a> = RawPayload<'a, ScryptoCustomExtension>;
// ScryptoRawValue and friends are defined in custom_payload_wrappers.rs

// The following trait "aliases" are to be used in parameters.
//
Expand Down
97 changes: 84 additions & 13 deletions radix-engine-tests/tests/application/stake_reconciliation.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,18 @@ use radix_common::prelude::*;
use radix_engine::updates::*;
use radix_substate_store_interface::db_key_mapper::{DatabaseKeyMapper, SpreadPrefixKeyMapper};
use scrypto_test::prelude::*;
use core::fmt::Write;

// HELP DEBUGGING:
// If this test diverges, it's often because of a change to genesis, which has made a substate
// bigger and changed the costing.
//
// The best way to debug this is to run the following to dump a new trace.
// cargo test --package radix-engine-tests --test application -- application::stake_reconciliation::test_stake_reconciliation --exact --show-output > radix-engine-tests/tests/application/reconciliation_log.txt
//
// And look for line/s which are different. Likely it'll be some substate write.
// Then look further down this test for a block of code to uncomment, which can be used to read that
// value from the database.
#[test]
fn test_stake_reconciliation() {
// Arrange
Expand All @@ -29,8 +40,7 @@ fn test_stake_reconciliation() {
receipt.expect_commit_success();

// Store current DB substate value hashes for comparision after staking execution
let mut pre_transaction_substates: HashMap<(DbPartitionKey, DbSortKey), Vec<u8>> =
HashMap::new();
let mut pre_transaction_substates: IndexMap<(DbPartitionKey, DbSortKey), Vec<u8>> = indexmap!();
let db = ledger.substate_db();
let old_keys: Vec<DbPartitionKey> = db.list_partition_keys().collect();
for key in old_keys {
Expand Down Expand Up @@ -58,6 +68,48 @@ fn test_stake_reconciliation() {
vec![NonFungibleGlobalId::from_public_key(&account_pk)],
);

let address_encoder = AddressBech32Encoder::for_simulator();
let receipt_display_context = TransactionReceiptDisplayContextBuilder::new()
.encoder(&address_encoder)
.display_state_updates(true)
.use_ansi_colors(false)
.schema_lookup_from_db(ledger.substate_db())
.set_max_substate_length_to_display(1000000)
.build();

// UNCOMMENT THESE LINES TO PRINT OUT A NICE DISPLAY OF A SINGLE SUBSTATE
// {
// let mut error_message = String::new();
// let node_id = NodeId(hex::decode("0d906318c6318c6c4e1b40cc6318c6318cf7bfd5d45f48c686318c6318c6").unwrap().try_into().unwrap());
// let partition_num = PartitionNumber(1);
// let substate_key = SubstateKey::Map(ScryptoRawPayload::from_valid_payload(vec![92, 32, 7, 32, 220, 0, 156, 5, 6, 83, 96, 189, 222, 100, 29, 145, 160, 147, 193, 127, 71, 54, 135, 62, 103, 35, 126, 168, 230, 117, 203, 71, 36, 132, 155, 157]));
// let value_from_database: ScryptoRawValue = ledger.substate_db()
// .get_mapped::<SpreadPrefixKeyMapper, _>(&node_id, partition_num, &substate_key)
// .unwrap();
// let substate_value = value_from_database.into_payload_bytes();
// let state_updates = StateUpdates {
// by_node: indexmap! {
// node_id => NodeStateUpdates::Delta {
// by_partition: indexmap! {
// partition_num => PartitionStateUpdates::Delta {
// by_substate: indexmap! {
// substate_key.clone() => DatabaseUpdate::Set(substate_value.clone())
// }
// }
// }
// }
// }
// };
// let system_structure = SystemStructure::resolve(ledger.substate_db(), &state_updates, &vec![]);
// format_substate_value(
// &mut error_message,
// &system_structure.substate_system_structures[&node_id][&partition_num][&substate_key],
// &receipt_display_context,
// &substate_value,
// ).unwrap();
// panic!(error_message)
// }

// Assert
println!("{:-^120}", "Application Events");

Expand Down Expand Up @@ -210,20 +262,36 @@ fn test_stake_reconciliation() {
};

let post_transaction_partitions: Vec<_> = post_transaction_partitions.collect();

let mut error_message = String::new();

for (full_key, (expected_old_value, _)) in expected_updated_substates.iter() {
let database_value = &pre_transaction_substates[full_key];
let (node_id, partition) = SpreadPrefixKeyMapper::from_db_partition_key(&full_key.0);
// Luckily they're all fields
let substate_key = SpreadPrefixKeyMapper::from_db_sort_key::<FieldKey>(&full_key.1);
let address = AddressBech32Encoder::for_simulator()
.encode(
&SpreadPrefixKeyMapper::from_db_partition_key(&full_key.0)
.0
.0,
)
.encode(&node_id.0)
.unwrap();
assert_eq!(
database_value, expected_old_value,
"The pre-transaction value of updated substate under {} is not expected: {:?}",
address, full_key
);
if database_value != expected_old_value {
let substate_structure = &commit_result.system_structure.substate_system_structures[&node_id][&partition][&substate_key];
write!(&mut error_message, "\nThe pre-transaction value of updated substate under {address} {partition:?} {substate_key:?} has changed.").unwrap();
write!(&mut error_message, "\n\nEXPECTED:").unwrap();
format_receipt_substate_value(
&mut error_message,
&substate_structure,
&receipt_display_context,
&expected_old_value,
).unwrap();
write!(&mut error_message, "\nACTUAL:").unwrap();
format_receipt_substate_value(
&mut error_message,
&substate_structure,
&receipt_display_context,
&database_value,
).unwrap();
write!(&mut error_message, "\n").unwrap();
}
// For printing:
// let (db_partition_key, db_sort_key) = full_key;
// println!(
Expand All @@ -246,6 +314,9 @@ fn test_stake_reconciliation() {
// hex::encode(new_value)
// );
}
if error_message.len() > 0 {
panic!("{}", error_message);
}

for key in post_transaction_partitions {
let partition_entries = ledger.substate_db().list_entries(&key);
Expand Down Expand Up @@ -296,4 +367,4 @@ fn test_stake_reconciliation() {

fn unhex(input: &'static str) -> Vec<u8> {
hex::decode(input).unwrap()
}
}
Loading
Loading