grpc tests + cleanup

Author: mhils

mitmproxy-contentviews/benches/contentviews.rs

@@ -1,5 +1,5 @@
 use criterion::{black_box, criterion_group, criterion_main, Criterion};
-use mitmproxy_contentviews::{MsgPack, Prettify, Protobuf, Reencode, TestMetadata};
+use mitmproxy_contentviews::{test::TestMetadata, MsgPack, Prettify, Protobuf, Reencode};
 
 fn criterion_benchmark(c: &mut Criterion) {
     c.bench_function("protobuf-prettify", |b| {

mitmproxy-contentviews/src/grpc.rs

@@ -71,9 +71,36 @@ impl Reencode for GRPC {
 
 #[cfg(test)]
 mod tests {
+    use super::*;
+    use crate::test::TestMetadata;
+
+    const TEST_YAML: &str = "1: 150\n\n---\n\n1: 150\n";
+    const TEST_GRPC: &[u8] = &[
+        0, 0, 0, 0, 3, 8, 150, 1,  // first message
+        0, 0, 0, 0, 3, 8, 150, 1,  // second message
+    ];
+
+    #[test]
+    fn test_empty() {
+        let res = GRPC.prettify(&vec![], &TestMetadata::default()).unwrap();
+        assert_eq!(res, "");
+    }
+
+    #[test]
+    fn test_prettify_two_messages() {
+        let res = GRPC.prettify(TEST_GRPC, &TestMetadata::default()).unwrap();
+        assert_eq!(res, TEST_YAML);
+    }
+
+    #[test]
+    fn test_reencode_two_messages() {
+        let res = GRPC.reencode(TEST_YAML, &TestMetadata::default()).unwrap();
+        assert_eq!(res, TEST_GRPC);
+    }
 
     #[test]
-    fn test_grpc() {
-        // FIXME
+    fn test_render_priority() {
+        assert_eq!(GRPC.render_priority(b"", &TestMetadata::default().with_content_type("application/grpc")), 1.0);
+        assert_eq!(GRPC.render_priority(b"", &TestMetadata::default().with_content_type("text/plain")), 0.0);
     }
 }

mitmproxy-contentviews/src/hex_dump.rs

@@ -36,7 +36,7 @@ impl Prettify for HexDump {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::TestMetadata;
+    use crate::test::TestMetadata;
 
     #[test]
     fn prettify_simple() {

mitmproxy-contentviews/src/hex_stream.rs

@@ -50,7 +50,7 @@ impl Reencode for HexStream {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::TestMetadata;
+    use crate::test::TestMetadata;
 
     #[test]
     fn test_hex_stream() {

mitmproxy-contentviews/src/lib.rs

@@ -14,22 +14,31 @@ use anyhow::Result;
 use mitmproxy_highlight::Language;
 
 pub trait Metadata {
+    /// The HTTP `content-type` of this message.
     fn content_type(&self) -> Option<&str>;
 }
 
+/// See https://docs.mitmproxy.org/dev/api/mitmproxy/contentviews.html
+/// for API details.
 pub trait Prettify: Send + Sync {
+    /// The name for this contentview, e.g. `gRPC` or `Protobuf`.
+    /// Favor brevity.
     fn name(&self) -> &str;
 
     fn instance_name(&self) -> String {
         self.name().to_lowercase().replace(" ", "_")
     }
 
+    /// The syntax highlighting that should be applied to the prettified output.
+    /// This is useful for contentviews that prettify to JSON or YAML.
     fn syntax_highlight(&self) -> Language {
         Language::None
     }
 
+    /// Pretty-print `data`.
     fn prettify(&self, data: &[u8], metadata: &dyn Metadata) -> Result<String>;
 
+    /// Render priority - typically a float between 0 and 1 for builtin views.
     #[allow(unused_variables)]
     fn render_priority(&self, data: &[u8], metadata: &dyn Metadata) -> f64 {
         0.0
@@ -40,13 +49,27 @@ pub trait Reencode: Send + Sync {
     fn reencode(&self, data: &str, metadata: &dyn Metadata) -> Result<Vec<u8>>;
 }
 
-#[derive(Default)]
-pub struct TestMetadata {
-    pub content_type: Option<String>,
-}
+// no cfg(test) gate because it's used in benchmarks as well
+pub mod test {
+    use crate::Metadata;
+
+    #[derive(Default)]
+    pub struct TestMetadata {
+        pub content_type: Option<String>,
+    }
 
-impl Metadata for TestMetadata {
-    fn content_type(&self) -> Option<&str> {
-        self.content_type.as_deref()
+    impl TestMetadata {
+        pub fn with_content_type(mut self, content_type: &str) -> Self {
+            self.content_type = Some(content_type.to_string());
+            self
+        }
     }
+
+    impl Metadata for TestMetadata {
+        fn content_type(&self) -> Option<&str> {
+            self.content_type.as_deref()
+        }
+    }
+
+
 }

mitmproxy-contentviews/src/msgpack.rs

@@ -48,7 +48,7 @@ impl Reencode for MsgPack {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::TestMetadata;
+    use crate::test::TestMetadata;
 
     // Hardcoded MsgPack data for a simple object:
     // {

mitmproxy-contentviews/src/protobuf.rs

@@ -538,7 +538,7 @@ pub(super) mod reencode {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::TestMetadata;
+    use crate::test::TestMetadata;
 
     macro_rules! test_roundtrip {
         ($name:ident,$proto:literal,$yaml:literal) => {

mitmproxy-rs/src/contentview.rs

@@ -26,8 +26,7 @@ impl Metadata for PythonMetadata<'_> {
                     .extract::<String>()
                     .ok()
             })
-            .as_ref()
-            .map(|ct| ct.as_str())
+            .as_deref()
     }
 }