tfctl 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cac739f38f0484a3f0a8373224183f0705c79372962c58711f82719978d86fbe
-  data.tar.gz: 8ed33267e070125bb03e1591075642163c367f8d5ab1d4ee4040c2afc97a11d8
+  metadata.gz: c01c64c623610d77abd88401c0bbea5d56eb4963b58d7ad3178a777d5d297ead
+  data.tar.gz: f6bbe78e0bc1f504105bcfa3362ce90368e5cd79b4b075a92e57b8adadbce1c1
 SHA512:
-  metadata.gz: 675c2b7e868b2850749a7ca53b34ee594f84a8b30a62f3098ede1221394879d7595ecede9b76eb3da960728600092f1385ac35d122e5d2aaf17e699f903d019a
-  data.tar.gz: caf57a862a8e5ecc2e3ff64102389f1822527f4975a708407b75a23a2378d8a087fe1a6ead434f4835fc3e5681c35c145d5d5b6dfb446409ffc909940a34c2e7
+  metadata.gz: 2eb1394b05e67619f9a2498348f4a1f96b2eb4bf0afd7252c74d822c3f35e08a6bc953c7eae95388ab2a5e34f5c8c7dbde91db9f59f0f02cbba51e23030542e2
+  data.tar.gz: a17c9e00867b95243e47ddc495a662a2464dcc251148fb7bfd51e8c380de6845235a4b7411fd5c833cbcdb5c3f582ff2bbbafc21f5c7bb2bb707c3955cfd9381

data/.travis.yml

@@ -1,17 +1,18 @@
 rvm:
-- 2.3
-- 2.6
-sudo: false
+  - 2.3
+  - 2.6
+os: linux
+language: ruby
 script: make test
-deploy:
-  provider: rubygems
-  api_key:
-    secure: FKAONS7x6koN7oiEULr4ViwjlDBzbE0bCgqhXRP4DfTtlRyEymeqgrfSIqkVH7unjd0muIGrMBnFuaQVSx7648RS1Ss0QAJo32SVnzoYl1P03cijqNmbbaf1jRdA3IGmh0gV5vsXrmlHiP8gfAuC9PqQ550OzxzWUvEI8vXgSTibmKd/PoQinv5g/dq0gBFjlhSMt/k3Z9WlMmkEsAro/r/Ie2M7mItHPT65f0ga5q5SeujPQQ3Sd/l3mznh37bmnw5RZpFDYdA7jL2p0Y58XJPBU8soa3ZC5GeHyxCYVoGh6EDGAFb83ERRT6rQ7ywkOufTv1o497P7a/prSbvT6fzc+DcugXPEaglT+dUXMe36OoF907Xva4vq3xIHV2N/yrxbDM85hmMk22wEU+9wpDDzFNQnfsXNbaHG9F7gLgy0eoTRrSuJf6cPDlE8pwvn7b8cjieeqWc//ZNhSYnHYZGER4LFINWVxs68Eofmmqp2IESTcUpJ8oB4bV+bzzyobJMRobOXu2hvgCrTdr6r/PnckpAfZE/l4nVQa14f1FU//8bU3DwvNun6TX1Ujp+XNiRDUlvP2KnkBU4s5rsIkL3lCHW7r6GipSk6SOvGMTz5eySMsoWvZQBdAzk/OxcIteeWH9pdo1Hbu5x2/bwyuTRCQ9E79CKWDKlIQwCgUY0=
-  gem: tfctl
-  on:
-    tags: true
-    repo: scalefactory/tfctl
-notifications:
-  slack:
-    rooms:
-      secure: HrdsUaTCvwtq5rLyAf7Uwo76p9JhxnoFvoZU/AtxTCL6lwMm5pqpfDAdbBH8C2BYMWRyiS8IfSrvuLbGUr317qJgVCmnhD7JIgdA0Aih4GkR0yK+EVao7qdOClO2CGJFJGqHveBBpXy94FEwgFwQSvnuSZdY8gNdXafvpgrPvcbWHIF9Bq7StfYelWZX6+FL7xczqVhdetXcHJEj6Q/thkbvyn0hJAVegjDq4Pw3MyR66Mv5HTj+jYbGrJOR1poNW8vv4iQjK0TIMvCCeTv4Ddrjitn1kOK1BPYqoHEkaRwXdS7+hevv+UfV074awTp3UOIS5VP3ve/KX21xcl9DWMG7Gde9tuyap9WKhN3XE5686qrfn4M/L7PmVnzeYimUKLQfdqjDXa7UI3orGIOq8nKCsCUFvFUQZ/DxeEssJzBNNRbeGywwVtXk7/8L2HHiQJ3t/29vMLEq6EwskYK3Uao2aIVWpLSkPwOuwVxrNWXrwojrrKo+oo8QvW6xkov5UW3VkapyzRyDN2oIpNkFeLYfuyTO4MBsnLzCBqJYEeku2l0Hp9WBq2Q1a+FRgqQlcRbLPsYwK5AdkRKcWuXP8FMZoqXX6F9B73q5Dbub2et4YN4zhvroLZN6MmlneM6faJh9aS4yV2ZlU1XbOtbqP0nkHrJ+o8DeM/wgTB1GB90=
+jobs:
+  include:
+    - stage: Gem release
+      rvm: 2.6
+      deploy:
+        provider: rubygems
+        api_key:
+          secure: FKAONS7x6koN7oiEULr4ViwjlDBzbE0bCgqhXRP4DfTtlRyEymeqgrfSIqkVH7unjd0muIGrMBnFuaQVSx7648RS1Ss0QAJo32SVnzoYl1P03cijqNmbbaf1jRdA3IGmh0gV5vsXrmlHiP8gfAuC9PqQ550OzxzWUvEI8vXgSTibmKd/PoQinv5g/dq0gBFjlhSMt/k3Z9WlMmkEsAro/r/Ie2M7mItHPT65f0ga5q5SeujPQQ3Sd/l3mznh37bmnw5RZpFDYdA7jL2p0Y58XJPBU8soa3ZC5GeHyxCYVoGh6EDGAFb83ERRT6rQ7ywkOufTv1o497P7a/prSbvT6fzc+DcugXPEaglT+dUXMe36OoF907Xva4vq3xIHV2N/yrxbDM85hmMk22wEU+9wpDDzFNQnfsXNbaHG9F7gLgy0eoTRrSuJf6cPDlE8pwvn7b8cjieeqWc//ZNhSYnHYZGER4LFINWVxs68Eofmmqp2IESTcUpJ8oB4bV+bzzyobJMRobOXu2hvgCrTdr6r/PnckpAfZE/l4nVQa14f1FU//8bU3DwvNun6TX1Ujp+XNiRDUlvP2KnkBU4s5rsIkL3lCHW7r6GipSk6SOvGMTz5eySMsoWvZQBdAzk/OxcIteeWH9pdo1Hbu5x2/bwyuTRCQ9E79CKWDKlIQwCgUY0=
+        gem: tfctl
+        on:
+          tags: true
+          repo: scalefactory/tfctl

data/CHANGELOG.adoc

@@ -1,12 +1,18 @@
 = Changelog
 
+== 0.2.0
+
+* feat: configurable Terraform and AWS provider version requirements
+* fix: use provider region from config file
+* fix: fail when terraform command is missing
+
 == 0.1.0
 
-* FEATURE: Added `-l` switch to list discovered accounts.
+* feat: Added `-l` switch to list discovered accounts.
 
 == 0.0.2
 
-* BUGFIX: Fixed an exception when `exclude_accounts` is not set.
+* fix: Fixed an exception when `exclude_accounts` is not set.
 
 == 0.0.1
 

data/Guardfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'bundle exec rspec' do
+    watch(%r{^spec/.+_spec\.rb$})
+    watch(%r{^lib/tfctl/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+    watch('spec/spec_helper.rb')  { 'spec' }
+end

data/Makefile

@@ -1,4 +1,4 @@
-.PHONY: clean install test rubocop spec
+.PHONY: clean install test rubocop spec guard
 
 vendor:
 	$(info => Installing Ruby dependencies)
@@ -6,6 +6,10 @@ vendor:
 
 test: vendor rubocop spec
 
+guard: vendor
+	$(info => Starting guard)
+	@bundle exec guard
+
 rubocop:
 	$(info => Running rubocop)
 	@vendor/bin/rubocop

data/bin/tfctl

@@ -118,11 +118,8 @@ def run_account(config, account, options, tf_argv, log)
     # executed from.
     log.info "#{account[:name]}: Generating Terraform run directory"
     Tfctl::Generator.make(
-        config:         config,
-        account_id:     account[:id],
-        account_name:   account[:name],
-        profiles:       account[:profiles],
-        execution_role: account[:tf_execution_role],
+        account: account,
+        config:  config,
     )
 
     log.info "#{account[:name]}: Executing Terraform #{tf_argv[0]}"

data/examples/control_tower/conf/example.yaml

@@ -19,7 +19,8 @@ tf_state_dynamodb_table: 'terraform-lock'
 tf_state_region: 'eu-west-1'
 # Role for accessing state resources
 tf_state_role_arn: 'arn:aws:iam::SHARED_SERVICES_ACCOUNT_ID:role/TerraformStateRole'
-
+tf_required_version: '>= 0.12.0'
+aws_provider_version: '>= 2.14'
 # Role used by tfctl to retrieve data from AWS Organizations
 # Has to be set up in the primary org account
 tfctl_role_arn: 'arn:aws:iam::PRIMARY_ACCOUNT_ID:role/TfctlRole'
@@ -61,7 +62,7 @@ organization_units:
 # Configuration to apply to individual accounts
 account_overrides:
   test-example1:
-    # Override the bucket name in specific account
+    # Override the bucket name in a specific account
     example_bucket_name: 'tfctl-account-override-example'
 
 

data/lib/tfctl/config.rb

@@ -26,6 +26,10 @@ module Tfctl
             @config[key]
         end
 
+        def fetch(key, default)
+            @config.fetch(key, default)
+        end
+
         def each(&block)
             @config.each(&block)
         end

data/lib/tfctl/executor.rb

@@ -12,11 +12,18 @@ module Tfctl
         # Execute terraform command
         def run(account_name:, config_name:, log:, cmd: nil, argv: [], unbuffered: true)
 
+            # Use bin/terraform from a project dir if available
+            # Otherwise rely on PATH.
             if cmd.nil?
-                # use project terraform binary if available
                 cmd = File.exist?("#{PROJECT_ROOT}/bin/terraform") ? "#{PROJECT_ROOT}/bin/terraform" : 'terraform'
             end
 
+            # Fail if there are no arguments for terraform and show terraform -help
+            if argv.empty?
+                help = `#{cmd} -help`.lines.to_a[1..-1].join
+                raise Tfctl::Error, "Missing terraform command.\n #{help}"
+            end
+
             path       = "#{PROJECT_ROOT}/.tfctl/#{config_name}/#{account_name}"
             cwd        = FileUtils.pwd
             plan_file  = "#{path}/tfplan"

data/lib/tfctl/generator.rb

@@ -14,17 +14,10 @@ module Tfctl
             end
         end
 
-        def make(
-            account_id:,
-            account_name:,
-            execution_role:,
-            profiles:,
-            config:,
-            region: 'eu-west-1',
-            tf_version: '>= 0.12.0',
-            aws_provider_version: '~> 2.14',
-            target_dir: "#{PROJECT_ROOT}/.tfctl/#{config[:config_name]}/#{account_name}"
-        )
+        def make(account:, config:)
+            target_dir = "#{PROJECT_ROOT}/.tfctl/#{config[:config_name]}/#{account[:name]}"
+            tf_version = config.fetch(:tf_required_version, '>= 0.12.0')
+            aws_provider_version = config.fetch(:aws_provider_version, '>= 2.14')
 
             FileUtils.mkdir_p target_dir
 
@@ -34,7 +27,7 @@ module Tfctl
                     'backend'          => {
                         's3' => {
                             'bucket'         => config[:tf_state_bucket],
-                            'key'            => "#{account_name}/tfstate",
+                            'key'            => "#{account[:name]}/tfstate",
                             'region'         => config[:tf_state_region],
                             'role_arn'       => config[:tf_state_role_arn],
                             'dynamodb_table' => config[:tf_state_dynamodb_table],
@@ -49,9 +42,9 @@ module Tfctl
                 'provider' => {
                     'aws' => {
                         'version'     => aws_provider_version,
-                        'region'      => region,
+                        'region'      => account[:region],
                         'assume_role' => {
-                            'role_arn' => "arn:aws:iam::#{account_id}:role/#{execution_role}",
+                            'role_arn' => "arn:aws:iam::#{account[:id]}:role/#{account[:tf_execution_role]}",
                         },
                     },
                 },
@@ -74,7 +67,7 @@ module Tfctl
 
             FileUtils.rm Dir.glob("#{target_dir}/profile_*.tf.json")
 
-            profiles.each do |profile|
+            account[:profiles].each do |profile|
                 profile_block = {
                     'module' => {
                         profile => {

data/lib/tfctl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tfctl
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
 end

data/tfctl.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
     spec.add_dependency 'parallel',              '~> 1.17'
     spec.add_dependency 'terminal-table',        '~> 1.8'
 
-    spec.add_development_dependency 'rspec', '~> 3.8'
-    spec.add_development_dependency 'rubocop', '~> 0.76'
+    spec.add_development_dependency 'guard-rspec', '~> 4.7'
+    spec.add_development_dependency 'rspec',       '~> 3.8'
+    spec.add_development_dependency 'rubocop',     '~> 0.76'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tfctl
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Wasilczuk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-09 00:00:00.000000000 Z
+date: 2019-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-organizations
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,7 @@ files:
 - ".travis.yml"
 - CHANGELOG.adoc
 - Gemfile
+- Guardfile
 - LICENSE
 - Makefile
 - README.adoc