kitchen-ec2 0.4.0 → 0.5.0

data/.tailor

@@ -0,0 +1,106 @@
+#------------------------------------------------------------------------------
+# Horizontal Whitespace
+#------------------------------------------------------------------------------
+# allow_hard_tabs         True to let hard tabs be considered a single space.
+#                         Default:      false
+#
+# allow_trailing_line_spaces
+#                         True to skip detecting extra spaces at the ends of
+#                         lines.
+#                         Default:      false
+#
+# indentation_spaces      The number of spaces to consider a proper indent.
+#                         Default:      2
+#
+# max_line_length         The maximum number of characters in a line before
+#                         tailor complains.
+#                         Default:      80
+# spaces_after_comma      Number of spaces to expect after a comma.
+#                         Default:      1
+#
+# spaces_before_comma     Number of spaces to expect before a comma.
+#                         Default:      0
+#
+# spaces_after_lbrace     The number of spaces to expect after an lbrace ('{').
+#                         Default:      1
+#
+# spaces_before_lbrace    The number of spaces to expect before an lbrace ('{').
+#                         Default:      1
+#
+# spaces_before_rbrace    The number of spaces to expect before an rbrace ('}').
+#                         Default:      1
+#
+# spaces_in_empty_braces  The number of spaces to expect between braces when
+#                         there's nothing in the braces (i.e. {}).
+#                         Default:      0
+#
+# spaces_after_lbracket   The number of spaces to expect after an
+#                         lbracket ('[').
+#                         Default:      0
+#
+# spaces_before_rbracket  The number of spaces to expect before an
+#                         rbracket (']').
+#                         Default:      0
+#
+# spaces_after_lparen     The number of spaces to expect after an
+#                         lparen ('(').
+#                         Default:      0
+#
+# spaces_before_rparen    The number of spaces to expect before an
+#                         rbracket (')').
+#                         Default:      0
+#
+#------------------------------------------------------------------------------
+# Naming
+#------------------------------------------------------------------------------
+# allow_camel_case_methods
+#                         Setting to true skips detection of camel-case method
+#                         names (i.e. def myMethod).
+#                         Default:      false
+#
+# allow_screaming_snake_case_classes
+#                         Setting to true skips detection of screaming
+#                         snake-case class names (i.e. My_Class).
+#                         Default:      false
+#
+#------------------------------------------------------------------------------
+# Vertical Whitespace
+#------------------------------------------------------------------------------
+# max_code_lines_in_class The number of lines of code in a class to allow before
+#                         tailor will warn you.
+#                         Default:      300
+#
+# max_code_lines_in_method
+#                         The number of lines of code in a method to allow
+#                         before tailor will warn you.
+#                         Default:      30
+#
+# trailing_newlines       The number of newlines that should be at the end of
+#                         the file.
+#                         Default:      1
+#
+Tailor.config do |config|
+  config.formatters "text"
+  config.file_set 'lib/**/*.rb' do |style|
+    style.allow_camel_case_methods false, level: :error
+    style.allow_hard_tabs false, level: :error
+    style.allow_screaming_snake_case_classes false, level: :error
+    style.allow_trailing_line_spaces false, level: :error
+    style.allow_invalid_ruby false, level: :warn
+    style.indentation_spaces 2, level: :error
+    style.max_code_lines_in_class 300, level: :error
+    style.max_code_lines_in_method 30, level: :error
+    style.max_line_length 80, level: :error
+    style.spaces_after_comma 1, level: :off
+    style.spaces_after_lbrace 1, level: :error
+    style.spaces_after_lbracket 0, level: :error
+    style.spaces_after_lparen 0, level: :error
+    style.spaces_before_comma 0, level: :error
+    style.spaces_before_lbrace 1, level: :off
+    style.spaces_before_rbrace 1, level: :error
+    style.spaces_before_rbracket 0, level: :error
+    style.spaces_before_rparen 0, level: :error
+    style.spaces_in_empty_braces 0, level: :error
+    style.trailing_newlines 1, level: :error
+  end
+end

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+## 0.5.0 / 2013-05-23
+
+### New features
+
+* Pull request [#5][]: Add the ability to give ec2 instances tags. ([@halcyonCorsair][])
+* Add required_config attributes for driver. ([@fnichol][])
+
+### Improvements
+
+* Write README. ([@fnichol][])
+* Pull request [#2][]: Extra EC2 server creation debugging. ([@mattray][])
+* Remove default_config :port in favor of SSHBase default (also 22). ([@fnichol][])
+
+<!--- The following link definition list is generated by PimpMyChangelog --->
+[#2]: https://github.com/opscode/kitchen-ec2/issues/2
+[#5]: https://github.com/opscode/kitchen-ec2/issues/5
+[@fnichol]: https://github.com/fnichol
+[@halcyonCorsair]: https://github.com/halcyonCorsair
+[@mattray]: https://github.com/mattray

data/README.md

@@ -1,29 +1,217 @@
-# Kitchen::Driver::Ec2
+# <a name="title"></a> Kitchen::Ec2: A Test Kitchen Driver for Amazon EC2
 
-TODO: Write a gem description
+[![Gem Version](https://badge.fury.io/rb/kitchen-ec2.png)](http://badge.fury.io/rb/kitchen-ec2)
+[![Build Status](https://travis-ci.org/opscode/kitchen-ec2.png)](https://travis-ci.org/opscode/kitchen-ec2)
+[![Code Climate](https://codeclimate.com/github/opscode/kitchen-ec2.png)](https://codeclimate.com/github/opscode/kitchen-ec2)
 
-## Installation
+A Test Kitchen Driver for Amazon EC2.
 
-Add this line to your application's Gemfile:
+This driver uses the [fog gem][fog_gem] to provision and destroy EC2
+instances. Use Amazon's cloud for your infrastructure testing!
 
-    gem 'kitchen-ec2'
+## <a name="requirements"></a> Requirements
 
-And then execute:
+There are **no** external system requirements for this driver. However you
+will need access to an [AWS][aws_site] account.
 
-    $ bundle
+## <a name="installation"></a> Installation and Setup
 
-Or install it yourself as:
+Please read the [Driver usage][driver_usage] page for more details.
 
-    $ gem install kitchen-ec2
+## <a name="config"></a> Configuration
 
-## Usage
+### <a name="config-az"></a> availability\_zone
 
-TODO: Write usage instructions here
+**Required** The AWS [availability zone][region_docs] to use.
 
-## Contributing
+The default is `"us-east-1b"`.
 
-1. Fork it
+### <a name="config-aws-access-key-id"></a> aws\_access\_key\_id
+
+**Required** The AWS [access key id][credentials_docs] to use.
+
+The default is unset, or `nil`.
+
+### <a name="config-aws-secret-access-key"></a> aws\_secret\_access\_key
+
+**Required** The AWS [secret access key][credentials_docs] to use.
+
+The default is unset, or `nil`.
+
+### <a name="config-aws-ssh-key-id"></a> aws\_ssh\_key\_id
+
+**Required** The EC2 [SSH key id][key_id_docs] to use.
+
+The default is unset, or `nil`.
+
+### <a name="config-flavor-id"></a> flavor\_id
+
+The EC2 [instance type][instance_docs] (also known as size) to use.
+
+The default is `"m1.small"`.
+
+### <a name="config-groups"></a> groups
+
+An Array of EC [security groups][group_docs] which will be applied to the
+instance.
+
+The default is `["default"]`.
+
+### <a name="config-image-id"></a> image\_id
+
+**Required** The EC2 [AMI id][ami_docs] to use.
+
+The default is unset, or `nil`.
+
+### <a name="config-port"></a> port
+
+The SSH port number to be used when communicating with the instance.
+
+The default is `22`.
+
+### <a name="config-region"></a> region
+
+**Required** The AWS [region][region_docs] to use.
+
+The default is `"us-east-1"`.
+
+### <a name="config-require-chef-omnibus"></a> require\_chef\_omnibus
+
+Determines whether or not a Chef [Omnibus package][chef_omnibus_dl] will be
+installed. There are several different behaviors available:
+
+* `true` - the latest release will be installed. Subsequent converges
+  will skip re-installing if chef is present.
+* `latest` - the latest release will be installed. Subsequent converges
+  will always re-install even if chef is present.
+* `<VERSION_STRING>` (ex: `10.24.0`) - the desired version string will
+  be passed the the install.sh script. Subsequent converges will skip if
+  the installed version and the desired version match.
+* `false` or `nil` - no chef is installed.
+
+The default value is unset, or `nil`.
+
+### <a name="config-ssh-key"></a> ssh\_key
+
+Path to the private SSH key used to connect to the instance.
+
+The default is unset, or `nil`.
+
+### <a name="config-sudo"></a> sudo
+
+Whether or not to prefix remote system commands such as installing and
+running Chef with `sudo`.
+
+The default is `true`.
+
+### <a name="config-tags"></a> tags
+
+The Hash of EC tag name/value pairs which will be applied to the instance.
+
+The default is `{ "created-by" => "test-kitchen" }`.
+
+### <a name="config-username"></a> username
+
+The SSH username that will be used to communicate with the instance.
+
+The default is `"root"`.
+
+## <a name="example"></a> Example
+
+The following could be used in a `.kitchen.yml` or in a `.kitchen.local.yml`
+to override default configuration.
+
+```yaml
+---
+driver_plugin: ec2
+driver_config:
+  aws_access_key_id: KAS...
+  aws_secret_access_key: 3UK...
+  aws_ssh_key_id: id_rsa-aws
+  ssh_key: /path/to/id_rsa-aws
+  region: us-east-1
+  availability_zone: us-east-1b
+  require_chef_omnibus: true
+
+platforms:
+- name: ubuntu-12.04
+  driver_config:
+    image_id: ami-fd20ad94
+    username: ubuntu
+- name: centos-6.3
+  driver_config:
+    image_id: ami-ef5ff086
+    username: ec2-user
+
+suites:
+# ...
+```
+
+Both `.kitchen.yml` and `.kitchen.local.yml` files are pre-processed through
+ERB which can help to factor out secrets and credentials. For example:
+
+```yaml
+---
+driver_plugin: ec2
+driver_config:
+  aws_access_key_id: <%= ENV['AWS_ACCESS_KEY_ID'] %>
+  aws_secret_access_key: <%= ENV['AWS_SECRET_ACCESS_KEY'] %>
+  aws_ssh_key_id: <%= ENV['AWS_SSH_KEY_ID'] %>
+  ssh_key: <%= File.expand_path('~/.ssh/id_rsa') %>
+  region: us-east-1
+  availability_zone: us-east-1b
+  require_chef_omnibus: true
+
+platforms:
+- name: ubuntu-12.04
+  driver_config:
+    image_id: ami-fd20ad94
+    username: ubuntu
+- name: centos-6.3
+  driver_config:
+    image_id: ami-ef5ff086
+    username: ec2-user
+
+suites:
+# ...
+```
+
+## <a name="development"></a> Development
+
+* Source hosted at [GitHub][repo]
+* Report issues/questions/feature requests on [GitHub Issues][issues]
+
+Pull requests are very welcome! Make sure your patches are well tested.
+Ideally create a topic branch for every separate change you make. For
+example:
+
+1. Fork the repo
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## <a name="authors"></a> Authors
+
+Created and maintained by [Fletcher Nichol][author] (<fnichol@nichol.ca>)
+
+## <a name="license"></a> License
+
+Apache 2.0 (see [LICENSE][license])
+
+
+[author]:           https://github.com/fnichol
+[issues]:           https://github.com/opscode/kitchen-ec2/issues
+[license]:          https://github.com/opscode/kitchen-ec2/blob/master/LICENSE
+[repo]:             https://github.com/opscode/kitchen-ec2
+[driver_usage]:     http://docs.kitchen-ci.org/drivers/usage
+[chef_omnibus_dl]:  http://www.opscode.com/chef/install/
+
+[ami_docs]:         http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html
+[aws_site]:         http://aws.amazon.com/
+[credentials_docs]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/SettingUp_CommandLine.html#using-credentials-access-key
+[fog_gem]:          http://fog.io/
+[group_docs]:       http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html
+[instance_docs]:    http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html
+[key_id_docs]:      http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/verifying-your-key-pair.html
+[region_docs]:      http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html

data/Rakefile

@@ -3,7 +3,9 @@ require 'cane/rake_task'
 require 'tailor/rake_task'
 
 desc "Run cane to check quality metrics"
-Cane::RakeTask.new
+Cane::RakeTask.new do |cane|
+  cane.canefile = './.cane'
+end
 
 Tailor::RakeTask.new
 
@@ -13,4 +15,7 @@ task :stats do
   sh "countloc -r lib/kitchen"
 end
 
-task :default => [ :cane, :tailor, :stats ]
+desc "Run all quality tasks"
+task :quality => [:cane, :tailor, :stats]
+
+task :default => [:quality]

data/kitchen-ec2.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency 'test-kitchen', '~> 1.0.0.alpha.0'
+  gem.add_dependency 'test-kitchen', '~> 1.0.0.alpha.7'
   gem.add_dependency 'fog'
 
   gem.add_development_dependency 'cane'

data/lib/kitchen/driver/ec2.rb

@@ -33,9 +33,14 @@ module Kitchen
       default_config :region,             'us-east-1'
       default_config :availability_zone,  'us-east-1b'
       default_config :flavor_id,          'm1.small'
-      default_config :groups,             [ 'default' ]
+      default_config :groups,             ['default']
+      default_config :tags,               { 'created-by' => 'test-kitchen' }
       default_config :username,           'root'
-      default_config :port,               '22'
+
+      required_config :aws_access_key_id
+      required_config :aws_secret_access_key
+      required_config :aws_ssh_key_id
+      required_config :image_id
 
       def create(state)
         server = create_server
@@ -45,6 +50,7 @@ module Kitchen
         server.wait_for { print "."; ready? } ; print "(server ready)"
         state[:hostname] = server.public_ip_address
         wait_for_sshd(state[:hostname])      ; print "(ssh ready)\n"
+        debug("ec2:create '#{state[:hostname]}'")
       rescue Fog::Errors::Error, Excon::Errors::Error => ex
         raise ActionFailed, ex.message
       end
@@ -71,14 +77,27 @@ module Kitchen
       end
 
       def create_server
+        debug_server_config
+
         connection.servers.create(
           :availability_zone  => config[:availability_zone],
           :groups             => config[:groups],
+          :tags               => config[:tags],
           :flavor_id          => config[:flavor_id],
           :image_id           => config[:image_id],
           :key_name           => config[:aws_ssh_key_id],
         )
       end
+
+      def debug_server_config
+        debug("ec2:region '#{config[:region]}'")
+        debug("ec2:availability_zone '#{config[:availability_zone]}'")
+        debug("ec2:flavor_id '#{config[:flavor_id]}'")
+        debug("ec2:image_id '#{config[:image_id]}'")
+        debug("ec2:groups '#{config[:groups]}'")
+        debug("ec2:tags '#{config[:tags]}'")
+        debug("ec2:key_name '#{config[:aws_ssh_key_id]}'")
+      end
     end
   end
 end

data/lib/kitchen/driver/ec2_version.rb

@@ -21,6 +21,6 @@ module Kitchen
   module Driver
 
     # Version string for EC2 Test Kitchen driver
-    EC2_VERSION = "0.4.0"
+    EC2_VERSION = "0.5.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-ec2
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-02 00:00:00.000000000 Z
+date: 2013-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-kitchen
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0.alpha.0
+        version: 1.0.0.alpha.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0.alpha.0
+        version: 1.0.0.alpha.7
 - !ruby/object:Gem::Dependency
   name: fog
   requirement: !ruby/object:Gem::Requirement
@@ -98,8 +98,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .cane
 - .gitignore
+- .tailor
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -121,7 +124,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4246554264751038241
+      hash: -927622726583194128
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -130,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4246554264751038241
+      hash: -927622726583194128
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24