Skip to content

Commit a84fb7c

Browse files
kikosodkhawk
kikoso
and
dkhawk
authored
build: refactor into modules (#27)
* build: refactor into modules * build: enhance API key validation and standardize installAndLaunch tasks This commit introduces rigorous safety checks for API key loading across all sample applications and standardizes local shell deployments. Validation Changes: 1. Regex Enforcement: Replaced naive substring equality checks with a strict ^AIza[a-zA-Z0-9_-]{35}$ Regex pattern to guarantee structural validity of the MAPS3D_API_KEY. 2. Graceful MAPS_API_KEY Handling: Downgraded the presence of MAPS_API_KEY from a hard build failure (GradleException) to a standard warning to prevent breaking unified workspaces. 3. Active Payload Parsing: Introduced java.util.Properties into the scripts to safely parse the properties file buffer. 4. Expanded Coverage: Integrated the complete secrets validation block dynamically into both Snippet build.gradle.kts files ensuring full modular parity. Workflow Changes (installAndLaunch): - Advanced App & Java ApiDemo: Added a brand new installAndLaunch task depending on installDebug to ADB intent the fully qualified main activity. - Snippets (Java & Kotlin): Renamed existing installAndLaunchDebug tasks to installAndLaunch to guarantee exact parity across the workspace, attaching standard description and group metadata. * build: enhance API key validation and standardize installAndLaunch tasks This commit introduces rigorous safety checks for API key loading across all sample applications and standardizes local shell deployments. Validation Changes: 1. Regex Enforcement: Replaced naive substring equality checks with a strict ^AIza[a-zA-Z0-9_-]{35}$ Regex pattern to guarantee structural validity of the MAPS3D_API_KEY. 2. Graceful MAPS_API_KEY Handling: Downgraded the presence of MAPS_API_KEY from a hard build failure (GradleException) to a standard warning to prevent breaking unified workspaces. 3. Active Payload Parsing: Introduced java.util.Properties into the scripts to safely parse the properties file buffer. 4. Expanded Coverage: Integrated the complete secrets validation block dynamically into both Snippet build.gradle.kts files ensuring full modular parity. Workflow Changes (installAndLaunch): - Advanced App & Java ApiDemo: Added a brand new installAndLaunch task depending on installDebug to ADB intent the fully qualified main activity. - Snippets (Java & Kotlin): Renamed existing installAndLaunchDebug tasks to installAndLaunch to guarantee exact parity across the workspace, attaching standard description and group metadata. --------- Co-authored-by: dkhawk <107309+dkhawk@users.noreply.github.com>
1 parent 4a632d1 commit a84fb7c

17 files changed

Lines changed: 682 additions & 142 deletions

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ build/
44

55
# Local configuration file (sdk path, etc)
66
local.properties
7+
secrets.properties
78

89
# Log/OS Files
910
*.log

‎Maps3DSamples/ApiDemos/java-app/build.gradle.kts‎

Lines changed: 33 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,19 @@
1414
* limitations under the License.
1515
*/
1616

17-
// Check for secrets.properties file before proceeding with build tasks.
17+
import java.util.Properties
18+
import org.gradle.api.GradleException
19+
20+
// Check for secrets.properties file and valid API key before proceeding with build tasks.
1821
val secretsFile = rootProject.file("secrets.properties")
1922
val isCI = System.getenv("CI")?.toBoolean() ?: false
2023

21-
if (!secretsFile.exists() && !isCI) {
24+
if (!isCI) {
2225
val requestedTasks = gradle.startParameter.taskNames
23-
if (requestedTasks.isEmpty()) {
26+
if (requestedTasks.isEmpty() && !secretsFile.exists()) {
2427
// It's likely an IDE sync if no tasks are specified, so just issue a warning.
2528
println("Warning: secrets.properties not found. Gradle sync may succeed, but building/running the app will fail.")
26-
} else {
29+
} else if (requestedTasks.isNotEmpty()) {
2730
val buildTaskKeywords = listOf("build", "install", "assemble")
2831
val isBuildTask = requestedTasks.any { task ->
2932
buildTaskKeywords.any { keyword ->
@@ -39,20 +42,32 @@ if (!secretsFile.exists() && !isCI) {
3942
}
4043

4144
val isDebugTask = requestedTasks.any { task ->
42-
task.contains("Debug", ignoreCase = true)
45+
task.contains("Debug", ignoreCase = true) || task.contains("installAndLaunch", ignoreCase = true)
4346
}
4447

4548
if (isBuildTask && !isTestTask && isDebugTask) {
4649
val defaultsFile = rootProject.file("local.defaults.properties")
4750
val requiredKeysMessage = if (defaultsFile.exists()) {
4851
defaultsFile.readText()
4952
} else {
50-
"MAPS_API_KEY=<YOUR_API_KEY>"
53+
"MAPS3D_API_KEY=<YOUR_API_KEY>"
54+
}
55+
56+
if (!secretsFile.exists()) {
57+
throw GradleException("secrets.properties file not found. Please create a 'secrets.properties' file in the root project directory with the following content:\n\n$requiredKeysMessage")
5158
}
5259

53-
throw GradleException("secrets.properties file not found. Please create a 'secrets.properties' file in the root project directory with the following content:\n" +
54-
"\n" +
55-
requiredKeysMessage)
60+
val secrets = Properties()
61+
secretsFile.inputStream().use { secrets.load(it) }
62+
val apiKey = secrets.getProperty("MAPS3D_API_KEY")
63+
64+
if (apiKey.isNullOrBlank() || !apiKey.matches(Regex("^AIza[a-zA-Z0-9_-]{35}$"))) {
65+
throw GradleException("Invalid or missing MAPS3D_API_KEY in secrets.properties. Please provide a valid Google Maps API key (starts with 'AIza').")
66+
}
67+
68+
if (secrets.getProperty("MAPS_API_KEY") != null) {
69+
println("Warning: Found MAPS_API_KEY in secrets.properties. This project relies exclusively on MAPS3D_API_KEY.")
70+
}
5671
}
5772
}
5873
}
@@ -112,12 +127,12 @@ dependencies {
112127
implementation(libs.androidx.ui.tooling.preview)
113128
implementation(libs.androidx.material3)
114129
implementation(libs.play.services.base)
115-
implementation(project(":common"))
130+
implementation(project(":Maps3DSamples:ApiDemos:common"))
116131

117132
testImplementation(libs.junit)
118133

119134
androidTestImplementation(libs.androidx.junit)
120-
androidTestImplementation(project(":common"))
135+
androidTestImplementation(project(":Maps3DSamples:ApiDemos:common"))
121136
androidTestImplementation(libs.androidx.espresso.core)
122137
androidTestImplementation(platform(libs.androidx.compose.bom))
123138
androidTestImplementation(libs.androidx.ui.test.junit4)
@@ -135,3 +150,10 @@ secrets {
135150
// checked in version control.
136151
defaultPropertiesFileName = "local.defaults.properties"
137152
}
153+
154+
tasks.register<Exec>("installAndLaunch") {
155+
description = "Installs and launches the demo app."
156+
group = "install"
157+
dependsOn("installDebug")
158+
commandLine("adb", "shell", "am", "start", "-n", "com.example.maps3djava/.mainactivity.MainActivity")
159+
}

‎Maps3DSamples/ApiDemos/kotlin-app/build.gradle.kts‎

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,18 @@
1616

1717
import org.gradle.api.GradleException
1818
import java.io.File
19+
import java.util.Properties
1920

20-
// Check for secrets.properties file before proceeding with build tasks.
21+
// Check for secrets.properties file and valid API key before proceeding with build tasks.
2122
val secretsFile = rootProject.file("secrets.properties")
2223
val isCI = System.getenv("CI")?.toBoolean() ?: false
2324

24-
if (!secretsFile.exists() && !isCI) {
25+
if (!isCI) {
2526
val requestedTasks = gradle.startParameter.taskNames
26-
if (requestedTasks.isEmpty()) {
27+
if (requestedTasks.isEmpty() && !secretsFile.exists()) {
2728
// It's likely an IDE sync if no tasks are specified, so just issue a warning.
2829
println("Warning: secrets.properties not found. Gradle sync may succeed, but building/running the app will fail.")
29-
} else {
30+
} else if (requestedTasks.isNotEmpty()) {
3031
val buildTaskKeywords = listOf("build", "install", "assemble")
3132
val isBuildTask = requestedTasks.any { task ->
3233
buildTaskKeywords.any { keyword ->
@@ -42,20 +43,32 @@ if (!secretsFile.exists() && !isCI) {
4243
}
4344

4445
val isDebugTask = requestedTasks.any { task ->
45-
task.contains("Debug", ignoreCase = true)
46+
task.contains("Debug", ignoreCase = true) || task.contains("installAndLaunch", ignoreCase = true)
4647
}
4748

4849
if (isBuildTask && !isTestTask && isDebugTask) {
4950
val defaultsFile = rootProject.file("local.defaults.properties")
5051
val requiredKeysMessage = if (defaultsFile.exists()) {
5152
defaultsFile.readText()
5253
} else {
53-
"MAPS_API_KEY=<YOUR_API_KEY>"
54+
"MAPS3D_API_KEY=<YOUR_API_KEY>"
5455
}
5556

56-
throw GradleException("secrets.properties file not found. Please create a 'secrets.properties' file in the root project directory with the following content:\n" +
57-
"\n" +
58-
requiredKeysMessage)
57+
if (!secretsFile.exists()) {
58+
throw GradleException("secrets.properties file not found. Please create a 'secrets.properties' file in the root project directory with the following content:\n\n$requiredKeysMessage")
59+
}
60+
61+
val secrets = Properties()
62+
secretsFile.inputStream().use { secrets.load(it) }
63+
val apiKey = secrets.getProperty("MAPS3D_API_KEY")
64+
65+
if (apiKey.isNullOrBlank() || !apiKey.matches(Regex("^AIza[a-zA-Z0-9_-]{35}$"))) {
66+
throw GradleException("Invalid or missing MAPS3D_API_KEY in secrets.properties. Please provide a valid Google Maps API key (starts with 'AIza').")
67+
}
68+
69+
if (secrets.getProperty("MAPS_API_KEY") != null) {
70+
println("Warning: Found MAPS_API_KEY in secrets.properties. This project relies exclusively on MAPS3D_API_KEY.")
71+
}
5972
}
6073
}
6174
}
@@ -133,7 +146,7 @@ dependencies {
133146
debugImplementation(libs.androidx.ui.test.manifest)
134147

135148
implementation(libs.play.services.base)
136-
implementation(project(":common"))
149+
implementation(project(":Maps3DSamples:ApiDemos:common"))
137150
}
138151

139152
secrets {

‎Maps3DSamples/ApiDemos/settings.gradle.kts‎

Lines changed: 0 additions & 54 deletions
This file was deleted.

‎Maps3DSamples/advanced/app/build.gradle.kts‎

Lines changed: 31 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,19 @@
1414
* limitations under the License.
1515
*/
1616

17-
// Check for secrets.properties file before proceeding with build tasks.
17+
import java.util.Properties
18+
import org.gradle.api.GradleException
19+
20+
// Check for secrets.properties file and valid API key before proceeding with build tasks.
1821
val secretsFile = rootProject.file("secrets.properties")
1922
val isCI = System.getenv("CI")?.toBoolean() ?: false
2023

21-
if (!secretsFile.exists() && !isCI) {
24+
if (!isCI) {
2225
val requestedTasks = gradle.startParameter.taskNames
23-
if (requestedTasks.isEmpty()) {
26+
if (requestedTasks.isEmpty() && !secretsFile.exists()) {
2427
// It's likely an IDE sync if no tasks are specified, so just issue a warning.
2528
println("Warning: secrets.properties not found. Gradle sync may succeed, but building/running the app will fail.")
26-
} else {
29+
} else if (requestedTasks.isNotEmpty()) {
2730
val buildTaskKeywords = listOf("build", "install", "assemble")
2831
val isBuildTask = requestedTasks.any { task ->
2932
buildTaskKeywords.any { keyword ->
@@ -39,20 +42,32 @@ if (!secretsFile.exists() && !isCI) {
3942
}
4043

4144
val isDebugTask = requestedTasks.any { task ->
42-
task.contains("Debug", ignoreCase = true)
45+
task.contains("Debug", ignoreCase = true) || task.contains("installAndLaunch", ignoreCase = true)
4346
}
4447

4548
if (isBuildTask && !isTestTask && isDebugTask) {
4649
val defaultsFile = rootProject.file("local.defaults.properties")
4750
val requiredKeysMessage = if (defaultsFile.exists()) {
4851
defaultsFile.readText()
4952
} else {
50-
"MAPS_API_KEY=<YOUR_API_KEY>"
53+
"MAPS3D_API_KEY=<YOUR_API_KEY>"
54+
}
55+
56+
if (!secretsFile.exists()) {
57+
throw GradleException("secrets.properties file not found. Please create a 'secrets.properties' file in the root project directory with the following content:\n\n$requiredKeysMessage")
5158
}
5259

53-
throw GradleException("secrets.properties file not found. Please create a 'secrets.properties' file in the root project directory with the following content:\n" +
54-
"\n" +
55-
requiredKeysMessage)
60+
val secrets = Properties()
61+
secretsFile.inputStream().use { secrets.load(it) }
62+
val apiKey = secrets.getProperty("MAPS3D_API_KEY")
63+
64+
if (apiKey.isNullOrBlank() || !apiKey.matches(Regex("^AIza[a-zA-Z0-9_-]{35}$"))) {
65+
throw GradleException("Invalid or missing MAPS3D_API_KEY in secrets.properties. Please provide a valid Google Maps API key (starts with 'AIza').")
66+
}
67+
68+
if (secrets.getProperty("MAPS_API_KEY") != null) {
69+
println("Warning: Found MAPS_API_KEY in secrets.properties. This project relies exclusively on MAPS3D_API_KEY.")
70+
}
5671
}
5772
}
5873
}
@@ -151,3 +166,10 @@ secrets {
151166
// checked in version control.
152167
defaultPropertiesFileName = "local.defaults.properties"
153168
}
169+
170+
tasks.register<Exec>("installAndLaunch") {
171+
description = "Installs and launches the demo app."
172+
group = "install"
173+
dependsOn("installDebug")
174+
commandLine("adb", "shell", "am", "start", "-n", "com.example.advancedmaps3dsamples/.MainActivity")
175+
}

‎gradle.properties‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Project-wide Gradle settings.
2+
# IDE (e.g. Android Studio) users:
3+
# Gradle settings configured through the IDE *will override*
4+
# any settings specified in this file.
5+
# For more details on how to configure your build environment visit
6+
# http://www.gradle.org/docs/current/userguide/build_environment.html
7+
# Specifies the JVM arguments used for the daemon process.
8+
# The setting is particularly useful for tweaking memory settings.
9+
org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8
10+
# When configured, Gradle will run in incubating parallel mode.
11+
# This option should only be used with decoupled projects. For more details, visit
12+
# https://developer.android.com/r/tools/gradle-multi-project-decoupled-projects
13+
# org.gradle.parallel=true
14+
# AndroidX package structure to make it clearer which packages are bundled with the
15+
# Android operating system, and which are packaged with your app's APK
16+
# https://developer.android.com/topic/libraries/support-library/androidx-rn
17+
android.useAndroidX=true
18+
# Kotlin code style for this project: "official" or "obsolete":
19+
kotlin.code.style=official
20+
# Enables namespacing of each library's R class so that its R class includes only the
21+
# resources declared in the library itself and none from the library's dependencies,
22+
# thereby reducing the size of the R class for that library
23+
android.nonTransitiveRClass=true

‎gradle/gradle-daemon-jvm.properties‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
#This file is generated by updateDaemonJvm
2+
toolchainUrl.FREE_BSD.AARCH64=https\://api.foojay.io/disco/v3.0/ids/ff1d4fc92bcfc9d3799beabb4e70cfa3/redirect
3+
toolchainUrl.FREE_BSD.X86_64=https\://api.foojay.io/disco/v3.0/ids/879378f84c64b2c76003b97a32968399/redirect
4+
toolchainUrl.LINUX.AARCH64=https\://api.foojay.io/disco/v3.0/ids/ff1d4fc92bcfc9d3799beabb4e70cfa3/redirect
5+
toolchainUrl.LINUX.X86_64=https\://api.foojay.io/disco/v3.0/ids/879378f84c64b2c76003b97a32968399/redirect
6+
toolchainUrl.MAC_OS.AARCH64=https\://api.foojay.io/disco/v3.0/ids/70ee42f1b0395356c016dbcb3e88f71d/redirect
7+
toolchainUrl.MAC_OS.X86_64=https\://api.foojay.io/disco/v3.0/ids/ee5178090598fb4291558827b9f00e0d/redirect
8+
toolchainUrl.UNIX.AARCH64=https\://api.foojay.io/disco/v3.0/ids/ff1d4fc92bcfc9d3799beabb4e70cfa3/redirect
9+
toolchainUrl.UNIX.X86_64=https\://api.foojay.io/disco/v3.0/ids/879378f84c64b2c76003b97a32968399/redirect
10+
toolchainUrl.WINDOWS.AARCH64=https\://api.foojay.io/disco/v3.0/ids/3dc48436acf46a9c2958682158988183/redirect
11+
toolchainUrl.WINDOWS.X86_64=https\://api.foojay.io/disco/v3.0/ids/d7d142be6e19e13dff41787c063f3185/redirect
12+
toolchainVendor=JETBRAINS
13+
toolchainVersion=21

0 commit comments

Comments
 (0)