tfctl 0.1.0 → 1.1.1

data/lib/tfctl.rb

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

data/lib/tfctl/aws_org.rb

@@ -71,23 +71,25 @@ module Tfctl
             @aws_org_client.list_children(
                 child_type: 'ORGANIZATIONAL_UNIT',
                 parent_id:  parent_id,
-            ).children.each do |child|
-
-                begin
-                    ou = @aws_org_client.describe_organizational_unit(
-                        organizational_unit_id: child.id,
-                    ).organizational_unit
-                rescue Aws::Organizations::Errors::TooManyRequestsException
-                    # FIXME: - use logger
-                    puts 'AWS Organizations: too many requests.  Retrying in 5 secs.'
-                    sleep 5
-                    retries += 1
-                    retry if retries < 10
-                end
+            ).each do |resp|
+                resp.children.each do |child|
+
+                    begin
+                        ou = @aws_org_client.describe_organizational_unit(
+                            organizational_unit_id: child.id,
+                        ).organizational_unit
+                    rescue Aws::Organizations::Errors::TooManyRequestsException
+                        # FIXME: - use logger
+                        puts 'AWS Organizations: too many requests.  Retrying in 5 secs.'
+                        sleep 5
+                        retries += 1
+                        retry if retries < 10
+                    end
 
-                ou_name = parent_name == :root ? ou.name.to_sym : "#{parent_name}/#{ou.name}".to_sym
+                    ou_name = parent_name == :root ? ou.name.to_sym : "#{parent_name}/#{ou.name}".to_sym
 
-                output[ou_name] = ou.id
+                    output[ou_name] = ou.id
+                end
             end
             output
         end

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
@@ -44,7 +48,7 @@ module Tfctl
             @config.to_json
         end
 
-        # Filters accounts by account property
+        # Filters accounts by an account property
         def find_accounts(property_name, property_value)
             output =[]
             @config[:accounts].each do |account|
@@ -84,7 +88,6 @@ module Tfctl
 
         # Retrieves AWS Organizations data and merges it with data from yaml config.
         def load_config(config_name, yaml_config, aws_org_config)
-
             # AWS Organizations data
             config = aws_org_config
             # Merge organization sections from yaml file

data/lib/tfctl/error.rb

@@ -3,4 +3,13 @@
 module Tfctl
     class Error < StandardError
     end
+
+    class ValidationError < StandardError
+        attr_reader :issues
+
+        def initialize(message, issues = [])
+            super(message)
+            @issues = issues
+        end
+    end
 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/schema.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'json_schemer'
+require_relative 'error.rb'
+
+# Config validator using JSON schema
+
+module Tfctl
+    module Schema
+        class << self
+
+            def validate(data)
+                schemer = JSONSchemer.schema(main_schema)
+                issues = []
+                schemer.validate(data).each do |issue|
+                    issues << {
+                        details:      issue['details'],
+                        data_pointer: issue['data_pointer'],
+                    }
+                end
+
+                return if issues.empty?
+
+                raise Tfctl::ValidationError.new('Config validation failed', issues)
+            end
+
+            private
+
+            def main_schema
+                iam_arn_pattern = 'arn:aws:iam:[a-z\-0-9]*:[0-9]{12}:[a-zA-Z\/+@=.,]*'
+
+                # rubocop:disable Layout/HashAlignment
+                {
+                    'type'       => 'object',
+                    'properties' => {
+                        'tf_state_bucket'         => { 'type' => 'string' },
+                        'tf_state_role_arn'       => {
+                            'type'    => 'string',
+                            'pattern' => iam_arn_pattern,
+                        },
+                        'tf_state_dynamodb_table' => { 'type' => 'string' },
+                        'tf_state_region'         => { 'type' => 'string' },
+                        'tf_required_version'     => { 'type' => 'string' },
+                        'aws_provider_version'    => { 'type' => 'string' },
+                        'tfctl_role_arn'          => {
+                            'type'    => 'string',
+                            'pattern' => iam_arn_pattern,
+                        },
+                        'data'                    => { 'type' => 'object' },
+                        'exclude_accounts'        => { 'type' => 'array' },
+                        'organization_root'       => org_schema,
+                        'organization_units'      => org_schema,
+                        'account_overrides'       => org_schema,
+                    },
+                    'required'   => %w[
+                        tf_state_bucket
+                        tf_state_role_arn
+                        tf_state_dynamodb_table
+                        tf_state_region
+                        tfctl_role_arn
+                    ],
+                    'additionalProperties' => false,
+                }
+                # rubocop:enable Layout/HashAlignment
+            end
+
+            def org_schema
+                {
+                    'type'       => 'object',
+                    'properties' => {
+                        'profiles'          => { 'type'=> 'array' },
+                        'data'              => { 'type'=> 'object' },
+                        'tf_execution_role' => { 'type'=> 'string' },
+                        'region'            => { 'type'=> 'string' },
+                    },
+                }
+            end
+        end
+    end
+end

data/lib/tfctl/version.rb

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

data/tfctl.gemspec

@@ -25,10 +25,12 @@ Gem::Specification.new do |spec|
 
     # Think when adding new dependencies.  Is it really necessary?
     # "The things you own end up owning you" etc.
-    spec.add_dependency 'aws-sdk-organizations', '~> 1.13'
-    spec.add_dependency 'parallel',              '~> 1.17'
+    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_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.9'
+    spec.add_development_dependency 'rubocop',     '~> 0.84'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tfctl
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Andrew Wasilczuk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-09 00:00:00.000000000 Z
+date: 2020-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-organizations
@@ -16,28 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.40'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.40'
+- !ruby/object:Gem::Dependency
+  name: json_schemer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '1.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '1.19'
 - !ruby/object:Gem::Dependency
   name: terminal-table
   requirement: !ruby/object:Gem::Requirement
@@ -52,34 +66,48 @@ 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
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.76'
+        version: '0.84'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.76'
+        version: '0.84'
 description: 
 email:
 - akw@scalefactory.com
@@ -94,6 +122,7 @@ files:
 - ".travis.yml"
 - CHANGELOG.adoc
 - Gemfile
+- Guardfile
 - LICENSE
 - Makefile
 - README.adoc
@@ -106,12 +135,12 @@ files:
 - examples/bootstrap/terraform-exec-role.template
 - examples/bootstrap/terraform-state.template
 - examples/bootstrap/tfctl-org-access.template
-- examples/control_tower/conf/example.yaml
 - examples/control_tower/modules/s3-bucket/main.tf
 - examples/control_tower/modules/s3-bucket/variables.tf
 - examples/control_tower/profiles/example-profile/data.tf
 - examples/control_tower/profiles/example-profile/main.tf
 - examples/control_tower/profiles/example-profile/variables.tf
+- examples/control_tower/tfctl.yaml
 - lib/hash.rb
 - lib/tfctl.rb
 - lib/tfctl/aws_org.rb
@@ -120,6 +149,7 @@ files:
 - lib/tfctl/executor.rb
 - lib/tfctl/generator.rb
 - lib/tfctl/logger.rb
+- lib/tfctl/schema.rb
 - lib/tfctl/version.rb
 - tfctl.gemspec
 homepage: https://github.com/scalefactory/tfctl