X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=fuzz%2Fsrc%2Fmsg_targets%2Futils.rs;h=82fa739fbcfbd4febfb33af89b6bbcb31717d559;hb=b56b4add6ae0625271a66a8a1a48058c7f542352;hp=a5257ba0f80c1fea24f399018103da37f572c763;hpb=e28fd78e67b92de9f42dae3636c5dbea5e9b1f86;p=rust-lightning

diff --git a/fuzz/src/msg_targets/utils.rs b/fuzz/src/msg_targets/utils.rs
index a5257ba0..82fa739f 100644
--- a/fuzz/src/msg_targets/utils.rs
+++ b/fuzz/src/msg_targets/utils.rs
@@ -1,3 +1,12 @@
+// This file is Copyright its original authors, visible in version control
+// history.
+//
+// This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
+// or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
+// You may not use this file except in accordance with one or both of these
+// licenses.
+
 #![macro_use]
 
 use lightning::util::ser::Writer;
@@ -13,13 +22,22 @@ impl Writer for VecWriter {
 	}
 }
 
+// We attempt to test the strictest behavior we can for a given message, however, some messages
+// have different expected behavior. You can see which messages have which behavior in
+// gen_target.sh, but, in general, the *_announcement messages have to round-trip exactly (as
+// otherwise we'd invalidate the signatures), most messages just need to round-trip up to the
+// amount of data we know how to interpret, and some messages we may throw out invalid stuff (eg
+// if an error message isn't valid UTF-8 we cant String-ize it), so they wont roundtrip correctly.
+
+// Tests a message that must survive roundtrip exactly, though may not empty the read buffer
+// entirely
 #[macro_export]
 macro_rules! test_msg {
 	($MsgType: path, $data: ident) => {
 		{
 			use lightning::util::ser::{Writeable, Readable};
 			let mut r = ::std::io::Cursor::new($data);
-			if let Ok(msg) = <$MsgType as Readable<::std::io::Cursor<&[u8]>>>::read(&mut r) {
+			if let Ok(msg) = <$MsgType as Readable>::read(&mut r) {
 				let p = r.position() as usize;
 				let mut w = VecWriter(Vec::new());
 				msg.write(&mut w).unwrap();
@@ -31,43 +49,53 @@ macro_rules! test_msg {
 	}
 }
 
+// Tests a message that may lose data on roundtrip, but shoulnd't lose data compared to our
+// re-serialization.
 #[macro_export]
 macro_rules! test_msg_simple {
 	($MsgType: path, $data: ident) => {
 		{
 			use lightning::util::ser::{Writeable, Readable};
 			let mut r = ::std::io::Cursor::new($data);
-			if let Ok(msg) = <$MsgType as Readable<::std::io::Cursor<&[u8]>>>::read(&mut r) {
+			if let Ok(msg) = <$MsgType as Readable>::read(&mut r) {
 				let mut w = VecWriter(Vec::new());
 				msg.write(&mut w).unwrap();
+
+				let msg = <$MsgType as Readable>::read(&mut ::std::io::Cursor::new(&w.0)).unwrap();
+				let mut w_two = VecWriter(Vec::new());
+				msg.write(&mut w_two).unwrap();
+				assert_eq!(&w.0[..], &w_two.0[..]);
 			}
 		}
 	}
 }
 
+// Tests a message that must survive roundtrip exactly, and must exactly empty the read buffer and
+// split it back out on re-serialization.
 #[macro_export]
 macro_rules! test_msg_exact {
 	($MsgType: path, $data: ident) => {
 		{
 			use lightning::util::ser::{Writeable, Readable};
 			let mut r = ::std::io::Cursor::new($data);
-			if let Ok(msg) = <$MsgType as Readable<::std::io::Cursor<&[u8]>>>::read(&mut r) {
+			if let Ok(msg) = <$MsgType as Readable>::read(&mut r) {
 				let mut w = VecWriter(Vec::new());
 				msg.write(&mut w).unwrap();
-
 				assert_eq!(&r.into_inner()[..], &w.0[..]);
 			}
 		}
 	}
 }
 
+// Tests a message that must survive roundtrip exactly, modulo one "hole" which may be set to
+// any value on re-serialization.
 #[macro_export]
 macro_rules! test_msg_hole {
 	($MsgType: path, $data: ident, $hole: expr, $hole_len: expr) => {
 		{
 			use lightning::util::ser::{Writeable, Readable};
 			let mut r = ::std::io::Cursor::new($data);
-			if let Ok(msg) = <$MsgType as Readable<::std::io::Cursor<&[u8]>>>::read(&mut r) {
+			if let Ok(msg) = <$MsgType as Readable>::read(&mut r) {
 				let mut w = VecWriter(Vec::new());
 				msg.write(&mut w).unwrap();
 				let p = w.0.len() as usize;