cold_test.dart 8.57 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
import 'package:file/memory.dart';
6
import 'package:flutter_tools/src/base/file_system.dart';
7
import 'package:flutter_tools/src/base/io.dart';
8
import 'package:flutter_tools/src/base/platform.dart';
9 10 11 12 13
import 'package:flutter_tools/src/build_info.dart';
import 'package:flutter_tools/src/compile.dart';
import 'package:flutter_tools/src/device.dart';
import 'package:flutter_tools/src/resident_runner.dart';
import 'package:flutter_tools/src/run_cold.dart';
14
import 'package:flutter_tools/src/tracing.dart';
15
import 'package:flutter_tools/src/vmservice.dart';
16
import 'package:test/fake.dart';
17
import 'package:vm_service/vm_service.dart';
18 19 20 21 22

import '../src/common.dart';
import '../src/context.dart';

void main() {
nt4f04uNd's avatar
nt4f04uNd committed
23
  testUsingContext('Exits with code 2 when HttpException is thrown '
24
    'during VM service connection', () async {
25
    final FakeResidentCompiler residentCompiler = FakeResidentCompiler();
26 27 28
    final FakeDevice device = FakeDevice()
      ..supportsHotReload = true
      ..supportsHotRestart = false;
29 30 31

    final List<FlutterDevice> devices = <FlutterDevice>[
      TestFlutterDevice(
32
        device: device,
33 34 35 36 37 38 39 40
        generator: residentCompiler,
        exception: const HttpException('Connection closed before full header was received, '
            'uri = http://127.0.0.1:63394/5ZmLv8A59xY=/ws'),
      ),
    ];

    final int exitCode = await ColdRunner(devices,
      debuggingOptions: DebuggingOptions.enabled(BuildInfo.debug),
41
      target: 'main.dart',
42
    ).attach();
43
    expect(exitCode, 2);
44
  });
45 46 47

  group('cleanupAtFinish()', () {
    testUsingContext('disposes each device', () async {
48 49 50 51
      final FakeDevice device1 = FakeDevice();
      final FakeDevice device2 = FakeDevice();
      final FakeFlutterDevice flutterDevice1 = FakeFlutterDevice(device1);
      final FakeFlutterDevice flutterDevice2 = FakeFlutterDevice(device2);
52

53
      final List<FlutterDevice> devices = <FlutterDevice>[flutterDevice1, flutterDevice2];
54 55 56

      await ColdRunner(devices,
        debuggingOptions: DebuggingOptions.enabled(BuildInfo.debug),
57
        target: 'main.dart',
58 59
      ).cleanupAtFinish();

60 61 62 63
      expect(flutterDevice1.stopEchoingDeviceLogCount, 1);
      expect(flutterDevice2.stopEchoingDeviceLogCount, 1);
      expect(device2.wasDisposed, true);
      expect(device1.wasDisposed, true);
64 65 66 67
    });
  });

  group('cold run', () {
68 69 70
    late MemoryFileSystem memoryFileSystem;
    late FakePlatform fakePlatform;

71 72 73 74 75
    setUp(() {
      memoryFileSystem = MemoryFileSystem();
      fakePlatform = FakePlatform(environment: <String, String>{});
    });

76
    testUsingContext('calls runCold on attached device', () async {
77 78 79 80
      final FakeDevice device = FakeDevice();
      final FakeFlutterDevice flutterDevice = FakeFlutterDevice(device)
        ..runColdCode = 1;
      final List<FlutterDevice> devices = <FlutterDevice>[flutterDevice];
81
      final File applicationBinary = MemoryFileSystem.test().file('binary');
82 83 84 85
      final int result = await ColdRunner(
        devices,
        applicationBinary: applicationBinary,
        debuggingOptions: DebuggingOptions.enabled(BuildInfo.debug),
86
        target: 'main.dart',
87
      ).run();
88

89 90
      expect(result, 1);
    });
91 92

    testUsingContext('with traceStartup, no env variable', () async {
93 94 95
      final FakeDevice device = FakeDevice();
      final FakeFlutterDevice flutterDevice = FakeFlutterDevice(device);
      final List<FlutterDevice> devices = <FlutterDevice>[flutterDevice];
96 97 98 99 100 101 102
      final File applicationBinary = MemoryFileSystem.test().file('binary');
      final int result = await ColdRunner(
        devices,
        applicationBinary: applicationBinary,
        debuggingOptions: DebuggingOptions.disabled(BuildInfo.debug),
        target: 'main.dart',
        traceStartup: true,
103
      ).run();
104 105 106 107 108 109 110 111 112 113 114 115

      expect(result, 0);
      expect(memoryFileSystem.directory(getBuildDirectory()).childFile('start_up_info.json').existsSync(), true);
    }, overrides: <Type, Generator>{
      FileSystem: () => memoryFileSystem,
      ProcessManager: () => FakeProcessManager.any(),
      Platform: () => fakePlatform,
    });

    testUsingContext('with traceStartup, env variable', () async {
      fakePlatform.environment[kFlutterTestOutputsDirEnvName] = 'test_output_dir';

116 117 118
      final FakeDevice device = FakeDevice();
      final FakeFlutterDevice flutterDevice = FakeFlutterDevice(device);
      final List<FlutterDevice> devices = <FlutterDevice>[flutterDevice];
119 120 121 122 123 124 125
      final File applicationBinary = MemoryFileSystem.test().file('binary');
      final int result = await ColdRunner(
        devices,
        applicationBinary: applicationBinary,
        debuggingOptions: DebuggingOptions.disabled(BuildInfo.debug),
        target: 'main.dart',
        traceStartup: true,
126
      ).run();
127 128 129 130 131 132 133 134

      expect(result, 0);
      expect(memoryFileSystem.directory('test_output_dir').childFile('start_up_info.json').existsSync(), true);
    }, overrides: <Type, Generator>{
      FileSystem: () => memoryFileSystem,
      ProcessManager: () => FakeProcessManager.any(),
      Platform: () => fakePlatform,
    });
135
  });
136 137
}

138 139 140 141 142 143 144 145 146
class FakeFlutterDevice extends Fake implements FlutterDevice {
  FakeFlutterDevice(this.device);

  @override
  Stream<Uri> get observatoryUris => const Stream<Uri>.empty();

  @override
  final Device device;

147 148 149 150 151 152 153 154 155
  int stopEchoingDeviceLogCount = 0;

  @override
  Future<void> stopEchoingDeviceLog() async {
    stopEchoingDeviceLogCount += 1;
  }

  @override
  FlutterVmService get vmService => FakeFlutterVmService();
156 157 158 159

  int runColdCode = 0;

  @override
160
  Future<int> runCold({ColdRunner? coldRunner, String? route}) async {
161 162 163 164 165
    return runColdCode;
  }

  @override
  Future<void> initLogReader() async { }
166
}
167

168 169 170
// Unfortunately Device, despite not being immutable, has an `operator ==`.
// Until we fix that, we have to also ignore related lints here.
// ignore: avoid_implementing_value_types
171 172 173 174 175
class FakeDevice extends Fake implements Device {
  @override
  bool isSupported() => true;

  @override
176
  bool supportsHotReload = false;
177 178

  @override
179
  bool supportsHotRestart = false;
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194

  @override
  Future<String> get sdkNameAndVersion async => 'Android 10';

  @override
  String get name => 'test';

  @override
  Future<TargetPlatform> get targetPlatform async => TargetPlatform.tester;

  bool wasDisposed = false;

  @override
  Future<void> dispose() async {
    wasDisposed = true;
195 196 197 198 199
  }
}

class TestFlutterDevice extends FlutterDevice {
  TestFlutterDevice({
200 201 202
    required Device device,
    required this.exception,
    required ResidentCompiler generator,
203
  })  : assert(exception != null),
204
        super(device, buildInfo: BuildInfo.debug, generator: generator);
205 206 207 208 209 210

  /// The exception to throw when the connect method is called.
  final Exception exception;

  @override
  Future<void> connect({
211 212 213 214 215
    ReloadSources? reloadSources,
    Restart? restart,
    CompileExpression? compileExpression,
    GetSkSLMethod? getSkSLMethod,
    PrintStructuredErrorLogMethod? printStructuredErrorLogMethod,
216
    bool enableDds = true,
217
    bool cacheStartupProfile = false,
218
    bool disableServiceAuthCodes = false,
219 220 221
    int? hostVmServicePort,
    int? ddsPort,
    bool? ipv6 = false,
222
    bool allowExistingDdsInstance = false,
223 224 225 226
  }) async {
    throw exception;
  }
}
227

228
class FakeResidentCompiler extends Fake implements ResidentCompiler { }
229 230 231 232 233 234 235 236 237 238 239

class FakeFlutterVmService extends Fake implements FlutterVmService {
  @override
  VmService get service => FakeVmService();

  @override
  Future<List<FlutterView>> getFlutterViews({bool returnEarly = false, Duration delay = const Duration(milliseconds: 50)}) async {
    return <FlutterView>[];
  }

  @override
240
  Future<bool> flutterAlreadyPaintedFirstUsefulFrame({String? isolateId}) async => true;
241 242

  @override
243
  Future<Response?> getTimeline() async {
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
    return Response.parse(<String, dynamic>{
      'traceEvents': <dynamic>[
        <String, dynamic>{
          'name': kFlutterEngineMainEnterEventName,
          'ts': 123,
        },
        <String, dynamic>{
          'name': kFirstFrameBuiltEventName,
          'ts': 124,
        },
        <String, dynamic>{
          'name': kFirstFrameRasterizedEventName,
          'ts': 124,
        },
      ],
    });
  }

  @override
  Future<void> setTimelineFlags(List<String> recordedStreams) async {}
}

class FakeVmService extends Fake implements VmService {
  @override
  Future<Success> streamListen(String streamId) async => Success();

  @override
  Stream<Event> get onExtensionEvent {
    return Stream<Event>.fromIterable(<Event>[
      Event(kind: 'Extension', extensionKind: 'Flutter.FirstFrame', timestamp: 1),
    ]);
  }
}