mirror of
https://github.com/flutter/flutter.git
synced 2025-06-03 00:51:18 +00:00
741608a261
Fixes #45075 Fixes #57210 If an asset was included directly from the project root directory, then the same asset when copied to various output or ephemeral directories would also be picked up as an asset variant. This could cause assets to be recursively copied into asset/build/ephemeral directories, as each time it would run it would pick up all of the previous "variants". The solution is to include project ephemeral directories, in addition to the build directory.
476 lines
17 KiB
Dart
476 lines
17 KiB
Dart
// 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 'dart:convert';
|
|
|
|
import 'package:file/file.dart';
|
|
import 'package:file/memory.dart';
|
|
import 'package:flutter_tools/src/asset.dart';
|
|
import 'package:flutter_tools/src/base/file_system.dart';
|
|
import 'package:flutter_tools/src/base/platform.dart';
|
|
import 'package:flutter_tools/src/bundle.dart';
|
|
import 'package:flutter_tools/src/cache.dart';
|
|
import 'package:flutter_tools/src/devfs.dart';
|
|
import 'package:flutter_tools/src/globals.dart' as globals;
|
|
import 'package:mockito/mockito.dart';
|
|
|
|
import '../src/common.dart';
|
|
import '../src/context.dart';
|
|
|
|
void main() {
|
|
setUpAll(() {
|
|
Cache.flutterRoot = getFlutterRoot();
|
|
});
|
|
|
|
group('AssetBundle.build', () {
|
|
FileSystem testFileSystem;
|
|
|
|
setUp(() async {
|
|
testFileSystem = MemoryFileSystem(
|
|
style: globals.platform.isWindows
|
|
? FileSystemStyle.windows
|
|
: FileSystemStyle.posix,
|
|
);
|
|
testFileSystem.currentDirectory = testFileSystem.systemTempDirectory.createTempSync('flutter_asset_bundle_test.');
|
|
});
|
|
|
|
testUsingContext('nonempty', () async {
|
|
final AssetBundle ab = AssetBundleFactory.instance.createBundle();
|
|
expect(await ab.build(packagesPath: '.packages'), 0);
|
|
expect(ab.entries.length, greaterThan(0));
|
|
}, overrides: <Type, Generator>{
|
|
FileSystem: () => testFileSystem,
|
|
ProcessManager: () => FakeProcessManager.any(),
|
|
});
|
|
|
|
testUsingContext('empty pubspec', () async {
|
|
globals.fs.file('pubspec.yaml')
|
|
..createSync()
|
|
..writeAsStringSync('');
|
|
|
|
final AssetBundle bundle = AssetBundleFactory.instance.createBundle();
|
|
await bundle.build(manifestPath: 'pubspec.yaml', packagesPath: '.packages');
|
|
expect(bundle.entries.length, 1);
|
|
const String expectedAssetManifest = '{}';
|
|
expect(
|
|
utf8.decode(await bundle.entries['AssetManifest.json'].contentsAsBytes()),
|
|
expectedAssetManifest,
|
|
);
|
|
}, overrides: <Type, Generator>{
|
|
FileSystem: () => testFileSystem,
|
|
ProcessManager: () => FakeProcessManager.any(),
|
|
});
|
|
|
|
testUsingContext('wildcard directories are updated when filesystem changes', () async {
|
|
final File packageFile = globals.fs.file('.packages')..createSync();
|
|
globals.fs.file(globals.fs.path.join('assets', 'foo', 'bar.txt')).createSync(recursive: true);
|
|
globals.fs.file('pubspec.yaml')
|
|
..createSync()
|
|
..writeAsStringSync(r'''
|
|
name: example
|
|
flutter:
|
|
assets:
|
|
- assets/foo/
|
|
''');
|
|
final AssetBundle bundle = AssetBundleFactory.instance.createBundle();
|
|
await bundle.build(manifestPath: 'pubspec.yaml', packagesPath: '.packages');
|
|
// Expected assets:
|
|
// - asset manifest
|
|
// - font manifest
|
|
// - license file
|
|
// - assets/foo/bar.txt
|
|
expect(bundle.entries.length, 4);
|
|
expect(bundle.needsBuild(manifestPath: 'pubspec.yaml'), false);
|
|
|
|
// Simulate modifying the files by updating the filestat time manually.
|
|
globals.fs.file(globals.fs.path.join('assets', 'foo', 'fizz.txt'))
|
|
..createSync(recursive: true)
|
|
..setLastModifiedSync(packageFile.lastModifiedSync().add(const Duration(hours: 1)));
|
|
|
|
expect(bundle.needsBuild(manifestPath: 'pubspec.yaml'), true);
|
|
await bundle.build(manifestPath: 'pubspec.yaml', packagesPath: '.packages');
|
|
// Expected assets:
|
|
// - asset manifest
|
|
// - font manifest
|
|
// - license file
|
|
// - assets/foo/bar.txt
|
|
// - assets/foo/fizz.txt
|
|
expect(bundle.entries.length, 5);
|
|
}, overrides: <Type, Generator>{
|
|
FileSystem: () => testFileSystem,
|
|
ProcessManager: () => FakeProcessManager.any(),
|
|
});
|
|
|
|
testUsingContext('handle removal of wildcard directories', () async {
|
|
globals.fs.file(globals.fs.path.join('assets', 'foo', 'bar.txt')).createSync(recursive: true);
|
|
final File pubspec = globals.fs.file('pubspec.yaml')
|
|
..createSync()
|
|
..writeAsStringSync(r'''
|
|
name: example
|
|
flutter:
|
|
assets:
|
|
- assets/foo/
|
|
''');
|
|
globals.fs.file('.packages').createSync();
|
|
final AssetBundle bundle = AssetBundleFactory.instance.createBundle();
|
|
await bundle.build(manifestPath: 'pubspec.yaml', packagesPath: '.packages');
|
|
// Expected assets:
|
|
// - asset manifest
|
|
// - font manifest
|
|
// - license file
|
|
// - assets/foo/bar.txt
|
|
expect(bundle.entries.length, 4);
|
|
expect(bundle.needsBuild(manifestPath: 'pubspec.yaml'), false);
|
|
|
|
// Delete the wildcard directory and update pubspec file.
|
|
final DateTime modifiedTime = pubspec.lastModifiedSync().add(const Duration(hours: 1));
|
|
globals.fs.directory(globals.fs.path.join('assets', 'foo')).deleteSync(recursive: true);
|
|
globals.fs.file('pubspec.yaml')
|
|
..createSync()
|
|
..writeAsStringSync(r'''
|
|
name: example''')
|
|
..setLastModifiedSync(modifiedTime);
|
|
|
|
// touch .packages to make sure its change time is after pubspec.yaml's
|
|
globals.fs.file('.packages')
|
|
.setLastModifiedSync(modifiedTime);
|
|
|
|
// Even though the previous file was removed, it is left in the
|
|
// asset manifest and not updated. This is due to the devfs not
|
|
// supporting file deletion.
|
|
expect(bundle.needsBuild(manifestPath: 'pubspec.yaml'), true);
|
|
await bundle.build(manifestPath: 'pubspec.yaml', packagesPath: '.packages');
|
|
// Expected assets:
|
|
// - asset manifest
|
|
// - font manifest
|
|
// - license file
|
|
// - assets/foo/bar.txt
|
|
expect(bundle.entries.length, 4);
|
|
}, overrides: <Type, Generator>{
|
|
FileSystem: () => testFileSystem,
|
|
ProcessManager: () => FakeProcessManager.any(),
|
|
});
|
|
|
|
// https://github.com/flutter/flutter/issues/42723
|
|
testUsingContext('Test regression for mistyped file', () async {
|
|
globals.fs.file(globals.fs.path.join('assets', 'foo', 'bar.txt')).createSync(recursive: true);
|
|
// Create a directory in the same path to test that we're only looking at File
|
|
// objects.
|
|
globals.fs.directory(globals.fs.path.join('assets', 'foo', 'bar')).createSync();
|
|
globals.fs.file('pubspec.yaml')
|
|
..createSync()
|
|
..writeAsStringSync(r'''
|
|
name: example
|
|
flutter:
|
|
assets:
|
|
- assets/foo/
|
|
''');
|
|
globals.fs.file('.packages').createSync();
|
|
final AssetBundle bundle = AssetBundleFactory.instance.createBundle();
|
|
await bundle.build(manifestPath: 'pubspec.yaml', packagesPath: '.packages');
|
|
// Expected assets:
|
|
// - asset manifest
|
|
// - font manifest
|
|
// - license file
|
|
// - assets/foo/bar.txt
|
|
expect(bundle.entries.length, 4);
|
|
expect(bundle.needsBuild(manifestPath: 'pubspec.yaml'), false);
|
|
}, overrides: <Type, Generator>{
|
|
FileSystem: () => testFileSystem,
|
|
ProcessManager: () => FakeProcessManager.any(),
|
|
});
|
|
});
|
|
|
|
testUsingContext('Failed directory delete shows message', () async {
|
|
final MockDirectory mockDirectory = MockDirectory();
|
|
when(mockDirectory.existsSync()).thenReturn(true);
|
|
when(mockDirectory.deleteSync(recursive: true)).thenThrow(const FileSystemException('ABCD'));
|
|
|
|
await writeBundle(mockDirectory, <String, DevFSContent>{}, loggerOverride: testLogger);
|
|
|
|
verify(mockDirectory.createSync(recursive: true)).called(1);
|
|
expect(testLogger.errorText, contains('ABCD'));
|
|
});
|
|
|
|
testUsingContext('does not unnecessarily recreate asset manifest, font manifest, license', () async {
|
|
globals.fs.file('.packages').createSync();
|
|
globals.fs.file(globals.fs.path.join('assets', 'foo', 'bar.txt')).createSync(recursive: true);
|
|
globals.fs.file('pubspec.yaml')
|
|
..createSync()
|
|
..writeAsStringSync(r'''
|
|
name: example
|
|
flutter:
|
|
assets:
|
|
- assets/foo/bar.txt
|
|
''');
|
|
final AssetBundle bundle = AssetBundleFactory.instance.createBundle();
|
|
await bundle.build(manifestPath: 'pubspec.yaml', packagesPath: '.packages');
|
|
|
|
final DevFSStringContent assetManifest = bundle.entries['AssetManifest.json']
|
|
as DevFSStringContent;
|
|
final DevFSStringContent fontManifest = bundle.entries['FontManifest.json']
|
|
as DevFSStringContent;
|
|
final DevFSStringContent license = bundle.entries['NOTICES']
|
|
as DevFSStringContent;
|
|
|
|
await bundle.build(manifestPath: 'pubspec.yaml', packagesPath: '.packages');
|
|
|
|
expect(assetManifest, bundle.entries['AssetManifest.json']);
|
|
expect(fontManifest, bundle.entries['FontManifest.json']);
|
|
expect(license, bundle.entries['NOTICES']);
|
|
}, overrides: <Type, Generator>{
|
|
FileSystem: () => MemoryFileSystem.test(),
|
|
ProcessManager: () => FakeProcessManager.any(),
|
|
});
|
|
|
|
testUsingContext('inserts dummy file into additionalDependencies when '
|
|
'wildcards are used', () async {
|
|
globals.fs.file('.packages').createSync();
|
|
globals.fs.file(globals.fs.path.join('assets', 'bar.txt')).createSync(recursive: true);
|
|
globals.fs.file('pubspec.yaml')
|
|
..createSync()
|
|
..writeAsStringSync(r'''
|
|
name: example
|
|
flutter:
|
|
assets:
|
|
- assets/
|
|
''');
|
|
final AssetBundle bundle = AssetBundleFactory.instance.createBundle();
|
|
|
|
expect(await bundle.build(manifestPath: 'pubspec.yaml', packagesPath: '.packages'), 0);
|
|
expect(bundle.additionalDependencies.single.path, contains('DOES_NOT_EXIST_RERUN_FOR_WILDCARD'));
|
|
}, overrides: <Type, Generator>{
|
|
FileSystem: () => MemoryFileSystem.test(),
|
|
ProcessManager: () => FakeProcessManager.any(),
|
|
});
|
|
|
|
testUsingContext('Does not insert dummy file into additionalDependencies '
|
|
'when wildcards are not used', () async {
|
|
globals.fs.file('.packages').createSync();
|
|
globals.fs.file(globals.fs.path.join('assets', 'bar.txt')).createSync(recursive: true);
|
|
globals.fs.file('pubspec.yaml')
|
|
..createSync()
|
|
..writeAsStringSync(r'''
|
|
name: example
|
|
flutter:
|
|
assets:
|
|
- assets/bar.txt
|
|
''');
|
|
final AssetBundle bundle = AssetBundleFactory.instance.createBundle();
|
|
|
|
expect(await bundle.build(manifestPath: 'pubspec.yaml', packagesPath: '.packages'), 0);
|
|
expect(bundle.additionalDependencies, isEmpty);
|
|
}, overrides: <Type, Generator>{
|
|
FileSystem: () => MemoryFileSystem.test(),
|
|
ProcessManager: () => FakeProcessManager.any(),
|
|
});
|
|
|
|
testUsingContext('Does not insert dummy file into additionalDependencies '
|
|
'when wildcards are used by dependencies', () async {
|
|
globals.fs.file('.packages').writeAsStringSync(r'''
|
|
example:lib/
|
|
foo:foo/lib/
|
|
''');
|
|
globals.fs.file(globals.fs.path.join('assets', 'foo', 'bar.txt'))
|
|
.createSync(recursive: true);
|
|
globals.fs.file('pubspec.yaml')
|
|
..createSync()
|
|
..writeAsStringSync(r'''
|
|
name: example
|
|
dependencies:
|
|
foo: any
|
|
''');
|
|
globals.fs.file('foo/pubspec.yaml')
|
|
..createSync(recursive: true)
|
|
..writeAsStringSync(r'''
|
|
name: foo
|
|
|
|
flutter:
|
|
assets:
|
|
- bar/
|
|
''');
|
|
final AssetBundle bundle = AssetBundleFactory.instance.createBundle();
|
|
globals.fs.file('foo/bar/fizz.txt').createSync(recursive: true);
|
|
|
|
expect(await bundle.build(manifestPath: 'pubspec.yaml', packagesPath: '.packages'), 0);
|
|
expect(bundle.additionalDependencies, isEmpty);
|
|
}, overrides: <Type, Generator>{
|
|
FileSystem: () => MemoryFileSystem.test(),
|
|
ProcessManager: () => FakeProcessManager.any(),
|
|
Platform: () => FakePlatform(operatingSystem: 'linux'),
|
|
});
|
|
|
|
testUsingContext('does not track wildcard directories from dependencies', () async {
|
|
globals.fs.file('.packages').writeAsStringSync(r'''
|
|
example:lib/
|
|
foo:foo/lib/
|
|
''');
|
|
globals.fs.file(globals.fs.path.join('assets', 'foo', 'bar.txt'))
|
|
.createSync(recursive: true);
|
|
globals.fs.file('pubspec.yaml')
|
|
..createSync()
|
|
..writeAsStringSync(r'''
|
|
name: example
|
|
dependencies:
|
|
foo: any
|
|
''');
|
|
globals.fs.file('foo/pubspec.yaml')
|
|
..createSync(recursive: true)
|
|
..writeAsStringSync(r'''
|
|
name: foo
|
|
|
|
flutter:
|
|
assets:
|
|
- bar/
|
|
''');
|
|
final AssetBundle bundle = AssetBundleFactory.instance.createBundle();
|
|
globals.fs.file('foo/bar/fizz.txt').createSync(recursive: true);
|
|
|
|
await bundle.build(manifestPath: 'pubspec.yaml', packagesPath: '.packages');
|
|
|
|
expect(bundle.entries, hasLength(4));
|
|
expect(bundle.needsBuild(manifestPath: 'pubspec.yaml'), false);
|
|
|
|
// Does not track dependency's wildcard directories.
|
|
globals.fs.file(globals.fs.path.join('assets', 'foo', 'bar.txt'))
|
|
.deleteSync();
|
|
|
|
expect(bundle.needsBuild(manifestPath: 'pubspec.yaml'), false);
|
|
}, overrides: <Type, Generator>{
|
|
FileSystem: () => MemoryFileSystem.test(),
|
|
ProcessManager: () => FakeProcessManager.any(),
|
|
Platform: () => FakePlatform(operatingSystem: 'linux'),
|
|
});
|
|
|
|
testUsingContext('reports package that causes asset bundle error when it is '
|
|
'a dependency', () async {
|
|
globals.fs.file('.packages').writeAsStringSync(r'''
|
|
example:lib/
|
|
foo:foo/lib/
|
|
''');
|
|
globals.fs.file(globals.fs.path.join('assets', 'foo', 'bar.txt'))
|
|
.createSync(recursive: true);
|
|
globals.fs.file('pubspec.yaml')
|
|
..createSync()
|
|
..writeAsStringSync(r'''
|
|
name: example
|
|
dependencies:
|
|
foo: any
|
|
''');
|
|
globals.fs.file('foo/pubspec.yaml')
|
|
..createSync(recursive: true)
|
|
..writeAsStringSync(r'''
|
|
name: foo
|
|
|
|
flutter:
|
|
assets:
|
|
- bar.txt
|
|
''');
|
|
final AssetBundle bundle = AssetBundleFactory.instance.createBundle();
|
|
|
|
expect(await bundle.build(manifestPath: 'pubspec.yaml', packagesPath: '.packages'), 1);
|
|
expect(testLogger.errorText, contains('This asset was included from package foo'));
|
|
}, overrides: <Type, Generator>{
|
|
FileSystem: () => MemoryFileSystem.test(),
|
|
ProcessManager: () => FakeProcessManager.any(),
|
|
Platform: () => FakePlatform(operatingSystem: 'linux'),
|
|
});
|
|
|
|
testUsingContext('does not report package that causes asset bundle error '
|
|
'when it is from own pubspec', () async {
|
|
globals.fs.file('.packages').writeAsStringSync(r'''
|
|
example:lib/
|
|
''');
|
|
globals.fs.file('pubspec.yaml')
|
|
..createSync()
|
|
..writeAsStringSync(r'''
|
|
name: example
|
|
flutter:
|
|
assets:
|
|
- bar.txt
|
|
''');
|
|
final AssetBundle bundle = AssetBundleFactory.instance.createBundle();
|
|
|
|
expect(await bundle.build(manifestPath: 'pubspec.yaml', packagesPath: '.packages'), 1);
|
|
expect(testLogger.errorText, isNot(contains('This asset was included from')));
|
|
}, overrides: <Type, Generator>{
|
|
FileSystem: () => MemoryFileSystem.test(),
|
|
ProcessManager: () => FakeProcessManager.any(),
|
|
Platform: () => FakePlatform(operatingSystem: 'linux'),
|
|
});
|
|
|
|
testUsingContext('does not include material design assets if uses-material-design: true is '
|
|
'specified only by a dependency', () async {
|
|
globals.fs.file('.packages').writeAsStringSync(r'''
|
|
example:lib/
|
|
foo:foo/lib/
|
|
''');
|
|
globals.fs.file('pubspec.yaml')
|
|
..createSync()
|
|
..writeAsStringSync(r'''
|
|
name: example
|
|
dependencies:
|
|
foo: any
|
|
|
|
flutter:
|
|
uses-material-design: false
|
|
''');
|
|
globals.fs.file('foo/pubspec.yaml')
|
|
..createSync(recursive: true)
|
|
..writeAsStringSync(r'''
|
|
name: foo
|
|
|
|
flutter:
|
|
uses-material-design: true
|
|
''');
|
|
final AssetBundle bundle = AssetBundleFactory.instance.createBundle();
|
|
|
|
expect(await bundle.build(manifestPath: 'pubspec.yaml', packagesPath: '.packages'), 0);
|
|
expect((bundle.entries['FontManifest.json'] as DevFSStringContent).string, '[]');
|
|
expect((bundle.entries['AssetManifest.json'] as DevFSStringContent).string, '{}');
|
|
expect(testLogger.errorText, contains(
|
|
'package:foo has `uses-material-design: true` set'
|
|
));
|
|
}, overrides: <Type, Generator>{
|
|
FileSystem: () => MemoryFileSystem.test(),
|
|
ProcessManager: () => FakeProcessManager.any(),
|
|
Platform: () => FakePlatform(operatingSystem: 'linux'),
|
|
});
|
|
|
|
testUsingContext('does not include assets in project directories as asset variants', () async {
|
|
globals.fs.file('.packages').writeAsStringSync(r'''
|
|
example:lib/
|
|
''');
|
|
globals.fs.file('pubspec.yaml')
|
|
..createSync()
|
|
..writeAsStringSync(r'''
|
|
name: example
|
|
|
|
flutter:
|
|
assets:
|
|
- foo.txt
|
|
''');
|
|
globals.fs.file('assets/foo.txt').createSync(recursive: true);
|
|
|
|
// Potential build artifacts outisde of build directory.
|
|
globals.fs.file('linux/flutter/foo.txt').createSync(recursive: true);
|
|
globals.fs.file('windows/flutter/foo.txt').createSync(recursive: true);
|
|
globals.fs.file('windows/CMakeLists.txt').createSync();
|
|
globals.fs.file('macos/Flutter/foo.txt').createSync(recursive: true);
|
|
globals.fs.file('ios/foo.txt').createSync(recursive: true);
|
|
globals.fs.file('build/foo.txt').createSync(recursive: true);
|
|
|
|
final AssetBundle bundle = AssetBundleFactory.instance.createBundle();
|
|
|
|
expect(await bundle.build(manifestPath: 'pubspec.yaml', packagesPath: '.packages'), 0);
|
|
expect(bundle.entries.length, 4);
|
|
}, overrides: <Type, Generator>{
|
|
FileSystem: () => MemoryFileSystem.test(),
|
|
ProcessManager: () => FakeProcessManager.any(),
|
|
Platform: () => FakePlatform(operatingSystem: 'linux'),
|
|
});
|
|
}
|
|
|
|
class MockDirectory extends Mock implements Directory {}
|