Skip to content

Fix: gradle secrets enforcement breaking tests #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dkhawk wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Fix: gradle secrets enforcement breaking tests #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
55b54f4
fix: bypass secrets check in CI and fix launchDebug package
dkhawk Jan 27, 2026
a7cb503
chore: remove .vscode from tracking and ignore it
dkhawk Jan 27, 2026
8b6b686
merge: Resolve conflicts with main and update CI secrets check
dkhawk Mar 26, 2026
e995f80
Merge branch 'main' into fix/gradle-secrets-enforcement-breaking-tests
dkhawk Apr 2, 2026
88c2613
build(secrets): centralize validation and modernize CI bypass
dkhawk Apr 2, 2026
e41e239
Merge branch 'main' into fix/gradle-secrets-enforcement-breaking-tests
dkhawk May 20, 2026
bcc4fe0
ci: include unit tests in build workflow
dkhawk May 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions .github/workflows/build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,9 @@ jobs:
distribution: 'adopt'
java-version: '21'
- name: Build ApiDemos
run: cd Maps3DSamples/ApiDemos && ./gradlew buildDebugPreBundle
run: ./gradlew :Maps3DSamples:ApiDemos:java-app:assembleDebug :Maps3DSamples:ApiDemos:kotlin-app:assembleDebug
- name: Run ApiDemos Unit Tests
run: ./gradlew :Maps3DSamples:ApiDemos:java-app:testDebugUnitTest :Maps3DSamples:ApiDemos:kotlin-app:testDebugUnitTest

build-advanced:
runs-on: ubuntu-latest
Expand All @@ -52,4 +54,6 @@ jobs:
distribution: 'adopt'
java-version: '21'
- name: Build advanced
run: cd Maps3DSamples/advanced && ./gradlew buildDebugPreBundle
run: ./gradlew :Maps3DSamples:advanced:app:assembleDebug
- name: Run advanced Unit Tests
run: ./gradlew :Maps3DSamples:advanced:app:testDebugUnitTest
8 changes: 0 additions & 8 deletions LOG.md
View file
Open in desktop

This file was deleted.

62 changes: 8 additions & 54 deletions Maps3DSamples/ApiDemos/java-app/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,59 +14,7 @@
* limitations under the License.
*/

import java.util.Properties
import org.gradle.api.GradleException

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

if (!isCI) {
val requestedTasks = gradle.startParameter.taskNames
if (requestedTasks.isEmpty() && !secretsFile.exists()) {
// It's likely an IDE sync if no tasks are specified, so just issue a warning.
println("Warning: secrets.properties not found. Gradle sync may succeed, but building/running the app will fail.")
} else if (requestedTasks.isNotEmpty()) {
val buildTaskKeywords = listOf("build", "install", "assemble")
val isBuildTask = requestedTasks.any { task ->
buildTaskKeywords.any { keyword ->
task.contains(keyword, ignoreCase = true)
}
}

val testTaskKeywords = listOf("test", "report", "lint")
val isTestTask = requestedTasks.any { task ->
testTaskKeywords.any { keyword ->
task.contains(keyword, ignoreCase = true)
}
}

val isDebugTask = requestedTasks.any { task ->
task.contains("Debug", ignoreCase = true) || task.contains("installAndLaunch", ignoreCase = true)
}

if (isBuildTask && !isTestTask && isDebugTask) {
val defaultsFile = rootProject.file("local.defaults.properties")
val requiredKeysMessage = if (defaultsFile.exists()) {
defaultsFile.readText()
} else {
"MAPS3D_API_KEY=<YOUR_API_KEY>"
}

if (!secretsFile.exists()) {
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")
}

val secrets = Properties()
secretsFile.inputStream().use { secrets.load(it) }
val apiKey = secrets.getProperty("MAPS3D_API_KEY")

if (apiKey.isNullOrBlank() || !apiKey.matches(Regex("^AIza[a-zA-Z0-9_-]{35}$"))) {
throw GradleException("Invalid or missing MAPS3D_API_KEY in secrets.properties. Please provide a valid Google Maps API key (starts with 'AIza').")
}
}
}
}
val isCI = rootProject.extra["isCI"] as? Boolean ?: false

plugins {
alias(libs.plugins.android.application)
Expand All @@ -88,7 +36,13 @@ android {
versionName = "1.0"

testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
manifestPlaceholders["MAPS3D_API_KEY"] = "DEFAULT_API_KEY"

if (isCI) {
manifestPlaceholders["MAPS3D_API_KEY"] = "DEFAULT_API_KEY"
manifestPlaceholders["PLACES_API_KEY"] = "DEFAULT_API_KEY"
}

buildConfigField("Boolean", "IS_CI", "${isCI}")
}

buildTypes {
Expand Down
3 changes: 3 additions & 0 deletions ...Samples/ApiDemos/java-app/src/main/java/com/example/maps3djava/Maps3DJavaApplication.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,9 @@ public void onCreate() {
* incorrectly configured, and a RuntimeException is thrown.
*/
private void checkApiKey() {
if (BuildConfig.IS_CI) {
return;
}
try {
ApplicationInfo appInfo =
getPackageManager().getApplicationInfo(getPackageName(), PackageManager.GET_META_DATA);
Expand Down
63 changes: 8 additions & 55 deletions Maps3DSamples/ApiDemos/kotlin-app/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,60 +14,7 @@
* limitations under the License.
*/

import org.gradle.api.GradleException
import java.io.File
import java.util.Properties

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

if (!isCI) {
val requestedTasks = gradle.startParameter.taskNames
if (requestedTasks.isEmpty() && !secretsFile.exists()) {
// It's likely an IDE sync if no tasks are specified, so just issue a warning.
println("Warning: secrets.properties not found. Gradle sync may succeed, but building/running the app will fail.")
} else if (requestedTasks.isNotEmpty()) {
val buildTaskKeywords = listOf("build", "install", "assemble")
val isBuildTask = requestedTasks.any { task ->
buildTaskKeywords.any { keyword ->
task.contains(keyword, ignoreCase = true)
}
}

val testTaskKeywords = listOf("test", "report", "lint")
val isTestTask = requestedTasks.any { task ->
testTaskKeywords.any { keyword ->
task.contains(keyword, ignoreCase = true)
}
}

val isDebugTask = requestedTasks.any { task ->
task.contains("Debug", ignoreCase = true) || task.contains("installAndLaunch", ignoreCase = true)
}

if (isBuildTask && !isTestTask && isDebugTask) {
val defaultsFile = rootProject.file("local.defaults.properties")
val requiredKeysMessage = if (defaultsFile.exists()) {
defaultsFile.readText()
} else {
"MAPS3D_API_KEY=<YOUR_API_KEY>"
}

if (!secretsFile.exists()) {
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")
}

val secrets = Properties()
secretsFile.inputStream().use { secrets.load(it) }
val apiKey = secrets.getProperty("MAPS3D_API_KEY")

if (apiKey.isNullOrBlank() || !apiKey.matches(Regex("^AIza[a-zA-Z0-9_-]{35}$"))) {
throw GradleException("Invalid or missing MAPS3D_API_KEY in secrets.properties. Please provide a valid Google Maps API key (starts with 'AIza').")
}
}
}
}
val isCI = rootProject.extra["isCI"] as? Boolean ?: false

plugins {
alias(libs.plugins.android.application)
Expand All @@ -91,7 +38,13 @@ android {
versionName = "1.8.0"

testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
manifestPlaceholders["MAPS3D_API_KEY"] = "DEFAULT_API_KEY"

if (isCI) {
manifestPlaceholders["MAPS3D_API_KEY"] = "DEFAULT_API_KEY"
manifestPlaceholders["PLACES_API_KEY"] = "DEFAULT_API_KEY"
}

buildConfigField("Boolean", "IS_CI", "${isCI}")
}

buildTypes {
Expand Down
3 changes: 3 additions & 0 deletions ...les/ApiDemos/kotlin-app/src/main/java/com/example/maps3dkotlin/Maps3DKotlinApplication.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,9 @@ class Maps3DKotlinApplication : Application() {
* incorrectly configured, and a RuntimeException is thrown.
*/
private fun checkApiKey() {
if (BuildConfig.IS_CI) {
return
}
try {
val appInfo =
packageManager.getApplicationInfo(packageName, PackageManager.GET_META_DATA)
Expand Down
63 changes: 8 additions & 55 deletions Maps3DSamples/advanced/app/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,59 +14,7 @@
* limitations under the License.
*/

import java.util.Properties
import org.gradle.api.GradleException

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

if (!isCI) {
val requestedTasks = gradle.startParameter.taskNames
if (requestedTasks.isEmpty() && !secretsFile.exists()) {
// It's likely an IDE sync if no tasks are specified, so just issue a warning.
println("Warning: secrets.properties not found. Gradle sync may succeed, but building/running the app will fail.")
} else if (requestedTasks.isNotEmpty()) {
val buildTaskKeywords = listOf("build", "install", "assemble")
val isBuildTask = requestedTasks.any { task ->
buildTaskKeywords.any { keyword ->
task.contains(keyword, ignoreCase = true)
}
}

val testTaskKeywords = listOf("test", "report", "lint")
val isTestTask = requestedTasks.any { task ->
testTaskKeywords.any { keyword ->
task.contains(keyword, ignoreCase = true)
}
}

val isDebugTask = requestedTasks.any { task ->
task.contains("Debug", ignoreCase = true) || task.contains("installAndLaunch", ignoreCase = true)
}

if (isBuildTask && !isTestTask && isDebugTask) {
val defaultsFile = rootProject.file("local.defaults.properties")
val requiredKeysMessage = if (defaultsFile.exists()) {
defaultsFile.readText()
} else {
"MAPS3D_API_KEY=<YOUR_API_KEY>"
}

if (!secretsFile.exists()) {
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")
}

val secrets = Properties()
secretsFile.inputStream().use { secrets.load(it) }
val apiKey = secrets.getProperty("MAPS3D_API_KEY")

if (apiKey.isNullOrBlank() || !apiKey.matches(Regex("^AIza[a-zA-Z0-9_-]{35}$"))) {
throw GradleException("Invalid or missing MAPS3D_API_KEY in secrets.properties. Please provide a valid Google Maps API key (starts with 'AIza').")
}
}
}
}
val isCI = rootProject.extra["isCI"] as? Boolean ?: false

plugins {
alias(libs.plugins.android.application)
Expand Down Expand Up @@ -94,7 +42,12 @@ android {
versionName = "1.8.0"

testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
manifestPlaceholders["MAPS3D_API_KEY"] = "DEFAULT_API_KEY"

if (isCI) {
manifestPlaceholders["MAPS3D_API_KEY"] = "DEFAULT_API_KEY"
manifestPlaceholders["PLACES_API_KEY"] = "DEFAULT_API_KEY"
}
buildConfigField("Boolean", "IS_CI", "${isCI}")
}

buildTypes {
Expand Down Expand Up @@ -178,4 +131,4 @@ tasks.register<Exec>("installAndLaunch") {
commandLine("adb", "shell", "am", "start", "-n", "com.example.advancedmaps3dsamples/.MainActivity")
}

tasks.register("prepareKotlinBuildScriptModel"){}
tasks.register("prepareKotlinBuildScriptModel"){}
9 changes: 9 additions & 0 deletions PlacesUIKit3D/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
* limitations under the License.
*/

val isCI = rootProject.extra["isCI"] as? Boolean ?: false

// The `plugins` block is where we apply Gradle plugins to this module.
// Plugins add new tasks and configurations to our build process.
plugins {
Expand Down Expand Up @@ -57,6 +59,13 @@ android {

// Specifies the instrumentation runner for running Android tests.
testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"

if (isCI) {
manifestPlaceholders["MAPS3D_API_KEY"] = "DEFAULT_API_KEY"
manifestPlaceholders["PLACES_API_KEY"] = "DEFAULT_API_KEY"
}

buildConfigField("Boolean", "IS_CI", "${isCI}")
}

buildTypes {
Expand Down
6 changes: 6 additions & 0 deletions PlacesUIKit3D/src/main/java/com/example/placesuikit3d/Maps3DPlacesApplication.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ class Maps3DPlacesApplication : Application() {
}

private fun initializePlaces() {
if (BuildConfig.IS_CI) {
return
}
val apiKey = BuildConfig.PLACES_API_KEY

if (apiKey == null || apiKey.isBlank() || apiKey == "DEFAULT_API_KEY") {
Expand All @@ -58,6 +61,9 @@ class Maps3DPlacesApplication : Application() {
* incorrectly configured, and a RuntimeException is thrown.
*/
private fun checkApiKey() {
if (BuildConfig.IS_CI) {
return
}
try {
val appInfo =
packageManager.getApplicationInfo(packageName, PackageManager.GET_META_DATA)
Expand Down
Loading
Loading