terraspace_plugin_aws 0.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (47) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +12 -0
  3. data/.rspec +3 -0
  4. data/CHANGELOG.md +8 -0
  5. data/Gemfile +16 -0
  6. data/LICENSE.txt +201 -0
  7. data/README.md +45 -0
  8. data/Rakefile +6 -0
  9. data/bin/console +14 -0
  10. data/bin/setup +8 -0
  11. data/lib/templates/hcl/module/main.tf +4 -0
  12. data/lib/templates/hcl/module/outputs.tf +4 -0
  13. data/lib/templates/hcl/module/variables.tf +11 -0
  14. data/lib/templates/hcl/project/config/templates/backend.tf.tt +9 -0
  15. data/lib/templates/hcl/project/config/templates/provider.tf +7 -0
  16. data/lib/templates/hcl/stack/main.tf +9 -0
  17. data/lib/templates/hcl/stack/outputs.tf +4 -0
  18. data/lib/templates/hcl/stack/variables.tf +11 -0
  19. data/lib/templates/ruby/module/main.rb +4 -0
  20. data/lib/templates/ruby/module/outputs.rb +4 -0
  21. data/lib/templates/ruby/module/variables.rb +9 -0
  22. data/lib/templates/ruby/project/config/templates/backend.rb.tt +7 -0
  23. data/lib/templates/ruby/project/config/templates/provider.rb +7 -0
  24. data/lib/templates/ruby/stack/main.rb +9 -0
  25. data/lib/templates/ruby/stack/outputs.rb +4 -0
  26. data/lib/templates/ruby/stack/variables.rb +11 -0
  27. data/lib/templates/test/rspec/module/test/.rspec +3 -0
  28. data/lib/templates/test/rspec/module/test/Gemfile.tt +9 -0
  29. data/lib/templates/test/rspec/module/test/spec/main_spec.rb.tt +26 -0
  30. data/lib/templates/test/rspec/module/test/spec/spec_helper.rb +13 -0
  31. data/lib/terraspace_plugin_aws.rb +31 -0
  32. data/lib/terraspace_plugin_aws/autoloader.rb +22 -0
  33. data/lib/terraspace_plugin_aws/clients.rb +18 -0
  34. data/lib/terraspace_plugin_aws/interfaces/backend.rb +11 -0
  35. data/lib/terraspace_plugin_aws/interfaces/backend/base.rb +11 -0
  36. data/lib/terraspace_plugin_aws/interfaces/backend/bucket.rb +34 -0
  37. data/lib/terraspace_plugin_aws/interfaces/backend/bucket/secure.rb +15 -0
  38. data/lib/terraspace_plugin_aws/interfaces/backend/table.rb +74 -0
  39. data/lib/terraspace_plugin_aws/interfaces/config.rb +29 -0
  40. data/lib/terraspace_plugin_aws/interfaces/decorator.rb +21 -0
  41. data/lib/terraspace_plugin_aws/interfaces/decorator/aws_security_group.rb +27 -0
  42. data/lib/terraspace_plugin_aws/interfaces/decorator/base.rb +7 -0
  43. data/lib/terraspace_plugin_aws/interfaces/expander.rb +12 -0
  44. data/lib/terraspace_plugin_aws/interfaces/layer.rb +27 -0
  45. data/lib/terraspace_plugin_aws/version.rb +3 -0
  46. data/terraspace_plugin_aws.gemspec +31 -0
  47. metadata +173 -0
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: dca5820d4f39269a02702a0c322cb249121f3676997b6e1f5a63e042cbc15e15
4
+ data.tar.gz: edb37d92d5e398c5c4ce98858db544fe7d4a23226da816eb6687b0809a173734
5
+ SHA512:
6
+ metadata.gz: ff289ee0cd67e65701c5d23916fc237723aca27f8f14a863f273e065056bef8b805dbd7bb962ac71590c1f66118472c6894d4649c262f2b7aa2daab7705527ed
7
+ data.tar.gz: 52357c39e20e2877b52c7ab803a9704764c1c917746defc53a62228227533ec845dac2981e5025c3f064e6e402068830e908c0da86c33808b9b8fd7e308e6b8b
@@ -0,0 +1,12 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+ /Gemfile.lock
10
+
11
+ # rspec failure tracking
12
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
@@ -0,0 +1,8 @@
1
+ # Change Log
2
+
3
+ All notable changes to this project will be documented in this file.
4
+ This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/).
5
+
6
+ ## [0.0.1]
7
+ - terraspace dep for dev only
8
+
data/Gemfile ADDED
@@ -0,0 +1,16 @@
1
+ source "https://rubygems.org"
2
+
3
+ # Specify your gem's dependencies in gemspec
4
+ gemspec
5
+
6
+ gem "rake", "~> 12.0"
7
+ gem "rspec", "~> 3.0"
8
+
9
+ group :development, :test do
10
+ if ENV['TS_EDGE']
11
+ base = ENV['TS_EDGE_ROOT'] || "#{ENV['HOME']}/environment/terraspace-edge"
12
+ gem "terraspace", path: "#{base}/terraspace"
13
+ else
14
+ gem "terraspace"
15
+ end
16
+ end
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,45 @@
1
+ # Terraspace AWS Plugin
2
+
3
+ AWS Cloud support for terraspace.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'terraspace_plugin_aws'
11
+ ```
12
+
13
+ ## Configure
14
+
15
+ Optionally configure the plugin. Here's an example `aws.rb` for your terraspace project.
16
+
17
+ config/plugins/aws.rb
18
+
19
+ ```ruby
20
+ TerraspacePluginAws.configure do |config|
21
+ # config.s3.encryption = true
22
+ # config.s3.enforce_ssl = true
23
+ # config.s3.versioning = true
24
+ # config.s3.lifecycle = true
25
+ # config.s3.access_logging = true
26
+ # config.s3.secure_existing = false # run the security controls on existing buckets. by default, only run on newly created bucket the first time
27
+ #
28
+ # config.dynamodb.encryption = true
29
+ # config.dynamodb.kms_master_key_id = nil
30
+ # config.dynamodb.sse_type = "KMS"
31
+ end
32
+ ```
33
+
34
+ By default:
35
+
36
+ * S3 Buckets are secured with encryption, have an enforce ssl bucket policy, have versioning enabled, has a lifecycle policy, and have bucket access logging enabled.
37
+ * DynamoDB tables have encryption enabled using the AWS Managed KMS Key for DynamoDB.
38
+
39
+ The settings generally only apply if the s3 bucket or dynamodb table do not yet exist yet and is created for the first time.
40
+
41
+ If using `kms_master_key_id` it must already exist.
42
+
43
+ ## Contributing
44
+
45
+ Bug reports and pull requests are welcome on GitHub at https://github.com/boltops-tools/terraspace_plugin_aws.
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "terraspace_plugin_aws"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,4 @@
1
+ resource "aws_s3_bucket" "this" {
2
+ bucket = var.bucket # If omitted, Terraform will assign a random, unique name.
3
+ acl = var.acl
4
+ }
@@ -0,0 +1,4 @@
1
+ output "name" {
2
+ description = "Bucket name"
3
+ value = aws_s3_bucket.this.id
4
+ }
@@ -0,0 +1,11 @@
1
+ variable "bucket" {
2
+ description = "The name of the bucket. If omitted, Terraform will assign a random, unique name." # IE: terraform-2020052606510241590000000
3
+ type = string
4
+ default = null
5
+ }
6
+
7
+ variable "acl" {
8
+ description = "(Optional) The canned ACL to apply. Defaults to 'private'."
9
+ type = string
10
+ default = "private"
11
+ }
@@ -0,0 +1,9 @@
1
+ terraform {
2
+ backend "s3" {
3
+ bucket = "<%%= backend_expand("s3", "terraform-state-:ACCOUNT-:REGION-:ENV") %>" # expanded by terraspace IE: terraform-state-112233445566-us-west-2-dev
4
+ key = "<%%= backend_expand("s3", ":REGION/:ENV/:BUILD_DIR/terraform.tfstate") %>" # expanded by terraspace IE: us-west-2/dev/modules/vm/terraform.tfstate
5
+ region = "<%%= backend_expand("s3", ":REGION") %>"
6
+ encrypt = true
7
+ dynamodb_table = "terraform_locks"
8
+ }
9
+ }
@@ -0,0 +1,7 @@
1
+ # Docs: https://www.terraform.io/docs/providers/aws/index.html
2
+ #
3
+ # If AWS_PROFILE and AWS_REGION is set, then the provider is optional. Here's an example anyway:
4
+ #
5
+ # provider "aws" {
6
+ # region = "us-east-1"
7
+ # }
@@ -0,0 +1,9 @@
1
+ resource "random_pet" "bucket" {
2
+ length = 2
3
+ }
4
+
5
+ module "bucket" {
6
+ source = "../../modules/example"
7
+ bucket = "bucket-${random_pet.bucket.id}"
8
+ acl = var.acl
9
+ }
@@ -0,0 +1,4 @@
1
+ output "bucket_name" {
2
+ description = "Bucket name"
3
+ value = module.bucket.name
4
+ }
@@ -0,0 +1,11 @@
1
+ variable "bucket" {
2
+ description = "The name of the bucket. If omitted, Terraform will assign a random, unique name." # IE: terraform-2020052606510241590000000
3
+ type = string
4
+ default = null
5
+ }
6
+
7
+ variable "acl" {
8
+ description = "The canned ACL to apply. Defaults to 'private'."
9
+ type = string
10
+ default = "private"
11
+ }
@@ -0,0 +1,4 @@
1
+ resource("aws_s3_bucket", "this",
2
+ bucket: var.bucket, # If omitted, Terraform will assign a random, unique name.
3
+ acl: var.acl,
4
+ )
@@ -0,0 +1,4 @@
1
+ output("name",
2
+ description: "Bucket name",
3
+ value: "${aws_s3_bucket.this.id}",
4
+ )
@@ -0,0 +1,9 @@
1
+ variable("bucket",
2
+ description: "The name of the bucket. If omitted, Terraform will assign a random, unique name.", # IE: terraform-2020052606510241590000000
3
+ default: nil,
4
+ )
5
+
6
+ variable("acl",
7
+ description: "(Optional) The canned ACL to apply. Defaults to 'private'.",
8
+ default: "private",
9
+ )
@@ -0,0 +1,7 @@
1
+ backend("s3",
2
+ bucket: "terraform-state-:ACCOUNT-:REGION-:ENV", # expanded by terraspace IE: terraform-state-112233445566-us-west-2-dev
3
+ key: ":REGION/:ENV/:BUILD_DIR/terraform.tfstate", # expanded by terraspace IE: us-west-2/dev/modules/vm/terraform.tfstate
4
+ region: ":REGION",
5
+ encrypt: true,
6
+ dynamodb_table: "terraform_locks"
7
+ )
@@ -0,0 +1,7 @@
1
+ # Docs: https://www.terraform.io/docs/providers/aws/index.html
2
+ #
3
+ # If AWS_PROFILE and AWS_REGION is set, then the provider is optional. Here's an example anyway:
4
+ #
5
+ # provider("aws",
6
+ # region: "us-east-1"
7
+ # )
@@ -0,0 +1,9 @@
1
+ resource("random_pet", "bucket",
2
+ length: 2
3
+ )
4
+
5
+ module!("bucket",
6
+ source: "../../modules/example",
7
+ bucket: "bucket-${random_pet.bucket.id}",
8
+ acl: var.acl,
9
+ )
@@ -0,0 +1,4 @@
1
+ output("bucket_name",
2
+ description: "Bucket name",
3
+ value: "${module.bucket.name}",
4
+ )
@@ -0,0 +1,11 @@
1
+ variable("bucket",
2
+ description: "The name of the bucket. If omitted, Terraform will assign a random, unique name.", # IE: terraform-2020052606510241590000000
3
+ type: "string",
4
+ default: nil,
5
+ )
6
+
7
+ variable("acl",
8
+ description: "The canned ACL to apply. Defaults to 'private'.",
9
+ type: "string",
10
+ default: "private",
11
+ )
@@ -0,0 +1,3 @@
1
+ --color
2
+ --format documentation
3
+ --require spec_helper
@@ -0,0 +1,9 @@
1
+ source "https://rubygems.org"
2
+
3
+ <%=
4
+ build_gemfile(
5
+ "terraspace",
6
+ "rspec-terraspace",
7
+ plugin_gem_name,
8
+ )
9
+ %>
@@ -0,0 +1,26 @@
1
+ # This starter example of a spec that creates a test harness and provisions a real s3 bucket.
2
+ # The test harness will be created at:
3
+ #
4
+ # /tmp/terraspace-test-harnesses/<%= @name %>
5
+ #
6
+ # It's recommended to run this on a test AWS account.
7
+ #
8
+ describe "main" do
9
+ before(:all) do
10
+ mod_path = File.expand_path("../..", __dir__)
11
+ terraspace.build_test_harness(
12
+ name: "<%= @name %>",
13
+ modules: {example: mod_path},
14
+ stacks: {example: "#{mod_path}/test/spec/fixtures/stack"},
15
+ )
16
+ terraspace.up("example")
17
+ end
18
+ after(:all) do
19
+ terraspace.down("example")
20
+ end
21
+
22
+ it "successful deploy" do
23
+ bucket_name = terraspace.output("example", "bucket_name")
24
+ expect(bucket_name).to include("bucket-") # IE: bucket-pet-name
25
+ end
26
+ end
@@ -0,0 +1,13 @@
1
+ ENV["TS_ENV"] = "test"
2
+
3
+ require "terraspace"
4
+ require "rspec/terraspace"
5
+
6
+ module Helper
7
+ # Add your helpers here
8
+ end
9
+
10
+ RSpec.configure do |c|
11
+ c.include RSpec::Terraspace::Helpers
12
+ c.include Helper
13
+ end
@@ -0,0 +1,31 @@
1
+ lib = File.expand_path("../../../", __FILE__)
2
+ $:.unshift(lib)
3
+
4
+ require "memoist"
5
+ require "terraspace" # for interface
6
+
7
+ require "terraspace_plugin_aws/version"
8
+ require "terraspace_plugin_aws/autoloader"
9
+ TerraspacePluginAws::Autoloader.setup
10
+
11
+ module TerraspacePluginAws
12
+ class Error < StandardError; end
13
+
14
+ # Friendlier method for config/plugins/aws.rb. Example:
15
+ #
16
+ # TerraspacePluginAws.configure do |config|
17
+ # config.s3.encrypt = true
18
+ # end
19
+ #
20
+ def configure(&block)
21
+ Interfaces::Config.instance.configure(&block)
22
+ end
23
+ extend self
24
+ end
25
+
26
+ Terraspace::Plugin.register("aws",
27
+ backend: "s3",
28
+ config_instance: TerraspacePluginAws::Interfaces::Config.instance,
29
+ layer_class: TerraspacePluginAws::Interfaces::Layer, # used for layering
30
+ root: File.dirname(__dir__),
31
+ )
@@ -0,0 +1,22 @@
1
+ require "zeitwerk"
2
+
3
+ module TerraspacePluginAws
4
+ class Autoloader
5
+ class Inflector < Zeitwerk::Inflector
6
+ def camelize(basename, _abspath)
7
+ map = { cli: "CLI", version: "VERSION" }
8
+ map[basename.to_sym] || super
9
+ end
10
+ end
11
+
12
+ class << self
13
+ def setup
14
+ loader = Zeitwerk::Loader.new
15
+ loader.inflector = Inflector.new
16
+ lib = File.expand_path("../", __dir__)
17
+ loader.push_dir(lib)
18
+ loader.setup
19
+ end
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,18 @@
1
+ require "aws-sdk-dynamodb"
2
+ require "aws-sdk-s3"
3
+
4
+ module TerraspacePluginAws
5
+ module Clients
6
+ extend Memoist
7
+
8
+ def s3
9
+ Aws::S3::Client.new
10
+ end
11
+ memoize :s3
12
+
13
+ def dynamodb
14
+ Aws::DynamoDB::Client.new
15
+ end
16
+ memoize :dynamodb
17
+ end
18
+ end
@@ -0,0 +1,11 @@
1
+ module TerraspacePluginAws::Interfaces
2
+ class Backend
3
+ include Terraspace::Plugin::Backend::Interface
4
+
5
+ # interface method
6
+ def call
7
+ Bucket.new(@info).create
8
+ Table.new(@info).create
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,11 @@
1
+ require "s3-secure"
2
+
3
+ class TerraspacePluginAws::Interfaces::Backend
4
+ class Base
5
+ include TerraspacePluginAws::Clients
6
+
7
+ def initialize(info)
8
+ @info = info
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,34 @@
1
+ class TerraspacePluginAws::Interfaces::Backend
2
+ class Bucket < Base
3
+ include Secure
4
+
5
+ def create
6
+ bucket = @info["bucket"]
7
+ unless bucket # not bucket provided
8
+ puts "ERROR: no bucket value provided in your terraform backend config".color(:red)
9
+ exit 1
10
+ end
11
+ if exist?(bucket)
12
+ # puts "Bucket already exist: #{bucket}"
13
+ c = TerraspacePluginAws::Interfaces::Config.instance.config.s3
14
+ secure(bucket) if c.secure_existing
15
+ else
16
+ puts "Creating bucket: #{bucket}"
17
+ s3.create_bucket(bucket: bucket)
18
+ secure(bucket)
19
+ end
20
+ end
21
+
22
+ def exist?(name)
23
+ s3.head_bucket(bucket: name, use_accelerate_endpoint: false)
24
+ true # Bucket exist
25
+ rescue Aws::S3::Errors::NotFound
26
+ false # Bucket does not exist
27
+ rescue Aws::S3::Errors::Forbidden => e
28
+ puts "#{e.class}: #{e.message}"
29
+ puts "ERROR: Bucket is not available: #{name}".color(:red)
30
+ puts "Bucket might be owned by someone else or is on another one of your AWS accounts."
31
+ exit 1
32
+ end
33
+ end
34
+ end
@@ -0,0 +1,15 @@
1
+ require "s3-secure"
2
+
3
+ class TerraspacePluginAws::Interfaces::Backend::Bucket
4
+ module Secure
5
+ def secure(bucket)
6
+ c = TerraspacePluginAws::Interfaces::Config.instance.config.s3
7
+
8
+ S3Secure::Encryption::Enable.new(bucket: bucket).run if c.encryption
9
+ S3Secure::Policy::Enforce.new(bucket: bucket, sid: "ForceSSLOnlyAccess").run if c.enforce_ssl
10
+ S3Secure::Versioning::Enable.new(bucket: bucket).run if c.versioning
11
+ S3Secure::Lifecycle::Add.new(bucket: bucket).run if c.lifecycle
12
+ S3Secure::AccessLogs::Enable.new(bucket: bucket).run if c.access_logging
13
+ end
14
+ end
15
+ end
@@ -0,0 +1,74 @@
1
+ class TerraspacePluginAws::Interfaces::Backend
2
+ class Table < Base
3
+ def create
4
+ table = @info["dynamodb_table"]
5
+ return unless table # not table provided
6
+
7
+ if exist?(table)
8
+ # puts "Table already exist: #{table}"
9
+ else
10
+ puts "Creating dynamodb table: #{table}"
11
+ create_table(table)
12
+ end
13
+ end
14
+
15
+ def create_table(name)
16
+ dynamodb.create_table(table_definition(name))
17
+ puts "Waiting for dynamodb table to finish creating..."
18
+ dynamodb.wait_until(:table_exists, table_name: name)
19
+ end
20
+
21
+ def table_definition(name)
22
+ definition = {
23
+ attribute_definitions: [
24
+ {
25
+ attribute_name: "LockID",
26
+ attribute_type: "S",
27
+ }
28
+ ],
29
+ key_schema: [
30
+ {
31
+ attribute_name: "LockID",
32
+ key_type: "HASH",
33
+ }
34
+ ],
35
+ billing_mode: "PAY_PER_REQUEST", # accepts PROVISIONED, PAY_PER_REQUEST
36
+ table_name: name,
37
+ }
38
+ secure(definition)
39
+ definition
40
+ end
41
+
42
+ def secure(definition)
43
+ c = TerraspacePluginAws::Interfaces::Config.instance.config.dynamodb
44
+ return unless c.encryption
45
+
46
+ # Docs: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_SSESpecification.html
47
+ #
48
+ # If enabled (true), server-side encryption type is set to KMS and an AWS managed CMK is used (AWS KMS charges apply).
49
+ # IE: If we want to use the "AWS Managed KMS Key", set `enable=true` and dont set any other values.
50
+ #
51
+ # Setting | Console
52
+ # --------------------------------------------------- | ---------------------------------------------------
53
+ # enable=false | DEFAULT - The key is owned by Amazon DynamoDB. You are not charged any fee for using these CMKs.
54
+ # enable=true without sse_type, kms_master_key_id set | KMS - Customer managed CMK - The key is stored in your account that you create, own, and manage. AWS Key Management Service (KMS) charges apply
55
+ # enable=true with sse_type, kms_master_key_id set | The key is stored in your account that you create, own, and manage. AWS Key Management Service (KMS) charges apply - The key is stored in your account that you create, own, and manage. AWS Key Management Service (KMS) charges apply
56
+ #
57
+ spec = {enabled: true}
58
+ if c.kms_master_key_id
59
+ spec[:sse_type] = c.sse_type # accepts AES256, KMS
60
+ spec[:kms_master_key_id] = c.kms_master_key_id
61
+ end
62
+
63
+ definition[:sse_specification] = spec
64
+ definition
65
+ end
66
+
67
+ def exist?(name)
68
+ dynamodb.describe_table(table_name: name)
69
+ true # table exist
70
+ rescue Aws::DynamoDB::Errors::ResourceNotFoundException
71
+ false # table does not exist
72
+ end
73
+ end
74
+ end
@@ -0,0 +1,29 @@
1
+ module TerraspacePluginAws::Interfaces
2
+ class Config
3
+ include Terraspace::Plugin::Config::Interface
4
+ include Singleton
5
+
6
+ def provider
7
+ "aws"
8
+ end
9
+
10
+ def defaults
11
+ c = ActiveSupport::OrderedOptions.new
12
+ c.s3 = ActiveSupport::OrderedOptions.new
13
+ c.dynamodb = ActiveSupport::OrderedOptions.new
14
+
15
+ c.s3.encryption = true
16
+ c.s3.enforce_ssl = true
17
+ c.s3.versioning = true
18
+ c.s3.lifecycle = true
19
+ c.s3.access_logging = true
20
+ c.s3.secure_existing = false # run the security controls on existing buckets. by default, only run on newly created bucket the first time
21
+
22
+ c.dynamodb.encryption = true
23
+ c.dynamodb.kms_master_key_id = nil
24
+ c.dynamodb.sse_type = "KMS"
25
+
26
+ c
27
+ end
28
+ end
29
+ end
@@ -0,0 +1,21 @@
1
+ module TerraspacePluginAws::Interfaces
2
+ class Decorator
3
+ include Terraspace::Plugin::Decorator::Interface
4
+
5
+ # interface method
6
+ def call
7
+ klass = decorator_class
8
+
9
+ return @props unless klass
10
+ decorator = klass.new(@props) # IE: AwsSecurityGroup.new(@props)
11
+ decorator.call
12
+ end
13
+
14
+ def decorator_class
15
+ # IE: TerraspacePluginAws::Interfaces::Decorator::AwsSecurityGroup
16
+ klass_name = "TerraspacePluginAws::Interfaces::Decorator::#{@type.camelize}"
17
+ klass_name.constantize
18
+ rescue NameError
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,27 @@
1
+ class TerraspacePluginAws::Interfaces::Decorator
2
+ class AwsSecurityGroup < Base
3
+ def call
4
+ ingress = @props[:ingress]
5
+ return @props unless ingress
6
+
7
+ @props[:ingress] = [ingress] if ingress.is_a?(Hash)
8
+
9
+ # expect Array
10
+ ingress_array!
11
+ @props
12
+ end
13
+
14
+ # json format requires sending all props
15
+ # see: https://github.com/terraform-providers/terraform-provider-aws/issues/8786
16
+ def ingress_array!
17
+ @props[:ingress].map! do |i|
18
+ i[:cidr_blocks] ||= nil
19
+ i[:ipv6_cidr_blocks] ||= nil
20
+ i[:prefix_list_ids] ||= nil
21
+ i[:security_groups] ||= nil
22
+ i[:self] ||= nil
23
+ i
24
+ end
25
+ end
26
+ end
27
+ end
@@ -0,0 +1,7 @@
1
+ class TerraspacePluginAws::Interfaces::Decorator
2
+ class Base
3
+ def initialize(props={})
4
+ @props = props
5
+ end
6
+ end
7
+ end
@@ -0,0 +1,12 @@
1
+ require "aws_data"
2
+
3
+ module TerraspacePluginAws::Interfaces
4
+ class Expander
5
+ include Terraspace::Plugin::Expander::Interface
6
+ delegate :account, :region, to: :aws_data
7
+
8
+ def aws_data
9
+ $__aws_data ||= AwsData.new
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,27 @@
1
+ require "aws_data"
2
+
3
+ module TerraspacePluginAws::Interfaces
4
+ class Layer
5
+ extend Memoist
6
+
7
+ # interface method
8
+ def region
9
+ aws_data.region
10
+ end
11
+
12
+ # interface method
13
+ def account
14
+ aws_data.account
15
+ end
16
+
17
+ # interface method
18
+ def provider
19
+ "aws"
20
+ end
21
+
22
+ def aws_data
23
+ AwsData.new
24
+ end
25
+ memoize :aws_data
26
+ end
27
+ end
@@ -0,0 +1,3 @@
1
+ module TerraspacePluginAws
2
+ VERSION = "0.0.0"
3
+ end
@@ -0,0 +1,31 @@
1
+ require_relative 'lib/terraspace_plugin_aws/version'
2
+
3
+ Gem::Specification.new do |spec|
4
+ spec.name = "terraspace_plugin_aws"
5
+ spec.version = TerraspacePluginAws::VERSION
6
+ spec.authors = ["Tung Nguyen"]
7
+ spec.email = ["tung@boltops.com"]
8
+
9
+ spec.summary = "Terraspace AWS Plugin"
10
+ spec.homepage = "https://github.com/boltops-tools/terraspace_plugin_aws"
11
+ spec.license = "Apache2.0"
12
+ spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
13
+
14
+ spec.metadata["homepage_uri"] = spec.homepage
15
+
16
+ # Specify which files should be added to the gem when it is released.
17
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
18
+ spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
19
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
20
+ end
21
+ spec.bindir = "exe"
22
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
23
+ spec.require_paths = ["lib"]
24
+
25
+ spec.add_dependency "aws-sdk-dynamodb"
26
+ spec.add_dependency "aws-sdk-s3"
27
+ spec.add_dependency "aws_data"
28
+ spec.add_dependency "memoist"
29
+ spec.add_dependency "s3-secure"
30
+ spec.add_dependency "zeitwerk"
31
+ end
metadata ADDED
@@ -0,0 +1,173 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: terraspace_plugin_aws
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Tung Nguyen
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2020-05-31 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: aws-sdk-dynamodb
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: aws-sdk-s3
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: aws_data
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: memoist
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: s3-secure
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :runtime
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: zeitwerk
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ type: :runtime
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ description:
98
+ email:
99
+ - tung@boltops.com
100
+ executables: []
101
+ extensions: []
102
+ extra_rdoc_files: []
103
+ files:
104
+ - ".gitignore"
105
+ - ".rspec"
106
+ - CHANGELOG.md
107
+ - Gemfile
108
+ - LICENSE.txt
109
+ - README.md
110
+ - Rakefile
111
+ - bin/console
112
+ - bin/setup
113
+ - lib/templates/hcl/module/main.tf
114
+ - lib/templates/hcl/module/outputs.tf
115
+ - lib/templates/hcl/module/variables.tf
116
+ - lib/templates/hcl/project/config/templates/backend.tf.tt
117
+ - lib/templates/hcl/project/config/templates/provider.tf
118
+ - lib/templates/hcl/stack/main.tf
119
+ - lib/templates/hcl/stack/outputs.tf
120
+ - lib/templates/hcl/stack/variables.tf
121
+ - lib/templates/ruby/module/main.rb
122
+ - lib/templates/ruby/module/outputs.rb
123
+ - lib/templates/ruby/module/variables.rb
124
+ - lib/templates/ruby/project/config/templates/backend.rb.tt
125
+ - lib/templates/ruby/project/config/templates/provider.rb
126
+ - lib/templates/ruby/stack/main.rb
127
+ - lib/templates/ruby/stack/outputs.rb
128
+ - lib/templates/ruby/stack/variables.rb
129
+ - lib/templates/test/rspec/module/test/.rspec
130
+ - lib/templates/test/rspec/module/test/Gemfile.tt
131
+ - lib/templates/test/rspec/module/test/spec/main_spec.rb.tt
132
+ - lib/templates/test/rspec/module/test/spec/spec_helper.rb
133
+ - lib/terraspace_plugin_aws.rb
134
+ - lib/terraspace_plugin_aws/autoloader.rb
135
+ - lib/terraspace_plugin_aws/clients.rb
136
+ - lib/terraspace_plugin_aws/interfaces/backend.rb
137
+ - lib/terraspace_plugin_aws/interfaces/backend/base.rb
138
+ - lib/terraspace_plugin_aws/interfaces/backend/bucket.rb
139
+ - lib/terraspace_plugin_aws/interfaces/backend/bucket/secure.rb
140
+ - lib/terraspace_plugin_aws/interfaces/backend/table.rb
141
+ - lib/terraspace_plugin_aws/interfaces/config.rb
142
+ - lib/terraspace_plugin_aws/interfaces/decorator.rb
143
+ - lib/terraspace_plugin_aws/interfaces/decorator/aws_security_group.rb
144
+ - lib/terraspace_plugin_aws/interfaces/decorator/base.rb
145
+ - lib/terraspace_plugin_aws/interfaces/expander.rb
146
+ - lib/terraspace_plugin_aws/interfaces/layer.rb
147
+ - lib/terraspace_plugin_aws/version.rb
148
+ - terraspace_plugin_aws.gemspec
149
+ homepage: https://github.com/boltops-tools/terraspace_plugin_aws
150
+ licenses:
151
+ - Apache2.0
152
+ metadata:
153
+ homepage_uri: https://github.com/boltops-tools/terraspace_plugin_aws
154
+ post_install_message:
155
+ rdoc_options: []
156
+ require_paths:
157
+ - lib
158
+ required_ruby_version: !ruby/object:Gem::Requirement
159
+ requirements:
160
+ - - ">="
161
+ - !ruby/object:Gem::Version
162
+ version: 2.3.0
163
+ required_rubygems_version: !ruby/object:Gem::Requirement
164
+ requirements:
165
+ - - ">="
166
+ - !ruby/object:Gem::Version
167
+ version: '0'
168
+ requirements: []
169
+ rubygems_version: 3.1.2
170
+ signing_key:
171
+ specification_version: 4
172
+ summary: Terraspace AWS Plugin
173
+ test_files: []