// Copyright 2017 The Chromium 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 'dart:async'; import 'dart:convert' show JSON; import 'package:file/memory.dart'; import 'package:flutter_tools/src/base/build.dart'; import 'package:flutter_tools/src/base/context.dart'; import 'package:flutter_tools/src/base/file_system.dart'; import 'package:flutter_tools/src/build_info.dart'; import 'package:test/test.dart'; import '../src/context.dart'; class _FakeGenSnapshot implements GenSnapshot { _FakeGenSnapshot({ this.succeed: true, this.snapshotPath: 'output.snapshot', this.snapshotContent: '', this.depfilePath: 'output.snapshot.d', this.depfileContent: 'output.snapshot.d : main.dart', }); final bool succeed; final String snapshotPath; final String snapshotContent; final String depfilePath; final String depfileContent; int _callCount = 0; int get callCount => _callCount; @override Future run({ TargetPlatform targetPlatform, BuildMode buildMode, String packagesPath, String depfilePath, Iterable additionalArgs, }) async { _callCount += 1; if (!succeed) return 1; await fs.file(snapshotPath).writeAsString(snapshotContent); await fs.file(depfilePath).writeAsString(depfileContent); return 0; } } void main() { group('Checksum', () { group('fromFiles', () { MemoryFileSystem fs; setUp(() { fs = new MemoryFileSystem(); }); testUsingContext('throws if any input file does not exist', () async { await fs.file('a.dart').create(); expect(() => new Checksum.fromFiles(['a.dart', 'b.dart'].toSet()), throwsA(anything)); }, overrides: { FileSystem: () => fs}); testUsingContext('populates checksums for valid files', () async { await fs.file('a.dart').writeAsString('This is a'); await fs.file('b.dart').writeAsString('This is b'); final Checksum checksum = new Checksum.fromFiles(['a.dart', 'b.dart'].toSet()); final String json = checksum.toJson(); expect(json, '{"a.dart":"8a21a15fad560b799f6731d436c1b698","b.dart":"6f144e08b58cd0925328610fad7ac07c"}'); }, overrides: { FileSystem: () => fs}); }); group('fromJson', () { test('throws if JSON is invalid', () async { expect(() => new Checksum.fromJson(''), throwsA(anything)); }); test('populates checksums for valid JSON', () async { final String json = '{"a.dart":"8a21a15fad560b799f6731d436c1b698","b.dart":"6f144e08b58cd0925328610fad7ac07c"}'; final Checksum checksum = new Checksum.fromJson(json); expect(checksum.toJson(), '{"a.dart":"8a21a15fad560b799f6731d436c1b698","b.dart":"6f144e08b58cd0925328610fad7ac07c"}'); }); }); group('operator ==', () { test('reports not equal if checksums do not match', () async { final Checksum a = new Checksum.fromJson('{"a.dart":"8a21a15fad560b799f6731d436c1b698","b.dart":"6f144e08b58cd0925328610fad7ac07c"}'); final Checksum b = new Checksum.fromJson('{"a.dart":"8a21a15fad560b799f6731d436c1b698","b.dart":"6f144e08b58cd0925328610fad7ac07d"}'); expect(a == b, isFalse); }); test('reports not equal if keys do not match', () async { final Checksum a = new Checksum.fromJson('{"a.dart":"8a21a15fad560b799f6731d436c1b698","b.dart":"6f144e08b58cd0925328610fad7ac07c"}'); final Checksum b = new Checksum.fromJson('{"a.dart":"8a21a15fad560b799f6731d436c1b698","c.dart":"6f144e08b58cd0925328610fad7ac07c"}'); expect(a == b, isFalse); }); test('reports equal if all checksums match', () async { final Checksum a = new Checksum.fromJson('{"a.dart":"8a21a15fad560b799f6731d436c1b698","b.dart":"6f144e08b58cd0925328610fad7ac07c"}'); final Checksum b = new Checksum.fromJson('{"a.dart":"8a21a15fad560b799f6731d436c1b698","b.dart":"6f144e08b58cd0925328610fad7ac07c"}'); expect(a == b, isTrue); }); }); }); group('readDepfile', () { MemoryFileSystem fs; setUp(() { fs = new MemoryFileSystem(); }); testUsingContext('returns one file if only one is listed', () async { await fs.file('a.d').writeAsString('snapshot.d: /foo/a.dart'); expect(await readDepfile('a.d'), unorderedEquals(['/foo/a.dart'])); }, overrides: { FileSystem: () => fs }); testUsingContext('returns multiple files', () async { await fs.file('a.d').writeAsString('snapshot.d: /foo/a.dart /foo/b.dart'); expect(await readDepfile('a.d'), unorderedEquals([ '/foo/a.dart', '/foo/b.dart', ])); }, overrides: { FileSystem: () => fs}); testUsingContext('trims extra spaces between files', () async { await fs.file('a.d').writeAsString('snapshot.d: /foo/a.dart /foo/b.dart /foo/c.dart'); expect(await readDepfile('a.d'), unorderedEquals([ '/foo/a.dart', '/foo/b.dart', '/foo/c.dart', ])); }, overrides: { FileSystem: () => fs }); testUsingContext('returns files with spaces and backslashes', () async { await fs.file('a.d').writeAsString(r'snapshot.d: /foo/a\ a.dart /foo/b\\b.dart /foo/c\\ c.dart'); expect(await readDepfile('a.d'), unorderedEquals([ r'/foo/a a.dart', r'/foo/b\b.dart', r'/foo/c\ c.dart', ])); }, overrides: { FileSystem: () => fs }); }); group('Snapshotter', () { _FakeGenSnapshot genSnapshot; MemoryFileSystem fs; Snapshotter snapshotter; setUp(() { fs = new MemoryFileSystem(); genSnapshot = new _FakeGenSnapshot(); snapshotter = new Snapshotter(); }); testUsingContext('builds snapshot and checksums when no checksums are present', () async { await fs.file('main.dart').writeAsString('void main() {}'); await fs.file('output.snapshot').create(); await fs.file('output.snapshot.d').writeAsString('snapshot : main.dart'); await snapshotter.buildScriptSnapshot( mainPath: 'main.dart', snapshotPath: 'output.snapshot', depfilePath: 'output.snapshot.d', packagesPath: '.packages', ); expect(genSnapshot.callCount, 1); final Map json = JSON.decode(await fs.file('output.snapshot.d.checksums').readAsString()); expect(json, hasLength(2)); expect(json['main.dart'], '27f5ebf0f8c559b2af9419d190299a5e'); expect(json['output.snapshot'], 'd41d8cd98f00b204e9800998ecf8427e'); }, overrides: { FileSystem: () => fs, GenSnapshot: () => genSnapshot, }); testUsingContext('builds snapshot and checksums when checksums differ', () async { await fs.file('main.dart').writeAsString('void main() {}'); await fs.file('output.snapshot').create(); await fs.file('output.snapshot.d').writeAsString('output.snapshot : main.dart'); await fs.file('output.snapshot.d.checksums').writeAsString(JSON.encode({ 'main.dart': '27f5ebf0f8c559b2af9419d190299a5e', 'output.snapshot': 'deadbeef01234567890abcdef0123456', })); await snapshotter.buildScriptSnapshot( mainPath: 'main.dart', snapshotPath: 'output.snapshot', depfilePath: 'output.snapshot.d', packagesPath: '.packages', ); expect(genSnapshot.callCount, 1); final Map json = JSON.decode(await fs.file('output.snapshot.d.checksums').readAsString()); expect(json, hasLength(2)); expect(json['main.dart'], '27f5ebf0f8c559b2af9419d190299a5e'); expect(json['output.snapshot'], 'd41d8cd98f00b204e9800998ecf8427e'); }, overrides: { FileSystem: () => fs, GenSnapshot: () => genSnapshot, }); testUsingContext('builds snapshot and checksums when checksums match but previous snapshot not present', () async { await fs.file('main.dart').writeAsString('void main() {}'); await fs.file('output.snapshot.d').writeAsString('output.snapshot : main.dart'); await fs.file('output.snapshot.d.checksums').writeAsString(JSON.encode({ 'main.dart': '27f5ebf0f8c559b2af9419d190299a5e', 'output.snapshot': 'd41d8cd98f00b204e9800998ecf8427e', })); await snapshotter.buildScriptSnapshot( mainPath: 'main.dart', snapshotPath: 'output.snapshot', depfilePath: 'output.snapshot.d', packagesPath: '.packages', ); expect(genSnapshot.callCount, 1); final Map json = JSON.decode(await fs.file('output.snapshot.d.checksums').readAsString()); expect(json, hasLength(2)); expect(json['main.dart'], '27f5ebf0f8c559b2af9419d190299a5e'); expect(json['output.snapshot'], 'd41d8cd98f00b204e9800998ecf8427e'); }, overrides: { FileSystem: () => fs, GenSnapshot: () => genSnapshot, }); testUsingContext('builds snapshot and checksums when main entry point changes', () async { final _FakeGenSnapshot genSnapshot = new _FakeGenSnapshot( snapshotPath: 'output.snapshot', depfilePath: 'output.snapshot.d', depfileContent: 'output.snapshot : other.dart', ); context.setVariable(GenSnapshot, genSnapshot); await fs.file('main.dart').writeAsString('void main() {}'); await fs.file('other.dart').writeAsString('void main() { print("Kanpai ima kimi wa jinsei no ookina ookina butai ni tachi"); }'); await fs.file('output.snapshot.d').writeAsString('output.snapshot : main.dart'); await fs.file('output.snapshot.d.checksums').writeAsString(JSON.encode({ 'main.dart': '27f5ebf0f8c559b2af9419d190299a5e', 'output.snapshot': 'd41d8cd98f00b204e9800998ecf8427e', })); await snapshotter.buildScriptSnapshot( mainPath: 'other.dart', snapshotPath: 'output.snapshot', depfilePath: 'output.snapshot.d', packagesPath: '.packages', ); expect(genSnapshot.callCount, 1); final Map json = JSON.decode(await fs.file('output.snapshot.d.checksums').readAsString()); expect(json, hasLength(2)); expect(json['other.dart'], '3238d0ae341339b1731d3c2e195ad177'); expect(json['output.snapshot'], 'd41d8cd98f00b204e9800998ecf8427e'); }, overrides: { FileSystem: () => fs, }); testUsingContext('skips snapshot when checksums match and previous snapshot is present', () async { await fs.file('main.dart').writeAsString('void main() {}'); await fs.file('output.snapshot').create(); await fs.file('output.snapshot.d').writeAsString('output.snapshot : main.dart'); await fs.file('output.snapshot.d.checksums').writeAsString(JSON.encode({ 'main.dart': '27f5ebf0f8c559b2af9419d190299a5e', 'output.snapshot': 'd41d8cd98f00b204e9800998ecf8427e', })); await snapshotter.buildScriptSnapshot( mainPath: 'main.dart', snapshotPath: 'output.snapshot', depfilePath: 'output.snapshot.d', packagesPath: '.packages', ); expect(genSnapshot.callCount, 0); final Map json = JSON.decode(await fs.file('output.snapshot.d.checksums').readAsString()); expect(json, hasLength(2)); expect(json['main.dart'], '27f5ebf0f8c559b2af9419d190299a5e'); expect(json['output.snapshot'], 'd41d8cd98f00b204e9800998ecf8427e'); }, overrides: { FileSystem: () => fs, GenSnapshot: () => genSnapshot, }); }); }