build_ios_framework_module_test.dart 11.7 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 8
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'dart:async';
import 'dart:io';

import 'package:flutter_devicelab/framework/framework.dart';
9
import 'package:flutter_devicelab/framework/ios.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 117 118 119
      checkFileExists(path.join(
        outputPath,
        'Debug',
        'App.xcframework',
        'ios-armv7_arm64',
        'App.framework',
        'App',
      ));
120

121 122 123 124 125 126 127 128
      checkFileExists(path.join(
        outputPath,
        'Debug',
        'App.xcframework',
        'ios-x86_64-simulator',
        'App.framework',
        'App',
      ));
129

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

132
      for (final String mode in <String>['Profile', 'Release']) {
133
        final String appFrameworkPath = path.join(
134 135 136 137
          outputPath,
          mode,
          'App.framework',
          'App',
138
        );
139

140
        await _checkFrameworkArchs(appFrameworkPath, mode);
141
        await _checkBitcode(appFrameworkPath, mode);
142

143
        final String aotSymbols = await dylibSymbols(appFrameworkPath);
144

145 146 147 148
        if (!aotSymbols.contains('_kDartVmSnapshot')) {
          throw TaskResult.failure('$mode App.framework missing Dart AOT');
        }

xster's avatar
xster committed
149 150 151 152 153 154 155
        checkFileNotExists(path.join(
          outputPath,
          mode,
          'App.framework',
          'flutter_assets',
          'vm_snapshot_data',
        ));
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173

        checkFileExists(path.join(
          outputPath,
          mode,
          'App.xcframework',
          'ios-armv7_arm64',
          'App.framework',
          'App',
        ));

        checkFileNotExists(path.join(
          outputPath,
          mode,
          'App.xcframework',
          'ios-x86_64-simulator',
          'App.framework',
          'App',
        ));
xster's avatar
xster committed
174 175 176 177
      }

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

178
      for (final String mode in <String>['Debug', 'Profile', 'Release']) {
179
        final String engineFrameworkPath = path.join(
xster's avatar
xster committed
180 181 182 183
          outputPath,
          mode,
          'Flutter.framework',
          'Flutter',
184 185 186
        );

        await _checkFrameworkArchs(engineFrameworkPath, mode);
187
        await _checkBitcode(engineFrameworkPath, mode);
188

189 190 191 192 193 194 195 196
        checkFileExists(path.join(
          outputPath,
          mode,
          'Flutter.xcframework',
          'ios-armv7_arm64',
          'Flutter.framework',
          'Flutter',
        ));
197
        final String simulatorFrameworkPath = path.join(
198 199 200 201 202 203
          outputPath,
          mode,
          'Flutter.xcframework',
          'ios-x86_64-simulator',
          'Flutter.framework',
          'Flutter',
204 205 206 207 208 209
        );
        if (mode == 'Debug') {
          checkFileExists(simulatorFrameworkPath);
        } else {
          checkFileNotExists(simulatorFrameworkPath);
        }
xster's avatar
xster committed
210 211 212 213
      }

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

214
      for (final String mode in <String>['Debug', 'Profile', 'Release']) {
xster's avatar
xster committed
215 216 217 218 219 220
        checkFileContains(
          <String>['#include "FlutterEngine.h"'],
          path.join(outputPath, mode, 'Flutter.framework', 'Headers', 'Flutter.h'),
        );
      }

221
      section('Check all modes have plugins');
xster's avatar
xster committed
222

223
      for (final String mode in <String>['Debug', 'Profile', 'Release']) {
224
        final String pluginFrameworkPath = path.join(
xster's avatar
xster committed
225 226 227 228
          outputPath,
          mode,
          'device_info.framework',
          'device_info',
229 230
        );
        await _checkFrameworkArchs(pluginFrameworkPath, mode);
231
        await _checkBitcode(pluginFrameworkPath, mode);
232

233 234 235 236 237 238 239 240
        checkFileExists(path.join(
          outputPath,
          mode,
          'device_info.xcframework',
          'ios-armv7_arm64',
          'device_info.framework',
          'device_info',
        ));
241 242 243 244 245 246 247 248 249 250 251

        checkFileExists(path.join(
          outputPath,
          mode,
          'device_info.xcframework',
          'ios-armv7_arm64',
          'device_info.framework',
          'Headers',
          'DeviceInfoPlugin.h',
        ));

252
        final String simulatorFrameworkPath = path.join(
253 254 255 256 257 258
          outputPath,
          mode,
          'device_info.xcframework',
          'ios-x86_64-simulator',
          'device_info.framework',
          'device_info',
259
        );
260 261 262 263 264 265 266 267 268 269 270

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

271 272
        if (mode == 'Debug') {
          checkFileExists(simulatorFrameworkPath);
273
          checkFileExists(simulatorFrameworkHeaderPath);
274 275
        } else {
          checkFileNotExists(simulatorFrameworkPath);
276
          checkFileNotExists(simulatorFrameworkHeaderPath);
277
        }
xster's avatar
xster committed
278 279
      }

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

282
      for (final String mode in <String>['Debug', 'Profile', 'Release']) {
283 284 285 286 287 288 289 290
        final String registrantFrameworkPath = path.join(
          outputPath,
          mode,
          'FlutterPluginRegistrant.framework',
          'FlutterPluginRegistrant'
        );

        await _checkFrameworkArchs(registrantFrameworkPath, mode);
291
        await _checkBitcode(registrantFrameworkPath, mode);
292

xster's avatar
xster committed
293 294 295 296 297 298 299
        checkFileExists(path.join(
          outputPath,
          mode,
          'FlutterPluginRegistrant.framework',
          'Headers',
          'GeneratedPluginRegistrant.h',
        ));
300 301 302 303 304 305 306 307 308
        checkFileExists(path.join(
          outputPath,
          mode,
          'FlutterPluginRegistrant.xcframework',
          'ios-armv7_arm64',
          'FlutterPluginRegistrant.framework',
          'Headers',
          'GeneratedPluginRegistrant.h',
        ));
309
        final String simulatorHeaderPath = path.join(
310 311 312 313 314 315 316
          outputPath,
          mode,
          'FlutterPluginRegistrant.xcframework',
          'ios-x86_64-simulator',
          'FlutterPluginRegistrant.framework',
          'Headers',
          'GeneratedPluginRegistrant.h',
317 318 319 320 321 322
        );
        if (mode == 'Debug') {
          checkFileExists(simulatorHeaderPath);
        } else {
          checkFileNotExists(simulatorHeaderPath);
        }
xster's avatar
xster committed
323 324
      }

325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 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
      // 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
375 376 377 378 379 380 381 382 383 384
      return TaskResult.success(null);
    } on TaskResult catch (taskResult) {
      return taskResult;
    } catch (e) {
      return TaskResult.failure(e.toString());
    } finally {
      rmTree(tempDir);
    }
  });
}
385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405

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'}');
  }
}
406 407 408 409 410 411 412 413 414

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');
  }
}