Update modules and docs (#46)

aknysh · web-flow · commit bf528db15836 · 2020-01-09T22:49:34.000-05:00
* Change region for tests to `us-east-2`

* Add GitHub Actions for slash command dispatch and rebuild README

* Update README

* Update README

* Update README
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1,4 @@
+# Use this file to define individuals or teams that are responsible for code in a repository.
+# Read more: <https://help.github.com/articles/about-codeowners/>
+
+* @cloudposse/engineering
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: 'bug'
+assignees: ''
+
+---
+
+Found a bug? Maybe our [Slack Community](https://slack.cloudposse.com) can help. 
+
+[![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
+
+## Describe the Bug
+A clear and concise description of what the bug is.
+
+## Expected Behavior
+A clear and concise description of what you expected to happen.
+
+## Steps to Reproduce
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Run '....'
+3. Enter '....'
+4. See error
+
+## Screenshots
+If applicable, add screenshots or logs to help explain your problem.
+
+## Environment (please complete the following information):
+
+Anything that will help us triage the bug will help. Here are some ideas:
+ - OS: [e.g. Linux, OSX, WSL, etc]
+ - Version [e.g. 10.15]
+
+## Additional Context
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,18 @@
+blank_issues_enabled: false
+
+contact_links:
+
+  - name: Community Slack Team
+    url: https://cloudposse.com/slack/
+    about: |-
+      Please ask and answer questions here.
+
+  - name: Office Hours
+    url: https://cloudposse.com/office-hours/
+    about: |-
+      Join us every Wednesday for FREE Office Hours (lunch & learn).
+
+  - name: DevOps Accelerator Program
+    url: https://cloudposse.com/accelerate/
+    about: |-
+      Own your infrastructure in record time. We build it. You drive it. 
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,36 @@
+---
+name: Feature Request
+about: Suggest an idea for this project
+title: ''
+labels: 'feature request'
+assignees: ''
+
+---
+
+Have a question? Please checkout our [Slack Community](https://slack.cloudposse.com) in the `#geodesic` channel or visit our [Slack Archive](https://archive.sweetops.com/geodesic/). 
+
+[![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
+
+## Describe the Feature
+
+A clear and concise description of what the bug is. 
+
+## Expected Behavior
+
+A clear and concise description of what you expected to happen.
+
+## Use Case
+
+Is your feature request related to a problem/challenge you are trying to solve? Please provide some additional context of why this feature or capability will be valuable.
+
+## Describe Ideal Solution
+
+A clear and concise description of what you want to happen. If you don't know, that's okay.
+
+## Alternatives Considered
+
+Explain what alternative solutions or features you've considered.
+
+## Additional Context
+
+Add any other context or screenshots about the feature request here.
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,13 @@
+## what
+* Describe high-level what changed as a result of these commits (i.e. in plain-english, what do these changes mean?)
+* Use bullet points to be concise and to the point.
+
+## why
+* Provide the justifications for the changes (e.g. business case). 
+* Describe why these changes were made (e.g. why do these commits fix the problem?)
+* Use bullet points to be concise and to the point.
+
+## references
+* Link to any supporting github issues or helpful documentation to add some context (e.g. stackoverflow). 
+* Use `closes #123`, if this PR closes a GitHub issue `#123`
+
diff --git a/.github/auto-assign.yml b/.github/auto-assign.yml
@@ -0,0 +1,16 @@
+# Set to true to add reviewers to pull requests
+addReviewers: true
+
+# Set to author to set PR creator as assignee
+addAssignees: author
+
+# A list of reviewers to be added to pull requests (GitHub user name)
+# Teams are not supported (wontfix): https://github.com/kentaro-m/auto-assign/issues/39
+reviewers:
+  - aknysh
+  - osterman
+  - goruha
+
+# A number of reviewers added to the pull request
+# Set 0 to add all the reviewers (default: 0)
+numberOfReviewers: 0
diff --git a/.github/auto-label.yml b/.github/auto-label.yml
@@ -0,0 +1,2 @@
+README:
+- README.md
diff --git a/.github/workflows/auto-assign.yml b/.github/workflows/auto-assign.yml
@@ -0,0 +1,13 @@
+name: auto-assign
+on:
+  pull_request: 
+    types: [opened, reopened]
+
+jobs:
+  reviewers:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: cloudposse/actions/github/auto-assign@0.5.0
+        with:
+          repo-token: "${{ secrets.GITHUB_TOKEN }}"
+          configuration-path: '.github/auto-assign.yml'
diff --git a/.github/workflows/auto-greet.yml b/.github/workflows/auto-greet.yml
@@ -0,0 +1,23 @@
+name: auto-greet
+
+on: [pull_request, issues]
+
+jobs:
+  comment:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/first-interaction@v1
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        issue-message: |-
+          Thank you for reporting the issue! If you haven't already [joined our slack community](https://slack.sweetops.com), then we invite you to do so.
+
+          This is a great place to get help and ask questions from our AMAZING community.  
+
+          [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
+        pr-message: |-
+          Thank you for submitting this PR! If you haven't already [joined our slack community](https://slack.sweetops.com), then we invite you to do so.
+
+          We receive an overwhelming number of contributions. By joining our slack, we'll be able to review your PR faster.
+
+          [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
diff --git a/.github/workflows/auto-label.yml b/.github/workflows/auto-label.yml
@@ -0,0 +1,11 @@
+name: auto-label
+on: [pull_request]
+
+jobs:
+  components:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/labeler@v2.1.0
+      with:
+        repo-token: "${{ secrets.GITHUB_TOKEN }}"
+        configuration-path: '.github/auto-label.yml'
diff --git a/.github/workflows/auto-readme.yml b/.github/workflows/auto-readme.yml
@@ -0,0 +1,43 @@
+name: 'auto-readme'
+
+on:
+  # Open a PR to update README on merge to master (as necessary)
+  push:
+    branches:
+      - master
+
+  # Open a PR to update README for all PRs (as necessary)
+  pull_request: 
+    types: [opened, synchronize, reopened]
+
+  # Update README nightly
+  schedule:
+    - cron:  '0 0 * * *'
+
+jobs:
+  update:
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v1
+      - name: readme/update
+        shell: bash
+        env:
+          GITHUB_TOKEN: "${{ secrets.GITHUB_BOT_TOKEN }}"
+        run: |
+          make init
+          make readme/deps
+          make readme
+      - name: Create Pull Request
+        uses: cloudposse/actions/github/create-pull-request@0.4.0
+        with: 
+          labels: automated pr
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_BOT_TOKEN }}
+          COMMIT_MESSAGE: Update README.md
+          PULL_REQUEST_TITLE: Automatic Update of README.md
+          PULL_REQUEST_BODY: |-
+            This is an auto-generated PR which updates the `README.md` from the `README.yaml` 
+            using the [`cloudposse/build-harness`](https://github.com/cloudposse/build-harness).
+          PULL_REQUEST_BRANCH: github-actions/auto-readme
+          BRANCH_SUFFIX: none
diff --git a/.github/workflows/slash-command-dispatch.yml b/.github/workflows/slash-command-dispatch.yml
@@ -0,0 +1,20 @@
+name: Slash Command Dispatch
+on:
+  issue_comment:
+    types: [created]
+
+jobs:
+  slashCommandDispatch:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Slash Command Dispatch
+        uses: cloudposse/actions/github/slash-command-dispatch@0.9.0
+        with:
+          token: ${{ secrets.GITHUB_BOT_TOKEN }}
+          reaction-token: ${{ secrets.GITHUB_TOKEN }}
+          repository: cloudposse/actions
+          commands: rebuild-readme
+          permission: none
+          issue-type: pull-request
diff --git a/LICENSE b/LICENSE
@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2018-2019 Cloud Posse, LLC
+   Copyright 2018-2020 Cloud Posse, 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/README.md b/README.md
@@ -92,6 +92,11 @@ We literally have [*hundreds of terraform modules*][terraform_modules] that are
 Instead pin to the release tag (e.g. `?ref=tags/x.y.z`) of one of our [latest releases](https://github.com/cloudposse/terraform-aws-dynamodb/releases).
 
 
+
+For a complete example, see [examples/complete](examples/complete).
+
+For automated tests of the complete example using [bats](https://github.com/bats-core/bats-core) and [Terratest](https://github.com/gruntwork-io/terratest) (which tests and deploys the example on AWS), see [test](test).
+
 ```hcl
 module "dynamodb_table" {
   source                       = "git::https://github.com/cloudposse/terraform-aws-dynamodb.git?ref=master"
@@ -174,6 +179,27 @@ module "dynamodb_table" {
 }
 ```
 
+__NOTE:__ Variables "global_secondary_index_map" and "local_secondary_index_map" have a predefined schema, but in some cases not all fields are required or needed.
+
+For example:
+ * `non_key_attributes` can't be specified for Global Secondary Indexes (GSIs) when `projection_type` is `ALL`
+ * `read_capacity` and `write_capacity` are not required for GSIs
+
+In these cases, set the fields to `null` and Terraform will treat them as if they were not provided at all, but will not complain about missing values:
+
+```hcl
+  global_secondary_index_map = [
+    {
+      write_capacity     = null
+      read_capacity      = null
+      projection_type    = "ALL"
+      non_key_attributes = null
+    }
+  ]
+```
+
+See [Terraform types and values](https://www.terraform.io/docs/configuration/expressions.html#types-and-values) for more details.
+
 
 
 
diff --git a/README.yaml b/README.yaml
@@ -78,6 +78,11 @@ description: |-
 
 # How to use this project
 usage: |-
+
+  For a complete example, see [examples/complete](examples/complete).
+
+  For automated tests of the complete example using [bats](https://github.com/bats-core/bats-core) and [Terratest](https://github.com/gruntwork-io/terratest) (which tests and deploys the example on AWS), see [test](test).
+
   ```hcl
   module "dynamodb_table" {
     source                       = "git::https://github.com/cloudposse/terraform-aws-dynamodb.git?ref=master"
@@ -160,6 +165,27 @@ usage: |-
   }
   ```
 
+  __NOTE:__ Variables "global_secondary_index_map" and "local_secondary_index_map" have a predefined schema, but in some cases not all fields are required or needed.
+
+  For example:
+   * `non_key_attributes` can't be specified for Global Secondary Indexes (GSIs) when `projection_type` is `ALL`
+   * `read_capacity` and `write_capacity` are not required for GSIs
+
+  In these cases, set the fields to `null` and Terraform will treat them as if they were not provided at all, but will not complain about missing values:
+
+  ```hcl
+    global_secondary_index_map = [
+      {
+        write_capacity     = null
+        read_capacity      = null
+        projection_type    = "ALL"
+        non_key_attributes = null
+      }
+    ]
+  ```
+
+  See [Terraform types and values](https://www.terraform.io/docs/configuration/expressions.html#types-and-values) for more details.
+
 include:
   - "docs/targets.md"
   - "docs/terraform.md"
diff --git a/codefresh/test.yml b/codefresh/test.yml
@@ -71,4 +71,7 @@ steps:
         image: ${{TEST_IMAGE}}
         stage: Test
         commands:
+          - unset AWS_PROFILE
+          - unset AWS_DEFAULT_PROFILE
+          - unset AWS_MFA_PROFILE
           - make -C test/src
diff --git a/examples/complete/fixtures.us-east-2.tfvars b/examples/complete/fixtures.us-east-2.tfvars
@@ -1,4 +1,4 @@
-region = "us-west-1"
+region = "us-east-2"
 
 namespace = "eg"
 
diff --git a/examples/complete/versions.tf b/examples/complete/versions.tf
@@ -0,0 +1,8 @@
+terraform {
+  required_version = "~> 0.12.0"
+
+  required_providers {
+    aws  = "~> 2.0"
+    null = "~> 2.0"
+  }
+}
diff --git a/main.tf b/main.tf
@@ -26,7 +26,7 @@ locals {
     var.dynamodb_attributes
   )
 
-  # Use the `slice` pattern (instead of `conditional`) to remove the first map from the list if no `range_key` is provided
+  # Remove the first map from the list if no `range_key` is provided
   from_index = length(var.range_key) > 0 ? 0 : 1
 
   attributes_final = slice(local.attributes, local.from_index, length(local.attributes))
@@ -113,7 +113,7 @@ resource "aws_dynamodb_table" "default" {
 
   ttl {
     attribute_name = var.ttl_attribute
-    enabled        = var.ttl_attribute != "" ? true : false
+    enabled        = var.ttl_attribute != "" && var.ttl_attribute != null ? true : false
   }
 
   tags = module.dynamodb_label.tags
@@ -129,8 +129,8 @@ module "dynamodb_autoscaler" {
   delimiter                    = var.delimiter
   attributes                   = var.attributes
   tags                         = module.dynamodb_label.tags
-  dynamodb_table_name          = concat(aws_dynamodb_table.default.*.id, [""])[0]
-  dynamodb_table_arn           = concat(aws_dynamodb_table.default.*.arn, [""])[0]
+  dynamodb_table_name          = join("", aws_dynamodb_table.default.*.id)
+  dynamodb_table_arn           = join("", aws_dynamodb_table.default.*.arn)
   dynamodb_indexes             = null_resource.global_secondary_index_names.*.triggers.name
   autoscale_write_target       = var.autoscale_write_target
   autoscale_read_target        = var.autoscale_read_target
diff --git a/outputs.tf b/outputs.tf
diff --git a/test/src/examples_complete_test.go b/test/src/examples_complete_test.go
