File: fake_shill_manager_client.h

package info (click to toggle)
chromium 138.0.7204.183-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,908 kB
  • sloc: cpp: 34,937,088; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (301 lines) | stat: -rw-r--r-- 13,596 bytes parent folder | download | duplicates (7)
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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
// Copyright 2013 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROMEOS_ASH_COMPONENTS_DBUS_SHILL_FAKE_SHILL_MANAGER_CLIENT_H_
#define CHROMEOS_ASH_COMPONENTS_DBUS_SHILL_FAKE_SHILL_MANAGER_CLIENT_H_

#include <map>
#include <memory>
#include <string>
#include <tuple>

#include "base/component_export.h"
#include "base/functional/callback.h"
#include "base/time/time.h"
#include "base/values.h"
#include "chromeos/ash/components/dbus/shill/shill_manager_client.h"

namespace ash {

// A fake implementation of ShillManagerClient. This works in close coordination
// with FakeShillServiceClient. FakeShillDeviceClient, and
// FakeShillProfileClient, and is not intended to be used independently.
class COMPONENT_EXPORT(SHILL_CLIENT) FakeShillManagerClient
    : public ShillManagerClient,
      public ShillManagerClient::TestInterface {
 public:
  FakeShillManagerClient();

  FakeShillManagerClient(const FakeShillManagerClient&) = delete;
  FakeShillManagerClient& operator=(const FakeShillManagerClient&) = delete;

  ~FakeShillManagerClient() override;

  // ShillManagerClient overrides
  void AddPropertyChangedObserver(
      ShillPropertyChangedObserver* observer) override;
  void RemovePropertyChangedObserver(
      ShillPropertyChangedObserver* observer) override;
  void GetProperties(
      chromeos::DBusMethodCallback<base::Value::Dict> callback) override;
  void GetNetworksForGeolocation(
      chromeos::DBusMethodCallback<base::Value::Dict> callback) override;
  void SetProperty(const std::string& name,
                   const base::Value& value,
                   base::OnceClosure callback,
                   ErrorCallback error_callback) override;
  void RequestScan(const std::string& type,
                   base::OnceClosure callback,
                   ErrorCallback error_callback) override;
  void EnableTechnology(const std::string& type,
                        base::OnceClosure callback,
                        ErrorCallback error_callback) override;
  void DisableTechnology(const std::string& type,
                         base::OnceClosure callback,
                         ErrorCallback error_callback) override;
  void ConfigureService(const base::Value::Dict& properties,
                        chromeos::ObjectPathCallback callback,
                        ErrorCallback error_callback) override;
  void ConfigureServiceForProfile(const dbus::ObjectPath& profile_path,
                                  const base::Value::Dict& properties,
                                  chromeos::ObjectPathCallback callback,
                                  ErrorCallback error_callback) override;
  void GetService(const base::Value::Dict& properties,
                  chromeos::ObjectPathCallback callback,
                  ErrorCallback error_callback) override;
  void ScanAndConnectToBestServices(base::OnceClosure callback,
                                    ErrorCallback error_callback) override;
  void SetNetworkThrottlingStatus(const NetworkThrottlingStatus& status,
                                  base::OnceClosure callback,
                                  ErrorCallback error_callback) override;
  void AddPasspointCredentials(const dbus::ObjectPath& profile_path,
                               const base::Value::Dict& properties,
                               base::OnceClosure callback,
                               ErrorCallback error_callback) override;
  void RemovePasspointCredentials(const dbus::ObjectPath& profile_path,
                                  const base::Value::Dict& properties,
                                  base::OnceClosure callback,
                                  ErrorCallback error_callback) override;
  void SetTetheringEnabled(bool enabled,
                           StringCallback callback,
                           ErrorCallback error_callback) override;
  void EnableTethering(const shill::WiFiInterfacePriority& priority,
                       StringCallback callback,
                       ErrorCallback error_callback) override;
  void DisableTethering(StringCallback callback,
                        ErrorCallback error_callback) override;
  void OnDisableTetheringSuccess(const std::string& result);
  void CheckTetheringReadiness(StringCallback callback,
                               ErrorCallback error_callback) override;
  void SetLOHSEnabled(bool enabled,
                      base::OnceClosure callback,
                      ErrorCallback error_callback) override;

  void CreateP2PGroup(
      const CreateP2PGroupParameter& create_group_argument,
      base::OnceCallback<void(base::Value::Dict result)> callback,
      ErrorCallback error_callback) override;

  void ConnectToP2PGroup(
      const ConnectP2PGroupParameter& connect_group_argument,
      base::OnceCallback<void(base::Value::Dict result)> callback,
      ErrorCallback error_callback) override;

  void DestroyP2PGroup(
      const int shill_id,
      base::OnceCallback<void(base::Value::Dict result)> callback,
      ErrorCallback error_callback) override;

  void DisconnectFromP2PGroup(
      const int shill_id,
      base::OnceCallback<void(base::Value::Dict result)> callback,
      ErrorCallback error_callback) override;

  ShillManagerClient::TestInterface* GetTestInterface() override;

  // ShillManagerClient::TestInterface overrides.
  void AddDevice(const std::string& device_path) override;
  void RemoveDevice(const std::string& device_path) override;
  void ClearDevices() override;
  void AddTechnology(const std::string& type, bool enabled) override;
  void RemoveTechnology(const std::string& type) override;
  void SetTechnologyInitializing(const std::string& type,
                                 bool initializing) override;
  void SetTechnologyProhibited(const std::string& type,
                               bool prohibited) override;
  void SetTechnologyEnabled(const std::string& type,
                            base::OnceClosure callback,
                            bool enabled) override;
  void AddGeoNetwork(const std::string& technology,
                     const base::Value::Dict& network) override;
  void AddProfile(const std::string& profile_path) override;
  void ClearProperties() override;
  void SetManagerProperty(const std::string& key,
                          const base::Value& value) override;
  base::Value::Dict GetStubProperties() override;
  void AddManagerService(const std::string& service_path,
                         bool notify_observers) override;
  void RemoveManagerService(const std::string& service_path) override;
  void RestartTethering() override;
  void ClearManagerServices() override;
  void ServiceStateChanged(const std::string& service_path,
                           const std::string& state) override;
  void SortManagerServices(bool notify) override;
  void SetupDefaultEnvironment() override;
  base::TimeDelta GetInteractiveDelay() const override;
  void SetInteractiveDelay(base::TimeDelta delay) override;
  void SetBestServiceToConnect(const std::string& service_path) override;
  const NetworkThrottlingStatus& GetNetworkThrottlingStatus() override;
  bool GetFastTransitionStatus() override;
  void SetSimulateConfigurationResult(
      FakeShillSimulatedResult configuration_result) override;
  void SetSimulateConfigurationError(std::string_view error_name,
                                     std::string_view error_message) override;
  void SetSimulateTetheringEnableResult(
      FakeShillSimulatedResult tethering_enable_result,
      const std::string& result_string) override;
  void SetSimulateCheckTetheringReadinessResult(
      FakeShillSimulatedResult tethering_readiness_result,
      const std::string& readiness_status) override;
  void SetSimulateCreateP2PGroupResult(
      FakeShillSimulatedResult operation_result,
      const std::string& result_code) override;
  void SetSimulateDestroyP2PGroupResult(
      FakeShillSimulatedResult operation_result,
      const std::string& result_code) override;
  void SetSimulateConnectToP2PGroupResult(
      FakeShillSimulatedResult operation_result,
      const std::string& result_code) override;
  void SetSimulateDisconnectFromP2PGroupResult(
      FakeShillSimulatedResult operation_result,
      const std::string& result_code) override;
  base::Value::List GetEnabledServiceList() const override;
  void ClearProfiles() override;
  void SetShouldReturnNullProperties(bool value) override;
  void SetWifiServicesVisibleByDefault(
      bool wifi_services_visible_by_default) override;
  int GetRecentlyDestroyedP2PGroupId() override;
  int GetRecentlyDisconnectedP2PGroupId() override;

  // Constants used for testing.
  static const char kFakeEthernetNetworkGuid[];

 private:
  // Error message for configure service failure.
  struct ConfigurationError {
    std::string name;
    std::string message;
  };

  using ConnectToBestServicesCallbacks =
      std::tuple<base::OnceClosure, ErrorCallback>;

  void SetDefaultProperties();
  void PassNullopt(
      chromeos::DBusMethodCallback<base::Value::Dict> callback) const;
  void PassStubProperties(
      chromeos::DBusMethodCallback<base::Value::Dict> callback) const;
  void PassStubGeoNetworks(
      chromeos::DBusMethodCallback<base::Value::Dict> callback) const;
  void CallNotifyObserversPropertyChanged(const std::string& property);
  void NotifyObserversPropertyChanged(const std::string& property);
  base::Value::List& GetListProperty(const std::string& property);
  bool TechnologyEnabled(const std::string& type) const;
  void ScanCompleted(const std::string& device_path);

  // Parses the command line for Shill stub switches and sets initial states.
  // Uses comma-separated name-value pairs (see SplitStringIntoKeyValuePairs):
  // interactive={delay} - sets delay in seconds for interactive UI
  // {wifi,cellular,etc}={on,off,disabled,none} - sets initial state for type
  void ParseCommandLineSwitch();
  bool ParseOption(const std::string& arg0, const std::string& arg1);
  bool SetInitialNetworkState(std::string type_arg,
                              const std::string& state_arg);
  std::string GetInitialStateForType(const std::string& type, bool* enabled);

  void ContinueConnectToBestServices(
      ConnectToBestServicesCallbacks connect_to_best_services_callbacks);

  // Dictionary of property name -> property value
  base::Value::Dict stub_properties_;

  // Dictionary of technology -> list of property dictionaries
  base::Value::Dict stub_geo_networks_;

  // Delay for interactive actions
  base::TimeDelta interactive_delay_;

  // Initial state for fake services.
  std::map<std::string, std::string> shill_initial_state_map_;

  // URL used for cellular activation.
  std::string cellular_olp_;

  // Technology type for fake cellular service.
  std::string cellular_technology_;

  // Roaming state for fake cellular service.
  std::string roaming_state_;

  // Current network throttling status.
  NetworkThrottlingStatus network_throttling_status_ = {false, 0, 0};

  using ShillPropertyMap = std::map<std::string, base::Value>;
  using DevicePropertyMap = std::map<std::string, ShillPropertyMap>;
  DevicePropertyMap shill_device_property_map_;

  base::ObserverList<ShillPropertyChangedObserver>::Unchecked observer_list_;

  // Track the default service for signaling Manager.DefaultService.
  std::string default_service_;

  // 'Best' service to connect to on ConnectToBestServices() calls.
  std::string best_service_;

  FakeShillSimulatedResult simulate_configuration_result_ =
      FakeShillSimulatedResult::kSuccess;
  ConfigurationError simulate_configuration_error_ = {"Error",
                                                      "Simulated failure"};
  FakeShillSimulatedResult simulate_tethering_enable_result_ =
      FakeShillSimulatedResult::kSuccess;
  std::string simulate_enable_tethering_result_string_;
  FakeShillSimulatedResult simulate_check_tethering_readiness_result_ =
      FakeShillSimulatedResult::kSuccess;
  std::string simulate_tethering_readiness_status_;
  FakeShillSimulatedResult simulate_create_p2p_group_result_ =
      FakeShillSimulatedResult::kSuccess;
  std::string simulate_create_p2p_group_result_code_;
  FakeShillSimulatedResult simulate_destroy_p2p_group_result_ =
      FakeShillSimulatedResult::kSuccess;
  std::string simulate_destroy_p2p_group_result_code_;
  int recent_destroyed_group_id = -1;
  FakeShillSimulatedResult simulate_connect_p2p_group_result_ =
      FakeShillSimulatedResult::kSuccess;
  std::string simulate_connect_p2p_group_result_code_;
  int recent_disconnected_group_id = -1;
  FakeShillSimulatedResult simulate_disconnect_p2p_group_result_ =
      FakeShillSimulatedResult::kSuccess;
  std::string simulate_disconnect_p2p_group_result_code_;

  bool return_null_properties_ = false;
  bool wifi_services_visible_by_default_ = true;

  // For testing multiple wifi networks.
  int extra_wifi_networks_ = 0;

  // For testing dynamic WEP networks (uses wifi2).
  bool dynamic_wep_ = false;

  // Caches the last-passed callbacks for ScanAndConnectToBestServices.
  std::optional<ConnectToBestServicesCallbacks>
      connect_to_best_services_callbacks_;

  // Note: This should remain the last member so it'll be destroyed and
  // invalidate its weak pointers before any other members are destroyed.
  base::WeakPtrFactory<FakeShillManagerClient> weak_ptr_factory_{this};
};

}  // namespace ash

#endif  // CHROMEOS_ASH_COMPONENTS_DBUS_SHILL_FAKE_SHILL_MANAGER_CLIENT_H_