flutter/packages/flutter_tools/test/dart/pub_get_test.dart
Greg Spencer f29ecba6de
Use .pub-cache from Flutter root, if it exists. (#13358)
The purpose of this PR is to make it so that when the user runs 'flutter', if they have a .pub-cache directory in their flutter root, we use that instead of the default location for the pub cache. Otherwise, it should act as before.

The eventual goal is to support a pre-populated flutter .zip/.tar.gz file that has everything the developer needs in one bundle. In order for that to actually work, we need to have the pub cache be self-contained, and not in the user's home dir.

Another advantage of this is that if you have multiple flutter repos that you're switching between, then the versions in the pub cache will remain static when you switch between them.

This is an attempt to re-land: #13248. Includes a fix for the test that makes it work on bots in the presence of PUB_CACHE being set, and no other changes.
2017-12-05 14:46:39 -08:00

261 lines
8.6 KiB
Dart

// Copyright 2016 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.
import 'dart:async';
import 'package:file/file.dart';
import 'package:file/memory.dart';
import 'package:flutter_tools/src/base/context.dart';
import 'package:flutter_tools/src/base/io.dart';
import 'package:flutter_tools/src/base/platform.dart';
import 'package:flutter_tools/src/dart/pub.dart';
import 'package:mockito/mockito.dart';
import 'package:process/process.dart';
import 'package:quiver/testing/async.dart';
import 'package:test/test.dart';
import '../src/context.dart';
void main() {
testUsingContext('pub get 69', () async {
String error;
final MockProcessManager processMock = context.getVariable(ProcessManager);
new FakeAsync().run((FakeAsync time) {
expect(processMock.lastPubEnvironmment, isNull);
pubGet(context: 'flutter_tests', checkLastModified: false).then((Null value) {
error = 'test completed unexpectedly';
}, onError: (dynamic thrownError) {
error = 'test failed unexpectedly: $thrownError';
});
expect(testLogger.statusText, '');
time.elapse(const Duration(milliseconds: 500));
expect(testLogger.statusText,
'Running "flutter packages get" in /...\n'
'pub get failed (69) -- attempting retry 1 in 1 second...\n'
);
expect(processMock.lastPubEnvironmment, contains('flutter_cli:ctx_flutter_tests'));
expect(processMock.lastPubCache, isNull);
time.elapse(const Duration(milliseconds: 500));
expect(testLogger.statusText,
'Running "flutter packages get" in /...\n'
'pub get failed (69) -- attempting retry 1 in 1 second...\n'
'pub get failed (69) -- attempting retry 2 in 2 seconds...\n'
);
time.elapse(const Duration(seconds: 1));
expect(testLogger.statusText,
'Running "flutter packages get" in /...\n'
'pub get failed (69) -- attempting retry 1 in 1 second...\n'
'pub get failed (69) -- attempting retry 2 in 2 seconds...\n'
);
time.elapse(const Duration(seconds: 100)); // from t=0 to t=100
expect(testLogger.statusText,
'Running "flutter packages get" in /...\n'
'pub get failed (69) -- attempting retry 1 in 1 second...\n'
'pub get failed (69) -- attempting retry 2 in 2 seconds...\n'
'pub get failed (69) -- attempting retry 3 in 4 seconds...\n' // at t=1
'pub get failed (69) -- attempting retry 4 in 8 seconds...\n' // at t=5
'pub get failed (69) -- attempting retry 5 in 16 seconds...\n' // at t=13
'pub get failed (69) -- attempting retry 6 in 32 seconds...\n' // at t=29
'pub get failed (69) -- attempting retry 7 in 64 seconds...\n' // at t=61
);
time.elapse(const Duration(seconds: 200)); // from t=0 to t=200
expect(testLogger.statusText,
'Running "flutter packages get" in /...\n'
'pub get failed (69) -- attempting retry 1 in 1 second...\n'
'pub get failed (69) -- attempting retry 2 in 2 seconds...\n'
'pub get failed (69) -- attempting retry 3 in 4 seconds...\n'
'pub get failed (69) -- attempting retry 4 in 8 seconds...\n'
'pub get failed (69) -- attempting retry 5 in 16 seconds...\n'
'pub get failed (69) -- attempting retry 6 in 32 seconds...\n'
'pub get failed (69) -- attempting retry 7 in 64 seconds...\n'
'pub get failed (69) -- attempting retry 8 in 64 seconds...\n' // at t=39
'pub get failed (69) -- attempting retry 9 in 64 seconds...\n' // at t=103
'pub get failed (69) -- attempting retry 10 in 64 seconds...\n' // at t=167
);
});
expect(testLogger.errorText, isEmpty);
expect(error, isNull);
}, overrides: <Type, Generator>{
ProcessManager: () => new MockProcessManager(69),
FileSystem: () => new MockFileSystem(),
Platform: () => new FakePlatform(
environment: <String, String>{},
),
});
testUsingContext('pub cache in root is used', () async {
String error;
final MockProcessManager processMock = context.getVariable(ProcessManager);
new FakeAsync().run((FakeAsync time) {
MockDirectory.findCache = true;
expect(processMock.lastPubEnvironmment, isNull);
expect(processMock.lastPubCache, isNull);
pubGet(context: 'flutter_tests', checkLastModified: false).then((Null value) {
error = 'test completed unexpectedly';
}, onError: (dynamic thrownError) {
error = 'test failed unexpectedly: $thrownError';
});
time.elapse(const Duration(milliseconds: 500));
expect(processMock.lastPubCache, endsWith('flutter/.pub-cache'));
expect(error, isNull);
});
}, overrides: <Type, Generator>{
ProcessManager: () => new MockProcessManager(69),
FileSystem: () => new MockFileSystem(),
Platform: () => new FakePlatform(
environment: <String, String>{},
),
});
testUsingContext('pub cache in environment is used', () async {
String error;
final MockProcessManager processMock = context.getVariable(ProcessManager);
new FakeAsync().run((FakeAsync time) {
MockDirectory.findCache = false;
expect(processMock.lastPubEnvironmment, isNull);
expect(processMock.lastPubCache, isNull);
pubGet(context: 'flutter_tests', checkLastModified: false).then((Null value) {
error = 'test completed unexpectedly';
}, onError: (dynamic thrownError) {
error = 'test failed unexpectedly: $thrownError';
});
time.elapse(const Duration(milliseconds: 500));
expect(processMock.lastPubCache, equals('path/to/pub-cache'));
expect(error, isNull);
});
}, overrides: <Type, Generator>{
ProcessManager: () => new MockProcessManager(69),
FileSystem: () => new MockFileSystem(),
Platform: () => new FakePlatform(
environment: <String, String>{'PUB_CACHE': 'path/to/pub-cache'},
),
});
}
typedef void StartCallback(List<dynamic> command);
class MockProcessManager implements ProcessManager {
MockProcessManager(this.fakeExitCode);
final int fakeExitCode;
String lastPubEnvironmment;
String lastPubCache;
@override
Future<Process> start(
List<dynamic> command, {
String workingDirectory,
Map<String, String> environment,
bool includeParentEnvironment: true,
bool runInShell: false,
ProcessStartMode mode: ProcessStartMode.NORMAL,
}) {
lastPubEnvironmment = environment['PUB_ENVIRONMENT'];
lastPubCache = environment['PUB_CACHE'];
return new Future<Process>.value(new MockProcess(fakeExitCode));
}
@override
dynamic noSuchMethod(Invocation invocation) => null;
}
class MockProcess implements Process {
MockProcess(this.fakeExitCode);
final int fakeExitCode;
@override
Stream<List<int>> get stdout => new MockStream<List<int>>();
@override
Stream<List<int>> get stderr => new MockStream<List<int>>();
@override
Future<int> get exitCode => new Future<int>.value(fakeExitCode);
@override
dynamic noSuchMethod(Invocation invocation) => null;
}
class MockStream<T> implements Stream<T> {
@override
Stream<S> transform<S>(StreamTransformer<T, S> streamTransformer) => new MockStream<S>();
@override
Stream<T> where(bool test(T event)) => new MockStream<T>();
@override
StreamSubscription<T> listen(void onData(T event), {Function onError, void onDone(), bool cancelOnError}) {
return new MockStreamSubscription<T>();
}
@override
dynamic noSuchMethod(Invocation invocation) => null;
}
class MockStreamSubscription<T> implements StreamSubscription<T> {
@override
Future<E> asFuture<E>([E futureValue]) => new Future<E>.value();
@override
Future<Null> cancel() => null;
@override
dynamic noSuchMethod(Invocation invocation) => null;
}
class MockFileSystem extends MemoryFileSystem {
@override
File file(dynamic path) {
return new MockFile();
}
@override
Directory directory(dynamic path) {
return new MockDirectory(path);
}
}
class MockFile implements File {
@override
Future<RandomAccessFile> open({FileMode mode: FileMode.READ}) async {
return new MockRandomAccessFile();
}
@override
bool existsSync() => true;
@override
DateTime lastModifiedSync() => new DateTime(0);
@override
dynamic noSuchMethod(Invocation invocation) => null;
}
class MockDirectory implements Directory {
static bool findCache = false;
MockDirectory(this.path);
@override
final String path;
@override
bool existsSync() => findCache && path.endsWith('.pub-cache');
@override
dynamic noSuchMethod(Invocation invocation) => null;
}
class MockRandomAccessFile extends Mock implements RandomAccessFile {}