File: fake_nearby_connections.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 (235 lines) | stat: -rw-r--r-- 10,434 bytes parent folder | download | duplicates (6)
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
// Copyright 2024 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_DATA_MIGRATION_TESTING_FAKE_NEARBY_CONNECTIONS_H_
#define CHROMEOS_ASH_COMPONENTS_DATA_MIGRATION_TESTING_FAKE_NEARBY_CONNECTIONS_H_

#include <cstdint>
#include <string>
#include <string_view>
#include <vector>

#include "base/component_export.h"
#include "chromeos/ash/services/nearby/public/mojom/nearby_connections.mojom.h"
#include "chromeos/ash/services/nearby/public/mojom/nearby_connections_types.mojom.h"
#include "mojo/public/cpp/bindings/remote.h"

namespace data_migration {

// Purpose-built for data migration. Acts as the remote device (the one
// transferring data to the ChromeOS device) in tests.
class COMPONENT_EXPORT(CHROMEOS_ASH_COMPONENTS_DATA_MIGRATION)
    FakeNearbyConnections
    : public ::nearby::connections::mojom::NearbyConnections {
 public:
  using PayloadStatus = ::nearby::connections::mojom::PayloadStatus;
  using Status = ::nearby::connections::mojom::Status;

  // `remote_endpoint_id` is the id of the simulated remote device from whom
  // data will be transferred.
  explicit FakeNearbyConnections(std::string_view remote_endpoint_id);
  FakeNearbyConnections(const FakeNearbyConnections&) = delete;
  FakeNearbyConnections& operator=(const FakeNearbyConnections&) = delete;
  ~FakeNearbyConnections() override;

  // Simulates a file being sent from the remote device (played by
  // `FakeNearbyConnections`) to the local device. The contents of the file
  // are randomly generated. All transferred file bytes are returned to the
  // caller via `transferred_bytes` if it's non-null.
  //
  // Returns true if file transmission was successfully simulated, false if any
  // error prevents the simulation.
  bool SendFile(int64_t payload_id,
                std::vector<uint8_t>* transferred_bytes = nullptr);

  // Sets the final payload status for all future `SendFile()` calls with
  // matching `payload_id`. Can be used to simulate file transfer failures.
  //
  // All file payloads with id not matching `payload_id` will return `kSuccess`.
  void SetFinalFilePayloadStatus(PayloadStatus status, int64_t payload_id);

  // The `register_payload_file_result_generator` is invoked for each call to
  // `RegisterPayloadFile()` and returns the `Status` of the operation.
  // By default, the generator is null and `RegisterPayloadFile()` succeeds.
  void set_register_payload_file_result_generator(
      base::RepeatingCallback<Status()>
          register_payload_file_result_generator) {
    register_payload_file_result_generator_ =
        std::move(register_payload_file_result_generator);
  }

  // Invoked every time a payload is sent from the local device to the remote
  // device.
  void set_local_to_remote_payload_listener(
      base::RepeatingCallback<void(::nearby::connections::mojom::PayloadPtr)>
          local_to_remote_payload_listener) {
    local_to_remote_payload_listener_ =
        std::move(local_to_remote_payload_listener);
  }

  // Invoked when both sides of the connection have been accepted, and payloads
  // can be exchanged.
  void set_connection_established_listener(
      base::RepeatingClosure connection_established_listener) {
    connection_established_listener_ =
        std::move(connection_established_listener);
  }

  // Size of all test files transmitted via `SendFile()`. Defaults to 1000.
  void set_test_file_size_in_bytes(size_t test_file_size_in_bytes) {
    test_file_size_in_bytes_ = test_file_size_in_bytes;
  }
  int test_file_size_in_bytes() const { return test_file_size_in_bytes_; }

  // Number of chunks into which files transmitted via `SendFile()` are divided.
  // Each chunk has the same size:
  // `test_file_size_in_bytes_` / `test_file_num_chunks_`.
  //
  // Defaults to 4.
  void set_test_file_num_chunks(size_t test_file_num_chunks) {
    test_file_num_chunks_ = test_file_num_chunks;
  }

  // Simulates a bytes payload being sent from the remote device to the local
  // device.
  //
  // Returns true if file transmission was successfully simulated, false if any
  // error prevents the simulation.
  [[nodiscard]] bool SendBytesPayload(int64_t payload_id,
                                      const std::string& bytes);

  // Simulates remote device disconnecting from the local device. Returns true
  // if simulation was successful; false if the remote device is not connected
  // to begin with.
  [[nodiscard]] bool SimulateRemoteDisconnect();

 private:
  // See `RegisterPayloadFile()` method.
  struct RegisteredFilePayload {
    RegisteredFilePayload();
    RegisteredFilePayload(base::File input_file_in, base::File output_file_in);
    RegisteredFilePayload(RegisteredFilePayload&&);
    RegisteredFilePayload& operator=(RegisteredFilePayload&&);
    ~RegisteredFilePayload();

    base::File input_file;
    base::File output_file;
  };

  // ::nearby::connections::mojom::NearbyConnections:
  void StartAdvertising(
      const std::string& service_id,
      const std::vector<uint8_t>& endpoint_info,
      ::nearby::connections::mojom::AdvertisingOptionsPtr options,
      mojo::PendingRemote<
          ::nearby::connections::mojom::ConnectionLifecycleListener> listener,
      StartAdvertisingCallback callback) override;
  void StopAdvertising(const std::string& service_id,
                       StopAdvertisingCallback callback) override;
  void StartDiscovery(
      const std::string& service_id,
      ::nearby::connections::mojom::DiscoveryOptionsPtr options,
      mojo::PendingRemote<
          ::nearby::connections::mojom::EndpointDiscoveryListener> listener,
      StartDiscoveryCallback callback) override;
  void StopDiscovery(const std::string& service_id,
                     StopDiscoveryCallback callback) override;
  void InjectBluetoothEndpoint(
      const std::string& service_id,
      const std::string& endpoint_id,
      const std::vector<uint8_t>& endpoint_info,
      const std::vector<uint8_t>& remote_bluetooth_mac_address,
      InjectBluetoothEndpointCallback callback) override;
  void RequestConnection(
      const std::string& service_id,
      const std::vector<uint8_t>& endpoint_info,
      const std::string& endpoint_id,
      ::nearby::connections::mojom::ConnectionOptionsPtr options,
      mojo::PendingRemote<
          ::nearby::connections::mojom::ConnectionLifecycleListener> listener,
      RequestConnectionCallback callback) override;
  void DisconnectFromEndpoint(const std::string& service_id,
                              const std::string& endpoint_id,
                              DisconnectFromEndpointCallback callback) override;
  void AcceptConnection(
      const std::string& service_id,
      const std::string& endpoint_id,
      mojo::PendingRemote<::nearby::connections::mojom::PayloadListener>
          listener,
      AcceptConnectionCallback callback) override;
  void RejectConnection(const std::string& service_id,
                        const std::string& endpoint_id,
                        RejectConnectionCallback callback) override;
  void SendPayload(const std::string& service_id,
                   const std::vector<std::string>& endpoint_ids,
                   ::nearby::connections::mojom::PayloadPtr payload,
                   SendPayloadCallback callback) override;
  void CancelPayload(const std::string& service_id,
                     int64_t payload_id,
                     CancelPayloadCallback callback) override;
  void StopAllEndpoints(const std::string& service_id,
                        StopAllEndpointsCallback callback) override;
  void InitiateBandwidthUpgrade(
      const std::string& service_id,
      const std::string& endpoint_id,
      InitiateBandwidthUpgradeCallback callback) override;
  void RegisterPayloadFile(const std::string& service_id,
                           int64_t payload_id,
                           base::File input_file,
                           base::File output_file,
                           RegisterPayloadFileCallback callback) override;
  void RequestConnectionV3(
      const std::string& service_id,
      ash::nearby::presence::mojom::PresenceDevicePtr remote_device,
      ::nearby::connections::mojom::ConnectionOptionsPtr connection_options,
      mojo::PendingRemote<::nearby::connections::mojom::ConnectionListenerV3>
          listener,
      RequestConnectionV3Callback callback) override;
  void AcceptConnectionV3(
      const std::string& service_id,
      ash::nearby::presence::mojom::PresenceDevicePtr remote_device,
      mojo::PendingRemote<::nearby::connections::mojom::PayloadListenerV3>
          listener,
      AcceptConnectionV3Callback callback) override;
  void RejectConnectionV3(
      const std::string& service_id,
      ash::nearby::presence::mojom::PresenceDevicePtr remote_device,
      RejectConnectionV3Callback callback) override;
  void DisconnectFromDeviceV3(
      const std::string& service_id,
      ash::nearby::presence::mojom::PresenceDevicePtr remote_device,
      DisconnectFromDeviceV3Callback callback) override;
  void RegisterServiceWithPresenceDeviceProvider(
      const std::string& service_id) override;

  const std::string remote_endpoint_id_;
  bool is_advertising_ = false;

  // Conceptually, both the `connection_listener_` and the
  // `remote_to_local_payload_listener_` are the target ChromeOS device that is
  // receiving data.
  //
  // Set during the discovery/advertising process.
  mojo::Remote<::nearby::connections::mojom::ConnectionLifecycleListener>
      connection_listener_;
  // Set during the payload transfer process (after connection is established).
  mojo::Remote<::nearby::connections::mojom::PayloadListener>
      remote_to_local_payload_listener_;

  base::flat_map</*payload_id*/ int64_t, RegisteredFilePayload>
      registered_files_;
  base::flat_map</*payload_id*/ int64_t, PayloadStatus>
      final_file_payload_status_;
  base::RepeatingCallback<Status()> register_payload_file_result_generator_;
  base::RepeatingCallback<void(::nearby::connections::mojom::PayloadPtr)>
      local_to_remote_payload_listener_;
  base::RepeatingClosure connection_established_listener_;

  size_t test_file_size_in_bytes_ = 1000;
  size_t test_file_num_chunks_ = 4;
};

}  // namespace data_migration

#endif  // CHROMEOS_ASH_COMPONENTS_DATA_MIGRATION_TESTING_FAKE_NEARBY_CONNECTIONS_H_