Define Stable API for WebRTC/Quartc

net/quic/quartc/quartc_reliable_stream_test.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/quic/quartc/quartc_reliable_stream.h"
+
+#include "base/threading/thread_task_runner_handle.h"
+#include "net/quic/core/quic_session.h"
+#include "net/quic/quartc/quartc_alarm_factory.h"
+#include "net/quic/quartc/quartc_connection_helper.h"
+#include "net/quic/quartc/quartc_reliable_stream_interface.h"
+#include "testing/gtest/include/gtest/gtest.h"
+
+namespace net {
+namespace test {
+namespace {
+
+static const SpdyPriority kDefaultPriority = 3;
+static const QuicStreamId kStreamId = 5;
+static const QuartcReliableStreamInterface::WriteParameters kDefaultParam;
+
+// MockQuicSession that does not create streams and writes data from
+// ReliableQuicStream to a string.
+class MockQuicSession : public QuicSession {
+ public:
+  MockQuicSession(QuicConnection* connection,
+                  const QuicConfig& config,
+                  std::string* write_buffer)
+      : QuicSession(connection, config), write_buffer_(write_buffer) {}
+
+  // Writes outgoing data from ReliableQuicStream to a string.
+  QuicConsumedData WritevData(
+      ReliableQuicStream* stream,
+      QuicStreamId id,
+      QuicIOVector iovector,
+      QuicStreamOffset offset,
+      bool fin,
+      QuicAckListenerInterface* ack_notifier_delegate) override {
+    if (!writable_) {
+      return QuicConsumedData(0, false);
+    }
+
+    const char* data = reinterpret_cast<const char*>(iovector.iov->iov_base);
+    size_t len = iovector.total_length;
+    write_buffer_->append(data, len);
+    return QuicConsumedData(len, false);

[skvlad-chromium, 2016/09/22 01:54:25]

shouldn't this return QuicConsumedData(len, fin)?

[zhihuang1, 2016/09/22 18:53:52]

You're right.

+  }
+
+  QuartcReliableStream* CreateIncomingDynamicStream(QuicStreamId id) override {
+    return nullptr;
+  }
+
+  QuartcReliableStream* CreateOutgoingDynamicStream(
+      SpdyPriority priority) override {
+    return nullptr;
+  }
+
+  QuicCryptoStream* GetCryptoStream() override { return nullptr; }
+
+  // Called by ReliableQuicStream when they want to close stream.
+  void SendRstStream(QuicStreamId id,
+                     QuicRstStreamErrorCode error,
+                     QuicStreamOffset bytes_written) override {}
+
+  // Sets whether data is written to buffer, or else if this is write blocked.
+  void set_writable(bool writable) { writable_ = writable; }
+
+  // Tracks whether the stream is write blocked and its priority.
+  void RegisterReliableStream(QuicStreamId stream_id, SpdyPriority priority) {
+    write_blocked_streams()->RegisterStream(stream_id, priority);
+  }
+
+  // The session take ownership of the stream.
+  void ActivateReliableStream(ReliableQuicStream* stream) {
+    ActivateStream(stream);
+  }
+
+ private:
+  // Stores written data from ReliableQuicStreamAdapter.
+  std::string* write_buffer_;
+  // Whether data is written to write_buffer_.
+  bool writable_ = true;
+};
+
+// Packet writer that does nothing. This is required for QuicConnection but
+// isn't used for writing data.
+class DummyPacketWriter : public QuicPacketWriter {
+ public:
+  DummyPacketWriter() {}
+
+  // QuicPacketWriter overrides.
+  WriteResult WritePacket(const char* buffer,
+                          size_t buf_len,
+                          const IPAddress& self_address,
+                          const IPEndPoint& peer_address,
+                          PerPacketOptions* options) override {
+    return WriteResult(WRITE_STATUS_ERROR, 0);
+  }
+
+  bool IsWriteBlockedDataBuffered() const override { return false; }
+
+  bool IsWriteBlocked() const override { return false; };
+
+  void SetWritable() override {}
+
+  QuicByteCount GetMaxPacketSize(
+      const IPEndPoint& peer_address) const override {
+    return 0;
+  }
+};
+
+class MockQuartcReliableStreamObserver : public QuartcReliableStream::Observer {
+ public:
+  MockQuartcReliableStreamObserver(int id, std::string& read_buffer)
+      : id_(id), read_buffer_(read_buffer) {}
+
+  void OnBufferedAmountChanged(QuartcReliableStreamInterface* stream) override {
+    queued_bytes_amount_ = stream->buffered_amount();
+  }
+
+  void OnReceived(QuartcReliableStreamInterface* stream,
+                  const char* data,
+                  size_t size) override {
+    EXPECT_EQ(id_, stream->stream_id());
+    read_buffer_.append(data, size);
+  }
+
+  void OnClose(QuartcReliableStreamInterface* stream, int error_code) override {
+    closed_ = true;
+  }
+
+  bool closed() { return closed_; }
+
+  int queued_bytes_amount() { return queued_bytes_amount_; }
+
+ protected:
+  uint32_t id_;
+  // Data read by the ReliableQuicStream.
+  std::string& read_buffer_;
+  // Whether the ReliableQuicStream is closed.
+  bool closed_ = false;
+  int queued_bytes_amount_ = -1;
+};
+
+class QuartcReliableStreamTest : public ::testing::Test {
+ public:
+  void CreateReliableQuicStream() {
+    // Arbitrary values for QuicConnection.
+    QuicConnectionHelperInterface* quic_helper = new QuartcConnectionHelper;
+    Perspective perspective = Perspective::IS_SERVER;
+    IPAddress ip(0, 0, 0, 0);
+    bool owns_writer = true;
+    QuartcAlarmFactory* alarm_factory = new QuartcAlarmFactory(

[skvlad-chromium, 2016/09/22 01:54:25]

Shouldn't the factory and the connection be owned by a unique_ptr inside the
test class? Otherwise they will leak at the end of the test.

[zhihuang1, 2016/09/22 18:53:52]

Yes. The connection will not own the factory.
Done.

+        base::ThreadTaskRunnerHandle::Get().get(), quic_helper->GetClock());
+
+    QuicConnection* connection =
+        new QuicConnection(0, IPEndPoint(ip, 0), quic_helper, alarm_factory,
+                           new DummyPacketWriter(), owns_writer, perspective,
+                           AllSupportedVersions());
+
+    session_.reset(
+        new MockQuicSession(connection, QuicConfig(), &write_buffer_));
+    mock_stream_observer_.reset(
+        new MockQuartcReliableStreamObserver(kStreamId, read_buffer_));
+    stream_ = new QuartcReliableStream(kStreamId, session_.get());
+    stream_->SetObserver(mock_stream_observer_.get());
+    session_->RegisterReliableStream(stream_->stream_id(), kDefaultPriority);
+    session_->ActivateReliableStream(stream_);
+  }
+
+ protected:
+  QuartcReliableStream* stream_ = nullptr;
+  std::unique_ptr<MockQuartcReliableStreamObserver> mock_stream_observer_;
+  std::unique_ptr<MockQuicSession> session_;
+  // Data written by the ReliableQuicStreamAdapterTest.
+  std::string write_buffer_;
+  // Data read by the ReliableQuicStreamAdapterTest.
+  std::string read_buffer_;
+};
+
+// Write an entire string.
+TEST_F(QuartcReliableStreamTest, WriteDataWhole) {
+  CreateReliableQuicStream();
+  stream_->Write("Foo bar", 7, kDefaultParam);
+  EXPECT_EQ("Foo bar", write_buffer_);
+}
+
+// Write part of a string.
+TEST_F(QuartcReliableStreamTest, WriteDataPartial) {
+  CreateReliableQuicStream();
+  stream_->Write("Foo bar", 5, kDefaultParam);
+  EXPECT_EQ("Foo b", write_buffer_);
+}
+
+// Test that strings are buffered correctly.
+TEST_F(QuartcReliableStreamTest, BufferData) {
+  CreateReliableQuicStream();
+
+  session_->set_writable(false);
+  stream_->Write("Foo bar", 7, kDefaultParam);
+  // The data will be buffered.
+  EXPECT_EQ(0ul, write_buffer_.size());
+  EXPECT_TRUE(stream_->HasBufferedData());
+  EXPECT_EQ(-1, mock_stream_observer_->queued_bytes_amount());
+  // The session is writable and the buffered data amount will change.
+  session_->set_writable(true);
+  stream_->OnCanWrite();
+  EXPECT_EQ(0, mock_stream_observer_->queued_bytes_amount());
+  EXPECT_FALSE(stream_->HasBufferedData());
+  EXPECT_EQ("Foo bar", write_buffer_);
+
+  stream_->Write("xyzzy", 5, kDefaultParam);
+  EXPECT_EQ("Foo barxyzzy", write_buffer_);
+}
+
+// Read an entire string.
+TEST_F(QuartcReliableStreamTest, ReadDataWhole) {
+  CreateReliableQuicStream();
+  QuicStreamFrame frame(kStreamId, false, 0, "Hello, World!");
+  stream_->OnStreamFrame(frame);
+
+  EXPECT_EQ("Hello, World!", read_buffer_);
+}
+
+// Read part of a string.
+TEST_F(QuartcReliableStreamTest, ReadDataPartial) {
+  CreateReliableQuicStream();
+  QuicStreamFrame frame(kStreamId, false, 0, "Hello, World!");
+  frame.data_length = 5;
+  stream_->OnStreamFrame(frame);
+
+  EXPECT_EQ("Hello", read_buffer_);
+}
+
+// Test that closing the stream results in a callback.
+TEST_F(QuartcReliableStreamTest, CloseStream) {
+  CreateReliableQuicStream();
+  EXPECT_FALSE(mock_stream_observer_->closed());
+  stream_->OnClose();
+  EXPECT_TRUE(mock_stream_observer_->closed());
+}
+
+}  // namespace
+}  // namespace test
+}  // namespace net