convection 2.2.1 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8931d15c79795527491f73c4440eb25decfbf0c1
-  data.tar.gz: '0318b27b08e66eca49fe8c459a1036ef9d421a3f'
+  metadata.gz: ea262d5b5afd735ba927d096ad928f509ba36ebf
+  data.tar.gz: 3c44b95e767817b022dcb7ed20dfbfa413882366
 SHA512:
-  metadata.gz: c233b5c721e0d9701529748010627cb237d368b247902ef3a3b616fd1060d0e2319bb2d20eec338793604e55a2deb2d7bc16554651c92d6a9ea63df7f4a8d9eb
-  data.tar.gz: 2bcf5644dd5d20986c96635276fbac598cef484ee4e5d3e670c214272624c95e0dc62e4ec974e0ccf048092c862f306d3ad42ee7dce396dcd0690911fcc4c5cc
+  metadata.gz: 3ac71c23b2062b707a5caafceb973de58ccc4ba32436373f6a26ee14ea49350d19078f6de1bc959d0280477412a63db8e03a7de9b53ddfa175cdc0c8d4dc52ab
+  data.tar.gz: c2a5cae44fda5935f59c4dea52486ddfc4371b4fe1ad1e294bd3d39f2cdaaab7ff833007e1a492fc8cb0891acc358d9feefffabf5a431b75bbbfcc7c2d30789a

data/README.md

@@ -1 +1 @@
-./docs/index.md
+docs/index.md

data/bin/convection

@@ -118,36 +118,59 @@ module Convection
       describe_stack_resources(options[:stack], options[:format], options[:properties], options[:type])
     end
 
+    # rubocop:disable Style/AsciiComments
+
     desc 'terraform-export STACK', 'Create terraform configuration for a given stack (including `terraform import` commands)'
     option :module_path, desc: 'The module path prefix for terraform', default: DEFAULT_MODULE_PATH
     option :output_directory, desc: 'The directory to create configuration files under', aliases: %w(-d --dir), default: '.'.freeze
     option :cloudfile, desc: 'The cloudfile to load', default: 'Cloudfile'
+    option :confirm_root, desc: 'Prompt to confirm module path when --module-path="root"', default: true, type: :boolean
+    option :overwrite, desc: 'Overwrite any conflicting tf.json files in --output-directory', default: false, type: :boolean
+    option :skip_existing, desc: 'Skip any conflicting tf.json files in --output-directory', default: false, type: :boolean
     def terraform_export(stack_name)
       if options[:output_directory].empty?
         say_status :error, '--output-directory must not be empty.', :red
         exit 1
       end
 
-      if options[:module_path] == DEFAULT_MODULE_PATH
+      if options[:confirm_root] && options[:module_path] == DEFAULT_MODULE_PATH
         say_status :warning, '--module-path was set to "root".', :yellow
         exit 0 unless yes?('Are you sure you want to generate terraform import commands in the root namespace?')
       end
 
       init_cloud
       template = @cloud.stacks.fetch(stack_name).template
+      # Beware of 🐲. This patches this Template to include terraform compatible intrinsic functions where possible.
+      #
+      # This should only be done in single threaded environment in the terraform-export command as it breaks usage of cloudformation psuedo-functions.
+      #
+      # e.g. #get_att("Bucket", "Arn") returns "aws_s3_bucket.bucket.arn" instead of { "Fn::GetAtt" => ["Bucket", "Arn"] }.
+      require 'convection/dsl/terraform_intrinsic_functions'
+      template.extend(Convection::DSL::TerraformIntrinsicFunctions)
       template.resource_collections.each(&method(:import_resources))
       template.resources.each(&method(:import_resources))
     end
 
+    # rubocop:enable Style/AsciiComments
+
     no_commands do
       attr_accessor :last_event
 
       private
 
+      # rubocop:disable Style/AsciiComments
+
       def import_resources(_resource_name, resource)
+        # Beware of 🐲. This patches this instance to include terraform compatible intrinsic functions where possible.
+        #
+        # This should only be done in single threaded environment in the terraform-export command as it breaks usage of cloudformation psuedo-functions.
+        require 'convection/dsl/terraform_intrinsic_functions'
+        resource.extend(Convection::DSL::TerraformIntrinsicFunctions)
+
         if resource.respond_to?(:to_hcl_json)
           empty_directory options[:output_directory]
-          create_file File.join(options[:output_directory], "#{resource.name.downcase}.tf.json"), resource.to_hcl_json
+          destination = File.join(options[:output_directory], "#{resource.name.downcase}.tf.json")
+          create_file destination, resource.to_hcl_json, force: options[:overwrite], skip: options[:skip_existing]
         else
           say "# Unable to generate terraform configuration for #{resource.class}. Define #{resource.class}#to_hcl_json to do so.", :yellow
         end
@@ -169,6 +192,8 @@ module Convection
         puts # Print an additional new line
       end
 
+      # rubocop:enable Style/AsciiComments
+
       def operation(task_name, stack)
         work_q = Queue.new
         semaphore = Mutex.new

data/convection.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
   spec.require_paths = ['lib']
 
+  spec.add_runtime_dependency 'activesupport'
   spec.add_runtime_dependency 'aws-sdk', '>= 2'
   spec.add_runtime_dependency 'httparty', '~> 0.13'
   spec.add_runtime_dependency 'netaddr', '~> 1.5'

data/lib/convection/dsl/terraform_intrinsic_functions.rb

@@ -0,0 +1,93 @@
+require 'active_support/core_ext/string/inflections'
+
+module Convection
+  module DSL
+    module TerraformIntrinsicFunctions
+      def base64(_content)
+        %q(base64(#{content.to_json}))
+      end
+
+      def fn_and(*)
+        warn "WARNING: Condition functions cannot be inferred when migrating to terraform. Please set count on migrated resources manually. #{self.class}(#{name})"
+        '${todo.fn_and.ATTRIBUTE.set_in_count}'
+      end
+
+      def fn_equals(*)
+        warn "WARNING: Condition functions cannot be inferred when migrating to terraform. Please set count on migrated resources manually. #{self.class}(#{name})"
+        '${todo.fn_equals.ATTRIBUTE.set_in_count}'
+      end
+
+      def fn_if(*)
+        warn "WARNING: Condition functions cannot be inferred when migrating to terraform. Please set count on migrated resources manually. #{self.class}(#{name})"
+        '${todo.fn_if.ATTRIBUTE.set_in_count}'
+      end
+
+      def fn_import_value(*)
+        warn "WARNING: Fn::ImportValue cannot be inferred when migrated to terraform. Please pull in this input through a variable or local value in your configuration. #{self.class}(#{name})"
+        '${todo.fn_import_value.ATTRIBUTE}'
+      end
+
+      def fn_not(*)
+        warn "WARNING: Condition functions cannot be inferred when migrating to terraform. Please set count on migrated resources manually. #{self.class}(#{name})"
+        '${todo.fn_not.ATTRIBUTE.set_in_count}'
+      end
+
+      def fn_or(*)
+        warn "WARNING: Condition functions cannot be inferred when migrating to terraform. Please set count on migrated resources manually. #{self.class}(#{name})"
+        '${todo.fn_or.ATTRIBUTE.set_in_count}'
+      end
+
+      def fn_sub(*)
+        warn "WARNING: Fn::Sub cannot be inferred when migrating to terraform. Please use ${replace(str, search, replace)} instead. #{self.class}(#{name})"
+        '${replace(todo.fn_sub.STRING, todo.fn_sub.SEARCH, todo.fn_sub.REPLACE)}'
+      end
+
+      def find_in_map(*)
+        warn "WARNING: Fn::FindInMap cannot be inferred when migrating to terraform. Please consult with the interpolation syntax terraform docs #{self.class}(#{name})"
+        '${lookup(lookup(YOUR_MAP, YOUR_TOP_LEVEL_KEY), YOUR_NESTED_KEY)}'
+      end
+
+      def get_att(resource_name, attr_name)
+        interpolation_string = "${#{terraform_resource_type(resource_name)}.#{terraform_resource_name(resource_name)}.#{attr_name.underscore}}"
+        warn "WARNING: Inferring you want to use #{interpolation_string} in place of Fn::GetAtt. Please consult with the interpolation syntax terraform docs and docs for this resource type in terraform to verify compatablity. #{self.class}(#{name})"
+        interpolation_string
+      end
+
+      def get_azs(*)
+        warn "WARNING: Inferring you want to use ${var.availability_zones} instead of Fn::GetAZs. Please consult with the interpolation syntax terraform docs to verify compatablity. Additionally you should attempt to use variables in place of a literal list. #{self.class}(#{name})"
+        '${var.availability_zones}'
+      end
+
+      def join(delimiter, *values)
+        interpolation_string = "${join(\"#{delimiter}\", list(#{values.map { |o| "\"#{o}\"" }.join(', ')}))"
+        warn "WARNING: Inferring you want to use #{interpolation_string} in place of Fn::Join. Please consult with the interpolation syntax terraform docs to verify compatablity. Additionally you should attempt to use variables in place of a literal list. #{self.class}(#{name})"
+        interpolation_string
+      end
+
+      def select(index, *objects)
+        interpolation_string = "${element(list(#{objects.map { |o| "\"#{o}\"" }.join(', ')}), #{index})"
+        warn "WARNING: Inferring you want to use #{interpolation_string} in place of Fn::Select. Please consult with the interpolation syntax terraform docs to verify compatablity. Additionally you should attempt to use variables in place of a literal list. #{self.class}(#{name})"
+        interpolation_string
+      end
+
+      def fn_ref(resource_name)
+        interpolation_string = "${#{terraform_resource_type(resource_name)}.#{terraform_resource_name(resource_name)}.id}"
+        warn "WARNING: Inferring you want to use #{interpolation_string} in place of Fn::Ref. Please consult with the interpolation syntax terraform docs and docs for this resource type in terraform to verify compatablity. #{self.class}(#{name})"
+        interpolation_string
+      end
+
+      def terraform_resource_name(resource_name)
+        resource_name.underscore
+      end
+
+      def terraform_resource_type(resource_name)
+        return type.sub(/^AWS::/, 'aws_').underscore if respond_to?(:type)
+        return resources[resource_name].type.underscore if respond_to?(:resources) && resources[resource_name]
+        return all_resources[resource_name].type.underscore if respond_to?(:all_resources) && all_resources[resource_name]
+        return parent.resources[resource_name].type.underscore if respond_to?(:parent) && parent.resources[resource_name]
+
+        'todo_fixme_see_resource_type'
+      end
+    end
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: convection
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.2.2
 platform: ruby
 authors:
 - John Manero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-23 00:00:00.000000000 Z
+date: 2017-12-04 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
@@ -118,6 +132,7 @@ files:
 - lib/convection/control/stack.rb
 - lib/convection/dsl/helpers.rb
 - lib/convection/dsl/intrinsic_functions.rb
+- lib/convection/dsl/terraform_intrinsic_functions.rb
 - lib/convection/model/attributes.rb
 - lib/convection/model/cloudfile.rb
 - lib/convection/model/diff.rb
@@ -363,7 +378,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A fully generic, modular DSL for AWS CloudFormation