prepare_package_test.dart 21.2 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 6
import 'dart:convert';
import 'dart:io' hide Platform;
7
import 'dart:typed_data';
8 9

import 'package:path/path.dart' as path;
10
import 'package:platform/platform.dart' show FakePlatform;
11

12
import '../../../packages/flutter_tools/test/src/fake_process_manager.dart';
13
import '../prepare_package.dart';
14
import 'common.dart';
15 16

void main() {
17
  const String testRef = 'deadbeefdeadbeefdeadbeefdeadbeefdeadbeef';
18 19 20
  test('Throws on missing executable', () async {
    // Uses a *real* process manager, since we want to know what happens if
    // it can't find an executable.
21
    final ProcessRunner processRunner = ProcessRunner(subprocessOutput: false);
22 23 24 25
    expect(
        expectAsync1((List<String> commandLine) async {
          return processRunner.runProcess(commandLine);
        })(<String>['this_executable_better_not_exist_2857632534321']),
26
        throwsA(isA<PreparePackageException>()));
27 28
    try {
      await processRunner.runProcess(<String>['this_executable_better_not_exist_2857632534321']);
29
    } on PreparePackageException catch (e) {
30 31
      expect(
        e.message,
32
        contains('Invalid argument(s): Failed to resolve this_executable_better_not_exist_2857632534321 to an executable.'),
33 34 35
      );
    }
  });
36
  for (final String platformName in <String>['macos', 'linux', 'windows']) {
37
    final FakePlatform platform = FakePlatform(
38
      operatingSystem: platformName,
39 40 41
      environment: <String, String>{
        'DEPOT_TOOLS': path.join('D:', 'depot_tools'),
      },
42
    );
43 44
    group('ProcessRunner for $platform', () {
      test('Returns stdout', () async {
45 46 47 48 49 50 51
        final FakeProcessManager fakeProcessManager = FakeProcessManager.list(<FakeCommand>[
          const FakeCommand(
            command: <String>['echo', 'test',],
            stdout: 'output',
            stderr: 'error',
          )
        ]);
52
        final ProcessRunner processRunner = ProcessRunner(
53 54
            subprocessOutput: false, platform: platform, processManager: fakeProcessManager);
        final String output = await processRunner.runProcess(<String>['echo', 'test']);
55 56 57
        expect(output, equals('output'));
      });
      test('Throws on process failure', () async {
58 59 60 61 62 63 64 65
        final FakeProcessManager fakeProcessManager = FakeProcessManager.list(<FakeCommand>[
          const FakeCommand(
            command: <String>['echo', 'test',],
            stdout: 'output',
            stderr: 'error',
            exitCode: -1,
          )
        ]);
66
        final ProcessRunner processRunner = ProcessRunner(
67
            subprocessOutput: false, platform: platform, processManager: fakeProcessManager);
68 69 70 71
        expect(
            expectAsync1((List<String> commandLine) async {
              return processRunner.runProcess(commandLine);
            })(<String>['echo', 'test']),
72
            throwsA(isA<PreparePackageException>()));
73 74
      });
    });
75 76
    group('ArchiveCreator for $platformName', () {
      ArchiveCreator creator;
77
      Directory tempDir;
78
      Directory flutterDir;
79
      Directory cacheDir;
80 81 82 83 84
      FakeProcessManager processManager;
      final List<List<String>> args = <List<String>>[];
      final List<Map<Symbol, dynamic>> namedArgs = <Map<Symbol, dynamic>>[];
      String flutter;

85
      Future<Uint8List> fakeHttpReader(Uri url, {Map<String, String> headers}) {
86
        return Future<Uint8List>.value(Uint8List(0));
87 88
      }

89
      setUp(() async {
90
        processManager = FakeProcessManager.list(<FakeCommand>[]);
91 92
        args.clear();
        namedArgs.clear();
93
        tempDir = Directory.systemTemp.createTempSync('flutter_prepage_package_test.');
94
        flutterDir = Directory(path.join(tempDir.path, 'flutter'));
95
        flutterDir.createSync(recursive: true);
96 97
        cacheDir = Directory(path.join(flutterDir.path, 'bin', 'cache'));
        cacheDir.createSync(recursive: true);
98
        creator = ArchiveCreator(
99 100
          tempDir,
          tempDir,
101 102 103 104 105
          testRef,
          Branch.dev,
          processManager: processManager,
          subprocessOutput: false,
          platform: platform,
106
          httpReader: fakeHttpReader,
107 108 109 110 111
        );
        flutter = path.join(creator.flutterRoot.absolute.path, 'bin', 'flutter');
      });

      tearDown(() async {
112
        tryToDelete(tempDir);
113 114 115
      });

      test('sets PUB_CACHE properly', () async {
116
        final String createBase = path.join(tempDir.absolute.path, 'create_');
117 118
        final String archiveName = path.join(tempDir.absolute.path,
            'flutter_${platformName}_v1.2.3-dev${platform.isLinux ? '.tar.xz' : '.zip'}');
119 120

        processManager.addCommands(convertResults(<String, List<ProcessResult>>{
121
          'git clone -b dev https://chromium.googlesource.com/external/github.com/flutter/flutter': null,
122
          'git reset --hard $testRef': null,
123
          'git remote set-url origin https://github.com/flutter/flutter.git': null,
124
          'git describe --tags --exact-match $testRef': <ProcessResult>[ProcessResult(0, 0, 'v1.2.3', '')],
125
          if (platform.isWindows) '7za x ${path.join(tempDir.path, 'mingit.zip')}': null,
126 127 128 129 130 131 132
          '$flutter doctor': null,
          '$flutter update-packages': null,
          '$flutter precache': null,
          '$flutter ide-config': null,
          '$flutter create --template=app ${createBase}app': null,
          '$flutter create --template=package ${createBase}package': null,
          '$flutter create --template=plugin ${createBase}plugin': null,
133 134
          'git clean -f -x -- **/.packages': null,
          'git clean -f -x -- **/.dart_tool/': null,
135
          if (platform.isWindows) 'attrib -h .git': null,
136
          if (platform.isWindows) '7za a -tzip -mx=9 $archiveName flutter': null
137
          else if (platform.isMacOS) 'zip -r -9 --symlinks $archiveName flutter': null
138
          else if (platform.isLinux) 'tar cJf $archiveName flutter': null,
139
        }));
140 141 142 143 144
        await creator.initializeRepo();
        await creator.createArchive();
      });

      test('calls the right commands for archive output', () async {
145
        final String createBase = path.join(tempDir.absolute.path, 'create_');
146 147
        final String archiveName = path.join(tempDir.absolute.path,
            'flutter_${platformName}_v1.2.3-dev${platform.isLinux ? '.tar.xz' : '.zip'}');
148
        final Map<String, List<ProcessResult>> calls = <String, List<ProcessResult>>{
149
          'git clone -b dev https://chromium.googlesource.com/external/github.com/flutter/flutter': null,
150
          'git reset --hard $testRef': null,
151
          'git remote set-url origin https://github.com/flutter/flutter.git': null,
152
          'git describe --tags --exact-match $testRef': <ProcessResult>[ProcessResult(0, 0, 'v1.2.3', '')],
153
          if (platform.isWindows) '7za x ${path.join(tempDir.path, 'mingit.zip')}': null,
154 155 156 157 158
          '$flutter doctor': null,
          '$flutter update-packages': null,
          '$flutter precache': null,
          '$flutter ide-config': null,
          '$flutter create --template=app ${createBase}app': null,
159
          '$flutter create --template=package ${createBase}package': null,
160
          '$flutter create --template=plugin ${createBase}plugin': null,
161 162
          'git clean -f -x -- **/.packages': null,
          'git clean -f -x -- **/.dart_tool/': null,
163
          if (platform.isWindows) 'attrib -h .git': null,
164
          if (platform.isWindows) '7za a -tzip -mx=9 $archiveName flutter': null
165
          else if (platform.isMacOS) 'zip -r -9 --symlinks $archiveName flutter': null
166 167
          else if (platform.isLinux) 'tar cJf $archiveName flutter': null,
        };
168
        processManager.addCommands(convertResults(calls));
169
        creator = ArchiveCreator(
170 171
          tempDir,
          tempDir,
172 173 174 175 176
          testRef,
          Branch.dev,
          processManager: processManager,
          subprocessOutput: false,
          platform: platform,
177
          httpReader: fakeHttpReader,
178 179 180 181 182 183 184 185
        );
        await creator.initializeRepo();
        await creator.createArchive();
      });

      test('throws when a command errors out', () async {
        final Map<String, List<ProcessResult>> calls = <String, List<ProcessResult>>{
          'git clone -b dev https://chromium.googlesource.com/external/github.com/flutter/flutter':
186 187
              <ProcessResult>[ProcessResult(0, 0, 'output1', '')],
          'git reset --hard $testRef': <ProcessResult>[ProcessResult(0, -1, 'output2', '')],
188
        };
189
        processManager.addCommands(convertResults(calls));
190
        expect(expectAsync0(creator.initializeRepo), throwsA(isA<PreparePackageException>()));
191 192 193 194
      });

      test('non-strict mode calls the right commands', () async {
        final String createBase = path.join(tempDir.absolute.path, 'create_');
195 196
        final String archiveName = path.join(tempDir.absolute.path,
            'flutter_${platformName}_v1.2.3-dev${platform.isLinux ? '.tar.xz' : '.zip'}');
197 198 199 200 201
        final Map<String, List<ProcessResult>> calls = <String, List<ProcessResult>>{
          'git clone -b dev https://chromium.googlesource.com/external/github.com/flutter/flutter': null,
          'git reset --hard $testRef': null,
          'git remote set-url origin https://github.com/flutter/flutter.git': null,
          'git describe --tags --abbrev=0 $testRef': <ProcessResult>[ProcessResult(0, 0, 'v1.2.3', '')],
202
          if (platform.isWindows) '7za x ${path.join(tempDir.path, 'mingit.zip')}': null,
203 204 205 206 207 208 209
          '$flutter doctor': null,
          '$flutter update-packages': null,
          '$flutter precache': null,
          '$flutter ide-config': null,
          '$flutter create --template=app ${createBase}app': null,
          '$flutter create --template=package ${createBase}package': null,
          '$flutter create --template=plugin ${createBase}plugin': null,
210 211
          'git clean -f -x -- **/.packages': null,
          'git clean -f -x -- **/.dart_tool/': null,
212
          if (platform.isWindows) 'attrib -h .git': null,
213
          if (platform.isWindows) '7za a -tzip -mx=9 $archiveName flutter': null
214
          else if (platform.isMacOS) 'zip -r -9 --symlinks $archiveName flutter': null
215 216
          else if (platform.isLinux) 'tar cJf $archiveName flutter': null,
        };
217
        processManager.addCommands(convertResults(calls));
218 219 220 221 222 223 224 225 226 227 228 229 230
        creator = ArchiveCreator(
          tempDir,
          tempDir,
          testRef,
          Branch.dev,
          strict: false,
          processManager: processManager,
          subprocessOutput: false,
          platform: platform,
          httpReader: fakeHttpReader,
        );
        await creator.initializeRepo();
        await creator.createArchive();
231
      });
232 233
    });

234 235 236
    group('ArchivePublisher for $platformName', () {
      FakeProcessManager processManager;
      Directory tempDir;
237 238 239 240 241 242 243
      final String gsutilCall = platform.isWindows
          ? 'python ${path.join("D:", "depot_tools", "gsutil.py")}'
          : 'gsutil.py';
      final String releasesName = 'releases_$platformName.json';
      final String archiveName = platform.isLinux ? 'archive.tar.xz' : 'archive.zip';
      final String archiveMime = platform.isLinux ? 'application/x-gtar' : 'application/zip';
      final String gsArchivePath = 'gs://flutter_infra/releases/stable/$platformName/$archiveName';
244
      final String newGsArchivePath = 'gs://flutter_infra_release/releases/stable/$platformName/$archiveName';
245 246

      setUp(() async {
247
        processManager = FakeProcessManager.list(<FakeCommand>[]);
248
        tempDir = Directory.systemTemp.createTempSync('flutter_prepage_package_test.');
249 250 251
      });

      tearDown(() async {
252
        tryToDelete(tempDir);
253 254 255
      });

      test('calls the right processes', () async {
256
        final String archivePath = path.join(tempDir.absolute.path, archiveName);
257 258
        final String jsonPath = path.join(tempDir.absolute.path, releasesName);
        final String gsJsonPath = 'gs://flutter_infra/releases/$releasesName';
259
        final String newGsJsonPath = 'gs://flutter_infra_release/releases/$releasesName';
260 261
        final String releasesJson = '''
{
262 263 264 265 266 267 268 269 270 271 272
  "base_url": "https://storage.googleapis.com/flutter_infra/releases",
  "current_release": {
    "beta": "3ea4d06340a97a1e9d7cae97567c64e0569dcaa2",
    "dev": "5a58b36e36b8d7aace89d3950e6deb307956a6a0"
  },
  "releases": [
    {
      "hash": "5a58b36e36b8d7aace89d3950e6deb307956a6a0",
      "channel": "dev",
      "version": "v0.2.3",
      "release_date": "2018-03-20T01:47:02.851729Z",
273 274
      "archive": "dev/$platformName/flutter_${platformName}_v0.2.3-dev.zip",
      "sha256": "4fe85a822093e81cb5a66c7fc263f68de39b5797b294191b6d75e7afcc86aff8"
275
    },
276 277 278 279 280
    {
      "hash": "b9bd51cc36b706215915711e580851901faebb40",
      "channel": "beta",
      "version": "v0.2.2",
      "release_date": "2018-03-16T18:48:13.375013Z",
281 282
      "archive": "dev/$platformName/flutter_${platformName}_v0.2.2-dev.zip",
      "sha256": "6073331168cdb37a4637a5dc073d6a7ef4e466321effa2c529fa27d2253a4d4b"
283 284 285
    },
    {
      "hash": "$testRef",
286
      "channel": "stable",
287 288
      "version": "v0.0.0",
      "release_date": "2018-03-20T01:47:02.851729Z",
289 290
      "archive": "stable/$platformName/flutter_${platformName}_v0.0.0-dev.zip",
      "sha256": "5dd34873b3a3e214a32fd30c2c319a0f46e608afb72f0d450b2d621a6d02aebd"
291
    }
292
  ]
293
}
294
''';
295
        File(jsonPath).writeAsStringSync(releasesJson);
296
        File(archivePath).writeAsStringSync('archive contents');
297
        final Map<String, List<ProcessResult>> calls = <String, List<ProcessResult>>{
298 299
          // This process fails because the file does NOT already exist
          '$gsutilCall -- stat $gsArchivePath': <ProcessResult>[ProcessResult(0, 1, '', '')],
300 301 302 303 304
          '$gsutilCall -- rm $gsArchivePath': null,
          '$gsutilCall -- -h Content-Type:$archiveMime cp $archivePath $gsArchivePath': null,
          '$gsutilCall -- cp $gsJsonPath $jsonPath': null,
          '$gsutilCall -- rm $gsJsonPath': null,
          '$gsutilCall -- -h Content-Type:application/json cp $jsonPath $gsJsonPath': null,
305 306 307 308 309 310
          '$gsutilCall -- stat $newGsArchivePath': <ProcessResult>[ProcessResult(0, 1, '', '')],
          '$gsutilCall -- rm $newGsArchivePath': null,
          '$gsutilCall -- -h Content-Type:$archiveMime cp $archivePath $newGsArchivePath': null,
          '$gsutilCall -- cp $newGsJsonPath $jsonPath': null,
          '$gsutilCall -- rm $newGsJsonPath': null,
          '$gsutilCall -- -h Content-Type:application/json cp $jsonPath $newGsJsonPath': null,
311
        };
312
        processManager.addCommands(convertResults(calls));
313
        final File outputFile = File(path.join(tempDir.absolute.path, archiveName));
314
        outputFile.createSync();
315
        assert(tempDir.existsSync());
316
        final ArchivePublisher publisher = ArchivePublisher(
317 318
          tempDir,
          testRef,
319
          Branch.stable,
320
          'v1.2.3',
321
          outputFile,
322
          false,
323 324 325 326 327 328
          processManager: processManager,
          subprocessOutput: false,
          platform: platform,
        );
        assert(tempDir.existsSync());
        await publisher.publishArchive();
329

330
        final File releaseFile = File(jsonPath);
331 332 333
        expect(releaseFile.existsSync(), isTrue);
        final String contents = releaseFile.readAsStringSync();
        // Make sure new data is added.
334
        expect(contents, contains('"hash": "$testRef"'));
335 336
        expect(contents, contains('"channel": "stable"'));
        expect(contents, contains('"archive": "stable/$platformName/$archiveName"'));
337
        expect(contents, contains('"sha256": "f69f4865f861193a91d1c5544a894167a7137b788d10bac8edbf5d095f45cb4d"'));
338
        // Make sure existing entries are preserved.
339 340 341 342 343 344
        expect(contents, contains('"hash": "5a58b36e36b8d7aace89d3950e6deb307956a6a0"'));
        expect(contents, contains('"hash": "b9bd51cc36b706215915711e580851901faebb40"'));
        expect(contents, contains('"channel": "beta"'));
        expect(contents, contains('"channel": "dev"'));
        // Make sure old matching entries are removed.
        expect(contents, isNot(contains('v0.0.0')));
345 346
        final Map<String, dynamic> jsonData = json.decode(contents) as Map<String, dynamic>;
        final List<dynamic> releases = jsonData['releases'] as List<dynamic>;
347 348 349 350
        expect(releases.length, equals(3));
        // Make sure the new entry is first (and hopefully it takes less than a
        // minute to go from publishArchive above to this line!).
        expect(
351
          DateTime.now().difference(DateTime.parse(releases[0]['release_date'] as String)),
352 353
          lessThan(const Duration(minutes: 1)),
        );
354
        const JsonEncoder encoder = JsonEncoder.withIndent('  ');
355 356
        expect(contents, equals(encoder.convert(jsonData)));
      });
357 358 359 360 361 362 363 364 365 366

      test('publishArchive throws if forceUpload is false and artifact already exists on cloud storage', () async {
        final String archiveName = platform.isLinux ? 'archive.tar.xz' : 'archive.zip';
        final File outputFile = File(path.join(tempDir.absolute.path, archiveName));
        final ArchivePublisher publisher = ArchivePublisher(
          tempDir,
          testRef,
          Branch.stable,
          'v1.2.3',
          outputFile,
367
          false,
368 369 370 371 372 373 374 375
          processManager: processManager,
          subprocessOutput: false,
          platform: platform,
        );
        final Map<String, List<ProcessResult>> calls = <String, List<ProcessResult>>{
          // This process returns 0 because file already exists
          '$gsutilCall -- stat $gsArchivePath': <ProcessResult>[ProcessResult(0, 0, '', '')],
        };
376
        processManager.addCommands(convertResults(calls));
377
        expect(() async => publisher.publishArchive(false), throwsException);
378 379 380 381 382 383 384 385 386 387 388
      });

      test('publishArchive does not throw if forceUpload is true and artifact already exists on cloud storage', () async {
        final String archiveName = platform.isLinux ? 'archive.tar.xz' : 'archive.zip';
        final File outputFile = File(path.join(tempDir.absolute.path, archiveName));
        final ArchivePublisher publisher = ArchivePublisher(
          tempDir,
          testRef,
          Branch.stable,
          'v1.2.3',
          outputFile,
389
          false,
390 391 392 393 394 395 396
          processManager: processManager,
          subprocessOutput: false,
          platform: platform,
        );
        final String archivePath = path.join(tempDir.absolute.path, archiveName);
        final String jsonPath = path.join(tempDir.absolute.path, releasesName);
        final String gsJsonPath = 'gs://flutter_infra/releases/$releasesName';
397
        final String newGsJsonPath = 'gs://flutter_infra_release/releases/$releasesName';
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 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
        final String releasesJson = '''
{
  "base_url": "https://storage.googleapis.com/flutter_infra/releases",
  "current_release": {
    "beta": "3ea4d06340a97a1e9d7cae97567c64e0569dcaa2",
    "dev": "5a58b36e36b8d7aace89d3950e6deb307956a6a0"
  },
  "releases": [
    {
      "hash": "5a58b36e36b8d7aace89d3950e6deb307956a6a0",
      "channel": "dev",
      "version": "v0.2.3",
      "release_date": "2018-03-20T01:47:02.851729Z",
      "archive": "dev/$platformName/flutter_${platformName}_v0.2.3-dev.zip",
      "sha256": "4fe85a822093e81cb5a66c7fc263f68de39b5797b294191b6d75e7afcc86aff8"
    },
    {
      "hash": "b9bd51cc36b706215915711e580851901faebb40",
      "channel": "beta",
      "version": "v0.2.2",
      "release_date": "2018-03-16T18:48:13.375013Z",
      "archive": "dev/$platformName/flutter_${platformName}_v0.2.2-dev.zip",
      "sha256": "6073331168cdb37a4637a5dc073d6a7ef4e466321effa2c529fa27d2253a4d4b"
    },
    {
      "hash": "$testRef",
      "channel": "stable",
      "version": "v0.0.0",
      "release_date": "2018-03-20T01:47:02.851729Z",
      "archive": "stable/$platformName/flutter_${platformName}_v0.0.0-dev.zip",
      "sha256": "5dd34873b3a3e214a32fd30c2c319a0f46e608afb72f0d450b2d621a6d02aebd"
    }
  ]
}
''';
        File(jsonPath).writeAsStringSync(releasesJson);
        File(archivePath).writeAsStringSync('archive contents');
        final Map<String, List<ProcessResult>> calls = <String, List<ProcessResult>>{
          '$gsutilCall -- rm $gsArchivePath': null,
          '$gsutilCall -- -h Content-Type:$archiveMime cp $archivePath $gsArchivePath': null,
          '$gsutilCall -- cp $gsJsonPath $jsonPath': null,
          '$gsutilCall -- rm $gsJsonPath': null,
          '$gsutilCall -- -h Content-Type:application/json cp $jsonPath $gsJsonPath': null,
441 442 443 444 445
          '$gsutilCall -- rm $newGsArchivePath': null,
          '$gsutilCall -- -h Content-Type:$archiveMime cp $archivePath $newGsArchivePath': null,
          '$gsutilCall -- cp $newGsJsonPath $jsonPath': null,
          '$gsutilCall -- rm $newGsJsonPath': null,
          '$gsutilCall -- -h Content-Type:application/json cp $jsonPath $newGsJsonPath': null,
446
        };
447
        processManager.addCommands(convertResults(calls));
448 449 450
        assert(tempDir.existsSync());
        await publisher.publishArchive(true);
      });
451 452
    });
  }
453
}
454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476

List<FakeCommand> convertResults(Map<String, List<ProcessResult>> results) {
  final List<FakeCommand> commands = <FakeCommand>[];
  for (final String key in results.keys) {
    final List<ProcessResult> candidates = results[key];
    final List<String> args = key.split(' ');
    if (candidates == null) {
      commands.add(FakeCommand(
        command: args,
      ));
    } else {
      for (final ProcessResult result in candidates) {
        commands.add(FakeCommand(
          command: args,
          exitCode: result.exitCode,
          stderr: result.stderr?.toString(),
          stdout: result.stdout?.toString(),
        ));
      }
    }
  }
  return commands;
}