Common cleanup (#95)

* chore: typos

---------

Co-authored-by: Michael Mileusnich <[email protected]>

Author: mikemiles-dev

src/netflow_common.rs

@@ -294,22 +294,31 @@ mod common_tests {
 
         let common: NetflowCommon = NetflowCommon::try_from(&v5).unwrap();
 
-        assert!(common.version == 5);
-        assert!(common.timestamp == 100);
-        assert!(common.flowsets.len() == 1);
+        assert_eq!(common.version, 5);
+        assert_eq!(common.timestamp, 100);
+        assert_eq!(common.flowsets.len(), 1);
         let flowset = &common.flowsets[0];
-        assert!(flowset.src_addr.unwrap() == IpAddr::V4(Ipv4Addr::new(192, 168, 1, 1)));
-        assert!(flowset.dst_addr.unwrap() == IpAddr::V4(Ipv4Addr::new(192, 168, 1, 2)));
-        assert!(flowset.src_port.unwrap() == 1234);
-        assert!(flowset.dst_port.unwrap() == 80);
-        assert!(flowset.protocol_number.unwrap() == 6);
-        assert!(flowset.protocol_type.unwrap() == crate::protocol::ProtocolTypes::Tcp);
-        assert!(flowset.first_seen.unwrap() == 100);
-        assert!(flowset.last_seen.unwrap() == 200);
+        assert_eq!(
+            flowset.src_addr.unwrap(),
+            IpAddr::V4(Ipv4Addr::new(192, 168, 1, 1))
+        );
+        assert_eq!(
+            flowset.dst_addr.unwrap(),
+            IpAddr::V4(Ipv4Addr::new(192, 168, 1, 2))
+        );
+        assert_eq!(flowset.src_port.unwrap(), 1234);
+        assert_eq!(flowset.dst_port.unwrap(), 80);
+        assert_eq!(flowset.protocol_number.unwrap(), 6);
+        assert_eq!(
+            flowset.protocol_type.unwrap(),
+            crate::protocol::ProtocolTypes::Tcp
+        );
+        assert_eq!(flowset.first_seen.unwrap(), 100);
+        assert_eq!(flowset.last_seen.unwrap(), 200);
     }
 
     #[test]
-    fn it_convets_v7_to_common() {
+    fn it_converts_v7_to_common() {
         let v7 = V7 {
             header: V7Header {
                 version: 7,
@@ -348,18 +357,27 @@ mod common_tests {
 
         let common: NetflowCommon = NetflowCommon::try_from(&v7).unwrap();
 
-        assert!(common.version == 7);
-        assert!(common.timestamp == 100);
-        assert!(common.flowsets.len() == 1);
+        assert_eq!(common.version, 7);
+        assert_eq!(common.timestamp, 100);
+        assert_eq!(common.flowsets.len(), 1);
         let flowset = &common.flowsets[0];
-        assert!(flowset.src_addr.unwrap() == IpAddr::V4(Ipv4Addr::new(192, 168, 1, 1)));
-        assert!(flowset.dst_addr.unwrap() == IpAddr::V4(Ipv4Addr::new(192, 168, 1, 2)));
-        assert!(flowset.src_port.unwrap() == 1234);
-        assert!(flowset.dst_port.unwrap() == 80);
-        assert!(flowset.protocol_number.unwrap() == 6);
-        assert!(flowset.protocol_type.unwrap() == crate::protocol::ProtocolTypes::Tcp);
-        assert!(flowset.first_seen.unwrap() == 100);
-        assert!(flowset.last_seen.unwrap() == 200);
+        assert_eq!(
+            flowset.src_addr.unwrap(),
+            IpAddr::V4(Ipv4Addr::new(192, 168, 1, 1))
+        );
+        assert_eq!(
+            flowset.dst_addr.unwrap(),
+            IpAddr::V4(Ipv4Addr::new(192, 168, 1, 2))
+        );
+        assert_eq!(flowset.src_port.unwrap(), 1234);
+        assert_eq!(flowset.dst_port.unwrap(), 80);
+        assert_eq!(flowset.protocol_number.unwrap(), 6);
+        assert_eq!(
+            flowset.protocol_type.unwrap(),
+            crate::protocol::ProtocolTypes::Tcp
+        );
+        assert_eq!(flowset.first_seen.unwrap(), 100);
+        assert_eq!(flowset.last_seen.unwrap(), 200);
     }
 
     #[test]

src/static_versions/v5.rs

@@ -105,7 +105,7 @@ impl V5 {
     pub fn to_be_bytes(&self) -> Vec<u8> {
         let header_version = self.header.version.to_be_bytes();
         let header_count = self.header.count.to_be_bytes();
-        let header_sys_up_time = (self.header.sys_up_time).to_be_bytes();
+        let header_sys_up_time = self.header.sys_up_time.to_be_bytes();
         let mut header_unix_timestamp = self.header.unix_secs.to_be_bytes().to_vec();
         let header_unix_nsecs = self.header.unix_nsecs.to_be_bytes().to_vec();
         header_unix_timestamp.extend_from_slice(&header_unix_nsecs);
@@ -135,8 +135,8 @@ impl V5 {
             let output = set.output.to_be_bytes();
             let d_pkts = set.d_pkts.to_be_bytes();
             let d_octets = set.d_octets.to_be_bytes();
-            let first = (set.first).to_be_bytes();
-            let last = (set.last).to_be_bytes();
+            let first = set.first.to_be_bytes();
+            let last = set.last.to_be_bytes();
             let src_port = set.src_port.to_be_bytes();
             let dst_ports = set.dst_port.to_be_bytes();
             let pad1 = set.pad1.to_be_bytes();

src/static_versions/v7.rs

@@ -131,8 +131,8 @@ impl V7 {
             let output = set.output.to_be_bytes();
             let d_pkts = set.d_pkts.to_be_bytes();
             let d_octets = set.d_octets.to_be_bytes();
-            let first = (set.first).to_be_bytes();
-            let last = (set.last).to_be_bytes();
+            let first = set.first.to_be_bytes();
+            let last = set.last.to_be_bytes();
             let src_port = set.src_port.to_be_bytes();
             let dst_ports = set.dst_port.to_be_bytes();
             let flag_field_valid = set.flags_fields_valid.to_be_bytes();

src/variable_versions/data_number.rs

@@ -261,7 +261,7 @@ impl From<DataNumber> for usize {
     }
 }
 
-/// Holds the post parsed field with its relvant datatype
+/// Holds the post parsed field with its relevant datatype
 #[derive(Debug, PartialEq, PartialOrd, Clone, Serialize)]
 pub enum FieldValue {
     String(String),
@@ -402,7 +402,7 @@ impl FieldValue {
     }
 }
 
-/// Helps the parser indefiy the data type to parse the field as
+/// Helps the parser indent the data type to parse the field as
 #[derive(Debug, PartialEq, Eq, Clone, Serialize)]
 pub enum FieldDataType {
     String,

src/variable_versions/ipfix.rs

@@ -350,7 +350,7 @@ impl IPFix {
 
         result.extend_from_slice(&self.header.version.to_be_bytes());
         result.extend_from_slice(&self.header.length.to_be_bytes());
-        result.extend_from_slice(&(self.header.export_time).to_be_bytes());
+        result.extend_from_slice(&self.header.export_time.to_be_bytes());
         result.extend_from_slice(&self.header.sequence_number.to_be_bytes());
         result.extend_from_slice(&self.header.observation_domain_id.to_be_bytes());
 

src/variable_versions/v9.rs

@@ -170,7 +170,7 @@ pub struct Template {
 pub struct OptionsTemplate {
     /// As a router generates different template FlowSets to match the type of NetFlow data it is exporting, each template is given a unique ID. This uniqueness is local to the router that generated the template ID. The Template ID is greater than 255. Template IDs inferior to 255 are reserved.
     pub template_id: u16,
-    /// This field gives the length in bytes of any scope fields that are contained in this options template.
+    /// This field gives the length in bytes of any scope fields that are contained in this options' template.
     pub options_scope_length: u16,
     /// This field gives the length (in bytes) of any Options field definitions that are contained in this options template
     pub options_length: u16,
@@ -201,7 +201,7 @@ pub struct TemplateField {
     /// that defines the known field types and their lengths.
     /// The currently defined field types are detailed in Table 6.
     pub field_type_number: u16,
-    /// Human readable type
+    /// Human-readable type
     #[nom(Value(V9Field::from(field_type_number)))]
     pub field_type: V9Field,
     /// This number gives the length of the above-defined field, in bytes.