Add the 'assert_valid' function for the test data

Author: Stanislav Tkach

rust/rbac-registration/src/cardano/cip509/cip509.rs

@@ -195,6 +195,7 @@ impl Cip509 {
     }
 
     /// Returns all role numbers present in this `Cip509` instance.
+    #[must_use]
     pub fn all_roles(&self) -> Vec<RoleNumber> {
         if let Some(metadata) = &self.metadata {
             metadata.role_data.keys().copied().collect()
@@ -204,36 +205,43 @@ impl Cip509 {
     }
 
     /// Returns a role data for the given role if it is present.
+    #[must_use]
     pub fn role_data(&self, role: RoleNumber) -> Option<&RoleData> {
         self.metadata.as_ref().and_then(|m| m.role_data.get(&role))
     }
 
     /// Returns a hash of the previous transaction.
+    #[must_use]
     pub fn previous_transaction(&self) -> Option<Blake2b256Hash> {
         self.prv_tx_id
     }
 
-    /// Returns a problem report
+    /// Returns a problem report.
+    #[must_use]
     pub fn report(&self) -> &ProblemReport {
         &self.report
     }
 
     /// Returns a point and a transaction index where this data is originating from.
+    #[must_use]
     pub fn origin(&self) -> &PointTxnIdx {
         &self.origin
     }
 
     /// Returns a hash of the transaction where this data is originating from.
+    #[must_use]
     pub fn txn_hash(&self) -> Blake2b256Hash {
         self.txn_hash
     }
 
     /// Returns URIs contained in both x509 and c509 certificates of `Cip509` metadata.
+    #[must_use]
     pub fn certificate_uris(&self) -> Option<&Cip0134UriSet> {
         self.metadata.as_ref().map(|m| &m.certificate_uris)
     }
 
     /// Returns a transaction inputs hash.
+    #[must_use]
     pub fn txn_inputs_hash(&self) -> Option<&TxInputHash> {
         self.txn_inputs_hash.as_ref()
     }
@@ -556,6 +564,7 @@ mod tests {
             .expect("Failed to get Cip509")
             .expect("There must be Cip509 in block");
         assert!(!res.report.is_problematic(), "{:?}", res.report);
+        data.assert_valid(&res);
     }
 
     #[test]
@@ -565,5 +574,6 @@ mod tests {
         assert_eq!(1, res.len());
         let cip509 = res.first().unwrap();
         assert!(!cip509.report.is_problematic(), "{:?}", cip509.report);
+        data.assert_valid(cip509);
     }
 }

rust/rbac-registration/src/cardano/cip509/types/role_data.rs

@@ -31,6 +31,7 @@ pub struct RoleData {
 
 impl RoleData {
     /// Create an instance of role data.
+    #[must_use]
     pub fn new(data: CborRoleData, txn: &conway::MintedTx, report: &ProblemReport) -> Self {
         let payment_key = if data.number == Some(RoleNumber::ROLE_0) && data.payment_key.is_none() {
             report.other(

rust/rbac-registration/src/cardano/cip509/utils/cip134_uri_set.rs

@@ -40,6 +40,7 @@ struct Cip0134UriSetInner {
 
 impl Cip0134UriSet {
     /// Creates a new `Cip0134UriSet` instance from the given certificates.
+    #[must_use]
     pub fn new(
         x509_certs: &[X509DerCert], c509_certs: &[C509Cert], report: &ProblemReport,
     ) -> Self {
@@ -287,12 +288,10 @@ mod tests {
         assert_eq!(uris.len(), 1);
 
         let uri = uris.first().unwrap();
-        // cSpell:disable
         assert_eq!(
             uri.uri(),
             format!("web+cardano://addr/{}", data.stake_addr.unwrap())
         );
-        // cSpell:enable
         let Address::Stake(address) = uri.address() else {
             panic!("Unexpected address type");
         };

rust/rbac-registration/src/cardano/cip509/validation.rs

@@ -248,10 +248,6 @@ fn check_key_offset<T>(
 
 #[cfg(test)]
 mod tests {
-    use std::str::FromStr;
-
-    use uuid::Uuid;
-
     use super::*;
     use crate::{cardano::cip509::Cip509, utils::test};
 
@@ -263,20 +259,7 @@ mod tests {
         assert_eq!(1, registrations.len());
 
         let registration = registrations.pop().unwrap();
-        assert!(
-            !registration.report().is_problematic(),
-            "{:?}",
-            registration.report()
-        );
-        assert!(registration.previous_transaction().is_none());
-
-        let origin = registration.origin();
-        assert_eq!(origin.txn_index(), data.txn_index);
-        assert_eq!(origin.point().slot_or_default(), data.slot);
-
-        let (purpose, metadata, _) = registration.consume().unwrap();
-        assert_eq!(purpose, Uuid::parse_str(&data.purpose).unwrap());
-        assert_eq!(1, metadata.role_data.len());
+        data.assert_valid(&registration);
     }
 
     #[test]
@@ -310,10 +293,7 @@ mod tests {
         let registration = registrations.pop().unwrap();
         assert!(registration.report().is_problematic());
 
-        assert_eq!(
-            registration.previous_transaction(),
-            Some(Blake2b256Hash::from_str(data.prv_hash.unwrap().as_str()).unwrap())
-        );
+        assert_eq!(registration.previous_transaction(), data.prv_hash);
 
         let origin = registration.origin();
         assert_eq!(origin.txn_index(), data.txn_index);
@@ -334,23 +314,7 @@ mod tests {
         assert_eq!(1, registrations.len());
 
         let registration = registrations.pop().unwrap();
-        assert!(
-            !registration.report().is_problematic(),
-            "{:?}",
-            registration.report()
-        );
-        assert_eq!(
-            registration.previous_transaction(),
-            Some(Blake2b256Hash::from_str(data.prv_hash.unwrap().as_str()).unwrap())
-        );
-
-        let origin = registration.origin();
-        assert_eq!(origin.txn_index(), data.txn_index);
-        assert_eq!(origin.point().slot_or_default(), data.slot);
-
-        let (purpose, metadata, _) = registration.consume().unwrap();
-        assert_eq!(purpose, Uuid::parse_str(&data.purpose).unwrap());
-        assert_eq!(1, metadata.role_data.len());
+        data.assert_valid(&registration);
     }
 
     #[test]

rust/rbac-registration/src/registration/cardano/mod.rs

@@ -420,15 +420,11 @@ mod test {
         let registration = Cip509::new(&data.block, data.txn_index, &[])
             .unwrap()
             .unwrap();
-        assert!(
-            !registration.report().is_problematic(),
-            "{:#?}",
-            registration.report()
-        );
+        data.assert_valid(&registration);
 
         // Create a chain with the first registration.
         let chain = RegistrationChain::new(registration).unwrap();
-        assert_eq!(chain.purpose(), &[Uuid::parse_str(&data.purpose).unwrap()]);
+        assert_eq!(chain.purpose(), &[data.purpose]);
         assert_eq!(1, chain.x509_certs().len());
         let origin = &chain.x509_certs().get(&0).unwrap().0;
         assert_eq!(origin.point().slot_or_default(), data.slot);
@@ -454,17 +450,11 @@ mod test {
         let registration = Cip509::new(&data.block, data.txn_index, &[])
             .unwrap()
             .unwrap();
-        assert!(
-            !registration.report().is_problematic(),
-            "{:#?}",
-            registration.report()
-        );
+        data.assert_valid(&registration);
         let update = chain.update(registration).unwrap();
 
-        // Current tx hash should updated to RBAC data in block 4
-        assert_eq!(update.current_tx_id_hash().to_string(), data.tx_hash);
-        assert!(update
-            .role_data()
-            .contains_key(&RoleNumber::from(data.role)));
+        // Current tx hash should be equal to the hash from block 4.
+        assert_eq!(update.current_tx_id_hash(), data.txn_hash);
+        assert!(update.role_data().contains_key(&data.role));
     }
 }

rust/rbac-registration/src/utils/test.rs

@@ -3,6 +3,10 @@
 // cspell: words stake_test1urs8t0ssa3w9wh90ld5tprp3gurxd487rth2qlqk6ernjqcef4ugr
 
 use cardano_blockchain_types::{MultiEraBlock, Network, Point, Slot, TxnIndex};
+use catalyst_types::hashes::Blake2b256Hash;
+use uuid::Uuid;
+
+use crate::cardano::cip509::{Cip509, RoleNumber};
 
 /// Test data expected from block.
 #[allow(dead_code)]
@@ -12,19 +16,37 @@ pub struct BlockTestData {
     /// Slot number.
     pub slot: Slot,
     /// Role.
-    pub role: u8,
+    pub role: RoleNumber,
     /// Transaction index.
     pub txn_index: TxnIndex,
     /// Transaction hash.
-    pub tx_hash: String,
+    pub txn_hash: Blake2b256Hash,
     /// Previous hash.
-    pub prv_hash: Option<String>,
+    pub prv_hash: Option<Blake2b256Hash>,
     /// Purpose.
-    pub purpose: String,
+    pub purpose: Uuid,
     /// Stake address.
     pub stake_addr: Option<String>,
 }
 
+impl BlockTestData {
+    /// Asserts that the problem report doesn't contain errors and all fields have
+    /// expected values.
+    #[track_caller]
+    pub fn assert_valid(&self, cip509: &Cip509) {
+        assert!(!cip509.report().is_problematic(), "{:?}", cip509.report());
+
+        let origin = cip509.origin();
+        assert_eq!(origin.txn_index(), self.txn_index);
+        assert_eq!(origin.point().as_fuzzy(), Point::fuzzy(self.slot));
+        assert!(cip509.role_data(self.role).is_some());
+        assert_eq!(cip509.txn_hash(), self.txn_hash);
+        assert_eq!(cip509.previous_transaction(), self.prv_hash);
+        let (purpose, ..) = cip509.clone().consume().unwrap();
+        assert_eq!(purpose, self.purpose);
+    }
+}
+
 /// Returns the decoded `conway_1.block` block that contains 6 transaction
 /// Slot number: `81_440_954`, Block number: `3_096_080`
 /// Tx hash: 0x22469cb214ad2c95265630f5c26b96166ea618722b38401d55ecf68a1fd893ec
@@ -40,11 +62,13 @@ pub fn block_1() -> BlockTestData {
     BlockTestData {
         block: block(data),
         slot: 81_440_954.into(),
-        role: 0,
+        role: 0.into(),
         txn_index: 2.into(),
-        tx_hash: "22469cb214ad2c95265630f5c26b96166ea618722b38401d55ecf68a1fd893ec".to_string(),
+        txn_hash: "22469cb214ad2c95265630f5c26b96166ea618722b38401d55ecf68a1fd893ec"
+            .parse()
+            .unwrap(),
         prv_hash: None,
-        purpose: "ca7a1457-ef9f-4c7f-9c74-7f8c4a4cfa6c".to_string(),
+        purpose: "ca7a1457-ef9f-4c7f-9c74-7f8c4a4cfa6c".parse().unwrap(),
         stake_addr: Some(
             "stake_test1urs8t0ssa3w9wh90ld5tprp3gurxd487rth2qlqk6ernjqcef4ugr".to_string(),
         ),
@@ -67,13 +91,17 @@ pub fn block_2() -> BlockTestData {
     BlockTestData {
         block: block(data),
         slot: 77_171_632.into(),
-        role: 0,
+        role: 0.into(),
         txn_index: 0.into(),
-        tx_hash: "337d35026efaa48b5ee092d38419e102add1b535364799eb8adec8ac6d573b79".to_string(),
+        txn_hash: "337d35026efaa48b5ee092d38419e102add1b535364799eb8adec8ac6d573b79"
+            .parse()
+            .unwrap(),
         prv_hash: Some(
-            "4d3f576f26db29139981a69443c2325daa812cc353a31b5a4db794a5bcbb06c2".to_string(),
+            "4d3f576f26db29139981a69443c2325daa812cc353a31b5a4db794a5bcbb06c2"
+                .parse()
+                .unwrap(),
         ),
-        purpose: "ca7a1457-ef9f-4c7f-9c74-7f8c4a4cfa6c".to_string(),
+        purpose: "ca7a1457-ef9f-4c7f-9c74-7f8c4a4cfa6c".parse().unwrap(),
         stake_addr: None,
     }
 }
@@ -94,15 +122,21 @@ pub fn block_3() -> BlockTestData {
     BlockTestData {
         block: block(data),
         slot: 77_170_639.into(),
-        role: 0,
+        role: 0.into(),
         txn_index: 0.into(),
-        tx_hash: "0fda4c9f86e763fecd33f57d8f93540b1598c0a0e539dd996c48052ce94bab80".to_string(),
+        txn_hash: "0fda4c9f86e763fecd33f57d8f93540b1598c0a0e539dd996c48052ce94bab80"
+            .parse()
+            .unwrap(),
         prv_hash: Some(
-            "4d3f576f26db29139981a69443c2325daa812cc353a31b5a4db794a5bcbb06c2".to_string(),
+            "4d3f576f26db29139981a69443c2325daa812cc353a31b5a4db794a5bcbb06c2"
+                .parse()
+                .unwrap(),
         ),
-        purpose: "ca7a1457-ef9f-4c7f-9c74-7f8c4a4cfa6c".to_string(),
+        purpose: "ca7a1457-ef9f-4c7f-9c74-7f8c4a4cfa6c".parse().unwrap(),
         stake_addr: Some(
-            "stake_test1urs8t0ssa3w9wh90ld5tprp3gurxd487rth2qlqk6ernjqcef4ugr".to_string(),
+            "stake_test1urs8t0ssa3w9wh90ld5tprp3gurxd487rth2qlqk6ernjqcef4ugr"
+                .parse()
+                .unwrap(),
         ),
     }
 }
@@ -122,11 +156,13 @@ pub fn block_4() -> BlockTestData {
     BlockTestData {
         block: block(data),
         slot: 81_441_637.into(),
-        role: 4,
+        role: 4.into(),
         txn_index: 4.into(),
-        tx_hash: "730cc97496b2aec16af58d27284deae2b3347e4c4c5e9ac97458e80131ccd575".to_string(),
-        prv_hash: Some(block_1().tx_hash),
-        purpose: "ca7a1457-ef9f-4c7f-9c74-7f8c4a4cfa6c".to_string(),
+        txn_hash: "730cc97496b2aec16af58d27284deae2b3347e4c4c5e9ac97458e80131ccd575"
+            .parse()
+            .unwrap(),
+        prv_hash: Some(block_1().txn_hash),
+        purpose: "ca7a1457-ef9f-4c7f-9c74-7f8c4a4cfa6c".parse().unwrap(),
         stake_addr: Some(
             "stake_test1urs8t0ssa3w9wh90ld5tprp3gurxd487rth2qlqk6ernjqcef4ugr".to_string(),
         ),