1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
|
// Copyright 2017 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "net/nqe/socket_watcher.h"
#include "base/functional/bind.h"
#include "base/run_loop.h"
#include "base/task/single_thread_task_runner.h"
#include "base/test/simple_test_tick_clock.h"
#include "base/time/time.h"
#include "build/build_config.h"
#include "net/base/ip_address.h"
#include "net/socket/socket_performance_watcher_factory.h"
#include "net/test/test_with_task_environment.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace net::nqe::internal {
namespace {
class NetworkQualitySocketWatcherTest : public TestWithTaskEnvironment {
public:
NetworkQualitySocketWatcherTest(const NetworkQualitySocketWatcherTest&) =
delete;
NetworkQualitySocketWatcherTest& operator=(
const NetworkQualitySocketWatcherTest&) = delete;
protected:
NetworkQualitySocketWatcherTest() { ResetExpectedCallbackParams(); }
~NetworkQualitySocketWatcherTest() override { ResetExpectedCallbackParams(); }
static void OnUpdatedRTTAvailableStoreParams(
SocketPerformanceWatcherFactory::Protocol protocol,
const base::TimeDelta& rtt,
const std::optional<IPHash>& host) {
// Need to verify before another callback is executed, or explicitly call
// |ResetCallbackParams()|.
ASSERT_FALSE(callback_executed_);
callback_rtt_ = rtt;
callback_host_ = host;
callback_executed_ = true;
}
static void OnUpdatedRTTAvailable(
SocketPerformanceWatcherFactory::Protocol protocol,
const base::TimeDelta& rtt,
const std::optional<IPHash>& host) {
// Need to verify before another callback is executed, or explicitly call
// |ResetCallbackParams()|.
ASSERT_FALSE(callback_executed_);
callback_executed_ = true;
}
static void SetShouldNotifyRTTCallback(bool value) {
should_notify_rtt_callback_ = value;
}
static bool ShouldNotifyRTTCallback(base::TimeTicks now) {
return should_notify_rtt_callback_;
}
static void VerifyCallbackParams(const base::TimeDelta& rtt,
const std::optional<IPHash>& host) {
ASSERT_TRUE(callback_executed_);
EXPECT_EQ(rtt, callback_rtt_);
if (host)
EXPECT_EQ(host, callback_host_);
else
EXPECT_FALSE(callback_host_.has_value());
ResetExpectedCallbackParams();
}
static void ResetExpectedCallbackParams() {
callback_rtt_ = base::Milliseconds(0);
callback_host_ = std::nullopt;
callback_executed_ = false;
should_notify_rtt_callback_ = false;
}
static base::TimeDelta callback_rtt() { return callback_rtt_; }
private:
static base::TimeDelta callback_rtt_;
static std::optional<IPHash> callback_host_;
static bool callback_executed_;
static bool should_notify_rtt_callback_;
};
base::TimeDelta NetworkQualitySocketWatcherTest::callback_rtt_ =
base::Milliseconds(0);
std::optional<IPHash> NetworkQualitySocketWatcherTest::callback_host_ =
std::nullopt;
bool NetworkQualitySocketWatcherTest::callback_executed_ = false;
bool NetworkQualitySocketWatcherTest::should_notify_rtt_callback_ = false;
// Verify that the buffer size is never exceeded.
TEST_F(NetworkQualitySocketWatcherTest, NotificationsThrottled) {
base::SimpleTestTickClock tick_clock;
tick_clock.SetNowTicks(base::TimeTicks::Now());
// Use a public IP address so that the socket watcher runs the RTT callback.
IPAddress ip_address;
ASSERT_TRUE(ip_address.AssignFromIPLiteral("157.0.0.1"));
SocketWatcher socket_watcher(
SocketPerformanceWatcherFactory::PROTOCOL_TCP, ip_address,
base::Milliseconds(2000), false,
base::SingleThreadTaskRunner::GetCurrentDefault(),
base::BindRepeating(OnUpdatedRTTAvailable),
base::BindRepeating(ShouldNotifyRTTCallback), &tick_clock);
EXPECT_TRUE(socket_watcher.ShouldNotifyUpdatedRTT());
socket_watcher.OnUpdatedRTTAvailable(base::Seconds(10));
base::RunLoop().RunUntilIdle();
ResetExpectedCallbackParams();
EXPECT_FALSE(socket_watcher.ShouldNotifyUpdatedRTT());
tick_clock.Advance(base::Milliseconds(1000));
// Minimum interval between consecutive notifications is 2000 msec.
EXPECT_FALSE(socket_watcher.ShouldNotifyUpdatedRTT());
// Advance the clock by 1000 msec more so that the current time is at least
// 2000 msec more than the last time |socket_watcher| received a notification.
tick_clock.Advance(base::Milliseconds(1000));
EXPECT_TRUE(socket_watcher.ShouldNotifyUpdatedRTT());
ResetExpectedCallbackParams();
socket_watcher.OnUpdatedRTTAvailable(base::Seconds(10));
EXPECT_FALSE(socket_watcher.ShouldNotifyUpdatedRTT());
// RTT notification is allowed by the global check.
SetShouldNotifyRTTCallback(true);
EXPECT_TRUE(socket_watcher.ShouldNotifyUpdatedRTT());
}
TEST_F(NetworkQualitySocketWatcherTest, QuicFirstNotificationDropped) {
base::SimpleTestTickClock tick_clock;
tick_clock.SetNowTicks(base::TimeTicks::Now());
// Use a public IP address so that the socket watcher runs the RTT callback.
IPAddress ip_address;
ASSERT_TRUE(ip_address.AssignFromIPLiteral("157.0.0.1"));
SocketWatcher socket_watcher(
SocketPerformanceWatcherFactory::PROTOCOL_QUIC, ip_address,
base::Milliseconds(2000), false,
base::SingleThreadTaskRunner::GetCurrentDefault(),
base::BindRepeating(OnUpdatedRTTAvailableStoreParams),
base::BindRepeating(ShouldNotifyRTTCallback), &tick_clock);
EXPECT_TRUE(socket_watcher.ShouldNotifyUpdatedRTT());
socket_watcher.OnUpdatedRTTAvailable(base::Seconds(10));
base::RunLoop().RunUntilIdle();
// First notification from a QUIC connection should be dropped, and it should
// be possible to notify the |socket_watcher| again.
EXPECT_TRUE(NetworkQualitySocketWatcherTest::callback_rtt().is_zero());
EXPECT_TRUE(socket_watcher.ShouldNotifyUpdatedRTT());
ResetExpectedCallbackParams();
socket_watcher.OnUpdatedRTTAvailable(base::Seconds(2));
base::RunLoop().RunUntilIdle();
EXPECT_EQ(base::Seconds(2), NetworkQualitySocketWatcherTest::callback_rtt());
ResetExpectedCallbackParams();
EXPECT_FALSE(socket_watcher.ShouldNotifyUpdatedRTT());
tick_clock.Advance(base::Milliseconds(1000));
// Minimum interval between consecutive notifications is 2000 msec.
EXPECT_FALSE(socket_watcher.ShouldNotifyUpdatedRTT());
// Advance the clock by 1000 msec more so that the current time is at least
// 2000 msec more than the last time |socket_watcher| received a notification.
tick_clock.Advance(base::Milliseconds(1000));
EXPECT_TRUE(socket_watcher.ShouldNotifyUpdatedRTT());
}
#if BUILDFLAG(IS_IOS)
// Flaky on iOS: crbug.com/672917.
#define MAYBE_PrivateAddressRTTNotNotified DISABLED_PrivateAddressRTTNotNotified
#else
#define MAYBE_PrivateAddressRTTNotNotified PrivateAddressRTTNotNotified
#endif
TEST_F(NetworkQualitySocketWatcherTest, MAYBE_PrivateAddressRTTNotNotified) {
base::SimpleTestTickClock tick_clock;
tick_clock.SetNowTicks(base::TimeTicks::Now());
const struct {
std::string ip_address;
bool expect_should_notify_rtt;
} tests[] = {
{"157.0.0.1", true}, {"127.0.0.1", false},
{"192.168.0.1", false}, {"::1", false},
{"0.0.0.0", false}, {"2607:f8b0:4006:819::200e", true},
};
for (const auto& test : tests) {
IPAddress ip_address;
ASSERT_TRUE(ip_address.AssignFromIPLiteral(test.ip_address));
SocketWatcher socket_watcher(
SocketPerformanceWatcherFactory::PROTOCOL_TCP, ip_address,
base::Milliseconds(2000), false,
base::SingleThreadTaskRunner::GetCurrentDefault(),
base::BindRepeating(OnUpdatedRTTAvailable),
base::BindRepeating(ShouldNotifyRTTCallback), &tick_clock);
EXPECT_EQ(test.expect_should_notify_rtt,
socket_watcher.ShouldNotifyUpdatedRTT());
socket_watcher.OnUpdatedRTTAvailable(base::Seconds(10));
base::RunLoop().RunUntilIdle();
ResetExpectedCallbackParams();
EXPECT_FALSE(socket_watcher.ShouldNotifyUpdatedRTT());
}
}
TEST_F(NetworkQualitySocketWatcherTest, RemoteHostIPHashComputedCorrectly) {
base::SimpleTestTickClock tick_clock;
tick_clock.SetNowTicks(base::TimeTicks::Now());
const struct {
std::string ip_address;
uint64_t host;
} tests[] = {
{"112.112.112.100", 0x0000000070707064UL}, // IPv4.
{"112.112.112.250", 0x00000000707070faUL},
{"2001:0db8:85a3:0000:0000:8a2e:0370:7334",
0x20010db885a30000UL}, // IPv6.
{"2001:db8:85a3::8a2e:370:7334", 0x20010db885a30000UL} // Shortened IPv6.
};
for (const auto& test : tests) {
IPAddress ip_address;
ASSERT_TRUE(ip_address.AssignFromIPLiteral(test.ip_address));
SocketWatcher socket_watcher(
SocketPerformanceWatcherFactory::PROTOCOL_TCP, ip_address,
base::Milliseconds(2000), false,
base::SingleThreadTaskRunner::GetCurrentDefault(),
base::BindRepeating(OnUpdatedRTTAvailableStoreParams),
base::BindRepeating(ShouldNotifyRTTCallback), &tick_clock);
EXPECT_TRUE(socket_watcher.ShouldNotifyUpdatedRTT());
socket_watcher.OnUpdatedRTTAvailable(base::Seconds(10));
base::RunLoop().RunUntilIdle();
VerifyCallbackParams(base::Seconds(10), test.host);
EXPECT_FALSE(socket_watcher.ShouldNotifyUpdatedRTT());
}
}
} // namespace
} // namespace net::nqe::internal
|