summaryrefslogtreecommitdiff
path: root/chromium/net/base/network_cost_change_notifier_win_unittest.cc
blob: ae35acc6c88ec6f734d176524d2c222b55e1b46b (plain)
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
// Copyright 2022 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/base/network_cost_change_notifier_win.h"

#include "base/run_loop.h"
#include "base/sequence_checker.h"
#include "base/test/scoped_os_info_override_win.h"
#include "base/win/windows_version.h"
#include "net/base/network_change_notifier.h"
#include "net/test/test_connection_cost_observer.h"
#include "net/test/test_with_task_environment.h"
#include "net/test/win/fake_network_cost_manager.h"
#include "testing/gtest/include/gtest/gtest.h"

namespace net {

class NetworkCostChangeNotifierWinTest : public TestWithTaskEnvironment {
 public:
  void SetUp() override {
    if (base::win::GetVersion() < base::win::Version::WIN10) {
      GTEST_SKIP();
    }
  }

 protected:
  FakeNetworkCostManagerEnvironment fake_network_cost_manager_environment_;
};

TEST_F(NetworkCostChangeNotifierWinTest, InitialCostUnknown) {
  fake_network_cost_manager_environment_.SetCost(
      NetworkChangeNotifier::ConnectionCost::CONNECTION_COST_UNKNOWN);

  TestConnectionCostObserver cost_change_observer;
  auto cost_change_callback =
      base::BindRepeating(&TestConnectionCostObserver::OnConnectionCostChanged,
                          base::Unretained(&cost_change_observer));

  base::SequenceBound<NetworkCostChangeNotifierWin> cost_change_notifier =
      NetworkCostChangeNotifierWin::CreateInstance(cost_change_callback);

  // Wait for `NetworkCostChangeNotifierWin` to finish initializing.
  cost_change_observer.WaitForConnectionCostChanged();

  // `NetworkCostChangeNotifierWin` must report an unknown cost after
  // initializing.
  EXPECT_EQ(cost_change_observer.cost_changed_calls(), 1u);
  EXPECT_EQ(cost_change_observer.last_cost_changed_input(),
            NetworkChangeNotifier::ConnectionCost::CONNECTION_COST_UNKNOWN);
}

TEST_F(NetworkCostChangeNotifierWinTest, InitialCostKnown) {
  fake_network_cost_manager_environment_.SetCost(
      NetworkChangeNotifier::ConnectionCost::CONNECTION_COST_UNMETERED);

  TestConnectionCostObserver cost_change_observer;
  auto cost_change_callback =
      base::BindRepeating(&TestConnectionCostObserver::OnConnectionCostChanged,
                          base::Unretained(&cost_change_observer));

  base::SequenceBound<NetworkCostChangeNotifierWin> cost_change_notifier =
      NetworkCostChangeNotifierWin::CreateInstance(cost_change_callback);

  // Initializing changes the cost from unknown to unmetered.
  cost_change_observer.WaitForConnectionCostChanged();

  ASSERT_EQ(cost_change_observer.cost_changed_calls(), 1u);
  EXPECT_EQ(cost_change_observer.last_cost_changed_input(),
            NetworkChangeNotifier::ConnectionCost::CONNECTION_COST_UNMETERED);
}

TEST_F(NetworkCostChangeNotifierWinTest, MultipleCostChangedEvents) {
  fake_network_cost_manager_environment_.SetCost(
      NetworkChangeNotifier::ConnectionCost::CONNECTION_COST_UNMETERED);

  TestConnectionCostObserver cost_change_observer;
  auto cost_change_callback =
      base::BindRepeating(&TestConnectionCostObserver::OnConnectionCostChanged,
                          base::Unretained(&cost_change_observer));

  base::SequenceBound<NetworkCostChangeNotifierWin> cost_change_notifier =
      NetworkCostChangeNotifierWin::CreateInstance(cost_change_callback);

  // Initializing changes the cost from unknown to unmetered.
  cost_change_observer.WaitForConnectionCostChanged();

  ASSERT_EQ(cost_change_observer.cost_changed_calls(), 1u);
  EXPECT_EQ(cost_change_observer.last_cost_changed_input(),
            NetworkChangeNotifier::ConnectionCost::CONNECTION_COST_UNMETERED);

  fake_network_cost_manager_environment_.SetCost(
      NetworkChangeNotifier::ConnectionCost::CONNECTION_COST_METERED);

  // The simulated event changes the cost from unmetered to metered.
  cost_change_observer.WaitForConnectionCostChanged();

  ASSERT_EQ(cost_change_observer.cost_changed_calls(), 2u);
  EXPECT_EQ(cost_change_observer.last_cost_changed_input(),
            NetworkChangeNotifier::ConnectionCost::CONNECTION_COST_METERED);

  fake_network_cost_manager_environment_.SetCost(
      NetworkChangeNotifier::ConnectionCost::CONNECTION_COST_UNKNOWN);

  // The simulated event changes the cost from metered to unknown.
  cost_change_observer.WaitForConnectionCostChanged();

  ASSERT_EQ(cost_change_observer.cost_changed_calls(), 3u);
  EXPECT_EQ(cost_change_observer.last_cost_changed_input(),
            NetworkChangeNotifier::ConnectionCost::CONNECTION_COST_UNKNOWN);
}

TEST_F(NetworkCostChangeNotifierWinTest, DuplicateEvents) {
  fake_network_cost_manager_environment_.SetCost(
      NetworkChangeNotifier::ConnectionCost::CONNECTION_COST_UNMETERED);

  TestConnectionCostObserver cost_change_observer;
  auto cost_change_callback =
      base::BindRepeating(&TestConnectionCostObserver::OnConnectionCostChanged,
                          base::Unretained(&cost_change_observer));

  base::SequenceBound<NetworkCostChangeNotifierWin> cost_change_notifier =
      NetworkCostChangeNotifierWin::CreateInstance(cost_change_callback);

  // Initializing changes the cost from unknown to unmetered.
  cost_change_observer.WaitForConnectionCostChanged();
  ASSERT_EQ(cost_change_observer.cost_changed_calls(), 1u);

  fake_network_cost_manager_environment_.SetCost(
      NetworkChangeNotifier::ConnectionCost::CONNECTION_COST_UNMETERED);

  cost_change_observer.WaitForConnectionCostChanged();

  // Changing from unmetered to unmetered must dispatch a cost changed event.
  ASSERT_EQ(cost_change_observer.cost_changed_calls(), 2u);
  EXPECT_EQ(cost_change_observer.last_cost_changed_input(),
            NetworkChangeNotifier::ConnectionCost::CONNECTION_COST_UNMETERED);
}

TEST_F(NetworkCostChangeNotifierWinTest, ShutdownImmediately) {
  TestConnectionCostObserver cost_change_observer;
  auto cost_change_callback =
      base::BindRepeating(&TestConnectionCostObserver::OnConnectionCostChanged,
                          base::Unretained(&cost_change_observer));

  base::SequenceBound<NetworkCostChangeNotifierWin> cost_change_notifier =
      NetworkCostChangeNotifierWin::CreateInstance(cost_change_callback);

  // Shutting down immediately must not crash.
  cost_change_notifier.Reset();

  // Wait for `NetworkCostChangeNotifierWin` to finish initializing and shutting
  // down.
  RunUntilIdle();

  // `NetworkCostChangeNotifierWin` reports a connection change after
  // initializing.
  EXPECT_EQ(cost_change_observer.cost_changed_calls(), 1u);

  fake_network_cost_manager_environment_.SetCost(
      NetworkChangeNotifier::ConnectionCost::CONNECTION_COST_METERED);

  // Wait for `NetworkCostChangeNotifierWin` to handle the cost changed event.
  RunUntilIdle();

  // After shutdown, cost changed events must have no effect.
  EXPECT_EQ(cost_change_observer.cost_changed_calls(), 1u);
}

TEST_F(NetworkCostChangeNotifierWinTest, ErrorHandling) {
  // Simulate the failure of each OS API while initializing
  // `NetworkCostChangeNotifierWin`.
  constexpr const NetworkCostManagerStatus kErrorList[] = {
      NetworkCostManagerStatus::kErrorCoCreateInstanceFailed,
      NetworkCostManagerStatus::kErrorQueryInterfaceFailed,
      NetworkCostManagerStatus::kErrorFindConnectionPointFailed,
      NetworkCostManagerStatus::kErrorAdviseFailed,
      NetworkCostManagerStatus::kErrorGetCostFailed,
  };
  for (auto error : kErrorList) {
    fake_network_cost_manager_environment_.SetCost(
        NetworkChangeNotifier::ConnectionCost::CONNECTION_COST_UNMETERED);

    fake_network_cost_manager_environment_.SimulateError(error);

    TestConnectionCostObserver cost_change_observer;
    auto cost_change_callback = base::BindRepeating(
        &TestConnectionCostObserver::OnConnectionCostChanged,
        base::Unretained(&cost_change_observer));

    base::SequenceBound<NetworkCostChangeNotifierWin> cost_change_notifier =
        NetworkCostChangeNotifierWin::CreateInstance(cost_change_callback);

    if (error == NetworkCostManagerStatus::kErrorGetCostFailed) {
      // `NetworkCostChangeNotifierWin` must report an unknown cost after
      // `INetworkCostManager::GetCost()` fails.
      cost_change_observer.WaitForConnectionCostChanged();

      EXPECT_EQ(cost_change_observer.cost_changed_calls(), 1u);
      EXPECT_EQ(cost_change_observer.last_cost_changed_input(),
                NetworkChangeNotifier::ConnectionCost::CONNECTION_COST_UNKNOWN);
    } else {
      // Wait for `NetworkCostChangeNotifierWin` to finish initializing.
      RunUntilIdle();

      // `NetworkCostChangeNotifierWin` must NOT report a changed cost after
      // failing to initialize.
      EXPECT_EQ(cost_change_observer.cost_changed_calls(), 0u);
    }
  }
}

TEST_F(NetworkCostChangeNotifierWinTest, UnsupportedOS) {
  base::test::ScopedOSInfoOverride os_override(
      base::test::ScopedOSInfoOverride::Type::kWin81Pro);

  fake_network_cost_manager_environment_.SetCost(
      NetworkChangeNotifier::ConnectionCost::CONNECTION_COST_UNMETERED);

  TestConnectionCostObserver cost_change_observer;
  auto cost_change_callback =
      base::BindRepeating(&TestConnectionCostObserver::OnConnectionCostChanged,
                          base::Unretained(&cost_change_observer));

  base::SequenceBound<NetworkCostChangeNotifierWin> cost_change_notifier =
      NetworkCostChangeNotifierWin::CreateInstance(cost_change_callback);

  // Wait for `NetworkCostChangeNotifierWin` to finish initializing.
  RunUntilIdle();

  // `NetworkCostChangeNotifierWin` must NOT report a changed cost for
  // unsupported OSes.
  EXPECT_EQ(cost_change_observer.cost_changed_calls(), 0u);
}

}  // namespace net