kitchen-rackspace 0.1.0 → 0.2.0

data/.gitignore

@@ -16,3 +16,5 @@ test/tmp
 test/version_tmp
 tmp
 .kitchen
+*.sw?
+*~

data/.travis.yml

@@ -4,7 +4,6 @@ gemfile:
   - Gemfile
 
 rvm:
-  - 1.8.7
   - 1.9.2
   - 1.9.3
   - 2.0.0

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# 0.2.0 / 2013-05-11
+
+### New Features
+
+* PR [#8][] - Support `rackspace_region:` option; at request of [@claco][]
+
+### Improvements
+
+* PR [#7][] - Clean up/refactor to pass style checks
+* PR [#9][] - Add some (probably overkill) RSpec tests
+
+# 0.1.0 / 2013-03-12
+
+* Initial release! Woo!
+
+[#9]: https://github.com/RoboticCheese/kitchen-rackspace/pull/9
+[#8]: https://github.com/RoboticCheese/kitchen-rackspace/pull/8
+[#7]: https://github.com/RoboticCheese/kitchen-rackspace/pull/7
+
+[@claco]: https://github.com/claco

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.org/RoboticCheese/kitchen-rackspace.png?branch=master)](https://travis-ci.org/RoboticCheese/kitchen-rackspace) [![Code Climate](https://codeclimate.com/github/RoboticCheese/kitchen-rackspace.png)](https://codeclimate.com/github/RoboticCheese/kitchen-rackspace)
+
 # Kitchen::Rackspace
 
 A Rackspace Cloud Servers driver for Test Kitchen 1.0!
@@ -29,13 +31,14 @@ Provide, at a minimum, the required driver options in your `.kitchen.yml` file:
       rackspace_api_key: [YOUR RACKSPACE CLOUD API KEY]
       require_chef_omnibus: latest (if you'll be using Chef)
 
-By default, the driver will spawn a 512MB Ubuntu 12.10 instance.
-Additional, optional settings can be provided:
+By default, the driver will spawn a 512MB Ubuntu 12.10 instance in your default
+Rackspace region. Additional, optional settings can be provided:
 
     image_id: [SERVER IMAGE ID]
     flavor_id: [SERVER FLAVOR ID]
     name: [A UNIQUE SERVER NAME]
     public_key_path: [PATH TO YOUR PUBLIC SSH KEY]
+    rackspace_region: [A VALID RACKSPACE DC/REGION]
 
 ## Contributing
 

data/Rakefile

@@ -1,12 +1,15 @@
 require 'bundler/gem_tasks'
 require 'tailor/rake_task'
 require 'cane/rake_task'
+require 'rspec/core/rake_task'
 
 desc 'Run Cane to check quality metrics'
 Cane::RakeTask.new
 
 desc 'Run Tailor to lint check code'
-Tailor::RakeTask.new
+Tailor::RakeTask.new do |task|
+  task.file_set '**/**/*.rb'
+end
 
 desc 'Display LOC stats'
 task :loc do
@@ -14,6 +17,9 @@ task :loc do
   sh 'countloc -r lib/kitchen'
 end
 
-task :default => [ :cane, :tailor, :loc ]
+desc 'Run RSpec unit tests'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => [ :cane, :tailor, :loc, :spec ]
 
 # vim: ai et ts=2 sts=2 sw=2 ft=ruby fdm=marker

data/kitchen-rackspace.gemspec

@@ -19,13 +19,14 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'test-kitchen', '~> 1.0.0.alpha'
-  spec.add_dependency 'fog'
+  spec.add_dependency 'fog', '~> 1.11'
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'tailor'
   spec.add_development_dependency 'cane'
   spec.add_development_dependency 'countloc'
+  spec.add_development_dependency 'rspec'
 end
 
 # vim: ai et ts=2 sts=2 sw=2 ft=ruby

data/lib/kitchen/driver/rackspace.rb

@@ -28,20 +28,17 @@ module Kitchen
     #
     # @author Jonathan Hartman <j@p4nt5.com>
     class Rackspace < Kitchen::Driver::SSHBase
-      default_config :version,          'v2'
-      default_config :image_id,         '8a3a9f96-b997-46fd-b7a8-a9e740796ffd'
-      default_config :flavor_id,        '2'
-      default_config :name,             nil
-      default_config :public_key_path,  File.expand_path('~/.ssh/id_dsa.pub')
-      default_config :username,         'root'
-      default_config :port,             '22'
+      default_config :version, 'v2'
+      default_config :image_id, '8a3a9f96-b997-46fd-b7a8-a9e740796ffd'
+      default_config :flavor_id, '2'
+      default_config :name, nil
+      default_config :public_key_path, File.expand_path('~/.ssh/id_dsa.pub')
+      default_config :username, 'root'
+      default_config :port, '22'
+      default_config :rackspace_region, nil
 
       def create(state)
-        if not config[:name]
-          # Generate what should be a unique server name
-          config[:name] = "#{instance.name}-#{Etc.getlogin}-" +
-            "#{Socket.gethostname}-#{Array.new(8){rand(36).to_s(36)}.join}"
-        end
+        config[:name] ||= generate_name(instance.name)
         server = create_server
         state[:server_id] = server.id
         info("Rackspace instance <#{state[:server_id]}> created.")
@@ -65,12 +62,16 @@ module Kitchen
       private
 
       def compute
-        Fog::Compute.new(
+        server_def = {
           :provider           => "Rackspace",
           :version            => config[:version],
           :rackspace_username => config[:rackspace_username],
           :rackspace_api_key  => config[:rackspace_api_key]
-        )
+        }
+        if config[:rackspace_region]
+          server_def[:rackspace_region] = config[:rackspace_region]
+        end
+        Fog::Compute.new(server_def)
       end
 
       def create_server
@@ -81,6 +82,12 @@ module Kitchen
           :public_key_path  => config[:public_key_path]
         )
       end
+
+      def generate_name(base)
+        # Generate what should be a unique server name
+        rand_str = Array.new(8) { rand(36).to_s(36) }.join
+        "#{base}-#{Etc.getlogin}-#{Socket.gethostname}-#{rand_str}"
+      end
     end
   end
 end

data/lib/kitchen/driver/rackspace_version.rb

@@ -19,7 +19,7 @@
 module Kitchen
   module Driver
     # Version string for Rackspace Kitchen driver
-    RACKSPACE_VERSION = '0.1.0'
+    RACKSPACE_VERSION = '0.2.0'
   end
 end
 

data/spec/kitchen/driver/rackspace_spec.rb

@@ -0,0 +1,265 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Jonathan Hartman (<j@p4nt5.com>)
+#
+# Copyright (C) 2013, Jonathan Hartman
+#
+# 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 'logger'
+require 'stringio'
+require 'rspec'
+require 'kitchen'
+require_relative '../../spec_helper'
+
+describe Kitchen::Driver::Rackspace do
+  let(:logged_output) { StringIO.new }
+  let(:logger) { Logger.new(logged_output) }
+  let(:config) { Hash.new }
+  let(:state) { Hash.new }
+
+  let(:instance) do
+    stub(:name => 'potatoes', :logger => logger, :to_str => 'instance')
+  end
+
+  let(:driver) do
+    d = Kitchen::Driver::Rackspace.new(config)
+    d.instance = instance
+    d
+  end
+
+  describe '#initialize'do
+    context 'default options' do
+      it 'defaults to v2 cloud' do
+        expect(driver[:version]).to eq('v2')
+      end
+
+      it 'defaults to a Ubuntu 12.10 image ID' do
+        expect(driver[:image_id]).to eq('8a3a9f96-b997-46fd-b7a8-a9e740796ffd')
+      end
+
+      it 'defaults to the smallest flavor size' do
+        expect(driver[:flavor_id]).to eq('2')
+      end
+
+      it 'defaults to local user\'s SSH public key' do
+        expect(driver[:public_key_path]).to eq(File.expand_path(
+          '~/.ssh/id_dsa.pub'))
+      end
+
+      it 'defaults to SSH with root user on port 22' do
+        expect(driver[:username]).to eq('root')
+        expect(driver[:port]).to eq('22')
+      end
+
+      it 'defaults to no server name' do
+        expect(driver[:name]).to eq(nil)
+      end
+
+      it 'defaults to no region' do
+        expect(driver[:rackspace_region]).to eq(nil)
+      end
+    end
+
+    context 'overridden options' do
+      let(:config) do
+        {
+          :image_id => '22',
+          :flavor_id => '33',
+          :public_key_path => '/tmp',
+          :username => 'admin',
+          :port => '2222',
+          :name => 'puppy',
+          :rackspace_region => 'ord'
+        }
+      end
+
+      it 'uses all the overridden options' do
+        drv = driver
+        config.each do |k, v|
+          expect(drv[k]).to eq(v)
+        end
+      end
+    end
+  end
+
+  describe '#create' do
+    let(:server) do
+      stub(:id => 'test123', :wait_for => true,
+        :public_ip_address => '1.2.3.4')
+    end
+    let(:driver) do
+      d = Kitchen::Driver::Rackspace.new(config)
+      d.instance = instance
+      d.stub(:generate_name).with('potatoes').and_return('a_monkey!')
+      d.stub(:create_server).and_return(server)
+      d.stub(:wait_for_sshd).with('1.2.3.4').and_return(true)
+      d
+    end
+
+    context 'username and API key only provided' do
+      let(:config) do
+        {
+          :rackspace_username => 'hello',
+          :rackspace_api_key => 'world'
+        }
+      end
+
+      it 'generates a server name in the absence of one' do
+        driver.create(state)
+        expect(driver[:name]).to eq('a_monkey!')
+      end
+
+      it 'gets a proper server ID' do
+        driver.create(state)
+        expect(state[:server_id]).to eq('test123')
+      end
+
+      it 'gets a proper hostname (IP)' do
+        driver.create(state)
+        expect(state[:hostname]).to eq('1.2.3.4')
+      end
+    end
+  end
+
+  describe '#destroy' do
+    let(:server_id) { '12345' }
+    let(:hostname) { 'example.com' }
+    let(:state) { { :server_id => server_id, :hostname => hostname } }
+    let(:server) { stub(:nil? => false, :destroy => true) }
+    let(:servers) { stub(:get => server) }
+    let(:compute) { stub(:servers => servers) }
+
+    let(:driver) do
+      d = Kitchen::Driver::Rackspace.new(config)
+      d.instance = instance
+      d.stub(:compute).and_return(compute)
+      d
+    end
+
+    context 'a live server that needs to be destroyed' do
+      it 'destroys the server' do
+        state.should_receive(:delete).with(:server_id)
+        state.should_receive(:delete).with(:hostname)
+        driver.destroy(state)
+      end
+    end
+
+    context 'no server ID present' do
+      let(:state) { Hash.new }
+
+      it 'does nothing' do
+        driver.stub(:compute)
+        driver.should_not_receive(:compute)
+        state.should_not_receive(:delete)
+        driver.destroy(state)
+      end
+    end
+
+    context 'a server that was already destroyed' do
+      let(:servers) do
+        s = double('servers')
+        s.stub(:get).with('12345').and_return(nil)
+        s
+      end
+      let(:compute) { stub(:servers => servers) }
+      let(:driver) do
+        d = Kitchen::Driver::Rackspace.new(config)
+        d.instance = instance
+        d.stub(:compute).and_return(compute)
+        d
+      end
+
+      it 'does not try to destroy the server again' do
+        allow_message_expectations_on_nil
+        driver.destroy(state)
+      end
+    end
+  end
+
+  describe '#compute' do
+    let(:config) do
+      {
+        :rackspace_username => 'monkey',
+        :rackspace_api_key => 'potato',
+        :rackspace_region => 'ord'
+      }
+    end
+
+    context 'all requirements provided' do
+      it 'creates a new compute connection' do
+        Fog::Compute.stub(:new) { |arg| arg }
+        res = config.merge({ :provider => 'Rackspace', :version => 'v2' })
+        expect(driver.send(:compute)).to eq(res)
+      end
+    end
+
+    context 'no username provided' do
+      let(:config) { { :rackspace_api_key => '1234' } }
+
+      it 'raises an error' do
+        expect { driver.send(:compute) }.to raise_error(ArgumentError)
+      end
+    end
+
+    context 'no API key provided' do
+      let(:config) { { :rackspace_username => 'monkey' } }
+
+      it 'raises an error' do
+        expect { driver.send(:compute) }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe '#create_server' do
+    let(:config) do
+      {
+        :name => 'hello',
+        :image_id => 'there',
+        :flavor_id => 'captain',
+        :public_key_path => 'tarpals'
+      }
+    end
+    before(:each) { @config = config.dup }
+    let(:servers) do
+      s = double('servers')
+      s.stub(:bootstrap) { |arg| arg }
+      s
+    end
+    let(:compute) { stub(:servers => servers) }
+    let(:driver) do
+      d = Kitchen::Driver::Rackspace.new(config)
+      d.instance = instance
+      d.stub(:compute).and_return(compute)
+      d
+    end
+
+    it 'creates the server using a compute connection' do
+      expect(driver.send(:create_server)).to eq(@config)
+    end
+  end
+
+  describe '#generate_name' do
+    before(:each) do
+      Etc.stub(:getlogin).and_return('user')
+      Socket.stub(:gethostname).and_return('host')
+    end
+
+    it 'generates a name' do
+      expect(driver.send(:generate_name, 'monkey')).to match(
+        /^monkey-user-host-/)
+    end
+  end
+end
+
+# vim: ai et ts=2 sts=2 sw=2 ft=ruby

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Jonathan Hartman (<j@p4nt5.com>)
+#
+# Copyright (C) 2013, Jonathan Hartman
+#
+# 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 'rspec'
+require_relative '../lib/kitchen/driver/rackspace'
+
+# vim: ai et ts=2 sts=2 sw=2 ft=ruby

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-rackspace
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-12 00:00:00.000000000 Z
+date: 2013-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-kitchen
@@ -32,33 +32,33 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -123,6 +123,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A Test Kitchen Rackspace driver
 email:
 - j@p4nt5.com
@@ -132,6 +148,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -139,6 +156,8 @@ files:
 - kitchen-rackspace.gemspec
 - lib/kitchen/driver/rackspace.rb
 - lib/kitchen/driver/rackspace_version.rb
+- spec/kitchen/driver/rackspace_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/RoboticCheese/kitchen-rackspace
 licenses:
 - Apache
@@ -164,5 +183,6 @@ rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A Test Kitchen Rackspace driver
-test_files: []
-has_rdoc: 
+test_files:
+- spec/kitchen/driver/rackspace_spec.rb
+- spec/spec_helper.rb