rspec-system 2.7.2 → 2.8.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZWFkNDA1YWE4ZWU1NjZlZDY5YjM2YTI3MDY1YzRhMmQxNThjNGIxYw==
+    N2FhYjg3NDZkZWFkNGZlMDY5NGRkMThhOTFmNDk0MTlkZmY5MDBiMg==
   data.tar.gz: !binary |-
-    MGMxOGNjMzg5ZDdlZTk0ODE3ZTUxOGM1MTJiZWYwZTEyNzVlNGEzNg==
+    M2ZmZWIyYTI0MDkyMjQyOTAwZGIyYjNmZDczNWYzZTZiNjlhY2YwOA==
 SHA512:
   metadata.gz: !binary |-
-    MjFmNjQ5NDE3OTkwYjFkYzkwYmM4ZGM4MDM5MmYwZGNhZjIxZDUzNDQyZDYz
-    ZjE2NzVhNWY0ZWUxNmQ3OGU2OWM1NzYyZDU2ZWZiMjc2YWFjNmEyZWJhOWQw
-    ZGMxNjhiNTU0YzlhZjJmNDMyM2RmODA4ODMzMDg2MzhhNzJlZWQ=
+    NTFiMGZjODQ5ZGQ1YmQ2OGI5MTMxODBjOTk0OGI0ZmMyMzE2Y2Y1MjQ3Yjgx
+    OGM1M2VjOTdhZTMwMmM3MjI1ZWVhY2Q0YzQ0MjE2OGJiNTA5ZGVkMGMxYzJm
+    NWQ3N2M0YTUwYzBmNTg4ODFmMDNiNWNkNzBlY2Q5NDgwZWEyMDI=
   data.tar.gz: !binary |-
-    MDhjNTNiNDZhMGJhMjFhMzA0MDNmMWIzMWYwY2YxOTBlYzI1Nzk3ZWNiMjlm
-    NDNlZTdjNjVmZmVhNDBkMjgwMDA2NDFjMzU4NjI0YmMxNmIxYzEwNDdjZmQ1
-    YmI3NTljYjFhMjFkNzk2ZmZhMzI3MzcxZmZjMmFiZTZhMDY4NzU=
+    ZDUzNzJhNzI0OTA1OThlY2UzNThlOTc0M2JiYmMzN2NkZjlmMDk3MWUxYjg1
+    YjgxMjY5MjdlM2JiMjhkY2ViOThhNzgwMGNlOTBhMzdmYmQxZTU2M2NlNDEz
+    ZWJlMTZkMmZmOGY0MmY1NDA4MzBkNGYxZmJiNGU0MjVmZjFiNDI=

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+2.8.0
+=====
+
+This feature release includes the new Openstack provider, which allows you to
+now use an Openstack installation for provisioning test nodes. Thanks to Hawk
+Newton for providing this contribution.
+
+Consult the README.md file for more information on this provider.
+
+As this functionality is fairly new, YMMV - but please test away and let us
+know if you find any issues.
+
+#### Detailed Changes
+
+* Openstack provider (Hawk Newton)
+
+-------------------------------
+
 2.7.2
 =====
 

data/Gemfile

@@ -10,5 +10,6 @@ end
 
 group :development do
   gem 'yard'
-  gem 'redcarpet'
+  # 3.0.0 breaks 1.8.7 support
+  gem 'redcarpet', '~> 2.3.0'
 end

data/README.md

@@ -306,6 +306,31 @@ Set these variables, and run the usual rake command specifying the provider:
 
 In Jenkins, set the authentication variables above using environment variable injection. I recommend using the private environment variables feature for user & pass however so these do not get displayed in the console output. As with the vagrant provider however, turn RS\_SET into a test matrix, containing all the sets you want to test against.
 
+#### OpenStack
+
+You may also use [OpenStack](http://www.openstack.org/) as a virtualization provider.
+
+    RS_PROVIDER=openstack
+
+All parameters are required and case sensitive.
+
+* *RS_OPENSTACK_ENDPOINT* -- Your openstack token url, something like `http://your.openstack.url:5000/v2.0/tokens`
+* *RS_OPENSTACK_USERNAME* -- Your openstack username
+* *RS_OPENSTACK_API_KEY* -- password
+* *RS_OPENSTACK_KEYPAIR_NAME* -- ssh keypair name
+* *RS_OPENSTACK_FLAVOR_NAME* -- flavor name
+* *RS_OPENSTACK_IMAGE_NAME* -- image name
+* *RS_OPENSTACK_NETWORK_NAME* -- network name
+* *RS_OPENSTACK_NODE_TIMEOUT* -- Number of seconds to wait for openstack instances to be created
+* *RS_OPENSTACK_SSH_KEYS* -- Full path to ssh private keys, colin (:) delimited
+
+
+##### OpenStack TODO
+* Support `RSPEC_DESTROY=no` and destroying abandoned instances by persisting the server ids in .rspec_system
+* Provide support for floating ips
+* Support explicit tenant ids
+* No custom option support
+
 ### Plugins to rspec-system
 
 Right now we have two types of plugins, the framework is in a state of flux as to how one writes these things but here we go.

data/lib/rspec-system/node_set/openstack.rb

@@ -0,0 +1,124 @@
+require 'net/ssh'
+require 'net/scp'
+require 'fog'
+require 'rspec-system/node_set/base'
+
+module RSpecSystem
+  class NodeSet::Openstack < NodeSet::Base
+    PROVIDER_TYPE = 'openstack'
+    attr_accessor :vmconf
+
+    CONFIG_KEYS = [
+      :node_timeout,
+      :username,
+      :flavor_name,
+      :image_name,
+      :endpoint,
+      :keypair_name,
+      :network_name,
+      :ssh_keys,
+      :api_key
+    ]
+
+    def initialize(name, config, custom_prefabs_path, options)
+      super
+      @vmconf = read_config
+      @now = Time.now.strftime '%Y%m%d-%H:%M:%S.%L'
+      RSpec.configuration.rs_storage[:nodes] ||= {}
+    end
+
+    def launch
+      nodes.each do |k,v|
+        storage = RSpec.configuration.rs_storage[:nodes][k] ||= {}
+        options = {
+          :flavor_ref => flavor.id,
+          :image_ref => image.id,
+          :name => "#{k}-#{@now}",
+          :key_name => vmconf[:keypair_name]
+        }
+        options[:nics] = [{'net_id' => nic.id}] if vmconf[:network_name]
+        log.info "Launching openstack instance #{k}"
+        result = compute.servers.create options
+        storage[:server] = result
+      end
+    end
+
+    def connect
+      nodes.each do |k,v|
+        server = RSpec.configuration.rs_storage[:nodes][k][:server]
+        before = Time.new.to_i
+        while true
+          begin
+            server.wait_for(5) { ready? }
+            break
+          rescue ::Fog::Errors::TimeoutError
+            raise if Time.new.to_i - before > vmconf[:node_timeout]
+            log.info "Timeout connecting to instance, trying again..."
+          end
+        end
+
+        chan = ssh_connect(:host => k, :user => 'root', :net_ssh_options => {
+          :keys => vmconf[:ssh_keys].split(':'),
+          :host_name => server.addresses[vmconf[:network_name]].first['addr'],
+          :paranoid => false
+        })
+        RSpec.configuration.rs_storage[:nodes][k][:ssh] = chan
+      end
+    end
+
+    def teardown
+      nodes.keys.each do |k|
+        server = RSpec.configuration.rs_storage[:nodes][k][:server]
+        log.info "Destroying server #{server.name}"
+        server.destroy
+      end
+    end
+
+    def compute
+      @compute || @compute = Fog::Compute.new({
+        :provider => :openstack,
+        :openstack_username => vmconf[:username],
+        :openstack_api_key => vmconf[:api_key],
+        :openstack_auth_url => vmconf[:endpoint],
+      })
+    end
+
+    def network
+      @network || @network = Fog::Network.new({
+        :provider => :openstack,
+        :openstack_username => vmconf[:username],
+        :openstack_api_key => vmconf[:api_key],
+        :openstack_auth_url => vmconf[:endpoint],
+      })
+    end
+    private
+
+    def flavor
+      log.info "Looking up flavor #{vmconf[:flavor_name]}"
+      compute.flavors.find { |x| x.name == vmconf[:flavor_name] } || raise("Couldn't find flavor: #{vmconf[:flavor_name]}")
+    end
+
+    def image
+      log.info "Looking up image #{vmconf[:image_name]}"
+      compute.images.find { |x| x.name == vmconf[:image_name] } || raise("Couldn't find image: #{vmconf[:image_name]}")
+    end
+
+    def nic
+      log.info "Looking up network #{vmconf[:network_name]}"
+      network.networks.find { |x| x.name == vmconf[:network_name] } || raise("Couldn't find network: #{vmconf[:network_name]}")
+    end
+
+    def read_config
+      conf = ENV.inject({}) do |memo,(k,v)|
+        if k =~ /^RS_OPENSTACK_(.+)/
+          var = $1.downcase.to_sym
+          memo[var] = v if ([var] & CONFIG_KEYS).any?
+        end
+        memo
+      end
+
+      conf[:node_timeout] = conf[:node_timeout].to_i unless conf[:node_timeout].nil?
+      conf
+    end
+  end
+end

data/rspec-system.gemspec

@@ -2,7 +2,7 @@
 Gem::Specification.new do |s|
   # Metadata
   s.name        = "rspec-system"
-  s.version     = "2.7.2"
+  s.version     = "2.8.0"
   s.authors     = ["Ken Barber"]
   s.email       = ["info@puppetlabs.com"]
   s.homepage    = "https://github.com/puppetlabs/rspec-system"
@@ -25,4 +25,8 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "rbvmomi", '~>1.6'
   # It seems 1.6.0 relies on ruby 1.9.2, so lets pin it for now
   s.add_runtime_dependency "nokogiri", '~>1.5.10'
+  s.add_runtime_dependency 'fog', '~> 1.18'
+  # 2.0 drops 1.8.7 support
+  s.add_runtime_dependency 'mime-types', '~> 1.16'
+
 end

data/spec/unit/openstack_spec.rb

@@ -0,0 +1,361 @@
+require 'spec_helper'
+require 'rspec-system/node_set/openstack'
+
+describe RSpecSystem::NodeSet::Openstack do
+  subject { described_class.new(setname, config, custom_prefabs_path, options) }
+
+  let(:setname) { 'set name' }
+  let(:config) do
+    {
+      'nodes' => {
+        'main-test1' => { 'prefab' => 'centos-64-x64' },
+        'main-test2' => { 'prefab' => 'centos-59-x64' }
+      }
+    }
+  end
+
+  let(:custom_prefabs_path) { '' }
+  let(:options) { { } }
+  let(:api_key) { 'test-api_key' }
+  let(:node_timeout) { 120 }
+  let(:username) { 'test-username' }
+  let(:image_name) { 'test-image_name' }
+  let(:flavor_name) { 'test-flavor_name' }
+  let(:endpoint) { 'http://token.url/tokens' }
+  let(:keypair_name) { 'test-keypair_name' }
+  let(:ssh_username) { 'test-ssh_username' }
+  let(:network_name) { 'test-network_name' }
+  let(:ssh_keys) { 'test-ssh_key' }
+
+  let(:env_vars) do
+    {
+      'RS_OPENSTACK_NODE_TIMEOUT' => node_timeout,
+      'RS_OPENSTACK_USERNAME'     => username,
+      'RS_OPENSTACK_API_KEY'      => api_key,
+      'RS_OPENSTACK_IMAGE_NAME'   => image_name,
+      'RS_OPENSTACK_FLAVOR_NAME'  => flavor_name,
+      'RS_OPENSTACK_ENDPOINT'     => endpoint,
+      'RS_OPENSTACK_KEYPAIR_NAME' => keypair_name,
+      'RS_OPENSTACK_SSH_USERNAME' => ssh_username,
+      'RS_OPENSTACK_NETWORK_NAME' => network_name,
+      'RS_OPENSTACK_SSH_KEYS'     => ssh_keys
+    }
+  end
+
+  let(:rs_storage) do
+    { }
+  end
+
+  let(:log) do
+    log = stub :log
+    log.stubs :info
+    log
+  end
+
+  before do
+    env_vars.each { |k,v| ENV[k] = v.to_s }
+    RSpec.configuration.stubs(:rs_storage).returns rs_storage
+    described_class.any_instance.stubs(:log).returns log
+  end
+
+  it 'should have the PROVIDER_TYPE openstack' do
+    expect(described_class::PROVIDER_TYPE).to eq 'openstack'
+  end
+
+  describe '#vmconf' do
+    subject { described_class.new(setname, config, custom_prefabs_path, options).vmconf }
+    context 'given env config variables' do
+
+      it 'should read node_timeout from the environment' do
+        expect(subject[:node_timeout]).to eq node_timeout
+      end
+
+      it 'should read username from the environment' do
+        expect(subject[:username]).to eq username
+      end
+
+      it 'should read flavor from the environment' do
+        expect(subject[:flavor_name]).to eq flavor_name
+      end
+
+      it 'should read image from the environment' do
+        expect(subject[:image_name]).to eq image_name
+      end
+
+      it 'should read endpoint url from the environment' do
+        expect(subject[:endpoint]).to eq endpoint
+      end
+
+      it 'should read keypair name from the environment' do
+        expect(subject[:keypair_name]).to eq keypair_name
+      end
+
+      it 'should read network name from the environment' do
+        expect(subject[:network_name]).to eq network_name
+      end
+
+      it 'should read private key from the environment' do
+        expect(subject[:ssh_keys]).to eq ssh_keys
+      end
+
+      it 'should read api key from the environment' do
+        expect(subject[:api_key]).to eq api_key
+      end
+    end
+  end
+
+  describe '#compute' do
+    subject { described_class.new(setname, config, custom_prefabs_path, options).compute }
+    let(:connection) { Object.new }
+
+    it 'should retrieve connection to openstack compute' do
+      Fog::Compute.expects(:new).with({
+        :provider => :openstack,
+        :openstack_username => username,
+        :openstack_api_key => api_key,
+        :openstack_auth_url => endpoint,
+      }).returns connection
+      expect(subject).to equal connection
+    end
+
+    it 'should cache openstack connections' do
+      Fog::Compute.expects(:new).with({
+        :provider => :openstack,
+        :openstack_username => username,
+        :openstack_api_key => api_key,
+        :openstack_auth_url => endpoint,
+      }).once.returns connection
+      c = described_class.new(setname, config, custom_prefabs_path, options)
+      c.compute
+      c.compute
+    end
+  end
+
+  describe '#network' do
+    subject { described_class.new(setname, config, custom_prefabs_path, options).network }
+    let(:connection) { Object.new }
+
+    it 'should retrieve connection to openstack network' do
+      Fog::Network.expects(:new).with({
+        :provider => :openstack,
+        :openstack_username => username,
+        :openstack_api_key => api_key,
+        :openstack_auth_url => endpoint,
+      }).returns connection
+      expect(subject).to equal connection
+    end
+
+    it 'should cache connections' do
+      Fog::Network.expects(:new).with({
+        :provider => :openstack,
+        :openstack_username => username,
+        :openstack_api_key => api_key,
+        :openstack_auth_url => endpoint,
+      }).once.returns connection
+      c = described_class.new(setname, config, custom_prefabs_path, options)
+      c.network
+      c.network
+    end
+  end
+
+  describe '#launch' do
+    subject { described_class.new(setname, config, custom_prefabs_path, options) }
+
+    let(:compute) do
+      stub({
+        :flavors => [ stub(:id => flavor_id, :name => flavor_name) ],
+        :images => [ stub(:id => image_id, :name => image_name) ],
+        :servers => mock('servers')
+      })
+    end
+
+    let(:create_returns) do
+      { 'id' => machine_id }
+    end
+
+    let(:network) do
+      stub(:networks => [ stub(:id => network_id, :name => network_name) ])
+    end
+
+    let(:flavor_id) { 'flavor_123' }
+    let(:image_id) { 'image_123' }
+    let(:network_id) { 'network_123' }
+    let(:machine_id) { 'machine_123' }
+
+    before do
+      compute.servers.stubs(:create).returns create_returns
+      subject.stubs(:compute).returns compute
+      subject.stubs(:network).returns network
+    end
+
+    it 'should use the node\'s name' do
+      num = 1
+      compute.servers.expects(:create).with do |options|
+        expect(options[:name]).to match /^main-test#{num}-.+/
+        num += 1
+      end.twice.returns create_returns
+      subject.launch
+    end
+
+    it 'should lookup the flavor' do
+      compute.servers.expects(:create).twice.with do |options|
+        expect(options[:flavor_ref]).to eq flavor_id
+      end.returns create_returns
+      subject.launch
+    end
+
+    it 'should lookup the image' do
+      compute.servers.expects(:create).twice.with do |options|
+        expect(options[:image_ref]).to eq image_id
+      end.returns create_returns
+      subject.launch
+    end
+
+    it 'should use the correct ssh keypair name' do
+      compute.servers.expects(:create).twice.with do |options|
+        expect(options[:key_name]).to eq keypair_name
+      end.returns create_returns
+      subject.launch
+    end
+
+    it 'should use the correct network id' do
+      compute.servers.expects(:create).twice.with do |options|
+        nics = options[:nics]
+        expect(nics[0]['net_id']).to eq network_id
+      end.returns create_returns
+      subject.launch
+    end
+
+    it 'should assign server to rs_storage' do
+      subject.launch
+      expect(rs_storage[:nodes]['main-test1'][:server]).to equal create_returns
+    end
+  end
+
+  describe '#connect' do
+    let(:servers) do
+      [
+        stub(:addresses => { 'test-network_name' => [{'addr' => 'address1'}]}),
+        stub(:addresses => { 'test-network_name' => [{'addr' => 'address2'}]})
+      ]
+    end
+
+    let(:rs_storage) do
+      {
+        :nodes =>
+        {
+          'main-test1' => {},
+          'main-test2' => {}
+        }
+      }
+    end
+
+    before do
+      rs_storage[:nodes]['main-test1'][:server] = servers[0]
+      rs_storage[:nodes]['main-test2'][:server] = servers[1]
+
+      servers.each do |x|
+        x.stubs(:wait_for).returns true
+      end
+      subject.stubs(:ssh_connect)
+    end
+
+    it 'should call ready? for each server' do
+      servers[0].expects(:wait_for).returns true
+      servers[1].expects(:wait_for).returns true
+
+      subject.connect
+    end
+
+    it 'should retry if Fog throws a timeout' do
+      servers[0].expects(:wait_for).raises(::Fog::Errors::TimeoutError.new).then.returns true
+      subject.connect
+    end
+
+    context 'with node timeout = 1' do
+      let(:node_timeout) { 1 }
+      it 'should give up after more than 1 second' do
+        servers[0].stubs(:wait_for).with do
+          sleep 1.25
+          raise ::Fog::Errors::TimeoutError.new
+        end
+
+        expect {subject.connect}.to raise_error ::Fog::Errors::TimeoutError
+      end
+
+      it 'should retry after less than 1 second' do
+        first_time = true
+        called_twice = false
+        servers[0].stubs(:wait_for).with do
+          if first_time
+            first_time = false
+            raise ::Fog::Errors::TimeoutError.new
+          else
+            called_twice = true
+          end
+        end
+        subject.connect
+        expect(called_twice).to be_true
+      end
+
+      it 'should connect though ssh as root' do
+        subject.expects(:ssh_connect).with do |options|
+          expect(options[:user]).to eq 'root'
+        end
+        subject.connect
+      end
+
+      it 'should disable ssh paranoid' do
+        subject.expects(:ssh_connect).with do |options|
+          expect(options[:net_ssh_options][:paranoid]).to eq false
+        end
+        subject.connect
+      end
+
+      it 'should connect though ssh using the private key' do
+        subject.expects(:ssh_connect).with do |options|
+          expect(options[:net_ssh_options][:keys]).to eq [ssh_keys]
+        end
+        subject.connect
+      end
+
+      it 'should connect through ssh to each node\'s address' do
+        subject.expects(:ssh_connect).with do |options|
+          if options[:host] == 'main-test1'
+            address = 'address1'
+          else
+            address = 'address2'
+          end
+          expect(options[:net_ssh_options][:host_name]).to eq address
+        end
+        subject.connect
+      end
+    end
+  end
+
+  describe '#teardown' do
+    let(:servers) do
+      [
+        stub(:name => 'server 1'),
+        stub(:name => 'server 2')
+      ]
+    end
+
+    let(:rs_storage) do
+      {
+        :nodes =>
+        {
+          'main-test1' => {:server => servers[0]},
+          'main-test2' => {:server => servers[1]}
+        }
+      }
+    end
+
+    it 'should call #destroy on each server' do
+      servers[0].expects(:destroy)
+      servers[1].expects(:destroy)
+
+      subject.teardown
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-system
 version: !ruby/object:Gem::Version
-  version: 2.7.2
+  version: 2.8.0
 platform: ruby
 authors:
 - Ken Barber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-13 00:00:00.000000000 Z
+date: 2013-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -108,6 +108,34 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.5.10
+- !ruby/object:Gem::Dependency
+  name: fog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.18'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.16'
 description: 
 email:
 - info@puppetlabs.com
@@ -144,6 +172,7 @@ files:
 - lib/rspec-system/node.rb
 - lib/rspec-system/node_set.rb
 - lib/rspec-system/node_set/base.rb
+- lib/rspec-system/node_set/openstack.rb
 - lib/rspec-system/node_set/vagrant_base.rb
 - lib/rspec-system/node_set/vagrant_virtualbox.rb
 - lib/rspec-system/node_set/vagrant_vmware_fusion.rb
@@ -171,6 +200,7 @@ files:
 - spec/unit/helper_spec.rb
 - spec/unit/kwalify-schemas/nodeset_schema_spec.rb
 - spec/unit/kwalify-schemas/prefabs_schema_spec.rb
+- spec/unit/openstack_spec.rb
 - spec/unit/result_spec.rb
 - spec/unit/utils_spec.rb
 homepage: https://github.com/puppetlabs/rspec-system
@@ -205,5 +235,6 @@ test_files:
 - spec/unit/helper_spec.rb
 - spec/unit/kwalify-schemas/nodeset_schema_spec.rb
 - spec/unit/kwalify-schemas/prefabs_schema_spec.rb
+- spec/unit/openstack_spec.rb
 - spec/unit/result_spec.rb
 - spec/unit/utils_spec.rb