android_sdk_test.dart 8.43 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 'package:file/memory.dart';
6
import 'package:flutter_tools/src/android/android_sdk.dart';
7
import 'package:flutter_tools/src/base/config.dart';
8
import 'package:flutter_tools/src/base/file_system.dart';
9
import 'package:flutter_tools/src/base/io.dart' show ProcessResult;
10
import 'package:flutter_tools/src/base/logger.dart';
11
import 'package:flutter_tools/src/base/platform.dart';
12
import 'package:meta/meta.dart';
13 14
import 'package:mockito/mockito.dart';
import 'package:process/process.dart';
15

16 17 18
import '../../src/common.dart';
import '../../src/context.dart';
import '../../src/mocks.dart';
19

20 21
class MockProcessManager extends Mock implements ProcessManager {}

22
void main() {
23
  MemoryFileSystem fileSystem;
24
  MockProcessManager processManager;
25
  Config config;
26 27

  setUp(() {
28
    fileSystem = MemoryFileSystem.test();
29
    processManager = MockProcessManager();
30 31 32 33 34
    config = Config.test(
      'test',
      directory: fileSystem.currentDirectory,
      logger: BufferLogger.test(),
    );
35 36
  });

37 38 39 40
  group('android_sdk AndroidSdk', () {
    Directory sdkDir;

    tearDown(() {
41 42 43 44
      if (sdkDir != null) {
        tryToDelete(sdkDir);
        sdkDir = null;
      }
45 46 47
    });

    testUsingContext('parse sdk', () {
48
      sdkDir = MockAndroidSdk.createSdkDirectory();
49
      config.setValue('android-sdk', sdkDir.path);
50

51
      final AndroidSdk sdk = AndroidSdk.locateAndroidSdk();
52 53
      expect(sdk.latestVersion, isNotNull);
      expect(sdk.latestVersion.sdkLevel, 23);
54
    }, overrides: <Type, Generator>{
55
      FileSystem: () => fileSystem,
56
      ProcessManager: () => FakeProcessManager.any(),
57
      Config: () => config,
58 59 60
    });

    testUsingContext('parse sdk N', () {
61
      sdkDir = MockAndroidSdk.createSdkDirectory(withAndroidN: true);
62
      config.setValue('android-sdk', sdkDir.path);
63

64
      final AndroidSdk sdk = AndroidSdk.locateAndroidSdk();
65 66
      expect(sdk.latestVersion, isNotNull);
      expect(sdk.latestVersion.sdkLevel, 24);
67
    }, overrides: <Type, Generator>{
68
      FileSystem: () => fileSystem,
69
      ProcessManager: () => FakeProcessManager.any(),
70
      Config: () => config,
71
    });
72

73
    testUsingContext('returns sdkmanager path under cmdline tools on Linux/macOS', () {
74
      sdkDir = MockAndroidSdk.createSdkDirectory();
75
      config.setValue('android-sdk', sdkDir.path);
76 77

      final AndroidSdk sdk = AndroidSdk.locateAndroidSdk();
78 79
      fileSystem.file(
        fileSystem.path.join(sdk.directory, 'cmdline-tools', 'latest', 'bin', 'sdkmanager')
80 81
      ).createSync(recursive: true);

82
      expect(sdk.sdkManagerPath, fileSystem.path.join(sdk.directory, 'cmdline-tools', 'latest', 'bin', 'sdkmanager'));
83
    }, overrides: <Type, Generator>{
84
      FileSystem: () => fileSystem,
85
      ProcessManager: () => FakeProcessManager.any(),
86
      Platform: () => FakePlatform(operatingSystem: 'linux'),
87
      Config: () => config,
88 89 90 91
    });

    testUsingContext('returns sdkmanager.bat path under cmdline tools for windows', () {
      sdkDir = MockAndroidSdk.createSdkDirectory();
92
      config.setValue('android-sdk', sdkDir.path);
93 94

      final AndroidSdk sdk = AndroidSdk.locateAndroidSdk();
95 96
      fileSystem.file(
        fileSystem.path.join(sdk.directory, 'cmdline-tools', 'latest', 'bin', 'sdkmanager.bat')
97 98 99
      ).createSync(recursive: true);

      expect(sdk.sdkManagerPath,
100
        fileSystem.path.join(sdk.directory, 'cmdline-tools', 'latest', 'bin', 'sdkmanager.bat'));
101
    }, overrides: <Type, Generator>{
102
      FileSystem: () => fileSystem,
103 104
      ProcessManager: () => FakeProcessManager.any(),
      Platform: () => FakePlatform(operatingSystem: 'windows'),
105
      Config: () => config,
106 107 108 109
    });

    testUsingContext('returns sdkmanager path under tools if cmdline doesnt exist', () {
      sdkDir = MockAndroidSdk.createSdkDirectory();
110
      config.setValue('android-sdk', sdkDir.path);
111 112 113

      final AndroidSdk sdk = AndroidSdk.locateAndroidSdk();

114
      expect(sdk.sdkManagerPath, fileSystem.path.join(sdk.directory, 'tools', 'bin', 'sdkmanager'));
115
    }, overrides: <Type, Generator>{
116
      FileSystem: () => fileSystem,
117
      ProcessManager: () => FakeProcessManager.any(),
118
      Config: () => config,
119 120 121
    });

    testUsingContext('returns sdkmanager version', () {
122
      sdkDir = MockAndroidSdk.createSdkDirectory();
123
      config.setValue('android-sdk', sdkDir.path);
124 125

      final AndroidSdk sdk = AndroidSdk.locateAndroidSdk();
126 127
      when(processManager.canRun(sdk.sdkManagerPath)).thenReturn(true);
      when(processManager.runSync(<String>[sdk.sdkManagerPath, '--version'],
128
          environment: argThat(isNotNull,  named: 'environment')))
129
          .thenReturn(ProcessResult(1, 0, '26.1.1\n', ''));
130 131 132 133 134 135
      when(processManager.runSync(
        <String>['/usr/libexec/java_home', '-v', '1.8'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).thenReturn(ProcessResult(0, 0, '', ''));

136 137
      expect(sdk.sdkManagerVersion, '26.1.1');
    }, overrides: <Type, Generator>{
138
      FileSystem: () => fileSystem,
139
      ProcessManager: () => processManager,
140
      Config: () => config,
141 142
    });

143
    testUsingContext('returns validate sdk is well formed', () {
144 145 146 147
      sdkDir = MockBrokenAndroidSdk.createSdkDirectory(
        fileSystem: fileSystem,
      );
      config.setValue('android-sdk', sdkDir.path);
148 149

      final AndroidSdk sdk = AndroidSdk.locateAndroidSdk();
150
      when(processManager.canRun(sdk.adbPath)).thenReturn(true);
151 152 153 154 155 156 157

      final List<String> validationIssues = sdk.validateSdkWellFormed();
      expect(validationIssues.first, 'No valid Android SDK platforms found in'
        ' /.tmp_rand0/flutter_mock_android_sdk.rand0/platforms. Candidates were:\n'
        '  - android-22\n'
        '  - android-23');
    }, overrides: <Type, Generator>{
158
      FileSystem: () => fileSystem,
159
      ProcessManager: () => processManager,
160 161
      Config: () => config,
      Platform: () => FakePlatform(operatingSystem: 'linux'),
162 163
    });

164
    testUsingContext('does not throw on sdkmanager version check failure', () {
165
      sdkDir = MockAndroidSdk.createSdkDirectory();
166
      config.setValue('android-sdk', sdkDir.path);
167 168

      final AndroidSdk sdk = AndroidSdk.locateAndroidSdk();
169 170
      when(processManager.canRun(sdk.sdkManagerPath)).thenReturn(true);
      when(processManager.runSync(<String>[sdk.sdkManagerPath, '--version'],
171
          environment: argThat(isNotNull,  named: 'environment')))
172
          .thenReturn(ProcessResult(1, 1, '26.1.1\n', 'Mystery error'));
173 174 175 176 177 178
      when(processManager.runSync(
        <String>['/usr/libexec/java_home', '-v', '1.8'],
        workingDirectory: anyNamed('workingDirectory'),
        environment: anyNamed('environment'),
      )).thenReturn(ProcessResult(0, 0, '', ''));

179
      expect(sdk.sdkManagerVersion, isNull);
180
    }, overrides: <Type, Generator>{
181
      FileSystem: () => fileSystem,
182
      ProcessManager: () => processManager,
183
      Config: () => config,
184 185 186
    });

    testUsingContext('throws on sdkmanager version check if sdkmanager not found', () {
187
      sdkDir = MockAndroidSdk.createSdkDirectory(withSdkManager: false);
188
      config.setValue('android-sdk', sdkDir.path);
189 190

      final AndroidSdk sdk = AndroidSdk.locateAndroidSdk();
191
      when(processManager.canRun(sdk.sdkManagerPath)).thenReturn(false);
192 193
      expect(() => sdk.sdkManagerVersion, throwsToolExit());
    }, overrides: <Type, Generator>{
194
      FileSystem: () => fileSystem,
195
      ProcessManager: () => processManager,
196
      Config: () => config,
197
    });
198 199
  });
}
200 201 202 203 204 205

/// A broken SDK installation.
class MockBrokenAndroidSdk extends Mock implements AndroidSdk {
  static Directory createSdkDirectory({
    bool withAndroidN = false,
    bool withSdkManager = true,
206
    @required FileSystem fileSystem,
207
  }) {
208
    final Directory dir = fileSystem.systemTempDirectory.createTempSync('flutter_mock_android_sdk.');
209
    _createSdkFile(dir, 'licenses/dummy');
210
    _createSdkFile(dir, 'platform-tools/adb');
211

212 213 214
    _createSdkFile(dir, 'build-tools/sda/aapt');
    _createSdkFile(dir, 'build-tools/af/aapt');
    _createSdkFile(dir, 'build-tools/ljkasd/aapt');
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229

    _createSdkFile(dir, 'platforms/android-22/android.jar');
    _createSdkFile(dir, 'platforms/android-23/android.jar');

    return dir;
  }

  static void _createSdkFile(Directory dir, String filePath, { String contents }) {
    final File file = dir.childFile(filePath);
    file.createSync(recursive: true);
    if (contents != null) {
      file.writeAsStringSync(contents, flush: true);
    }
  }
}