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
// Copyright 2014 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
import 'package:fuchsia_remote_debug_protocol/fuchsia_remote_debug_protocol.dart';
import 'package:test/fake.dart';
import 'package:vm_service/vm_service.dart' as vms;
import 'common.dart';
void main() {
group('FuchsiaRemoteConnection.connect', () {
late List<FakePortForwarder> forwardedPorts;
List<FakeVmService> fakeVmServices;
late List<Uri> uriConnections;
setUp(() {
final List<Map<String, dynamic>> flutterViewCannedResponses =
<Map<String, dynamic>>[
<String, dynamic>{
'views': <Map<String, dynamic>>[
<String, dynamic>{
'type': 'FlutterView',
'id': 'flutterView0',
},
],
},
<String, dynamic>{
'views': <Map<String, dynamic>>[
<String, dynamic>{
'type': 'FlutterView',
'id': 'flutterView1',
'isolate': <String, dynamic>{
'type': '@Isolate',
'fixedId': 'true',
'id': 'isolates/1',
'name': 'file://flutterBinary1',
'number': '1',
},
},
],
},
<String, dynamic>{
'views': <Map<String, dynamic>>[
<String, dynamic>{
'type': 'FlutterView',
'id': 'flutterView2',
'isolate': <String, dynamic>{
'type': '@Isolate',
'fixedId': 'true',
'id': 'isolates/2',
'name': 'file://flutterBinary2',
'number': '2',
},
},
],
},
];
forwardedPorts = <FakePortForwarder>[];
fakeVmServices = <FakeVmService>[];
uriConnections = <Uri>[];
Future<vms.VmService> fakeVmConnectionFunction(
Uri uri, {
Duration? timeout,
}) {
return Future<vms.VmService>(() async {
final FakeVmService service = FakeVmService();
fakeVmServices.add(service);
uriConnections.add(uri);
service.flutterListViews = vms.Response.parse(flutterViewCannedResponses[uri.port]);
return service;
});
}
fuchsiaVmServiceConnectionFunction = fakeVmConnectionFunction;
});
tearDown(() {
/// Most tests will fake out the port forwarding and connection
/// functions.
restoreFuchsiaPortForwardingFunction();
restoreVmServiceConnectionFunction();
});
test('end-to-end with three vm connections and flutter view query', () async {
int port = 0;
Future<PortForwarder> fakePortForwardingFunction(
String address,
int remotePort, [
String? interface = '',
String? configFile,
]) {
return Future<PortForwarder>(() {
final FakePortForwarder pf = FakePortForwarder();
forwardedPorts.add(pf);
pf.port = port++;
pf.remotePort = remotePort;
return pf;
});
}
fuchsiaPortForwardingFunction = fakePortForwardingFunction;
final FakeSshCommandRunner fakeRunner = FakeSshCommandRunner();
// Adds some extra junk to make sure the strings will be cleaned up.
fakeRunner.findResponse = <String>['/hub/blah/blah/blah/vmservice-port\n'];
fakeRunner.lsResponse = <String>['123\n\n\n', '456 ', '789'];
fakeRunner.address = 'fe80::8eae:4cff:fef4:9247';
fakeRunner.interface = 'eno1';
final FuchsiaRemoteConnection connection =
await FuchsiaRemoteConnection.connectWithSshCommandRunner(fakeRunner);
// [fakePortForwardingFunction] will have returned three different
// forwarded ports, incrementing the port each time by one. (Just a sanity
// check that the forwarding port was called).
expect(forwardedPorts.length, 3);
expect(forwardedPorts[0].remotePort, 123);
expect(forwardedPorts[1].remotePort, 456);
expect(forwardedPorts[2].remotePort, 789);
expect(forwardedPorts[0].port, 0);
expect(forwardedPorts[1].port, 1);
expect(forwardedPorts[2].port, 2);
// VMs should be accessed via localhost ports given by
// [fakePortForwardingFunction].
expect(uriConnections[0],
Uri(scheme:'ws', host:'[::1]', port:0, path:'/ws'));
expect(uriConnections[1],
Uri(scheme:'ws', host:'[::1]', port:1, path:'/ws'));
expect(uriConnections[2],
Uri(scheme:'ws', host:'[::1]', port:2, path:'/ws'));
final List<FlutterView> views = await connection.getFlutterViews();
expect(views, isNot(null));
expect(views.length, 3);
// Since name can be null, check for the ID on all of them.
expect(views[0].id, 'flutterView0');
expect(views[1].id, 'flutterView1');
expect(views[2].id, 'flutterView2');
expect(views[0].name, equals(null));
expect(views[1].name, 'file://flutterBinary1');
expect(views[2].name, 'file://flutterBinary2');
// Ensure the ports are all closed after stop was called.
await connection.stop();
expect(forwardedPorts[0].stopped, true);
expect(forwardedPorts[1].stopped, true);
expect(forwardedPorts[2].stopped, true);
});
test('end-to-end with three vms and remote open port', () async {
int port = 0;
Future<PortForwarder> fakePortForwardingFunction(
String address,
int remotePort, [
String? interface = '',
String? configFile,
]) {
return Future<PortForwarder>(() {
final FakePortForwarder pf = FakePortForwarder();
forwardedPorts.add(pf);
pf.port = port++;
pf.remotePort = remotePort;
pf.openPortAddress = 'fe80::1:2%eno2';
return pf;
});
}
fuchsiaPortForwardingFunction = fakePortForwardingFunction;
final FakeSshCommandRunner fakeRunner = FakeSshCommandRunner();
// Adds some extra junk to make sure the strings will be cleaned up.
fakeRunner.findResponse = <String>['/hub/blah/blah/blah/vmservice-port\n'];
fakeRunner.lsResponse = <String>['123\n\n\n', '456 ', '789'];
fakeRunner.address = 'fe80::8eae:4cff:fef4:9247';
fakeRunner.interface = 'eno1';
final FuchsiaRemoteConnection connection =
await FuchsiaRemoteConnection.connectWithSshCommandRunner(fakeRunner);
// [fakePortForwardingFunction] will have returned three different
// forwarded ports, incrementing the port each time by one. (Just a sanity
// check that the forwarding port was called).
expect(forwardedPorts.length, 3);
expect(forwardedPorts[0].remotePort, 123);
expect(forwardedPorts[1].remotePort, 456);
expect(forwardedPorts[2].remotePort, 789);
expect(forwardedPorts[0].port, 0);
expect(forwardedPorts[1].port, 1);
expect(forwardedPorts[2].port, 2);
// VMs should be accessed via the alternate address given by
// [fakePortForwardingFunction].
expect(uriConnections[0],
Uri(scheme:'ws', host:'[fe80::1:2%25eno2]', port:0, path:'/ws'));
expect(uriConnections[1],
Uri(scheme:'ws', host:'[fe80::1:2%25eno2]', port:1, path:'/ws'));
expect(uriConnections[2],
Uri(scheme:'ws', host:'[fe80::1:2%25eno2]', port:2, path:'/ws'));
final List<FlutterView> views = await connection.getFlutterViews();
expect(views, isNot(null));
expect(views.length, 3);
// Since name can be null, check for the ID on all of them.
expect(views[0].id, 'flutterView0');
expect(views[1].id, 'flutterView1');
expect(views[2].id, 'flutterView2');
expect(views[0].name, equals(null));
expect(views[1].name, 'file://flutterBinary1');
expect(views[2].name, 'file://flutterBinary2');
// Ensure the ports are all closed after stop was called.
await connection.stop();
expect(forwardedPorts[0].stopped, true);
expect(forwardedPorts[1].stopped, true);
expect(forwardedPorts[2].stopped, true);
});
test('end-to-end with three vms and ipv4', () async {
int port = 0;
Future<PortForwarder> fakePortForwardingFunction(
String address,
int remotePort, [
String? interface = '',
String? configFile,
]) {
return Future<PortForwarder>(() {
final FakePortForwarder pf = FakePortForwarder();
forwardedPorts.add(pf);
pf.port = port++;
pf.remotePort = remotePort;
return pf;
});
}
fuchsiaPortForwardingFunction = fakePortForwardingFunction;
final FakeSshCommandRunner fakeRunner = FakeSshCommandRunner();
// Adds some extra junk to make sure the strings will be cleaned up.
fakeRunner.findResponse = <String>['/hub/blah/blah/blah/vmservice-port\n'];
fakeRunner.lsResponse = <String>['123\n\n\n', '456 ', '789'];
fakeRunner.address = '196.168.1.4';
final FuchsiaRemoteConnection connection =
await FuchsiaRemoteConnection.connectWithSshCommandRunner(fakeRunner);
// [fakePortForwardingFunction] will have returned three different
// forwarded ports, incrementing the port each time by one. (Just a sanity
// check that the forwarding port was called).
expect(forwardedPorts.length, 3);
expect(forwardedPorts[0].remotePort, 123);
expect(forwardedPorts[1].remotePort, 456);
expect(forwardedPorts[2].remotePort, 789);
expect(forwardedPorts[0].port, 0);
expect(forwardedPorts[1].port, 1);
expect(forwardedPorts[2].port, 2);
// VMs should be accessed via the ipv4 loopback.
expect(uriConnections[0],
Uri(scheme:'ws', host:'127.0.0.1', port:0, path:'/ws'));
expect(uriConnections[1],
Uri(scheme:'ws', host:'127.0.0.1', port:1, path:'/ws'));
expect(uriConnections[2],
Uri(scheme:'ws', host:'127.0.0.1', port:2, path:'/ws'));
final List<FlutterView> views = await connection.getFlutterViews();
expect(views, isNot(null));
expect(views.length, 3);
// Since name can be null, check for the ID on all of them.
expect(views[0].id, 'flutterView0');
expect(views[1].id, 'flutterView1');
expect(views[2].id, 'flutterView2');
expect(views[0].name, equals(null));
expect(views[1].name, 'file://flutterBinary1');
expect(views[2].name, 'file://flutterBinary2');
// Ensure the ports are all closed after stop was called.
await connection.stop();
expect(forwardedPorts[0].stopped, true);
expect(forwardedPorts[1].stopped, true);
expect(forwardedPorts[2].stopped, true);
});
test('env variable test without remote addr', () async {
Future<void> failingFunction() async {
await FuchsiaRemoteConnection.connect();
}
// Should fail as no env variable has been passed.
expect(failingFunction,
throwsA(isA<FuchsiaRemoteConnectionError>()));
});
});
}
class FakeSshCommandRunner extends Fake implements SshCommandRunner {
List<String>? findResponse;
List<String>? lsResponse;
@override
Future<List<String>> run(String command) async {
if (command.startsWith('/bin/find')) {
return findResponse!;
}
if (command.startsWith('/bin/ls')) {
return lsResponse!;
}
throw UnimplementedError(command);
}
@override
String interface = '';
@override
String address = '';
@override
String get sshConfigPath => '~/.ssh';
}
class FakePortForwarder extends Fake implements PortForwarder {
@override
int port = 0;
@override
int remotePort = 0;
@override
String? openPortAddress;
bool stopped = false;
@override
Future<void> stop() async {
stopped = true;
}
}
class FakeVmService extends Fake implements vms.VmService {
bool disposed = false;
vms.Response? flutterListViews;
@override
Future<void> dispose() async {
disposed = true;
}
@override
Future<vms.Response> callMethod(String method, {String? isolateId, Map<String, dynamic>? args}) async {
if (method == '_flutter.listViews') {
return flutterListViews!;
}
throw UnimplementedError(method);
}
@override
Future<void> onDone = Future<void>.value();
@override
Future<vms.Version> getVersion() async {
return vms.Version(major: -1, minor: -1);
}
}