Skip to content

Commit a67862d

Browse files
rosen-vladimirovrosen-vladimirov
committed
Pass correct parameters to gradle build
We should pass correct parameters to android build. We need: * Compile SDK - at least 21 * BuildTools version - at least 22 * AppCompat lib (Android Support) version - same as compile SDK * Target SDK - the selected target by user - there's no need to have it Add AndroidToolsInfo class that calculates all required and installed versions of required Android tools. This class prints warnings when the public method getToolsInfo is called without parameters and prints errors when the showWarningsAsErrors parameter is set to true. When `tns doctor` command is called, the checks will print warnings and when `tns platform add android` or `tns build/prepare... android` commands are used, the AndroidToolsInfo will break the execution when incorrect Android setup is detected. Fixes #840
1 parent c9aacda commit a67862d

File tree

5 files changed

+251
-81
lines changed

5 files changed

+251
-81
lines changed

‎lib/android-tools-info.ts

+171
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,171 @@
1+
///<reference path=".d.ts"/>
2+
"use strict";
3+
4+
import path = require("path");
5+
import semver = require("semver");
6+
7+
class AndroidToolsInfo implements IAndroidToolsInfo {
8+
private static ANDROID_TARGET_PREFIX = "android";
9+
private static MIN_SUPPORTED_VERSION = 17;
10+
private static SUPPORTED_TARGETS = ["android-17", "android-18", "android-19", "android-21", "android-22"];
11+
private static MIN_REQUIRED_COMPILE_TARGET = 21;
12+
private static REQUIRED_BUILD_TOOLS_RANGE_PREFIX = ">=22";
13+
private showWarningsAsErrors: boolean;
14+
private toolsInfo: IAndroidToolsInfoData;
15+
private selectedCompileSdk: number;
16+
private installedTargetsCache: string[] = null;
17+
18+
constructor(private $childProcess: IChildProcess,
19+
private $errors: IErrors,
20+
private $fs: IFileSystem,
21+
private $logger: ILogger,
22+
private $options: IOptions) {}
23+
24+
public getToolsInfo(options?: {showWarningsAsErrors: boolean}): IFuture<IAndroidToolsInfoData> {
25+
return ((): IAndroidToolsInfoData => {
26+
if(!this.toolsInfo) {
27+
this.showWarningsAsErrors = options && options.showWarningsAsErrors;
28+
29+
let infoData: IAndroidToolsInfoData = Object.create(null);
30+
infoData.androidHomeEnvVar = this.getAndroidHome();
31+
infoData.compileSdkVersion = this.getCompileSdk().wait();
32+
infoData.buildToolsVersion = this.getBuildToolsVersion().wait();
33+
infoData.targetSdkVersion = this.getTargetSdk().wait();
34+
infoData.supportLibraryVersion = this.getAndroidSupportLibVersion().wait();
35+
36+
this.toolsInfo = infoData;
37+
}
38+
39+
return this.toolsInfo;
40+
}).future<IAndroidToolsInfoData>()();
41+
}
42+
43+
/**
44+
* Prints warining on the screen. In case the showWarningsAsErrors flag is set to true, the warnings are replaced by errors.
45+
* Uses logger.warn for warnings and errors.failWithoutHelp when erros must be shown.
46+
* In case additional details must be shown as info message, use the second parameter.
47+
* NOTE: The additional information will not be printed when showWarningsAsErrors flag is set.
48+
* @param {string} msg The message that will be shown as warning or error.
49+
* @param {string} additionalMsg The additional message that will be shown as info message.
50+
* @return {void}
51+
*/
52+
private printMessage(msg: string, additionalMsg?: string): void {
53+
let printMessage = this.showWarningsAsErrors ? this.$errors.failWithoutHelp : this.$logger.warn;
54+
let printMsgContext = this.showWarningsAsErrors ? this.$errors : this.$logger;
55+
printMessage.apply(printMsgContext, [msg]);
56+
if(additionalMsg) {
57+
this.$logger.info(additionalMsg);
58+
}
59+
}
60+
61+
private getAndroidHome(): string {
62+
let androidHomeEnvVar = process.env["ANDROID_HOME"];
63+
if(!androidHomeEnvVar) {
64+
this.printMessage("ANDROID_HOME environment variable is not set. You cannot use gradle without setting it.",
65+
"Make sure you have set ANDROID_HOME and it points the root of your Android SDK installation directory.");
66+
}
67+
68+
return androidHomeEnvVar;
69+
}
70+
71+
private getCompileSdk(): IFuture<number> {
72+
return ((): number => {
73+
if(!this.selectedCompileSdk) {
74+
let latestValidAndroidTarget = this.getLatestValidAndroidTarget().wait();
75+
if(latestValidAndroidTarget) {
76+
let integerVersion = this.parseAndroidSdkString(latestValidAndroidTarget);
77+
78+
if(integerVersion && integerVersion >= AndroidToolsInfo.MIN_REQUIRED_COMPILE_TARGET) {
79+
return integerVersion;
80+
}
81+
}
82+
83+
this.printMessage(`Could not find supported Android target for compilation. Please install at least: ${AndroidToolsInfo.MIN_REQUIRED_COMPILE_TARGET}.` +
84+
" Make sure you have the latest Android tools installed as well.",
85+
'Run "android" from your command-line to install required Android SDK version.');
86+
}
87+
88+
return this.selectedCompileSdk;
89+
}).future<number>()();
90+
}
91+
92+
private getTargetSdk(): IFuture<number> {
93+
return ((): number => {
94+
let targetSdk = this.$options.sdk ? parseInt(this.$options.sdk) : this.getCompileSdk().wait();
95+
let newTarget = `${AndroidToolsInfo.ANDROID_TARGET_PREFIX}-${targetSdk}`;
96+
if(!_.contains(AndroidToolsInfo.SUPPORTED_TARGETS, newTarget)) {
97+
let versionNumber = parseInt(_.last(newTarget.split("-")));
98+
if(versionNumber && (versionNumber < AndroidToolsInfo.MIN_SUPPORTED_VERSION)) {
99+
this.printMessage(`The selected target SDK ${newTarget} is not supported. You should target at least ${AndroidToolsInfo.MIN_SUPPORTED_VERSION}.`);
100+
} else if(!versionNumber || versionNumber > AndroidToolsInfo.MIN_SUPPORTED_VERSION) {
101+
this.$logger.warn(`The selected Android target '${newTarget}' is not verified as supported. Some functionality may not work as expected.`);
102+
}
103+
}
104+
105+
return targetSdk;
106+
}).future<number>()();
107+
}
108+
109+
private getBuildToolsVersion(): IFuture<string> {
110+
return ((): string => {
111+
let pathToBuildTools = path.join(this.getAndroidHome(), "build-tools");
112+
let maxSupportedAndroidTarget = this.parseAndroidSdkString(_.last(AndroidToolsInfo.SUPPORTED_TARGETS));
113+
let buildToolsRange = `${AndroidToolsInfo.REQUIRED_BUILD_TOOLS_RANGE_PREFIX} <=${maxSupportedAndroidTarget}`;
114+
if(this.$fs.exists(pathToBuildTools).wait()) {
115+
let availableBuildToolsVersions = this.$fs.readDirectory(pathToBuildTools).wait()
116+
.filter(buildTools => !!buildTools.match(/^(\d+\.){2}\d+$/));
117+
let selectedBuildToolsVersion = semver.maxSatisfying(availableBuildToolsVersions, buildToolsRange);
118+
if(selectedBuildToolsVersion) {
119+
return selectedBuildToolsVersion;
120+
}
121+
this.$logger.trace(`Installed build tools are ${availableBuildToolsVersions.join(", ")} and none of them satisfies buildToolsRange: ${buildToolsRange}`);
122+
}
123+
this.printMessage(`You have to install Android Build Tools and the version should be in the following range: '${buildToolsRange}'.`,
124+
'Run "android" from your command-line to install required Android Build Tools.');
125+
}).future<string>()();
126+
}
127+
128+
private getAndroidSupportLibVersion(): IFuture<string> {
129+
return ((): string => {
130+
let pathToAppCompat = path.join(this.getAndroidHome(), "extras", "android", "m2repository", "com", "android", "support", "appcompat-v7");
131+
let compileSdkVersion = this.getCompileSdk().wait();
132+
let requiredAppCompatRange = `>=${compileSdkVersion} <${compileSdkVersion + 1}`;
133+
if(this.$fs.exists(pathToAppCompat).wait()) {
134+
let availableAppCompatVersions = this.$fs.readDirectory(pathToAppCompat).wait()
135+
.filter(buildTools => !!buildTools.match(/^(\d+\.){2}\d+$/));
136+
let selectedAppCompatVersion = semver.maxSatisfying(availableAppCompatVersions, requiredAppCompatRange);
137+
if(selectedAppCompatVersion) {
138+
return selectedAppCompatVersion;
139+
}
140+
this.$logger.trace(`Installed Android Support Library versions are ${availableAppCompatVersions.join(", ")} ` +
141+
`and none of them satisfies our required range: ${requiredAppCompatRange}`);
142+
}
143+
144+
this.printMessage(`You have to install Android Support Library in the following range ${requiredAppCompatRange}.`,
145+
'Run "android" from your command-line to install Android Support Library.');
146+
}).future<string>()();
147+
}
148+
149+
private getLatestValidAndroidTarget(): IFuture<string> {
150+
return (() => {
151+
let installedTargets = this.getInstalledTargets().wait();
152+
return _(AndroidToolsInfo.SUPPORTED_TARGETS).sort().findLast(supportedTarget => _.contains(installedTargets, supportedTarget));
153+
}).future<string>()();
154+
}
155+
156+
private parseAndroidSdkString(androidSdkString: string): number {
157+
return parseInt(androidSdkString.replace(`${AndroidToolsInfo.ANDROID_TARGET_PREFIX}-`, ""));
158+
}
159+
160+
private getInstalledTargets(): IFuture<string[]> {
161+
return (() => {
162+
if (!this.installedTargetsCache) {
163+
this.installedTargetsCache = [];
164+
let output = this.$childProcess.exec('android list targets').wait();
165+
output.replace(/id: \d+ or "(.+)"/g, (m:string, p1:string) => (this.installedTargetsCache.push(p1), m));
166+
}
167+
return this.installedTargetsCache;
168+
}).future<string[]>()();
169+
}
170+
}
171+
$injector.register("androidToolsInfo", AndroidToolsInfo);

‎lib/bootstrap.ts

+1
Original file line numberDiff line numberDiff line change
@@ -72,3 +72,4 @@ $injector.requireCommand("init", "./commands/init");
7272

7373
$injector.require("projectFilesManager", "./services/project-files-manager");
7474
$injector.requireCommand("livesync", "./commands/livesync");
75+
$injector.require("androidToolsInfo", "./android-tools-info");

‎lib/declarations.ts

+44
Original file line numberDiff line numberDiff line change
@@ -90,3 +90,47 @@ interface IProjectFilesManager {
9090
interface IInitService {
9191
initialize(): IFuture<void>;
9292
}
93+
94+
/**
95+
* Provides access to information about installed Android tools and SDKs versions.
96+
*/
97+
interface IAndroidToolsInfo {
98+
/**
99+
* Provides information about installed Android SDKs, Build Tools, Support Library
100+
* and ANDROID_HOME environement variable.
101+
* @param {any} options Defines if the warning messages should treated as error.
102+
* @return {IAndroidToolsInfoData} Information about installed Android Tools and SDKs.
103+
*/
104+
getToolsInfo(options?: {showWarningsAsErrors: boolean}): IFuture<IAndroidToolsInfoData>;
105+
}
106+
107+
/**
108+
* Describes information about installed Android tools and SDKs.
109+
*/
110+
interface IAndroidToolsInfoData {
111+
/**
112+
* The value of ANDROID_HOME environment variable.
113+
*/
114+
androidHomeEnvVar: string;
115+
116+
/**
117+
* The latest installed version of Android Build Tools that satisfies CLI's requirements.
118+
*/
119+
buildToolsVersion: string;
120+
121+
/**
122+
* The latest installed version of Android SDK that satisfies CLI's requirements.
123+
*/
124+
compileSdkVersion: number;
125+
126+
/**
127+
* The latest installed version of Android Support Library that satisfies CLI's requirements.
128+
*/
129+
supportLibraryVersion: string;
130+
131+
/**
132+
* The Android targetSdkVersion specified by the user.
133+
* In case it is not specified, compileSdkVersion will be used for targetSdkVersion.
134+
*/
135+
targetSdkVersion: number;
136+
}

0 commit comments

Comments
 (0)