beaker-openstack 0.2.0 → 0.3.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MDJjYjZkYjUwOTBmOWQyZDg5ZDU2YTU3MjFiNDBmNDQzN2U0M2Q1NA==
-  data.tar.gz: !binary |-
-    ZTRlZjczNzlhNDIxYmJlYzNlZDdmMjQ3YWMxMjIyOWRkYzc2NTFmMg==
+SHA1:
+  metadata.gz: d6633df09acdbb5609695abe943b7d8ca80d4793
+  data.tar.gz: b121d5093ba7cb858cf96854949ada97ae53aacf
 SHA512:
-  metadata.gz: !binary |-
-    OWJhMGI4YjAxMDAwY2QxZjMwMzY5ZjE5ZTU4NmMyNzU4MDc4NzExYTllZDEy
-    NTViZjFmZjhiZGMyMjVhYzlkYzE5MDQyMDlhYjAzM2ZkOTk2YWFmZDQxMTA0
-    MDU3OWVjYzQzNjIyZjE0ZjM2ZjgwZjIyM2JjMzE0OWI0YTU4ZTM=
-  data.tar.gz: !binary |-
-    YzZlYWFhMzY0MjUxNzI4NmVlYWE1ZDlmNGM4N2Q0NTNmMDY2Y2JjZWIyODA4
-    YzcyMGY0OTRjMzFhN2VjYjliNTk2NjRkZjIwMTRiMmFmMDk5NDM1YjU2ODQy
-    YTk2MmI0YzI1ZmMwMzBhYzg1Y2I4OTQ4ZGYwYjRkNzIxZmUwMjY=
+  metadata.gz: 6f9ad76c1b51b2ac3e190ecf931fea129b308f7bac7f6573f89b1956c4d7f7ad7237f09a22ea0619b82b9ae5662e230614700b906f334cc564d198947438543f
+  data.tar.gz: 88e8e676509fa13b677597e773719b850691ba4eed0581748a6318edfe1c7a9ae843eefe7c5d185d623b1a58ac49f3cacbf285660a1e3db7a1552511f00d57f5

data/.gitignore

@@ -23,4 +23,5 @@ doc
 # Vagrant folder
 .vagrant/
 .vagrant_files/
-sut-files.tgz
+sut-files.tgz
+vendor/

data/README.md

@@ -6,16 +6,24 @@ Beaker library to use openstack hypervisor
 
 This gem that allows you to use hosts with [openstack](openstack.md) hypervisor with [beaker](https://github.com/puppetlabs/beaker). 
 
-### Right Now? (beaker 3.x)
+Beaker will automatically load the appropriate hypervisors for any given hosts file, so as long as your project dependencies are satisfied there's nothing else to do. No need to `require` this library in your tests.
 
-This gem is already included as [beaker dependency](https://github.com/puppetlabs/beaker/blob/master/beaker.gemspec) for you, so you don't need to do anything special to use this gem's functionality with beaker.
+## With Beaker 3.x
 
-### In beaker's Next Major Version? (beaker 4.x)
+This library is included as a dependency of Beaker 3.x versions, so there's nothing to do.
 
-In beaker's next major version, the requirement for beaker-openstack will be pulled
-from that repo. When that happens, then the usage pattern will change. In order
-to use this then, you'll need to include beaker-openstack as a dependency right
-next to beaker itself.
+## With Beaker 4.x
+
+As of Beaker 4.0, all hypervisor and DSL extension libraries have been removed and are no longer dependencies. In order to use a specific hypervisor or DSL extension library in your project, you will need to include them alongside Beaker in your Gemfile or project.gemspec. E.g.
+
+~~~ruby
+# Gemfile
+gem 'beaker', '~>4.0'
+gem 'beaker-aws'
+# project.gemspec
+s.add_runtime_dependency 'beaker', '~>4.0'
+s.add_runtime_dependency 'beaker-aws'
+~~~
 
 # Spec tests
 

data/beaker-openstack.gemspec

@@ -20,7 +20,12 @@ Gem::Specification.new do |s|
   # Testing dependencies
   s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'rspec-its'
-  s.add_development_dependency 'fakefs', '~> 0.6'
+  # pin fakefs for Ruby < 2.3
+  if RUBY_VERSION < "2.3"
+    s.add_development_dependency 'fakefs', '~> 0.6', '< 0.14'
+  else
+    s.add_development_dependency 'fakefs', '~> 0.6'
+  end
   s.add_development_dependency 'rake', '~> 10.1'
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'pry', '~> 0.10'
@@ -32,7 +37,7 @@ Gem::Specification.new do |s|
 
   # Run time dependencies
   s.add_runtime_dependency 'stringify-hash', '~> 0.0.0'
-  s.add_runtime_dependency 'fog-openstack', '>= 0'
+  s.add_runtime_dependency 'fog-openstack', '~> 1.0.0'
 
 end
 

data/lib/beaker-openstack/version.rb

@@ -1,3 +1,3 @@
 module BeakerOpenstack
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/beaker/hypervisor/openstack.rb

@@ -12,9 +12,11 @@ module Beaker
     #@option options [String] :openstack_api_key The key to access the OpenStack instance with (required)
     #@option options [String] :openstack_username The username to access the OpenStack instance with (required)
     #@option options [String] :openstack_auth_url The URL to access the OpenStack instance with (required)
-    #@option options [String] :openstack_tenant The tenant to access the OpenStack instance with (required)
+    #@option options [String] :openstack_tenant The tenant to access the OpenStack instance with (either this or openstack_project_name is required)
+    #@option options [String] :openstack_project_name The project name to access the OpenStack instance with (either this or openstack_tenant is required)
     #@option options [String] :openstack_region The region that each OpenStack instance should be provisioned on (optional)
     #@option options [String] :openstack_network The network that each OpenStack instance should be contacted through (required)
+    #@option options [Bool] :openstack_floating_ip Whether a floating IP should be allocated (required)
     #@option options [String] :openstack_keyname The name of an existing key pair that should be auto-loaded onto each
     #@option options [Hash] :security_group An array of security groups to associate with the instance
     #                                            OpenStack instance (optional)
@@ -32,8 +34,21 @@ module Beaker
       raise 'You must specify an Openstack API key (:openstack_api_key) for OpenStack instances!' unless @options[:openstack_api_key]
       raise 'You must specify an Openstack username (:openstack_username) for OpenStack instances!' unless @options[:openstack_username]
       raise 'You must specify an Openstack auth URL (:openstack_auth_url) for OpenStack instances!' unless @options[:openstack_auth_url]
-      raise 'You must specify an Openstack tenant (:openstack_tenant) for OpenStack instances!' unless @options[:openstack_tenant]
       raise 'You must specify an Openstack network (:openstack_network) for OpenStack instances!' unless @options[:openstack_network]
+      raise 'You must specify whether a floating IP (:openstack_floating_ip) should be used for OpenStack instances!' unless !@options[:openstack_floating_ip].nil?
+
+      is_v3 = @options[:openstack_auth_url].include?('/v3/')
+      raise 'You must specify an Openstack project name (:openstack_project_name) for OpenStack instances!' if is_v3 and !@options[:openstack_project_name]
+      raise 'You must specify an Openstack tenant (:openstack_tenant) for OpenStack instances!' if !is_v3 and !@options[:openstack_tenant]
+      raise 'Invalid option specified: v3 API expects :openstack_project_name, not :openstack_tenant for OpenStack instances!' if is_v3 and @options[:openstack_tenant]
+      raise 'Invalid option specified: v2 API expects :openstack_tenant, not :openstack_project_name for OpenStack instances!' if !is_v3 and @options[:openstack_project_name]
+
+      # Keystone version 3 changed the parameter names
+      if !is_v3
+        extra_credentials = {:openstack_tenant => @options[:openstack_tenant]}
+      else
+        extra_credentials = {:openstack_project_name => @options[:openstack_project_name]}
+      end
 
       # Common keystone authentication credentials
       @credentials = {
@@ -43,10 +58,10 @@ module Beaker
         :openstack_username => @options[:openstack_username],
         :openstack_tenant   => @options[:openstack_tenant],
         :openstack_region   => @options[:openstack_region],
-      }
+      }.merge(extra_credentials)
 
       # Keystone version 3 requires users and projects to be scoped
-      if @credentials[:openstack_auth_url].include?('/v3/')
+      if is_v3
         @credentials[:openstack_user_domain]    = @options[:openstack_user_domain] || 'Default'
         @credentials[:openstack_project_domain] = @options[:openstack_project_domain] || 'Default'
       end
@@ -54,13 +69,13 @@ module Beaker
       @compute_client ||= Fog::Compute.new(@credentials)
 
       if not @compute_client
-        raise "Unable to create OpenStack Compute instance (api key: #{@options[:openstack_api_key]}, username: #{@options[:openstack_username]}, auth_url: #{@options[:openstack_auth_url]}, tenant: #{@options[:openstack_tenant]})"
+        raise "Unable to create OpenStack Compute instance (api key: #{@options[:openstack_api_key]}, username: #{@options[:openstack_username]}, auth_url: #{@options[:openstack_auth_url]}, tenant: #{@options[:openstack_tenant]}, project_name: #{@options[:openstack_project_name]})"
       end
 
       @network_client ||= Fog::Network.new(@credentials)
 
       if not @network_client
-        raise "Unable to create OpenStack Network instance (api_key: #{@options[:openstack_api_key]}, username: #{@options[:openstack_username]}, auth_url: #{@options[:openstack_auth_url]}, tenant: #{@options[:openstack_tenant]})"
+        raise "Unable to create OpenStack Network instance (api key: #{@options[:openstack_api_key]}, username: #{@options[:openstack_username]}, auth_url: #{@options[:openstack_auth_url]}, tenant: #{@options[:openstack_tenant]}, project_name: #{@options[:openstack_project_name]})"
       end
 
       # Validate openstack_volume_support setting value, reset to boolean if passed via ENV value string
@@ -197,17 +212,19 @@ module Beaker
 
     # Get a floating IP address to associate with the instance, try
     # to allocate a new one from the specified pool if none are available
-    def get_ip
+    #
+    # TODO(GiedriusS): convert to use @network_client. This API will be turned off
+    # completely very soon.
+    def get_floating_ip
       begin
         @logger.debug "Creating IP"
         ip = @compute_client.addresses.create
-      rescue Fog::Compute::OpenStack::NotFound
+      rescue Fog::OpenStack::Compute::NotFound
         # If there are no more floating IP addresses, allocate a
-        # new one and try again. 
+        # new one and try again.
         @compute_client.allocate_address(@options[:floating_ip_pool])
         ip = @compute_client.addresses.find { |ip| ip.instance_id.nil? }
       end
-      raise 'Could not find or allocate an address' if not ip
       ip
     end
 
@@ -216,9 +233,15 @@ module Beaker
       @logger.notify "Provisioning OpenStack"
 
       @hosts.each do |host|
-        ip = get_ip
-        hostname = ip.ip.gsub('.','-')
-        host[:vmhostname] = hostname + '.rfc1918.puppetlabs.net'
+        if @options[:openstack_floating_ip]
+          ip = get_floating_ip
+          hostname = ip.ip.gsub('.','-')
+          host[:vmhostname] = hostname + '.rfc1918.puppetlabs.net'
+        else
+          hostname = ('a'..'z').to_a.shuffle[0, 10].join
+          host[:vmhostname] = hostname
+        end
+
         create_or_associate_keypair(host, hostname)
         @logger.debug "Provisioning #{host.name} (#{host[:vmhostname]})"
         options = {
@@ -252,9 +275,15 @@ module Beaker
           try += 1
         end
 
-        # Associate a public IP to the server
-        ip.server = vm
-        host[:ip] = ip.ip
+        if @options[:openstack_floating_ip]
+          # Associate a public IP to the VM
+          ip.server = vm
+          host[:ip] = ip.ip
+        else
+          # Get the first address of the VM that was just created just like in the
+          # OpenStack UI
+          host[:ip] = vm.addresses.first[1][0]["addr"]
+        end
 
         @logger.debug "OpenStack host #{host.name} (#{host[:vmhostname]}) assigned ip: #{host[:ip]}"
 

data/spec/beaker/hypervisor/openstack_spec.rb

@@ -4,7 +4,7 @@ require 'fog/openstack'
 module Beaker
   describe Openstack do
 
-    let(:options) { make_opts.merge({'logger' => double().as_null_object}) }
+    let(:options) { make_opts.merge({'logger' => double().as_null_object, 'openstack_floating_ip' => true}) }
 
     let(:openstack) {
       Openstack.new(@hosts, options)
@@ -30,10 +30,14 @@ module Beaker
       it 'supports keystone v3 with implicit arguments' do
         v3_options = options
         v3_options[:openstack_auth_url] = 'https://example.com/identity/v3/auth'
+        v3_options[:openstack_project_name] = 'TeamTest_ab_c'
+        v3_options[:openstack_tenant] = nil
 
         credentials = Openstack.new(@hosts, v3_options).instance_eval('@credentials')
         expect(credentials[:openstack_user_domain]).to eq('Default')
         expect(credentials[:openstack_project_domain]).to eq('Default')
+        expect(credentials[:openstack_project_name]).to eq('TeamTest_ab_c')
+        expect(credentials[:openstack_tenant]).to be_nil
       end
 
       it 'supports keystone v3 with explicit arguments' do
@@ -41,10 +45,14 @@ module Beaker
         v3_options[:openstack_auth_url] = 'https://example.com/identity/v3/auth'
         v3_options[:openstack_user_domain] = 'acme.com'
         v3_options[:openstack_project_domain] = 'R&D'
+        v3_options[:openstack_project_name] = 'Team_test_abc'
+        v3_options[:openstack_tenant] = nil
 
         credentials = Openstack.new(@hosts, v3_options).instance_eval('@credentials')
         expect(credentials[:openstack_user_domain]).to eq('acme.com')
         expect(credentials[:openstack_project_domain]).to eq('R&D')
+        expect(credentials[:openstack_project_name]).to eq('Team_test_abc')
+        expect(credentials[:openstack_tenant]).to be_nil
       end
     end
 
@@ -102,7 +110,7 @@ module Beaker
         # Simulate getting a dynamic IP from OpenStack to test key generation code
         # after provisioning. See _validate_new_key_pair in openstack/nova for reference
         mock_ip = double().as_null_object
-        allow( openstack ).to receive( :get_ip ).and_return( mock_ip )
+        allow( openstack ).to receive( :get_floating_ip ).and_return( mock_ip )
         allow( mock_ip ).to receive( :ip ).and_return( '172.16.0.1' )
         openstack.instance_eval('@options')['openstack_keyname'] = nil
 
@@ -117,7 +125,7 @@ module Beaker
         end
       end
 
-      it 'get_ip always allocates a new floatingip' do
+      it 'get_floating_ip always allocates a new floatingip' do
         # Assume beaker is being executed in parallel N times by travis (or similar).
         # IPs are allocated (but not associated) before an instance is created; it is
         # hightly possible the first instance will allocate a new IP and create an ssh
@@ -130,7 +138,7 @@ module Beaker
         allow(@compute_client).to receive(:addresses).and_return(mock_addresses)
         allow(mock_addresses).to receive(:create).and_return(mock_ip)
         expect(mock_addresses).to receive(:create).exactly(3).times
-        (1..3).each { openstack.get_ip }
+        (1..3).each { openstack.get_floating_ip }
       end
 
       context 'volume creation option' do

metadata

@@ -1,169 +1,169 @@
 --- !ruby/object:Gem::Specification
 name: beaker-openstack
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Rishi Javia, Kevin Imber, Tony Vu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-09 00:00:00.000000000 Z
+date: 2019-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: fakefs
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: markdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: thin
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: stringify-hash
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.0
 - !ruby/object:Gem::Dependency
   name: fog-openstack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
 description: For use for the Beaker acceptance testing tool
 email:
 - rishi.javia@puppet.com, kevin.imber@puppet.com, tony.vu@puppet.com
@@ -172,8 +172,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .simplecov
+- ".gitignore"
+- ".simplecov"
 - Gemfile
 - LICENSE
 - README.md
@@ -195,17 +195,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Beaker DSL Extension Helpers!