devfs_test.dart 16 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
2 3 4
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

5 6
import 'dart:async';
import 'dart:convert';
7
import 'dart:io'; // ignore: dart_io_import
8

9 10
import 'package:file/file.dart';
import 'package:file/memory.dart';
11
import 'package:flutter_tools/src/base/file_system.dart';
12
import 'package:flutter_tools/src/base/io.dart';
13
import 'package:flutter_tools/src/base/net.dart';
14
import 'package:flutter_tools/src/compile.dart';
15
import 'package:flutter_tools/src/devfs.dart';
16
import 'package:flutter_tools/src/vmservice.dart';
17
import 'package:json_rpc_2/json_rpc_2.dart' as rpc;
18
import 'package:mockito/mockito.dart';
19

20 21 22
import '../src/common.dart';
import '../src/context.dart';
import '../src/mocks.dart';
23 24

void main() {
25
  FileSystem fs;
26 27 28 29 30
  String filePath;
  Directory tempDir;
  String basePath;

  setUpAll(() {
Dan Field's avatar
Dan Field committed
31
    fs = MemoryFileSystem.test();
32
    filePath = fs.path.join('lib', 'foo.txt');
33 34
  });

35 36
  group('DevFSContent', () {
    test('bytes', () {
37
      final DevFSByteContent content = DevFSByteContent(<int>[4, 5, 6]);
38 39 40 41 42 43 44 45 46
      expect(content.bytes, orderedEquals(<int>[4, 5, 6]));
      expect(content.isModified, isTrue);
      expect(content.isModified, isFalse);
      content.bytes = <int>[7, 8, 9, 2];
      expect(content.bytes, orderedEquals(<int>[7, 8, 9, 2]));
      expect(content.isModified, isTrue);
      expect(content.isModified, isFalse);
    });
    test('string', () {
47
      final DevFSStringContent content = DevFSStringContent('some string');
48
      expect(content.string, 'some string');
49
      expect(content.bytes, orderedEquals(utf8.encode('some string')));
50 51 52 53
      expect(content.isModified, isTrue);
      expect(content.isModified, isFalse);
      content.string = 'another string';
      expect(content.string, 'another string');
54
      expect(content.bytes, orderedEquals(utf8.encode('another string')));
55 56
      expect(content.isModified, isTrue);
      expect(content.isModified, isFalse);
57
      content.bytes = utf8.encode('foo bar');
58
      expect(content.string, 'foo bar');
59
      expect(content.bytes, orderedEquals(utf8.encode('foo bar')));
60 61 62
      expect(content.isModified, isTrue);
      expect(content.isModified, isFalse);
    });
63
    testUsingContext('file', () async {
64
      final File file = fs.file(filePath);
65 66 67 68 69
      final DevFSFileContent content = DevFSFileContent(file);
      expect(content.isModified, isFalse);
      expect(content.isModified, isFalse);

      file.parent.createSync(recursive: true);
70
      file.writeAsBytesSync(<int>[1, 2, 3], flush: true);
71

Dan Field's avatar
Dan Field committed
72
      final DateTime fiveSecondsAgo = file.statSync().modified.subtract(const Duration(seconds: 5));
73 74 75 76
      expect(content.isModifiedAfter(fiveSecondsAgo), isTrue);
      expect(content.isModifiedAfter(fiveSecondsAgo), isTrue);
      expect(content.isModifiedAfter(null), isTrue);

77
      file.writeAsBytesSync(<int>[2, 3, 4], flush: true);
78
      expect(content.fileDependencies, <String>[filePath]);
79 80
      expect(content.isModified, isTrue);
      expect(content.isModified, isFalse);
81
      expect(await content.contentsAsBytes(), <int>[2, 3, 4]);
82 83 84 85 86 87 88 89 90 91
      updateFileModificationTime(file.path, fiveSecondsAgo, 0);
      expect(content.isModified, isFalse);
      expect(content.isModified, isFalse);

      file.deleteSync();
      expect(content.isModified, isTrue);
      expect(content.isModified, isFalse);
      expect(content.isModified, isFalse);
    }, overrides: <Type, Generator>{
      FileSystem: () => fs,
92
      ProcessManager: () => FakeProcessManager.any(),
93
    }, skip: Platform.isWindows); // TODO(jonahwilliams): fix or disable this functionality.
94 95
  });

96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
  group('mocked http client', () {
    HttpOverrides savedHttpOverrides;
    HttpClient httpClient;

    setUpAll(() {
      tempDir = _newTempDir(fs);
      basePath = tempDir.path;
      savedHttpOverrides = HttpOverrides.current;
      httpClient = MockOddlyFailingHttpClient();
      HttpOverrides.global = MyHttpOverrides(httpClient);
    });

    tearDownAll(() async {
      HttpOverrides.global = savedHttpOverrides;
    });

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
    final List<dynamic> exceptions = <dynamic>[
      Exception('Connection resert by peer'),
      const OSError('Connection reset by peer'),
    ];

    for (final dynamic exception in exceptions) {
      testUsingContext('retry uploads when failure: $exception', () async {
        final File file = fs.file(fs.path.join(basePath, filePath));
        await file.parent.create(recursive: true);
        file.writeAsBytesSync(<int>[1, 2, 3]);
        // simulate package
        await _createPackage(fs, 'somepkg', 'somefile.txt');

        final RealMockVMService vmService = RealMockVMService();
        final RealMockVM vm = RealMockVM();
        final Map<String, dynamic> response =  <String, dynamic>{ 'uri': 'file://abc' };
        when(vm.createDevFS(any)).thenAnswer((Invocation invocation) {
          return Future<Map<String, dynamic>>.value(response);
        });
        when(vmService.vm).thenReturn(vm);

        reset(httpClient);

        final MockHttpClientRequest httpRequest = MockHttpClientRequest();
        when(httpRequest.headers).thenReturn(MockHttpHeaders());
        when(httpClient.putUrl(any)).thenAnswer((Invocation invocation) {
          return Future<HttpClientRequest>.value(httpRequest);
        });
        final MockHttpClientResponse httpClientResponse = MockHttpClientResponse();
        int nRequest = 0;
        const int kFailedAttempts = 5;
        when(httpRequest.close()).thenAnswer((Invocation invocation) {
          if (nRequest++ < kFailedAttempts) {
            throw exception;
          }
          return Future<HttpClientResponse>.value(httpClientResponse);
        });

        final DevFS devFS = DevFS(vmService, 'test', tempDir);
        await devFS.create();

        final MockResidentCompiler residentCompiler = MockResidentCompiler();
        final UpdateFSReport report = await devFS.update(
          mainPath: 'lib/foo.txt',
          generator: residentCompiler,
          pathToReload: 'lib/foo.txt.dill',
          trackWidgetCreation: false,
          invalidatedFiles: <Uri>[],
        );

        expect(report.syncedBytes, 22);
        expect(report.success, isTrue);
        verify(httpClient.putUrl(any)).called(kFailedAttempts + 1);
        verify(httpRequest.close()).called(kFailedAttempts + 1);
      }, overrides: <Type, Generator>{
        FileSystem: () => fs,
        HttpClientFactory: () => () => httpClient,
        ProcessManager: () => FakeProcessManager.any(),
170
      });
171
    }
172 173
  });

174
  group('devfs remote', () {
175 176
    MockVMService vmService;
    final MockResidentCompiler residentCompiler = MockResidentCompiler();
177
    DevFS devFS;
178 179 180 181 182 183 184

    setUpAll(() async {
      tempDir = _newTempDir(fs);
      basePath = tempDir.path;
      vmService = MockVMService();
      await vmService.setUp();
    });
185

186 187 188 189 190
    setUp(() {
      vmService.resetState();
      devFS = DevFS(vmService, 'test', tempDir);
    });

191 192 193
    tearDownAll(() async {
      await vmService.tearDown();
      _cleanupTempDirs();
194
    });
195 196 197

    testUsingContext('create dev file system', () async {
      // simulate workspace
198
      final File file = fs.file(fs.path.join(basePath, filePath));
199 200 201 202
      await file.parent.create(recursive: true);
      file.writeAsBytesSync(<int>[1, 2, 3]);

      // simulate package
203
      await _createPackage(fs, 'somepkg', 'somefile.txt');
204

205 206
      await devFS.create();
      vmService.expectMessages(<String>['create test']);
207 208
      expect(devFS.assetPathsToEvict, isEmpty);

209
      final UpdateFSReport report = await devFS.update(
210 211 212
        mainPath: 'lib/foo.txt',
        generator: residentCompiler,
        pathToReload: 'lib/foo.txt.dill',
213
        trackWidgetCreation: false,
214
        invalidatedFiles: <Uri>[],
215
      );
216 217 218
      vmService.expectMessages(<String>[
        'writeFile test lib/foo.txt.dill',
      ]);
219
      expect(devFS.assetPathsToEvict, isEmpty);
220 221
      expect(report.syncedBytes, 22);
      expect(report.success, true);
222 223
    }, overrides: <Type, Generator>{
      FileSystem: () => fs,
224
      HttpClient: () => () => HttpClient(),
225
      ProcessManager: () => FakeProcessManager.any(),
Dan Rubel's avatar
Dan Rubel committed
226
    });
227 228

    testUsingContext('delete dev file system', () async {
229
      expect(vmService.messages, isEmpty, reason: 'prior test timeout');
230
      await devFS.destroy();
231
      vmService.expectMessages(<String>['destroy test']);
232 233 234
      expect(devFS.assetPathsToEvict, isEmpty);
    }, overrides: <Type, Generator>{
      FileSystem: () => fs,
235
      ProcessManager: () => FakeProcessManager.any(),
236 237 238 239
    });

    testUsingContext('cleanup preexisting file system', () async {
      // simulate workspace
240
      final File file = fs.file(fs.path.join(basePath, filePath));
241 242 243 244 245 246
      await file.parent.create(recursive: true);
      file.writeAsBytesSync(<int>[1, 2, 3]);

      // simulate package
      await _createPackage(fs, 'somepkg', 'somefile.txt');
      await devFS.create();
247
      vmService.expectMessages(<String>['create test']);
248 249 250 251
      expect(devFS.assetPathsToEvict, isEmpty);

      // Try to create again.
      await devFS.create();
252
      vmService.expectMessages(<String>['create test', 'destroy test', 'create test']);
253 254 255 256
      expect(devFS.assetPathsToEvict, isEmpty);

      // Really destroy.
      await devFS.destroy();
257
      vmService.expectMessages(<String>['destroy test']);
258
      expect(devFS.assetPathsToEvict, isEmpty);
259 260
    }, overrides: <Type, Generator>{
      FileSystem: () => fs,
261
      ProcessManager: () => FakeProcessManager.any(),
262
    });
263 264 265

    testUsingContext('reports unsuccessful compile when errors are returned', () async {
      await devFS.create();
266
      final DateTime previousCompile = devFS.lastCompiled;
267 268 269 270 271 272

      final RealMockResidentCompiler residentCompiler = RealMockResidentCompiler();
      when(residentCompiler.recompile(
        any,
        any,
        outputPath: anyNamed('outputPath'),
273
        packagesFilePath: anyNamed('packagesFilePath'),
274 275 276 277 278 279 280 281 282 283 284 285 286
      )).thenAnswer((Invocation invocation) {
        return Future<CompilerOutput>.value(const CompilerOutput('example', 2, <Uri>[]));
      });

      final UpdateFSReport report = await devFS.update(
        mainPath: 'lib/foo.txt',
        generator: residentCompiler,
        pathToReload: 'lib/foo.txt.dill',
        trackWidgetCreation: false,
        invalidatedFiles: <Uri>[],
      );

      expect(report.success, false);
287 288 289
      expect(devFS.lastCompiled, previousCompile);
    }, overrides: <Type, Generator>{
      FileSystem: () => fs,
290
      ProcessManager: () => FakeProcessManager.any(),
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
    });

    testUsingContext('correctly updates last compiled time when compilation does not fail', () async {
      // simulate package
      final File sourceFile = await _createPackage(fs, 'somepkg', 'main.dart');

      await devFS.create();
      final DateTime previousCompile = devFS.lastCompiled;

      final RealMockResidentCompiler residentCompiler = RealMockResidentCompiler();
      when(residentCompiler.recompile(
        any,
        any,
        outputPath: anyNamed('outputPath'),
        packagesFilePath: anyNamed('packagesFilePath'),
      )).thenAnswer((Invocation invocation) {
307
        fs.file('example').createSync();
308 309 310 311 312 313 314 315 316 317 318 319 320
        return Future<CompilerOutput>.value(CompilerOutput('example', 0, <Uri>[sourceFile.uri]));
      });

      final UpdateFSReport report = await devFS.update(
        mainPath: 'lib/main.dart',
        generator: residentCompiler,
        pathToReload: 'lib/foo.txt.dill',
        trackWidgetCreation: false,
        invalidatedFiles: <Uri>[],
      );

      expect(report.success, true);
      expect(devFS.lastCompiled, isNot(previousCompile));
321 322
    }, overrides: <Type, Generator>{
      FileSystem: () => fs,
323
      HttpClient: () => () => HttpClient(),
324
      ProcessManager: () => FakeProcessManager.any(),
325
    });
326
  });
327 328
}

329 330 331 332
class MockVMService extends BasicMock implements VMService {
  MockVMService() {
    _vm = MockVM(this);
  }
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
  Uri _httpAddress;
  HttpServer _server;
  MockVM _vm;

  @override
  Uri get httpAddress => _httpAddress;

  @override
  VM get vm => _vm;

  Future<void> setUp() async {
    try {
      _server = await HttpServer.bind(InternetAddress.loopbackIPv6, 0);
      _httpAddress = Uri.parse('http://[::1]:${_server.port}');
    } on SocketException {
      // Fall back to IPv4 if the host doesn't support binding to IPv6 localhost
      _server = await HttpServer.bind(InternetAddress.loopbackIPv4, 0);
      _httpAddress = Uri.parse('http://127.0.0.1:${_server.port}');
    }
    _server.listen((HttpRequest request) {
      final String fsName = request.headers.value('dev_fs_name');
      final String devicePath = utf8.decode(base64.decode(request.headers.value('dev_fs_uri_b64')));
      messages.add('writeFile $fsName $devicePath');
      request.drain<List<int>>().then<void>((List<int> value) {
        request.response
          ..write('Got it')
          ..close();
      });
    });
  }
364

365 366 367
  Future<void> tearDown() async {
    await _server?.close();
  }
368

369 370 371 372 373
  void resetState() {
    _vm = MockVM(this);
    messages.clear();
  }

374 375
  @override
  dynamic noSuchMethod(Invocation invocation) => super.noSuchMethod(invocation);
376

377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
}

class MockVM implements VM {
  MockVM(this._service);

  final MockVMService _service;
  final Uri _baseUri = Uri.parse('file:///tmp/devfs/test');
  bool _devFSExists = false;

  static const int kFileSystemAlreadyExists = 1001;

  @override
  Future<Map<String, dynamic>> createDevFS(String fsName) async {
    _service.messages.add('create $fsName');
    if (_devFSExists) {
      throw rpc.RpcException(kFileSystemAlreadyExists, 'File system already exists');
    }
    _devFSExists = true;
    return <String, dynamic>{'uri': '$_baseUri'};
  }

  @override
  Future<Map<String, dynamic>> deleteDevFS(String fsName) async {
    _service.messages.add('destroy $fsName');
    _devFSExists = false;
    return <String, dynamic>{'type': 'Success'};
  }

  @override
  Future<Map<String, dynamic>> invokeRpcRaw(
    String method, {
    Map<String, dynamic> params = const <String, dynamic>{},
    Duration timeout,
    bool timeoutFatal = true,
411
    bool truncateLogs = true,
412 413 414 415 416 417 418 419 420
  }) async {
    _service.messages.add('$method $params');
    return <String, dynamic>{'success': true};
  }

  @override
  dynamic noSuchMethod(Invocation invocation) => super.noSuchMethod(invocation);
}

421
class RealMockResidentCompiler extends Mock implements ResidentCompiler {}
422 423

final List<Directory> _tempDirs = <Directory>[];
424
final Map <String, Uri> _packages = <String, Uri>{};
425

426
Directory _newTempDir(FileSystem fs) {
427
  final Directory tempDir = fs.systemTempDirectory.createTempSync('flutter_devfs${_tempDirs.length}_test.');
428 429 430 431 432
  _tempDirs.add(tempDir);
  return tempDir;
}

void _cleanupTempDirs() {
433
  while (_tempDirs.isNotEmpty) {
434
    tryToDelete(_tempDirs.removeLast());
435
  }
436
}
437

438
Future<File> _createPackage(FileSystem fs, String pkgName, String pkgFileName, { bool doubleSlash = false }) async {
439
  final Directory pkgTempDir = _newTempDir(fs);
440
  String pkgFilePath = fs.path.join(pkgTempDir.path, pkgName, 'lib', pkgFileName);
441 442
  if (doubleSlash) {
    // Force two separators into the path.
443 444
    final String doubleSlash = fs.path.separator + fs.path.separator;
    pkgFilePath = pkgTempDir.path + doubleSlash + fs.path.join(pkgName, 'lib', pkgFileName);
445
  }
446
  final File pkgFile = fs.file(pkgFilePath);
447 448
  await pkgFile.parent.create(recursive: true);
  pkgFile.writeAsBytesSync(<int>[11, 12, 13]);
449
  _packages[pkgName] = fs.path.toUri(pkgFile.parent.path);
450
  final StringBuffer sb = StringBuffer();
451 452
  _packages.forEach((String pkgName, Uri pkgUri) {
    sb.writeln('$pkgName:$pkgUri');
453
  });
454
  return fs.file(fs.path.join(_tempDirs[0].path, '.packages'))
455
    ..writeAsStringSync(sb.toString());
456
}
457

458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
class RealMockVM extends Mock implements VM {

}

class RealMockVMService extends Mock implements VMService {

}

class MyHttpOverrides extends HttpOverrides {
  MyHttpOverrides(this._httpClient);
  @override
  HttpClient createHttpClient(SecurityContext context) {
    return _httpClient;
  }

  final HttpClient _httpClient;
}

class MockOddlyFailingHttpClient extends Mock implements HttpClient {}
class MockHttpClientRequest extends Mock implements HttpClientRequest {}
class MockHttpHeaders extends Mock implements HttpHeaders {}
479
class MockHttpClientResponse extends Mock implements HttpClientResponse {}