kitchen-openstack 1.6.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0fbad99eac55c81d83ff01f71923df56b60984a9
-  data.tar.gz: effda2e0a07e3f9f94ec25092869721a65812894
+  metadata.gz: e6059fb2f510144b58793252bb820a17f15b60e1
+  data.tar.gz: 1839ff785f4c4864ecee83317e6849c13bf96919
 SHA512:
-  metadata.gz: bf46986fa541331a45fe596d29202c28712b086115e4bdf0a4ea126830ee4f413c6a7864ea67c6035944bb74fd0131fd53ae793580b4c6c6a08d12e195f6fada
-  data.tar.gz: 7f0163070fce30dee8c62085001b631fa462b39d77079e92b5a506527d1946a8b5492c4809326ce84a78f2772a78b77a694cd93de31570596937c95397d08abe
+  metadata.gz: 6237abba4531cb071ea8681478a3069cdc5605c8ba60bef2f9defa56a3a5519699343d000f7ed4805b825867c6123ffcd19e358760a20944529993588599f346
+  data.tar.gz: 52857088b9f309bcbe3178912f0be5318be8eb0cc587ed16b3500ea8709d415e1cd3fe8a6f6c16728e7f6537732d27bf05ace5edf9b1e8000acfde69e61c56d1

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 1.7.0 / 2014-10-25
+
+### New Features
+
+* PR [#66][] - Allow setting a timed sleep for SSH check edge cases
+* PR [#63][] - Add support for a static server name prefix; via [@ftclausen][]
+* PR [#62][] - Add availability zone support; via [@fortable1999][]
+
 # 1.6.1 / 2014-10-07
 
 ### Bug Fixes
@@ -126,6 +134,9 @@ certain specified NICs; via [@monsterzz][]
 
 * Initial release! Woo!
 
+[#66]: https://github.com/test-kitchen/kitchen-openstack/pull/66
+[#63]: https://github.com/test-kitchen/kitchen-openstack/pull/63
+[#62]: https://github.com/test-kitchen/kitchen-openstack/pull/62
 [#60]: https://github.com/test-kitchen/kitchen-openstack/pull/60
 [#58]: https://github.com/test-kitchen/kitchen-openstack/pull/58
 [#56]: https://github.com/test-kitchen/kitchen-openstack/pull/56
@@ -154,6 +165,8 @@ certain specified NICs; via [@monsterzz][]
 [#7]: https://github.com/test-kitchen/kitchen-openstack/pull/7
 [#2]: https://github.com/test-kitchen/kitchen-openstack/pull/2
 
+[@ftclausen]: https://github.com/ftclausen
+[@fortable1999]: https://github.com/fortable1999
 [@stevejmason]: https://github.com/stevejmason
 [@StaymanHou]: https://github.com/StaymanHou
 [@jer]: https://github.com/jer

data/README.md

@@ -46,6 +46,7 @@ key will be used (with an RSA key taking precedence over a DSA), though that
 behavior can be overridden with additional options:
 
     server_name: [A UNIQUE SERVER NAME]
+    server_name_prefix: [STATIC PREFIX FOR RANDOM SERVER NAME]
     private_key_path: [PATH TO YOUR PRIVATE SSH KEY]
     public_key_path: [PATH TO YOUR SSH PUBLIC KEY]
     username: [SSH USER]
@@ -53,6 +54,7 @@ behavior can be overridden with additional options:
     key_name: [SSH KEY NAME]
     openstack_tenant: [YOUR OPENSTACK TENANT ID]
     openstack_region: [A VALID OPENSTACK REGION]
+    availability_zone: [AN OPENSTACK AVAILABILITY ZONE]
     openstack_service_name: [YOUR OPENSTACK COMPUTE SERVICE NAME]
     openstack_network_name: [YOUR OPENSTACK NETWORK NAME USED TO CONNECT]
     security_groups:
@@ -61,6 +63,13 @@ behavior can be overridden with additional options:
     network_ref:
       - [OPENSTACK NETWORK NAMES OR...]
       - [...ID TO CREATE INSTANCE WITH]
+    no_ssh_tcp_check: [DEFAULTS TO false, SKIPS TCP CHECK WHEN true]
+    no_ssh_tcp_check_sleep: [NUM OF SECONDS TO SLEEP IF no_ssh_tcp_check IS SET]
+
+If a `server_name_prefix` is specified then this prefix will be used when 
+generating random names of the form `<NAME PREFIX>-<RANDOM STRING>` e.g.
+`myproject-asdfghjk`. If both `server_name_prefix` and `server_name` are 
+specified then the `server_name` takes precedence.
 
 If a `key_name` is provided it will be used instead of any
 `public_key_path` that is specified.

data/lib/kitchen/driver/openstack.rb

@@ -33,6 +33,7 @@ module Kitchen
       @@ip_pool_lock = Mutex.new
 
       default_config :server_name, nil
+      default_config :server_name_prefix, nil
       default_config :key_name, nil
       default_config :private_key_path do
         %w(id_rsa id_dsa).map do |k|
@@ -52,11 +53,22 @@ module Kitchen
       default_config :openstack_network_name, nil
       default_config :floating_ip_pool, nil
       default_config :floating_ip, nil
+      default_config :availability_zone, nil
       default_config :security_groups, nil
       default_config :network_ref, nil
+      default_config :no_ssh_tcp_check, false
+      default_config :no_ssh_tcp_check_sleep, 120
 
       def create(state)
-        config[:server_name] ||= default_name
+        unless config[:server_name]
+          if config[:server_name_prefix]
+            config[:server_name] = server_name_prefix(
+              config[:server_name_prefix]
+            )
+          else
+            config[:server_name] = default_name
+          end
+        end
         config[:disable_ssl_validation] && disable_ssl_validation
         server = create_server
         state[:server_id] = server.id
@@ -145,7 +157,8 @@ module Kitchen
         {
           name: config[:server_name],
           image_ref: find_image(config[:image_ref]).id,
-          flavor_ref: find_flavor(config[:flavor_ref]).id
+          flavor_ref: find_flavor(config[:flavor_ref]).id,
+          availability_zone: config[:availability_zone]
         }
       end
 
@@ -198,6 +211,32 @@ module Kitchen
         ].join('-')
       end
 
+      def server_name_prefix(server_name_prefix)
+        # Generate what should be a unique server name with given prefix
+        # of up to 63 total chars
+        #
+        # Provided prefix:  variable, max 54
+        # Separator:        1
+        # Random string:    8
+        # ===================
+        # Max:              63
+        #
+        if server_name_prefix.length > 54
+          warn 'Server name prefix too long, truncated to 54 characters'
+          server_name_prefix = server_name_prefix[0..53]
+        end
+
+        server_name_prefix.gsub!(/\W/, '')
+
+        if server_name_prefix.empty?
+          warn 'Server name prefix empty or invalid; using fully generated name'
+          default_name
+        else
+          random_suffix = ('a'..'z').to_a.shuffle[0, 8].join
+          server_name_prefix + '-' + random_suffix
+        end
+      end
+
       def attach_ip_from_pool(server, pool)
         @@ip_pool_lock.synchronize do
           info "Attaching floating IP from <#{pool}> pool"
@@ -265,8 +304,7 @@ module Kitchen
       end
 
       def setup_ssh(server, state)
-        wait_for_sshd(state[:hostname], config[:username], port: config[:port])
-        info '(ssh ready)'
+        tcp_check(state)
         if config[:key_name]
           info "Using OpenStack keypair <#{config[:key_name]}>"
         end
@@ -289,6 +327,19 @@ module Kitchen
         ])
       end
 
+      def tcp_check(state)
+        # allow driver config to bypass SSH tcp check -- because
+        # it doesn't respect ssh_config values that might be required
+        if config[:no_ssh_tcp_check]
+          sleep(config[:no_ssh_tcp_check_sleep])
+        else
+          wait_for_sshd(state[:hostname],
+                        config[:username],
+                        port: config[:port])
+        end
+        info '(ssh ready)'
+      end
+
       def disable_ssl_validation
         require 'excon'
         Excon.defaults[:ssl_verify_peer] = false

data/lib/kitchen/driver/openstack_version.rb

@@ -21,6 +21,6 @@ module Kitchen
   #
   # @author Jonathan Hartman <j@p4nt5.com>
   module Driver
-    OPENSTACK_VERSION = '1.6.1'
+    OPENSTACK_VERSION = '1.7.0'
   end
 end

data/spec/kitchen/driver/openstack_spec.rb

@@ -53,6 +53,14 @@ describe Kitchen::Driver::Openstack do
 
   describe '#initialize'do
     context 'default options' do
+      it 'uses the normal SSH status check' do
+        expect(driver[:no_ssh_tcp_check]).to eq(false)
+      end
+
+      it 'sets a default TCP check wait time' do
+        expect(driver[:no_ssh_tcp_check_sleep]).to eq(120)
+      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)
@@ -105,6 +113,8 @@ describe Kitchen::Driver::Openstack do
         :openstack_service_name,
         :floating_ip_pool,
         :floating_ip,
+        :availability_zone,
+        :security_groups,
         :network_ref
       ]
       nils.each do |i|
@@ -123,6 +133,7 @@ describe Kitchen::Driver::Openstack do
           username: 'admin',
           port: '2222',
           server_name: 'puppy',
+          server_name_prefix: 'parsnip',
           openstack_tenant: 'that_one',
           openstack_region: 'atlantis',
           openstack_service_name: 'the_service',
@@ -139,6 +150,10 @@ describe Kitchen::Driver::Openstack do
           expect(drv[k]).to eq(v)
         end
       end
+
+      it 'overrides server name prefix with explicit server name, if given' do
+        expect(driver[:server_name]).to eq(config[:server_name])
+      end
     end
   end
 
@@ -354,6 +369,7 @@ describe Kitchen::Driver::Openstack do
         server_name: 'hello',
         image_ref: '111',
         flavor_ref: '1',
+        availability_zone: nil,
         public_key_path: 'tarpals'
       }
     end
@@ -403,6 +419,7 @@ describe Kitchen::Driver::Openstack do
           server_name: 'hello',
           image_ref: '111',
           flavor_ref: '1',
+          availability_zone: nil,
           public_key_path: 'tarpals'
         }
       end
@@ -422,6 +439,7 @@ describe Kitchen::Driver::Openstack do
           server_name: 'hello',
           image_ref: '111',
           flavor_ref: '1',
+          availability_zone: nil,
           public_key_path: 'montgomery',
           key_name: 'tarpals'
         }
@@ -443,6 +461,7 @@ describe Kitchen::Driver::Openstack do
           server_name: 'hello',
           image_ref: '111',
           flavor_ref: '1',
+          availability_zone: nil,
           public_key_path: 'montgomery',
           key_name: 'tarpals',
           security_groups: ['ping-and-ssh']
@@ -459,6 +478,28 @@ describe Kitchen::Driver::Openstack do
       end
     end
 
+    context 'a provided availability zone' do
+      let(:config) do
+        {
+          server_name: 'hello',
+          image_ref: '111',
+          flavor_ref: '1',
+          availability_zone: 'elsewhere',
+          public_key_path: 'montgomery',
+          key_name: 'tarpals'
+        }
+      end
+
+      before(:each) do
+        @expected = config.merge(name: config[:server_name])
+        @expected.delete_if { |k, _| k == :server_name }
+      end
+
+      it 'passes that availability zone to Fog' do
+        expect(driver.send(:create_server)).to eq(@expected)
+      end
+    end
+
     context 'image/flavor specifies id' do
       let(:config) do
         {
@@ -473,6 +514,7 @@ describe Kitchen::Driver::Openstack do
         expect(servers).to receive(:create).with(name: 'hello',
                                                  image_ref: '111',
                                                  flavor_ref: '1',
+                                                 availability_zone: nil,
                                                  public_key_path: 'tarpals')
         driver.send(:create_server)
       end
@@ -492,6 +534,7 @@ describe Kitchen::Driver::Openstack do
         expect(servers).to receive(:create).with(name: 'hello',
                                                  image_ref: '222',
                                                  flavor_ref: '2',
+                                                 availability_zone: nil,
                                                  public_key_path: 'tarpals')
         driver.send(:create_server)
       end
@@ -512,6 +555,7 @@ describe Kitchen::Driver::Openstack do
         expect(servers).to receive(:create).with(name: 'hello',
                                                  image_ref: '222',
                                                  flavor_ref: '1',
+                                                 availability_zone: nil,
                                                  public_key_path: 'tarpals')
         driver.send(:create_server)
       end
@@ -536,6 +580,7 @@ describe Kitchen::Driver::Openstack do
           name: 'hello',
           image_ref: '111',
           flavor_ref: '1',
+          availability_zone: nil,
           public_key_path: 'tarpals',
           nics: networks
         )
@@ -562,6 +607,7 @@ describe Kitchen::Driver::Openstack do
           name: 'hello',
           image_ref: '111',
           flavor_ref: '1',
+          availability_zone: nil,
           public_key_path: 'tarpals',
           nics: networks
         )
@@ -589,6 +635,7 @@ describe Kitchen::Driver::Openstack do
           name: 'hello',
           image_ref: '111',
           flavor_ref: '1',
+          availability_zone: nil,
           public_key_path: 'tarpals',
           nics: networks
         )
@@ -618,6 +665,7 @@ describe Kitchen::Driver::Openstack do
           name: 'hello',
           image_ref: '111',
           flavor_ref: '1',
+          availability_zone: nil,
           public_key_path: 'tarpals',
           user_data: data)
         driver.send(:create_server)
@@ -679,6 +727,53 @@ describe Kitchen::Driver::Openstack do
     end
   end
 
+  describe '#server_name_prefix' do
+    let(:login) { 'user' }
+    let(:hostname) { 'host' }
+    let(:prefix) { 'parsnip' }
+
+    # These are still used in the "blank prefix" test
+    before(:each) do
+      allow(Etc).to receive(:getlogin).and_return(login)
+      allow(Socket).to receive(:gethostname).and_return(hostname)
+    end
+
+    it 'generates a name with the selected prefix' do
+      expect(driver.send(:server_name_prefix, prefix))
+        .to match(/^parsnip-(\S*)/)
+    end
+
+    context 'very long prefix provided' do
+      let(:long_prefix) { 'a' * 70 }
+
+      it 'limits the generated name to 63 characters' do
+        expect(driver.send(:server_name_prefix, long_prefix).length)
+          .to be <= (63)
+      end
+    end
+
+    context 'a prefix with punctuation' do
+      let(:bad_char_prefix) { 'pa-rsn.ip' }
+
+      it 'strips out the dots to prevent bad server names' do
+        expect(driver.send(:server_name_prefix, bad_char_prefix))
+          .to_not include('.')
+      end
+
+      it 'strips out all but the one hyphen separator' do
+        expect(driver.send(:server_name_prefix, bad_char_prefix)
+          .count('-')).to eq(1)
+      end
+    end
+
+    context 'blank prefix' do
+      it 'generates fully random server name' do
+        expect(driver.send(:server_name_prefix, ''))
+          .to match(/potatoes-user-host-(\S*)/)
+      end
+    end
+  end
+
   describe '#attach_ip_from_pool' do
     let(:server) { nil }
     let(:pool) { 'swimmers' }
@@ -978,6 +1073,43 @@ describe Kitchen::Driver::Openstack do
     end
   end
 
+  describe '#setup_ssh' do
+    let(:server) { double }
+    before(:each) do
+      [:tcp_check, :do_ssh_setup].each do |m|
+        allow_any_instance_of(described_class).to receive(m)
+      end
+    end
+
+    it 'calls the TCP check' do
+      expect_any_instance_of(described_class).to receive(:tcp_check).with(state)
+      driver.send(:setup_ssh, server, state)
+    end
+  end
+
+  describe '#tcp_check' do
+    let(:state) { { hostname: 'hostname' } }
+
+    context 'standard SSH check' do
+      it 'calls the normal Kitchen SSH wait' do
+        expect_any_instance_of(described_class).not_to receive(:sleep)
+        expect_any_instance_of(described_class).to receive(:wait_for_sshd)
+          .with('hostname', 'root', port: '22')
+        driver.send(:tcp_check, state)
+      end
+    end
+
+    context 'override SSH wait' do
+      let(:config) { { no_ssh_tcp_check: true } }
+
+      it 'sleeps instead of monitoring the SSH port' do
+        expect_any_instance_of(described_class).not_to receive(:wait_for_sshd)
+        expect_any_instance_of(described_class).to receive(:sleep).with(120)
+        driver.send(:tcp_check, state)
+      end
+    end
+  end
+
   describe '#disable_ssl_validation' do
     it 'turns off Excon SSL cert validation' do
       expect(driver.send(:disable_ssl_validation)).to eq(false)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-openstack
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.7.0
 platform: ruby
 authors:
 - Jonathan Hartman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-07 00:00:00.000000000 Z
+date: 2014-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-kitchen