net/spdy/spdy_headers_block_parser_test.cc

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "net/spdy/spdy_headers_block_parser.h"
   6
   7 #include <string>
   8
   9 #include "base/memory/scoped_ptr.h"
  10 #include "base/strings/string_number_conversions.h"
  11 #include "base/sys_byteorder.h"
  12 #include "net/test/gtest_util.h"
  13 #include "testing/gmock/include/gmock/gmock.h"
  14 #include "testing/gtest/include/gtest/gtest.h"
  15
  16 namespace net {
  17
  18 using base::IntToString;
  19 using base::StringPiece;
  20 using base::UintToString;
  21 using std::string;
  22
  23 // A mock the handler class to check that we parse out the correct headers
  24 // and call the callback methods when we should.
  25 class MockSpdyHeadersHandler : public SpdyHeadersHandlerInterface {
  26  public:
  27   MOCK_METHOD0(OnHeaderBlockStart, void());
  28   MOCK_METHOD1(OnHeaderBlockEnd, void(size_t bytes));
  29   MOCK_METHOD2(OnHeader, void(StringPiece key, StringPiece value));
  30 };
  31
  32 class SpdyHeadersBlockParserTest :
  33     public ::testing::TestWithParam<SpdyMajorVersion> {
  34  public:
  35   ~SpdyHeadersBlockParserTest() override {}
  36
  37  protected:
  38   void SetUp() override {
  39     // Create a parser using the mock handler.
  40     spdy_version_ = GetParam();
  41
  42     parser_.reset(new SpdyHeadersBlockParser(spdy_version_, &handler_));
  43     length_field_size_ =
  44         SpdyHeadersBlockParser::LengthFieldSizeForVersion(spdy_version_);
  45   }
  46
  47   // Create a header block with a specified number of headers.
  48   string CreateHeaders(uint32_t num_headers, bool insert_nulls) {
  49     string headers;
  50
  51     // First, write the number of headers in the header block.
  52     headers += EncodeLength(num_headers);
  53
  54     // Second, write the key-value pairs.
  55     for (uint32_t i = 0; i < num_headers; i++) {
  56       // Build the key.
  57       string key;
  58       if (insert_nulls) {
  59         key = string(kBaseKey) + string("\0", 1) + UintToString(i);
  60       } else {
  61         key = string(kBaseKey) + UintToString(i);
  62       }
  63       // Encode the key as SPDY header.
  64       headers += EncodeLength(key.length());
  65       headers += key;
  66
  67       // Build the value.
  68       string value;
  69       if (insert_nulls) {
  70         value = string(kBaseValue) + string("\0", 1) + UintToString(i);
  71       } else {
  72         value = string(kBaseValue) + UintToString(i);
  73       }
  74       // Encode the value as SPDY header.
  75       headers += EncodeLength(value.length());
  76       headers += value;
  77     }
  78     return headers;
  79   }
  80
  81   string EncodeLength(uint32_t len) {
  82     char buffer[4];
  83     if (length_field_size_ == sizeof(uint32_t)) {
  84       uint32_t net_order_len = htonl(len);
  85       memcpy(buffer, &net_order_len, length_field_size_);
  86     } else if (length_field_size_ == sizeof(uint16_t)) {
  87       uint16_t net_order_len = htons(len);
  88       memcpy(buffer, &net_order_len, length_field_size_);
  89     } else {
  90       CHECK(false) << "Invalid length field size";
  91     }
  92     return string(buffer, length_field_size_);
  93   }
  94
  95   size_t length_field_size_;
  96   SpdyMajorVersion spdy_version_;
  97
  98   MockSpdyHeadersHandler handler_;
  99   scoped_ptr<SpdyHeadersBlockParser> parser_;
 100
 101   static const char *const kBaseKey;
 102   static const char *const kBaseValue;
 103
 104   // Number of headers and header blocks used in the tests.
 105   static const int kNumHeadersInBlock = 10;
 106   static const int kNumHeaderBlocks = 10;
 107 };
 108
 109 const char *const SpdyHeadersBlockParserTest::kBaseKey = "test_key";
 110 const char *const SpdyHeadersBlockParserTest::kBaseValue = "test_value";
 111
 112 // All tests are run with 3 different SPDY versions: SPDY/2, SPDY/3, HTTP/2.
 113 INSTANTIATE_TEST_CASE_P(SpdyHeadersBlockParserTests,
 114                         SpdyHeadersBlockParserTest,
 115                         ::testing::Values(SPDY2, SPDY3, HTTP2));
 116
 117 TEST_P(SpdyHeadersBlockParserTest, BasicTest) {
 118   // Sanity test, verify that we parse out correctly a block with
 119   // a single key-value pair and that we notify when we start and finish
 120   // handling a headers block.
 121   EXPECT_EQ(spdy_version_, parser_->spdy_version());
 122
 123   EXPECT_CALL(handler_, OnHeaderBlockStart()).Times(1);
 124   string expect_key = kBaseKey + IntToString(0);
 125   string expect_value = kBaseValue + IntToString(0);
 126   EXPECT_CALL(handler_, OnHeader(StringPiece(expect_key),
 127                                  StringPiece(expect_value))).Times(1);
 128
 129   string headers(CreateHeaders(1, false));
 130   EXPECT_CALL(handler_, OnHeaderBlockEnd(headers.length())).Times(1);
 131
 132   EXPECT_TRUE(parser_->
 133       HandleControlFrameHeadersData(1, headers.c_str(), headers.length()));
 134   EXPECT_EQ(SpdyHeadersBlockParser::NO_PARSER_ERROR, parser_->get_error());
 135 }
 136
 137 TEST_P(SpdyHeadersBlockParserTest, NullsSupportedTest) {
 138   // Sanity test, verify that we parse out correctly a block with
 139   // a single key-value pair when the key and value contain null charecters.
 140   EXPECT_CALL(handler_, OnHeaderBlockStart()).Times(1);
 141
 142   string expect_key = kBaseKey + string("\0", 1) + IntToString(0);
 143   string expect_value = kBaseValue + string("\0", 1) + IntToString(0);
 144   EXPECT_CALL(handler_, OnHeader(StringPiece(expect_key),
 145                                  StringPiece(expect_value))).Times(1);
 146
 147   string headers(CreateHeaders(1, true));
 148   EXPECT_CALL(handler_, OnHeaderBlockEnd(headers.length())).Times(1);
 149
 150   EXPECT_TRUE(parser_->
 151       HandleControlFrameHeadersData(1, headers.c_str(), headers.length()));
 152   EXPECT_EQ(SpdyHeadersBlockParser::NO_PARSER_ERROR, parser_->get_error());
 153 }
 154
 155 TEST_P(SpdyHeadersBlockParserTest, MultipleBlocksAndHeadersWithPartialData) {
 156   testing::InSequence s;
 157
 158   // CreateHeaders is deterministic; we can call it once for the whole test.
 159   string headers(CreateHeaders(kNumHeadersInBlock, false));
 160
 161   // The mock doesn't retain storage of arguments, so keep them in scope.
 162   std::vector<string> retained_arguments;
 163   for (int i = 0; i < kNumHeadersInBlock; i++) {
 164     retained_arguments.push_back(kBaseKey + IntToString(i));
 165     retained_arguments.push_back(kBaseValue + IntToString(i));
 166   }
 167   // For each block we expect to parse out the headers in order.
 168   for (int i = 0; i < kNumHeaderBlocks; i++) {
 169     EXPECT_CALL(handler_, OnHeaderBlockStart()).Times(1);
 170     for (int j = 0; j < kNumHeadersInBlock; j++) {
 171       EXPECT_CALL(handler_, OnHeader(
 172           StringPiece(retained_arguments[2 * j]),
 173           StringPiece(retained_arguments[2 * j + 1]))).Times(1);
 174     }
 175     EXPECT_CALL(handler_, OnHeaderBlockEnd(headers.length())).Times(1);
 176   }
 177   // Parse the header blocks, feeding the parser one byte at a time.
 178   for (int i = 1; i <= kNumHeaderBlocks; i++) {
 179     for (string::iterator it = headers.begin(); it != headers.end(); ++it) {
 180       if ((it + 1) == headers.end()) {
 181         // Last byte completes the block.
 182         EXPECT_TRUE(parser_->HandleControlFrameHeadersData(i, &(*it), 1));
 183         EXPECT_EQ(SpdyHeadersBlockParser::NO_PARSER_ERROR,
 184                   parser_->get_error());
 185       } else {
 186         EXPECT_FALSE(parser_->HandleControlFrameHeadersData(i, &(*it), 1));
 187         EXPECT_EQ(SpdyHeadersBlockParser::NEED_MORE_DATA, parser_->get_error());
 188       }
 189     }
 190   }
 191 }
 192
 193 TEST_P(SpdyHeadersBlockParserTest, HandlesEmptyCallsTest) {
 194   EXPECT_CALL(handler_, OnHeaderBlockStart()).Times(1);
 195
 196   string expect_key = kBaseKey + IntToString(0);
 197   string expect_value = kBaseValue + IntToString(0);
 198   EXPECT_CALL(handler_, OnHeader(StringPiece(expect_key),
 199                                  StringPiece(expect_value))).Times(1);
 200
 201   string headers(CreateHeaders(1, false));
 202   EXPECT_CALL(handler_, OnHeaderBlockEnd(headers.length())).Times(1);
 203
 204   // Send a header in pieces with intermediate empty calls.
 205   for (string::iterator it = headers.begin(); it != headers.end(); ++it) {
 206     if ((it + 1) == headers.end()) {
 207       // Last byte completes the block.
 208       EXPECT_TRUE(parser_->HandleControlFrameHeadersData(1, &(*it), 1));
 209       EXPECT_EQ(SpdyHeadersBlockParser::NO_PARSER_ERROR, parser_->get_error());
 210     } else {
 211       EXPECT_FALSE(parser_->HandleControlFrameHeadersData(1, &(*it), 1));
 212       EXPECT_EQ(SpdyHeadersBlockParser::NEED_MORE_DATA, parser_->get_error());
 213       EXPECT_FALSE(parser_->HandleControlFrameHeadersData(1, NULL, 0));
 214     }
 215   }
 216 }
 217
 218 TEST_P(SpdyHeadersBlockParserTest, LargeBlocksDiscardedTest) {
 219   // Header block with too many headers.
 220   {
 221     string headers = EncodeLength(
 222         parser_->MaxNumberOfHeadersForVersion(spdy_version_) + 1);
 223     EXPECT_FALSE(parser_->
 224         HandleControlFrameHeadersData(1, headers.c_str(), headers.length()));
 225     EXPECT_EQ(SpdyHeadersBlockParser::HEADER_BLOCK_TOO_LARGE,
 226               parser_->get_error());
 227   }
 228   parser_.reset(new SpdyHeadersBlockParser(spdy_version_, &handler_));
 229   // Header block with one header, which has a too-long key.
 230   {
 231     string headers = EncodeLength(1) + EncodeLength(
 232         SpdyHeadersBlockParser::kMaximumFieldLength + 1);
 233     EXPECT_FALSE(parser_->
 234         HandleControlFrameHeadersData(1, headers.c_str(), headers.length()));
 235     EXPECT_EQ(SpdyHeadersBlockParser::HEADER_FIELD_TOO_LARGE,
 236               parser_->get_error());
 237   }
 238 }
 239
 240 TEST_P(SpdyHeadersBlockParserTest, ExtraDataTest) {
 241   EXPECT_CALL(handler_, OnHeaderBlockStart()).Times(1);
 242
 243   string expect_key = kBaseKey + IntToString(0);
 244   string expect_value = kBaseValue + IntToString(0);
 245   EXPECT_CALL(handler_, OnHeader(StringPiece(expect_key),
 246                                  StringPiece(expect_value))).Times(1);
 247
 248   string headers = CreateHeaders(1, false) + "foobar";
 249   EXPECT_CALL(handler_, OnHeaderBlockEnd(headers.length())).Times(1);
 250
 251   EXPECT_FALSE(parser_->HandleControlFrameHeadersData(1, headers.c_str(),
 252                                                       headers.length()));
 253   EXPECT_EQ(SpdyHeadersBlockParser::TOO_MUCH_DATA, parser_->get_error());
 254 }
 255
 256 TEST_P(SpdyHeadersBlockParserTest, WrongStreamIdTest) {
 257   string headers(CreateHeaders(kNumHeadersInBlock, false));
 258   EXPECT_FALSE(parser_->HandleControlFrameHeadersData(1, headers.data(), 1));
 259   EXPECT_EQ(SpdyHeadersBlockParser::NEED_MORE_DATA, parser_->get_error());
 260   bool result;
 261   EXPECT_DFATAL(
 262       result = parser_->HandleControlFrameHeadersData(2, headers.data() + 1, 1),
 263       "Unexpected stream id: 2 \\(expected 1\\)");
 264   EXPECT_FALSE(result);
 265   EXPECT_EQ(SpdyHeadersBlockParser::UNEXPECTED_STREAM_ID, parser_->get_error());
 266 }
 267
 268 TEST_P(SpdyHeadersBlockParserTest, InvalidStreamIdTest) {
 269   string headers(CreateHeaders(kNumHeadersInBlock, false));
 270   bool result;
 271   EXPECT_DFATAL(
 272       result = parser_->HandleControlFrameHeadersData(0, headers.data(), 1),
 273       "Expected nonzero stream id, saw: 0");
 274   EXPECT_FALSE(result);
 275   EXPECT_EQ(SpdyHeadersBlockParser::UNEXPECTED_STREAM_ID, parser_->get_error());
 276 }
 277
 278 }  // namespace net