Enforce mandatory types in all variables (#1737)
This commit is contained in:
Julio Castillo
GitHub
parent
bb76878d0d
commit
ef290c1c8d
|
|
@ -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. | <code title="map(object({ zone = optional(string) storage_type = optional(string) num_nodes = optional(number) autoscaling = optional(object({ min_nodes = number max_nodes = number cpu_target = number storage_target = optional(number) })) }))">map(object({…}))</code> | ✓ | |
|
||||
| [name](variables.tf#L80) | The name of the Cloud Bigtable instance. | <code>string</code> | ✓ | |
|
||||
| [project_id](variables.tf#L85) | Id of the project where datasets will be created. | <code>string</code> | ✓ | |
|
||||
| [name](variables.tf#L81) | The name of the Cloud Bigtable instance. | <code>string</code> | ✓ | |
|
||||
| [project_id](variables.tf#L86) | Id of the project where datasets will be created. | <code>string</code> | ✓ | |
|
||||
| [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. | <code title="object({ min_nodes = number max_nodes = number cpu_target = number storage_target = optional(number) })">object({…})</code> | | <code>null</code> |
|
||||
| [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. | <code title="object({ deletion_policy = optional(string) gc_rules = optional(string) mode = optional(string) max_age = optional(string) max_version = optional(string) })">object({…})</code> | | <code>null</code> |
|
||||
| [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. | <code>bool</code> | | <code>true</code> |
|
||||
| [display_name](variables.tf#L63) | The human-readable display name of the Bigtable instance. | <code></code> | | <code>null</code> |
|
||||
| [iam](variables.tf#L68) | IAM bindings for topic in {ROLE => [MEMBERS]} format. | <code>map(list(string))</code> | | <code>{}</code> |
|
||||
| [instance_type](variables.tf#L74) | (deprecated) The instance type to create. One of 'DEVELOPMENT' or 'PRODUCTION'. | <code>string</code> | | <code>null</code> |
|
||||
| [tables](variables.tf#L90) | Tables to be created in the BigTable instance. | <code title="map(object({ split_keys = optional(list(string), []) column_families = optional(map(object( { gc_policy = optional(object({ deletion_policy = optional(string) gc_rules = optional(string) mode = optional(string) max_age = optional(string) max_version = optional(string) }), null) })), {}) }))">map(object({…}))</code> | | <code>{}</code> |
|
||||
| [display_name](variables.tf#L63) | The human-readable display name of the Bigtable instance. | <code>string</code> | | <code>null</code> |
|
||||
| [iam](variables.tf#L69) | IAM bindings for topic in {ROLE => [MEMBERS]} format. | <code>map(list(string))</code> | | <code>{}</code> |
|
||||
| [instance_type](variables.tf#L75) | (deprecated) The instance type to create. One of 'DEVELOPMENT' or 'PRODUCTION'. | <code>string</code> | | <code>null</code> |
|
||||
| [tables](variables.tf#L91) | Tables to be created in the BigTable instance. | <code title="map(object({ split_keys = optional(list(string), []) column_families = optional(map(object( { gc_policy = optional(object({ deletion_policy = optional(string) gc_rules = optional(string) mode = optional(string) max_age = optional(string) max_version = optional(string) }), null) })), {}) }))">map(object({…}))</code> | | <code>{}</code> |
|
||||
|
||||
## Outputs
|
||||
|
||||
|
|
|
|||
|
|
@ -62,6 +62,7 @@ variable "deletion_protection" {
|
|||
|
||||
variable "display_name" {
|
||||
description = "The human-readable display name of the Bigtable instance."
|
||||
type = string
|
||||
default = null
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -80,7 +80,7 @@ module "cmn-dc" {
|
|||
| name | description | type | required | default |
|
||||
|---|---|:---:|:---:|:---:|
|
||||
| [name](variables.tf#L77) | Name of this taxonomy. | <code>string</code> | ✓ | |
|
||||
| [project_id](variables.tf#L92) | GCP project id. | <code></code> | ✓ | |
|
||||
| [project_id](variables.tf#L92) | GCP project id. | <code>string</code> | ✓ | |
|
||||
| [activated_policy_types](variables.tf#L17) | A list of policy types that are activated for this taxonomy. | <code>list(string)</code> | | <code>["FINE_GRAINED_ACCESS_CONTROL"]</code> |
|
||||
| [description](variables.tf#L23) | Description of this taxonomy. | <code>string</code> | | <code>"Taxonomy - Terraform managed"</code> |
|
||||
| [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. | <code>map(list(string))</code> | | <code>{}</code> |
|
||||
|
|
@ -89,7 +89,7 @@ module "cmn-dc" {
|
|||
| [iam_bindings_additive](variables.tf#L56) | Individual additive IAM bindings. Keys are arbitrary. | <code title="map(object({ member = string role = string condition = optional(object({ expression = string title = string description = optional(string) })) }))">map(object({…}))</code> | | <code>{}</code> |
|
||||
| [location](variables.tf#L71) | Data Catalog Taxonomy location. | <code>string</code> | | <code>"eu"</code> |
|
||||
| [prefix](variables.tf#L82) | Optional prefix used to generate project id and name. | <code>string</code> | | <code>null</code> |
|
||||
| [tags](variables.tf#L96) | List of Data Catalog Policy tags to be created with optional IAM binging configuration in {tag => {ROLE => [MEMBERS]}} format. | <code title="map(object({ description = optional(string) iam = optional(map(list(string)), {}) }))">map(object({…}))</code> | | <code>{}</code> |
|
||||
| [tags](variables.tf#L97) | List of Data Catalog Policy tags to be created with optional IAM binging configuration in {tag => {ROLE => [MEMBERS]}} format. | <code title="map(object({ description = optional(string) iam = optional(map(list(string)), {}) }))">map(object({…}))</code> | | <code>{}</code> |
|
||||
|
||||
## Outputs
|
||||
|
||||
|
|
|
|||
|
|
@ -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" {
|
||||
|
|
|
|||
|
|
@ -164,25 +164,24 @@ module "secure-web-proxy" {
|
|||
# tftest modules=1 resources=7 inventory=tls.yaml
|
||||
```
|
||||
<!-- BEGIN TFDOC -->
|
||||
|
||||
## Variables
|
||||
|
||||
| name | description | type | required | default |
|
||||
|---|---|:---:|:---:|:---:|
|
||||
| [addresses](variables.tf#L19) | One or more IP addresses to be used for Secure Web Proxy. | <code></code> | ✓ | |
|
||||
| [certificates](variables.tf#L27) | List of certificates to be used for Secure Web Proxy. | <code>list(string)</code> | ✓ | |
|
||||
| [name](variables.tf#L50) | Name of the Secure Web Proxy resource. | <code>string</code> | ✓ | |
|
||||
| [network](variables.tf#L55) | Name of the network the Secure Web Proxy is deployed into. | <code>string</code> | ✓ | |
|
||||
| [project_id](variables.tf#L119) | Project id of the project that holds the network. | <code>string</code> | ✓ | |
|
||||
| [region](variables.tf#L124) | Region where resources will be created. | <code>string</code> | ✓ | |
|
||||
| [subnetwork](variables.tf#L135) | Name of the subnetwork the Secure Web Proxy is deployed into. | <code>string</code> | ✓ | |
|
||||
| [delete_swg_autogen_router_on_destroy](variables.tf#L32) | Delete automatically provisioned Cloud Router on destroy. | <code>bool</code> | | <code>true</code> |
|
||||
| [description](variables.tf#L38) | Optional description for the created resources. | <code>string</code> | | <code>"Managed by Terraform."</code> |
|
||||
| [labels](variables.tf#L44) | Resource labels. | <code>map(string)</code> | | <code>{}</code> |
|
||||
| [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. | <code title="object({ secure_tags = optional(map(object({ tag = string session_matcher = optional(string) application_matcher = optional(string) priority = number action = optional(string, "ALLOW") enabled = optional(bool, true) tls_inspection_enabled = optional(bool, false) description = optional(string) })), {}) url_lists = optional(map(object({ url_list = string values = optional(list(string)) session_matcher = optional(string) application_matcher = optional(string) priority = number action = optional(string, "ALLOW") enabled = optional(bool, true) tls_inspection_enabled = optional(bool, false) description = optional(string) })), {}) custom = optional(map(object({ session_matcher = optional(string) application_matcher = optional(string) priority = number action = optional(string, "ALLOW") enabled = optional(bool, true) tls_inspection_enabled = optional(bool, false) description = optional(string) })), {}) })">object({…})</code> | | <code>{}</code> |
|
||||
| [ports](variables.tf#L113) | Ports to use for Secure Web Proxy. | <code>list(number)</code> | | <code>[443]</code> |
|
||||
| [scope](variables.tf#L129) | Scope determines how configuration across multiple Gateway instances are merged. | <code>string</code> | | <code>null</code> |
|
||||
| [tls_inspection_config](variables.tf#L140) | TLS inspection configuration. | <code title="object({ ca_pool = optional(string, null) exclude_public_ca_set = optional(bool, false) description = optional(string) })">object({…})</code> | | <code>null</code> |
|
||||
| [addresses](variables.tf#L19) | One or more IP addresses to be used for Secure Web Proxy. | <code>list(string)</code> | ✓ | |
|
||||
| [certificates](variables.tf#L28) | List of certificates to be used for Secure Web Proxy. | <code>list(string)</code> | ✓ | |
|
||||
| [name](variables.tf#L51) | Name of the Secure Web Proxy resource. | <code>string</code> | ✓ | |
|
||||
| [network](variables.tf#L56) | Name of the network the Secure Web Proxy is deployed into. | <code>string</code> | ✓ | |
|
||||
| [project_id](variables.tf#L120) | Project id of the project that holds the network. | <code>string</code> | ✓ | |
|
||||
| [region](variables.tf#L125) | Region where resources will be created. | <code>string</code> | ✓ | |
|
||||
| [subnetwork](variables.tf#L136) | Name of the subnetwork the Secure Web Proxy is deployed into. | <code>string</code> | ✓ | |
|
||||
| [delete_swg_autogen_router_on_destroy](variables.tf#L33) | Delete automatically provisioned Cloud Router on destroy. | <code>bool</code> | | <code>true</code> |
|
||||
| [description](variables.tf#L39) | Optional description for the created resources. | <code>string</code> | | <code>"Managed by Terraform."</code> |
|
||||
| [labels](variables.tf#L45) | Resource labels. | <code>map(string)</code> | | <code>{}</code> |
|
||||
| [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. | <code title="object({ secure_tags = optional(map(object({ tag = string session_matcher = optional(string) application_matcher = optional(string) priority = number action = optional(string, "ALLOW") enabled = optional(bool, true) tls_inspection_enabled = optional(bool, false) description = optional(string) })), {}) url_lists = optional(map(object({ url_list = string values = optional(list(string)) session_matcher = optional(string) application_matcher = optional(string) priority = number action = optional(string, "ALLOW") enabled = optional(bool, true) tls_inspection_enabled = optional(bool, false) description = optional(string) })), {}) custom = optional(map(object({ session_matcher = optional(string) application_matcher = optional(string) priority = number action = optional(string, "ALLOW") enabled = optional(bool, true) tls_inspection_enabled = optional(bool, false) description = optional(string) })), {}) })">object({…})</code> | | <code>{}</code> |
|
||||
| [ports](variables.tf#L114) | Ports to use for Secure Web Proxy. | <code>list(number)</code> | | <code>[443]</code> |
|
||||
| [scope](variables.tf#L130) | Scope determines how configuration across multiple Gateway instances are merged. | <code>string</code> | | <code>null</code> |
|
||||
| [tls_inspection_config](variables.tf#L141) | TLS inspection configuration. | <code title="object({ ca_pool = optional(string, null) exclude_public_ca_set = optional(bool, false) description = optional(string) })">object({…})</code> | | <code>null</code> |
|
||||
|
||||
## 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. | |
|
||||
|
||||
<!-- END TFDOC -->
|
||||
|
|
|
|||
|
|
@ -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."
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue