beaker-vmpooler 1.2.0 → 1.4.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NGM3ODk5NTJiZTVlNWUwZjliMjAxMTgyNmM0NWZkYjEzNmUzYmJlNw==
-  data.tar.gz: !binary |-
-    ZjI4NTIxYzg4ZmVhYzE3ZTc4NjcxOGUwMDdiMjBhOWNlMjE1MTUyMA==
+SHA256:
+  metadata.gz: 6d1691a4a15f960385c5d8041e285b4fc23f45f33996e8bf71d165f066256e68
+  data.tar.gz: cf3cc37f0a2cb87cc8b1df85dafde1a5ac0e64de4fec80ebbe00d7be96e6afae
 SHA512:
-  metadata.gz: !binary |-
-    YzM3NjEyMzAwM2YxN2RhM2Y2MWNiNmIwYjYxNmVhOGFjYWE1NWY2OGI2ZTBh
-    NmZjMTQ3ZDZiMjk5NDU3NWRiNTk1ZTQ0MmQ4OGQzNDE1ZGVhMGIyNzhiODEx
-    NDliZWY3N2FkMzRkMDc2ZDIzODQyMTYwMDUyZDZlZTNiOGI0MTI=
-  data.tar.gz: !binary |-
-    NmUyYTc2ZDg2YmM4MmI5YzI0NTE1Yjc5YTlhZjFkNDk1NGM4MDIzMzBmNDIx
-    MzRjMTI3ZDhkMmYwOTQ5NTkwZWMwNjU5OWIyYWMwYmY5YTEzODZlMDBkZjll
-    YWEzZTI0YWVmM2M0NGFmZjYzNWI1MzJiNDBlMTQ2YzNhZmIwM2I=
+  metadata.gz: 2e4dc2ae575c94cdacc891ceefdff027d7e6524bb209475e8b802adfbbcf266f856cc76b60ed9b8b305dcbecbe33c25679b17d8b9a792015f37b2b0dc7989f4d
+  data.tar.gz: 26d647464683ff718032126a19b50c7d072c0c6a34771b9237cb9ae543929ac42f8cc81cd02ba8aee6155eeaff56ec98dc48d07b7e2649b21b6b8b60dae6481b

data/.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "13:00"
+  open-pull-requests-limit: 10

data/.github/workflows/test.yml

@@ -0,0 +1,26 @@
+name: Test
+
+on:
+  - pull_request
+  - push
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - "2.5"
+          - "2.6"
+          - "2.7"
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rake test:spec

data/CODEOWNERS

@@ -0,0 +1 @@
+* @puppetlabs/beaker

data/Gemfile

@@ -1,6 +1,6 @@
 source ENV['GEM_SOURCE'] || "https://rubygems.org"
 
-gemspec
+gemspec :development_group => :acceptance_testing
 
 
 
@@ -18,8 +18,8 @@ end
 # We don't put beaker in as a test dependency because we
 # don't want to create a transitive dependency
 group :acceptance_testing do
-  gem "beaker", *location_for(ENV['BEAKER_VERSION'] || '~> 3.0')
-  gem "beaker-abs", *location_for(ENV['ABS_VERSION'] || '~> 0.3.0')
+  gem "beaker", *location_for(ENV['BEAKER_VERSION'] || '~> 4.0')
+  gem "beaker-abs"
 end
 
 

data/README.md

@@ -3,8 +3,27 @@
 Beaker library to use vmpooler hypervisor
 
 # How to use this wizardry
- 
-This is a gem that allows you to use hosts with [vmpooler](vmpooler.md) hypervisor with [beaker](https://github.com/puppetlabs/beaker). This gem is already included as [beaker dependency](https://github.com/puppetlabs/beaker/blob/master/beaker.gemspec#L59) for you, so you don't need to do anything special to use this gem's functionality with beaker.
+
+This is a gem that allows you to use hosts with [vmpooler](vmpooler.md) hypervisor with [beaker](https://github.com/puppetlabs/beaker).
+
+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.
+
+## With Beaker 3.x
+
+This library is included as a dependency of Beaker 3.x versions, so there's nothing to do.
+
+## 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-vmpooler'
+# project.gemspec
+s.add_runtime_dependency 'beaker', '~>4.0'
+s.add_runtime_dependency 'beaker-vmpooler'
+~~~
 
 # Spec tests
 

data/beaker-vmpooler.gemspec

@@ -20,8 +20,13 @@ 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'
-  s.add_development_dependency 'rake', '~> 10.1'
+  # 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', '~> 13.0'
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'pry', '~> 0.10'
 

data/lib/beaker-vmpooler/version.rb

@@ -1,3 +1,3 @@
 module BeakerVmpooler
-  VERSION = '1.2.0'
+  VERSION = '1.4.0'
 end

data/lib/beaker/hypervisor/vmpooler.rb

@@ -27,33 +27,21 @@ module Beaker
 
     def load_credentials(dot_fog = '.fog')
       creds = {}
-
-      if fog = read_fog_file(dot_fog)
-        if fog[:default] && fog[:default][:vmpooler_token]
-          creds[:vmpooler_token] = fog[:default][:vmpooler_token]
+      begin
+        fog = get_fog_credentials(dot_fog)
+        if fog[:vmpooler_token]
+          creds[:vmpooler_token] = fog[:vmpooler_token]
         else
-          @logger.warn "Credentials file (#{dot_fog}) is missing a :default section with a :vmpooler_token value; proceeding without authentication"
+          @logger.warn "vmpooler_token not found in credentials file (#{dot_fog})\nProceeding without authentication"
         end
-      else
-        @logger.warn "Credentials file (#{dot_fog}) is empty; proceeding without authentication"
+      rescue ArgumentError => e
+        @logger.warn "Invalid credentials file:\n(#{e.class}) #{e.message}\nProceeding without authentication"
       end
-
       creds
-
-    rescue TypeError, Psych::SyntaxError => e
-      @logger.warn "#{e.class}: Credentials file (#{dot_fog}) has invalid syntax; proceeding without authentication"
-      creds
-    rescue Errno::ENOENT
-      @logger.warn "Credentials file (#{dot_fog}) not found; proceeding without authentication"
-      creds
-    end
-
-    def read_fog_file(dot_fog = '.fog')
-      YAML.load_file(dot_fog)
     end
 
     def connection_preference(host)
-      ['vmhostname', 'ip', 'hostname']
+      [:vmhostname, :ip, :hostname]
     end
 
     def check_url url
@@ -126,6 +114,7 @@ module Beaker
         uri = URI.parse(@options['pooling_api'] + '/vm/')
 
         http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = uri.instance_of?(URI::HTTPS)
         request = Net::HTTP::Post.new(uri.request_uri)
 
         if @credentials[:vmpooler_token]
@@ -181,7 +170,7 @@ module Beaker
           @logger.debug("Retrying provision for vmpooler host after waiting #{wait} second(s)")
           sleep wait
           waited += wait
-          last_wait, wait = wait, last_wait + wait
+          last_wait, wait = wait, [last_wait + wait, 15].min + rand(5)
           retry
         end
         report_and_raise(@logger, e, 'Vmpooler.provision')
@@ -197,6 +186,7 @@ module Beaker
           uri = URI.parse(@options[:pooling_api] + '/vm/' + h['vmhostname'].split('.')[0])
 
           http = Net::HTTP.new(uri.host, uri.port)
+          http.use_ssl = uri.instance_of?(URI::HTTPS)
           request = Net::HTTP::Put.new(uri.request_uri)
 
           # merge pre-defined tags with host tags
@@ -262,6 +252,7 @@ module Beaker
         uri = URI.parse(get_template_url(@options['pooling_api'], name))
 
         http = Net::HTTP.new( uri.host, uri.port )
+        http.use_ssl = uri.instance_of?(URI::HTTPS)
         request = Net::HTTP::Delete.new(uri.request_uri)
 
         if @credentials[:vmpooler_token]
@@ -289,6 +280,7 @@ module Beaker
         uri = URI.parse(@options[:pooling_api] + '/api/v1/vm/' + hostname + '/disk/' + disk_size.to_s)
 
         http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = uri.instance_of?(URI::HTTPS)
         request = Net::HTTP::Post.new(uri.request_uri)
         request['X-AUTH-TOKEN'] = @credentials[:vmpooler_token]
 
@@ -321,6 +313,7 @@ module Beaker
         uri = URI.parse(@options[:pooling_api] + '/vm/' + hostname)
 
         http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = uri.instance_of?(URI::HTTPS)
         request = Net::HTTP::Get.new(uri.request_uri)
 
         response = http.request(request)

data/spec/beaker/hypervisor/vmpooler_spec.rb

@@ -4,11 +4,8 @@ module Beaker
   describe Vmpooler do
 
     before :each do
-      vms = make_hosts()
-      MockVsphereHelper.set_config( fog_file_contents )
-      MockVsphereHelper.set_vms( vms )
-      stub_const( "VsphereHelper", MockVsphereHelper )
       stub_const( "Net", MockNet )
+      allow_any_instance_of(MockNet::HTTP).to receive(:use_ssl=)
       allow( JSON ).to receive( :parse ) do |arg|
         arg
       end
@@ -147,20 +144,15 @@ module Beaker
     describe "#cleanup" do
 
       it "cleans up hosts in the pool" do
-        MockVsphereHelper.powerOn
-
+        mock_http = MockNet::HTTP.new( "host", "port" )
         vmpooler = Beaker::Vmpooler.new( make_hosts, make_opts )
-        allow( vmpooler ).to receive( :require ).and_return( true )
-        allow( vmpooler ).to receive( :sleep ).and_return( true )
         vmpooler.provision
-        vmpooler.cleanup
+        vm_count = vmpooler.instance_variable_get( :@hosts ).count
 
-        hosts = vmpooler.instance_variable_get( :@hosts )
-        hosts.each do | host |
-          name = host.name
-          vm = MockVsphereHelper.find_vm( name )
-          expect( vm.runtime.powerState ).to be === "poweredOn" #handed back to the pool, stays on
-        end
+        expect( Net::HTTP ).to receive( :new ).exactly( vm_count ).times.and_return( mock_http )
+        expect( mock_http ).to receive( :request ).exactly( vm_count ).times
+        expect( Net::HTTP::Delete ).to receive( :new ).exactly( vm_count ).times
+        expect{ vmpooler.cleanup }.to_not raise_error
       end
     end
   end
@@ -168,10 +160,6 @@ module Beaker
   describe Vmpooler do
 
     before :each do
-      vms = make_hosts()
-      MockVsphereHelper.set_config( fog_file_contents )
-      MockVsphereHelper.set_vms( vms )
-      stub_const( "VsphereHelper", MockVsphereHelper )
       stub_const( "Net", MockNet )
       allow( JSON ).to receive( :parse ) do |arg|
         arg
@@ -181,95 +169,38 @@ module Beaker
 
     describe "#load_credentials" do
 
-      it 'continues without credentials when fog file is missing' do
-        allow_any_instance_of( Beaker::Vmpooler ).to \
-          receive(:read_fog_file).and_raise(Errno::ENOENT.new)
-
-        vmpooler = Beaker::Vmpooler.new( make_hosts, make_opts )
-        expect( vmpooler.credentials ).to be == {}
-      end
-
-      it 'continues without credentials when fog file is empty' do
-        allow_any_instance_of( Beaker::Vmpooler ).to \
-          receive(:read_fog_file).and_return(false)
-
-        vmpooler = Beaker::Vmpooler.new( make_hosts, make_opts )
-        expect( vmpooler.credentials ).to be == {}
-      end
-
-      it 'continues without credentials when fog file contains no :default section' do
-        data = { :some => { :other => :data } }
+      it 'loads credentials from a fog file' do
+        credentials = { :vmpooler_token => "example_token" }
+        make_opts = { :dot_fog => '.fog' }
 
-        allow_any_instance_of( Beaker::Vmpooler ).to \
-          receive(:read_fog_file).and_return(data)
+        expect_any_instance_of( Beaker::Vmpooler ).to receive( :get_fog_credentials ).and_return(credentials)
 
         vmpooler = Beaker::Vmpooler.new( make_hosts, make_opts )
-        expect( vmpooler.credentials ).to be == { }
+        expect( vmpooler.credentials ).to be == credentials
       end
 
-      it 'continues without credentials when fog file :default section has no :vmpooler_token' do
-        data = { :default => { :something_else => "TOKEN" } }
+      it 'continues without credentials when there are problems loading the fog file' do
+        logger = double( 'logger' )
+        make_opts = { :logger => logger, :dot_fog => '.fog' }
 
-        allow_any_instance_of( Beaker::Vmpooler ).to \
-          receive(:read_fog_file).and_return(data)
+        expect_any_instance_of( Beaker::Vmpooler ).to receive( :get_fog_credentials ).and_raise( ArgumentError, 'something went wrong' )
+        expect( logger ).to receive( :warn ).with( /Invalid credentials file.*something went wrong.*Proceeding without authentication/m )
 
         vmpooler = Beaker::Vmpooler.new( make_hosts, make_opts )
-        expect( vmpooler.credentials ).to be == { }
-      end
-
-      it 'continues without credentials when there are formatting errors in the fog file' do
-        data = { "'default'" => { :vmpooler_token => "b2wl8prqe6ddoii70md" } }
-
-        allow_any_instance_of( Beaker::Vmpooler ).to \
-          receive(:read_fog_file).and_return(data)
-
-        logger = double('logger')
 
-        expect(logger).to receive(:warn).with(/is missing a :default section with a :vmpooler_token value/)
-        make_opts = {:logger => logger}
-
-        vmpooler = Beaker::Vmpooler.new( make_hosts, make_opts )
-        expect( vmpooler.credentials ).to be == { }
+        expect( vmpooler.credentials ).to be == {}
       end
 
-      it 'throws a TypeError and continues without credentials when there are syntax errors in the fog file' do
-        data = "'default'\n  :vmpooler_token: z2wl8prqe0ddoii70ad"
+      it 'continues without credentials when fog file has no vmpooler_token' do
+        logger = double( 'logger' )
+        make_opts = { :logger => logger, :dot_fog => '.fog' }
 
-        allow( File ).to receive( :open ).and_yield( StringIO.new(data)  )
-        logger = double('logger')
-
-        expect(logger).to receive(:warn).with(/TypeError: .* has invalid syntax/)
-        make_opts = {:logger => logger}
+        expect_any_instance_of( Beaker::Vmpooler ).to receive( :get_fog_credentials ).and_return( {} )
+        expect( logger ).to receive( :warn ).with( /vmpooler_token not found in credentials file.*Proceeding without authentication/m )
 
         vmpooler = Beaker::Vmpooler.new( make_hosts, make_opts )
 
-        expect( vmpooler.credentials ).to be == { }
-      end
-
-      it 'throws a Psych::SyntaxError and continues without credentials when there are syntax errors in the fog file' do
-
-        data = ";default;\n  :vmpooler_token: z2wl8prqe0ddoii707d"
-
-        allow( File ).to receive( :open ).and_yield( StringIO.new(data)  )
-
-        logger = double('logger')
-
-        expect(logger).to receive(:warn).with(/Psych::SyntaxError: .* invalid syntax/)
-        make_opts = {:logger => logger}
-
-        vmpooler = Beaker::Vmpooler.new( make_hosts, make_opts )
-
-        expect( vmpooler.credentials ).to be == { }
-      end
-
-      it 'stores vmpooler token when found in fog file' do
-        data = { :default => { :vmpooler_token => "TOKEN" } }
-
-        allow_any_instance_of( Beaker::Vmpooler ).to \
-          receive(:read_fog_file).and_return(data)
-
-        vmpooler = Beaker::Vmpooler.new( make_hosts, make_opts )
-        expect( vmpooler.credentials ).to be == { :vmpooler_token => "TOKEN" }
+        expect( vmpooler.credentials ).to be == {}
       end
     end
   end

metadata

@@ -1,153 +1,153 @@
 --- !ruby/object:Gem::Specification
 name: beaker-vmpooler
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Rishi Javia, Kevin Imber, Tony Vu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-04 00:00:00.000000000 Z
+date: 2021-06-15 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'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: '13.0'
 - !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
 description: For use for the Beaker acceptance testing tool
@@ -158,9 +158,12 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .simplecov
+- ".github/dependabot.yml"
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rspec"
+- ".simplecov"
+- CODEOWNERS
 - Gemfile
 - LICENSE
 - README.md
@@ -182,17 +185,16 @@ 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: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Beaker DSL Extension Helpers!