More tests for CodedInputStream, and some more WireFormat

committer: Jon Skeet <skeet@pobox.com>

1 files changed, 335 insertions, 6 deletions

diff --git a/csharp/ProtocolBuffers.Test/CodedInputStreamTest.cs b/csharp/ProtocolBuffers.Test/CodedInputStreamTest.cs
index 56b17a35..8fefd98f 100644
--- a/csharp/ProtocolBuffers.Test/CodedInputStreamTest.cs
+++ b/csharp/ProtocolBuffers.Test/CodedInputStreamTest.cs
@@ -2,16 +2,153 @@
 using System.Collections.Generic;
 using System.Text;
 using NUnit.Framework;
+using System.IO;
 
 namespace Google.ProtocolBuffers {
   [TestFixture]
   public class CodedInputStreamTest {
-    
+
+    /// <summary>
+    /// Helper to construct a byte array from a bunch of bytes.  The inputs are
+    /// actually ints so that I can use hex notation and not get stupid errors
+    /// about precision.
+    /// </summary>
+    private static byte[] Bytes(params int[] bytesAsInts) {
+      byte[] bytes = new byte[bytesAsInts.Length];
+      for (int i = 0; i < bytesAsInts.Length; i++) {
+        bytes[i] = (byte)bytesAsInts[i];
+      }
+      return bytes;
+    }
+
+    /// <summary>
+    /// Parses the given bytes using ReadRawVarint32() and ReadRawVarint64() and
+    /// </summary>
+    private static void AssertReadVarint(byte[] data, ulong value) {
+      CodedInputStream input = CodedInputStream.CreateInstance(data);
+      Assert.AreEqual((uint)value, input.ReadRawVarint32());
+
+      input = CodedInputStream.CreateInstance(data);
+      Assert.AreEqual(value, input.ReadRawVarint64());
+
+      // Try different block sizes.
+      for (int bufferSize = 1; bufferSize <= 16; bufferSize *= 2) {
+        input = CodedInputStream.CreateInstance(new SmallBlockInputStream(data, bufferSize));
+        Assert.AreEqual((uint)value, input.ReadRawVarint32());
+
+        input = CodedInputStream.CreateInstance(new SmallBlockInputStream(data, bufferSize));
+        Assert.AreEqual(value, input.ReadRawVarint64());
+      }
+    }
+
+    /// <summary>
+    /// Parses the given bytes using ReadRawVarint32() and ReadRawVarint64() and
+    /// expects them to fail with an InvalidProtocolBufferException whose
+    /// description matches the given one.
+    /// </summary>
+    private void AssertReadVarintFailure(InvalidProtocolBufferException expected, byte[] data) {
+      CodedInputStream input = CodedInputStream.CreateInstance(data);
+      try {
+        input.ReadRawVarint32();
+        Assert.Fail("Should have thrown an exception.");
+      } catch (InvalidProtocolBufferException e) {
+        Assert.AreEqual(expected.Message, e.Message);
+      }
+
+      input = CodedInputStream.CreateInstance(data);
+      try {
+        input.ReadRawVarint64();
+        Assert.Fail("Should have thrown an exception.");
+      } catch (InvalidProtocolBufferException e) {
+        Assert.AreEqual(expected.Message, e.Message);
+      }
+    }
+
+    [Test]
+    public void ReadVarint() {
+      AssertReadVarint(Bytes(0x00), 0);
+      AssertReadVarint(Bytes(0x01), 1);
+      AssertReadVarint(Bytes(0x7f), 127);
+      // 14882
+      AssertReadVarint(Bytes(0xa2, 0x74), (0x22 << 0) | (0x74 << 7));
+      // 2961488830
+      AssertReadVarint(Bytes(0xbe, 0xf7, 0x92, 0x84, 0x0b),
+        (0x3e << 0) | (0x77 << 7) | (0x12 << 14) | (0x04 << 21) |
+        (0x0bL << 28));
+
+      // 64-bit
+      // 7256456126
+      AssertReadVarint(Bytes(0xbe, 0xf7, 0x92, 0x84, 0x1b),
+        (0x3e << 0) | (0x77 << 7) | (0x12 << 14) | (0x04 << 21) |
+        (0x1bL << 28));
+      // 41256202580718336
+      AssertReadVarint(Bytes(0x80, 0xe6, 0xeb, 0x9c, 0xc3, 0xc9, 0xa4, 0x49),
+        (0x00 << 0) | (0x66 << 7) | (0x6b << 14) | (0x1c << 21) |
+        (0x43L << 28) | (0x49L << 35) | (0x24L << 42) | (0x49L << 49));
+      // 11964378330978735131
+      AssertReadVarint(Bytes(0x9b, 0xa8, 0xf9, 0xc2, 0xbb, 0xd6, 0x80, 0x85, 0xa6, 0x01),
+        (0x1b << 0) | (0x28 << 7) | (0x79 << 14) | (0x42 << 21) |
+        (0x3bUL << 28) | (0x56UL << 35) | (0x00UL << 42) |
+        (0x05UL << 49) | (0x26UL << 56) | (0x01UL << 63));
+
+      // Failures
+      AssertReadVarintFailure(
+        InvalidProtocolBufferException.MalformedVarint(),
+        Bytes(0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80,
+              0x00));
+      AssertReadVarintFailure(
+        InvalidProtocolBufferException.TruncatedMessage(),
+        Bytes(0x80));
+    }
+
+    /// <summary>
+    /// Parses the given bytes using ReadRawLittleEndian32() and checks
+    /// that the result matches the given value.
+    /// </summary>
+    private static void AssertReadLittleEndian32(byte[] data, int value) {
+      CodedInputStream input = CodedInputStream.CreateInstance(data);
+      Assert.AreEqual(value, input.ReadRawLittleEndian32());
+
+      // Try different block sizes.
+      for (int blockSize = 1; blockSize <= 16; blockSize *= 2) {
+        input = CodedInputStream.CreateInstance(
+          new SmallBlockInputStream(data, blockSize));
+        Assert.AreEqual(value, input.ReadRawLittleEndian32());
+      }
+    }
+
+    /// <summary>
+    /// Parses the given bytes using ReadRawLittleEndian64() and checks
+    /// that the result matches the given value.
+    /// </summary>
+    private static void AssertReadLittleEndian64(byte[] data, long value) {
+      CodedInputStream input = CodedInputStream.CreateInstance(data);
+      Assert.AreEqual(value, input.ReadRawLittleEndian64());
+
+      // Try different block sizes.
+      for (int blockSize = 1; blockSize <= 16; blockSize *= 2) {
+        input = CodedInputStream.CreateInstance(
+          new SmallBlockInputStream(data, blockSize));
+        Assert.AreEqual(value, input.ReadRawLittleEndian64());
+      }
+    }
+
+    [Test]
+    public void ReadLittleEndian() {
+      AssertReadLittleEndian32(Bytes(0x78, 0x56, 0x34, 0x12), 0x12345678);
+      AssertReadLittleEndian32(Bytes(0xf0, 0xde, 0xbc, 0x9a), unchecked((int)0x9abcdef0));
+
+      AssertReadLittleEndian64(Bytes(0xf0, 0xde, 0xbc, 0x9a, 0x78, 0x56, 0x34, 0x12),
+        0x123456789abcdef0L);
+      AssertReadLittleEndian64(
+        Bytes(0x78, 0x56, 0x34, 0x12, 0xf0, 0xde, 0xbc, 0x9a), unchecked((long)0x9abcdef012345678L));
+    }
+
     [Test]
     public void DecodeZigZag32() {
-      Assert.AreEqual( 0, CodedInputStream.DecodeZigZag32(0));
+      Assert.AreEqual(0, CodedInputStream.DecodeZigZag32(0));
       Assert.AreEqual(-1, CodedInputStream.DecodeZigZag32(1));
-      Assert.AreEqual( 1, CodedInputStream.DecodeZigZag32(2));
+      Assert.AreEqual(1, CodedInputStream.DecodeZigZag32(2));
       Assert.AreEqual(-2, CodedInputStream.DecodeZigZag32(3));
       Assert.AreEqual(0x3FFFFFFF, CodedInputStream.DecodeZigZag32(0x7FFFFFFE));
       Assert.AreEqual(unchecked((int)0xC0000000), CodedInputStream.DecodeZigZag32(0x7FFFFFFF));
@@ -21,16 +158,208 @@ namespace Google.ProtocolBuffers {
 
     [Test]
     public void DecodeZigZag64() {
-      Assert.AreEqual( 0, CodedInputStream.DecodeZigZag64(0));
+      Assert.AreEqual(0, CodedInputStream.DecodeZigZag64(0));
       Assert.AreEqual(-1, CodedInputStream.DecodeZigZag64(1));
-      Assert.AreEqual( 1, CodedInputStream.DecodeZigZag64(2));
+      Assert.AreEqual(1, CodedInputStream.DecodeZigZag64(2));
       Assert.AreEqual(-2, CodedInputStream.DecodeZigZag64(3));
       Assert.AreEqual(0x000000003FFFFFFFL, CodedInputStream.DecodeZigZag64(0x000000007FFFFFFEL));
       Assert.AreEqual(unchecked((long)0xFFFFFFFFC0000000L), CodedInputStream.DecodeZigZag64(0x000000007FFFFFFFL));
       Assert.AreEqual(0x000000007FFFFFFFL, CodedInputStream.DecodeZigZag64(0x00000000FFFFFFFEL));
       Assert.AreEqual(unchecked((long)0xFFFFFFFF80000000L), CodedInputStream.DecodeZigZag64(0x00000000FFFFFFFFL));
       Assert.AreEqual(0x7FFFFFFFFFFFFFFFL, CodedInputStream.DecodeZigZag64(0xFFFFFFFFFFFFFFFEL));
-      Assert.AreEqual(unchecked((long)0x8000000000000000L),CodedInputStream.DecodeZigZag64(0xFFFFFFFFFFFFFFFFL));
+      Assert.AreEqual(unchecked((long)0x8000000000000000L), CodedInputStream.DecodeZigZag64(0xFFFFFFFFFFFFFFFFL));
+    }
+
+    /* TODO(jonskeet): Reinstate this when protoc is ready
+    public void testReadWholeMessage() throws Exception {
+      TestAllTypes message = TestUtil.getAllSet();
+
+      byte[] rawBytes = message.toByteArray();
+      assertEquals(rawBytes.length, message.getSerializedSize());
+
+      TestAllTypes message2 = TestAllTypes.parseFrom(rawBytes);
+      TestUtil.assertAllFieldsSet(message2);
+
+      // Try different block sizes.
+      for (int blockSize = 1; blockSize < 256; blockSize *= 2) {
+        message2 = TestAllTypes.parseFrom(
+          new SmallBlockInputStream(rawBytes, blockSize));
+        TestUtil.assertAllFieldsSet(message2);
+      }
+    }*/
+
+    /* TODO(jonskeet): Reinstate this when protoc is ready
+    public void testSkipWholeMessage() throws Exception {
+      TestAllTypes message = TestUtil.getAllSet();
+      byte[] rawBytes = message.toByteArray();
+
+      // Create two parallel inputs.  Parse one as unknown fields while using
+      // skipField() to skip each field on the other.  Expect the same tags.
+      CodedInputStream input1 = CodedInputStream.newInstance(rawBytes);
+      CodedInputStream input2 = CodedInputStream.newInstance(rawBytes);
+      UnknownFieldSet.Builder unknownFields = UnknownFieldSet.newBuilder();
+
+      while (true) {
+        int tag = input1.readTag();
+        assertEquals(tag, input2.readTag());
+        if (tag == 0) {
+          break;
+        }
+        unknownFields.mergeFieldFrom(tag, input1);
+        input2.skipField(tag);
+      }
+    }*/
+
+    /* TODO(jonskeet): Reinstate this when protoc is ready
+    public void testReadHugeBlob() throws Exception {
+      // Allocate and initialize a 1MB blob.
+      byte[] blob = new byte[1 << 20];
+      for (int i = 0; i < blob.length; i++) {
+        blob[i] = (byte)i;
+      }
+
+      // Make a message containing it.
+      TestAllTypes.Builder builder = TestAllTypes.newBuilder();
+      TestUtil.setAllFields(builder);
+      builder.setOptionalBytes(ByteString.copyFrom(blob));
+      TestAllTypes message = builder.build();
+
+      // Serialize and parse it.  Make sure to parse from an InputStream, not
+      // directly from a ByteString, so that CodedInputStream uses buffered
+      // reading.
+      TestAllTypes message2 =
+        TestAllTypes.parseFrom(message.toByteString().newInput());
+
+      assertEquals(message.getOptionalBytes(), message2.getOptionalBytes());
+
+      // Make sure all the other fields were parsed correctly.
+      TestAllTypes message3 = TestAllTypes.newBuilder(message2)
+        .setOptionalBytes(TestUtil.getAllSet().getOptionalBytes())
+        .build();
+      TestUtil.assertAllFieldsSet(message3);
+    }*/
+
+    [Test]
+    public void ReadMaliciouslyLargeBlob() {
+      MemoryStream ms = new MemoryStream();
+      CodedOutputStream output = CodedOutputStream.CreateInstance(ms);
+
+      uint tag = WireFormat.MakeTag(1, WireFormat.WireType.LengthDelimited);
+      output.WriteRawVarint32(tag);
+      output.WriteRawVarint32(0x7FFFFFFF);
+      output.WriteRawBytes(new byte[32]);  // Pad with a few random bytes.
+      output.Flush();
+      ms.Position = 0;
+
+      CodedInputStream input = CodedInputStream.CreateInstance(ms);
+      Assert.AreEqual(tag, input.ReadTag());
+
+      try {
+        input.ReadBytes();
+        Assert.Fail("Should have thrown an exception!");
+      } catch (InvalidProtocolBufferException) {
+        // success.
+      }
+    }
+
+    
+    /* TODO(jonskeet): Reinstate this when protoc is ready
+    private TestRecursiveMessage makeRecursiveMessage(int depth) {
+      if (depth == 0) {
+        return TestRecursiveMessage.newBuilder().setI(5).build();
+      } else {
+        return TestRecursiveMessage.newBuilder()
+          .setA(makeRecursiveMessage(depth - 1)).build();
+      }
+    }
+
+    private void assertMessageDepth(TestRecursiveMessage message, int depth) {
+      if (depth == 0) {
+        assertFalse(message.hasA());
+        assertEquals(5, message.getI());
+      } else {
+        assertTrue(message.hasA());
+        assertMessageDepth(message.getA(), depth - 1);
+      }
+    }
+
+    public void testMaliciousRecursion() {
+      ByteString data64 = makeRecursiveMessage(64).toByteString();
+      ByteString data65 = makeRecursiveMessage(65).toByteString();
+
+      assertMessageDepth(TestRecursiveMessage.parseFrom(data64), 64);
+
+      try {
+        TestRecursiveMessage.parseFrom(data65);
+        fail("Should have thrown an exception!");
+      } catch (InvalidProtocolBufferException e) {
+        // success.
+      }
+
+      CodedInputStream input = data64.newCodedInput();
+      input.setRecursionLimit(8);
+      try {
+        TestRecursiveMessage.parseFrom(input);
+        fail("Should have thrown an exception!");
+      } catch (InvalidProtocolBufferException e) {
+        // success.
+      }
+    }
+     */
+
+     /* TODO(jonskeet): Reinstate this when protoc is ready
+    public void testSizeLimit() throws Exception {
+      CodedInputStream input = CodedInputStream.newInstance(
+        TestUtil.getAllSet().toByteString().newInput());
+      input.setSizeLimit(16);
+
+      try {
+        TestAllTypes.parseFrom(input);
+        fail("Should have thrown an exception!");
+      } catch (InvalidProtocolBufferException e) {
+        // success.
+      }
+    }*/
+
+    /// <summary>
+    /// Tests that if we read an string that contains invalid UTF-8, no exception
+    /// is thrown.  Instead, the invalid bytes are replaced with the Unicode
+    /// "replacement character" U+FFFD.
+    /// </summary>
+    [Test]
+    public void ReadInvalidUtf8()  {
+      MemoryStream ms = new MemoryStream();
+      CodedOutputStream output = CodedOutputStream.CreateInstance(ms);
+
+      uint tag = WireFormat.MakeTag(1, WireFormat.WireType.LengthDelimited);
+      output.WriteRawVarint32(tag);
+      output.WriteRawVarint32(1);
+      output.WriteRawBytes(new byte[] { 0x80 });
+      output.Flush();
+      ms.Position = 0;
+
+      CodedInputStream input = CodedInputStream.CreateInstance(ms);
+      Assert.AreEqual(tag, input.ReadTag());
+      string text = input.ReadString();
+      Assert.AreEqual('\ufffd', text[0]);
+    }
+
+    /// <summary>
+    /// A stream which limits the number of bytes it reads at a time.
+    /// We use this to make sure that CodedInputStream doesn't screw up when
+    /// reading in small blocks.
+    /// </summary>
+    private sealed class SmallBlockInputStream : MemoryStream {
+      private readonly int blockSize;
+
+      public SmallBlockInputStream(byte[] data, int blockSize)
+        : base(data) {
+        this.blockSize = blockSize;
+      }
+
+      public override int Read(byte[] buffer, int offset, int count) {
+        return base.Read(buffer, offset, Math.Min(count, blockSize));
+      }
     }
   }
 }