prepare_package.dart 27.7 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 'dart:async';
6
import 'dart:convert';
7
import 'dart:io' hide Platform;
8
import 'dart:typed_data';
9 10

import 'package:args/args.dart';
11 12
import 'package:crypto/crypto.dart';
import 'package:crypto/src/digest_sink.dart';
13
import 'package:http/http.dart' as http;
14
import 'package:path/path.dart' as path;
15
import 'package:platform/platform.dart' show Platform, LocalPlatform;
16
import 'package:process/process.dart';
17

18
const String chromiumRepo = 'https://chromium.googlesource.com/external/github.com/flutter/flutter';
19
const String githubRepo = 'https://github.com/flutter/flutter.git';
20
const String mingitForWindowsUrl = 'https://storage.googleapis.com/flutter_infra_release/mingit/'
21
    '603511c649b00bbef0a6122a827ac419b656bc19/mingit.zip';
22
const String oldGsBase = 'gs://flutter_infra';
23
const String releaseFolder = '/releases';
24 25 26 27 28
const String oldGsReleaseFolder = '$oldGsBase$releaseFolder';
const String oldBaseUrl = 'https://storage.googleapis.com/flutter_infra';
const String newGsBase = 'gs://flutter_infra_release';
const String newGsReleaseFolder = '$newGsBase$releaseFolder';
const String newBaseUrl = 'https://storage.googleapis.com/flutter_infra_release';
29

30
/// Exception class for when a process fails to run, so we can catch
31
/// it and provide something more readable than a stack trace.
32
class PreparePackageException implements Exception {
33
  PreparePackageException(this.message, [this.result]);
34

35
  final String message;
36 37
  final ProcessResult result;
  int get exitCode => result?.exitCode ?? -1;
38 39

  @override
40 41 42 43 44 45 46 47 48 49 50
  String toString() {
    String output = runtimeType.toString();
    if (message != null) {
      output += ': $message';
    }
    final String stderr = result?.stderr as String ?? '';
    if (stderr.isNotEmpty) {
      output += ':\n$stderr';
    }
    return output;
  }
51 52
}

53
enum Branch { dev, beta, stable }
54 55 56 57 58 59 60

String getBranchName(Branch branch) {
  switch (branch) {
    case Branch.beta:
      return 'beta';
    case Branch.dev:
      return 'dev';
61 62
    case Branch.stable:
      return 'stable';
63 64 65 66 67 68 69 70 71 72
  }
  return null;
}

Branch fromBranchName(String name) {
  switch (name) {
    case 'beta':
      return Branch.beta;
    case 'dev':
      return Branch.dev;
73 74
    case 'stable':
      return Branch.stable;
75
    default:
76
      throw ArgumentError('Invalid branch name.');
77 78 79
  }
}

80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
/// A helper class for classes that want to run a process, optionally have the
/// stderr and stdout reported as the process runs, and capture the stdout
/// properly without dropping any.
class ProcessRunner {
  ProcessRunner({
    ProcessManager processManager,
    this.subprocessOutput = true,
    this.defaultWorkingDirectory,
    this.platform = const LocalPlatform(),
  }) : processManager = processManager ?? const LocalProcessManager() {
    environment = Map<String, String>.from(platform.environment);
  }

  /// The platform to use for a starting environment.
  final Platform platform;

  /// Set [subprocessOutput] to show output as processes run. Stdout from the
  /// process will be printed to stdout, and stderr printed to stderr.
  final bool subprocessOutput;

  /// Set the [processManager] in order to inject a test instance to perform
  /// testing.
  final ProcessManager processManager;

  /// Sets the default directory used when `workingDirectory` is not specified
  /// to [runProcess].
  final Directory defaultWorkingDirectory;

  /// The environment to run processes with.
  Map<String, String> environment;

  /// Run the command and arguments in `commandLine` as a sub-process from
  /// `workingDirectory` if set, or the [defaultWorkingDirectory] if not. Uses
  /// [Directory.current] if [defaultWorkingDirectory] is not set.
  ///
  /// Set `failOk` if [runProcess] should not throw an exception when the
  /// command completes with a non-zero exit code.
  Future<String> runProcess(
    List<String> commandLine, {
    Directory workingDirectory,
    bool failOk = false,
  }) async {
    workingDirectory ??= defaultWorkingDirectory ?? Directory.current;
    if (subprocessOutput) {
      stderr.write('Running "${commandLine.join(' ')}" in ${workingDirectory.path}.\n');
    }
    final List<int> output = <int>[];
    final Completer<void> stdoutComplete = Completer<void>();
    final Completer<void> stderrComplete = Completer<void>();
    Process process;
    Future<int> allComplete() async {
      await stderrComplete.future;
      await stdoutComplete.future;
      return process.exitCode;
    }

    try {
      process = await processManager.start(
        commandLine,
        workingDirectory: workingDirectory.absolute.path,
        environment: environment,
      );
      process.stdout.listen(
        (List<int> event) {
          output.addAll(event);
          if (subprocessOutput) {
            stdout.add(event);
          }
        },
        onDone: () async => stdoutComplete.complete(),
      );
      if (subprocessOutput) {
        process.stderr.listen(
          (List<int> event) {
            stderr.add(event);
          },
          onDone: () async => stderrComplete.complete(),
        );
      } else {
        stderrComplete.complete();
      }
    } on ProcessException catch (e) {
      final String message = 'Running "${commandLine.join(' ')}" in ${workingDirectory.path} '
          'failed with:\n${e.toString()}';
      throw PreparePackageException(message);
    } on ArgumentError catch (e) {
      final String message = 'Running "${commandLine.join(' ')}" in ${workingDirectory.path} '
          'failed with:\n${e.toString()}';
      throw PreparePackageException(message);
    }

    final int exitCode = await allComplete();
    if (exitCode != 0 && !failOk) {
      final String message = 'Running "${commandLine.join(' ')}" in ${workingDirectory.path} failed';
      throw PreparePackageException(
        message,
        ProcessResult(0, exitCode, null, 'returned $exitCode'),
      );
    }
    return utf8.decoder.convert(output).trim();
  }
}

183
typedef HttpReader = Future<Uint8List> Function(Uri url, {Map<String, String> headers});
184

185 186
/// Creates a pre-populated Flutter archive from a git repo.
class ArchiveCreator {
187
  /// [tempDir] is the directory to use for creating the archive.  The script
188 189 190
  /// will place several GiB of data there, so it should have available space.
  ///
  /// The processManager argument is used to inject a mock of [ProcessManager] for
191
  /// testing purposes.
192 193 194
  ///
  /// If subprocessOutput is true, then output from processes invoked during
  /// archive creation is echoed to stderr and stdout.
195 196 197 198 199
  ArchiveCreator(
    this.tempDir,
    this.outputDir,
    this.revision,
    this.branch, {
200
    this.strict = true,
201
    ProcessManager processManager,
202 203
    bool subprocessOutput = true,
    this.platform = const LocalPlatform(),
204
    HttpReader httpReader,
205 206 207 208
  })  : assert(revision.length == 40),
        flutterRoot = Directory(path.join(tempDir.path, 'flutter')),
        httpReader = httpReader ?? http.readBytes,
        _processRunner = ProcessRunner(
209 210 211
          processManager: processManager,
          subprocessOutput: subprocessOutput,
          platform: platform,
212
        ) {
213
    _flutter = path.join(
214
      flutterRoot.absolute.path,
215
      'bin',
216
      'flutter',
217
    );
218
    _processRunner.environment['PUB_CACHE'] = path.join(flutterRoot.absolute.path, '.pub-cache');
219 220
  }

221 222
  /// The platform to use for the environment and determining which
  /// platform we're running on.
223
  final Platform platform;
224 225

  /// The branch to build the archive for.  The branch must contain [revision].
226
  final Branch branch;
227 228 229 230 231

  /// The git revision hash to build the archive for. This revision has
  /// to be available in the [branch], although it doesn't have to be
  /// at HEAD, since we clone the branch and then reset to this revision
  /// to create the archive.
232
  final String revision;
233 234

  /// The flutter root directory in the [tempDir].
235
  final Directory flutterRoot;
236 237

  /// The temporary directory used to build the archive in.
238
  final Directory tempDir;
239 240

  /// The directory to write the output file to.
241
  final Directory outputDir;
242

243 244 245 246 247
  /// True if the creator should be strict about checking requirements or not.
  ///
  /// In strict mode, will insist that the [revision] be a tagged revision.
  final bool strict;

248
  final Uri _minGitUri = Uri.parse(mingitForWindowsUrl);
249 250
  final ProcessRunner _processRunner;

251 252 253 254 255
  /// Used to tell the [ArchiveCreator] which function to use for reading
  /// bytes from a URL. Used in tests to inject a fake reader. Defaults to
  /// [http.readBytes].
  final HttpReader httpReader;

256 257 258 259 260 261
  File _outputFile;
  String _version;
  String _flutter;

  /// Get the name of the channel as a string.
  String get branchName => getBranchName(branch);
262 263 264

  /// Returns a default archive name when given a Git revision.
  /// Used when an output filename is not given.
265 266
  String get _archiveName {
    final String os = platform.operatingSystem.toLowerCase();
267 268 269 270 271 272 273 274
    // We don't use .tar.xz on Mac because although it can unpack them
    // on the command line (with tar), the "Archive Utility" that runs
    // when you double-click on them just does some crazy behavior (it
    // converts it to a compressed cpio archive, and when you double
    // click on that, it converts it back to .tar.xz, without ever
    // unpacking it!) So, we use .zip for Mac, and the files are about
    // 220MB larger than they need to be. :-(
    final String suffix = platform.isLinux ? 'tar.xz' : 'zip';
275 276 277 278 279 280 281 282 283 284
    return 'flutter_${os}_$_version-$branchName.$suffix';
  }

  /// Checks out the flutter repo and prepares it for other operations.
  ///
  /// Returns the version for this release, as obtained from the git tags.
  Future<String> initializeRepo() async {
    await _checkoutFlutter();
    _version = await _getVersion();
    return _version;
285 286
  }

287
  /// Performs all of the steps needed to create an archive.
288 289
  Future<File> createArchive() async {
    assert(_version != null, 'Must run initializeRepo before createArchive');
290
    _outputFile = File(path.join(outputDir.absolute.path, _archiveName));
291 292
    await _installMinGitIfNeeded();
    await _populateCaches();
293 294 295 296
    await _archiveFiles(_outputFile);
    return _outputFile;
  }

297 298 299 300 301 302 303 304 305
  /// Returns the version number of this release, according the to tags in the
  /// repo.
  ///
  /// This looks for the tag attached to [revision] and, if it doesn't find one,
  /// git will give an error.
  ///
  /// If [strict] is true, the exact [revision] must be tagged to return the
  /// version.  If [strict] is not true, will look backwards in time starting at
  /// [revision] to find the most recent version tag.
306
  Future<String> _getVersion() async {
307 308 309
    if (strict) {
      try {
        return _runGit(<String>['describe', '--tags', '--exact-match', revision]);
310
      } on PreparePackageException catch (exception) {
311
        throw PreparePackageException(
312 313 314 315
          'Git error when checking for a version tag attached to revision $revision.\n'
          'Perhaps there is no tag at that revision?:\n'
          '$exception'
        );
316 317 318 319
      }
    } else {
      return _runGit(<String>['describe', '--tags', '--abbrev=0', revision]);
    }
320
  }
321 322 323

  /// Clone the Flutter repo and make sure that the git environment is sane
  /// for when the user will unpack it.
324
  Future<void> _checkoutFlutter() async {
325 326
    // We want the user to start out the in the specified branch instead of a
    // detached head. To do that, we need to make sure the branch points at the
327
    // desired revision.
328
    await _runGit(<String>['clone', '-b', branchName, chromiumRepo], workingDirectory: tempDir);
329
    await _runGit(<String>['reset', '--hard', revision]);
330 331

    // Make the origin point to github instead of the chromium mirror.
332
    await _runGit(<String>['remote', 'set-url', 'origin', githubRepo]);
333 334 335
  }

  /// Retrieve the MinGit executable from storage and unpack it.
336
  Future<void> _installMinGitIfNeeded() async {
337
    if (!platform.isWindows) {
338 339
      return;
    }
340
    final Uint8List data = await httpReader(_minGitUri);
341
    final File gitFile = File(path.join(tempDir.absolute.path, 'mingit.zip'));
342 343
    await gitFile.writeAsBytes(data, flush: true);

344
    final Directory minGitPath = Directory(path.join(flutterRoot.absolute.path, 'bin', 'mingit'));
345
    await minGitPath.create(recursive: true);
346
    await _unzipArchive(gitFile, workingDirectory: minGitPath);
347 348 349
  }

  /// Prepare the archive repo so that it has all of the caches warmed up and
350
  /// is configured for the user to begin working.
351
  Future<void> _populateCaches() async {
352 353 354 355 356 357
    await _runFlutter(<String>['doctor']);
    await _runFlutter(<String>['update-packages']);
    await _runFlutter(<String>['precache']);
    await _runFlutter(<String>['ide-config']);

    // Create each of the templates, since they will call 'pub get' on
358 359
    // themselves when created, and this will warm the cache with their
    // dependencies too.
360
    for (final String template in <String>['app', 'package', 'plugin']) {
361
      final String createName = path.join(tempDir.path, 'create_$template');
362
      await _runFlutter(
363
        <String>['create', '--template=$template', createName],
364 365 366
        // Run it outside the cloned Flutter repo to not nest git repos, since
        // they'll be git repos themselves too.
        workingDirectory: tempDir,
367 368 369 370 371 372
      );
    }

    // Yes, we could just skip all .packages files when constructing
    // the archive, but some are checked in, and we don't want to skip
    // those.
373
    await _runGit(<String>['clean', '-f', '-X', '**/.packages']);
374 375
    /// Remove package_config files and any contents in .dart_tool
    await _runGit(<String>['clean', '-f', '-X', '**/.dart_tool']);
376 377 378 379 380 381
    /// Remove git subfolder from .pub-cache, this contains the flutter goldens
    /// and new flutter_gallery.
    final Directory gitCache = Directory(path.join(flutterRoot.absolute.path, '.pub-cache', 'git'));
    if (gitCache.existsSync()) {
      gitCache.deleteSync(recursive: true);
    }
382 383
  }

384
  /// Write the archive to the given output file.
385
  Future<void> _archiveFiles(File outputFile) async {
386
    if (outputFile.path.toLowerCase().endsWith('.zip')) {
387
      await _createZipArchive(outputFile, flutterRoot);
388
    } else if (outputFile.path.toLowerCase().endsWith('.tar.xz')) {
389
      await _createTarArchive(outputFile, flutterRoot);
390 391 392
    }
  }

393 394 395
  Future<String> _runFlutter(List<String> args, {Directory workingDirectory}) {
    return _processRunner.runProcess(
      <String>[_flutter, ...args],
396 397
      workingDirectory: workingDirectory ?? flutterRoot,
    );
398
  }
399

400
  Future<String> _runGit(List<String> args, {Directory workingDirectory}) {
401 402 403 404
    return _processRunner.runProcess(
      <String>['git', ...args],
      workingDirectory: workingDirectory ?? flutterRoot,
    );
405 406
  }

407 408
  /// Unpacks the given zip file into the currentDirectory (if set), or the
  /// same directory as the archive.
409
  Future<String> _unzipArchive(File archive, {Directory workingDirectory}) {
410
    workingDirectory ??= Directory(path.dirname(archive.absolute.path));
411 412 413 414 415 416 417 418 419 420 421 422 423
    List<String> commandLine;
    if (platform.isWindows) {
      commandLine = <String>[
        '7za',
        'x',
        archive.absolute.path,
      ];
    } else {
      commandLine = <String>[
        'unzip',
        archive.absolute.path,
      ];
    }
424
    return _processRunner.runProcess(commandLine, workingDirectory: workingDirectory);
425 426
  }

427
  /// Create a zip archive from the directory source.
428
  Future<String> _createZipArchive(File output, Directory source) async {
429 430
    List<String> commandLine;
    if (platform.isWindows) {
431
      // Unhide the .git folder, https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/attrib.
432
      await _processRunner.runProcess(
433 434 435
        <String>['attrib', '-h', '.git'],
        workingDirectory: Directory(source.absolute.path),
      );
436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452
      commandLine = <String>[
        '7za',
        'a',
        '-tzip',
        '-mx=9',
        output.absolute.path,
        path.basename(source.path),
      ];
    } else {
      commandLine = <String>[
        'zip',
        '-r',
        '-9',
        output.absolute.path,
        path.basename(source.path),
      ];
    }
453
    return _processRunner.runProcess(
454
      commandLine,
455
      workingDirectory: Directory(path.dirname(source.absolute.path)),
456
    );
457 458
  }

459
  /// Create a tar archive from the directory source.
460 461 462 463 464 465 466
  Future<String> _createTarArchive(File output, Directory source) {
    return _processRunner.runProcess(<String>[
      'tar',
      'cJf',
      output.absolute.path,
      path.basename(source.absolute.path),
    ], workingDirectory: Directory(path.dirname(source.absolute.path)));
467
  }
468
}
469

470 471 472 473 474 475
class ArchivePublisher {
  ArchivePublisher(
    this.tempDir,
    this.revision,
    this.branch,
    this.version,
476 477
    this.outputFile,
    this.dryRun, {
478
    ProcessManager processManager,
479 480
    bool subprocessOutput = true,
    this.platform = const LocalPlatform(),
481 482
  })  : assert(revision.length == 40),
        platformName = platform.operatingSystem.toLowerCase(),
483
        metadataGsPath = '$newGsReleaseFolder/${getMetadataFilename(platform)}',
484 485
        _processRunner = ProcessRunner(
          processManager: processManager,
486
          subprocessOutput: subprocessOutput,
487
        );
488 489 490 491 492 493 494 495 496 497

  final Platform platform;
  final String platformName;
  final String metadataGsPath;
  final Branch branch;
  final String revision;
  final String version;
  final Directory tempDir;
  final File outputFile;
  final ProcessRunner _processRunner;
498
  final bool dryRun;
499
  String get branchName => getBranchName(branch);
500 501
  String get destinationArchivePath => '$branchName/$platformName/${path.basename(outputFile.path)}';
  static String getMetadataFilename(Platform platform) => 'releases_${platform.operatingSystem.toLowerCase()}.json';
502

503 504 505 506 507 508 509 510 511 512 513 514
  Future<String> _getChecksum(File archiveFile) async {
    final DigestSink digestSink = DigestSink();
    final ByteConversionSink sink = sha256.startChunkedConversion(digestSink);

    final Stream<List<int>> stream = archiveFile.openRead();
    await stream.forEach((List<int> chunk) {
      sink.add(chunk);
    });
    sink.close();
    return digestSink.value.toString();
  }

515
  /// Publish the archive to Google Storage.
516 517 518 519
  ///
  /// This method will throw if the target archive already exists on cloud
  /// storage.
  Future<void> publishArchive([bool forceUpload = false]) async {
520 521 522 523 524 525 526 527
    for (final String releaseFolder in <String>[oldGsReleaseFolder, newGsReleaseFolder]) {
      final String destGsPath = '$releaseFolder/$destinationArchivePath';
      if (!forceUpload) {
        if (await _cloudPathExists(destGsPath) && !dryRun) {
          throw PreparePackageException(
            'File $destGsPath already exists on cloud storage!',
          );
        }
528
      }
529 530 531
      await _cloudCopy(outputFile.absolute.path, destGsPath);
      assert(tempDir.existsSync());
      await _updateMetadata('$releaseFolder/${getMetadataFilename(platform)}', newBucket: false);
532
    }
533 534
  }

535 536 537
  Future<Map<String, dynamic>> _addRelease(Map<String, dynamic> jsonData, {bool newBucket=true}) async {
    final String tmpBaseUrl = newBucket ? newBaseUrl : oldBaseUrl;
    jsonData['base_url'] = '$tmpBaseUrl$releaseFolder';
538 539 540 541 542 543 544 545 546 547 548 549
    if (!jsonData.containsKey('current_release')) {
      jsonData['current_release'] = <String, String>{};
    }
    jsonData['current_release'][branchName] = revision;
    if (!jsonData.containsKey('releases')) {
      jsonData['releases'] = <Map<String, dynamic>>[];
    }

    final Map<String, dynamic> newEntry = <String, dynamic>{};
    newEntry['hash'] = revision;
    newEntry['channel'] = branchName;
    newEntry['version'] = version;
550
    newEntry['release_date'] = DateTime.now().toUtc().toIso8601String();
551
    newEntry['archive'] = destinationArchivePath;
552
    newEntry['sha256'] = await _getChecksum(outputFile);
553 554

    // Search for any entries with the same hash and channel and remove them.
555
    final List<dynamic> releases = jsonData['releases'] as List<dynamic>;
556
    jsonData['releases'] = <Map<String, dynamic>>[
557
      for (final Map<String, dynamic> entry in releases.cast<Map<String, dynamic>>())
558 559 560 561
        if (entry['hash'] != newEntry['hash'] || entry['channel'] != newEntry['channel'])
          entry,
      newEntry,
    ]..sort((Map<String, dynamic> a, Map<String, dynamic> b) {
562 563
      final DateTime aDate = DateTime.parse(a['release_date'] as String);
      final DateTime bDate = DateTime.parse(b['release_date'] as String);
564 565 566 567 568
      return bDate.compareTo(aDate);
    });
    return jsonData;
  }

569
  Future<void> _updateMetadata(String gsPath, {bool newBucket=true}) async {
570 571 572 573
    // We can't just cat the metadata from the server with 'gsutil cat', because
    // Windows wants to echo the commands that execute in gsutil.bat to the
    // stdout when we do that. So, we copy the file locally and then read it
    // back in.
574
    final File metadataFile = File(
575 576
      path.join(tempDir.absolute.path, getMetadataFilename(platform)),
    );
577 578 579 580 581 582
    await _runGsUtil(<String>['cp', gsPath, metadataFile.absolute.path]);
    if (!dryRun) {
      final String currentMetadata = metadataFile.readAsStringSync();
      if (currentMetadata.isEmpty) {
        throw PreparePackageException('Empty metadata received from server');
      }
583

584 585 586 587 588 589
      Map<String, dynamic> jsonData;
      try {
        jsonData = json.decode(currentMetadata) as Map<String, dynamic>;
      } on FormatException catch (e) {
        throw PreparePackageException('Unable to parse JSON metadata received from cloud: $e');
      }
590

591
      jsonData = await _addRelease(jsonData, newBucket: newBucket);
592

593 594 595 596
      const JsonEncoder encoder = JsonEncoder.withIndent('  ');
      metadataFile.writeAsStringSync(encoder.convert(jsonData));
    }
    await _cloudCopy(metadataFile.absolute.path, gsPath);
597 598
  }

599 600 601
  Future<String> _runGsUtil(
    List<String> args, {
    Directory workingDirectory,
602
    bool failOk = false,
603
  }) async {
604 605 606 607
    if (dryRun) {
      print('gsutil.py -- $args');
      return '';
    }
608
    if (platform.isWindows) {
609 610
      return _processRunner.runProcess(
        <String>['python', path.join(platform.environment['DEPOT_TOOLS'], 'gsutil.py'), '--', ...args],
611 612 613 614 615
        workingDirectory: workingDirectory,
        failOk: failOk,
      );
    }

616
    return _processRunner.runProcess(
617
      <String>['gsutil.py', '--', ...args],
618 619 620 621 622
      workingDirectory: workingDirectory,
      failOk: failOk,
    );
  }

623 624 625 626 627 628 629 630 631 632 633 634 635 636
  /// Determine if a file exists at a given [cloudPath].
  Future<bool> _cloudPathExists(String cloudPath) async {
    try {
      await _runGsUtil(
        <String>['stat', cloudPath],
        failOk: false,
      );
    } on PreparePackageException {
      // `gsutil stat gs://path/to/file` will exit with 1 if file does not exist
      return false;
    }
    return true;
  }

637
  Future<String> _cloudCopy(String src, String dest) async {
638 639
    // We often don't have permission to overwrite, but
    // we have permission to remove, so that's what we do.
640
    await _runGsUtil(<String>['rm', dest], failOk: true);
641 642 643 644 645 646 647 648 649 650
    String mimeType;
    if (dest.endsWith('.tar.xz')) {
      mimeType = 'application/x-gtar';
    }
    if (dest.endsWith('.zip')) {
      mimeType = 'application/zip';
    }
    if (dest.endsWith('.json')) {
      mimeType = 'application/json';
    }
651 652 653 654 655 656 657 658
    return await _runGsUtil(<String>[
      // Use our preferred MIME type for the files we care about
      // and let gsutil figure it out for anything else.
      if (mimeType != null) ...<String>['-h', 'Content-Type:$mimeType'],
      'cp',
      src,
      dest,
    ]);
659 660 661 662 663 664 665
  }
}

/// Prepares a flutter git repo to be packaged up for distribution.
/// It mainly serves to populate the .pub-cache with any appropriate Dart
/// packages, and the flutter cache in bin/cache with the appropriate
/// dependencies and snapshots.
666
///
Ian Hickson's avatar
Ian Hickson committed
667 668
/// Archives contain the executables and customizations for the platform that
/// they are created on.
Ian Hickson's avatar
Ian Hickson committed
669
Future<void> main(List<String> rawArguments) async {
670
  final ArgParser argParser = ArgParser();
671 672 673 674 675
  argParser.addOption(
    'temp_dir',
    defaultsTo: null,
    help: 'A location where temporary files may be written. Defaults to a '
        'directory in the system temp folder. Will write a few GiB of data, '
676 677 678
        'so it should have sufficient free space. If a temp_dir is not '
        'specified, then the default temp_dir will be created, used, and '
        'removed automatically.',
679
  );
680 681 682 683
  argParser.addOption('revision',
      defaultsTo: null,
      help: 'The Flutter git repo revision to build the '
          'archive with. Must be the full 40-character hash. Required.');
684
  argParser.addOption(
685 686
    'branch',
    defaultsTo: null,
687
    allowed: Branch.values.map<String>((Branch branch) => getBranchName(branch)),
688
    help: 'The Flutter branch to build the archive with. Required.',
689 690 691 692
  );
  argParser.addOption(
    'output',
    defaultsTo: null,
693 694 695 696 697 698 699 700
    help: 'The path to the directory where the output archive should be '
        'written. If --output is not specified, the archive will be written to '
        "the current directory. If the output directory doesn't exist, it, and "
        'the path to it, will be created.',
  );
  argParser.addFlag(
    'publish',
    defaultsTo: false,
701 702
    help: 'If set, will publish the archive to Google Cloud Storage upon '
        'successful creation of the archive. Will publish under this '
703
        'directory: $newBaseUrl$releaseFolder',
704
  );
705 706 707 708 709 710
  argParser.addFlag(
    'force',
    abbr: 'f',
    defaultsTo: false,
    help: 'Overwrite a previously uploaded package.',
  );
711 712 713 714 715 716
  argParser.addFlag(
    'dry_run',
    defaultsTo: false,
    negatable: false,
    help: 'Prints gsutil commands instead of executing them.',
  );
717 718 719 720 721
  argParser.addFlag(
    'help',
    defaultsTo: false,
    negatable: false,
    help: 'Print help for this command.',
722
  );
723

Ian Hickson's avatar
Ian Hickson committed
724
  final ArgResults parsedArguments = argParser.parse(rawArguments);
725

726
  if (parsedArguments['help'] as bool) {
727 728 729 730
    print(argParser.usage);
    exit(0);
  }

731 732 733 734 735 736
  void errorExit(String message, {int exitCode = -1}) {
    stderr.write('Error: $message\n\n');
    stderr.write('${argParser.usage}\n');
    exit(exitCode);
  }

737
  final String revision = parsedArguments['revision'] as String;
738
  if (!parsedArguments.wasParsed('revision')) {
739 740
    errorExit('Invalid argument: --revision must be specified.');
  }
741 742 743 744
  if (revision.length != 40) {
    errorExit('Invalid argument: --revision must be the entire hash, not just a prefix.');
  }

745
  if (!parsedArguments.wasParsed('branch')) {
746 747
    errorExit('Invalid argument: --branch must be specified.');
  }
748

749
  final String tempDirArg = parsedArguments['temp_dir'] as String;
750
  Directory tempDir;
751
  bool removeTempDir = false;
752
  if (tempDirArg == null || tempDirArg.isEmpty) {
753
    tempDir = Directory.systemTemp.createTempSync('flutter_package.');
754 755
    removeTempDir = true;
  } else {
756
    tempDir = Directory(tempDirArg);
757
    if (!tempDir.existsSync()) {
758
      errorExit("Temporary directory $tempDirArg doesn't exist.");
759 760 761
    }
  }

762
  Directory outputDir;
Ian Hickson's avatar
Ian Hickson committed
763
  if (parsedArguments['output'] == null) {
764
    outputDir = tempDir;
765
  } else {
766
    outputDir = Directory(parsedArguments['output'] as String);
767 768
    if (!outputDir.existsSync()) {
      outputDir.createSync(recursive: true);
769
    }
770 771
  }

772
  final Branch branch = fromBranchName(parsedArguments['branch'] as String);
773
  final ArchiveCreator creator = ArchiveCreator(tempDir, outputDir, revision, branch, strict: parsedArguments['publish'] as bool);
774 775 776
  int exitCode = 0;
  String message;
  try {
777 778
    final String version = await creator.initializeRepo();
    final File outputFile = await creator.createArchive();
779
    if (parsedArguments['publish'] as bool) {
780
      final ArchivePublisher publisher = ArchivePublisher(
781 782 783 784 785
        tempDir,
        revision,
        branch,
        version,
        outputFile,
786
	parsedArguments['dry_run'] as bool,
787
      );
788
      await publisher.publishArchive(parsedArguments['force'] as bool);
789
    }
790
  } on PreparePackageException catch (e) {
791
    exitCode = e.exitCode;
792 793
    message = e.message;
  } catch (e) {
794
    exitCode = -1;
795
    message = e.toString();
796 797
  } finally {
    if (removeTempDir) {
798
      tempDir.deleteSync(recursive: true);
799 800 801 802 803 804 805
    }
    if (exitCode != 0) {
      errorExit(message, exitCode: exitCode);
    }
    exit(0);
  }
}