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
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
content / browser / media / audio_loopback_stream_broker_unittest.cc [blame]
// Copyright 2018 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "content/browser/media/audio_loopback_stream_broker.h"
#include <memory>
#include <utility>
#include "base/memory/raw_ptr.h"
#include "base/sync_socket.h"
#include "base/test/mock_callback.h"
#include "content/public/test/browser_task_environment.h"
#include "media/mojo/mojom/audio_input_stream.mojom.h"
#include "mojo/public/cpp/bindings/pending_associated_receiver.h"
#include "mojo/public/cpp/bindings/pending_receiver.h"
#include "mojo/public/cpp/bindings/pending_remote.h"
#include "mojo/public/cpp/bindings/receiver.h"
#include "mojo/public/cpp/bindings/remote.h"
#include "mojo/public/cpp/system/platform_handle.h"
#include "services/audio/public/cpp/fake_stream_factory.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "third_party/abseil-cpp/absl/utility/utility.h"
using ::testing::_;
using ::testing::Test;
using ::testing::Mock;
using ::testing::NiceMock;
using ::testing::StrictMock;
using ::testing::InSequence;
namespace content {
namespace {
const int kRenderProcessId = 123;
const int kRenderFrameId = 234;
const uint32_t kShMemCount = 10;
media::AudioParameters TestParams() {
return media::AudioParameters::UnavailableDeviceParams();
}
class MockSource : public AudioStreamBroker::LoopbackSource {
public:
MockSource() : group_id_(base::UnguessableToken::Create()) {}
MockSource(const MockSource&) = delete;
MockSource& operator=(const MockSource&) = delete;
~MockSource() override {}
// AudioStreamBrokerFactory::LoopbackSource mocking.
const base::UnguessableToken& GetGroupID() override { return group_id_; }
MOCK_METHOD1(AddLoopbackSink, void(AudioStreamBroker::LoopbackSink*));
MOCK_METHOD1(RemoveLoopbackSink, void(AudioStreamBroker::LoopbackSink*));
private:
base::UnguessableToken group_id_;
};
using MockDeleterCallback = StrictMock<
base::MockCallback<base::OnceCallback<void(AudioStreamBroker*)>>>;
class MockRendererAudioInputStreamFactoryClient
: public blink::mojom::RendererAudioInputStreamFactoryClient {
public:
MockRendererAudioInputStreamFactoryClient() = default;
~MockRendererAudioInputStreamFactoryClient() override {}
mojo::PendingRemote<blink::mojom::RendererAudioInputStreamFactoryClient>
MakeRemote() {
return receiver_.BindNewPipeAndPassRemote();
}
MOCK_METHOD0(OnStreamCreated, void());
void StreamCreated(
mojo::PendingRemote<media::mojom::AudioInputStream> input_stream,
mojo::PendingReceiver<media::mojom::AudioInputStreamClient>
client_receiver,
media::mojom::ReadOnlyAudioDataPipePtr data_pipe,
bool initially_muted,
const std::optional<base::UnguessableToken>& stream_id) override {
// Loopback streams have no stream ids.
EXPECT_FALSE(stream_id.has_value());
input_stream_.Bind(std::move(input_stream));
client_receiver_ = std::move(client_receiver);
OnStreamCreated();
}
void CloseReceiver() { receiver_.reset(); }
private:
mojo::Receiver<blink::mojom::RendererAudioInputStreamFactoryClient> receiver_{
this};
mojo::Remote<media::mojom::AudioInputStream> input_stream_;
mojo::PendingReceiver<media::mojom::AudioInputStreamClient> client_receiver_;
};
class MockStreamFactory final : public audio::FakeStreamFactory {
public:
MockStreamFactory() = default;
MockStreamFactory(const MockStreamFactory&) = delete;
MockStreamFactory& operator=(const MockStreamFactory&) = delete;
~MockStreamFactory() override = default;
// State of an expected stream creation. |device_id| and |params| are set
// ahead of time and verified during request. The other fields are filled in
// when the request is received.
struct StreamRequestData {
StreamRequestData(const base::UnguessableToken& group_id,
const media::AudioParameters& params)
: params(params), group_id(group_id) {}
bool requested = false;
mojo::PendingReceiver<media::mojom::AudioInputStream> stream_receiver;
mojo::Remote<media::mojom::AudioInputStreamClient> client;
mojo::Remote<media::mojom::AudioInputStreamObserver> observer;
const media::AudioParameters params;
uint32_t shared_memory_count;
base::UnguessableToken group_id;
mojo::ScopedSharedBufferHandle key_press_count_buffer;
CreateLoopbackStreamCallback created_callback;
mojo::PendingAssociatedReceiver<media::mojom::LocalMuter> muter_receiver;
};
void ExpectStreamCreation(StreamRequestData* ex) {
stream_request_data_ = ex;
}
MOCK_METHOD1(IsMuting, void(const base::UnguessableToken&));
private:
void CreateLoopbackStream(
mojo::PendingReceiver<media::mojom::AudioInputStream> receiver,
mojo::PendingRemote<media::mojom::AudioInputStreamClient> client,
mojo::PendingRemote<media::mojom::AudioInputStreamObserver> observer,
const media::AudioParameters& params,
uint32_t shared_memory_count,
const base::UnguessableToken& group_id,
CreateLoopbackStreamCallback created_callback) override {
// No way to cleanly exit the test here in case of failure, so use CHECK.
CHECK(stream_request_data_);
EXPECT_EQ(stream_request_data_->group_id, group_id);
EXPECT_TRUE(stream_request_data_->params.Equals(params));
stream_request_data_->requested = true;
stream_request_data_->stream_receiver = std::move(receiver);
stream_request_data_->client.Bind(std::move(client));
stream_request_data_->observer.Bind(std::move(observer));
stream_request_data_->shared_memory_count = shared_memory_count;
stream_request_data_->created_callback = std::move(created_callback);
}
void BindMuter(
mojo::PendingAssociatedReceiver<media::mojom::LocalMuter> receiver,
const base::UnguessableToken& group_id) override {
stream_request_data_->muter_receiver = std::move(receiver);
IsMuting(group_id);
}
raw_ptr<StreamRequestData> stream_request_data_;
};
const bool kMuteSource = true;
struct TestEnvironment {
TestEnvironment(const base::UnguessableToken& group_id, bool mute_source) {
// Muting should not start until CreateStream() is called.
EXPECT_CALL(stream_factory, IsMuting(_)).Times(0);
EXPECT_CALL(source, AddLoopbackSink(_));
broker = std::make_unique<AudioLoopbackStreamBroker>(
kRenderProcessId, kRenderFrameId, &source, TestParams(), kShMemCount,
mute_source, deleter.Get(), renderer_factory_client.MakeRemote());
}
void RunUntilIdle() { task_environment.RunUntilIdle(); }
BrowserTaskEnvironment task_environment;
MockDeleterCallback deleter;
MockSource source;
StrictMock<MockRendererAudioInputStreamFactoryClient> renderer_factory_client;
std::unique_ptr<AudioLoopbackStreamBroker> broker;
MockStreamFactory stream_factory;
mojo::Remote<media::mojom::AudioStreamFactory> factory_ptr{
stream_factory.MakeRemote()};
};
} // namespace
TEST(AudioLoopbackStreamBrokerTest, StoresProcessAndFrameId) {
InSequence seq;
BrowserTaskEnvironment task_environment;
MockDeleterCallback deleter;
StrictMock<MockRendererAudioInputStreamFactoryClient> renderer_factory_client;
MockSource source;
EXPECT_CALL(source, AddLoopbackSink(_));
AudioLoopbackStreamBroker broker(
kRenderProcessId, kRenderFrameId, &source, TestParams(), kShMemCount,
!kMuteSource, deleter.Get(), renderer_factory_client.MakeRemote());
EXPECT_EQ(kRenderProcessId, broker.render_process_id());
EXPECT_EQ(kRenderFrameId, broker.render_frame_id());
EXPECT_CALL(source, RemoveLoopbackSink(&broker));
}
TEST(AudioLoopbackStreamBrokerTest, StreamCreationSuccess_Propagates) {
TestEnvironment env(base::UnguessableToken::Create(), !kMuteSource);
MockStreamFactory::StreamRequestData stream_request_data(
env.source.GetGroupID(), TestParams());
env.stream_factory.ExpectStreamCreation(&stream_request_data);
EXPECT_CALL(env.stream_factory, IsMuting(_)).Times(0);
env.broker->CreateStream(env.factory_ptr.get());
env.RunUntilIdle();
EXPECT_TRUE(stream_request_data.requested);
// Set up test IPC primitives.
const size_t shmem_size = 456;
base::SyncSocket socket1, socket2;
base::SyncSocket::CreatePair(&socket1, &socket2);
std::move(stream_request_data.created_callback)
.Run({std::in_place,
base::ReadOnlySharedMemoryRegion::Create(shmem_size).region,
mojo::PlatformHandle(socket1.Take())});
EXPECT_CALL(env.renderer_factory_client, OnStreamCreated());
env.RunUntilIdle();
Mock::VerifyAndClear(&env.renderer_factory_client);
env.broker.reset();
}
TEST(AudioLoopbackStreamBrokerTest, MutedStreamCreation_Mutes) {
TestEnvironment env(base::UnguessableToken::Create(), kMuteSource);
MockStreamFactory::StreamRequestData stream_request_data(
env.source.GetGroupID(), TestParams());
env.stream_factory.ExpectStreamCreation(&stream_request_data);
EXPECT_CALL(env.stream_factory, IsMuting(env.source.GetGroupID()));
env.broker->CreateStream(env.factory_ptr.get());
env.RunUntilIdle();
EXPECT_TRUE(stream_request_data.requested);
// Set up test IPC primitives.
const size_t shmem_size = 456;
base::SyncSocket socket1, socket2;
base::SyncSocket::CreatePair(&socket1, &socket2);
std::move(stream_request_data.created_callback)
.Run({std::in_place,
base::ReadOnlySharedMemoryRegion::Create(shmem_size).region,
mojo::PlatformHandle(socket1.Take())});
EXPECT_CALL(env.renderer_factory_client, OnStreamCreated());
env.RunUntilIdle();
Mock::VerifyAndClear(&env.renderer_factory_client);
env.broker.reset();
}
TEST(AudioLoopbackStreamBrokerTest, SourceGone_CallsDeleter) {
TestEnvironment env(base::UnguessableToken::Create(), kMuteSource);
MockStreamFactory::StreamRequestData stream_request_data(
env.source.GetGroupID(), TestParams());
env.stream_factory.ExpectStreamCreation(&stream_request_data);
EXPECT_CALL(env.stream_factory, IsMuting(env.source.GetGroupID()));
env.broker->CreateStream(env.factory_ptr.get());
env.RunUntilIdle();
EXPECT_TRUE(stream_request_data.requested);
// Set up test IPC primitives.
const size_t shmem_size = 456;
base::SyncSocket socket1, socket2;
base::SyncSocket::CreatePair(&socket1, &socket2);
std::move(stream_request_data.created_callback)
.Run({std::in_place,
base::ReadOnlySharedMemoryRegion::Create(shmem_size).region,
mojo::PlatformHandle(socket1.Take())});
EXPECT_CALL(env.renderer_factory_client, OnStreamCreated());
env.RunUntilIdle();
Mock::VerifyAndClear(&env.renderer_factory_client);
EXPECT_CALL(env.deleter, Run(env.broker.get()));
// Accessing source is not allowed after OnSourceGone.
EXPECT_CALL(env.source, RemoveLoopbackSink(_)).Times(0);
env.broker->OnSourceGone();
env.RunUntilIdle();
}
TEST(AudioLoopbackStreamBrokerTest, StreamCreationFailure_CallsDeleter) {
TestEnvironment env(base::UnguessableToken::Create(), !kMuteSource);
MockStreamFactory::StreamRequestData stream_request_data(
env.source.GetGroupID(), TestParams());
env.stream_factory.ExpectStreamCreation(&stream_request_data);
EXPECT_CALL(env.stream_factory, IsMuting(_)).Times(0);
env.broker->CreateStream(env.factory_ptr.get());
env.RunUntilIdle();
EXPECT_TRUE(stream_request_data.requested);
EXPECT_CALL(env.deleter, Run(env.broker.release()))
.WillOnce(testing::DeleteArg<0>());
std::move(stream_request_data.created_callback).Run(nullptr);
env.RunUntilIdle();
}
TEST(AudioLoopbackStreamBrokerTest,
RendererFactoryClientDisconnect_CallsDeleter) {
TestEnvironment env(base::UnguessableToken::Create(), !kMuteSource);
MockStreamFactory::StreamRequestData stream_request_data(
env.source.GetGroupID(), TestParams());
env.stream_factory.ExpectStreamCreation(&stream_request_data);
EXPECT_CALL(env.stream_factory, IsMuting(_)).Times(0);
env.broker->CreateStream(env.factory_ptr.get());
env.RunUntilIdle();
EXPECT_TRUE(stream_request_data.requested);
EXPECT_CALL(env.deleter, Run(env.broker.release()))
.WillOnce(testing::DeleteArg<0>());
env.renderer_factory_client.CloseReceiver();
env.RunUntilIdle();
Mock::VerifyAndClear(&env.deleter);
env.stream_factory.ResetReceiver();
env.RunUntilIdle();
}
TEST(AudioLoopbackStreamBrokerTest, ObserverDisconnect_CallsDeleter) {
TestEnvironment env(base::UnguessableToken::Create(), !kMuteSource);
MockStreamFactory::StreamRequestData stream_request_data(
env.source.GetGroupID(), TestParams());
env.stream_factory.ExpectStreamCreation(&stream_request_data);
EXPECT_CALL(env.stream_factory, IsMuting(_)).Times(0);
env.broker->CreateStream(env.factory_ptr.get());
env.RunUntilIdle();
EXPECT_TRUE(stream_request_data.requested);
EXPECT_CALL(env.deleter, Run(env.broker.release()))
.WillOnce(testing::DeleteArg<0>());
stream_request_data.observer.reset();
env.RunUntilIdle();
Mock::VerifyAndClear(&env.deleter);
env.stream_factory.ResetReceiver();
env.RunUntilIdle();
}
TEST(AudioLoopbackStreamBrokerTest,
FactoryDisconnectDuringConstruction_CallsDeleter) {
TestEnvironment env(base::UnguessableToken::Create(), !kMuteSource);
env.broker->CreateStream(env.factory_ptr.get());
env.stream_factory.ResetReceiver();
EXPECT_CALL(env.deleter, Run(env.broker.release()))
.WillOnce(testing::DeleteArg<0>());
env.RunUntilIdle();
}
} // namespace content