Merge pull request #1101 from GoogleCloudPlatform/jccb/test-updates

First batch of testing updates to core modules
GoogleCloudPlatform · Jan 20, 2023 · fef45ed · fef45ed
2 parents c1d3736 + 1335277
commit fef45ed
Show file tree

Hide file tree

Showing 79 changed files with 1,807 additions and 1,362 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -754,7 +754,7 @@ def test_name(plan_summary, tfvars_to_yaml, tmp_path):
   assert s.values[address]['project'] == 'my-project'
 ```
 
-For more examples on how to write python tests, the tests for  [`organization`](./tests/modules/organization/test_plan_org_policies.py) and [`net-vpc`](./tests/modules/net_vpc/test_routes.py) modules.
+For more examples on how to write python tests, check the tests for the [`organization`](./tests/modules/organization/test_plan_org_policies.py) module.
 
 #### Testing documentation examples
 

diff --git a/modules/api-gateway/README.md b/modules/api-gateway/README.md
@@ -1,4 +1,4 @@
-# Api Gateway
+# API Gateway
 This module allows creating an API with its associated API config and API gateway. It also allows you grant IAM roles on the created resources.
 
 # Examples
@@ -15,46 +15,46 @@ module "gateway" {
   # ...
   EOT
 }
-# tftest modules=1 resources=4
+# tftest modules=1 resources=4 inventory=basic.yaml
 ```
 
-## Basic example + customer service account
+## Use existing service account
 ```hcl
 module "gateway" {
   source                = "./fabric/modules/api-gateway"
   project_id            = "my-project"
   api_id                = "api"
   region                = "europe-west1"
-  spec                  = <<EOT
-  # The OpenAPI spec contents
-  # ...
-  EOT
   service_account_email = "[email protected]"
   iam = {
     "roles/apigateway.admin" = ["user:[email protected]"]
   }
+  spec = <<EOT
+  # The OpenAPI spec contents
+  # ...
+  EOT
 }
-# tftest modules=1 resources=7
+# tftest modules=1 resources=7 inventory=existing-sa.yaml
 ```
 
-## Basic example + service account creation
+## Create service account
 ```hcl
 module "gateway" {
   source                 = "./fabric/modules/api-gateway"
   project_id             = "my-project"
   api_id                 = "api"
   region                 = "europe-west1"
-  spec                   = <<EOT
-  # The OpenAPI spec contents
-  # ...
-  EOT
   service_account_create = true
   iam = {
     "roles/apigateway.admin"  = ["user:[email protected]"]
     "roles/apigateway.viewer" = ["user:[email protected]"]
   }
+  spec = <<EOT
+  # The OpenAPI spec contents
+  # ...
+  EOT
 }
-# tftest modules=1 resources=11
+# tftest modules=1 resources=11 inventory=create-sa.yaml
 ```
 <!-- BEGIN TFDOC -->
 

diff --git a/modules/dns/README.md b/modules/dns/README.md
@@ -21,7 +21,7 @@ module "private-dns" {
     "A myhost"    = { ttl = 600, records = ["10.0.0.120"] }
   }
 }
-# tftest modules=1 resources=3
+# tftest modules=1 resources=3 inventory=private-zone.yaml
 ```
 
 ### Forwarding Zone
@@ -36,7 +36,7 @@ module "private-dns" {
   client_networks = [var.vpc.self_link]
   forwarders      = { "10.0.1.1" = null, "1.2.3.4" = "private" }
 }
-# tftest modules=1 resources=1
+# tftest modules=1 resources=1 inventory=forwarding-zone.yaml
 ```
 
 ### Peering Zone
@@ -47,11 +47,12 @@ module "private-dns" {
   project_id      = "myproject"
   type            = "peering"
   name            = "test-example"
-  domain          = "test.example."
+  domain          = "."
+  description     = "Forwarding zone for ."
   client_networks = [var.vpc.self_link]
   peer_network    = var.vpc2.self_link
 }
-# tftest modules=1 resources=1
+# tftest modules=1 resources=1 inventory=peering-zone.yaml
 ```
 
 ### Routing Policies
@@ -84,7 +85,7 @@ module "private-dns" {
     }
   }
 }
-# tftest modules=1 resources=4
+# tftest modules=1 resources=4 inventory=routing-policies.yaml
 ```
 
 ### Reverse Lookup Zone
@@ -98,7 +99,23 @@ module "private-dns" {
   domain          = "0.0.10.in-addr.arpa."
   client_networks = [var.vpc.self_link]
 }
-# tftest modules=1 resources=1
+# tftest modules=1 resources=1 inventory=reverse-zone.yaml
+```
+
+### Public Zone
+
+```hcl
+module "public-dns" {
+  source     = "./fabric/modules/dns"
+  project_id = "myproject"
+  type       = "public"
+  name       = "example"
+  domain     = "example.com."
+  recordsets = {
+    "A myhost" = { ttl = 300, records = ["127.0.0.1"] }
+  }
+}
+# tftest modules=1 resources=3 inventory=public-zone.yaml
 ```
 <!-- BEGIN TFDOC -->
 

diff --git a/modules/dns/main.tf b/modules/dns/main.tf
@@ -1,5 +1,5 @@
 /**
- * Copyright 2022 Google LLC
+ * Copyright 2023 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/modules/gcs/README.md b/modules/gcs/README.md
@@ -8,50 +8,46 @@ module "bucket" {
   project_id = "myproject"
   prefix     = "test"
   name       = "my-bucket"
+  versioning = true
   iam = {
     "roles/storage.admin" = ["group:[email protected]"]
   }
+  labels = {
+    cost-center = "devops"
+  }
 }
-# tftest modules=1 resources=2
+# tftest modules=1 resources=2 inventory=simple.yaml
 ```
 
 ### Example with Cloud KMS
 
 ```hcl
 module "bucket" {
-  source     = "./fabric/modules/gcs"
-  project_id = "myproject"
-  prefix     = "test"
-  name       = "my-bucket"
-  iam = {
-    "roles/storage.admin" = ["group:[email protected]"]
-  }
+  source         = "./fabric/modules/gcs"
+  project_id     = "myproject"
+  name           = "my-bucket"
   encryption_key = "my-encryption-key"
 }
-# tftest modules=1 resources=2
+# tftest modules=1 resources=1 inventory=cmek.yaml
 ```
 
-### Example with retention policy
+### Example with retention policy and logging
 
 ```hcl
 module "bucket" {
   source     = "./fabric/modules/gcs"
   project_id = "myproject"
-  prefix     = "test"
   name       = "my-bucket"
-  iam = {
-    "roles/storage.admin" = ["group:[email protected]"]
-  }
   retention_policy = {
     retention_period = 100
     is_locked        = true
   }
   logging_config = {
-    log_bucket        = var.bucket
+    log_bucket        = "log-bucket"
     log_object_prefix = null
   }
 }
-# tftest modules=1 resources=2
+# tftest modules=1 resources=1 inventory=retention-logging.yaml
 ```
 
 ### Example with lifecycle rule
@@ -60,11 +56,7 @@ module "bucket" {
 module "bucket" {
   source     = "./fabric/modules/gcs"
   project_id = "myproject"
-  prefix     = "test"
   name       = "my-bucket"
-  iam = {
-    "roles/storage.admin" = ["group:[email protected]"]
-  }
   lifecycle_rules = {
     lr-0 = {
       action = {
@@ -77,7 +69,7 @@ module "bucket" {
     }
   }
 }
-# tftest modules=1 resources=2
+# tftest modules=1 resources=1 inventory=lifecycle.yaml
 ```
 
 ### Minimal example with GCS notifications
@@ -86,7 +78,6 @@ module "bucket" {
 module "bucket-gcs-notification" {
   source     = "./fabric/modules/gcs"
   project_id = "myproject"
-  prefix     = "test"
   name       = "my-bucket"
   notification_config = {
     enabled           = true
@@ -97,7 +88,7 @@ module "bucket-gcs-notification" {
     custom_attributes = {}
   }
 }
-# tftest modules=1 resources=4
+# tftest modules=1 resources=4 inventory=notification.yaml
 ```
 <!-- BEGIN TFDOC -->
 

diff --git a/modules/gke-cluster/README.md b/modules/gke-cluster/README.md
@@ -33,7 +33,7 @@ module "cluster-1" {
     environment = "dev"
   }
 }
-# tftest modules=1 resources=1
+# tftest modules=1 resources=1 inventory=basic.yaml
 ```
 
 ### GKE Cluster with Dataplane V2 enabled
@@ -42,7 +42,7 @@ module "cluster-1" {
 module "cluster-1" {
   source     = "./fabric/modules/gke-cluster"
   project_id = "myproject"
-  name       = "cluster-1"
+  name       = "cluster-dataplane-v2"
   location   = "europe-west1-b"
   vpc_config = {
     network    = var.vpc.self_link
@@ -68,8 +68,36 @@ module "cluster-1" {
     environment = "dev"
   }
 }
-# tftest modules=1 resources=1
+# tftest modules=1 resources=1 inventory=dataplane-v2.yaml
+```
+### Autopilot Cluster
+
+```hcl
+module "cluster-autopilot" {
+  source     = "./fabric/modules/gke-cluster"
+  project_id = "myproject"
+  name       = "cluster-autopilot"
+  location   = "europe-west1-b"
+  vpc_config = {
+    network    = var.vpc.self_link
+    subnetwork = var.subnet.self_link
+    secondary_range_names = {
+      pods     = "pods"
+      services = "services"
+    }
+    master_authorized_ranges = {
+      internal-vms = "10.0.0.0/8"
+    }
+    master_ipv4_cidr_block = "192.168.0.0/28"
+  }
+  enable_features = {
+    autopilot = true
+  }
+}
+# tftest modules=1 resources=1 inventory=autopilot.yaml
 ```
+
+
 <!-- BEGIN TFDOC -->
 
 ## Variables