Extracts CT DNS test utilities into a standalone class

components/certificate_transparency/mock_log_dns_traffic.cc

Index: components/certificate_transparency/mock_log_dns_traffic.cc
diff --git a/components/certificate_transparency/mock_log_dns_traffic.cc b/components/certificate_transparency/mock_log_dns_traffic.cc
new file mode 100644
index 0000000000000000000000000000000000000000..c42156259c525516abcaf173bbd1fddba85e30ad
--- /dev/null
+++ b/components/certificate_transparency/mock_log_dns_traffic.cc
@@ -0,0 +1,239 @@
+// Copyright 2016 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 "components/certificate_transparency/mock_log_dns_traffic.h"
+
+#include <algorithm>
+#include <numeric>
+#include <vector>
+
+#include "base/big_endian.h"
+#include "base/sys_byteorder.h"
+#include "base/test/test_timeouts.h"
+#include "net/dns/dns_client.h"
+#include "net/dns/dns_protocol.h"
+#include "net/dns/dns_util.h"
+#include "net/socket/socket_test_util.h"
+#include "testing/gtest/include/gtest/gtest.h"
+
+namespace certificate_transparency {
+
+namespace {
+
+// Always return min, to simplify testing.
+// This should result in the DNS query ID always being 0.
+int FakeRandInt(int min, int max) {
+  return min;
+}
+
+std::vector<char> CreateDnsTxtRequest(base::StringPiece qname) {
+  std::string encoded_qname;
+  EXPECT_TRUE(net::DNSDomainFromDot(qname, &encoded_qname));
+
+  const size_t query_section_size = encoded_qname.size() + 4;

[Eran Messeri, 2016/07/21 14:47:02]

What does the '4' here stand for? Would it make sense having a constant for it ?

[Rob Percival, 2016/07/21 17:32:21]

It's the 4 bytes you see written below, just after the encoded_qname is written.
I could call it "query_section_size_minus_qname", or perhaps more sensibly split
it into "record_type_size" and "record_class_size"?

[Eran Messeri, 2016/07/22 15:55:48]

Splitting sounds better.

+
+  std::vector<char> request(sizeof(net::dns_protocol::Header) +
+                            query_section_size);
+  base::BigEndianWriter writer(request.data(), request.size());
+
+  // Header
+  net::dns_protocol::Header header = {};
+  header.flags = base::HostToNet16(net::dns_protocol::kFlagRD);
+  header.qdcount = base::HostToNet16(1);
+  EXPECT_TRUE(writer.WriteBytes(&header, sizeof(header)));
+  // Query section
+  EXPECT_TRUE(writer.WriteBytes(encoded_qname.data(), encoded_qname.size()));
+  EXPECT_TRUE(writer.WriteU16(net::dns_protocol::kTypeTXT));
+  EXPECT_TRUE(writer.WriteU16(net::dns_protocol::kClassIN));
+  EXPECT_EQ(0, writer.remaining());
+
+  return request;
+}
+
+std::vector<char> CreateDnsTxtResponse(const std::vector<char>& request,
+                                       base::StringPiece answer) {
+  const size_t answers_section_size = 12 + answer.size();

[Eran Messeri, 2016/07/21 14:47:02]

Another magic number, please have a constant explaining it.

[Rob Percival, 2016/07/21 17:32:21]

Again, this is the 12 bytes you see written a little further down this function.
I could break this down into all of the constituent parts, e.g. "qname_size",
"record_type_size", "record_class_size", "ttl_size", "answer_size_size" (not so
sure about that last one)? Alternatively, "answers_section_size_minus_answer".

[Eran Messeri, 2016/07/22 15:55:48]

Again, breaking down seems better as it's clear what we're adding and it's easy
to review and make sure that the size of each added component matches what's
being written to the BigEndianWriter.

+  constexpr uint32_t ttl = 86400;  // seconds
+
+  std::vector<char> response(request.size() + answers_section_size);
+  std::copy(request.begin(), request.end(), response.begin());
+  // Modify the header
+  net::dns_protocol::Header* header =
+      reinterpret_cast<net::dns_protocol::Header*>(response.data());
+  header->ancount = base::HostToNet16(1);
+  header->flags |= base::HostToNet16(net::dns_protocol::kFlagResponse);
+
+  // Write the answer section
+  base::BigEndianWriter writer(response.data() + request.size(),
+                               response.size() - request.size());
+  EXPECT_TRUE(writer.WriteU8(0xc0));  // qname is a pointer
+  EXPECT_TRUE(writer.WriteU8(
+      sizeof(*header)));  // address of qname (start of query section)
+  EXPECT_TRUE(writer.WriteU16(net::dns_protocol::kTypeTXT));
+  EXPECT_TRUE(writer.WriteU16(net::dns_protocol::kClassIN));
+  EXPECT_TRUE(writer.WriteU32(ttl));
+  EXPECT_TRUE(writer.WriteU16(answer.size()));
+  EXPECT_TRUE(writer.WriteBytes(answer.data(), answer.size()));
+  EXPECT_EQ(0, writer.remaining());
+
+  return response;
+}
+
+std::vector<char> CreateDnsErrorResponse(const std::vector<char>& request,
+                                         uint8_t rcode) {
+  std::vector<char> response(request);
+  // Modify the header
+  net::dns_protocol::Header* header =
+      reinterpret_cast<net::dns_protocol::Header*>(response.data());
+  header->ancount = base::HostToNet16(1);
+  header->flags |= base::HostToNet16(net::dns_protocol::kFlagResponse | rcode);
+
+  return response;
+}
+
+}  // namespace
+
+namespace detail {
+
+MockSocketData::MockSocketData(const std::vector<char>& write,
+                               const std::vector<char>& read)
+    : expected_write_payload_(write),
+      expected_read_payload_(read),
+      expected_write_(net::SYNCHRONOUS,
+                      expected_write_payload_.data(),
+                      expected_write_payload_.size(),
+                      0),
+      expected_reads_{net::MockRead(net::ASYNC,
+                                    expected_read_payload_.data(),
+                                    expected_read_payload_.size(),
+                                    1),
+                      eof_},
+      socket_data_(expected_reads_, 2, &expected_write_, 1) {}
+
+MockSocketData::MockSocketData(const std::vector<char>& write, int net_error)
+    : expected_write_payload_(write),
+      expected_write_(net::SYNCHRONOUS,
+                      expected_write_payload_.data(),
+                      expected_write_payload_.size(),
+                      0),
+      expected_reads_{net::MockRead(net::ASYNC, net_error, 1), eof_},
+      socket_data_(expected_reads_, 2, &expected_write_, 1) {}
+
+MockSocketData::MockSocketData(const std::vector<char>& write)
+    : expected_write_payload_(write),
+      expected_write_(net::SYNCHRONOUS,
+                      expected_write_payload_.data(),
+                      expected_write_payload_.size(),
+                      0),
+      expected_reads_{net::MockRead(net::SYNCHRONOUS, net::ERR_IO_PENDING, 1),
+                      eof_},
+      socket_data_(expected_reads_, 2, &expected_write_, 1) {}
+
+MockSocketData::~MockSocketData() {}
+
+void MockSocketData::AddToFactory(
+    net::MockClientSocketFactory* socket_factory) {
+  socket_factory->AddSocketDataProvider(&socket_data_);
+}
+
+const net::MockRead MockSocketData::eof_(net::SYNCHRONOUS,
+                                         net::ERR_IO_PENDING,
+                                         2);
+
+}  // namespace detail
+
+using detail::MockSocketData;
+
+MockLogDnsTraffic::MockLogDnsTraffic() : socket_read_mode_(net::ASYNC) {
+  // Use an invalid nameserver address. This prevents the tests accidentally
+  // sending real DNS queries. The mock sockets don't care that the address
+  // is invalid.
+  dns_config_.nameservers.push_back(net::IPEndPoint());
+  // Don't attempt retransmissions - just fail.
+  dns_config_.attempts = 1;
+  // This ensures timeouts are long enough for memory tests.
+  dns_config_.timeout = TestTimeouts::action_timeout();
+  // Simplify testing - don't require random numbers for the source port.
+  // This means our FakeRandInt function should only be called to get query
+  // IDs.
+  dns_config_.randomize_ports = false;
+}
+
+MockLogDnsTraffic::~MockLogDnsTraffic() {}
+
+void MockLogDnsTraffic::ExpectRequestAndErrorResponse(base::StringPiece qname,
+                                                      uint8_t rcode) {
+  std::vector<char> request = CreateDnsTxtRequest(qname);
+  std::vector<char> response = CreateDnsErrorResponse(request, rcode);
+
+  mock_socket_data_.emplace_back(new MockSocketData(request, response));

[Eran Messeri, 2016/07/21 14:47:02]

inline request and response, since they're not used after being passed into the
c'tor (or you could have a MockSocketData c'tor that'll invoke the CreateDns*
methods.)

[Rob Percival, 2016/07/21 17:32:21]

Creating |response| requires |request|, so they can't both be inlined that
simply. Making MockSocketData invoke the CreateDns* functions is an option
though. 

[Eran Messeri, 2016/07/22 15:55:48]

So at the very least you could inline creating the response? Having the
MockSocketData do that is also fine, whatever looks best.

+  mock_socket_data_.back()->SetReadMode(socket_read_mode_);
+  mock_socket_data_.back()->AddToFactory(&socket_factory_);
+}
+
+void MockLogDnsTraffic::ExpectRequestAndSocketError(base::StringPiece qname,
+                                                    int net_error) {
+  std::vector<char> request = CreateDnsTxtRequest(qname);
+
+  mock_socket_data_.emplace_back(new MockSocketData(request, net_error));

[Eran Messeri, 2016/07/21 14:47:02]

Seems like you could have a helper method/function for emplacing a new
MockSocketData instance, then setting the read mode and adding it to factory.

[Rob Percival, 2016/07/21 17:32:21]

Done.

+  mock_socket_data_.back()->SetReadMode(socket_read_mode_);
+  mock_socket_data_.back()->AddToFactory(&socket_factory_);
+}
+
+void MockLogDnsTraffic::ExpectRequestAndTimeout(base::StringPiece qname) {
+  std::vector<char> request = CreateDnsTxtRequest(qname);
+
+  mock_socket_data_.emplace_back(new MockSocketData(request));
+  mock_socket_data_.back()->SetReadMode(socket_read_mode_);
+  mock_socket_data_.back()->AddToFactory(&socket_factory_);
+
+  // Speed up timeout tests.
+  dns_config_.timeout = TestTimeouts::tiny_timeout();
+}
+
+void MockLogDnsTraffic::ExpectLeafIndexRequestAndResponse(
+    base::StringPiece qname,
+    base::StringPiece leaf_index) {
+  // Prepend size to leaf_index to create the query answer (rdata)
+  ASSERT_LE(leaf_index.size(), 0xFFul);  // size must fit into a single byte
+  std::string answer = leaf_index.as_string();
+  answer.insert(answer.begin(), static_cast<char>(leaf_index.size()));
+
+  ExpectRequestAndResponse(qname, answer);
+}
+
+void MockLogDnsTraffic::ExpectAuditProofRequestAndResponse(
+    base::StringPiece qname,
+    std::vector<std::string>::const_iterator audit_path_start,
+    std::vector<std::string>::const_iterator audit_path_end) {
+  // Join nodes in the audit path into a single string.
+  std::string proof =
+      std::accumulate(audit_path_start, audit_path_end, std::string());
+
+  // Prepend size to proof to create the query answer (rdata)
+  ASSERT_LE(proof.size(), 0xFFul);  // size must fit into a single byte
+  proof.insert(proof.begin(), static_cast<char>(proof.size()));
+
+  ExpectRequestAndResponse(qname, proof);
+}
+
+std::unique_ptr<net::DnsClient> MockLogDnsTraffic::CreateDnsClient() {
+  std::unique_ptr<net::DnsClient> client =
+      net::DnsClient::CreateClientForTesting(nullptr, &socket_factory_,
+                                             base::Bind(&FakeRandInt));
+  client->SetConfig(dns_config_);
+  return client;
+}
+
+void MockLogDnsTraffic::ExpectRequestAndResponse(base::StringPiece qname,
+                                                 base::StringPiece answer) {
+  std::vector<char> request = CreateDnsTxtRequest(qname);
+  std::vector<char> response = CreateDnsTxtResponse(request, answer);
+
+  mock_socket_data_.emplace_back(new MockSocketData(request, response));
+  mock_socket_data_.back()->SetReadMode(socket_read_mode_);
+  mock_socket_data_.back()->AddToFactory(&socket_factory_);
+}
+
+}  // namespace certificate_transparency