kitchen-openstack 0.5.0 → 1.0.0

data/CHANGELOG.md

@@ -1,4 +1,20 @@
-# ?.?.? / ????-??-??
+# 1.0.0 / 2013-10-16
+
+### New Features
+
+* PR [#26][] - Support image and flavor names and regexes; via [@jgawor][]
+* PR [#25][] - Support specific floating IPs, in addition to named pools
+* PR [#14][] - Add support for floating IP pools; via [@hufman][]
+
+### Improvements
+
+* PR [#15][] - Improved SSH key support, support RSA and DSA; via [@hufman][]
+
+### Bug Fixes
+
+* PR [#27][] - Prevent IP contention in TK parallel mode; via [@jgawor][]
+
+# 0.5.0 / 2013-09-23
 
 ### Improvements
 
@@ -36,8 +52,13 @@
 
 * Initial release! Woo!
 
+[#27]: https://github.com/RoboticCheese/kitchen-openstack/pull/27
+[#26]: https://github.com/RoboticCheese/kitchen-openstack/pull/26
+[#25]: https://github.com/RoboticCheese/kitchen-openstack/pull/25
 [#20]: https://github.com/RoboticCheese/kitchen-openstack/pull/20
 [#19]: https://github.com/RoboticCheese/kitchen-openstack/pull/19
+[#15]: https://github.com/RoboticCheese/kitchen-openstack/pull/15
+[#14]: https://github.com/RoboticCheese/kitchen-openstack/pull/14
 [#12]: https://github.com/RoboticCheese/kitchen-openstack/pull/12
 [#11]: https://github.com/RoboticCheese/kitchen-openstack/pull/11
 [#10]: https://github.com/RoboticCheese/kitchen-openstack/pull/10
@@ -45,5 +66,7 @@
 [#7]: https://github.com/RoboticCheese/kitchen-openstack/pull/7
 [#2]: https://github.com/RoboticCheese/kitchen-openstack/pull/2
 
+[@jgawor]: https://github.com/jgawor
+[@hufman]: https://github.com/hufman
 [@saketoba]: https://github.com/saketoba
 [@stevendanna]: https://github.com/stevendanna

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/RoboticCheese/kitchen-openstack.png?branch=master)](https://travis-ci.org/RoboticCheese/kitchen-openstack) [![Code Climate](https://codeclimate.com/github/RoboticCheese/kitchen-openstack.png)](https://codeclimate.com/github/RoboticCheese/kitchen-openstack)
+[![Gem Version](https://badge.fury.io/rb/kitchen-openstack.png)](http://badge.fury.io/rb/kitchen-openstack) [![Dependency Status](https://gemnasium.com/RoboticCheese/kitchen-openstack.png)](https://gemnasium.com/RoboticCheese/kitchen-openstack) [![Build Status](https://travis-ci.org/RoboticCheese/kitchen-openstack.png?branch=master)](https://travis-ci.org/RoboticCheese/kitchen-openstack) [![Code Climate](https://codeclimate.com/github/RoboticCheese/kitchen-openstack.png)](https://codeclimate.com/github/RoboticCheese/kitchen-openstack)
 
 # Kitchen::OpenStack
 
@@ -34,12 +34,15 @@ Provide, at a minimum, the required driver options in your `.kitchen.yml` file:
       image_ref: [SERVER IMAGE ID]
       flavor_ref: [SERVER FLAVOR ID]
 
+The `image_ref` and `flavor_ref` options can be specified as an exact id,
+an exact name, or as a regular expression matching the name of the image or flavor.
+
 By default, a unique server name will be generated and the current user's SSH
-key will be used, though that behavior can be overridden with additional
-options:
+key will be used (with an RSA key taking precedence over a DSA), though that
+behavior can be overridden with additional options:
 
     name: [A UNIQUE SERVER NAME]
-    ssh_key: [PATH TO YOUR PRIVATE SSH KEY]
+    private_key_path: [PATH TO YOUR PRIVATE SSH KEY]
     public_key_path: [PATH TO YOUR SSH PUBLIC KEY]
     username: [SSH USER]
     port: [SSH PORT]
@@ -48,9 +51,15 @@ options:
     openstack_region: [A VALID OPENSTACK REGION]
     openstack_service_name: [YOUR OPENSTACK COMPUTE SERVICE NAME]
     openstack_network_name: [YOUR OPENSTACK NETWORK NAME]
+    floating_ip: [A SPECIFIC FLOATING IP TO ASSIGN]
+    floating_ip_pool: [AN OPENSTACK POOL NAME TO ASSIGN THE NEXT IP FROM]
+
+If a `key_name` is provided it will be used instead of any
+`public_key_path` that is specified.
 
-If a key\_name is provided it will be used instead of any
-public\_key\_path that is specified.
+If a `key_name` is provided without any `private_key_path`, unexpected
+behavior may result if your local RSA/DSA private key doesn't match that
+OpenStack key.
 
     disable_ssl_validation: true
 

data/Rakefile

@@ -8,7 +8,7 @@ Cane::RakeTask.new
 
 desc 'Run Tailor to lint check code'
 Tailor::RakeTask.new do |task|
-  task.file_set '**/**/*.rb'
+  task.file_set '**/*.rb'
 end
 
 desc 'Display LOC stats'

data/lib/kitchen/driver/openstack.rb

@@ -29,8 +29,19 @@ module Kitchen
     #
     # @author Jonathan Hartman <j@p4nt5.com>
     class Openstack < Kitchen::Driver::SSHBase
+      @@ip_pool_lock = Mutex.new
+
       default_config :name, nil
-      default_config :public_key_path, File.expand_path('~/.ssh/id_dsa.pub')
+      default_config :key_name, nil
+      default_config :private_key_path do |driver|
+        %w{id_rsa id_dsa}.collect do |k|
+          f = File.expand_path "~/.ssh/#{k}"
+          f if File.exists? f
+        end.compact.first
+      end
+      default_config :public_key_path do |driver|
+        driver[:private_key_path] + '.pub'
+      end
       default_config :username, 'root'
       default_config :port, '22'
       default_config :use_ipv6, false
@@ -38,6 +49,8 @@ module Kitchen
       default_config :openstack_region, nil
       default_config :openstack_service_name, nil
       default_config :openstack_network_name, nil
+      default_config :floating_ip_pool, nil
+      default_config :floating_ip, nil
 
       def create(state)
         config[:name] ||= generate_name(instance.name)
@@ -45,10 +58,21 @@ module Kitchen
         server = create_server
         state[:server_id] = server.id
         info "OpenStack instance <#{state[:server_id]}> created."
-        server.wait_for { print '.'; ready? } ; puts "\n(server ready)"
+        server.wait_for { print '.'; ready? } ; info "\n(server ready)"
+        if config[:floating_ip_pool]
+          attach_ip_from_pool(server, config[:floating_ip_pool])
+        elsif config[:floating_ip]
+          attach_ip(server, config[:floating_ip])
+        end
         state[:hostname] = get_ip(server)
-        wait_for_sshd(state[:hostname]) ; puts '(ssh ready)'
-        unless config[:ssh_key] or config[:key_name]
+        state[:ssh_key] = config[:private_key_path]
+        wait_for_sshd(state[:hostname]) ; info '(ssh ready)'
+        if config[:key_name]
+          info "Using OpenStack keypair <#{config[:key_name]}>"
+        end
+        info "Using public SSH key <#{config[:public_key_path]}>"
+        info "Using private SSH key <#{config[:private_key_path]}>"
+        unless config[:key_name]
           do_ssh_setup(state, config, server)
         end
       rescue Fog::Errors::Error, Excon::Errors::Error => ex
@@ -85,10 +109,18 @@ module Kitchen
       end
 
       def create_server
+        image = find_matching(compute.images, config[:image_ref])
+        raise ActionFailed, "Image not found" if !image
+        debug "Selected image: #{image.id} #{image.name}"
+
+        flavor = find_matching(compute.flavors, config[:flavor_ref])
+        raise ActionFailed, "Flavor not found" if !flavor
+        debug "Selected flavor: #{flavor.id} #{flavor.name}"
+
         server_def = {
           :name => config[:name],
-          :image_ref => config[:image_ref],
-          :flavor_ref => config[:flavor_ref]
+          :image_ref => image.id,
+          :flavor_ref => flavor.id
         }
         if config[:public_key_path]
           server_def[:public_key_path] = config[:public_key_path]
@@ -121,6 +153,25 @@ module Kitchen
         pieces.join sep
       end
 
+      def attach_ip_from_pool(server, pool)
+        @@ip_pool_lock.synchronize do
+          info "Attaching floating IP from <#{pool}> pool"
+          free_addrs = compute.addresses.collect do |i|
+            i.ip if i.fixed_ip.nil? and i.instance_id.nil? and i.pool == pool
+          end.compact
+          if free_addrs.empty?
+            raise ActionFailed, "No available IPs in pool <#{pool}>"
+          end
+          attach_ip(server, free_addrs[0])
+        end
+      end
+
+      def attach_ip(server, ip)
+        info "Attaching floating IP <#{ip}>"
+        server.associate_address ip
+        (server.addresses['public'] ||= []) << { 'version' => 4, 'addr' => ip }
+      end
+
       def get_ip(server)
         if config[:openstack_network_name]
           debug "Using configured network: #{config[:openstack_network_name]}"
@@ -149,6 +200,7 @@ module Kitchen
       end
 
       def do_ssh_setup(state, config, server)
+        info "Setting up SSH access for key <#{config[:public_key_path]}>"
         ssh = Fog::SSH.new(state[:hostname], config[:username],
           { :password => server.password })
         pub_key = open(config[:public_key_path]).read
@@ -163,6 +215,28 @@ module Kitchen
         require 'excon'
         Excon.defaults[:ssl_verify_peer] = false
       end
+
+      def find_matching(collection, name)
+        name = name.to_s
+        if name.start_with?('/')
+          regex = eval(name)
+          # check for regex name match
+          collection.each do |single|
+            return single if regex =~ single.name
+          end
+        else
+          # check for exact id match
+          collection.each do |single|
+            return single if single.id == name
+          end
+          # check for exact name match
+          collection.each do |single|
+            return single if single.name == name
+          end
+        end
+        nil
+      end
+
     end
   end
 end

data/lib/kitchen/driver/openstack_version.rb

@@ -19,7 +19,7 @@
 module Kitchen
   module Driver
     # Version string for OpenStack Kitchen driver
-    OPENSTACK_VERSION = '0.5.0'
+    OPENSTACK_VERSION = '1.0.0'
   end
 end
 

data/spec/kitchen/driver/openstack_spec.rb

@@ -27,6 +27,8 @@ describe Kitchen::Driver::Openstack do
   let(:logger) { Logger.new(logged_output) }
   let(:config) { Hash.new }
   let(:state) { Hash.new }
+  let(:dsa) { File.expand_path('~/.ssh/id_dsa') }
+  let(:rsa) { File.expand_path('~/.ssh/id_rsa') }
 
   let(:instance) do
     double(:name => 'potatoes', :logger => logger, :to_str => 'instance')
@@ -38,32 +40,73 @@ describe Kitchen::Driver::Openstack do
     d
   end
 
+  before(:each) do
+    File.stub(:exists?).and_call_original
+    File.stub(:exists?).with(dsa).and_return(true)
+    File.stub(:exists?).with(rsa).and_return(true)
+  end
+
   describe '#initialize'do
     context 'default options' do
-      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
+      context 'both DSA and RSA SSH keys available for the user' do
+        it 'prefers the local user\'s RSA private key' do
+          expect(driver[:private_key_path]).to eq(rsa)
+        end
 
-      it 'defaults to SSH with root user on port 22' do
-        expect(driver[:username]).to eq('root')
-        expect(driver[:port]).to eq('22')
+        it 'prefers the local user\'s RSA public key' do
+          expect(driver[:public_key_path]).to eq(rsa + '.pub')
+        end
       end
 
-      it 'defaults to no server name' do
-        expect(driver[:name]).to eq(nil)
+      context 'only a DSA SSH key available for the user' do
+        before(:each) do
+          File.unstub(:exists?)
+          File.stub(:exists?).and_return(false)
+          File.stub(:exists?).with(dsa).and_return(true)
+        end
+
+        it 'uses the local user\'s DSA private key' do
+          expect(driver[:private_key_path]).to eq(dsa)
+        end
+
+        it 'uses the local user\'s DSA public key' do
+          expect(driver[:public_key_path]).to eq(dsa + '.pub')
+        end
       end
 
-      it 'defaults to no tenant' do
-        expect(driver[:openstack_tenant]).to eq(nil)
+      context 'only a RSA SSH key available for the user' do
+        before(:each) do
+          File.unstub(:exists?)
+          File.stub(:exists?).and_return(false)
+          File.stub(:exists?).with(rsa).and_return(true)
+        end
+
+        it 'uses the local user\'s RSA private key' do
+          expect(driver[:private_key_path]).to eq(rsa)
+        end
+
+        it 'uses the local user\'s RSA public key' do
+          expect(driver[:public_key_path]).to eq(rsa + '.pub')
+        end
       end
 
-      it 'defaults to no region' do
-        expect(driver[:openstack_region]).to eq(nil)
+      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 service name' do
-        expect(driver[:openstack_service_name]).to eq(nil)
+      nils = [
+        :name,
+        :openstack_tenant,
+        :openstack_region,
+        :openstack_service_name,
+        :floating_ip_pool,
+        :floating_ip
+      ]
+      nils.each do |i|
+        it "defaults to no #{i}" do
+          expect(driver[i]).to eq(nil)
+        end
       end
     end
 
@@ -79,7 +122,9 @@ describe Kitchen::Driver::Openstack do
           :openstack_tenant => 'that_one',
           :openstack_region => 'atlantis',
           :openstack_service_name => 'the_service',
-          :ssh_key => '/path/to/id_rsa'
+          :private_key_path => '/path/to/id_rsa',
+          :floating_ip_pool => 'swimmers',
+          :floating_ip => '11111'
         }
       end
 
@@ -89,10 +134,6 @@ describe Kitchen::Driver::Openstack do
           expect(drv[k]).to eq(v)
         end
       end
-
-      it 'SSH with user-specified private key' do
-        expect(driver[:ssh_key]).to eq('/path/to/id_rsa')
-      end
     end
   end
 
@@ -263,8 +304,8 @@ describe Kitchen::Driver::Openstack do
     let(:config) do
       {
         :name => 'hello',
-        :image_ref => 'there',
-        :flavor_ref => 'captain',
+        :image_ref => '111',
+        :flavor_ref => '1',
         :public_key_path => 'tarpals'
       }
     end
@@ -273,7 +314,14 @@ describe Kitchen::Driver::Openstack do
       s.stub(:create) { |arg| arg }
       s
     end
-    let(:compute) { double(:servers => servers) }
+    let(:ubuntu_image) { double(:id => '111', :name => 'ubuntu') }
+    let(:fedora_image) { double(:id => '222', :name => 'fedora') }
+    let(:tiny_flavor) { double(:id => '1', :name => 'tiny') }
+    let(:small_flavor) { double(:id => '2', :name => 'small') }
+    let(:compute) do
+      double(:servers => servers, :images => [ubuntu_image, fedora_image],
+        :flavors => [tiny_flavor, small_flavor])
+    end
     let(:driver) do
       d = Kitchen::Driver::Openstack.new(config)
       d.instance = instance
@@ -293,8 +341,8 @@ describe Kitchen::Driver::Openstack do
       let(:config) do
         {
           :name => 'hello',
-          :image_ref => 'there',
-          :flavor_ref => 'captain',
+          :image_ref => '111',
+          :flavor_ref => '1',
           :public_key_path => 'tarpals'
         }
       end
@@ -309,8 +357,8 @@ describe Kitchen::Driver::Openstack do
       let(:config) do
         {
           :name => 'hello',
-          :image_ref => 'there',
-          :flavor_ref => 'captain',
+          :image_ref => '111',
+          :flavor_ref => '1',
           :public_key_path => 'montgomery',
           :key_name => 'tarpals'
         }
@@ -321,6 +369,61 @@ describe Kitchen::Driver::Openstack do
         expect(driver.send(:create_server)).to eq(@config)
       end
     end
+
+    context 'image/flavor specifies id' do
+      let(:config) do
+        {
+          :name => 'hello',
+          :image_ref => '111',
+          :flavor_ref => '1',
+          :public_key_path => 'tarpals'
+        }
+      end
+
+      it 'exact id match' do
+        servers.should_receive(:create).with(:name => 'hello',
+          :image_ref => '111', :flavor_ref => '1',
+          :public_key_path => 'tarpals')
+        driver.send(:create_server)
+      end
+    end
+
+    context 'image/flavor specifies name' do
+      let(:config) do
+        {
+          :name => 'hello',
+          :image_ref => 'fedora',
+          :flavor_ref => 'small',
+          :public_key_path => 'tarpals'
+        }
+      end
+
+      it 'exact name match' do
+        servers.should_receive(:create).with(:name => 'hello',
+          :image_ref => '222', :flavor_ref => '2',
+          :public_key_path => 'tarpals')
+        driver.send(:create_server)
+      end
+    end
+
+    context 'image/flavor specifies regex' do
+      let(:config) do
+        {
+          :name => 'hello',
+          # pass regex as string as yml returns string values
+          :image_ref => '/edo/',
+          :flavor_ref => '/in/',
+          :public_key_path => 'tarpals'
+        }
+      end
+
+      it 'regex name match' do
+        servers.should_receive(:create).with(:name => 'hello',
+          :image_ref => '222', :flavor_ref => '1',
+          :public_key_path => 'tarpals')
+        driver.send(:create_server)
+      end
+    end
   end
 
   describe '#generate_name' do
@@ -346,6 +449,50 @@ describe Kitchen::Driver::Openstack do
     end
   end
 
+  describe '#attach_ip_from_pool' do
+    let(:server) { nil }
+    let(:pool) { 'swimmers' }
+    let(:ip) { '1.1.1.1' }
+    let(:address) { double(:ip => ip, :fixed_ip => nil, :instance_id => nil,
+      :pool => pool) }
+    let(:compute) { double(:addresses => [address]) }
+
+    before(:each) do
+      driver.stub(:attach_ip).with(server, ip).and_return('bing!')
+      driver.stub(:compute).and_return(compute)
+    end
+
+    it 'determines an IP to attempt to attach' do
+      expect(driver.send(:attach_ip_from_pool, server, pool)).to eq('bing!')
+    end
+
+    context 'no free addresses in the specified pool' do
+      let(:address) { double(:ip => ip, :fixed_ip => nil, :instance_id => nil,
+        :pool => 'some_other_pool') }
+
+      it 'raises an exception' do
+        expect { driver.send(:attach_ip_from_pool, server, pool) }.to \
+          raise_error
+      end
+    end
+  end
+
+  describe '#attach_ip' do
+    let(:ip) { '1.1.1.1' }
+    let(:addresses) { {} }
+    let(:server) do
+      s = double('server')
+      s.should_receive(:associate_address).with(ip).and_return(true)
+      s.stub(:addresses).and_return(addresses)
+      s
+    end
+
+    it 'associates the IP address with the server' do
+      expect(driver.send(:attach_ip, server, ip)).to eq(
+        [{ 'version' => 4, 'addr' => ip }])
+    end
+  end
+
   describe '#get_ip' do
     let(:addresses) { nil }
     let(:public_ip_addresses) { nil }
@@ -543,6 +690,7 @@ describe Kitchen::Driver::Openstack do
   end
 
   describe '#do_ssh_setup' do
+    let(:config) { { :public_key_path => '/pub_key' } }
     let(:server) { double(:password => 'aloha') }
     let(:state) { { :hostname => 'host' } }
     let(:read) { double(:read => 'a_key') }
@@ -555,8 +703,7 @@ describe Kitchen::Driver::Openstack do
     it 'opens an SSH session to the server' do
       Fog::SSH.stub(:new).with('host', 'root',
         { :password => 'aloha' }).and_return(ssh)
-      driver.stub(:open).with(File.expand_path(
-        '~/.ssh/id_dsa.pub')).and_return(read)
+      driver.stub(:open).with('/pub_key').and_return(read)
       read.stub(:read).and_return('a_key')
       res = driver.send(:do_ssh_setup, state, config, server)
       expected = [

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-openstack
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-23 00:00:00.000000000 Z
+date: 2013-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-kitchen