Merge pull request #12 from lgallard/feature/secondary-resources

Feature/secondary resources

Author: lgallard

CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.5.0 (March 18, 2021)
+
+FEATURES:
+
+  * Add secondary sources (based on @brettminnie's)
+  * Update example with secondary sources
+
 ## 0.4.0 (March 17, 2021)
 
 FEATURES:

README.md

@@ -136,7 +136,6 @@ module "myapp-project" {
 
 }
 ```
-
 ## Requirements
 
 No requirements.
@@ -180,13 +179,12 @@ No Modules.
 | build\_timeout | How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any related build that does not get marked as completed.The default is 60 minutes. | `number` | `60` | no |
 | cache | Information about the cache storage for the project. | `any` | `{}` | no |
 | cache\_location | The location where the AWS CodeBuild project stores cached resources. For type S3 the value must be a valid S3 bucket name/prefix. (Required when cache `type` is `S3`) | `string` | `null` | no |
-| cache\_modes | Specifies settings that AWS CodeBuild uses to store and reuse build dependencies. Valid values: `LOCAL_SOURCE_CACHE`, `LOCAL_DOCKER_LAYER_CACHE`, and `LOCAL_CUSTOM_CACHE`. (Required when cache type is `LOCAL`) | `list` | `[]` | no |
+| cache\_modes | Specifies settings that AWS CodeBuild uses to store and reuse build dependencies. Valid values: `LOCAL_SOURCE_CACHE`, `LOCAL_DOCKER_LAYER_CACHE`, and `LOCAL_CUSTOM_CACHE`. (Required when cache type is `LOCAL`) | `list(any)` | `[]` | no |
 | cache\_type | The type of storage that will be used for the AWS CodeBuild project cache. Valid values: `NO_CACHE`, `LOCAL`, and `S3`. | `string` | `"NO_CACHE"` | no |
 | cloudwatch\_logs | Configuration for the builds to store log data to CloudWatch. | `any` | `{}` | no |
 | cloudwatch\_logs\_group\_name | The group name of the logs in CloudWatch Logs. | `string` | `null` | no |
 | cloudwatch\_logs\_status | Current status of logs in CloudWatch Logs for a build project. Valid values: `ENABLED`, `DISABLED.` | `string` | `"ENABLED"` | no |
 | cloudwatch\_logs\_stream\_name | The stream name of the logs in CloudWatch Logs. | `string` | `null` | no |
-| codebuild\_secondary\_source | Information about the project's secondary source code. | `any` | `{}` | no |
 | codebuild\_secondary\_source\_auth | Information about the authorization settings for AWS CodeBuild to access the source code to be built. | `map` | `{}` | no |
 | codebuild\_secondary\_source\_auth\_resource | The resource value that applies to the specified authorization type. | `string` | `null` | no |
 | codebuild\_secondary\_source\_auth\_type | The authorization type to use. The only valid value is OAUTH | `string` | `"OAUTH"` | no |
@@ -199,13 +197,14 @@ No Modules.
 | codebuild\_secondary\_source\_location | The location of the source code from git or s3. | `string` | `null` | no |
 | codebuild\_secondary\_source\_report\_build\_status | Set to true to report the status of a build's start and finish to your source provider. This option is only valid when the type is `BITBUCKET` or `GITHUB`. | `bool` | `false` | no |
 | codebuild\_secondary\_source\_type | The type of repository that contains the secondary source code to be built. Valid values for this parameter are: `CODECOMMIT`, `CODEPIPELINE`, `GITHUB`, `GITHUB_ENTERPRISE`, `BITBUCKET`, `S3` or `NO_SOURCE`. | `string` | `"CODEPIPELINE"` | no |
+| codebuild\_secondary\_sources | Information about the project's secondary sources code. See the related codebuild source objects for descriptions of each parameter.<br>  The parameter `source_identifier` is the name of the directory to clone the secondary source into as a sibling to the primary source code directory.<br>  If this variable is omitted, no secondary sources are created.<br><br>  eg:<pre>codebuild_secondary_sources = [<br>    {<br>      type              = "GITHUB"<br>      location          = "https://github.com/myprofile/myproject-1.git"<br>      source_identifier = "my_awesome_project1"<br>    },<br>    {<br>      type                = "GITHUB"<br>      location            = "https://github.com/myprofile/myproject-2.git"<br>      git_clone_depth     = 1<br>      source_identifier   = "my_awesome_project2"<br>      report_build_status = true<br>      insecure_ssl        = true<br>    }<br>  ]</pre> | `any` | `[]` | no |
 | codebuild\_source | Information about the project's input source code. | `any` | `{}` | no |
-| codebuild\_source\_auth | Information about the authorization settings for AWS CodeBuild to access the source code to be built. | `map` | `{}` | no |
+| codebuild\_source\_auth | Information about the authorization settings for AWS CodeBuild to access the source code to be built. | `map(any)` | `{}` | no |
 | codebuild\_source\_auth\_resource | The resource value that applies to the specified authorization type. | `string` | `null` | no |
 | codebuild\_source\_auth\_type | The authorization type to use. The only valid value is OAUTH | `string` | `"OAUTH"` | no |
 | codebuild\_source\_buildspec | The build spec declaration to use for this build project's related builds. This must be set when type is iNO\_SOURCE | `string` | `null` | no |
 | codebuild\_source\_git\_clone\_depth | Information about the Git submodules configuration for an AWS CodeBuild build project. Git submodules config blocks are documented below. This option is only valid when the type is `CODECOMMIT`. | `number` | `0` | no |
-| codebuild\_source\_git\_submodules\_config | Information about the Git submodules configuration for an AWS CodeBuild build project. Git submodules config blocks are documented below. This option is only valid when the type is `CODECOMMIT`. | `map` | `{}` | no |
+| codebuild\_source\_git\_submodules\_config | Information about the Git submodules configuration for an AWS CodeBuild build project. Git submodules config blocks are documented below. This option is only valid when the type is `CODECOMMIT`. | `map(any)` | `{}` | no |
 | codebuild\_source\_git\_submodules\_config\_fetch\_submodules | If set to true, fetches Git submodules for the AWS CodeBuild build project. | `bool` | `true` | no |
 | codebuild\_source\_insecure\_ssl | Ignore SSL warnings when connecting to source control. | `bool` | `false` | no |
 | codebuild\_source\_location | The location of the source code from git or s3. | `string` | `null` | no |
@@ -220,9 +219,9 @@ No Modules.
 | environment\_image | The Docker image to use for this build project. Valid values include Docker images provided by CodeBuild (e.g `aws/codebuild/standard:2.0`), Docker Hub images (e.g. `hashicorp/terraform:latest`), and full Docker repository URIs such as those for ECR (e.g. `137112412989.dkr.ecr.us-west-2.amazonaws.com/amazonlinux:latest`) | `string` | `"aws/codebuild/standard:2.0"` | no |
 | environment\_image\_pull\_credentials\_type | The type of credentials AWS CodeBuild uses to pull images in your build. Available values for this parameter are `CODEBUID` or `SERVICE_ROLE`. When you use a cross-account or private registry image, you must use SERVICE\_ROLE credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials. | `string` | `"CODEBUILD"` | no |
 | environment\_privileged\_mode | If set to true, enables running the Docker daemon inside a Docker container. | `bool` | `false` | no |
-| environment\_registry\_credential | Information about credentials for access to a private Docker registry. Registry Credential config blocks are documented below. | `map` | `{}` | no |
+| environment\_registry\_credential | Information about credentials for access to a private Docker registry. Registry Credential config blocks are documented below. | `map(any)` | `{}` | no |
 | environment\_type | The type of build environment to use for related builds. Available values are: `LINUX_CONTAINER`, `LINUX_GPU_CONTAINER`, `WINDOWS_CONTAINER` or `ARM_CONTAINER`. | `string` | `"LINUX_CONTAINER"` | no |
-| environment\_variables | A list of sets of environment variables to make available to builds for this build project. | `list` | `[]` | no |
+| environment\_variables | A list of sets of environment variables to make available to builds for this build project. | `list(any)` | `[]` | no |
 | name | The projects name. | `string` | n/a | yes |
 | queued\_timeout | How long in minutes, from 5 to 480 (8 hours), a build is allowed to be queued before it times out.The default is 8 hours. | `number` | `480` | no |
 | s3\_logs | Configuration for the builds to store log data to S3. | `any` | `{}` | no |

examples/codebuild_using_objects/main.tf

@@ -1,7 +1,7 @@
 # CodeBuild
 module "myapp-project" {
 
-  source = "git::https://github.com/lgallard/terraform-aws-codebuild.git"
+  source = "lgallard/codebuild/aws"
 
   name        = "my-app"
   description = "Codebuild for deploying myapp"
@@ -18,6 +18,23 @@ module "myapp-project" {
     }
   }
 
+  # Secondary Sources
+  codebuild_secondary_sources = [
+    {
+      type              = "GITHUB"
+      location          = "https://github.com/myprofile/myproject-1.git"
+      source_identifier = "my_awesome_project1"
+    },
+    {
+      type                = "GITHUB"
+      location            = "https://github.com/myprofile/myproject-2.git"
+      git_clone_depth     = 1
+      source_identifier   = "my_awesome_project2"
+      report_build_status = true
+      insecure_ssl        = true
+    }
+  ]
+
   # Environment
   environment = {
     compute_type    = "BUILD_GENERAL1_SMALL"
@@ -29,11 +46,11 @@ module "myapp-project" {
     variables = [
       {
         name  = "REGISTRY_URL"
-        value = "012345678910.dkr.ecr.us-east-1.amazonaws.com/my-ecr"
+        value = "012345678910.dkr.ecr.us-west-1.amazonaws.com/my-ecr"
       },
       {
         name  = "AWS_DEFAULT_REGION"
-        value = "us-east-1"
+        value = "us-west-1"
       },
     ]
   }
@@ -68,7 +85,7 @@ module "myapp-project" {
 
 # S3
 resource "aws_s3_bucket" "myapp-project" {
-  bucket = "myapp-project-bucket"
-  acl    = "private"
+  bucket_prefix = "myapp-project-bucket-"
+  acl           = "private"
 }
 

main.tf

@@ -60,7 +60,7 @@ resource "aws_codebuild_project" "cb_project" {
         content {
           name  = environment_variable.value.name
           value = environment_variable.value.value
-          type  = lookup(environment_variable.value, "type", null) == null ?  "PLAINTEXT" : environment_variable.value.type
+          type  = lookup(environment_variable.value, "type", null) == null ? "PLAINTEXT" : environment_variable.value.type
         }
       }
     }
@@ -127,15 +127,15 @@ resource "aws_codebuild_project" "cb_project" {
 
   # Secondary Sources
   dynamic "secondary_sources" {
-    for_each = local.secondary_source
+    for_each = local.secondary_sources
     content {
-      type                = lookup(secondary_sources.value, "type")
-      buildspec           = lookup(secondary_sources.value, "buildspec")
-      git_clone_depth     = lookup(secondary_sources.value, "git_clone_depth")
-      insecure_ssl        = lookup(secondary_sources.value, "insecure_ssl")
-      location            = lookup(secondary_sources.value, "location")
-      report_build_status = lookup(secondary_sources.value, "report_build_status")
-      source_identifier   = lookup(secondary_sources.value, "source_identifier")
+      type                = lookup(secondary_sources.value, "type", "CODEBUILD")
+      buildspec           = lookup(secondary_sources.value, "buildspec", null)
+      git_clone_depth     = lookup(secondary_sources.value, "git_clone_depth", 0)
+      insecure_ssl        = lookup(secondary_sources.value, "insecure_ssl", var.codebuild_source_insecure_ssl)
+      location            = lookup(secondary_sources.value, "location", null)
+      report_build_status = lookup(secondary_sources.value, "report_build_status", var.codebuild_source_report_build_status)
+      source_identifier   = lookup(secondary_sources.value, "source_identifier", null)
 
       # Auth
       dynamic "auth" {
@@ -253,22 +253,22 @@ locals {
     }
   ]
 
-  # Secondary Sources
-  # If no block is provided build one using defaults
-  secondary_source = [
+  secondary_sources = [
+    for source in var.codebuild_secondary_sources :
     {
-      type                  = lookup(var.codebuild_secondary_source, "type", null) == null ? var.codebuild_secondary_source_type : lookup(var.codebuild_secondary_source, "type")
-      buildspec             = lookup(var.codebuild_secondary_source, "buildspec", null) == null ? var.codebuild_secondary_source_buildspec : lookup(var.codebuild_secondary_source, "buildspec")
-      git_clone_depth       = lookup(var.codebuild_secondary_source, "git_clone_depth", null) == null ? var.codebuild_secondary_source_git_clone_depth : lookup(var.codebuild_secondary_source, "git_clone_depth")
-      insecure_ssl          = lookup(var.codebuild_secondary_source, "insecure_ssl", null) == null ? var.codebuild_secondary_source_insecure_ssl : lookup(var.codebuild_secondary_source, "insecure_ssl")
-      location              = lookup(var.codebuild_secondary_source, "location", null) == null ? var.codebuild_secondary_source_location : lookup(var.codebuild_secondary_source, "location")
-      report_build_status   = lookup(var.codebuild_secondary_source, "report_build_status", null) == null ? var.codebuild_secondary_source_report_build_status : lookup(var.codebuild_secondary_source, "report_build_status")
-      source_identifier     = lookup(var.codebuild_secondary_source, "source_identifier", null) == null ? var.codebuild_secondary_source_identifier : lookup(var.codebuild_secondary_source, "source_identifier")
-      auth                  = lookup(var.codebuild_secondary_source, "auth", null) == null ? var.codebuild_secondary_source_auth : lookup(var.codebuild_secondary_source, "auth")
-      git_submodules_config = lookup(var.codebuild_secondary_source, "git_submodules_config", null) == null ? var.codebuild_secondary_source_git_submodules_config : lookup(var.codebuild_secondary_source, "git_submodules_config")
+      type                  = lookup(source, "type", null) == null ? var.codebuild_secondary_source_type : lookup(source, "type")
+      buildspec             = lookup(source, "buildspec", null) == null ? var.codebuild_secondary_source_buildspec : lookup(source, "buildspec")
+      git_clone_depth       = lookup(source, "git_clone_depth", null) == null ? var.codebuild_secondary_source_git_clone_depth : lookup(source, "git_clone_depth")
+      insecure_ssl          = lookup(source, "insecure_ssl", null) == null ? var.codebuild_secondary_source_insecure_ssl : lookup(source, "insecure_ssl")
+      location              = lookup(source, "location", null) == null ? var.codebuild_secondary_source_location : lookup(source, "location")
+      report_build_status   = lookup(source, "report_build_status", null) == null ? var.codebuild_secondary_source_report_build_status : lookup(source, "report_build_status")
+      source_identifier     = lookup(source, "source_identifier", null) == null ? var.codebuild_secondary_source_identifier : lookup(source, "source_identifier")
+      auth                  = lookup(source, "auth", null) == null ? var.codebuild_secondary_source_auth : lookup(source, "auth")
+      git_submodules_config = lookup(source, "git_submodules_config", null) == null ? var.codebuild_secondary_source_git_submodules_config : lookup(source, "git_submodules_config")
     }
   ]
 
+
   # VPC Config
   # If no VPC Config block is provided, build one using the default values
   vpc_config = {

variables.tf

@@ -122,7 +122,7 @@ variable "cache_location" {
 
 variable "cache_modes" {
   description = "Specifies settings that AWS CodeBuild uses to store and reuse build dependencies. Valid values: `LOCAL_SOURCE_CACHE`, `LOCAL_DOCKER_LAYER_CACHE`, and `LOCAL_CUSTOM_CACHE`. (Required when cache type is `LOCAL`)"
-  type        = list
+  type        = list(any)
   default     = []
 }
 
@@ -159,7 +159,7 @@ variable "environment_image_pull_credentials_type" {
 
 variable "environment_variables" {
   description = "A list of sets of environment variables to make available to builds for this build project."
-  type        = list
+  type        = list(any)
   default     = []
 }
 
@@ -177,7 +177,7 @@ variable "environment_certificate" {
 
 variable "environment_registry_credential" {
   description = "Information about credentials for access to a private Docker registry. Registry Credential config blocks are documented below."
-  type        = map
+  type        = map(any)
   default     = {}
 }
 
@@ -275,7 +275,7 @@ variable "codebuild_source_report_build_status" {
 
 variable "codebuild_source_auth" {
   description = "Information about the authorization settings for AWS CodeBuild to access the source code to be built."
-  type        = map
+  type        = map(any)
   default     = {}
 }
 
@@ -293,7 +293,7 @@ variable "codebuild_source_auth_resource" {
 
 variable "codebuild_source_git_submodules_config" {
   description = "Information about the Git submodules configuration for an AWS CodeBuild build project. Git submodules config blocks are documented below. This option is only valid when the type is `CODECOMMIT`."
-  type        = map
+  type        = map(any)
   default     = {}
 }
 
@@ -304,10 +304,33 @@ variable "codebuild_source_git_submodules_config_fetch_submodules" {
 }
 
 # Secondary Source
-variable "codebuild_secondary_source" {
-  description = "Information about the project's secondary source code."
+variable "codebuild_secondary_sources" {
+  description = <<-EOF
+    Information about the project's secondary sources code. See the related codebuild source objects for descriptions of each parameter.
+    The parameter `source_identifier` is the name of the directory to clone the secondary source into as a sibling to the primary source code directory.
+    If this variable is omitted, no secondary sources are created.
+
+    eg:
+    ```
+    codebuild_secondary_sources = [
+      {
+        type              = "GITHUB"
+        location          = "https://github.com/myprofile/myproject-1.git"
+        source_identifier = "my_awesome_project1"
+      },
+      {
+        type                = "GITHUB"
+        location            = "https://github.com/myprofile/myproject-2.git"
+        git_clone_depth     = 1
+        source_identifier   = "my_awesome_project2"
+        report_build_status = true
+        insecure_ssl        = true
+      }
+    ]
+  ```
+  EOF
   type        = any
-  default     = {}
+  default     = []
 }
 
 variable "codebuild_secondary_source_type" {