feat(android): --gradleFlavor to build a product flavor (#6133)

Author: farfromrefug

docs/man_pages/project/testing/build-android.md

@@ -34,6 +34,7 @@ General | `$ ns build android [--compileSdk <API Level>] [--key-store-path <File
     *   `--env.sourceMap` - creates inline source maps.
     *   `--env.hiddenSourceMap` - creates sources maps in the root folder (useful for Crashlytics usage with bundled app in release).
 * `--aab` - Specifies that the build will produce an Android App Bundle(`.aab`) file.
+* `--gradleFlavor` - Builds the given product flavor, when the app declares any. `--gradleFlavor foo` runs the `assembleFooDebug`/`assembleFooRelease` gradle task instead of `assembleDebug`/`assembleRelease`.
 * `--force` - If set, skips the application compatibility checks and forces `npm i` to ensure all dependencies are installed. Otherwise, the command will check the application compatibility with the current CLI version and could fail requiring `ns migrate`.
 * `--path <Directory>` - Specifies the directory that contains the project. If not set, the project is searched for in the current directory and all directories above it.
 

docs/man_pages/project/testing/debug-android.md

@@ -38,6 +38,7 @@ Attach the debug tools to a running app in the native emulator | `$ ns debug and
     *   `--env.sourceMap` - creates inline source maps.
     *   `--env.hiddenSourceMap` - creates sources maps in the root folder (useful for Crashlytics usage with bundled app in release).
 * `--aab` - Specifies that the command will produce and deploy an Android App Bundle.
+* `--gradleFlavor` - Builds the given product flavor, when the app declares any. `--gradleFlavor foo` runs the `assembleFooDebug`/`assembleFooRelease` gradle task instead of `assembleDebug`/`assembleRelease`.
 * `--force` - If set, skips the application compatibility checks and forces `npm i` to ensure all dependencies are installed. Otherwise, the command will check the application compatibility with the current CLI version and could fail requiring `ns migrate`.
 
 <% if(isHtml) { %>

docs/man_pages/project/testing/run-android.md

@@ -43,6 +43,7 @@ Start a default emulator if none are running, or run application on all connecte
     *   `--env.sourceMap` - creates inline source maps.
     *   `--env.hiddenSourceMap` - creates sources maps in the root folder (useful for Crashlytics usage with bundled app in release).
 * `--aab` - Specifies that the command will produce and deploy an Android App Bundle.
+* `--gradleFlavor` - Builds the given product flavor, when the app declares any. `--gradleFlavor foo` runs the `assembleFooDebug`/`assembleFooRelease` gradle task instead of `assembleDebug`/`assembleRelease`.
 * `--force` - If set, skips the application compatibility checks and forces `npm i` to ensure all dependencies are installed. Otherwise, the command will check the application compatibility with the current CLI version and could fail requiring `ns migrate`.
 
 <% if(isHtml) { %>

lib/data/build-data.ts

@@ -51,6 +51,7 @@ export class AndroidBuildData extends BuildData {
 	public keyStoreAliasPassword: string;
 	public keyStorePassword: string;
 	public androidBundle: boolean;
+	public gradleFlavor: string;
 	public gradlePath: string;
 	public gradleArgs: string;
 	public hostProjectPath: string;
@@ -63,6 +64,7 @@ export class AndroidBuildData extends BuildData {
 		this.keyStoreAliasPassword = data.keyStoreAliasPassword;
 		this.keyStorePassword = data.keyStorePassword;
 		this.androidBundle = data.androidBundle || data.aab;
+		this.gradleFlavor = data.gradleFlavor;
 		this.gradlePath = data.gradlePath;
 		this.gradleArgs = data.gradleArgs;
 		this.hostProjectPath = data.hostProjectPath;

lib/declarations.d.ts

@@ -572,6 +572,11 @@ interface IEmbedOptions {
 }
 
 interface IAndroidOptions extends IEmbedOptions {
+	/**
+	 * The product flavor to build, when the app declares any. `--gradleFlavor foo`
+	 * runs `assembleFooDebug` instead of `assembleDebug`.
+	 */
+	gradleFlavor: string;
 	gradlePath: string;
 	gradleArgs: string;
 }

lib/definitions/build.d.ts

@@ -31,6 +31,7 @@ interface IAndroidBuildData
 	extends IBuildData,
 		IAndroidSigningData,
 		IHasAndroidBundle {
+	gradleFlavor?: string;
 	gradlePath?: string;
 	gradleArgs?: string;
 }

lib/options.ts

@@ -219,6 +219,7 @@ export class Options {
 				default: false,
 				hasSensitiveValue: false,
 			},
+			gradleFlavor: { type: OptionType.String, hasSensitiveValue: false },
 			gradlePath: { type: OptionType.String, hasSensitiveValue: false },
 			gradleArgs: { type: OptionType.String, hasSensitiveValue: false },
 			hostProjectPath: { type: OptionType.String, hasSensitiveValue: false },

lib/services/android/gradle-build-args-service.ts

@@ -85,7 +85,15 @@ export class GradleBuildArgsService implements IGradleBuildArgsService {
 	}
 
 	private getBuildTaskName(buildData: IAndroidBuildData): string {
-		const baseTaskName = buildData.androidBundle ? "bundle" : "assemble";
+		let baseTaskName = buildData.androidBundle ? "bundle" : "assemble";
+
+		// a product flavor sits between the task and the build type -
+		// `assembleFooRelease`, `bundleFooDebug`
+		const flavor = buildData.gradleFlavor;
+		if (flavor) {
+			baseTaskName += flavor[0].toUpperCase() + flavor.slice(1);
+		}
+
 		const buildTaskName = buildData.release
 			? `${baseTaskName}${Configurations.Release}`
 			: `${baseTaskName}${Configurations.Debug}`;

test/services/android/gradle-build-args-service.ts

@@ -163,6 +163,56 @@ describe("GradleBuildArgsService", () => {
 		);
 	});
 
+	describe("gradleFlavor", async () => {
+		const testCases = [
+			{
+				name: "should build the flavor of a debug build",
+				buildConfig: { release: false, gradleFlavor: "foo" },
+				logLevel: "INFO",
+				expectedTask: "assembleFooDebug",
+			},
+			{
+				name: "should build the flavor of a release build",
+				buildConfig: { ...releaseBuildConfig, gradleFlavor: "foo" },
+				logLevel: "INFO",
+				expectedTask: "assembleFooRelease",
+			},
+			{
+				name: "should build the flavor of an android bundle",
+				buildConfig: {
+					release: false,
+					androidBundle: true,
+					gradleFlavor: "foo",
+				},
+				logLevel: "INFO",
+				expectedTask: "bundleFooDebug",
+			},
+			{
+				name: "should keep an already capitalized flavor",
+				buildConfig: { release: false, gradleFlavor: "Foo" },
+				logLevel: "INFO",
+				expectedTask: "assembleFooDebug",
+			},
+		];
+
+		for (const testCase of testCases) {
+			it(testCase.name, async () => {
+				const injector = createTestInjector();
+				const logger = injector.resolve("logger");
+				logger.getLevel = () => testCase.logLevel;
+
+				const gradleBuildArgsService = injector.resolve(
+					"gradleBuildArgsService"
+				);
+				const args = await gradleBuildArgsService.getBuildTaskArgs(
+					<any>testCase.buildConfig
+				);
+
+				assert.deepStrictEqual(args[0], testCase.expectedTask);
+			});
+		}
+	});
+
 	describe("getCleanTaskArgs", async () => {
 		const testCases = [
 			{