build_ios_framework_module_test.dart 12.5 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
xster's avatar
xster committed
2 3 4 5 6 7
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'dart:io';

import 'package:flutter_devicelab/framework/framework.dart';
8
import 'package:flutter_devicelab/framework/ios.dart';
9
import 'package:flutter_devicelab/framework/task_result.dart';
xster's avatar
xster committed
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
import 'package:flutter_devicelab/framework/utils.dart';
import 'package:path/path.dart' as path;

/// Tests that iOS .frameworks can be built on module projects.
Future<void> main() async {
  await task(() async {

    section('Create module project');

    final Directory tempDir = Directory.systemTemp.createTempSync('flutter_module_test.');
    final Directory projectDir = Directory(path.join(tempDir.path, 'hello'));
    try {
      await inDirectory(tempDir, () async {
        await flutter(
          'create',
          options: <String>['--org', 'io.flutter.devicelab', '--template', 'module', 'hello'],
        );
      });

      section('Add plugins');

      final File pubspec = File(path.join(projectDir.path, 'pubspec.yaml'));
      String content = pubspec.readAsStringSync();
      content = content.replaceFirst(
        '\ndependencies:\n',
        '\ndependencies:\n  device_info: 0.4.1\n  package_info: 0.4.0+9\n',
      );
      pubspec.writeAsStringSync(content, flush: true);
      await inDirectory(projectDir, () async {
        await flutter(
          'packages',
          options: <String>['get'],
        );
      });

45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
      // First, build the module in Debug to copy the debug version of Flutter.framework.
      // This proves "flutter build ios-framework" re-copies the relevant Flutter.framework,
      // otherwise building plugins with bitcode will fail linking because the debug version
      // of Flutter.framework does not contain bitcode.
      await inDirectory(projectDir, () async {
        await flutter(
          'build',
          options: <String>[
            'ios',
            '--debug',
            '--no-codesign',
          ],
        );
      });

xster's avatar
xster committed
60 61 62
      // This builds all build modes' frameworks by default
      section('Build frameworks');

63 64
      const String outputDirectoryName = 'flutter-frameworks';

xster's avatar
xster committed
65 66 67
      await inDirectory(projectDir, () async {
        await flutter(
          'build',
68 69 70 71 72
          options: <String>[
            'ios-framework',
            '--xcframework',
            '--output=$outputDirectoryName'
          ],
xster's avatar
xster committed
73 74 75
        );
      });

76
      final String outputPath = path.join(projectDir.path, outputDirectoryName);
xster's avatar
xster committed
77 78 79 80 81 82 83 84 85 86 87

      section('Check debug build has Dart snapshot as asset');

      checkFileExists(path.join(
        outputPath,
        'Debug',
        'App.framework',
        'flutter_assets',
        'vm_snapshot_data',
      ));

88 89 90 91 92 93 94 95 96 97
      section('Check debug build has no Dart AOT');

      // There's still an App.framework with a dylib, but it's empty.
      checkFileExists(path.join(
        outputPath,
        'Debug',
        'App.framework',
        'App',
      ));

98
      final String debugAppFrameworkPath = path.join(
99 100 101 102
        outputPath,
        'Debug',
        'App.framework',
        'App',
103
      );
104
      final String aotSymbols = await dylibSymbols(debugAppFrameworkPath);
105 106 107 108 109

      if (aotSymbols.contains('architecture') ||
          aotSymbols.contains('_kDartVmSnapshot')) {
        throw TaskResult.failure('Debug App.framework contains AOT');
      }
110
      await _checkFrameworkArchs(debugAppFrameworkPath, 'Debug');
111

112 113 114 115 116
      // Xcode changed the name of this generated directory in Xcode 12.
      const String xcode11ArmDirectoryName = 'ios-armv7_arm64';
      const String xcode12ArmDirectoryName = 'ios-arm64_armv7';

      final String xcode11AppFrameworkDirectory = path.join(
117 118 119
        outputPath,
        'Debug',
        'App.xcframework',
120
        xcode11ArmDirectoryName,
121 122
        'App.framework',
        'App',
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
      );
      final String xcode12AppFrameworkDirectory = path.join(
        outputPath,
        'Debug',
        'App.xcframework',
        xcode12ArmDirectoryName,
        'App.framework',
        'App',
      );

      // This seemed easier than an explicit Xcode version check.
      String xcodeArmDirectoryName;
      if (exists(File(xcode11AppFrameworkDirectory))) {
        xcodeArmDirectoryName = xcode11ArmDirectoryName;
      } else if (exists(File(xcode12AppFrameworkDirectory))) {
        xcodeArmDirectoryName = xcode12ArmDirectoryName;
      } else {
        throw const FileSystemException('Expected App.framework binary to exist.');
      }
142

143 144 145 146 147 148 149 150
      checkFileExists(path.join(
        outputPath,
        'Debug',
        'App.xcframework',
        'ios-x86_64-simulator',
        'App.framework',
        'App',
      ));
151

152
      section('Check profile, release builds has Dart AOT dylib');
xster's avatar
xster committed
153

154
      for (final String mode in <String>['Profile', 'Release']) {
155
        final String appFrameworkPath = path.join(
156 157 158 159
          outputPath,
          mode,
          'App.framework',
          'App',
160
        );
161

162
        await _checkFrameworkArchs(appFrameworkPath, mode);
163
        await _checkBitcode(appFrameworkPath, mode);
164

165
        final String aotSymbols = await dylibSymbols(appFrameworkPath);
166

167 168 169 170
        if (!aotSymbols.contains('_kDartVmSnapshot')) {
          throw TaskResult.failure('$mode App.framework missing Dart AOT');
        }

xster's avatar
xster committed
171 172 173 174 175 176 177
        checkFileNotExists(path.join(
          outputPath,
          mode,
          'App.framework',
          'flutter_assets',
          'vm_snapshot_data',
        ));
178 179 180 181 182

        checkFileExists(path.join(
          outputPath,
          mode,
          'App.xcframework',
183
          xcodeArmDirectoryName,
184 185 186 187 188 189 190 191 192 193 194 195
          'App.framework',
          'App',
        ));

        checkFileNotExists(path.join(
          outputPath,
          mode,
          'App.xcframework',
          'ios-x86_64-simulator',
          'App.framework',
          'App',
        ));
xster's avatar
xster committed
196 197 198 199
      }

      section("Check all modes' engine dylib");

200
      for (final String mode in <String>['Debug', 'Profile', 'Release']) {
201
        final String engineFrameworkPath = path.join(
xster's avatar
xster committed
202 203 204 205
          outputPath,
          mode,
          'Flutter.framework',
          'Flutter',
206 207 208
        );

        await _checkFrameworkArchs(engineFrameworkPath, mode);
209
        await _checkBitcode(engineFrameworkPath, mode);
210

211 212 213 214
        checkFileExists(path.join(
          outputPath,
          mode,
          'Flutter.xcframework',
215
          xcodeArmDirectoryName,
216 217 218
          'Flutter.framework',
          'Flutter',
        ));
219
        final String simulatorFrameworkPath = path.join(
220 221 222 223 224 225
          outputPath,
          mode,
          'Flutter.xcframework',
          'ios-x86_64-simulator',
          'Flutter.framework',
          'Flutter',
226 227 228 229 230 231
        );
        if (mode == 'Debug') {
          checkFileExists(simulatorFrameworkPath);
        } else {
          checkFileNotExists(simulatorFrameworkPath);
        }
xster's avatar
xster committed
232 233 234 235
      }

      section("Check all modes' engine header");

236
      for (final String mode in <String>['Debug', 'Profile', 'Release']) {
237
        checkFileExists(path.join(outputPath, mode, 'Flutter.framework', 'Headers', 'Flutter.h'));
xster's avatar
xster committed
238 239
      }

240
      section('Check all modes have plugins');
xster's avatar
xster committed
241

242
      for (final String mode in <String>['Debug', 'Profile', 'Release']) {
243
        final String pluginFrameworkPath = path.join(
xster's avatar
xster committed
244 245 246 247
          outputPath,
          mode,
          'device_info.framework',
          'device_info',
248 249
        );
        await _checkFrameworkArchs(pluginFrameworkPath, mode);
250
        await _checkBitcode(pluginFrameworkPath, mode);
251

252 253 254 255
        checkFileExists(path.join(
          outputPath,
          mode,
          'device_info.xcframework',
256
          xcodeArmDirectoryName,
257 258 259
          'device_info.framework',
          'device_info',
        ));
260 261 262 263 264

        checkFileExists(path.join(
          outputPath,
          mode,
          'device_info.xcframework',
265
          xcodeArmDirectoryName,
266 267 268 269 270
          'device_info.framework',
          'Headers',
          'DeviceInfoPlugin.h',
        ));

271
        final String simulatorFrameworkPath = path.join(
272 273 274 275 276 277
          outputPath,
          mode,
          'device_info.xcframework',
          'ios-x86_64-simulator',
          'device_info.framework',
          'device_info',
278
        );
279 280 281 282 283 284 285 286 287 288 289

        final String simulatorFrameworkHeaderPath = path.join(
          outputPath,
          mode,
          'device_info.xcframework',
          'ios-x86_64-simulator',
          'device_info.framework',
          'Headers',
          'DeviceInfoPlugin.h',
        );

290 291
        if (mode == 'Debug') {
          checkFileExists(simulatorFrameworkPath);
292
          checkFileExists(simulatorFrameworkHeaderPath);
293 294
        } else {
          checkFileNotExists(simulatorFrameworkPath);
295
          checkFileNotExists(simulatorFrameworkHeaderPath);
296
        }
xster's avatar
xster committed
297 298
      }

299
      section('Check all modes have generated plugin registrant');
xster's avatar
xster committed
300

301
      for (final String mode in <String>['Debug', 'Profile', 'Release']) {
302 303 304 305 306 307 308 309
        final String registrantFrameworkPath = path.join(
          outputPath,
          mode,
          'FlutterPluginRegistrant.framework',
          'FlutterPluginRegistrant'
        );

        await _checkFrameworkArchs(registrantFrameworkPath, mode);
310
        await _checkBitcode(registrantFrameworkPath, mode);
311

xster's avatar
xster committed
312 313 314 315 316 317 318
        checkFileExists(path.join(
          outputPath,
          mode,
          'FlutterPluginRegistrant.framework',
          'Headers',
          'GeneratedPluginRegistrant.h',
        ));
319 320 321 322
        checkFileExists(path.join(
          outputPath,
          mode,
          'FlutterPluginRegistrant.xcframework',
323
          xcodeArmDirectoryName,
324 325 326 327
          'FlutterPluginRegistrant.framework',
          'Headers',
          'GeneratedPluginRegistrant.h',
        ));
328
        final String simulatorHeaderPath = path.join(
329 330 331 332 333 334 335
          outputPath,
          mode,
          'FlutterPluginRegistrant.xcframework',
          'ios-x86_64-simulator',
          'FlutterPluginRegistrant.framework',
          'Headers',
          'GeneratedPluginRegistrant.h',
336 337 338 339 340 341
        );
        if (mode == 'Debug') {
          checkFileExists(simulatorHeaderPath);
        } else {
          checkFileNotExists(simulatorHeaderPath);
        }
xster's avatar
xster committed
342 343
      }

344 345 346 347 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 386 387 388 389 390 391 392 393
      // This builds all build modes' frameworks by default
      section('Build podspec');

      const String cocoapodsOutputDirectoryName = 'flutter-frameworks-cocoapods';

      await inDirectory(projectDir, () async {
        await flutter(
          'build',
          options: <String>[
            'ios-framework',
            '--cocoapods',
            '--force', // Allow podspec creation on master.
            '--output=$cocoapodsOutputDirectoryName'
          ],
        );
      });

      final String cocoapodsOutputPath = path.join(projectDir.path, cocoapodsOutputDirectoryName);
      for (final String mode in <String>['Debug', 'Profile', 'Release']) {
        checkFileExists(path.join(
          cocoapodsOutputPath,
          mode,
          'Flutter.podspec',
        ));

        checkDirectoryExists(path.join(
          cocoapodsOutputPath,
          mode,
          'App.framework',
        ));

        checkDirectoryExists(path.join(
          cocoapodsOutputPath,
          mode,
          'FlutterPluginRegistrant.framework',
        ));

        checkDirectoryExists(path.join(
          cocoapodsOutputPath,
          mode,
          'device_info.framework',
        ));

        checkDirectoryExists(path.join(
          cocoapodsOutputPath,
          mode,
          'package_info.framework',
        ));
      }

xster's avatar
xster committed
394 395 396 397 398 399 400 401 402 403
      return TaskResult.success(null);
    } on TaskResult catch (taskResult) {
      return taskResult;
    } catch (e) {
      return TaskResult.failure(e.toString());
    } finally {
      rmTree(tempDir);
    }
  });
}
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424

Future<void> _checkFrameworkArchs(String frameworkPath, String mode) async {
  checkFileExists(frameworkPath);

  final String archs = await fileType(frameworkPath);
  if (!archs.contains('armv7')) {
    throw TaskResult.failure('$mode $frameworkPath armv7 architecture missing');
  }

  if (!archs.contains('arm64')) {
    throw TaskResult.failure('$mode $frameworkPath arm64 architecture missing');
  }
  final bool containsSimulator = archs.contains('x86_64');
  final bool isDebug = mode == 'Debug';

  // Debug should contain the simulator archs.
  // Release and Profile should not.
  if (containsSimulator != isDebug) {
    throw TaskResult.failure('$mode $frameworkPath x86_64 architecture ${isDebug ? 'missing' : 'present'}');
  }
}
425 426 427 428 429 430 431 432 433

Future<void> _checkBitcode(String frameworkPath, String mode) async {
  checkFileExists(frameworkPath);

  // Bitcode only needed in Release mode for archiving.
  if (mode == 'Release' && !await containsBitcode(frameworkPath)) {
    throw TaskResult.failure('$frameworkPath does not contain bitcode');
  }
}