Merge pull request #8 from averbuks/master

 Deprecate 'parent_type' and 'parent_id' input variables

Author: morgante

README.md

@@ -21,10 +21,9 @@ Basic usage of this module is as follows:
 ```hcl
 module "folders" {
   source  = "terraform-google-modules/folders/google"
-  version = "~> 0.1"
+  version = "~> 2.0"
 
-  parent_id   = "65552901371"
-  parent_type = "folder"
+  parent  = "folders/65552901371"
 
   names = [
     "dev",
@@ -50,29 +49,27 @@ module "folders" {
 Functional examples are included in the
 [examples](./examples/) directory.
 
-[^]: (autogen_docs_start)
-
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ## Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|:----:|:-----:|:-----:|
-| all\_folder\_admins | List of IAM-style members that will get the extended permissions across all the folders. | list | `<list>` | no |
-| folder\_admin\_roles | List of roles that will be applied to per folder owners on their respective folder. | list | `<list>` | no |
-| names | Folder names. | list | `<list>` | no |
-| parent\_id | Id of the resource under which the folder will be placed. | string | n/a | yes |
-| parent\_type | Type of the parent reosurce, defaults to organization. | string | `"organization"` | no |
-| per\_folder\_admins | List of IAM-style members per folder who will get extended permissions. | list | `<list>` | no |
+| all\_folder\_admins | List of IAM-style members that will get the extended permissions across all the folders. | list(string) | `<list>` | no |
+| folder\_admin\_roles | List of roles that will be applied to per folder owners on their respective folder. | list(string) | `<list>` | no |
+| names | Folder names. | list(string) | `<list>` | no |
+| parent | The resource name of the parent Folder or Organization. Must be of the form folders/folder_id or organizations/org_id | string | n/a | yes |
+| per\_folder\_admins | List of IAM-style members per folder who will get extended permissions. | list(string) | `<list>` | no |
 | prefix | Optional prefix to enforce uniqueness of folder names. | string | `""` | no |
-| set\_roles | Set roles to actors passed in role_members variable. | string | `"false"` | no |
+| set\_roles | Set roles to actors passed in role_members variable. | bool | `"false"` | no |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| ids | Map of name => folder resource id. |
-| names | Map of name => folder resource name. |
+| names\_and\_display\_names | Map of name => folder resource name. |
+| names\_and\_ids | Map of name => folder resource id. |
 
-[^]: (autogen_docs_end)
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 
 ## Requirements
 

examples/simple_example/README.md

@@ -2,25 +2,24 @@
 
 This example illustrates how to use the `folders` module.
 
-[^]: (autogen_docs_start)
-
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ## Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|:----:|:-----:|:-----:|
-| all\_folder\_admins | List of IAM-style members that will get the extended permissions across all the folders. | list | `<list>` | no |
-| names | Folder names. | list | `<list>` | no |
+| all\_folder\_admins | List of IAM-style members that will get the extended permissions across all the folders. | list(string) | `<list>` | no |
+| names | Folder names. | list(string) | `<list>` | no |
 | parent\_id | Id of the resource under which the folder will be placed. | string | n/a | yes |
-| parent\_type | Type of the parent reosurce, defaults to organization. | string | `"organization"` | no |
-| per\_folder\_admins | List of IAM-style members per folder who will get extended permissions. | list | `<list>` | no |
+| parent\_type | Type of the parent reosurce, defaults to organization. | string | `"folders"` | no |
+| per\_folder\_admins | List of IAM-style members per folder who will get extended permissions. | list(string) | `<list>` | no |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| ids | Map of name => folder resource id. |
+| names\_and\_ids | Map of name => folder resource id. |
 
-[^]: (autogen_docs_end)
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 
 To provision this example, run the following from within this directory:
 - `terraform init` to get the plugins

examples/simple_example/main.tf

@@ -21,8 +21,7 @@ provider "google" {
 module "folders" {
   source = "../.."
 
-  parent_id         = var.parent_id
-  parent_type       = var.parent_type
+  parent            = "${var.parent_type}/${var.parent_id}"
   names             = var.names
   set_roles         = true
   per_folder_admins = var.per_folder_admins

examples/simple_example/variables.tf

@@ -22,7 +22,7 @@ variable "parent_id" {
 variable "parent_type" {
   type        = string
   description = "Type of the parent reosurce, defaults to organization."
-  default     = "folder"
+  default     = "folders"
 }
 
 variable "names" {

main.tf

@@ -25,23 +25,22 @@ locals {
 resource "google_folder" "folders" {
   count        = length(var.names)
   display_name = "${local.prefix}${element(var.names, count.index)}"
-  parent       = "${var.parent_type}s/${var.parent_id}"
+  parent       = "${var.parent}"
 }
 
 # give project creation access to service accounts
 # https://cloud.google.com/resource-manager/docs/access-control-folders#granting_folder-specific_roles_to_enable_project_creation
 
 resource "google_folder_iam_binding" "owners" {
-  count = var.set_roles ? length(var.names) * length(var.folder_admin_roles) : 0
+  count  = var.set_roles ? length(var.names) * length(var.folder_admin_roles) : 0
   folder = google_folder.folders[floor(count.index / length(var.folder_admin_roles))].name
-  role = var.folder_admin_roles[count.index % length(var.folder_admin_roles)]
+  role   = var.folder_admin_roles[count.index % length(var.folder_admin_roles)]
 
   members = compact(
-              concat(
-                split(",",
-                  concat(var.per_folder_admins, [""])[floor(count.index / length(var.folder_admin_roles))],
-                ), var.all_folder_admins,
-              ),
-            )
-}
-
+    concat(
+      split(",",
+        concat(var.per_folder_admins, [""])[floor(count.index / length(var.folder_admin_roles))],
+      ), var.all_folder_admins,
+    ),
+  )
+}

test/fixtures/simple_example/main.tf

@@ -22,6 +22,7 @@ module "example" {
   source = "../../../examples/simple_example"
 
   parent_id         = var.parent_id
+  parent_type       = var.parent_type
   names             = var.names
   per_folder_admins = var.per_folder_admins
   all_folder_admins = var.all_folder_admins

test/fixtures/simple_example/variables.tf

@@ -22,7 +22,7 @@ variable "parent_id" {
 variable "parent_type" {
   type        = string
   description = "Type of the parent reosurce, defaults to organization."
-  default     = "folder"
+  default     = "folders"
 }
 
 variable "names" {

test/integration/simple_example/inspec.yml

@@ -15,4 +15,4 @@ attributes:
     type: hash
   - name: per_folder_admins
     required: true
-    type: array
+    type: array

variables.tf

@@ -14,15 +14,9 @@
  * limitations under the License.
  */
 
-variable "parent_id" {
+variable "parent" {
   type        = string
-  description = "Id of the resource under which the folder will be placed."
-}
-
-variable "parent_type" {
-  type        = string
-  description = "Type of the parent reosurce, defaults to organization."
-  default     = "organization"
+  description = "The resource name of the parent Folder or Organization. Must be of the form folders/folder_id or organizations/org_id"
 }
 
 variable "names" {
@@ -50,7 +44,7 @@ variable "all_folder_admins" {
 }
 
 variable "prefix" {
-  type = string
+  type        = string
   description = "Optional prefix to enforce uniqueness of folder names."
   default     = ""
 }