net/spdy/spdy_protocol_test.cc

   1 // Copyright (c) 2012 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_protocol.h"
   6
   7 #include "base/memory/scoped_ptr.h"
   8 #include "net/spdy/spdy_bitmasks.h"
   9 #include "net/spdy/spdy_framer.h"
  10 #include "testing/platform_test.h"
  11
  12 namespace {
  13
  14 enum SpdyProtocolTestTypes {
  15   SPDY2 = 2,
  16   SPDY3 = 3,
  17 };
  18
  19 } // namespace
  20
  21 namespace net {
  22
  23 class SpdyProtocolTest
  24     : public ::testing::TestWithParam<SpdyProtocolTestTypes> {
  25  protected:
  26   virtual void SetUp() {
  27     spdy_version_ = GetParam();
  28   }
  29
  30   bool IsSpdy2() { return spdy_version_ == SPDY2; }
  31
  32   // Version of SPDY protocol to be used.
  33   int spdy_version_;
  34 };
  35
  36 // All tests are run with two different SPDY versions: SPDY/2 and SPDY/3.
  37 INSTANTIATE_TEST_CASE_P(SpdyProtocolTests,
  38                         SpdyProtocolTest,
  39                         ::testing::Values(SPDY2, SPDY3));
  40
  41 // Test our protocol constants
  42 TEST_P(SpdyProtocolTest, ProtocolConstants) {
  43   EXPECT_EQ(8u, SpdyFrame::kHeaderSize);
  44   EXPECT_EQ(8u, SpdyDataFrame::size());
  45   EXPECT_EQ(8u, SpdyControlFrame::kHeaderSize);
  46   EXPECT_EQ(18u, SpdySynStreamControlFrame::size());
  47   EXPECT_EQ(12u, SpdySynReplyControlFrame::size());
  48   EXPECT_EQ(16u, SpdyRstStreamControlFrame::size());
  49   EXPECT_EQ(12u, SpdySettingsControlFrame::size());
  50   EXPECT_EQ(12u, SpdyPingControlFrame::size());
  51   EXPECT_EQ(16u, SpdyGoAwayControlFrame::size());
  52   EXPECT_EQ(12u, SpdyHeadersControlFrame::size());
  53   EXPECT_EQ(16u, SpdyWindowUpdateControlFrame::size());
  54   EXPECT_EQ(4u, sizeof(FlagsAndLength));
  55   EXPECT_EQ(1, SYN_STREAM);
  56   EXPECT_EQ(2, SYN_REPLY);
  57   EXPECT_EQ(3, RST_STREAM);
  58   EXPECT_EQ(4, SETTINGS);
  59   EXPECT_EQ(5, NOOP);
  60   EXPECT_EQ(6, PING);
  61   EXPECT_EQ(7, GOAWAY);
  62   EXPECT_EQ(8, HEADERS);
  63   EXPECT_EQ(9, WINDOW_UPDATE);
  64 }
  65
  66 // Test some of the protocol helper functions
  67 TEST_P(SpdyProtocolTest, FrameStructs) {
  68   SpdyFrame frame(SpdyFrame::kHeaderSize);
  69   frame.set_length(12345);
  70   frame.set_flags(10);
  71   EXPECT_EQ(12345u, frame.length());
  72   EXPECT_EQ(10u, frame.flags());
  73   EXPECT_FALSE(frame.is_control_frame());
  74
  75   frame.set_length(0);
  76   frame.set_flags(10);
  77   EXPECT_EQ(0u, frame.length());
  78   EXPECT_EQ(10u, frame.flags());
  79   EXPECT_FALSE(frame.is_control_frame());
  80 }
  81
  82 TEST_P(SpdyProtocolTest, DataFrameStructs) {
  83   SpdyDataFrame data_frame;
  84   data_frame.set_stream_id(12345);
  85   EXPECT_EQ(12345u, data_frame.stream_id());
  86 }
  87
  88 TEST_P(SpdyProtocolTest, ControlFrameStructs) {
  89   SpdyFramer framer(spdy_version_);
  90   SpdyHeaderBlock headers;
  91
  92   const uint8 credential_slot = IsSpdy2() ? 0 : 5;
  93
  94   scoped_ptr<SpdySynStreamControlFrame> syn_frame(framer.CreateSynStream(
  95       123, 456, 2, credential_slot, CONTROL_FLAG_FIN, false, &headers));
  96   EXPECT_EQ(framer.protocol_version(), syn_frame->version());
  97   EXPECT_TRUE(syn_frame->is_control_frame());
  98   EXPECT_EQ(SYN_STREAM, syn_frame->type());
  99   EXPECT_EQ(123u, syn_frame->stream_id());
 100   EXPECT_EQ(456u, syn_frame->associated_stream_id());
 101   EXPECT_EQ(2u, syn_frame->priority());
 102   EXPECT_EQ(credential_slot, syn_frame->credential_slot());
 103   EXPECT_EQ(IsSpdy2() ? 2 : 4, syn_frame->header_block_len());
 104   EXPECT_EQ(1u, syn_frame->flags());
 105   syn_frame->set_associated_stream_id(999u);
 106   EXPECT_EQ(123u, syn_frame->stream_id());
 107   EXPECT_EQ(999u, syn_frame->associated_stream_id());
 108
 109   scoped_ptr<SpdySynReplyControlFrame> syn_reply(
 110       framer.CreateSynReply(123, CONTROL_FLAG_NONE, false, &headers));
 111   EXPECT_EQ(framer.protocol_version(), syn_reply->version());
 112   EXPECT_TRUE(syn_reply->is_control_frame());
 113   EXPECT_EQ(SYN_REPLY, syn_reply->type());
 114   EXPECT_EQ(123u, syn_reply->stream_id());
 115   EXPECT_EQ(IsSpdy2() ? 2 : 4, syn_reply->header_block_len());
 116   EXPECT_EQ(0, syn_reply->flags());
 117
 118   scoped_ptr<SpdyRstStreamControlFrame> rst_frame(
 119       framer.CreateRstStream(123, PROTOCOL_ERROR));
 120   EXPECT_EQ(framer.protocol_version(), rst_frame->version());
 121   EXPECT_TRUE(rst_frame->is_control_frame());
 122   EXPECT_EQ(RST_STREAM, rst_frame->type());
 123   EXPECT_EQ(123u, rst_frame->stream_id());
 124   EXPECT_EQ(PROTOCOL_ERROR, rst_frame->status());
 125   rst_frame->set_status(INVALID_STREAM);
 126   EXPECT_EQ(INVALID_STREAM, rst_frame->status());
 127   EXPECT_EQ(0, rst_frame->flags());
 128
 129   const uint32 kUniqueId = 1234567u;
 130   const uint32 kUniqueId2 = 31415926u;
 131   scoped_ptr<SpdyPingControlFrame> ping_frame(
 132       framer.CreatePingFrame(kUniqueId));
 133   EXPECT_EQ(framer.protocol_version(), ping_frame->version());
 134   EXPECT_TRUE(ping_frame->is_control_frame());
 135   EXPECT_EQ(PING, ping_frame->type());
 136   EXPECT_EQ(kUniqueId, ping_frame->unique_id());
 137   ping_frame->set_unique_id(kUniqueId2);
 138   EXPECT_EQ(kUniqueId2, ping_frame->unique_id());
 139
 140   scoped_ptr<SpdyGoAwayControlFrame> goaway_frame(
 141       framer.CreateGoAway(123, GOAWAY_INTERNAL_ERROR));
 142   EXPECT_EQ(framer.protocol_version(), goaway_frame->version());
 143   EXPECT_TRUE(goaway_frame->is_control_frame());
 144   EXPECT_EQ(GOAWAY, goaway_frame->type());
 145   EXPECT_EQ(123u, goaway_frame->last_accepted_stream_id());
 146   if (!IsSpdy2()) {
 147     EXPECT_EQ(GOAWAY_INTERNAL_ERROR, goaway_frame->status());
 148   }
 149
 150   scoped_ptr<SpdyHeadersControlFrame> headers_frame(
 151       framer.CreateHeaders(123, CONTROL_FLAG_NONE, false, &headers));
 152   EXPECT_EQ(framer.protocol_version(), headers_frame->version());
 153   EXPECT_TRUE(headers_frame->is_control_frame());
 154   EXPECT_EQ(HEADERS, headers_frame->type());
 155   EXPECT_EQ(123u, headers_frame->stream_id());
 156   EXPECT_EQ(IsSpdy2() ? 2 : 4, headers_frame->header_block_len());
 157   EXPECT_EQ(0, headers_frame->flags());
 158
 159   scoped_ptr<SpdyWindowUpdateControlFrame> window_update_frame(
 160       framer.CreateWindowUpdate(123, 456));
 161   EXPECT_EQ(framer.protocol_version(), window_update_frame->version());
 162   EXPECT_TRUE(window_update_frame->is_control_frame());
 163   EXPECT_EQ(WINDOW_UPDATE, window_update_frame->type());
 164   EXPECT_EQ(123u, window_update_frame->stream_id());
 165   EXPECT_EQ(456u, window_update_frame->delta_window_size());
 166 }
 167
 168 TEST_P(SpdyProtocolTest, TestDataFrame) {
 169   SpdyDataFrame frame;
 170
 171   // Set the stream ID to various values.
 172   frame.set_stream_id(0);
 173   EXPECT_EQ(0u, frame.stream_id());
 174   EXPECT_FALSE(frame.is_control_frame());
 175   frame.set_stream_id(~0 & kStreamIdMask);
 176   EXPECT_EQ(~0 & kStreamIdMask, frame.stream_id());
 177   EXPECT_FALSE(frame.is_control_frame());
 178
 179   // Set length to various values.  Make sure that when you set_length(x),
 180   // length() == x.  Also make sure the flags are unaltered.
 181   memset(frame.data(), '1', SpdyDataFrame::size());
 182   int8 flags = frame.flags();
 183   frame.set_length(0);
 184   EXPECT_EQ(0u, frame.length());
 185   EXPECT_EQ(flags, frame.flags());
 186   frame.set_length(kLengthMask);
 187   EXPECT_EQ(kLengthMask, frame.length());
 188   EXPECT_EQ(flags, frame.flags());
 189   frame.set_length(5u);
 190   EXPECT_EQ(5u, frame.length());
 191   EXPECT_EQ(flags, frame.flags());
 192
 193   // Set flags to various values.  Make sure that when you set_flags(x),
 194   // flags() == x.  Also make sure the length is unaltered.
 195   memset(frame.data(), '1', SpdyDataFrame::size());
 196   uint32 length = frame.length();
 197   frame.set_flags(0u);
 198   EXPECT_EQ(0u, frame.flags());
 199   EXPECT_EQ(length, frame.length());
 200   int8 all_flags = ~0;
 201   frame.set_flags(all_flags);
 202   flags = frame.flags();
 203   EXPECT_EQ(all_flags, flags);
 204   EXPECT_EQ(length, frame.length());
 205   frame.set_flags(5u);
 206   EXPECT_EQ(5u, frame.flags());
 207   EXPECT_EQ(length, frame.length());
 208 }
 209
 210 // Test various types of SETTINGS frames.
 211 TEST_P(SpdyProtocolTest, TestSpdySettingsFrame) {
 212   SpdyFramer framer(spdy_version_);
 213
 214   // Create a settings frame with no settings.
 215   SettingsMap settings;
 216   scoped_ptr<SpdySettingsControlFrame> settings_frame(
 217       framer.CreateSettings(settings));
 218   EXPECT_EQ(framer.protocol_version(), settings_frame->version());
 219   EXPECT_TRUE(settings_frame->is_control_frame());
 220   EXPECT_EQ(SETTINGS, settings_frame->type());
 221   EXPECT_EQ(0u, settings_frame->num_entries());
 222
 223   // We'll add several different ID/Flag combinations and then verify
 224   // that they encode and decode properly.
 225   SettingsFlagsAndId ids[] = {
 226     SettingsFlagsAndId::FromWireFormat(spdy_version_, 0x00000000),
 227     SettingsFlagsAndId::FromWireFormat(spdy_version_, 0xffffffff),
 228     SettingsFlagsAndId::FromWireFormat(spdy_version_, 0xff000001),
 229     SettingsFlagsAndId::FromWireFormat(spdy_version_, 0x01000002),
 230     SettingsFlagsAndId(6, 9)
 231   };
 232
 233   for (uint32 index = 0; index < arraysize(ids); ++index) {
 234     SettingsFlagsAndId flags_and_id = ids[index];
 235     SpdySettingsIds id = static_cast<SpdySettingsIds>(flags_and_id.id());
 236     SpdySettingsFlags flags =
 237         static_cast<SpdySettingsFlags>(flags_and_id.flags());
 238     settings[id] = SettingsFlagsAndValue(flags, index);
 239     settings_frame.reset(framer.CreateSettings(settings));
 240     EXPECT_EQ(framer.protocol_version(), settings_frame->version());
 241     EXPECT_TRUE(settings_frame->is_control_frame());
 242     EXPECT_EQ(SETTINGS, settings_frame->type());
 243     EXPECT_EQ(index + 1, settings_frame->num_entries());
 244
 245     SettingsMap parsed_settings;
 246     EXPECT_TRUE(framer.ParseSettings(settings_frame.get(), &parsed_settings));
 247     EXPECT_EQ(settings.size(), parsed_settings.size());
 248     for (SettingsMap::const_iterator it = parsed_settings.begin();
 249          it != parsed_settings.end();
 250          it++) {
 251       SettingsMap::const_iterator it2 = settings.find(it->first);
 252       EXPECT_EQ(it->first, it2->first);
 253       SettingsFlagsAndValue parsed = it->second;
 254       SettingsFlagsAndValue created = it2->second;
 255       EXPECT_EQ(created.first, parsed.first);
 256       EXPECT_EQ(created.second, parsed.second);
 257     }
 258   }
 259 }
 260
 261 TEST_P(SpdyProtocolTest, HasHeaderBlock) {
 262   SpdyControlFrame frame(SpdyControlFrame::kHeaderSize);
 263   for (SpdyControlType type = SYN_STREAM;
 264       type < NUM_CONTROL_FRAME_TYPES;
 265       type = static_cast<SpdyControlType>(type + 1)) {
 266     frame.set_type(type);
 267     if (type == SYN_STREAM || type == SYN_REPLY || type == HEADERS) {
 268       EXPECT_TRUE(frame.has_header_block());
 269     } else {
 270       EXPECT_FALSE(frame.has_header_block());
 271     }
 272   }
 273 }
 274
 275 class SpdyProtocolDeathTest : public SpdyProtocolTest {};
 276
 277 // All tests are run with two different SPDY versions: SPDY/2 and SPDY/3.
 278 INSTANTIATE_TEST_CASE_P(SpdyProtocolDeathTests,
 279                         SpdyProtocolDeathTest,
 280                         ::testing::Values(SPDY2, SPDY3));
 281
 282 // Make sure that overflows both die in debug mode, and do not cause problems
 283 // in opt mode.  Note:  The EXPECT_DEBUG_DEATH call does not work on Win32 yet,
 284 // so we comment it out.
 285 TEST_P(SpdyProtocolDeathTest, TestDataFrame) {
 286   SpdyDataFrame frame;
 287
 288   frame.set_stream_id(0);
 289   // TODO(mbelshe):  implement EXPECT_DEBUG_DEATH on windows.
 290 #if !defined(WIN32) && defined(GTEST_HAS_DEATH_TEST)
 291 #if !defined(DCHECK_ALWAYS_ON)
 292   EXPECT_DEBUG_DEATH(frame.set_stream_id(~0), "");
 293 #else
 294   EXPECT_DEATH(frame.set_stream_id(~0), "");
 295 #endif
 296 #endif
 297   EXPECT_FALSE(frame.is_control_frame());
 298
 299   frame.set_flags(0);
 300 #if !defined(WIN32) && defined(GTEST_HAS_DEATH_TEST)
 301 #if !defined(DCHECK_ALWAYS_ON)
 302   EXPECT_DEBUG_DEATH(frame.set_length(~0), "");
 303 #else
 304   EXPECT_DEATH(frame.set_length(~0), "");
 305 #endif
 306 #endif
 307   EXPECT_EQ(0, frame.flags());
 308 }
 309
 310 TEST_P(SpdyProtocolDeathTest, TestSpdyControlFrameStreamId) {
 311   SpdyControlFrame frame_store(SpdySynStreamControlFrame::size());
 312   memset(frame_store.data(), '1', SpdyControlFrame::kHeaderSize);
 313   SpdySynStreamControlFrame* frame =
 314       reinterpret_cast<SpdySynStreamControlFrame*>(&frame_store);
 315
 316   // Set the stream ID to various values.
 317   frame->set_stream_id(0);
 318   EXPECT_EQ(0u, frame->stream_id());
 319   EXPECT_FALSE(frame->is_control_frame());
 320   frame->set_stream_id(kStreamIdMask);
 321   EXPECT_EQ(kStreamIdMask, frame->stream_id());
 322   EXPECT_FALSE(frame->is_control_frame());
 323 }
 324
 325 TEST_P(SpdyProtocolDeathTest, TestSpdyControlFrameVersion) {
 326   const unsigned int kVersionMask = 0x7fff;
 327   SpdyControlFrame frame(SpdySynStreamControlFrame::size());
 328   memset(frame.data(), '1', SpdyControlFrame::kHeaderSize);
 329
 330   // Set the version to various values, and make sure it does not affect the
 331   // type.
 332   frame.set_type(SYN_STREAM);
 333   frame.set_version(0);
 334   EXPECT_EQ(0, frame.version());
 335   EXPECT_TRUE(frame.is_control_frame());
 336   EXPECT_EQ(SYN_STREAM, frame.type());
 337
 338   SpdySynStreamControlFrame* syn_stream =
 339       reinterpret_cast<SpdySynStreamControlFrame*>(&frame);
 340   syn_stream->set_stream_id(~0 & kVersionMask);
 341   EXPECT_EQ(~0 & kVersionMask, syn_stream->stream_id());
 342   EXPECT_TRUE(frame.is_control_frame());
 343   EXPECT_EQ(SYN_STREAM, frame.type());
 344 }
 345
 346 TEST_P(SpdyProtocolDeathTest, TestSpdyControlFrameType) {
 347   SpdyControlFrame frame(SpdyControlFrame::kHeaderSize);
 348   memset(frame.data(), 255, SpdyControlFrame::kHeaderSize);
 349
 350   // type() should be out of bounds.
 351   EXPECT_FALSE(frame.AppearsToBeAValidControlFrame());
 352
 353   frame.set_version(spdy_version_);
 354   uint16 version = frame.version();
 355
 356   for (int i = SYN_STREAM; i <= WINDOW_UPDATE; ++i) {
 357     frame.set_type(static_cast<SpdyControlType>(i));
 358     EXPECT_EQ(i, static_cast<int>(frame.type()));
 359     if (!IsSpdy2() && i == NOOP) {
 360       // NOOP frames aren't 'valid'.
 361       EXPECT_FALSE(frame.AppearsToBeAValidControlFrame());
 362     } else {
 363       EXPECT_TRUE(frame.AppearsToBeAValidControlFrame());
 364     }
 365     // Make sure setting type does not alter the version block.
 366     EXPECT_EQ(version, frame.version());
 367     EXPECT_TRUE(frame.is_control_frame());
 368   }
 369 }
 370
 371 TEST_P(SpdyProtocolDeathTest, TestRstStreamStatusBounds) {
 372   SpdyFramer framer(spdy_version_);
 373   scoped_ptr<SpdyRstStreamControlFrame> rst_frame;
 374
 375   rst_frame.reset(framer.CreateRstStream(123, PROTOCOL_ERROR));
 376   EXPECT_EQ(PROTOCOL_ERROR, rst_frame->status());
 377
 378   rst_frame->set_status(INVALID);
 379   EXPECT_EQ(INVALID, rst_frame->status());
 380
 381   rst_frame->set_status(
 382       static_cast<SpdyStatusCodes>(INVALID - 1));
 383   EXPECT_EQ(INVALID, rst_frame->status());
 384
 385   rst_frame->set_status(NUM_STATUS_CODES);
 386   EXPECT_EQ(INVALID, rst_frame->status());
 387 }
 388
 389 }  // namespace net