src/net/tools/quic/test_tools/quic_test_utils.h

   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 // Common utilities for Quic tests
   6
   7 #ifndef NET_TOOLS_QUIC_TEST_TOOLS_QUIC_TEST_UTILS_H_
   8 #define NET_TOOLS_QUIC_TEST_TOOLS_QUIC_TEST_UTILS_H_
   9
  10 #include <string>
  11
  12 #include "base/strings/string_piece.h"
  13 #include "net/quic/quic_connection.h"
  14 #include "net/quic/quic_packet_writer.h"
  15 #include "net/quic/quic_session.h"
  16 #include "net/spdy/spdy_framer.h"
  17 #include "net/tools/quic/quic_dispatcher.h"
  18 #include "net/tools/quic/quic_per_connection_packet_writer.h"
  19 #include "net/tools/quic/quic_server_session.h"
  20 #include "testing/gmock/include/gmock/gmock.h"
  21
  22 namespace net {
  23
  24 class EpollServer;
  25 class IPEndPoint;
  26
  27 namespace tools {
  28 namespace test {
  29
  30 static const QuicConnectionId kTestConnectionId = 42;
  31 static const int kTestPort = 123;
  32 static const uint32 kInitialStreamFlowControlWindowForTest =
  33     32 * 1024;  // 32 KB
  34 static const uint32 kInitialSessionFlowControlWindowForTest =
  35     64 * 1024;  // 64 KB
  36
  37 // Testing convenience method to construct a QuicAckFrame with |num_nack_ranges|
  38 // nack ranges of width 1 packet, starting from |least_unacked|.
  39 QuicAckFrame MakeAckFrameWithNackRanges(size_t num_nack_ranges,
  40                                         QuicPacketSequenceNumber least_unacked);
  41
  42 class MockConnection : public QuicConnection {
  43  public:
  44   // Uses a MockHelper, ConnectionId of 42, and 127.0.0.1:123.
  45   explicit MockConnection(bool is_server);
  46
  47   // Uses a MockHelper, ConnectionId of 42.
  48   MockConnection(IPEndPoint address, bool is_server);
  49
  50   // Uses a MockHelper, and 127.0.0.1:123
  51   MockConnection(QuicConnectionId connection_id, bool is_server);
  52
  53   // Uses a Mock helper, ConnectionId of 42, and 127.0.0.1:123.
  54   MockConnection(bool is_server, const QuicVersionVector& supported_versions);
  55
  56   virtual ~MockConnection();
  57
  58   // If the constructor that uses a MockHelper has been used then this method
  59   // will advance the time of the MockClock.
  60   void AdvanceTime(QuicTime::Delta delta);
  61
  62   MOCK_METHOD3(ProcessUdpPacket, void(const IPEndPoint& self_address,
  63                                       const IPEndPoint& peer_address,
  64                                       const QuicEncryptedPacket& packet));
  65   MOCK_METHOD1(SendConnectionClose, void(QuicErrorCode error));
  66   MOCK_METHOD2(SendConnectionCloseWithDetails, void(
  67       QuicErrorCode error,
  68       const std::string& details));
  69   MOCK_METHOD2(SendConnectionClosePacket, void(QuicErrorCode error,
  70                                                const std::string& details));
  71   MOCK_METHOD3(SendRstStream, void(QuicStreamId id,
  72                                    QuicRstStreamErrorCode error,
  73                                    QuicStreamOffset bytes_written));
  74   MOCK_METHOD3(SendGoAway, void(QuicErrorCode error,
  75                                 QuicStreamId last_good_stream_id,
  76                                 const std::string& reason));
  77   MOCK_METHOD1(SendBlocked, void(QuicStreamId id));
  78   MOCK_METHOD2(SendWindowUpdate, void(QuicStreamId id,
  79                                       QuicStreamOffset byte_offset));
  80   MOCK_METHOD0(OnCanWrite, void());
  81   MOCK_CONST_METHOD0(HasPendingWrites, bool());
  82
  83   void ReallyProcessUdpPacket(const IPEndPoint& self_address,
  84                               const IPEndPoint& peer_address,
  85                               const QuicEncryptedPacket& packet) {
  86     return QuicConnection::ProcessUdpPacket(self_address, peer_address, packet);
  87   }
  88
  89   virtual bool OnProtocolVersionMismatch(QuicVersion version) { return false; }
  90
  91  private:
  92   scoped_ptr<QuicConnectionHelperInterface> helper_;
  93
  94   DISALLOW_COPY_AND_ASSIGN(MockConnection);
  95 };
  96
  97 class TestSession : public QuicSession {
  98  public:
  99   TestSession(QuicConnection* connection, const QuicConfig& config);
 100   virtual ~TestSession();
 101
 102   MOCK_METHOD1(CreateIncomingDataStream, QuicDataStream*(QuicStreamId id));
 103   MOCK_METHOD0(CreateOutgoingDataStream, QuicDataStream*());
 104
 105   void SetCryptoStream(QuicCryptoStream* stream);
 106
 107   virtual QuicCryptoStream* GetCryptoStream() override;
 108
 109  private:
 110   QuicCryptoStream* crypto_stream_;
 111
 112   DISALLOW_COPY_AND_ASSIGN(TestSession);
 113 };
 114
 115 class MockPacketWriter : public QuicPacketWriter {
 116  public:
 117   MockPacketWriter();
 118   virtual ~MockPacketWriter();
 119
 120   MOCK_METHOD4(WritePacket,
 121                WriteResult(const char* buffer,
 122                            size_t buf_len,
 123                            const IPAddressNumber& self_address,
 124                            const IPEndPoint& peer_address));
 125   MOCK_CONST_METHOD0(IsWriteBlockedDataBuffered, bool());
 126   MOCK_CONST_METHOD0(IsWriteBlocked, bool());
 127   MOCK_METHOD0(SetWritable, void());
 128
 129  private:
 130   DISALLOW_COPY_AND_ASSIGN(MockPacketWriter);
 131 };
 132
 133 class MockQuicServerSessionVisitor : public QuicServerSessionVisitor {
 134  public:
 135   MockQuicServerSessionVisitor();
 136   virtual ~MockQuicServerSessionVisitor();
 137   MOCK_METHOD2(OnConnectionClosed, void(QuicConnectionId connection_id,
 138                                         QuicErrorCode error));
 139   MOCK_METHOD1(OnWriteBlocked,
 140                void(QuicBlockedWriterInterface* blocked_writer));
 141
 142  private:
 143   DISALLOW_COPY_AND_ASSIGN(MockQuicServerSessionVisitor);
 144 };
 145
 146 class MockAckNotifierDelegate : public QuicAckNotifier::DelegateInterface {
 147  public:
 148   MockAckNotifierDelegate();
 149
 150   MOCK_METHOD5(OnAckNotification, void(int num_original_packets,
 151                                        int num_original_bytes,
 152                                        int num_retransmitted_packets,
 153                                        int num_retransmitted_bytes,
 154                                        QuicTime::Delta delta_largest_observed));
 155
 156  protected:
 157   // Object is ref counted.
 158   virtual ~MockAckNotifierDelegate();
 159
 160   DISALLOW_COPY_AND_ASSIGN(MockAckNotifierDelegate);
 161 };
 162
 163 // Creates per-connection packet writers that register themselves with the
 164 // TestWriterFactory on each write so that TestWriterFactory::OnPacketSent can
 165 // be routed to the appropriate QuicConnection.
 166 class TestWriterFactory : public QuicDispatcher::PacketWriterFactory {
 167  public:
 168   TestWriterFactory();
 169   ~TestWriterFactory() override;
 170
 171   QuicPacketWriter* Create(QuicPacketWriter* writer,
 172                            QuicConnection* connection) override;
 173
 174   // Calls OnPacketSent on the last QuicConnection to write through one of the
 175   // packet writers created by this factory.
 176   void OnPacketSent(WriteResult result);
 177
 178  private:
 179   class PerConnectionPacketWriter : public QuicPerConnectionPacketWriter {
 180    public:
 181     PerConnectionPacketWriter(TestWriterFactory* factory,
 182                               QuicPacketWriter* writer,
 183                               QuicConnection* connection);
 184     ~PerConnectionPacketWriter() override;
 185
 186     WriteResult WritePacket(const char* buffer,
 187                             size_t buf_len,
 188                             const IPAddressNumber& self_address,
 189                             const IPEndPoint& peer_address) override;
 190
 191    private:
 192     TestWriterFactory* factory_;
 193   };
 194
 195   // If an asynchronous write is happening and |writer| gets deleted, this
 196   // clears the pointer to it to prevent use-after-free.
 197   void Unregister(PerConnectionPacketWriter* writer);
 198
 199   PerConnectionPacketWriter* current_writer_;
 200 };
 201
 202 }  // namespace test
 203 }  // namespace tools
 204 }  // namespace net
 205
 206 #endif  // NET_TOOLS_QUIC_TEST_TOOLS_QUIC_TEST_UTILS_H_