android_sdk_test.dart 9.42 KB
Newer Older
1 2 3 4
// 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.

5
import 'package:file/memory.dart';
6
import 'package:flutter_tools/src/android/android_sdk.dart';
7
import 'package:flutter_tools/src/base/file_system.dart';
8
import 'package:flutter_tools/src/base/io.dart' show ProcessResult;
9 10
import 'package:flutter_tools/src/base/platform.dart';
import 'package:flutter_tools/src/base/config.dart';
11 12
import 'package:mockito/mockito.dart';
import 'package:process/process.dart';
13

14
import '../src/common.dart';
15
import '../src/context.dart';
16
import '../src/mocks.dart';
17

18 19
class MockProcessManager extends Mock implements ProcessManager {}

20
void main() {
21
  MemoryFileSystem fs;
22
  MockProcessManager processManager;
23 24

  setUp(() {
25 26
    fs = MemoryFileSystem();
    processManager = MockProcessManager();
27 28
  });

29 30 31 32
  group('android_sdk AndroidSdk', () {
    Directory sdkDir;

    tearDown(() {
33 34 35 36
      if (sdkDir != null) {
        tryToDelete(sdkDir);
        sdkDir = null;
      }
37 38 39
    });

    testUsingContext('parse sdk', () {
40
      sdkDir = MockAndroidSdk.createSdkDirectory();
41
      Config.instance.setValue('android-sdk', sdkDir.path);
42

43
      final AndroidSdk sdk = AndroidSdk.locateAndroidSdk();
44 45
      expect(sdk.latestVersion, isNotNull);
      expect(sdk.latestVersion.sdkLevel, 23);
46 47
    }, overrides: <Type, Generator>{
      FileSystem: () => fs,
48 49 50
    });

    testUsingContext('parse sdk N', () {
51
      sdkDir = MockAndroidSdk.createSdkDirectory(withAndroidN: true);
52
      Config.instance.setValue('android-sdk', sdkDir.path);
53

54
      final AndroidSdk sdk = AndroidSdk.locateAndroidSdk();
55 56
      expect(sdk.latestVersion, isNotNull);
      expect(sdk.latestVersion.sdkLevel, 24);
57 58
    }, overrides: <Type, Generator>{
      FileSystem: () => fs,
59
    });
60

61
    testUsingContext('returns sdkmanager path', () {
62
      sdkDir = MockAndroidSdk.createSdkDirectory();
63 64 65 66 67 68 69 70 71
      Config.instance.setValue('android-sdk', sdkDir.path);

      final AndroidSdk sdk = AndroidSdk.locateAndroidSdk();
      expect(sdk.sdkManagerPath, fs.path.join(sdk.directory, 'tools', 'bin', 'sdkmanager'));
    }, overrides: <Type, Generator>{
      FileSystem: () => fs,
    });

    testUsingContext('returns sdkmanager version', () {
72
      sdkDir = MockAndroidSdk.createSdkDirectory();
73 74 75 76
      Config.instance.setValue('android-sdk', sdkDir.path);

      final AndroidSdk sdk = AndroidSdk.locateAndroidSdk();
      when(processManager.canRun(sdk.sdkManagerPath)).thenReturn(true);
77
      when(processManager.runSync(<String>[sdk.sdkManagerPath, '--version'],
78
          environment: argThat(isNotNull,  named: 'environment')))
79
          .thenReturn(ProcessResult(1, 0, '26.1.1\n', ''));
80 81 82 83 84 85
      expect(sdk.sdkManagerVersion, '26.1.1');
    }, overrides: <Type, Generator>{
      FileSystem: () => fs,
      ProcessManager: () => processManager,
    });

86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
    testUsingContext('returns validate sdk is well formed', () {
      sdkDir = MockBrokenAndroidSdk.createSdkDirectory();
      Config.instance.setValue('android-sdk', sdkDir.path);

      final AndroidSdk sdk = AndroidSdk.locateAndroidSdk();
      when(processManager.canRun(sdk.adbPath)).thenReturn(true);

      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>{
      FileSystem: () => fs,
      ProcessManager: () => processManager,
    });

103
    testUsingContext('does not throw on sdkmanager version check failure', () {
104
      sdkDir = MockAndroidSdk.createSdkDirectory();
105 106 107 108
      Config.instance.setValue('android-sdk', sdkDir.path);

      final AndroidSdk sdk = AndroidSdk.locateAndroidSdk();
      when(processManager.canRun(sdk.sdkManagerPath)).thenReturn(true);
109
      when(processManager.runSync(<String>[sdk.sdkManagerPath, '--version'],
110
          environment: argThat(isNotNull,  named: 'environment')))
111
          .thenReturn(ProcessResult(1, 1, '26.1.1\n', 'Mystery error'));
112
      expect(sdk.sdkManagerVersion, isNull);
113 114 115 116 117 118
    }, overrides: <Type, Generator>{
      FileSystem: () => fs,
      ProcessManager: () => processManager,
    });

    testUsingContext('throws on sdkmanager version check if sdkmanager not found', () {
119
      sdkDir = MockAndroidSdk.createSdkDirectory(withSdkManager: false);
120 121 122 123 124 125 126 127 128 129
      Config.instance.setValue('android-sdk', sdkDir.path);

      final AndroidSdk sdk = AndroidSdk.locateAndroidSdk();
      when(processManager.canRun(sdk.sdkManagerPath)).thenReturn(false);
      expect(() => sdk.sdkManagerVersion, throwsToolExit());
    }, overrides: <Type, Generator>{
      FileSystem: () => fs,
      ProcessManager: () => processManager,
    });

130 131 132 133 134 135
    group('ndk', () {
      const <String, String>{
        'linux': 'linux-x86_64',
        'macos': 'darwin-x86_64',
      }.forEach((String os, String osDir) {
        testUsingContext('detection on $os', () {
136
          sdkDir = MockAndroidSdk.createSdkDirectory(
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
              withAndroidN: true, withNdkDir: osDir, withNdkSysroot: true);
          Config.instance.setValue('android-sdk', sdkDir.path);

          final String realSdkDir = sdkDir.path;
          final String realNdkDir = fs.path.join(realSdkDir, 'ndk-bundle');
          final String realNdkCompiler = fs.path.join(
              realNdkDir,
              'toolchains',
              'arm-linux-androideabi-4.9',
              'prebuilt',
              osDir,
              'bin',
              'arm-linux-androideabi-gcc');
          final String realNdkSysroot =
              fs.path.join(realNdkDir, 'platforms', 'android-9', 'arch-arm');

          final AndroidSdk sdk = AndroidSdk.locateAndroidSdk();
          expect(sdk.directory, realSdkDir);
155 156 157 158
          expect(sdk.ndk, isNotNull);
          expect(sdk.ndk.directory, realNdkDir);
          expect(sdk.ndk.compiler, realNdkCompiler);
          expect(sdk.ndk.compilerArgs, <String>['--sysroot', realNdkSysroot]);
159 160
        }, overrides: <Type, Generator>{
          FileSystem: () => fs,
161
          Platform: () => FakePlatform(operatingSystem: os),
162
        });
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196

        testUsingContext('newer NDK require explicit -fuse-ld on $os', () {
          sdkDir = MockAndroidSdk.createSdkDirectory(
              withAndroidN: true, withNdkDir: osDir, withNdkSysroot: true, ndkVersion: 18);
          Config.instance.setValue('android-sdk', sdkDir.path);

          final String realSdkDir = sdkDir.path;
          final String realNdkDir = fs.path.join(realSdkDir, 'ndk-bundle');
          final String realNdkToolchainBin = fs.path.join(
              realNdkDir,
              'toolchains',
              'arm-linux-androideabi-4.9',
              'prebuilt',
              osDir,
              'bin');
          final String realNdkCompiler = fs.path.join(
              realNdkToolchainBin,
              'arm-linux-androideabi-gcc');
          final String realNdkLinker = fs.path.join(
              realNdkToolchainBin,
              'arm-linux-androideabi-ld');
          final String realNdkSysroot =
              fs.path.join(realNdkDir, 'platforms', 'android-9', 'arch-arm');

          final AndroidSdk sdk = AndroidSdk.locateAndroidSdk();
          expect(sdk.directory, realSdkDir);
          expect(sdk.ndk, isNotNull);
          expect(sdk.ndk.directory, realNdkDir);
          expect(sdk.ndk.compiler, realNdkCompiler);
          expect(sdk.ndk.compilerArgs, <String>['--sysroot', realNdkSysroot, '-fuse-ld=$realNdkLinker']);
        }, overrides: <Type, Generator>{
          FileSystem: () => fs,
          Platform: () => FakePlatform(operatingSystem: os),
        });
197 198 199 200
      });

      for (String os in <String>['linux', 'macos']) {
        testUsingContext('detection on $os (no ndk available)', () {
201
          sdkDir = MockAndroidSdk.createSdkDirectory(withAndroidN: true);
202 203 204 205 206
          Config.instance.setValue('android-sdk', sdkDir.path);

          final String realSdkDir = sdkDir.path;
          final AndroidSdk sdk = AndroidSdk.locateAndroidSdk();
          expect(sdk.directory, realSdkDir);
207 208 209
          expect(sdk.ndk, isNull);
          final String explanation = AndroidNdk.explainMissingNdk(sdk.directory);
          expect(explanation, contains('Can not locate ndk-bundle'));
210 211
        }, overrides: <Type, Generator>{
          FileSystem: () => fs,
212
          Platform: () => FakePlatform(operatingSystem: os),
213 214 215
        });
      }
    });
216 217
  });
}
218 219 220 221 222 223 224 225 226 227

/// A broken SDK installation.
class MockBrokenAndroidSdk extends Mock implements AndroidSdk {
  static Directory createSdkDirectory({
    bool withAndroidN = false,
    String withNdkDir,
    bool withNdkSysroot = false,
    bool withSdkManager = true,
  }) {
    final Directory dir = fs.systemTempDirectory.createTempSync('flutter_mock_android_sdk.');
228 229 230
    final String exe = platform.isWindows ? '.exe' : '';
    _createSdkFile(dir, 'licenses/dummy');
    _createSdkFile(dir, 'platform-tools/adb$exe');
231

232 233 234
    _createSdkFile(dir, 'build-tools/sda/aapt$exe');
    _createSdkFile(dir, 'build-tools/af/aapt$exe');
    _createSdkFile(dir, 'build-tools/ljkasd/aapt$exe');
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249

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