Merge pull request project-chip#31 from kedars/feature/large_read_tests

Tests for multi-leg read/subscribe

Author: kedars

matter/src/core.rs

@@ -61,12 +61,14 @@ impl Matter {
         let mdns = Mdns::get()?;
         mdns.set_values(dev_det.vid, dev_det.pid, &dev_det.device_name);
 
-        print_pairing_code_and_qr(&dev_det, &dev_comm, DiscoveryCapabilities::default());
-
         let fabric_mgr = Arc::new(FabricMgr::new()?);
+        let open_comm_window = fabric_mgr.is_empty();
+        if open_comm_window {
+            print_pairing_code_and_qr(&dev_det, &dev_comm, DiscoveryCapabilities::default());
+        }
+
         let acl_mgr = Arc::new(AclMgr::new()?);
         let mut pase = PaseMgr::new();
-        let open_comm_window = fabric_mgr.is_empty();
         let data_model =
             DataModel::new(dev_det, dev_att, fabric_mgr.clone(), acl_mgr, pase.clone())?;
         let mut matter = Box::new(Matter {

matter/src/data_model/cluster_basic_information.rs

@@ -22,7 +22,7 @@ use num_derive::FromPrimitive;
 pub const ID: u32 = 0x0028;
 
 #[derive(FromPrimitive)]
-enum Attributes {
+pub enum Attributes {
     DMRevision = 0,
     VendorId = 2,
     ProductId = 4,

matter/src/data_model/cluster_media_playback.rs

@@ -55,7 +55,7 @@ enum PlaybackState {
     Playing = 0,
     Paused = 1,
     NotPlaying = 2,
-    BUFFERING = 3,
+    Buffering = 3,
 }
 #[derive(FromPrimitive)]
 enum CommandStatus {
@@ -186,10 +186,7 @@ impl MediaPlaybackCluster {
     }
 
     pub fn add_callback(&mut self, name: Commands, callback: Box<dyn FnMut()>) {
-        self.callbacks.push(ClusterCallback {
-            name,
-            callback: callback,
-        });
+        self.callbacks.push(ClusterCallback { name, callback });
     }
 
     fn run_callback(&mut self, name: Commands) {

matter/src/data_model/core/read.rs

@@ -221,7 +221,7 @@ impl DataModel {
         //
         // This is the amount of space we reserve for other things to be attached towards
         // the end
-        const RESERVE_SIZE: usize = 18;
+        const RESERVE_SIZE: usize = 24;
         let mut new_wb = wb_shrink!(old_wb, RESERVE_SIZE);
         let mut tw = TLVWriter::new(&mut new_wb);
 

matter/src/data_model/objects/encoder.rs

@@ -42,7 +42,7 @@ pub enum EncodeValue<'a> {
     Tlv(TLVElement<'a>),
     /// This indicates a static value. This variant is typically used in the transmit/
     /// to-tlv path
-    Value(&'a (dyn ToTLV)),
+    Value(&'a dyn ToTLV),
 }
 
 impl<'a> EncodeValue<'a> {

matter/src/data_model/sdm/noc.rs

@@ -81,7 +81,7 @@ pub enum Commands {
 }
 
 #[derive(FromPrimitive)]
-enum Attributes {
+pub enum Attributes {
     NOCs = 0,
     Fabrics = 1,
     SupportedFabrics = 2,

matter/src/data_model/system_model/descriptor.rs

@@ -28,7 +28,7 @@ pub const ID: u32 = 0x001D;
 
 #[derive(FromPrimitive)]
 #[allow(clippy::enum_variant_names)]
-enum Attributes {
+pub enum Attributes {
     DeviceTypeList = 0,
     ServerList = 1,
     ClientList = 2,

matter/src/interaction_model/messages.rs

@@ -76,7 +76,7 @@ pub mod msg {
         EventPath,
     };
 
-    #[derive(FromTLV)]
+    #[derive(Default, FromTLV, ToTLV)]
     #[tlvargs(lifetime = "'a")]
     pub struct SubscribeReq<'a> {
         pub keep_subs: bool,
@@ -92,6 +92,20 @@ pub mod msg {
     }
 
     impl<'a> SubscribeReq<'a> {
+        pub fn new(fabric_filtered: bool, min_int_floor: u16, max_int_ceil: u16) -> Self {
+            Self {
+                fabric_filtered,
+                min_int_floor,
+                max_int_ceil,
+                ..Default::default()
+            }
+        }
+
+        pub fn set_attr_requests(mut self, requests: &'a [AttrPath]) -> Self {
+            self.attr_requests = Some(TLVArray::new(requests));
+            self
+        }
+
         pub fn to_read_req(&self) -> ReadReq<'a> {
             ReadReq {
                 attr_requests: self.attr_requests,
@@ -103,7 +117,7 @@ pub mod msg {
         }
     }
 
-    #[derive(ToTLV)]
+    #[derive(Debug, FromTLV, ToTLV)]
     pub struct SubscribeResp {
         pub subs_id: u32,
         // The Context Tags are discontiguous for some reason

matter/tests/common/attributes.rs

@@ -15,10 +15,14 @@
  *    limitations under the License.
  */
 
-use matter::interaction_model::{messages::ib::AttrResp, messages::msg::ReportDataMsg};
+use matter::{
+    interaction_model::{messages::ib::AttrResp, messages::msg::ReportDataMsg},
+    tlv::{TLVElement, TLVList, TLVWriter, TagType, ToTLV},
+    utils::writebuf::WriteBuf,
+};
 
 /// Assert that the data received in the outbuf matches our expectations
-pub fn assert_attr_report(received: &ReportDataMsg, expected: &[AttrResp]) {
+pub fn __assert_attr_report(received: &ReportDataMsg, expected: &[AttrResp], skip_data: bool) {
     let mut index = 0;
 
     // We can't use assert_eq because it will also try to match data-version
@@ -29,7 +33,9 @@ pub fn assert_attr_report(received: &ReportDataMsg, expected: &[AttrResp]) {
                 AttrResp::Data(d) => {
                     // We don't match the data-version
                     assert_eq!(e_d.path, d.path);
-                    assert_eq!(e_d.data, d.data);
+                    if !skip_data {
+                        assert_eq!(e_d.data, d.data);
+                    }
                 }
                 _ => {
                     panic!("Invalid response, expected AttrRespIn::Data");
@@ -43,12 +49,36 @@ pub fn assert_attr_report(received: &ReportDataMsg, expected: &[AttrResp]) {
     assert_eq!(index, expected.len());
 }
 
+pub fn assert_attr_report(received: &ReportDataMsg, expected: &[AttrResp]) {
+    __assert_attr_report(received, expected, false)
+}
+
+pub fn assert_attr_report_skip_data(received: &ReportDataMsg, expected: &[AttrResp]) {
+    __assert_attr_report(received, expected, true)
+}
+
 // We have to hard-code this here, and it should match the tag
 // of the 'data' part in AttrData
 pub const ATTR_DATA_TAG_DATA: u8 = 2;
 
 #[macro_export]
 macro_rules! attr_data {
+    ($endpoint:expr, $cluster:expr, $attr: expr, $data:expr) => {
+        AttrResp::Data(AttrData {
+            data_ver: None,
+            path: AttrPath {
+                endpoint: Some($endpoint),
+                cluster: Some($cluster),
+                attr: Some($attr as u16),
+                ..Default::default()
+            },
+            data: EncodeValue::Tlv(TLVElement::new(TagType::Context(ATTR_DATA_TAG_DATA), $data)),
+        })
+    };
+}
+
+#[macro_export]
+macro_rules! attr_data_path {
     ($path:expr, $data:expr) => {
         AttrResp::Data(AttrData {
             data_ver: None,
@@ -69,3 +99,37 @@ macro_rules! attr_status {
         AttrResp::Status(AttrStatus::new($path, $status, 0))
     };
 }
+
+pub struct TLVHolder {
+    buf: [u8; 100],
+    used_len: usize,
+}
+
+impl TLVHolder {
+    pub fn new_array<'a, T, I>(ctx_tag: u8, data: I) -> Self
+    where
+        T: ToTLV + 'a,
+        I: IntoIterator<Item = &'a T>,
+    {
+        let mut s = Self {
+            buf: [0; 100],
+            used_len: 0,
+        };
+        let buf_len = s.buf.len();
+        let mut wb = WriteBuf::new(&mut s.buf, buf_len);
+        let mut tw = TLVWriter::new(&mut wb);
+        let _ = tw.start_array(TagType::Context(ctx_tag));
+        for e in data {
+            let _ = e.to_tlv(&mut tw, TagType::Anonymous);
+        }
+        let _ = tw.end_container();
+
+        s.used_len = wb.as_slice().len();
+        s
+    }
+
+    pub fn to_tlv(&self) -> TLVElement {
+        let s = &self.buf[..self.used_len];
+        TLVList::new(s).iter().next().unwrap()
+    }
+}

matter/tests/data_model/acl_and_dataver.rs

@@ -34,7 +34,7 @@ use matter::{
 };
 
 use crate::{
-    attr_data, attr_status,
+    attr_data_path, attr_status,
     common::{
         attributes::*,
         echo_cluster::{self, ATTR_WRITE_DEFAULT_VALUE},
@@ -151,7 +151,7 @@ fn wc_read_attribute() {
 
     // Test2: Only Single response as only single endpoint is allowed
     let input = &[AttrPath::new(&wc_att1)];
-    let expected = &[attr_data!(ep0_att1, ElementType::U16(0x1234))];
+    let expected = &[attr_data_path!(ep0_att1, ElementType::U16(0x1234))];
     handle_read_reqs(&mut im, peer, input, expected);
 
     // Add ACL to allow our peer to only access endpoint 1
@@ -163,8 +163,8 @@ fn wc_read_attribute() {
     // Test3: Both responses are valid
     let input = &[AttrPath::new(&wc_att1)];
     let expected = &[
-        attr_data!(ep0_att1, ElementType::U16(0x1234)),
-        attr_data!(ep1_att1, ElementType::U16(0x1234)),
+        attr_data_path!(ep0_att1, ElementType::U16(0x1234)),
+        attr_data_path!(ep1_att1, ElementType::U16(0x1234)),
     ];
     handle_read_reqs(&mut im, peer, input, expected);
 }
@@ -201,7 +201,7 @@ fn exact_read_attribute() {
 
     // Test2: Only Single response as only single endpoint is allowed
     let input = &[AttrPath::new(&wc_att1)];
-    let expected = &[attr_data!(ep0_att1, ElementType::U16(0x1234))];
+    let expected = &[attr_data_path!(ep0_att1, ElementType::U16(0x1234))];
     handle_read_reqs(&mut im, peer, input, expected);
 }
 
@@ -565,15 +565,15 @@ fn test_read_data_ver() {
     let input = &[AttrPath::new(&wc_ep_att1)];
 
     let expected = &[
-        attr_data!(
+        attr_data_path!(
             GenericPath::new(
                 Some(0),
                 Some(echo_cluster::ID),
                 Some(echo_cluster::Attributes::Att1 as u32)
             ),
             ElementType::U16(0x1234)
         ),
-        attr_data!(
+        attr_data_path!(
             GenericPath::new(
                 Some(1),
                 Some(echo_cluster::ID),
@@ -614,7 +614,7 @@ fn test_read_data_ver() {
         Some(TLVArray::Slice(&dataver_filter)),
         &mut out_buf,
     );
-    let expected_only_one = &[attr_data!(
+    let expected_only_one = &[attr_data_path!(
         GenericPath::new(
             Some(1),
             Some(echo_cluster::ID),