kitchen-cloudformation 0.0.1

data/kitchen-cloudformation.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "kitchen/driver/cloudformation_version.rb"
+
+Gem::Specification.new do |gem|
+  gem.name          = "kitchen-cloudformation"
+  gem.version       = Kitchen::Driver::CLOUDFORMATION_VERSION
+  gem.license       = "Apache 2.0"
+  gem.authors       = ["Neill Turner"]
+  gem.email         = ["neillwturner@gmail.com"]
+  gem.description   = "A Test Kitchen Driver for Amazon AWS CloudFormation"
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/neillturner/kitchen-cloudformation"
+  candidates = Dir.glob('{lib}/**/*') + ['README.md', 'CHANGELOG.md', 'LICENSE' , 'ca-bundle.crt', 'kitchen-cloudformation.gemspec']
+  gem.files         = candidates.sort
+  gem.executables   = []
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "test-kitchen", "~> 1.4"
+  gem.add_dependency "excon"
+  gem.add_dependency "multi_json"
+  gem.add_dependency "aws-sdk-v1", "~> 1.59.0"
+  gem.add_dependency "aws-sdk", "~> 2"
+
+end

data/lib/kitchen/driver/aws/cf_client.rb

@@ -0,0 +1,108 @@
+# -*- encoding: utf-8 -*-
+#
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "aws-sdk"
+require "aws-sdk-core/credentials"
+require "aws-sdk-core/shared_credentials"
+require "aws-sdk-core/instance_profile_credentials"
+
+module Kitchen
+
+  module Driver
+
+    class Aws
+
+      # A class for creating and managing the Cloud Formation client connection
+      #
+      class CfClient
+
+        def initialize(
+          region,
+          profile_name = nil,
+          ssl_cert_file = nil,
+          access_key_id = nil,
+          secret_access_key = nil,
+          session_token = nil
+        )
+          creds = self.class.get_credentials(
+            profile_name, access_key_id, secret_access_key, session_token
+          )
+          
+          ::AWS.config(
+            :region => region,
+            :credentials => creds,
+            :ssl_ca_bundle => ssl_cert_file            
+          )
+        end
+
+        # Try and get the credentials from an ordered list of locations
+        # http://docs.aws.amazon.com/sdkforruby/api/index.html#Configuration
+        # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+        def self.get_credentials(profile_name, access_key_id, secret_access_key, session_token)
+          shared_creds = ::Aws::SharedCredentials.new(:profile_name => profile_name)
+          if access_key_id && secret_access_key
+            ::Aws::Credentials.new(access_key_id, secret_access_key, session_token)
+          # TODO: these are deprecated, remove them in the next major version
+          elsif ENV["AWS_ACCESS_KEY"] && ENV["AWS_SECRET_KEY"]
+            ::Aws::Credentials.new(
+              ENV["AWS_ACCESS_KEY"],
+              ENV["AWS_SECRET_KEY"],
+              ENV["AWS_TOKEN"]
+            )
+          elsif ENV["AWS_ACCESS_KEY_ID"] && ENV["AWS_SECRET_ACCESS_KEY"]
+            ::Aws::Credentials.new(
+              ENV["AWS_ACCESS_KEY_ID"],
+              ENV["AWS_SECRET_ACCESS_KEY"],
+              ENV["AWS_SESSION_TOKEN"]
+            )
+          elsif shared_creds.loadable?
+            shared_creds
+          else
+            ::Aws::InstanceProfileCredentials.new(:retries => 1)
+          end
+        end
+
+        def create_stack(options)
+          resource.create_stack(options)
+        end
+
+        def get_stack(stack_name)
+          resource.stack(stack_name)
+        end
+
+        def get_stack_events(stack_name)
+          client.describe_stack_events({:stack_name => stack_name})
+        end
+
+        def delete_stack(stack_name)
+          s = resource.stack(stack_name)
+          s.delete
+        end
+
+        def client
+          @client ||= ::Aws::CloudFormation::Client.new 
+        end
+
+        def resource
+          @resource ||= ::Aws::CloudFormation::Resource.new
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/kitchen/driver/aws/stack_generator.rb

@@ -0,0 +1,60 @@
+# -*- encoding: utf-8 -*-
+#
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "kitchen/logging"
+
+module Kitchen
+
+  module Driver
+
+    class Aws
+
+      # A class for encapsulating the stack payload logic
+      #
+      class StackGenerator
+
+        include Logging
+
+        attr_reader :config, :cf
+
+        def initialize(config, cf)
+          @config = config
+          @cf = cf
+        end
+
+        # Transform the provided config into the hash to send to AWS.  Some fields
+        # can be passed in null, others need to be ommitted if they are null
+        def cf_stack_data # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+          s ={:stack_name => config[:stack_name]}
+          s[:template_url] = config[:template_url] if config[:template_file]
+          if config[:template_file]
+            s[:template_body] = File.open(config[:template_file], 'rb') { |file| file.read }
+          end
+          s[:timeout_in_minutes] = config[:timeout_in_minutes] if config[:timeout_in_minutes] != nil and config[:timeout_in_minutes]>0
+          s[:disable_rollback] = config[:disable_rollback] if config[:disable_rollback] != nil and config[:disable_rollback] == true or config[:disable_rollback] == false
+          s[:parameters] = []
+          config[:parameters].each do |k,v|
+            s[:parameters].push({:parameter_key => k.to_s, :parameter_value => v.to_s})
+          end
+          s
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/kitchen/driver/cloud_formation.rb

@@ -0,0 +1,185 @@
+# -*- encoding: utf-8 -*-
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "benchmark"
+require "json"
+require "aws"
+require "kitchen"
+require_relative "cloudformation_version"
+require_relative "aws/cf_client"
+require_relative "aws/stack_generator"
+#require "aws-sdk-core/waiters/errors"
+
+module Kitchen
+
+  module Driver
+
+    # Amazon CloudFormation driver for Test Kitchen.
+    #
+    class CloudFormation < Kitchen::Driver::Base # rubocop:disable Metrics/ClassLength
+
+      kitchen_driver_api_version 2
+
+      plugin_version Kitchen::Driver::CLOUDFORMATION_VERSION
+
+      default_config :region,             ENV["AWS_REGION"] || "us-east-1"
+      default_config :shared_credentials_profile, nil      
+      default_config :aws_access_key_id,  nil
+      default_config :aws_secret_access_key, nil
+      default_config :aws_session_token,  nil
+      default_config :ssl_cert_file,      ENV["SSL_CERT_FILE"]
+      default_config :stack_name,         nil
+      default_config :template_file,      nil
+      default_config :parameters,         {}
+      default_config :disable_rollback,   false
+      default_config :timeout_in_minutes, 0
+      default_config :parameters,         {}
+
+      default_config :ssh_key,              nil
+      default_config :username,            'root'
+      default_config :hostname,             nil
+      #default_config :interface,           nil
+
+      required_config :ssh_key
+      required_config :stack_name
+
+      def create(state) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        copy_deprecated_configs(state)
+        return if state[:stack_name]
+
+        info(Kitchen::Util.outdent!(<<-END))
+          Creating CloudFormation Stack <#{config[:stack_name]}>...
+          If you are not using an account that qualifies under the AWS
+          free-tier, you may be charged to run these suites. The charge
+          should be minimal, but neither Test Kitchen nor its maintainers
+          are responsible for your incurred costs.
+        END
+        begin
+          stack = create_stack
+        rescue Exception => e
+          error("CloudFormation #{e.message}.")
+          return
+        end
+        state[:stack_name] = stack.stack_name
+        state[:hostname] = config[:hostname]
+        info("Stack <#{state[:stack_name]}> requested.")
+        #tag_stack(stack)
+
+        s = cf.get_stack(state[:stack_name])
+        while s.stack_status == 'CREATE_IN_PROGRESS'
+          debug_stack_events(state[:stack_name])
+          info("CloudFormation waiting for stack <#{state[:stack_name]}> to be created.....")
+          sleep(30)
+          s = cf.get_stack(state[:stack_name])
+        end
+        if s.stack_status == 'CREATE_COMPLETE'
+          display_stack_events(state[:stack_name])
+          info("CloudFormation stack <#{state[:stack_name]}> created.")
+        else
+          display_stack_events(state[:stack_name])
+          error("CloudFormation stack <#{stack.stack_name}> failed to create....attempting to delete")
+          destroy(state)
+        end
+      end
+
+      def destroy(state)
+        stack = cf.get_stack(state[:stack_name])
+        if stack.nil?
+          state.delete(:stack_name)
+        else
+          cf.delete_stack(state[:stack_name])
+          begin
+            stack = cf.get_stack(state[:stack_name])
+            while stack.stack_status == 'DELETE_IN_PROGRESS'
+              debug_stack_events(state[:stack_name])
+              info("CloudFormation waiting for stack <#{state[:stack_name]}> to be deleted.....")
+              sleep(30)
+              stack = cf.get_stack(state[:stack_name])
+            end
+          rescue Exception => e
+            info("CloudFormation stack <#{state[:stack_name]}> deleted.")
+            state.delete(:stack_name)
+            return
+          end
+          display_stack_events(state[:stack_name])
+          error("CloudFormation stack <#{stack.stack_name}> failed to deleted.")
+        end
+      end
+
+      def cf
+        @cf ||= Aws::CfClient.new(
+          config[:region],
+          config[:shared_credentials_profile],
+          config[:ssl_cert_file],
+          config[:aws_access_key_id],
+          config[:aws_secret_access_key],
+          config[:aws_session_token]
+        )
+      end
+
+      def stack_generator
+        @stack_generator ||= Aws::StackGenerator.new(config, cf)
+      end
+
+      # This copies transport config from the current config object into the
+      # state.  This relies on logic in the transport that merges the transport
+      # config with the current state object, so its a bad coupling.  But we
+      # can get rid of this when we get rid of these deprecated configs!
+      # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      def copy_deprecated_configs(state)
+        if config[:ssh_timeout]
+          state[:connection_timeout] = config[:ssh_timeout]
+        end
+        if config[:ssh_retries]
+          state[:connection_retries] = config[:ssh_retries]
+        end
+        if config[:username]
+          state[:username] = config[:username]
+        #elsif instance.transport[:username] == instance.transport.class.defaults[:username]
+        #  # If the transport has the default username, copy it from amis.json
+        #  # This duplicated old behavior but I hate amis.json
+        #  ami_username = amis["usernames"][instance.platform.name]
+        #  state[:username] = ami_username if ami_username
+        end
+        if config[:ssh_key]
+          state[:ssh_key] = config[:ssh_key]
+        end
+      end
+      # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+      # Fog AWS helper for creating the stack
+      def create_stack
+        stack_data = stack_generator.cf_stack_data
+        info("Creating CloudFormation Stack #{stack_data[:stack_name]}")
+        cf.create_stack(stack_data)
+      end
+
+      def debug_stack_events(stack_name)
+        return unless logger.debug?
+        response = cf.get_stack_events(stack_name)
+        response[:stack_events].each do |r|
+          debug("#{r[:timestamp]} #{r[:resource_type]} #{r[:logical_resource_id]} #{r[:resource_status]} #{r[:resource_status_reason]}")
+        end
+      end
+
+      def display_stack_events(stack_name)
+        response = cf.get_stack_events(stack_name)
+        response[:stack_events].each do |r|
+          info("#{r[:timestamp]} #{r[:resource_type]} #{r[:logical_resource_id]} #{r[:resource_status]} #{r[:resource_status_reason]}")
+        end
+      end
+
+    end
+  end
+end

data/lib/kitchen/driver/cloudformation_version.rb

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Kitchen
+
+  module Driver
+
+    # Version string for CloudFormation Test Kitchen driver
+    CLOUDFORMATION_VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: kitchen-cloudformation
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Neill Turner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-kitchen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: excon
+  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: multi_json
+  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-v1
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.59.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.59.0
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: A Test Kitchen Driver for Amazon AWS CloudFormation
+email:
+- neillwturner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- ca-bundle.crt
+- kitchen-cloudformation.gemspec
+- lib/kitchen/driver/aws/cf_client.rb
+- lib/kitchen/driver/aws/stack_generator.rb
+- lib/kitchen/driver/cloud_formation.rb
+- lib/kitchen/driver/cloudformation_version.rb
+homepage: https://github.com/neillturner/kitchen-cloudformation
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.3
+signing_key: 
+specification_version: 4
+summary: A Test Kitchen Driver for Amazon AWS CloudFormation
+test_files: []