Merge pull request #24 from androidx/invalidbucketname

Validate that configured bucket for the project is valid

Author: liutikas

README.md

@@ -8,7 +8,7 @@ In your `settings.gradle.kts` file add the following
 
 ```kotlin
 plugins {
-    id("androidx.build.gradle.gcpbuildcache") version "1.0.0-alpha05"
+    id("androidx.build.gradle.gcpbuildcache") version "1.0.0-alpha06"
 }
 
 import androidx.build.gradle.gcpbuildcache.GcpBuildCache
@@ -36,7 +36,7 @@ If you are using Groovy, then you should do the following:
 
 ```groovy
 plugins {
-    id("androidx.build.gradle.gcpbuildcache") version "1.0.0-alpha05"
+    id("androidx.build.gradle.gcpbuildcache") version "1.0.0-alpha06"
 }
 
 import androidx.build.gradle.gcpbuildcache.GcpBuildCache

RELEASE-NOTES.md

@@ -1,5 +1,9 @@
 # Release notes for GCP backed Gradle Remote Cache
 
+## 1.0.0-alpha06
+
+- Warn when a user incorrectly configures GCP bucket to be used for the cache.
+
 ## 1.0.0-alpha05
 
 - Downloads `Blob`s to an intermediate `Buffer` or a `File` depending on the size of the blob.

gcpbuildcache/build.gradle.kts

@@ -45,16 +45,15 @@ gradlePlugin {
             id = "androidx.build.gradle.gcpbuildcache"
             displayName = "Gradle GCP Build Cache Plugin"
             description = """
-                Implementation of Gradle Build Cache that allows to use Google Cloud Platform
-                storage buckets as a back end.
+                - Warn when a user incorrectly configures GCP bucket to be used for the cache.
             """.trimIndent()
             implementationClass = "androidx.build.gradle.gcpbuildcache.GcpGradleBuildCachePlugin"
         }
     }
 }
 
 group = "androidx.build.gradle.gcpbuildcache"
-version = "1.0.0-alpha05"
+version = "1.0.0-alpha06"
 
 testing {
     suites {

gcpbuildcache/src/main/kotlin/androidx/build/gradle/gcpbuildcache/FileSystemStorageService.kt

@@ -76,6 +76,10 @@ internal class FileSystemStorageService(
         return file.delete()
     }
 
+    override fun validateConfiguration() {
+        // There is nothing to validate
+    }
+
     override fun close() {
         location.deleteRecursively()
     }

gcpbuildcache/src/main/kotlin/androidx/build/gradle/gcpbuildcache/GcpBuildCacheService.kt

@@ -70,6 +70,10 @@ internal class GcpBuildCacheService(
         storageService.store(cacheKey, output.toByteArray())
     }
 
+    fun validateConfiguration() {
+        storageService.validateConfiguration()
+    }
+
     companion object {
         // Build Cache Key Helpers
         private val SLASHES = """"/+""".toRegex()

gcpbuildcache/src/main/kotlin/androidx/build/gradle/gcpbuildcache/GcpBuildCacheServiceFactory.kt

@@ -39,12 +39,14 @@ class GcpBuildCacheServiceFactory : BuildCacheServiceFactory<GcpBuildCache> {
                 "${buildCache.credentials is ExportedKeyGcpCredentials}"
             )
 
-        return GcpBuildCacheService(
+        val service = GcpBuildCacheService(
             buildCache.projectId,
             buildCache.bucketName,
             buildCache.credentials,
             buildCache.isPush,
             buildCache.isEnabled
         )
+        service.validateConfiguration()
+        return service
     }
 }

gcpbuildcache/src/main/kotlin/androidx/build/gradle/gcpbuildcache/GcpStorageService.kt

@@ -45,7 +45,6 @@ internal class GcpStorageService(
             logger.info("Not Enabled")
             return null
         }
-
         val blobId = BlobId.of(bucketName, cacheKey)
         logger.info("Loading $cacheKey from ${blobId.name}")
         return load(storageOptions, blobId, sizeThreshold)
@@ -80,6 +79,16 @@ internal class GcpStorageService(
         return Companion.delete(storageOptions, blobId)
     }
 
+    override fun validateConfiguration() {
+        if (storageOptions?.service?.get(bucketName, Storage.BucketGetOption.fields()) == null) {
+            throw Exception("""
+                Bucket $bucketName under project $projectId cannot be found or it is not accessible using the provided
+                credentials.
+                """.trimIndent()
+            )
+        }
+    }
+
     override fun close() {
         // Does nothing
     }

gcpbuildcache/src/main/kotlin/androidx/build/gradle/gcpbuildcache/StorageService.kt

@@ -59,4 +59,9 @@ interface StorageService : Closeable {
      * @param cacheKey is the unique key that can identify a resource that needs to be removed.
      */
     fun delete(cacheKey: String): Boolean
+
+    /**
+     * Checks of the current configuration is valid. Throws an exception if the state is bad.
+     */
+    fun validateConfiguration()
 }