Index: components/certificate_transparency/mock_log_dns_traffic.h |
diff --git a/components/certificate_transparency/mock_log_dns_traffic.h b/components/certificate_transparency/mock_log_dns_traffic.h |
index 78257d8eeef6ddd6fd2717b05356b0615843b216..2496737f864b06ea5ab91dac9d5c992d36cf1a04 100644 |
--- a/components/certificate_transparency/mock_log_dns_traffic.h |
+++ b/components/certificate_transparency/mock_log_dns_traffic.h |
@@ -19,28 +19,62 @@ |
namespace certificate_transparency { |
+namespace internal { |
+ |
+// A container for all of the data we need to keep alive for a mock socket. |
+// This is useful because Mock{Read,Write}, SequencedSocketData and |
+// MockClientSocketFactory all do not take ownership of or copy their arguments, |
+// so we have to manage the lifetime of those arguments ourselves. Wrapping all |
+// of that up in a single class simplifies this. |
+// This cannot be forward declared because MockLogDnsTraffic has a |
+// vector<unique_ptr<MockSocketData>> member, which requires MockSocketData be |
+// defined. |
+class MockSocketData { |
+ public: |
+ // A socket that expects one write and one read operation. |
+ MockSocketData(const std::vector<char>& write, const std::vector<char>& read); |
+ // A socket that expects one write and a read error. |
+ MockSocketData(const std::vector<char>& write, int net_error); |
+ // A socket that expects one write and no response. |
+ explicit MockSocketData(const std::vector<char>& write); |
+ |
+ ~MockSocketData(); |
+ |
+ void SetWriteMode(net::IoMode mode) { expected_write_.mode = mode; } |
+ void SetReadMode(net::IoMode mode) { expected_reads_[0].mode = mode; } |
+ |
+ void AddToFactory(net::MockClientSocketFactory* socket_factory); |
+ |
+ private: |
+ // Prevents read overruns and makes a socket timeout the default behaviour. |
+ static const net::MockRead no_more_data_; |
+ |
+ // This class only supports one write and one read, so just need to store one |
+ // payload each. |
+ const std::vector<char> expected_write_payload_; |
+ const std::vector<char> expected_read_payload_; |
+ // Encapsulates the data that is expected to be written to a socket. |
+ net::MockWrite expected_write_; |
+ // Encapsulates the data/error that should be returned when reading from a |
+ // socket. The second "expected" read is always |no_more_data_|, which |
+ // causes the socket read to hang until it times out. This results in better |
+ // test failure messages (rather than a CHECK-fail due to a socket read |
+ // overrunning the MockRead array) and behaviour more like a real socket when |
+ // an unexpected second socket read occurs. |
+ net::MockRead expected_reads_[2]; |
+ // Holds pointers to |expected_write_| and |expected_reads_|. This is what is |
+ // added to net::MockClientSocketFactory to prepare a mock socket. |
+ net::SequencedSocketData socket_data_; |
+ |
+ DISALLOW_COPY_AND_ASSIGN(MockSocketData); |
+}; |
+ |
+} // namespace internal |
+ |
// Mocks DNS requests and responses for a Certificate Transparency (CT) log. |
// This is implemented using mock sockets. Call the CreateDnsClient() method to |
// get a net::DnsClient wired up to these mock sockets. |
// The Expect*() methods must be called from within a GTest test case. |
-// |
-// Example Usage: |
-// // net::DnsClient requires an I/O message loop for async operations. |
-// base::MessageLoopForIO message_loop; |
-// |
-// // Create a mock NetworkChangeNotifier to propagate DNS config. |
-// std::unique_ptr<net::NetworkChangeNotifier> net_change_notifier( |
-// net::NetworkChangeNotifier::CreateMock()); |
-// |
-// MockLogDnsTraffic mock_dns; |
-// mock_dns.InitializeDnsConfig(); |
-// // Use the Expect* methods to define expected DNS requests and responses. |
-// mock_dns.ExpectLeafIndexRequestAndResponse( |
-// "D4S6DSV2J743QJZEQMH4UYHEYK7KRQ5JIQOCPMFUHZVJNFGHXACA.hash.ct.test.", |
-// "123456"); |
-// |
-// LogDnsClient log_client(mock_dns.CreateDnsClient(), ...); |
-// log_client.QueryAuditProof("ct.test", ..., base::Bind(...)); |
class MockLogDnsTraffic { |
public: |
MockLogDnsTraffic(); |
@@ -51,16 +85,14 @@ |
// specified by |rcode| occurred. See RFC1035, Section 4.1.1 for |rcode| |
// values. |
void ExpectRequestAndErrorResponse(base::StringPiece qname, uint8_t rcode); |
- |
// Expect a CT DNS request for the domain |qname|. |
- // Such a request will trigger a socket error of type |error|. |
- void ExpectRequestAndSocketError(base::StringPiece qname, net::Error error); |
- |
+ // Such a request will trigger a socket error of type |net_error|. |
+ // |net_error| can be any net:Error value. |
+ void ExpectRequestAndSocketError(base::StringPiece qname, int net_error); |
// Expect a CT DNS request for the domain |qname|. |
// Such a request will timeout. |
// This will reduce the DNS timeout to minimize test duration. |
void ExpectRequestAndTimeout(base::StringPiece qname); |
- |
// Expect a CT DNS request for the domain |qname|. |
// Such a request will receive a DNS TXT response containing |txt_strings|. |
void ExpectRequestAndResponse( |
@@ -98,19 +130,12 @@ |
// It is this DNS client that the expectations will be tested against. |
std::unique_ptr<net::DnsClient> CreateDnsClient(); |
- private: |
- // Allows tests to change socket read mode. Only the LogDnsClient tests should |
- // need to do so, to ensure consistent behaviour regardless of mode. |
- friend class LogDnsClientTest; |
- |
- class MockSocketData; |
- |
// Sets whether mock reads should complete synchronously or asynchronously. |
- // By default, they complete asynchronously. |
void SetSocketReadMode(net::IoMode read_mode) { |
socket_read_mode_ = read_mode; |
} |
+ private: |
// Constructs MockSocketData from |args| and adds it to |socket_factory_|. |
template <typename... Args> |
void EmplaceMockSocketData(Args&&... args); |
@@ -123,7 +148,7 @@ |
// One MockSocketData for each socket that is created. This corresponds to one |
// for each DNS request sent. |
- std::vector<std::unique_ptr<MockSocketData>> mock_socket_data_; |
+ std::vector<std::unique_ptr<internal::MockSocketData>> mock_socket_data_; |
// Provides as many mock sockets as there are entries in |mock_socket_data_|. |
net::MockClientSocketFactory socket_factory_; |
// Controls whether mock socket reads are asynchronous. |