tfctl 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1825dfe2e3683c1ef8444460e5cd7baedde7424ec60de056a7a3351e69ad380
-  data.tar.gz: db929e7c2323d42c99719610e18bf5ef17277521ff69985b668e6f26ca71feea
+  metadata.gz: 5fe79c7d1c05d536eabd439037d74996bf35af1b72e359e34a0f52f32067fecf
+  data.tar.gz: 67c20fd6e27f58ce119e9c050923c80499b0054991716515f41dbbd2c4156336
 SHA512:
-  metadata.gz: 7288eadc3e15802584060d055a2dd51fa34aae5fe0fba8d4eefd69d3e654fa0bcdef3c05b9a410891f31b4b3f9564301350d6298f7fcdbdf175deef9ac236a74
-  data.tar.gz: c9515472d66fb6d6f423aaf2d01504901a2e42acf47aa6d59919d7737dc37f2817436e5364241afca523cd70cccf2082d0e791573aabb9ff55b3da42fcd760c2
+  metadata.gz: 693f29d4f7ddea34dfe9dbb747cf976452bdc8ff423bf63d41bc2f77f2ae05fb58ddb8b6d9a2d4c1f151749899a325b7326384e5e4128eda076d51c7c54bd8ca
+  data.tar.gz: a71acfa057e8a80923b7ec9c48ab2654af1fd6d73e4fa0259949d3bded769773dd3127590475266586fe48e3f5549a7f8725c111429a6ceb850389bb7fc63c01

data/.bundle/config

@@ -0,0 +1,3 @@
+---
+BUNDLE_WITH: "developement"
+BUNDLE_BIN: "vendor/bin"

data/.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10

data/.gitignore

@@ -4,7 +4,6 @@
 pkg/
 *.gem
 vendor/
-.bundle
 bin/bundle
 bin/htmldiff
 bin/ldiff

data/.rubocop.yml

@@ -2,6 +2,7 @@
 AllCops:
   TargetRubyVersion: 2.5
   DisplayCopNames: true
+  NewCops: enable
 
 Layout/IndentationWidth:
   Width: 4

data/CHANGELOG.adoc

@@ -1,6 +1,13 @@
 = Changelog
 
-== Upcoming
+== 1.3.0
+
+ * feat: support new Terraform provider syntax
+
+BREAKING CHANGE: The minimum supported Terraform version has been bumped to
+0.12.29.  If you are running an older version of Terraform you will need to
+update to the latest Terraform in 0.12.x series before updating tfctl.  Once
+tfctl is updated you can upgrade Terraform to further versions.
 
 == 1.2.2
  * chore: reverted PR #11 - not necessary and introduced regression.  See PR #13 for details.

data/Makefile

@@ -2,7 +2,8 @@
 
 vendor:
 	$(info => Installing Ruby dependencies)
-	@bundle install --path vendor --with developement --binstubs=vendor/bin
+	@bundle install
+	@bundle binstubs --all --path vendor/bin
 
 test: vendor rubocop spec
 
@@ -10,11 +11,11 @@ guard: vendor
 	$(info => Starting guard)
 	@bundle exec guard
 
-rubocop:
+rubocop: vendor
 	$(info => Running rubocop)
 	@vendor/bin/rubocop
 
-spec:
+spec: vendor
 	$(info => Running spec tests)
 	@vendor/bin/rspec
 

data/README.adoc

@@ -42,6 +42,23 @@ https://aws.amazon.com/solutions/aws-landing-zone/[AWS Landing Zone] and
 https://aws.amazon.com/controltower/[Control Tower] but should work with most
 other ways of managing accounts in AWS Organizations.
 
+== Project status
+
+`tfctl` is an open source project published by The Scale Factory.
+
+We currently consider this project to be maintained but we don't actively
+develop new features.  We keep it security patched and ready for use in
+production environments.
+
+We’ll take a look at any issues or PRs you open and get back to you as soon as
+we can. We don’t offer any formal SLA, but we’ll be checking on this project
+periodically.
+
+If your issue is urgent, you can flag it as such, and we’ll attempt to triage
+appropriately, but we have paying customers who also have demands on our time.
+If your business depends on this project and you have an urgent problem, then
+you can talk to our sales team about paying us to support you.
+
 == Features
 
 * Discovers AWS accounts automatically.
@@ -57,8 +74,8 @@ other ways of managing accounts in AWS Organizations.
 
 == Requirements
 
- * Terraform >= 0.12
- * Ruby >= 2.4
+ * Terraform >= 0.12.29
+ * Ruby >= 2.5
  * Accounts managed in AWS Organizations (by Landing Zone, Control Tower, some
    other means)
 

data/RELEASING.adoc

@@ -0,0 +1,13 @@
+= Releasing
+
+This document is aimed at `tfctl` maintainers and describes the process of
+releasing a new gem version.
+
+== Process
+
+* Smoke test in SF test accounts: https://github.com/scalefactory/tfctl-test
+* Bump version in `lib/tfctl/version.rb`
+* Update `CHANGELOG.adoc`
+* Commit
+* Create a new GitHub release and version tag using format: vX.X.X
+* TravisCI will build and release the gem automatically: https://travis-ci.org/github/scalefactory/tfctl

data/bin/tfctl

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-if File.directory?(File.dirname(__FILE__) + '/../vendor')
+if File.directory?("#{File.dirname(__FILE__)}/../vendor")
     require 'bundler/setup'
 end
 require 'optparse'
@@ -81,8 +81,8 @@ begin
     targetting_opts = %i[account ou all]
     targets_set = []
     options.each do |k, v|
-        if targetting_opts.include?(k)
-            targets_set << k.to_s unless v.nil?
+        if targetting_opts.include?(k) and !v.nil?
+            targets_set << k.to_s
         end
     end
     if targets_set.length > 1

data/examples/control_tower/profiles/example-profile/main.tf

@@ -1,4 +1,4 @@
 module "bucket" {
   source = "../../modules/s3-bucket"
-  name   = "${local.account_id}-${local.account["example_bucket_name"]}"
+  name   = "${local.account_id}-${local.account["data"]["example_bucket_name"]}"
 }

data/examples/control_tower/profiles/example-profile/variables.tf

@@ -7,6 +7,6 @@ variable "config" {
 locals {
   config     = jsondecode(var.config)
   account_id = "${data.aws_caller_identity.current.account_id}"
-  # get current account configuration from tfctl config
+  # get account configuration from tfctl config
   account    = [ for account in local.config["accounts"]: account if account["id"] == local.account_id ][0]
 }

data/examples/control_tower/tfctl.yaml

@@ -5,7 +5,7 @@
 # create final configuration used by tfctl.  You can view the merged
 # configuration by running:
 #
-#   tfctl -c conf/example.yaml -s
+#   tfctl -c conf/tfctl.yaml -s
 #
 
 #
@@ -17,7 +17,7 @@ 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'
+tf_required_version: '>= 0.12.29'
 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

data/lib/hash.rb

@@ -18,13 +18,14 @@ class Hash
         merge(second.to_h, &merger)
     end
 
-    # Copied from ruby 2.6 Psych for 2.3 compatibility.
     def symbolize_names!(result = self)
         case result
         when Hash
+            # rubocop:disable Style/HashEachMethods
             result.keys.each do |key|
                 result[key.to_sym] = symbolize_names!(result.delete(key))
             end
+            # rubocop:enable Style/HashEachMethods
         when Array
             result.map! { |r| symbolize_names!(r) }
         end

data/lib/tfctl.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require_relative 'tfctl/aws_org.rb'
-require_relative 'tfctl/config.rb'
-require_relative 'tfctl/error.rb'
-require_relative 'tfctl/executor.rb'
-require_relative 'tfctl/generator.rb'
-require_relative 'tfctl/logger.rb'
-require_relative 'tfctl/schema.rb'
-require_relative 'tfctl/version.rb'
+require_relative 'tfctl/aws_org'
+require_relative 'tfctl/config'
+require_relative 'tfctl/error'
+require_relative 'tfctl/executor'
+require_relative 'tfctl/generator'
+require_relative 'tfctl/logger'
+require_relative 'tfctl/schema'
+require_relative 'tfctl/version'

data/lib/tfctl/aws_org.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'error.rb'
+require_relative 'error'
 require 'aws-sdk-organizations'
 
 module Tfctl

data/lib/tfctl/config.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative '../hash.rb'
-require_relative 'error.rb'
+require_relative '../hash'
+require_relative 'error'
 require 'yaml'
 require 'json'
 
@@ -121,7 +121,9 @@ module Tfctl
             return config unless config.key?(:exclude_accounts)
 
             config[:accounts].each_with_index do |account, idx|
+                # rubocop:disable Style/IfWithBooleanLiteralBranches
                 config[:accounts][idx][:excluded] = config[:exclude_accounts].include?(account[:name]) ? true : false
+                # rubocop:enable Style/IfWithBooleanLiteralBranches
             end
 
             config

data/lib/tfctl/executor.rb

@@ -3,7 +3,7 @@
 require 'open3'
 require 'fileutils'
 require 'shellwords'
-require_relative 'error.rb'
+require_relative 'error'
 
 module Tfctl
     module Executor

data/lib/tfctl/generator.rb

@@ -10,21 +10,27 @@ module Tfctl
 
         def write_json_block(path, block)
             File.open(path, 'w') do |f|
-                f.write(JSON.pretty_generate(block) + "\n")
+                f.write("#{JSON.pretty_generate(block)}\n")
             end
         end
 
         def make(account:, config:)
             target_dir = "#{PROJECT_ROOT}/.tfctl/#{config[:config_name]}/#{account[:name]}"
-            tf_version = config.fetch(:tf_required_version, '>= 0.12.0')
+            tf_version = config.fetch(:tf_required_version, '>= 0.12.29')
             aws_provider_version = config.fetch(:aws_provider_version, '>= 2.14')
 
             FileUtils.mkdir_p target_dir
 
             terraform_block = {
                 'terraform' => {
-                    'required_version' => tf_version,
-                    'backend'          => {
+                    'required_version'   => tf_version,
+                    'required_providers' => {
+                        'aws' => {
+                            'source'  => 'hashicorp/aws',
+                            'version' => aws_provider_version,
+                        },
+                    },
+                    'backend'            => {
                         's3' => {
                             'bucket'         => config[:tf_state_bucket],
                             'key'            => "#{account[:name]}/tfstate",
@@ -41,7 +47,6 @@ module Tfctl
             provider_block = {
                 'provider' => {
                     'aws' => {
-                        'version'     => aws_provider_version,
                         'region'      => account[:region],
                         'assume_role' => {
                             'role_arn' => "arn:aws:iam::#{account[:id]}:role/#{account[:tf_execution_role]}",
@@ -71,11 +76,8 @@ module Tfctl
                 profile_block = {
                     'module' => {
                         profile => {
-                            'source'    => "../../../profiles/#{profile}",
-                            'config'    => '${var.config}',
-                            'providers' => {
-                                'aws' => 'aws',
-                            },
+                            'source' => "../../../profiles/#{profile}",
+                            'config' => '${var.config}',
                         },
                     },
                 }

data/lib/tfctl/logger.rb

@@ -6,7 +6,7 @@ module Tfctl
     class Logger
 
         def initialize(log_level)
-            @outlog  = ::Logger.new(STDOUT)
+            @outlog  = ::Logger.new($stdout)
 
             self.level = log_level
 

data/lib/tfctl/schema.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'json_schemer'
-require_relative 'error.rb'
+require_relative 'error'
 
 # Config validator using JSON schema
 

data/lib/tfctl/version.rb

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

data/tfctl.gemspec

@@ -30,9 +30,10 @@ Gem::Specification.new do |spec|
     spec.add_dependency 'aws-sdk-organizations', '~> 1.40'
     spec.add_dependency 'json_schemer',          '~> 0.2'
     spec.add_dependency 'parallel',              '~> 1.19'
-    spec.add_dependency 'terminal-table',        '~> 1.8'
+    spec.add_dependency 'terminal-table',        '>= 1.8', '< 4.0'
 
-    spec.add_development_dependency 'guard-rspec', '~> 4.7'
-    spec.add_development_dependency 'rspec',       '~> 3.9'
-    spec.add_development_dependency 'rubocop',     '~> 0.84'
+    spec.add_development_dependency 'guard-rspec',   '~> 4.7'
+    spec.add_development_dependency 'rspec',         '~> 3.9'
+    spec.add_development_dependency 'rubocop',       '~> 1.3'
+    spec.add_development_dependency 'rubocop-rspec', '~> 2.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tfctl
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Andrew Wasilczuk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-01 00:00:00.000000000 Z
+date: 2021-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-organizations
@@ -56,16 +56,22 @@ dependencies:
   name: terminal-table
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +106,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.84'
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.84'
+        version: '2.2'
 description: 
 email:
 - akw@scalefactory.com
@@ -116,6 +136,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".bundle/config"
+- ".github/dependabot.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -126,6 +148,7 @@ files:
 - LICENSE
 - Makefile
 - README.adoc
+- RELEASING.adoc
 - bin/tfctl
 - docs/configuration.adoc
 - docs/control_tower.adoc