kitchen-openstack 2.1.1 → 2.2.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69c69a59c3e8c2bfdb001296bfe5949b6bf45430
-  data.tar.gz: 2c6b438b1af153db872ddf311a56caa76bbcc1bf
+  metadata.gz: 059bf269f5416a2a5a5bcc11a3e68844b487c61b
+  data.tar.gz: 1c8d23e64ba66875ef55645883c8b08cb8771612
 SHA512:
-  metadata.gz: 04ebc0f118339b453c235970fe51bb58ade74e93b3c83e8e0226efb360b56ac4d8c0ff68605d467934fd6eb7bd4b8589d70253b14db0a7bfeef3c965e52a5449
-  data.tar.gz: ed824128dd046d02eb63579418022da643a965b4eccf7c95a8135f92cb5a823199627e760f1ea040195c46c1c5ba8c01df361bdf995a17633c8fd96c17adcea4
+  metadata.gz: 542449b370fe53182781a840bd1b3808e8dc3efd4d4ad9e65d0f360ed1fae79f7a01c73ed6d5459cc450f04245995701f9343a92a43a302c77b1af6320db8ad0
+  data.tar.gz: 6597a4224677f92de822959d5c1483bbf278d17c94c2216de93e74e06947a0342022b9eacc15ed460d2743312cf109ded22591a350581f82dae96e5237b4968e

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+[Full Changelog](https://github.com/test-kitchen/kitchen-openstack/compare/v2.1.1...HEAD)
+
+**Merged pull requests:**
+
+- Updated README with key\_name issue. [\#127](https://github.com/test-kitchen/kitchen-openstack/pull/127) ([jjasghar](https://github.com/jjasghar))
+- Use OpenStack models for waiting for conditions [\#120](https://github.com/test-kitchen/kitchen-openstack/pull/120) ([carpnick](https://github.com/carpnick))
 
 ## [v2.1.1](https://github.com/test-kitchen/kitchen-openstack/tree/v2.1.1) (2015-11-03)
 [Full Changelog](https://github.com/test-kitchen/kitchen-openstack/compare/v2.1.0...v2.1.1)
@@ -10,6 +16,7 @@
 
 **Merged pull requests:**
 
+- 2.1.1 [\#125](https://github.com/test-kitchen/kitchen-openstack/pull/125) ([jjasghar](https://github.com/jjasghar))
 - Ohai hint file is now created with the correct encoding on Windows [\#124](https://github.com/test-kitchen/kitchen-openstack/pull/124) ([stuartpreston](https://github.com/stuartpreston))
 - Added info about user\_data [\#121](https://github.com/test-kitchen/kitchen-openstack/pull/121) ([jjasghar](https://github.com/jjasghar))
 
@@ -400,6 +407,3 @@
 [Full Changelog](https://github.com/test-kitchen/kitchen-openstack/compare/v0.5.1...v0.5.2)
 
 ## [v0.5.1](https://github.com/test-kitchen/kitchen-openstack/tree/v0.5.1) (2011-04-05)
-
-
-\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/README.md

@@ -118,8 +118,15 @@ If a `key_name` is provided it will be used instead of any
 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. If you do key injection via `cloud-init` like this issue:
-[#77](https://github.com/test-kitchen/kitchen-openstack/issues/77) the best
-way is to make a "dummy-key."
+[#77](https://github.com/test-kitchen/kitchen-openstack/issues/77). The
+`key_name` should be a blank string if you need to skip it. Example:
+
+```yml
+driver:
+  [-- snip --]
+  key_name: ""
+  user_data: cloud_init
+```
 
 ### username
 
@@ -154,6 +161,9 @@ Your OpenStack compute service name.
 Your OpenStack network name used to connect to, if you have only private network
 connections you want declare this.
 
+### glance\_cache\_wait\_timeout
+When OpenStack downloads the image into cache, it takes extra time to provision.  Timeout controls maximum amount of time to wait for machine to move from the Build/Spawn phase to Active.
+
 ### server\_wait
 
 `server_wait` is a workaround to deal with how some VMs with `cloud-init`.
@@ -253,6 +263,9 @@ The volume type, this is optional.
 This will delete the volume on the instance when `destroy` happens, if set to true.
 Otherwise set this to `false`.
 
+#### creation\_timeout
+Timeout to wait for volume to become available.  If a large volume is provisioned, it might take time to provision it on the backend.  Maximum amount of time to wait for volume to be created and be available.
+
 #### Example
 
 ```yaml
@@ -262,6 +275,7 @@ block_device_mappings:
   device_name: vda
   availability_zone: nova
   delete_on_termination: false
+  creation_timeout: 120
 ```
 
 ## Network and Communication Configuration

data/lib/kitchen/driver/openstack.rb

@@ -63,6 +63,7 @@ module Kitchen
       default_config :no_ssh_tcp_check, false
       default_config :no_ssh_tcp_check_sleep, 120
       default_config :winrm_wait, nil
+      default_config :glance_cache_wait_timeout, 600
       default_config :block_device_mapping, nil
 
       required_config :private_key_path
@@ -96,8 +97,14 @@ module Kitchen
         server = create_server
         state[:server_id] = server.id
         info "OpenStack instance with ID of <#{state[:server_id]}> is ready." # rubocop:disable Metrics/LineLength
+
         # this is due to the glance_caching issues. Annoying yes, but necessary.
-        sleep 30
+        debug "Waiting for VM to be in ACTIVE state for a max time of:#{config[:glance_cache_wait_timeout]} seconds" # rubocop:disable Metrics/LineLength
+        server.wait_for(config[:glance_cache_wait_timeout]) do
+          sleep(1)
+          ready?
+        end
+
         if config[:floating_ip]
           attach_ip(server, config[:floating_ip])
         elsif config[:floating_ip_pool]
@@ -152,7 +159,7 @@ module Kitchen
       end
 
       def volume
-        Volume.new
+        Volume.new(logger)
       end
 
       def get_bdm(config)

data/lib/kitchen/driver/openstack/volume.rb

@@ -27,15 +27,14 @@ module Kitchen
       #
       # @author Liam Haworth <liam.haworth@bluereef.com.au>
       class Volume
-        def volume(openstack_server)
-          Fog::Volume.new(openstack_server)
+        @@default_creation_timeout = 60
+
+        def initialize(logger)
+          @logger = logger
         end
 
-        def volume_ready?(vol_id, os)
-          resp = volume(os).get_volume_details(vol_id)
-          status = resp[:body]['volume']['status']
-          fail "Failed to make volume <#{vol_id}>" if status == 'error'
-          status == 'available'
+        def volume(openstack_server)
+          Fog::Volume.new(openstack_server)
         end
 
         def create_volume(config, os)
@@ -46,12 +45,31 @@ module Kitchen
           vanilla_options.select { |o| bdm[o] }.each do |key|
             opt[key] = bdm[key]
           end
+          @logger.info 'Creating Volume...'
           resp = volume(os).create_volume("#{config[:server_name]}-volume",
                                           "#{config[:server_name]} volume",
                                           bdm[:volume_size],
                                           opt)
           vol_id = resp[:body]['volume']['id']
-          sleep(1) until volume_ready?(vol_id, os)
+
+          # Get Volume Model to make waiting for ready easy
+          vol_model = volume(os).volumes.first { |x| x.id == vol_id }
+
+          # Use default creation timeout or user supplied
+          creation_timeout = @@default_creation_timeout
+          if bdm.key?(:creation_timeout)
+            creation_timeout = bdm[:creation_timeout]
+          end
+
+          @logger.debug "Waiting for volume to be ready for #{creation_timeout} seconds" # rubocop:disable Metrics/LineLength
+          vol_model.wait_for(creation_timeout) do
+            sleep(1)
+            fail('Failed to make volume') if status.downcase == 'error'
+            ready?
+          end
+
+          @logger.debug 'Volume Ready'
+
           vol_id
         end
 

data/lib/kitchen/driver/openstack_version.rb

@@ -22,6 +22,6 @@ module Kitchen
   #
   # @author Jonathan Hartman <j@p4nt5.com>
   module Driver
-    OPENSTACK_VERSION = '2.1.1'
+    OPENSTACK_VERSION = '2.2.0.pre.1'
   end
 end

data/spec/kitchen/driver/openstack/volume_spec.rb

@@ -20,10 +20,11 @@ describe Kitchen::Driver::Openstack::Volume do
       openstack_service_name: 'the_service'
     }
   end
-
+  let(:logger_io) { StringIO.new }
+  let(:logger)    { Kitchen::Logger.new(logdev: logger_io) }
   describe '#volume' do
     let(:vol_driver) do
-      described_class.new
+      described_class.new(logger)
     end
 
     it 'creates a new block device connection' do
@@ -31,38 +32,14 @@ describe Kitchen::Driver::Openstack::Volume do
       expect(vol_driver.send(:volume, os)).to eq(os)
     end
   end
-
-  describe '#volume_ready?' do
-    let(:volume_details) do
-      {
-        body: { 'volume' => { 'status' => 'available' } }
-      }
-    end
-
-    let(:volume) do
-      double(
-        get_volume_details: volume_details
-      )
-    end
-
-    let(:vol_driver) do
-      d = described_class.new
-      allow(d).to receive(:volume).and_return(volume)
-      d
-    end
-
-    it 'checks if the volume is ready' do
-      expect(vol_driver.send(:volume_ready?, '333', os)).to eq(true)
-    end
-  end
-
   describe '#create_volume' do
     let(:config) do
       {
         server_name: 'applejack',
         block_device_mapping: {
           snapshot_id: '444',
-          volume_size: '5'
+          volume_size: '5',
+          creation_timeout: '30'
         }
       }
     end
@@ -73,20 +50,47 @@ describe Kitchen::Driver::Openstack::Volume do
       }
     end
 
+    let(:volume_model) do
+      {
+        id: '555',
+        status: 'ACTIVE'
+        # wait_for: true
+        # ready?: true
+      }
+    end
+
     let(:volume) do
       double(
-        create_volume: create_volume
+        create_volume: create_volume,
+        volumes: [volume_model]
       )
     end
 
+    let(:wait_for) do
+      {
+        ready?: true,
+        status: 'ACTIVE'
+      }
+    end
+
     let(:vol_driver) do
-      d = described_class.new
+      d = described_class.new(logger)
       allow(d).to receive(:volume).and_return(volume)
-      allow(d).to receive(:volume_ready?).and_return(true)
+      allow(d).to receive(:volume_model).and_return(true)
       d
     end
 
     it 'creates a volume' do
+      # This seems like a hack
+      # how would we do this on the volume_model instead?
+      # This makes rspec work
+      # but the vol_driver doesnt have these methods properties?
+      allow(vol_driver).to receive(:status).and_return('ACTIVE')
+      allow(vol_driver).to receive(:ready?).and_return(true)
+      allow(volume_model).to receive(:wait_for)
+        .with(an_instance_of(String)).and_yield
+
+      # allow(vol_driver).a
       expect(vol_driver.send(:create_volume, config, os)).to eq('555')
     end
   end
@@ -106,7 +110,7 @@ describe Kitchen::Driver::Openstack::Volume do
     end
 
     let(:vol_driver) do
-      d = described_class.new
+      d = described_class.new(logger)
       allow(d).to receive(:create_volume).and_return('555')
       d
     end

data/spec/kitchen/driver/openstack_spec.rb

@@ -12,6 +12,8 @@ require 'kitchen/provisioner/dummy'
 require 'kitchen/transport/dummy'
 require 'kitchen/verifier/dummy'
 require 'ohai'
+require 'excon'
+require 'fog'
 
 describe Kitchen::Driver::Openstack do
   let(:logged_output) { StringIO.new }
@@ -201,22 +203,53 @@ describe Kitchen::Driver::Openstack do
       d
     end
 
+    context 'when a server is already created' do
+      it 'does not create a new instance' do
+        state[:server_id] = '1'
+        expect(driver).not_to receive(:create_server)
+        driver.create(state)
+      end
+    end
+
     context 'required options provided' do
       let(:config) do
         {
           openstack_username: 'hello',
           openstack_api_key: 'world',
           openstack_auth_url: 'http:',
-          openstack_tenant: 'www'
+          openstack_tenant: 'www',
+          glance_cache_wait_timeout: 600,
+          disable_ssl_validation: false
         }
       end
-    end
+      let(:server) do
+        double(id: 'test123', wait_for: true, public_ip_addresses: %w(1.2.3.4))
+      end
 
-    context 'when a server is already created' do
-      it 'does not create a new instance' do
-        state[:server_id] = '123'
-        expect(driver).not_to receive(:create_server)
-        driver.create(state)
+      let(:driver) do
+        d = described_class.new(config)
+        allow(d).to receive(:config_server_name).and_return('a_monkey!')
+        allow(d).to receive(:create_server).and_return(server)
+        allow(server).to receive(:id).and_return('test123')
+
+        # Inside the yield block we are calling ready?  So we fake it here
+        allow(d).to receive(:ready?).and_return(true)
+        allow(server).to receive(:wait_for)
+          .with(an_instance_of(Fixnum)).and_yield
+
+        allow(d).to receive(:get_ip).and_return('1.2.3.4')
+        allow(d).to receive(:bourne_shell?).and_return(false)
+        d
+      end
+
+      it 'returns nil, but modifies the state' do
+        expect(driver.send(:create, state)).to eq(nil)
+        expect(state[:server_id]).to eq('test123')
+      end
+
+      it 'throws an Action error when trying to create_server' do
+        allow(driver).to receive(:create_server).and_raise(Fog::Errors::Error)
+        expect { driver.send(:create, state) }.to raise_error(Kitchen::ActionFailed) # rubocop:disable Metrics/LineLength
       end
     end
   end
@@ -1081,6 +1114,38 @@ describe Kitchen::Driver::Openstack do
     end
   end
 
+  describe '#setup_ssh' do
+    let(:config) { { public_key_path: '/pub_key' } }
+    let(:config) do
+      {
+        public_key_path: '/pub_key',
+        key_name: 'OpenStackKey'
+      }
+    end
+
+    let(:server) { double(password: 'aloha') }
+    let(:state) { { hostname: 'host' } }
+    let(:read) { double(read: 'a_key') }
+    let(:ssh) { double(run: true) }
+
+    before(:each) do
+      allow(driver).to receive(:open).with(config[:public_key_path])
+        .and_return(read)
+    end
+
+    context 'sets the ssh_key state' do
+      before do
+        allow(driver).to receive(:bourne_shell?).and_return(false)
+        allow(driver).to receive(:do_ssh_setup).and_return(nil)
+      end
+
+      it 'does not execute the ssh setup' do
+        expect(driver).not_to receive(:do_ssh_setup)
+        driver.send(:setup_ssh, server, state)
+      end
+    end
+  end
+
   describe '#do_ssh_setup' do
     let(:config) { { public_key_path: '/pub_key' } }
     let(:server) { double(password: 'aloha') }
@@ -1136,6 +1201,12 @@ describe Kitchen::Driver::Openstack do
     it 'opens an SSH session to the server' do
       driver.send(:add_ohai_hint, state)
     end
+
+    it 'opens an Winrm session to the server' do
+      allow(driver).to receive(:bourne_shell?).and_return(false)
+      allow(driver).to receive(:windows_os?).and_return(true)
+      driver.send(:add_ohai_hint, state)
+    end
   end
 
   describe '#disable_ssl_validation' do
@@ -1143,4 +1214,84 @@ describe Kitchen::Driver::Openstack do
       expect(driver.send(:disable_ssl_validation)).to eq(false)
     end
   end
+
+  describe '#countdown' do
+    it 'counts down to future time with 0 seconds with almost no time' do
+      current = Time.now
+      driver.send(:countdown, 0)
+      after = Time.now
+      expect(after - current).to be >= 0
+      expect(after - current).to be < 10
+    end
+
+    it 'counts down to future time with 1 seconds with at least 9 seconds' do
+      current = Time.now
+      driver.send(:countdown, 1)
+      after = Time.now
+      expect(after - current).to be >= 9
+    end
+  end
+
+  describe '#wait_for_server' do
+    let(:config) { { server_wait: 0 } }
+    let(:state) { { hostname: 'host' } }
+
+    it 'waits for connection to be available' do
+      expect(driver.send(:wait_for_server, state)).to be(nil)
+    end
+
+    it 'Fails when calling transport but still destroys the created system' do
+      allow(instance.transport).to receive(:connection).and_raise(ArgumentError)
+      expect(driver).to receive(:destroy)
+
+      expect { driver.send(:wait_for_server, state) }
+        .to raise_error(ArgumentError)
+    end
+  end
+
+  describe '#get_bdm' do
+    let(:logger) { Logger.new(logged_output) }
+    let(:config) do
+      {
+        openstack_username: 'a',
+        openstack_api_key: 'b',
+        openstack_auth_url: 'http://',
+        openstack_tenant: 'me',
+        openstack_region: 'ORD',
+        openstack_service_name: 'stack',
+        image_ref: '22',
+        flavor_ref: '33',
+        public_key_path: '/tmp',
+        username: 'admin',
+        port: '2222',
+        server_name: 'puppy',
+        server_name_prefix: 'parsnip',
+        private_key_path: '/path/to/id_rsa',
+        floating_ip_pool: 'swimmers',
+        floating_ip: '11111',
+        network_ref: '0xCAFFE',
+        block_device_mapping: {
+          volume_id: '55',
+          volume_size: '5',
+          device_name: 'vda',
+          delete_on_termination: true
+        }
+      }
+    end
+    it 'returns just the BDM config' do
+      expect(driver.send(:get_bdm, config)).to eq(config[:block_device_mapping])
+    end
+  end
+
+  describe '#config_server_name' do
+    let(:config) do
+      {
+        server_name_prefix: 'parsnip'
+      }
+    end
+
+    it 'returns random string prefixed by servername_prefix attribute' do
+      expect(driver.send(:config_server_name)).to include('parsnip')
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -10,7 +10,8 @@ SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
   SimpleCov::Formatter::HTMLFormatter,
   SimpleCov::Formatter::Console
 ]
-SimpleCov.minimum_coverage 90
+SimpleCov.minimum_coverage 95
 SimpleCov.start do
   add_filter '/vendor/'
+  add_filter '/spec/'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-openstack
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0.pre.1
 platform: ruby
 authors:
 - Jonathan Hartman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-03 00:00:00.000000000 Z
+date: 2015-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-kitchen
@@ -237,9 +237,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2