From ef290c1c8d2b66834eeb2a7a94df0eec425ab900 Mon Sep 17 00:00:00 2001 From: Julio Castillo Date: Fri, 6 Oct 2023 11:44:33 +0200 Subject: [PATCH] Enforce mandatory types in all variables (#1737) --- modules/bigtable-instance/README.md | 12 ++++---- modules/bigtable-instance/variables.tf | 1 + modules/data-catalog-policy-tag/README.md | 4 +-- modules/data-catalog-policy-tag/variables.tf | 3 +- modules/net-swp/README.md | 30 +++++++++----------- modules/net-swp/variables.tf | 1 + tools/check_documentation.py | 9 ++++++ 7 files changed, 35 insertions(+), 25 deletions(-) diff --git a/modules/bigtable-instance/README.md b/modules/bigtable-instance/README.md index 3328b37a6..703810a01 100644 --- a/modules/bigtable-instance/README.md +++ b/modules/bigtable-instance/README.md @@ -230,15 +230,15 @@ module "bigtable-instance" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| | [clusters](variables.tf#L17) | Clusters to be created in the BigTable instance. Set more than one cluster to enable replication. If you set autoscaling, num_nodes will be ignored. | map(object({…})) | ✓ | | -| [name](variables.tf#L80) | The name of the Cloud Bigtable instance. | string | ✓ | | -| [project_id](variables.tf#L85) | Id of the project where datasets will be created. | string | ✓ | | +| [name](variables.tf#L81) | The name of the Cloud Bigtable instance. | string | ✓ | | +| [project_id](variables.tf#L86) | Id of the project where datasets will be created. | string | ✓ | | | [default_autoscaling](variables.tf#L33) | Default settings for autoscaling of clusters. This will be the default autoscaling for any cluster not specifying any autoscaling details. | object({…}) | | null | | [default_gc_policy](variables.tf#L44) | Default garbage collection policy, to be applied to all column families and all tables. Can be override in the tables variable for specific column families. | object({…}) | | null | | [deletion_protection](variables.tf#L56) | Whether or not to allow Terraform to destroy the instance. Unless this field is set to false in Terraform state, a terraform destroy or terraform apply that would delete the instance will fail. | bool | | true | -| [display_name](variables.tf#L63) | The human-readable display name of the Bigtable instance. | | | null | -| [iam](variables.tf#L68) | IAM bindings for topic in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | -| [instance_type](variables.tf#L74) | (deprecated) The instance type to create. One of 'DEVELOPMENT' or 'PRODUCTION'. | string | | null | -| [tables](variables.tf#L90) | Tables to be created in the BigTable instance. | map(object({…})) | | {} | +| [display_name](variables.tf#L63) | The human-readable display name of the Bigtable instance. | string | | null | +| [iam](variables.tf#L69) | IAM bindings for topic in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | +| [instance_type](variables.tf#L75) | (deprecated) The instance type to create. One of 'DEVELOPMENT' or 'PRODUCTION'. | string | | null | +| [tables](variables.tf#L91) | Tables to be created in the BigTable instance. | map(object({…})) | | {} | ## Outputs diff --git a/modules/bigtable-instance/variables.tf b/modules/bigtable-instance/variables.tf index 52cf380df..d8567766a 100644 --- a/modules/bigtable-instance/variables.tf +++ b/modules/bigtable-instance/variables.tf @@ -62,6 +62,7 @@ variable "deletion_protection" { variable "display_name" { description = "The human-readable display name of the Bigtable instance." + type = string default = null } diff --git a/modules/data-catalog-policy-tag/README.md b/modules/data-catalog-policy-tag/README.md index 8a4647842..139c74708 100644 --- a/modules/data-catalog-policy-tag/README.md +++ b/modules/data-catalog-policy-tag/README.md @@ -80,7 +80,7 @@ module "cmn-dc" { | name | description | type | required | default | |---|---|:---:|:---:|:---:| | [name](variables.tf#L77) | Name of this taxonomy. | string | ✓ | | -| [project_id](variables.tf#L92) | GCP project id. | | ✓ | | +| [project_id](variables.tf#L92) | GCP project id. | string | ✓ | | | [activated_policy_types](variables.tf#L17) | A list of policy types that are activated for this taxonomy. | list(string) | | ["FINE_GRAINED_ACCESS_CONTROL"] | | [description](variables.tf#L23) | Description of this taxonomy. | string | | "Taxonomy - Terraform managed" | | [group_iam](variables.tf#L29) | Authoritative IAM binding for organization groups, in {GROUP_EMAIL => [ROLES]} format. Group emails need to be static. Can be used in combination with the `iam` variable. | map(list(string)) | | {} | @@ -89,7 +89,7 @@ module "cmn-dc" { | [iam_bindings_additive](variables.tf#L56) | Individual additive IAM bindings. Keys are arbitrary. | map(object({…})) | | {} | | [location](variables.tf#L71) | Data Catalog Taxonomy location. | string | | "eu" | | [prefix](variables.tf#L82) | Optional prefix used to generate project id and name. | string | | null | -| [tags](variables.tf#L96) | List of Data Catalog Policy tags to be created with optional IAM binging configuration in {tag => {ROLE => [MEMBERS]}} format. | map(object({…})) | | {} | +| [tags](variables.tf#L97) | List of Data Catalog Policy tags to be created with optional IAM binging configuration in {tag => {ROLE => [MEMBERS]}} format. | map(object({…})) | | {} | ## Outputs diff --git a/modules/data-catalog-policy-tag/variables.tf b/modules/data-catalog-policy-tag/variables.tf index 0fef9e7bd..a41990b91 100644 --- a/modules/data-catalog-policy-tag/variables.tf +++ b/modules/data-catalog-policy-tag/variables.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. @@ -91,6 +91,7 @@ variable "prefix" { variable "project_id" { description = "GCP project id." + type = string } variable "tags" { diff --git a/modules/net-swp/README.md b/modules/net-swp/README.md index 03fe246ca..37a86b24a 100644 --- a/modules/net-swp/README.md +++ b/modules/net-swp/README.md @@ -164,25 +164,24 @@ module "secure-web-proxy" { # tftest modules=1 resources=7 inventory=tls.yaml ``` - ## Variables | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [addresses](variables.tf#L19) | One or more IP addresses to be used for Secure Web Proxy. | | ✓ | | -| [certificates](variables.tf#L27) | List of certificates to be used for Secure Web Proxy. | list(string) | ✓ | | -| [name](variables.tf#L50) | Name of the Secure Web Proxy resource. | string | ✓ | | -| [network](variables.tf#L55) | Name of the network the Secure Web Proxy is deployed into. | string | ✓ | | -| [project_id](variables.tf#L119) | Project id of the project that holds the network. | string | ✓ | | -| [region](variables.tf#L124) | Region where resources will be created. | string | ✓ | | -| [subnetwork](variables.tf#L135) | Name of the subnetwork the Secure Web Proxy is deployed into. | string | ✓ | | -| [delete_swg_autogen_router_on_destroy](variables.tf#L32) | Delete automatically provisioned Cloud Router on destroy. | bool | | true | -| [description](variables.tf#L38) | Optional description for the created resources. | string | | "Managed by Terraform." | -| [labels](variables.tf#L44) | Resource labels. | map(string) | | {} | -| [policy_rules](variables.tf#L60) | List of policy rule definitions, default to allow action. Available keys: secure_tags, url_lists, custom. URL lists that only have values set will be created. | object({…}) | | {} | -| [ports](variables.tf#L113) | Ports to use for Secure Web Proxy. | list(number) | | [443] | -| [scope](variables.tf#L129) | Scope determines how configuration across multiple Gateway instances are merged. | string | | null | -| [tls_inspection_config](variables.tf#L140) | TLS inspection configuration. | object({…}) | | null | +| [addresses](variables.tf#L19) | One or more IP addresses to be used for Secure Web Proxy. | list(string) | ✓ | | +| [certificates](variables.tf#L28) | List of certificates to be used for Secure Web Proxy. | list(string) | ✓ | | +| [name](variables.tf#L51) | Name of the Secure Web Proxy resource. | string | ✓ | | +| [network](variables.tf#L56) | Name of the network the Secure Web Proxy is deployed into. | string | ✓ | | +| [project_id](variables.tf#L120) | Project id of the project that holds the network. | string | ✓ | | +| [region](variables.tf#L125) | Region where resources will be created. | string | ✓ | | +| [subnetwork](variables.tf#L136) | Name of the subnetwork the Secure Web Proxy is deployed into. | string | ✓ | | +| [delete_swg_autogen_router_on_destroy](variables.tf#L33) | Delete automatically provisioned Cloud Router on destroy. | bool | | true | +| [description](variables.tf#L39) | Optional description for the created resources. | string | | "Managed by Terraform." | +| [labels](variables.tf#L45) | Resource labels. | map(string) | | {} | +| [policy_rules](variables.tf#L61) | List of policy rule definitions, default to allow action. Available keys: secure_tags, url_lists, custom. URL lists that only have values set will be created. | object({…}) | | {} | +| [ports](variables.tf#L114) | Ports to use for Secure Web Proxy. | list(number) | | [443] | +| [scope](variables.tf#L130) | Scope determines how configuration across multiple Gateway instances are merged. | string | | null | +| [tls_inspection_config](variables.tf#L141) | TLS inspection configuration. | object({…}) | | null | ## Outputs @@ -191,5 +190,4 @@ module "secure-web-proxy" { | [gateway](outputs.tf#L17) | The gateway resource. | | | [gateway_security_policy](outputs.tf#L22) | The gateway security policy resource. | | | [id](outputs.tf#L27) | ID of the gateway resource. | | - diff --git a/modules/net-swp/variables.tf b/modules/net-swp/variables.tf index 17d9061ff..e491eded8 100644 --- a/modules/net-swp/variables.tf +++ b/modules/net-swp/variables.tf @@ -18,6 +18,7 @@ variable "addresses" { description = "One or more IP addresses to be used for Secure Web Proxy." + type = list(string) validation { condition = length(var.addresses) > 0 error_message = "Must specify at least one IP address." diff --git a/tools/check_documentation.py b/tools/check_documentation.py index 992e44849..965bf1a24 100755 --- a/tools/check_documentation.py +++ b/tools/check_documentation.py @@ -42,6 +42,7 @@ class State(enum.IntEnum): FAIL_OUTPUT_PERIOD = enum.auto() FAIL_VARIABLE_DESCRIPTION = enum.auto() FAIL_OUTPUT_DESCRIPTION = enum.auto() + FAIL_MISSING_TYPES = enum.auto() @property def failed(self): @@ -60,6 +61,7 @@ class State(enum.IntEnum): State.FAIL_OUTPUT_PERIOD: '.O', State.FAIL_VARIABLE_DESCRIPTION: 'DV', State.FAIL_OUTPUT_DESCRIPTION: 'DO', + State.FAIL_MISSING_TYPES: 'TY', }[self.value] @@ -144,6 +146,13 @@ def _check_dir(dir_name, exclude_files=None, files=False, show_extra=False): ', '.join(nc), ]) + elif no_types := [v.name for v in newvars if not v.type]: + state = state.FAIL_MISSING_TYPES + diff = "\n".join([ + f'----- {readme_rel} variables without types -----', + ', '.join(no_types), + ]) + yield readme_rel, state, diff