WebSocketFrameChunk should use IOBuffer to hold data

net/websockets/websocket_frame_parser_unittest.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "net/websockets/websocket_frame_parser.h"
 
+#include <algorithm>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/memory/scoped_vector.h"
 #include "base/port.h"
+#include "net/base/io_buffer.h"
 #include "net/websockets/websocket_frame.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 namespace {
 
 const char kHello[] = "Hello, world!";
 const uint64 kHelloLength = arraysize(kHello) - 1;
 const char kHelloFrame[] = "\x81\x0DHello, world!";
 const uint64 kHelloFrameLength = arraysize(kHelloFrame) - 1;
 const char kMaskedHelloFrame[] =
     "\x81\x8D\xDE\xAD\xBE\xEF"
     "\x96\xC8\xD2\x83\xB1\x81\x9E\x98\xB1\xDF\xD2\x8B\xFF";
 const uint64 kMaskedHelloFrameLength = arraysize(kMaskedHelloFrame) - 1;
 
 struct FrameHeaderTestCase {
   const char* frame_header;
   size_t frame_header_length;
   uint64 frame_length;
+  bool failed;
 };
 
+// TODO(toyoshim): Provide error code and check if the reason is correct.
 const FrameHeaderTestCase kFrameHeaderTests[] = {
-  { "\x81\x00", 2, GG_UINT64_C(0) },
-  { "\x81\x7D", 2, GG_UINT64_C(125) },
-  { "\x81\x7E\x00\x7E", 4, GG_UINT64_C(126) },
-  { "\x81\x7E\xFF\xFF", 4, GG_UINT64_C(0xFFFF) },
-  { "\x81\x7F\x00\x00\x00\x00\x00\x01\x00\x00", 10, GG_UINT64_C(0x10000) },
+  { "\x81\x00", 2, GG_UINT64_C(0), false },
+  { "\x81\x7D", 2, GG_UINT64_C(125), false },
+  { "\x81\x7E\x00\x7E", 4, GG_UINT64_C(126), false },
+  { "\x81\x7E\xFF\xFF", 4, GG_UINT64_C(0xFFFF), false },
+  { "\x81\x7F\x00\x00\x00\x00\x00\x01\x00\x00", 10, GG_UINT64_C(0x10000),
+    false },
+  { "\x81\x7F\x00\x00\x00\x00\x7F\xFF\xFF\xFF", 10, GG_UINT64_C(0x7FFFFFFF),
+    false },
+  { "\x81\x7F\x00\x00\x00\x00\x80\x00\x00\x00", 10, GG_UINT64_C(0x80000000),
+    true },
   { "\x81\x7F\x7F\xFF\xFF\xFF\xFF\xFF\xFF\xFF", 10,
-    GG_UINT64_C(0x7FFFFFFFFFFFFFFF) }
+    GG_UINT64_C(0x7FFFFFFFFFFFFFFF), true }
 };
 const int kNumFrameHeaderTests = arraysize(kFrameHeaderTests);
 
 }  // Unnamed namespace
 
 namespace net {
 
 TEST(WebSocketFrameParserTest, DecodeNormalFrame) {
   WebSocketFrameParser parser;
 
   ScopedVector<WebSocketFrameChunk> frames;
   EXPECT_TRUE(parser.Decode(kHelloFrame, kHelloFrameLength, &frames));
   EXPECT_FALSE(parser.failed());
   ASSERT_EQ(1u, frames.size());
   WebSocketFrameChunk* frame = frames[0];
   ASSERT_TRUE(frame != NULL);
   const WebSocketFrameHeader* header = frame->header.get();
   EXPECT_TRUE(header != NULL);
   if (header) {
     EXPECT_TRUE(header->final);
     EXPECT_FALSE(header->reserved1);
     EXPECT_FALSE(header->reserved2);
     EXPECT_FALSE(header->reserved3);
     EXPECT_EQ(WebSocketFrameHeader::kOpCodeText, header->opcode);
     EXPECT_FALSE(header->masked);
     EXPECT_EQ(kHelloLength, header->payload_length);
   }
   EXPECT_TRUE(frame->final_chunk);
 
-  std::vector<char> expected_data(kHello, kHello + kHelloLength);
-  EXPECT_EQ(expected_data, frame->data);
+  ASSERT_EQ(static_cast<int>(kHelloLength), frame->data->size());
+  EXPECT_TRUE(std::equal(kHello, kHello + kHelloLength, frame->data->data()));
 }
 
 TEST(WebSocketFrameParserTest, DecodeMaskedFrame) {
   WebSocketFrameParser parser;
 
   ScopedVector<WebSocketFrameChunk> frames;
   EXPECT_TRUE(parser.Decode(kMaskedHelloFrame, kMaskedHelloFrameLength,
                             &frames));
   EXPECT_FALSE(parser.failed());
   ASSERT_EQ(1u, frames.size());
   WebSocketFrameChunk* frame = frames[0];
   ASSERT_TRUE(frame != NULL);
   const WebSocketFrameHeader* header = frame->header.get();
   EXPECT_TRUE(header != NULL);
   if (header) {
     EXPECT_TRUE(header->final);
     EXPECT_FALSE(header->reserved1);
     EXPECT_FALSE(header->reserved2);
     EXPECT_FALSE(header->reserved3);
     EXPECT_EQ(WebSocketFrameHeader::kOpCodeText, header->opcode);
     EXPECT_TRUE(header->masked);
     EXPECT_EQ(kHelloLength, header->payload_length);
   }
   EXPECT_TRUE(frame->final_chunk);
 
-  std::vector<char> expected_data(kHello, kHello + kHelloLength);
-  EXPECT_EQ(expected_data, frame->data);
+  ASSERT_EQ(static_cast<int>(kHelloLength), frame->data->size());
+  EXPECT_TRUE(std::equal(kHello, kHello + kHelloLength, frame->data->data()));
 }
 
 TEST(WebSocketFrameParserTest, DecodeManyFrames) {
   struct Input {
     const char* frame;
     size_t frame_length;
     const char* expected_payload;
     size_t expected_payload_length;
   };
   static const Input kInputs[] = {
@@ skipping 28 matching lines @@
   EXPECT_TRUE(parser.Decode(&input.front(), input.size(), &frames));
   EXPECT_FALSE(parser.failed());
   ASSERT_EQ(static_cast<size_t>(kNumInputs), frames.size());
 
   for (int i = 0; i < kNumInputs; ++i) {
     WebSocketFrameChunk* frame = frames[i];
     EXPECT_TRUE(frame != NULL);
     if (!frame)
       continue;
     EXPECT_TRUE(frame->final_chunk);
-    std::vector<char> expected_data(
+    ASSERT_EQ(kInputs[i].expected_payload_length,
+              static_cast<uint64>(frame->data->size()));
+    EXPECT_TRUE(std::equal(
         kInputs[i].expected_payload,
-        kInputs[i].expected_payload + kInputs[i].expected_payload_length);
-    EXPECT_EQ(expected_data, frame->data);
+        kInputs[i].expected_payload + kInputs[i].expected_payload_length,
+        frame->data->data()));
 
     const WebSocketFrameHeader* header = frame->header.get();
     EXPECT_TRUE(header != NULL);
     if (!header)
       continue;
     EXPECT_TRUE(header->final);
     EXPECT_FALSE(header->reserved1);
     EXPECT_FALSE(header->reserved2);
     EXPECT_FALSE(header->reserved3);
     EXPECT_EQ(WebSocketFrameHeader::kOpCodeText, header->opcode);
@@ skipping 20 matching lines @@
     EXPECT_TRUE(parser.Decode(&input1.front(), input1.size(), &frames1));
     EXPECT_FALSE(parser.failed());
     EXPECT_EQ(1u, frames1.size());
     if (frames1.size() != 1u)
       continue;
     WebSocketFrameChunk* frame1 = frames1[0];
     EXPECT_TRUE(frame1 != NULL);
     if (!frame1)
       continue;
     EXPECT_FALSE(frame1->final_chunk);
-    EXPECT_EQ(expected1, frame1->data);
+    if (expected1.size() == 0) {
+      EXPECT_EQ(NULL, frame1->data.get());
+    } else {
+      ASSERT_EQ(cutting_pos, static_cast<size_t>(frame1->data->size()));
+      EXPECT_TRUE(std::equal(expected1.begin(),
+                             expected1.end(),
+                             frame1->data->data()));
+    }
     const WebSocketFrameHeader* header1 = frame1->header.get();
     EXPECT_TRUE(header1 != NULL);
     if (!header1)
       continue;
     EXPECT_TRUE(header1->final);
     EXPECT_FALSE(header1->reserved1);
     EXPECT_FALSE(header1->reserved2);
     EXPECT_FALSE(header1->reserved3);
     EXPECT_EQ(WebSocketFrameHeader::kOpCodeText, header1->opcode);
     EXPECT_FALSE(header1->masked);
     EXPECT_EQ(kHelloLength, header1->payload_length);
 
     ScopedVector<WebSocketFrameChunk> frames2;
     EXPECT_TRUE(parser.Decode(&input2.front(), input2.size(), &frames2));
     EXPECT_FALSE(parser.failed());
     EXPECT_EQ(1u, frames2.size());
     if (frames2.size() != 1u)
       continue;
     WebSocketFrameChunk* frame2 = frames2[0];
     EXPECT_TRUE(frame2 != NULL);
     if (!frame2)
       continue;
     EXPECT_TRUE(frame2->final_chunk);
-    EXPECT_EQ(expected2, frame2->data);
+    if (expected2.size() == 0) {
+      EXPECT_EQ(NULL, frame2->data.get());
+    } else {
+      ASSERT_EQ(expected2.size(), static_cast<uint64>(frame2->data->size()));
+      EXPECT_TRUE(std::equal(expected2.begin(),
+                             expected2.end(),
+                             frame2->data->data()));
+    }
     const WebSocketFrameHeader* header2 = frame2->header.get();
     EXPECT_TRUE(header2 == NULL);
   }
 }
 
 TEST(WebSocketFrameParserTest, DecodePartialMaskedFrame) {
   static const size_t kFrameHeaderSize = 6;
 
   for (size_t cutting_pos = 0; cutting_pos < kHelloLength; ++cutting_pos) {
     std::vector<char> input1(
@@ skipping 11 matching lines @@
     EXPECT_TRUE(parser.Decode(&input1.front(), input1.size(), &frames1));
     EXPECT_FALSE(parser.failed());
     EXPECT_EQ(1u, frames1.size());
     if (frames1.size() != 1u)
       continue;
     WebSocketFrameChunk* frame1 = frames1[0];
     EXPECT_TRUE(frame1 != NULL);
     if (!frame1)
       continue;
     EXPECT_FALSE(frame1->final_chunk);
-    EXPECT_EQ(expected1, frame1->data);
+    if (expected1.size() == 0) {
+      EXPECT_EQ(NULL, frame1->data.get());
+    } else {
+      ASSERT_EQ(expected1.size(), static_cast<uint64>(frame1->data->size()));
+      EXPECT_TRUE(std::equal(expected1.begin(),
+                             expected1.end(),
+                             frame1->data->data()));
+    }
     const WebSocketFrameHeader* header1 = frame1->header.get();
     EXPECT_TRUE(header1 != NULL);
     if (!header1)
       continue;
     EXPECT_TRUE(header1->final);
     EXPECT_FALSE(header1->reserved1);
     EXPECT_FALSE(header1->reserved2);
     EXPECT_FALSE(header1->reserved3);
     EXPECT_EQ(WebSocketFrameHeader::kOpCodeText, header1->opcode);
     EXPECT_TRUE(header1->masked);
     EXPECT_EQ(kHelloLength, header1->payload_length);
 
     ScopedVector<WebSocketFrameChunk> frames2;
     EXPECT_TRUE(parser.Decode(&input2.front(), input2.size(), &frames2));
     EXPECT_FALSE(parser.failed());
     EXPECT_EQ(1u, frames2.size());
     if (frames2.size() != 1u)
       continue;
     WebSocketFrameChunk* frame2 = frames2[0];
     EXPECT_TRUE(frame2 != NULL);
     if (!frame2)
       continue;
     EXPECT_TRUE(frame2->final_chunk);
-    EXPECT_EQ(expected2, frame2->data);
+    if (expected2.size() == 0) {
+      EXPECT_EQ(NULL, frame2->data.get());
+    } else {
+      ASSERT_EQ(expected2.size(), static_cast<uint64>(frame2->data->size()));
+      EXPECT_TRUE(std::equal(expected2.begin(),
+                             expected2.end(),
+                             frame2->data->data()));
+    }
     const WebSocketFrameHeader* header2 = frame2->header.get();
     EXPECT_TRUE(header2 == NULL);
   }
 }
 
 TEST(WebSocketFrameParserTest, DecodeFramesOfVariousLengths) {
   for (int i = 0; i < kNumFrameHeaderTests; ++i) {
     const char* frame_header = kFrameHeaderTests[i].frame_header;
     size_t frame_header_length = kFrameHeaderTests[i].frame_header_length;
     uint64 frame_length = kFrameHeaderTests[i].frame_length;
 
     std::vector<char> input(frame_header, frame_header + frame_header_length);
     // Limit the payload size not to flood the console on failure.
     static const uint64 kMaxPayloadSize = 200;
     uint64 input_payload_size = std::min(frame_length, kMaxPayloadSize);
     input.insert(input.end(), input_payload_size, 'a');
 
     WebSocketFrameParser parser;
 
     ScopedVector<WebSocketFrameChunk> frames;
-    EXPECT_TRUE(parser.Decode(&input.front(), input.size(), &frames));
-    EXPECT_FALSE(parser.failed());
-    EXPECT_EQ(1u, frames.size());
+    EXPECT_EQ(!kFrameHeaderTests[i].failed,
+        parser.Decode(&input.front(), input.size(), &frames));
+    EXPECT_EQ(kFrameHeaderTests[i].failed, parser.failed());
+    if (kFrameHeaderTests[i].failed)
+      EXPECT_EQ(0u, frames.size());
+    else
+      EXPECT_EQ(1u, frames.size());

[mmenke, 2012/07/31 17:03:49]

Suggest you use braces around these code blocks.  Not strictly necessary, but
with macros, seems like a good idea to play it safe.

[Takashi Toyoshima, 2012/08/01 07:06:33]

Thank you for catching this.
I agreed.
I fixed this and other same errors in this file.

     if (frames.size() != 1u)
       continue;
     WebSocketFrameChunk* frame = frames[0];
     EXPECT_TRUE(frame != NULL);
     if (!frame)
       continue;
     if (frame_length == input_payload_size)
       EXPECT_TRUE(frame->final_chunk);
     else
       EXPECT_FALSE(frame->final_chunk);
     std::vector<char> expected_payload(input_payload_size, 'a');
-    EXPECT_EQ(expected_payload, frame->data);
+    if (expected_payload.size() == 0) {
+      EXPECT_EQ(NULL, frame->data.get());
+    } else {
+      ASSERT_EQ(expected_payload.size(),
+                static_cast<uint64>(frame->data->size()));
+      EXPECT_TRUE(std::equal(
+          expected_payload.begin(),
+          expected_payload.end(),
+          frame->data->data()));
+    }
     const WebSocketFrameHeader* header = frame->header.get();
     EXPECT_TRUE(header != NULL);
     if (!header)
       continue;
     EXPECT_TRUE(header->final);
     EXPECT_FALSE(header->reserved1);
     EXPECT_FALSE(header->reserved2);
     EXPECT_FALSE(header->reserved3);
     EXPECT_EQ(WebSocketFrameHeader::kOpCodeText, header->opcode);
     EXPECT_FALSE(header->masked);
     EXPECT_EQ(frame_length, header->payload_length);
   }
 }
 
 TEST(WebSocketFrameParserTest, DecodePartialHeader) {
   for (int i = 0; i < kNumFrameHeaderTests; ++i) {
     const char* frame_header = kFrameHeaderTests[i].frame_header;
     size_t frame_header_length = kFrameHeaderTests[i].frame_header_length;
     uint64 frame_length = kFrameHeaderTests[i].frame_length;
 
     WebSocketFrameParser parser;
 
     ScopedVector<WebSocketFrameChunk> frames;
     // Feed each byte to the parser to see if the parser behaves correctly
     // when it receives partial frame header.
+    size_t last_byte_offset = frame_header_length - 1;
     for (size_t j = 0; j < frame_header_length; ++j) {
-      EXPECT_TRUE(parser.Decode(frame_header + j, 1, &frames));
-      EXPECT_FALSE(parser.failed());
-      if (j == frame_header_length - 1)
+      bool failed = kFrameHeaderTests[i].failed && j == last_byte_offset;
+      EXPECT_EQ(!failed, parser.Decode(frame_header + j, 1, &frames));
+      EXPECT_EQ(failed, parser.failed());
+      if (!kFrameHeaderTests[i].failed && j == last_byte_offset)
         EXPECT_EQ(1u, frames.size());
       else
         EXPECT_EQ(0u, frames.size());
     }
     if (frames.size() != 1u)
       continue;
     WebSocketFrameChunk* frame = frames[0];
     EXPECT_TRUE(frame != NULL);
     if (!frame)
       continue;
     if (frame_length == 0u)
       EXPECT_TRUE(frame->final_chunk);
     else
       EXPECT_FALSE(frame->final_chunk);
-    EXPECT_EQ(std::vector<char>(), frame->data);
+    EXPECT_EQ(NULL, frame->data.get());
     const WebSocketFrameHeader* header = frame->header.get();
     EXPECT_TRUE(header != NULL);
     if (!header)
       continue;
     EXPECT_TRUE(header->final);
     EXPECT_FALSE(header->reserved1);
     EXPECT_FALSE(header->reserved2);
     EXPECT_FALSE(header->reserved3);
     EXPECT_EQ(WebSocketFrameHeader::kOpCodeText, header->opcode);
     EXPECT_FALSE(header->masked);
@@ skipping 77 matching lines @@
     EXPECT_TRUE(parser.Decode(frame_header, frame_header_length, &frames));
     EXPECT_FALSE(parser.failed());
     EXPECT_EQ(1u, frames.size());
     if (frames.size() != 1u)
       continue;
     WebSocketFrameChunk* frame = frames[0];
     EXPECT_TRUE(frame != NULL);
     if (!frame)
       continue;
     EXPECT_TRUE(frame->final_chunk);
-    EXPECT_EQ(std::vector<char>(), frame->data);
+    EXPECT_EQ(NULL, frame->data.get());
     const WebSocketFrameHeader* header = frame->header.get();
     EXPECT_TRUE(header != NULL);
     if (!header)
       continue;
     EXPECT_TRUE(header->final);
     EXPECT_FALSE(header->reserved1);
     EXPECT_FALSE(header->reserved2);
     EXPECT_FALSE(header->reserved3);
     EXPECT_EQ(opcode, header->opcode);
     EXPECT_FALSE(header->masked);
@@ skipping 35 matching lines @@
     EXPECT_TRUE(parser.Decode(frame_header, frame_header_length, &frames));
     EXPECT_FALSE(parser.failed());
     EXPECT_EQ(1u, frames.size());
     if (frames.size() != 1u)
       continue;
     WebSocketFrameChunk* frame = frames[0];
     EXPECT_TRUE(frame != NULL);
     if (!frame)
       continue;
     EXPECT_TRUE(frame->final_chunk);
-    EXPECT_EQ(std::vector<char>(), frame->data);
+    EXPECT_EQ(NULL, frame->data.get());
     const WebSocketFrameHeader* header = frame->header.get();
     EXPECT_TRUE(header != NULL);
     if (!header)
       continue;
     EXPECT_EQ(final, header->final);
     EXPECT_EQ(reserved1, header->reserved1);
     EXPECT_EQ(reserved2, header->reserved2);
     EXPECT_EQ(reserved3, header->reserved3);
     EXPECT_EQ(WebSocketFrameHeader::kOpCodeText, header->opcode);
     EXPECT_FALSE(header->masked);
     EXPECT_EQ(0u, header->payload_length);
   }
 }
 
 }  // namespace net