Modify DeterministicSocketData to verify that the sequence number of reads and writes start at zero…

net/socket/socket_test_util.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/socket/socket_test_util.h"
 
 #include <algorithm>
 #include <vector>
 
 #include "base/basictypes.h"
@@ skipping 145 matching lines @@
                                                    MockWrite* writes,
                                                    size_t writes_count)
     : reads_(reads),
       read_index_(0),
       read_count_(reads_count),
       writes_(writes),
       write_index_(0),
       write_count_(writes_count) {
 }
 
+StaticSocketDataProvider::StaticSocketDataProvider(
+    bool verify_sequence_numbers,
+    MockRead* reads,
+    size_t reads_count,
+    MockWrite* writes,
+    size_t writes_count)
+    : reads_(reads),
+      read_index_(0),
+      read_count_(reads_count),
+      writes_(writes),
+      write_index_(0),
+      write_count_(writes_count) {
+  if (verify_sequence_numbers)
+    VerifyCorrectSequenceNumbers();
+}
+
 StaticSocketDataProvider::~StaticSocketDataProvider() {}
 
 const MockRead& StaticSocketDataProvider::PeekRead() const {
   DCHECK(!at_read_eof());
   return reads_[read_index_];
 }
 
 const MockWrite& StaticSocketDataProvider::PeekWrite() const {
   DCHECK(!at_write_eof());
   return writes_[write_index_];
@@ skipping 44 matching lines @@
       result = w->data_len;
   }
   return MockWriteResult(w->mode, result);
 }
 
 void StaticSocketDataProvider::Reset() {
   read_index_ = 0;
   write_index_ = 0;
 }
 
+void StaticSocketDataProvider::VerifyCorrectSequenceNumbers() {
+  size_t read = 0;
+  size_t write = 0;
+  int expected = 0;
+  while (read < read_count_ || write < write_count_) {
+    // Check to see that we have a read or write at the expected
+    // state.
+    if (read < read_count_  && reads_[read].sequence_number == expected) {
+      ++read;
+      ++expected;
+      continue;
+    }
+    if (write < write_count_ && writes_[write].sequence_number == expected) {
+      ++write;
+      ++expected;
+      continue;
+    }
+    EXPECT_TRUE(false) << "Missing sequence number: " << expected;
+    return;
+  }
+  EXPECT_EQ(read, read_count_);
+  EXPECT_EQ(write, write_count_);

[Ryan Sleevi, 2012/07/18 18:02:13]

Rather than EXPECT_TRUE(false) [which is really ADD_FAILURE()] and EXPECT_EQ, I
think it would be better to DCHECK and NOTREACHED()

These aren't failures within the test, these are failures with the code itself.
We already DCHECK on certain situations (eg: see PeekRead/PeakWrite()), and I
think the quicker we surface to the developer that they've made a programming
error, the better.

[Ryan Hamilton, 2012/07/18 18:45:06]

Done.  Fair enough.  Using EXPECT happened to be super handy when I was working
on this feature so I could see how many tests were afflicted by this
anti-pattern, but that's not really relevant anymore.

+}
+
 DynamicSocketDataProvider::DynamicSocketDataProvider()
     : short_read_limit_(0),
       allow_unconsumed_reads_(false) {
 }
 
 DynamicSocketDataProvider::~DynamicSocketDataProvider() {}
 
 MockRead DynamicSocketDataProvider::GetNextRead() {
   if (reads_.empty())
     return MockRead(SYNCHRONOUS, ERR_UNEXPECTED);
@@ skipping 196 matching lines @@
   if (socket() && blocked_) {
     NET_TRACE(INFO, "  *** ") << "Stage " << sequence_number_;
     socket()->OnReadComplete(GetNextRead());
   }
 }
 
 OrderedSocketData::~OrderedSocketData() {}
 
 DeterministicSocketData::DeterministicSocketData(MockRead* reads,
     size_t reads_count, MockWrite* writes, size_t writes_count)
-    : StaticSocketDataProvider(reads, reads_count, writes, writes_count),
+    : StaticSocketDataProvider(true, reads, reads_count, writes, writes_count),
       sequence_number_(0),
       current_read_(),
       current_write_(),
       stopping_sequence_number_(0),
       stopped_(false),
       print_debug_(false) {
 }
 
 DeterministicSocketData::~DeterministicSocketData() {}
 
@@ skipping 1186 matching lines @@
 
 const char kSOCKS5OkRequest[] =
     { 0x05, 0x01, 0x00, 0x03, 0x04, 'h', 'o', 's', 't', 0x00, 0x50 };
 const int kSOCKS5OkRequestLength = arraysize(kSOCKS5OkRequest);
 
 const char kSOCKS5OkResponse[] =
     { 0x05, 0x00, 0x00, 0x01, 127, 0, 0, 1, 0x00, 0x50 };
 const int kSOCKS5OkResponseLength = arraysize(kSOCKS5OkResponse);
 
 }  // namespace net