simulators_test.dart 17 KB
Newer Older
1 2 3 4
// 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.

5
import 'dart:async';
6
import 'dart:io' show ProcessResult, Process;
7

8
import 'package:file/file.dart';
9
import 'package:flutter_tools/src/build_info.dart';
10
import 'package:file/memory.dart';
11 12
import 'package:flutter_tools/src/device.dart';
import 'package:flutter_tools/src/application_package.dart';
13
import 'package:flutter_tools/src/base/file_system.dart';
14
import 'package:flutter_tools/src/ios/ios_workflow.dart';
15
import 'package:flutter_tools/src/ios/mac.dart';
16
import 'package:flutter_tools/src/ios/simulators.dart';
17
import 'package:flutter_tools/src/macos/xcode.dart';
18
import 'package:flutter_tools/src/project.dart';
19
import 'package:mockito/mockito.dart';
20
import 'package:platform/platform.dart';
21 22
import 'package:process/process.dart';

23
import '../src/common.dart';
24
import '../src/context.dart';
25
import '../src/mocks.dart';
26 27

class MockFile extends Mock implements File {}
28
class MockIMobileDevice extends Mock implements IMobileDevice {}
29
class MockProcess extends Mock implements Process {}
30 31
class MockProcessManager extends Mock implements ProcessManager {}
class MockXcode extends Mock implements Xcode {}
32 33
class MockSimControl extends Mock implements SimControl {}
class MockIOSWorkflow extends Mock implements IOSWorkflow {}
34

35
void main() {
36 37 38
  FakePlatform osx;

  setUp(() {
39
    osx = FakePlatform.fromPlatform(const LocalPlatform());
40 41 42 43 44 45
    osx.operatingSystem = 'macos';
  });

  group('logFilePath', () {
    testUsingContext('defaults to rooted from HOME', () {
      osx.environment['HOME'] = '/foo/bar';
46
      expect(IOSSimulator('123').logFilePath, '/foo/bar/Library/Logs/CoreSimulator/123/system.log');
47 48 49 50 51 52 53
    }, overrides: <Type, Generator>{
      Platform: () => osx,
    }, testOn: 'posix');

    testUsingContext('respects IOS_SIMULATOR_LOG_FILE_PATH', () {
      osx.environment['HOME'] = '/foo/bar';
      osx.environment['IOS_SIMULATOR_LOG_FILE_PATH'] = '/baz/qux/%{id}/system.log';
54
      expect(IOSSimulator('456').logFilePath, '/baz/qux/456/system.log');
55 56 57 58
    }, overrides: <Type, Generator>{
      Platform: () => osx,
    });
  });
59

60 61 62
  group('compareIosVersions', () {
    test('compares correctly', () {
      // This list must be sorted in ascending preference order
63
      final List<String> testList = <String>[
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
        '8', '8.0', '8.1', '8.2',
        '9', '9.0', '9.1', '9.2',
        '10', '10.0', '10.1',
      ];

      for (int i = 0; i < testList.length; i++) {
        expect(compareIosVersions(testList[i], testList[i]), 0);
      }

      for (int i = 0; i < testList.length - 1; i++) {
        for (int j = i + 1; j < testList.length; j++) {
          expect(compareIosVersions(testList[i], testList[j]), lessThan(0));
          expect(compareIosVersions(testList[j], testList[i]), greaterThan(0));
        }
      }
    });
  });

  group('compareIphoneVersions', () {
    test('compares correctly', () {
      // This list must be sorted in ascending preference order
85
      final List<String> testList = <String>[
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
        'com.apple.CoreSimulator.SimDeviceType.iPhone-4s',
        'com.apple.CoreSimulator.SimDeviceType.iPhone-5',
        'com.apple.CoreSimulator.SimDeviceType.iPhone-5s',
        'com.apple.CoreSimulator.SimDeviceType.iPhone-6strange',
        'com.apple.CoreSimulator.SimDeviceType.iPhone-6-Plus',
        'com.apple.CoreSimulator.SimDeviceType.iPhone-6',
        'com.apple.CoreSimulator.SimDeviceType.iPhone-6s-Plus',
        'com.apple.CoreSimulator.SimDeviceType.iPhone-6s',
      ];

      for (int i = 0; i < testList.length; i++) {
        expect(compareIphoneVersions(testList[i], testList[i]), 0);
      }

      for (int i = 0; i < testList.length - 1; i++) {
        for (int j = i + 1; j < testList.length; j++) {
          expect(compareIphoneVersions(testList[i], testList[j]), lessThan(0));
          expect(compareIphoneVersions(testList[j], testList[i]), greaterThan(0));
        }
      }
    });
  });
108

109 110 111
  group('sdkMajorVersion', () {
    // This new version string appears in SimulatorApp-850 CoreSimulator-518.16 beta.
    test('can be parsed from iOS-11-3', () async {
112
      final IOSSimulator device = IOSSimulator('x', name: 'iPhone SE', category: 'com.apple.CoreSimulator.SimRuntime.iOS-11-3');
113 114 115 116 117

      expect(await device.sdkMajorVersion, 11);
    });

    test('can be parsed from iOS 11.2', () async {
118
      final IOSSimulator device = IOSSimulator('x', name: 'iPhone SE', category: 'iOS 11.2');
119 120 121 122 123

      expect(await device.sdkMajorVersion, 11);
    });
  });

124
  group('IOSSimulator.isSupported', () {
125
    testUsingContext('Apple TV is unsupported', () {
126
      expect(IOSSimulator('x', name: 'Apple TV').isSupported(), false);
127 128
    }, overrides: <Type, Generator>{
      Platform: () => osx,
129 130
    });

131
    testUsingContext('Apple Watch is unsupported', () {
132
      expect(IOSSimulator('x', name: 'Apple Watch').isSupported(), false);
133 134
    }, overrides: <Type, Generator>{
      Platform: () => osx,
135 136
    });

137
    testUsingContext('iPad 2 is supported', () {
138
      expect(IOSSimulator('x', name: 'iPad 2').isSupported(), true);
139 140
    }, overrides: <Type, Generator>{
      Platform: () => osx,
141 142
    });

143
    testUsingContext('iPad Retina is supported', () {
144
      expect(IOSSimulator('x', name: 'iPad Retina').isSupported(), true);
145 146
    }, overrides: <Type, Generator>{
      Platform: () => osx,
147 148
    });

149
    testUsingContext('iPhone 5 is supported', () {
150
      expect(IOSSimulator('x', name: 'iPhone 5').isSupported(), true);
151 152
    }, overrides: <Type, Generator>{
      Platform: () => osx,
153 154
    });

155
    testUsingContext('iPhone 5s is supported', () {
156
      expect(IOSSimulator('x', name: 'iPhone 5s').isSupported(), true);
157 158
    }, overrides: <Type, Generator>{
      Platform: () => osx,
159 160
    });

161
    testUsingContext('iPhone SE is supported', () {
162
      expect(IOSSimulator('x', name: 'iPhone SE').isSupported(), true);
163 164
    }, overrides: <Type, Generator>{
      Platform: () => osx,
165 166
    });

167
    testUsingContext('iPhone 7 Plus is supported', () {
168
      expect(IOSSimulator('x', name: 'iPhone 7 Plus').isSupported(), true);
169 170
    }, overrides: <Type, Generator>{
      Platform: () => osx,
171
    });
172 173

    testUsingContext('iPhone X is supported', () {
174
      expect(IOSSimulator('x', name: 'iPhone X').isSupported(), true);
175 176 177
    }, overrides: <Type, Generator>{
      Platform: () => osx,
    });
178
  });
179 180 181 182 183 184 185

  group('Simulator screenshot', () {
    MockXcode mockXcode;
    MockProcessManager mockProcessManager;
    IOSSimulator deviceUnderTest;

    setUp(() {
186 187
      mockXcode = MockXcode();
      mockProcessManager = MockProcessManager();
188 189
      // Let everything else return exit code 0 so process.dart doesn't crash.
      when(
190
        mockProcessManager.run(any, environment: null, workingDirectory: null)
191
      ).thenAnswer((Invocation invocation) =>
192
        Future<ProcessResult>.value(ProcessResult(2, 0, '', ''))
193 194
      );
      // Doesn't matter what the device is.
195
      deviceUnderTest = IOSSimulator('x', name: 'iPhone SE');
196 197 198 199 200
    });

    testUsingContext(
      'old Xcode doesn\'t support screenshot',
      () {
201 202
        when(mockXcode.majorVersion).thenReturn(7);
        when(mockXcode.minorVersion).thenReturn(1);
203 204
        expect(deviceUnderTest.supportsScreenshot, false);
      },
205
      overrides: <Type, Generator>{Xcode: () => mockXcode},
206 207 208 209
    );

    testUsingContext(
      'Xcode 8.2+ supports screenshots',
210
      () async {
211 212
        when(mockXcode.majorVersion).thenReturn(8);
        when(mockXcode.minorVersion).thenReturn(2);
213
        expect(deviceUnderTest.supportsScreenshot, true);
214
        final MockFile mockFile = MockFile();
215
        when(mockFile.path).thenReturn(fs.path.join('some', 'path', 'to', 'screenshot.png'));
216 217
        await deviceUnderTest.takeScreenshot(mockFile);
        verify(mockProcessManager.run(
218 219 220 221
          <String>[
              '/usr/bin/xcrun',
              'simctl',
              'io',
222
              'x',
223
              'screenshot',
224
              fs.path.join('some', 'path', 'to', 'screenshot.png'),
225 226
          ],
          environment: null,
227
          workingDirectory: null,
228 229 230 231 232
        ));
      },
      overrides: <Type, Generator>{
        ProcessManager: () => mockProcessManager,
        // Test a real one. Screenshot doesn't require instance states.
233
        SimControl: () => SimControl(),
234
        Xcode: () => mockXcode,
235
      },
236 237
    );
  });
238 239 240 241 242

  group('launchDeviceLogTool', () {
    MockProcessManager mockProcessManager;

    setUp(() {
243
      mockProcessManager = MockProcessManager();
244
      when(mockProcessManager.start(any, environment: null, workingDirectory: null))
245
        .thenAnswer((Invocation invocation) => Future<Process>.value(MockProcess()));
246 247 248
    });

    testUsingContext('uses tail on iOS versions prior to iOS 11', () async {
249
      final IOSSimulator device = IOSSimulator('x', name: 'iPhone SE', category: 'iOS 9.3');
250 251
      await launchDeviceLogTool(device);
      expect(
252
        verify(mockProcessManager.start(captureAny, environment: null, workingDirectory: null)).captured.single,
253 254 255 256 257 258 259 260
        contains('tail'),
      );
    },
    overrides: <Type, Generator>{
      ProcessManager: () => mockProcessManager,
    });

    testUsingContext('uses /usr/bin/log on iOS 11 and above', () async {
261
      final IOSSimulator device = IOSSimulator('x', name: 'iPhone SE', category: 'iOS 11.0');
262 263
      await launchDeviceLogTool(device);
      expect(
264
        verify(mockProcessManager.start(captureAny, environment: null, workingDirectory: null)).captured.single,
265 266 267 268 269 270 271 272 273 274 275 276
        contains('/usr/bin/log'),
      );
    },
    overrides: <Type, Generator>{
      ProcessManager: () => mockProcessManager,
    });
  });

  group('launchSystemLogTool', () {
    MockProcessManager mockProcessManager;

    setUp(() {
277
      mockProcessManager = MockProcessManager();
278
      when(mockProcessManager.start(any, environment: null, workingDirectory: null))
279
        .thenAnswer((Invocation invocation) => Future<Process>.value(MockProcess()));
280 281 282
    });

    testUsingContext('uses tail on iOS versions prior to iOS 11', () async {
283
      final IOSSimulator device = IOSSimulator('x', name: 'iPhone SE', category: 'iOS 9.3');
284 285
      await launchSystemLogTool(device);
      expect(
286
        verify(mockProcessManager.start(captureAny, environment: null, workingDirectory: null)).captured.single,
287 288 289 290 291 292 293 294
        contains('tail'),
      );
    },
    overrides: <Type, Generator>{
      ProcessManager: () => mockProcessManager,
    });

    testUsingContext('uses /usr/bin/log on iOS 11 and above', () async {
295
      final IOSSimulator device = IOSSimulator('x', name: 'iPhone SE', category: 'iOS 11.0');
296 297 298 299 300 301 302
      await launchSystemLogTool(device);
      verifyNever(mockProcessManager.start(any, environment: null, workingDirectory: null));
    },
    overrides: <Type, Generator>{
      ProcessManager: () => mockProcessManager,
    });
  });
303 304 305

  group('log reader', () {
    MockProcessManager mockProcessManager;
306
    MockIosProject mockIosProject;
307 308

    setUp(() {
309 310
      mockProcessManager = MockProcessManager();
      mockIosProject = MockIosProject();
311 312 313 314
    });

    testUsingContext('simulator can output `)`', () async {
      when(mockProcessManager.start(any, environment: null, workingDirectory: null))
315 316 317 318 319
        .thenAnswer((Invocation invocation) {
          final Process mockProcess = MockProcess();
          when(mockProcess.stdout)
            .thenAnswer((Invocation invocation) {
              return Stream<List<int>>.fromIterable(<List<int>>['''
320 321 322
2017-09-13 15:26:57.228948-0700  localhost Runner[37195]: (Flutter) Observatory listening on http://127.0.0.1:57701/
2017-09-13 15:26:57.228948-0700  localhost Runner[37195]: (Flutter) ))))))))))
2017-09-13 15:26:57.228948-0700  localhost Runner[37195]: (Flutter) #0      Object.noSuchMethod (dart:core-patch/dart:core/object_patch.dart:46)'''
323 324 325 326 327 328 329 330 331
                .codeUnits]);
            });
          when(mockProcess.stderr)
              .thenAnswer((Invocation invocation) => const Stream<List<int>>.empty());
          // Delay return of exitCode until after stdout stream data, since it terminates the logger.
          when(mockProcess.exitCode)
              .thenAnswer((Invocation invocation) => Future<int>.delayed(Duration.zero, () => 0));
          return Future<Process>.value(mockProcess);
        });
332

333
      final IOSSimulator device = IOSSimulator('123456', category: 'iOS 11.0');
334
      final DeviceLogReader logReader = device.getLogReader(
335
        app: BuildableIOSApp(mockIosProject),
336 337 338 339 340 341 342 343 344 345 346 347
      );

      final List<String> lines = await logReader.logLines.toList();
      expect(lines, <String>[
        'Observatory listening on http://127.0.0.1:57701/',
        '))))))))))',
        '#0      Object.noSuchMethod (dart:core-patch/dart:core/object_patch.dart:46)',
      ]);
    }, overrides: <Type, Generator>{
      ProcessManager: () => mockProcessManager,
    });
  });
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385

  group('SimControl', () {
    const int mockPid = 123;
    const String validSimControlOutput = '''
{
  "devices" : {
    "watchOS 4.3" : [
      {
        "state" : "Shutdown",
        "availability" : "(available)",
        "name" : "Apple Watch - 38mm",
        "udid" : "TEST-WATCH-UDID"
      }
    ],
    "iOS 11.4" : [
      {
        "state" : "Booted",
        "availability" : "(available)",
        "name" : "iPhone 5s",
        "udid" : "TEST-PHONE-UDID"
      }
    ],
    "tvOS 11.4" : [
      {
        "state" : "Shutdown",
        "availability" : "(available)",
        "name" : "Apple TV",
        "udid" : "TEST-TV-UDID"
      }
    ]
  }
}
    ''';

    MockProcessManager mockProcessManager;
    SimControl simControl;

    setUp(() {
386
      mockProcessManager = MockProcessManager();
387
      when(mockProcessManager.runSync(any))
388
          .thenReturn(ProcessResult(mockPid, 0, validSimControlOutput, ''));
389

390
      simControl = SimControl();
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
    });

    testUsingContext('getDevices succeeds', () {
      final List<SimDevice> devices = simControl.getDevices();

      final SimDevice watch = devices[0];
      expect(watch.category, 'watchOS 4.3');
      expect(watch.state, 'Shutdown');
      expect(watch.availability, '(available)');
      expect(watch.name, 'Apple Watch - 38mm');
      expect(watch.udid, 'TEST-WATCH-UDID');
      expect(watch.isBooted, isFalse);

      final SimDevice phone = devices[1];
      expect(phone.category, 'iOS 11.4');
      expect(phone.state, 'Booted');
      expect(phone.availability, '(available)');
      expect(phone.name, 'iPhone 5s');
      expect(phone.udid, 'TEST-PHONE-UDID');
      expect(phone.isBooted, isTrue);

      final SimDevice tv = devices[2];
      expect(tv.category, 'tvOS 11.4');
      expect(tv.state, 'Shutdown');
      expect(tv.availability, '(available)');
      expect(tv.name, 'Apple TV');
      expect(tv.udid, 'TEST-TV-UDID');
      expect(tv.isBooted, isFalse);
    }, overrides: <Type, Generator>{
      ProcessManager: () => mockProcessManager,
      SimControl: () => simControl,
    });
  });
424

425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451
  group('startApp', () {
    SimControl simControl;

    setUp(() {
      simControl = MockSimControl();
    });

    testUsingContext("startApp uses compiled app's Info.plist to find CFBundleIdentifier", () async {
        final IOSSimulator device = IOSSimulator('x', name: 'iPhone SE', category: 'iOS 11.2');
        when(iosWorkflow.getPlistValueFromFile(any, any)).thenReturn('correct');

        final Directory mockDir = fs.currentDirectory;
        final IOSApp package = PrebuiltIOSApp(projectBundleId: 'incorrect', bundleName: 'name', bundleDir: mockDir);

        const BuildInfo mockInfo = BuildInfo(BuildMode.debug, 'flavor');
        final DebuggingOptions mockOptions = DebuggingOptions.disabled(mockInfo);
        await device.startApp(package, prebuiltApplication: true, debuggingOptions: mockOptions);

        verify(simControl.launch(any, 'correct', any));
      },
      overrides: <Type, Generator>{
        SimControl: () => simControl,
        IOSWorkflow: () => MockIOSWorkflow()
      },
    );
  });

452 453 454 455 456 457 458 459 460 461
  testUsingContext('IOSDevice.isSupportedForProject is true on module project', () async {
    fs.file('pubspec.yaml')
      ..createSync()
      ..writeAsStringSync(r'''
name: example

flutter:
  module: {}
''');
    fs.file('.packages').createSync();
462
    final FlutterProject flutterProject = FlutterProject.current();
463 464 465 466 467 468 469 470 471 472

    expect(IOSSimulator('test').isSupportedForProject(flutterProject), true);
  }, overrides: <Type, Generator>{
    FileSystem: () => MemoryFileSystem(),
  });

  testUsingContext('IOSDevice.isSupportedForProject is true with editable host app', () async {
    fs.file('pubspec.yaml').createSync();
    fs.file('.packages').createSync();
    fs.directory('ios').createSync();
473
    final FlutterProject flutterProject = FlutterProject.current();
474 475 476 477 478 479 480 481 482

    expect(IOSSimulator('test').isSupportedForProject(flutterProject), true);
  }, overrides: <Type, Generator>{
    FileSystem: () => MemoryFileSystem(),
  });

  testUsingContext('IOSDevice.isSupportedForProject is false with no host app and no module', () async {
    fs.file('pubspec.yaml').createSync();
    fs.file('.packages').createSync();
483
    final FlutterProject flutterProject = FlutterProject.current();
484 485 486 487 488

    expect(IOSSimulator('test').isSupportedForProject(flutterProject), false);
  }, overrides: <Type, Generator>{
    FileSystem: () => MemoryFileSystem(),
  });
489
}