Merge pull request #358 from lgandras/cloud-functions

Support for consistent function bundles

cloud-operations/asset-inventory-feed-remediation/main.tf

@@ -90,6 +90,7 @@ module "cf" {
   bundle_config = {
     source_dir  = "cf"
     output_path = var.bundle_path
+    excludes    = null
   }
   service_account = module.service-account.email
   trigger_config = {

cloud-operations/quota-monitoring/main.tf

@@ -62,6 +62,7 @@ module "cf" {
   bundle_config = {
     source_dir  = "cf"
     output_path = var.bundle_path
+    excludes    = null
   }
   # https://github.com/hashicorp/terraform-provider-archive/issues/40
   # https://issuetracker.google.com/issues/155215191

cloud-operations/scheduled-asset-inventory-export-bq/main.tf

@@ -82,6 +82,7 @@ module "cf" {
   bundle_config = {
     source_dir  = "cf"
     output_path = var.bundle_path
+    excludes    = null
   }
   service_account = module.service-account.email
   trigger_config = {

modules/cloud-function/README.md

@@ -23,6 +23,7 @@ module "cf-http" {
   bundle_config = {
     source_dir  = "my-cf-source-folder"
     output_path = "bundle.zip"
+    excludes    = null
   }
 }
 # tftest:skip
@@ -41,6 +42,7 @@ module "cf-http" {
   bundle_config = {
     source_dir  = "my-cf-source-folder"
     output_path = "bundle.zip"
+    excludes    = null
   }
   trigger_config = {
     event = "google.pubsub.topic.publish"
@@ -64,6 +66,7 @@ module "cf-http" {
   bundle_config = {
     source_dir  = "my-cf-source-folder"
     output_path = "bundle.zip"
+    excludes    = null
   }
   iam   = {
     "roles/cloudfunctions.invoker" = ["allUsers"]
@@ -89,6 +92,7 @@ module "cf-http" {
   bundle_config = {
     source_dir  = "my-cf-source-folder"
     output_path = "bundle.zip"
+    excludes    = null
   }
 }
 # tftest:skip
@@ -107,6 +111,7 @@ module "cf-http" {
   bundle_config = {
     source_dir  = "my-cf-source-folder"
     output_path = "bundle.zip"
+    excludes    = null
   }
   service_account_create = true
 }
@@ -124,19 +129,39 @@ module "cf-http" {
   bundle_config = {
     source_dir  = "my-cf-source-folder"
     output_path = "bundle.zip"
+    excludes    = null
   }
   service_account = local.service_account_email
 }
 # tftest:skip
 ```
 
+### Custom bundle config
+
+In order to help prevent `archive_zip.output_md5` from changing cross platform (e.g. Cloud Build vs your local development environment), you'll have to make sure that the files included in the zip are always the same.
+
+```hcl
+module "cf-http" {
+  source        = "./modules/cloud-function"
+  project_id    = "my-project"
+  name          = "test-cf-http"
+  bucket_name   = "test-cf-bundles"
+  bundle_config = {
+    source_dir  = "my-cf-source-folder"
+    output_path = "bundle.zip"
+    excludes    = ["__pycache__"]
+  }
+}
+# tftest:skip
+```
+
 <!-- BEGIN TFDOC -->
 ## Variables
 
 | name | description | type | required | default |
 |---|---|:---: |:---:|:---:|
 | bucket_name | Name of the bucket that will be used for the function code. It will be created with prefix prepended if bucket_config is not null. | <code title="">string</code> | ✓ |  |
-| bundle_config | Cloud function source folder and generated zip bundle paths. Output path defaults to '/tmp/bundle.zip' if null. | <code title="object&#40;&#123;&#10;source_dir  &#61; string&#10;output_path &#61; string&#10;&#125;&#41;">object({...})</code> | ✓ |  |
+| bundle_config | Cloud function source folder and generated zip bundle paths. Output path defaults to '/tmp/bundle.zip' if null. | <code title="object&#40;&#123;&#10;source_dir  &#61; string&#10;output_path &#61; string&#10;excludes    &#61; list&#40;string&#41;&#10;&#125;&#41;">object({...})</code> | ✓ |  |
 | name | Name used for cloud function and associated resources. | <code title="">string</code> | ✓ |  |
 | project_id | Project id used for all resources. | <code title="">string</code> | ✓ |  |
 | *bucket_config* | Enable and configure auto-created bucket. Set fields to null to use defaults. | <code title="object&#40;&#123;&#10;location             &#61; string&#10;lifecycle_delete_age &#61; number&#10;&#125;&#41;">object({...})</code> |  | <code title="">null</code> |

modules/cloud-function/main.tf

@@ -137,6 +137,8 @@ data "archive_file" "bundle" {
     ? "/tmp/bundle.zip"
     : var.bundle_config.output_path
   )
+  output_file_mode = "0666"
+  excludes         = var.bundle_config.excludes
 }
 
 resource "google_service_account" "service_account" {

modules/cloud-function/variables.tf

@@ -33,6 +33,7 @@ variable "bundle_config" {
   type = object({
     source_dir  = string
     output_path = string
+    excludes    = list(string)
   })
 }
 

networking/private-cloud-function-from-onprem/main.tf

@@ -208,6 +208,7 @@ module "function-hello" {
   bundle_config = {
     source_dir  = "${path.module}/assets"
     output_path = "bundle.zip"
+    excludes    = null
   }
   bucket_config = {
     location             = var.region

tests/modules/cloud_function/fixture/main.tf

@@ -22,6 +22,7 @@ module "test" {
   bundle_config = {
     source_dir  = "bundle"
     output_path = "bundle.zip"
+    excludes    = null
   }
   iam = {
     "roles/cloudfunctions.invoker" = ["allUsers"]