Updating to use the AWS SDK V2, refactoring code out of the base driver

so it is easier to read, adding unit tests, updating static analysis
to match Test Kitchen

Author: tyler-ball

.cane

@@ -1,2 +1,2 @@
---style-measure 100
 --abc-max 30
+--style-measure 100

.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format progress

.rubocop.yml

@@ -0,0 +1,9 @@
+Style/FileName:
+  Exclude:
+    - 'data/**/*'
+
+Style/Next:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false

.tailor

@@ -0,0 +1,3 @@
+--readme README.md
+--markup markdown
+--markup-provider maruku

.yardopts

@@ -1,9 +1,9 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in kitchen-ec2.gemspec
 gemspec
 
 group :test do
-  gem 'rake'
-  gem 'pry'
+  gem "rake"
+  gem "pry"
 end

Gemfile

@@ -1,24 +1,39 @@
+# -*- encoding: utf-8 -*-
+
 require "bundler/gem_tasks"
-require 'cane/rake_task'
-require 'tailor/rake_task'
-require 'rspec/core/rake_task'
 
+require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:test)
 
-desc "Run cane to check quality metrics"
-Cane::RakeTask.new do |cane|
-  cane.canefile = './.cane'
-end
-
-Tailor::RakeTask.new
-
 desc "Display LOC stats"
 task :stats do
   puts "\n## Production Code Stats"
-  sh "countloc -r lib/kitchen"
+  sh "countloc -r lib/kitchen lib/kitchen.rb"
+  puts "\n## Test Code Stats"
+  sh "countloc -r spec features"
+end
+
+require "finstyle"
+require "rubocop/rake_task"
+RuboCop::RakeTask.new(:style) do |task|
+  task.options << "--display-cop-names"
+end
+
+if RUBY_ENGINE != "jruby"
+  require "cane/rake_task"
+  desc "Run cane to check quality metrics"
+  Cane::RakeTask.new do |cane|
+    cane.canefile = "./.cane"
+  end
+
+  desc "Run all quality tasks"
+  task :quality => [:cane, :style, :stats]
+else
+  desc "Run all quality tasks"
+  task :quality => [:style, :stats]
 end
 
-desc "Run all quality tasks"
-task :quality => [:cane, :tailor, :stats, :test]
+require "yard"
+YARD::Rake::YardocTask.new
 
-task :default => [:quality]
+task :default => [:test, :quality]

Rakefile

@@ -1,31 +1,39 @@
 # -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'kitchen/driver/ec2_version.rb'
+require "kitchen/driver/ec2_version.rb"
 
 Gem::Specification.new do |gem|
   gem.name          = "kitchen-ec2"
   gem.version       = Kitchen::Driver::EC2_VERSION
-  gem.license       = 'Apache 2.0'
+  gem.license       = "Apache 2.0"
   gem.authors       = ["Fletcher Nichol"]
   gem.email         = ["[email protected]"]
   gem.description   = "A Test Kitchen Driver for Amazon EC2"
   gem.summary       = gem.description
   gem.homepage      = "http://kitchen.ci/"
 
-  gem.files         = `git ls-files`.split($/)
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   gem.executables   = []
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency "test-kitchen", "~> 1.4.0"
-  gem.add_dependency 'excon'
-  gem.add_dependency 'multi_json'
-  gem.add_dependency 'aws-sdk-v1', '~> 1.59.0'
-  gem.add_dependency 'retryable', '~> 2.0'
+  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"
 
-  gem.add_development_dependency 'rspec'
-  gem.add_development_dependency 'cane'
-  gem.add_development_dependency 'tailor'
-  gem.add_development_dependency 'countloc'
+  gem.add_development_dependency "rspec",     "~> 3.2"
+  gem.add_development_dependency "countloc",  "~> 0.4"
+  gem.add_development_dependency "maruku",    "~> 0.6"
+  gem.add_development_dependency "simplecov", "~> 0.7"
+  gem.add_development_dependency "yard",      "~> 0.8"
+
+  # style and complexity libraries are tightly version pinned as newer releases
+  # may introduce new and undesireable style choices which would be immediately
+  # enforced in CI
+  gem.add_development_dependency "finstyle",  "1.4.0"
+  gem.add_development_dependency "cane",      "2.6.2"
+  gem.add_development_dependency "climate_control"
 end

kitchen-ec2.gemspec

@@ -0,0 +1,102 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Tyler Ball (<[email protected]>)
+#
+# Copyright (C) 2015, Fletcher Nichol
+#
+# 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 EC2 client connection
+      #
+      # @author Tyler Ball <[email protected]>
+      class Client
+
+        def initialize(region, profile_name = nil, access_key_id = nil, secret_access_key = nil)
+          creds = self.class.get_credentials(profile_name, access_key_id, secret_access_key)
+          Aws.config = {
+            :region => region,
+            :credentials => creds
+          }
+        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)
+          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)
+          # 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
+        # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+        def create_instance(options)
+          resource.create_instances(options)[0]
+        end
+
+        def get_instance(id)
+          resource.instance(id)
+        end
+
+        def get_instance_from_spot_request(request_id)
+          resource.instances(
+            :filters => [{
+              :name => "spot-instance-request-id",
+              :values => [request_id]
+            }]
+          ).to_a[0]
+        end
+
+        def client
+          @client ||= Aws::EC2::Client.new
+        end
+
+        def resource
+          @resource ||= Aws::EC2::Resource.new
+        end
+
+      end
+
+    end
+
+  end
+
+end