// 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:args/command_runner.dart'; import 'package:file/memory.dart'; import 'package:file_testing/file_testing.dart'; import 'package:flutter_tools/src/artifacts.dart'; import 'package:flutter_tools/src/base/file_system.dart'; import 'package:flutter_tools/src/build_system/build_system.dart'; import 'package:flutter_tools/src/cache.dart'; import 'package:flutter_tools/src/commands/assemble.dart'; import 'package:flutter_tools/src/convert.dart'; import 'package:mockito/mockito.dart'; import 'package:flutter_tools/src/globals.dart' as globals; import '../../src/common.dart'; import '../../src/context.dart'; import '../../src/testbed.dart'; void main() { Cache.disableLocking(); Cache.flutterRoot = ''; final Testbed testbed = Testbed(overrides: { BuildSystem: () => MockBuildSystem(), Cache: () => FakeCache(), }); testbed.test('flutter assemble can run a build', () async { when(globals.buildSystem.build(any, any, buildSystemConfig: anyNamed('buildSystemConfig'))) .thenAnswer((Invocation invocation) async { return BuildResult(success: true); }); final CommandRunner commandRunner = createTestCommandRunner(AssembleCommand()); await commandRunner.run(['assemble', '-o Output', 'debug_macos_bundle_flutter_assets']); expect(testLogger.traceText, contains('build succeeded.')); }); testbed.test('flutter assemble can parse defines whose values contain =', () async { when(globals.buildSystem.build(any, any, buildSystemConfig: anyNamed('buildSystemConfig'))) .thenAnswer((Invocation invocation) async { expect((invocation.positionalArguments[1] as Environment).defines, containsPair('FooBar', 'fizz=2')); return BuildResult(success: true); }); final CommandRunner commandRunner = createTestCommandRunner(AssembleCommand()); await commandRunner.run(['assemble', '-o Output', '-dFooBar=fizz=2', 'debug_macos_bundle_flutter_assets']); expect(testLogger.traceText, contains('build succeeded.')); }); testbed.test('flutter assemble can parse inputs', () async { when(globals.buildSystem.build(any, any, buildSystemConfig: anyNamed('buildSystemConfig'))) .thenAnswer((Invocation invocation) async { expect((invocation.positionalArguments[1] as Environment).inputs, containsPair('Foo', 'Bar.txt')); return BuildResult(success: true); }); final CommandRunner commandRunner = createTestCommandRunner(AssembleCommand()); await commandRunner.run(['assemble', '-o Output', '-iFoo=Bar.txt', 'debug_macos_bundle_flutter_assets']); expect(testLogger.traceText, contains('build succeeded.')); }); testbed.test('flutter assemble throws ToolExit if not provided with output', () async { when(globals.buildSystem.build(any, any, buildSystemConfig: anyNamed('buildSystemConfig'))) .thenAnswer((Invocation invocation) async { return BuildResult(success: true); }); final CommandRunner commandRunner = createTestCommandRunner(AssembleCommand()); expect(commandRunner.run(['assemble', 'debug_macos_bundle_flutter_assets']), throwsToolExit()); }); testbed.test('flutter assemble throws ToolExit if called with non-existent rule', () async { when(globals.buildSystem.build(any, any, buildSystemConfig: anyNamed('buildSystemConfig'))) .thenAnswer((Invocation invocation) async { return BuildResult(success: true); }); final CommandRunner commandRunner = createTestCommandRunner(AssembleCommand()); expect(commandRunner.run(['assemble', '-o Output', 'undefined']), throwsToolExit()); }); testbed.test('flutter assemble does not log stack traces during build failure', () async { final StackTrace testStackTrace = StackTrace.current; when(globals.buildSystem.build(any, any, buildSystemConfig: anyNamed('buildSystemConfig'))) .thenAnswer((Invocation invocation) async { return BuildResult(success: false, exceptions: { 'hello': ExceptionMeasurement('hello', 'bar', testStackTrace), }); }); final CommandRunner commandRunner = createTestCommandRunner(AssembleCommand()); await expectLater(commandRunner.run(['assemble', '-o Output', 'debug_macos_bundle_flutter_assets']), throwsToolExit()); expect(testLogger.errorText, isNot(contains('bar'))); expect(testLogger.errorText, isNot(contains(testStackTrace.toString()))); }); testbed.test('flutter assemble outputs JSON performance data to provided file', () async { when(globals.buildSystem.build(any, any, buildSystemConfig: anyNamed('buildSystemConfig'))) .thenAnswer((Invocation invocation) async { return BuildResult(success: true, performance: { 'hello': PerformanceMeasurement( target: 'hello', analyticsName: 'bar', elapsedMilliseconds: 123, skipped: false, succeeded: true, ), }); }); final CommandRunner commandRunner = createTestCommandRunner(AssembleCommand()); await commandRunner.run([ 'assemble', '-o Output', '--performance-measurement-file=out.json', 'debug_macos_bundle_flutter_assets', ]); expect(globals.fs.file('out.json'), exists); expect( json.decode(globals.fs.file('out.json').readAsStringSync()), containsPair('targets', contains( containsPair('name', 'bar'), )), ); }); testbed.test('flutter assemble does not inject engine revision with local-engine', () async { Environment environment; when(globals.artifacts.isLocalEngine).thenReturn(true); when(globals.buildSystem.build(any, any, buildSystemConfig: anyNamed('buildSystemConfig'))) .thenAnswer((Invocation invocation) async { environment = invocation.positionalArguments[1] as Environment; return BuildResult(success: true); }); final CommandRunner commandRunner = createTestCommandRunner(AssembleCommand()); await commandRunner.run(['assemble', '-o Output', 'debug_macos_bundle_flutter_assets']); expect(environment.engineVersion, isNull); }, overrides: { Artifacts: () => MockLocalEngineArtifacts() }); testbed.test('flutter assemble only writes input and output files when the values change', () async { when(globals.buildSystem.build(any, any, buildSystemConfig: anyNamed('buildSystemConfig'))) .thenAnswer((Invocation invocation) async { return BuildResult( success: true, inputFiles: [globals.fs.file('foo')..createSync()], outputFiles: [globals.fs.file('bar')..createSync()], ); }); final CommandRunner commandRunner = createTestCommandRunner(AssembleCommand()); await commandRunner.run([ 'assemble', '-o Output', '--build-outputs=outputs', '--build-inputs=inputs', 'debug_macos_bundle_flutter_assets', ]); final File inputs = globals.fs.file('inputs'); final File outputs = globals.fs.file('outputs'); expect(inputs.readAsStringSync(), contains('foo')); expect(outputs.readAsStringSync(), contains('bar')); final DateTime theDistantPast = DateTime(1991, 8, 23); inputs.setLastModifiedSync(theDistantPast); outputs.setLastModifiedSync(theDistantPast); await commandRunner.run([ 'assemble', '-o Output', '--build-outputs=outputs', '--build-inputs=inputs', 'debug_macos_bundle_flutter_assets', ]); expect(inputs.lastModifiedSync(), theDistantPast); expect(outputs.lastModifiedSync(), theDistantPast); when(globals.buildSystem.build(any, any, buildSystemConfig: anyNamed('buildSystemConfig'))) .thenAnswer((Invocation invocation) async { return BuildResult( success: true, inputFiles: [globals.fs.file('foo'), globals.fs.file('fizz')..createSync()], outputFiles: [globals.fs.file('bar'), globals.fs.file(globals.fs.path.join('.dart_tool', 'fizz2'))..createSync(recursive: true)]); }); await commandRunner.run([ 'assemble', '-o Output', '--build-outputs=outputs', '--build-inputs=inputs', 'debug_macos_bundle_flutter_assets', ]); expect(inputs.readAsStringSync(), contains('foo')); expect(inputs.readAsStringSync(), contains('fizz')); expect(inputs.lastModifiedSync(), isNot(theDistantPast)); }); testWithoutContext('writePerformanceData outputs performance data in JSON form', () { final List performanceMeasurement = [ PerformanceMeasurement( analyticsName: 'foo', target: 'hidden', skipped: false, succeeded: true, elapsedMilliseconds: 123, ) ]; final FileSystem fileSystem = MemoryFileSystem.test(); final File outFile = fileSystem.currentDirectory .childDirectory('foo') .childFile('out.json'); writePerformanceData(performanceMeasurement, outFile); expect(outFile, exists); expect(json.decode(outFile.readAsStringSync()), { 'targets': [ { 'name': 'foo', 'skipped': false, 'succeeded': true, 'elapsedMilliseconds': 123, }, ], }); }); } class MockBuildSystem extends Mock implements BuildSystem {} class MockLocalEngineArtifacts extends Mock implements LocalEngineArtifacts {}