kitchen-openstack 0.4.0 → 0.5.0

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+# ?.?.? / ????-??-??
+
+### Improvements
+
+* PR [#19][] - Don't assume `public` and `private` network names exist
+* PR [#19][] - Make IPv4 or IPv6 configurable instead of relying on Fog to pick
+
+### Bug Fixes
+
+* PR [#20][] - Limit generated hostnames to 64 characters
+
 # 0.4.0 / 2013-06-06
 
 ### New Features
@@ -25,6 +36,8 @@
 
 * Initial release! Woo!
 
+[#20]: https://github.com/RoboticCheese/kitchen-openstack/pull/20
+[#19]: https://github.com/RoboticCheese/kitchen-openstack/pull/19
 [#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

data/kitchen-openstack.gemspec

@@ -18,8 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'test-kitchen', '~> 1.0.0.alpha'
-  spec.add_dependency 'fog', '~> 1.11'
+  spec.add_dependency 'test-kitchen', '~> 1.0.0.beta'
+  spec.add_dependency 'fog', '~> 1.15'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'

data/lib/kitchen/driver/openstack.rb

@@ -20,6 +20,7 @@ require 'benchmark'
 require 'fog'
 require 'kitchen'
 require 'etc'
+require 'ipaddr'
 require 'socket'
 
 module Kitchen
@@ -32,6 +33,7 @@ module Kitchen
       default_config :public_key_path, File.expand_path('~/.ssh/id_dsa.pub')
       default_config :username, 'root'
       default_config :port, '22'
+      default_config :use_ipv6, false
       default_config :openstack_tenant, nil
       default_config :openstack_region, nil
       default_config :openstack_service_name, nil
@@ -42,11 +44,9 @@ module Kitchen
         config[:disable_ssl_validation] and disable_ssl_validation
         server = create_server
         state[:server_id] = server.id
-        info("OpenStack instance <#{state[:server_id]}> created.")
+        info "OpenStack instance <#{state[:server_id]}> created."
         server.wait_for { print '.'; ready? } ; puts "\n(server ready)"
         state[:hostname] = get_ip(server)
-        # As a consequence of IP weirdness, the OpenStack setup() method is
-        # also borked
         wait_for_sshd(state[:hostname]) ; puts '(ssh ready)'
         unless config[:ssh_key] or config[:key_name]
           do_ssh_setup(state, config, server)
@@ -61,7 +61,7 @@ module Kitchen
         config[:disable_ssl_validation] and disable_ssl_validation
         server = compute.servers.get(state[:server_id])
         server.destroy unless server.nil?
-        info("OpenStack instance <#{state[:server_id]}> destroyed.")
+        info "OpenStack instance <#{state[:server_id]}> destroyed."
         state.delete(:server_id)
         state.delete(:hostname)
       end
@@ -94,24 +94,58 @@ module Kitchen
           server_def[:public_key_path] = config[:public_key_path]
         end
         server_def[:key_name] = config[:key_name] if config[:key_name]
+        # Can't use the Fog bootstrap and/or setup methods here; they require a
+        # public IP address that can't be guaranteed to exist across all
+        # OpenStack deployments (e.g. TryStack ARM only has private IPs).
         compute.servers.create(server_def)
       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}"
+        sep = '-'
+        pieces = [
+          base,
+          Etc.getlogin,
+          Socket.gethostname,
+          Array.new(8) { rand(36).to_s(36) }.join
+        ]
+        until pieces.join(sep).length <= 64 do
+          if pieces[2].length > 24
+            pieces[2] = pieces[2][0..-2]
+          elsif pieces[1].length > 16
+            pieces[1] = pieces[1][0..-2]
+          elsif pieces[0].length > 16
+            pieces[0] = pieces[0][0..-2]
+          end
+        end
+        pieces.join sep
       end
 
       def get_ip(server)
         if config[:openstack_network_name]
+          debug "Using configured network: #{config[:openstack_network_name]}"
           return server.addresses[config[:openstack_network_name]].first['addr']
-        elsif server.addresses['public'] and !server.addresses['public'].empty?
-          # server.public_ip_address stopped working in Fog 1.10.0
-          return server.addresses['public'].first['addr']
+        end
+        begin
+          pub, priv = server.public_ip_addresses, server.private_ip_addresses
+        rescue Fog::Compute::OpenStack::NotFound
+          # See Fog issue: https://github.com/fog/fog/issues/2160
+          addrs = server.addresses
+          addrs['public'] and pub = addrs['public'].map { |i| i['addr'] }
+          addrs['private'] and priv = addrs['private'].map { |i| i['addr'] }
+        end
+        pub, priv = parse_ips(pub, priv)
+        pub.first || priv.first || raise(ActionFailed, 'Could not find an IP')
+      end
+
+      def parse_ips(pub, priv)
+        pub, priv = Array(pub), Array(priv)
+        if config[:use_ipv6]
+          [pub, priv].each { |n| n.select! { |i| IPAddr.new(i).ipv6? } }
         else
-          return server.addresses['private'].first['addr']
+          [pub, priv].each { |n| n.select! { |i| IPAddr.new(i).ipv4? } }
         end
+        return pub, priv
       end
 
       def do_ssh_setup(state, config, server)

data/lib/kitchen/driver/openstack_version.rb

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

data/spec/kitchen/driver/openstack_spec.rb

@@ -29,7 +29,7 @@ describe Kitchen::Driver::Openstack do
   let(:state) { Hash.new }
 
   let(:instance) do
-    stub(:name => 'potatoes', :logger => logger, :to_str => 'instance')
+    double(:name => 'potatoes', :logger => logger, :to_str => 'instance')
   end
 
   let(:driver) do
@@ -98,8 +98,8 @@ describe Kitchen::Driver::Openstack do
 
   describe '#create' do
     let(:server) do
-      stub(:id => 'test123', :wait_for => true,
-        :public_ip_address => '1.2.3.4')
+      double(:id => 'test123', :wait_for => true,
+        :public_ip_addresses => %w{1.2.3.4})
     end
     let(:driver) do
       d = Kitchen::Driver::Openstack.new(config)
@@ -157,9 +157,9 @@ describe Kitchen::Driver::Openstack 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(:server) { double(:nil? => false, :destroy => true) }
+    let(:servers) { double(:get => server) }
+    let(:compute) { double(:servers => servers) }
 
     let(:driver) do
       d = Kitchen::Driver::Openstack.new(config)
@@ -198,7 +198,7 @@ describe Kitchen::Driver::Openstack do
         s.stub(:get).with('12345').and_return(nil)
         s
       end
-      let(:compute) { stub(:servers => servers) }
+      let(:compute) { double(:servers => servers) }
       let(:driver) do
         d = Kitchen::Driver::Openstack.new(config)
         d.instance = instance
@@ -273,7 +273,7 @@ describe Kitchen::Driver::Openstack do
       s.stub(:create) { |arg| arg }
       s
     end
-    let(:compute) { stub(:servers => servers) }
+    let(:compute) { double(:servers => servers) }
     let(:driver) do
       d = Kitchen::Driver::Openstack.new(config)
       d.instance = instance
@@ -333,41 +333,60 @@ describe Kitchen::Driver::Openstack do
       expect(driver.send(:generate_name, 'monkey')).to match(
         /^monkey-user-host-/)
     end
+
+    context 'local node with a long hostname' do
+      before(:each) do
+        Socket.unstub(:gethostname)
+        Socket.stub(:gethostname).and_return('ab.c' * 20)
+      end
+
+      it 'limits the generated name to 64-characters' do
+        expect(driver.send(:generate_name, 'long').length).to eq(64)
+      end
+    end
   end
 
   describe '#get_ip' do
-    let(:addresses) { { 'public' => [], 'private' => [] } }
-    let(:server) { stub(:addresses => addresses) }
+    let(:addresses) { nil }
+    let(:public_ip_addresses) { nil }
+    let(:private_ip_addresses) { nil }
+    let(:parsed_ips) { [[], []] }
+    let(:driver) do
+      d = Kitchen::Driver::Openstack.new(config)
+      d.instance = instance
+      d.stub(:parse_ips).and_return(parsed_ips)
+      d
+    end
+    let(:server) do
+      double(:addresses => addresses,
+        :public_ip_addresses => public_ip_addresses,
+        :private_ip_addresses => private_ip_addresses)
+    end
 
     context 'both public and private IPs' do
-      let(:addresses) do
-        {
-          'public' => [
-            { 'addr' => '1.2.3.4' },
-            { 'addr' => '1.2.3.5' }
-          ],
-          'private' => [
-            { 'addr' => '5.5.5.5' },
-            { 'addr' => '6.6.6.6' }
-          ]
-        }
-      end
+      let(:public_ip_addresses) { %w{1::1 1.2.3.4} }
+      let(:private_ip_addresses) { %w{5.5.5.5} }
+      let(:parsed_ips) { [%w{1.2.3.4}, %w{5.5.5.5}] }
 
-      it 'returns a public IP' do
+      it 'returns a public IPv4 address' do
         expect(driver.send(:get_ip, server)).to eq('1.2.3.4')
       end
     end
 
-    context 'only private IPs' do
-      let(:addresses) do
-        {
-          'private' => [
-            { 'addr' => '5.5.5.5' },
-            { 'addr' => '6.6.6.6' }
-          ]
-        }
+    context 'only public IPs' do
+      let(:public_ip_addresses) { %w{4.3.2.1 2::1} }
+      let(:parsed_ips) { [%w{4.3.2.1}, []] }
+
+      it 'returns a public IPv4 address' do
+        expect(driver.send(:get_ip, server)).to eq('4.3.2.1')
       end
-      it 'returns a private IP' do
+    end
+
+    context 'only private IPs' do
+      let(:private_ip_addresses) { %w{3::1 5.5.5.5} }
+      let(:parsed_ips) { [[], %w{5.5.5.5}] }
+
+      it 'returns a private IPv4 address' do
         expect(driver.send(:get_ip, server)).to eq('5.5.5.5')
       end
     end
@@ -378,20 +397,155 @@ describe Kitchen::Driver::Openstack do
         {
           'mynetwork' => [
             { 'addr' => '7.7.7.7' },
-            { 'addr' => '8.8.8.8' }
+            { 'addr' => '4::1' }
           ]
         }
       end
-      it 'returns a IP in user-defined network group' do
+
+      it 'returns a IPv4 address in user-defined network group' do
         expect(driver.send(:get_ip, server)).to eq('7.7.7.7')
       end
     end
+
+    context 'an OpenStack deployment without the floating IP extension' do
+      let(:server) do
+        s = double('server')
+        s.stub(:addresses).and_return(addresses)
+        s.stub(:public_ip_addresses).and_raise(
+          Fog::Compute::OpenStack::NotFound)
+        s.stub(:private_ip_addresses).and_raise(
+          Fog::Compute::OpenStack::NotFound)
+        s
+      end
+
+      context 'both public and private IPs in the addresses hash' do
+        let(:addresses) do
+          {
+            'public' => [{ 'addr' => '6.6.6.6' }, { 'addr' => '7.7.7.7' }],
+            'private' => [{ 'addr' => '8.8.8.8' }, { 'addr' => '9.9.9.9' }]
+          }
+        end
+        let(:parsed_ips) { [%w{6.6.6.6 7.7.7.7}, %w{8.8.8.8 9.9.9.9}] }
+
+        it 'selects the first public IP' do
+          expect(driver.send(:get_ip, server)).to eq('6.6.6.6')
+        end
+      end
+
+      context 'only public IPs in the address hash' do
+        let(:addresses) do
+          { 'public' => [{ 'addr' => '6.6.6.6' }, { 'addr' => '7.7.7.7' }] }
+        end
+        let(:parsed_ips) { [%w{6.6.6.6 7.7.7.7}, []] }
+
+        it 'selects the first public IP' do
+          expect(driver.send(:get_ip, server)).to eq('6.6.6.6')
+        end
+      end
+
+      context 'only private IPs in the address hash' do
+        let(:addresses) do
+          { 'private' => [{ 'addr' => '8.8.8.8' }, { 'addr' => '9.9.9.9' }] }
+        end
+        let(:parsed_ips) { [[], %w{8.8.8.8 9.9.9.9}] }
+
+        it 'selects the first private IP' do
+          expect(driver.send(:get_ip, server)).to eq('8.8.8.8')
+        end
+      end
+    end
+
+    context 'no IP addresses whatsoever' do
+      it 'raises an exception' do
+        expect { driver.send(:get_ip, server) }.to raise_error
+      end
+    end
+  end
+
+  describe '#parse_ips' do
+    let(:pub_v4) { %w{1.1.1.1 2.2.2.2} }
+    let(:pub_v6) { %w{1::1 2::2} }
+    let(:priv_v4) { %w{3.3.3.3 4.4.4.4} }
+    let(:priv_v6) { %w{3::3 4::4} }
+    let(:pub) { pub_v4 + pub_v6 }
+    let(:priv) { priv_v4 + priv_v6 }
+
+    context 'both public and private IPs' do
+      context 'IPv4 (default)' do
+        it 'returns only the v4 IPs' do
+          expect(driver.send(:parse_ips, pub, priv)).to eq([pub_v4, priv_v4])
+        end
+      end
+
+      context 'IPv6' do
+        let(:config) { { :use_ipv6 => true } }
+
+        it 'returns only the v6 IPs' do
+          expect(driver.send(:parse_ips, pub, priv)).to eq([pub_v6, priv_v6])
+        end
+      end
+    end
+
+    context 'only public IPs' do
+      let(:priv) { nil }
+
+      context 'IPv4 (default)' do
+        it 'returns only the v4 IPs' do
+          expect(driver.send(:parse_ips, pub, priv)).to eq([pub_v4, []])
+        end
+      end
+
+      context 'IPv6' do
+        let(:config) { { :use_ipv6 => true } }
+
+        it 'returns only the v6 IPs' do
+          expect(driver.send(:parse_ips, pub, priv)).to eq([pub_v6, []])
+        end
+      end
+    end
+
+    context 'only private IPs' do
+      let(:pub) { nil }
+
+      context 'IPv4 (default)' do
+        it 'returns only the v4 IPs' do
+          expect(driver.send(:parse_ips, pub, priv)).to eq([[], priv_v4])
+        end
+      end
+
+      context 'IPv6' do
+        let(:config) { { :use_ipv6 => true } }
+
+        it 'returns only the v6 IPs' do
+          expect(driver.send(:parse_ips, pub, priv)).to eq([[], priv_v6])
+        end
+      end
+    end
+
+    context 'no IPs whatsoever' do
+      let(:pub) { nil }
+      let(:priv) { nil }
+
+      context 'IPv4 (default)' do
+        it 'returns empty lists' do
+          expect(driver.send(:parse_ips, pub, priv)).to eq([[], []])
+        end
+      end
+
+      context 'IPv6' do
+        let(:config) { { :use_ipv6 => true } }
+
+        it 'returns empty lists' do
+          expect(driver.send(:parse_ips, nil, nil)).to eq([[], []])
+        end
+      end
+    end
   end
 
   describe '#do_ssh_setup' do
-    let(:server) { stub(:password => 'aloha') }
+    let(:server) { double(:password => 'aloha') }
     let(:state) { { :hostname => 'host' } }
-    let(:read) { stub(:read => 'a_key') }
+    let(:read) { double(:read => 'a_key') }
     let(:ssh) do
       s = double('ssh')
       s.stub(:run) { |args| args }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-openstack
 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-06-06 00:00:00.000000000 Z
+date: 2013-09-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
+        version: 1.0.0.beta
   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
+        version: 1.0.0.beta
 - !ruby/object:Gem::Dependency
   name: fog
   requirement: !ruby/object:Gem::Requirement
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement