beaker-openstack 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec8d2595a3b94ae10ba8dbc5b29529506c36c5133b3fa56ae93a1f52d07d9686
-  data.tar.gz: 0d7518b15835c1b50b8a33e58a739e56a4d76a5c6593f17a64daa12592f915f0
+  metadata.gz: c5432c86653f848d141b7170b2f434bdd9479268956aad4dd821bfbb4f66eed7
+  data.tar.gz: a3e397ec1d79f453858d00e641211feaeef426f55bc95ee99ac3e5bdfcf60151
 SHA512:
-  metadata.gz: bc97fe129ef779dd643011e1a5b9f55c99c3f92659d397019a657dadf45da0364872f0eab3b32fb195561ff02e65e63e2a41e2d2a51e25d6bc8c90fbdd58f9a6
-  data.tar.gz: 14b0b253f8008aa4729257fa46cfc1e47a05436fe9bff420dc92b75040364878e6ce058f7266c0210eb037af3b49febaa38feb07428fbc002195135229538c16
+  metadata.gz: 8665d145f7d23bfcbc5fdb5bf504e333570156507b94e8bbbf5c251ca0a7eff95e4924a600dcbdb96b60f569e0068c38eea240c45553fd5738f6b420228d0979
+  data.tar.gz: b25f60256f8687260e3ac7f690789ebeec180d4f27fb88b06e9f8b8d0731faf7a899f38ea5e5b1f8842628e27490fbec4b2838a5c782adf678f77845b81db587

data/.github/dependabot.yml

@@ -1,8 +1,17 @@
 version: 2
 updates:
-- package-ecosystem: bundler
-  directory: "/"
-  schedule:
-    interval: daily
-    time: "13:00"
-  open-pull-requests-limit: 10
+  # raise PRs for gem updates
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: daily
+      time: "13:00"
+    open-pull-requests-limit: 10
+
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: daily
+      time: "13:00"
+    open-pull-requests-limit: 10

data/.github/workflows/release.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     if: github.repository == 'voxpupuli/beaker-openstack'
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Install Ruby 3.0
         uses: ruby/setup-ruby@v1
         with:

data/.github/workflows/test.yml

@@ -11,19 +11,14 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-          - "2.4"
-          - "2.5"
-          - "2.6"
           - "2.7"
           - "3.0"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Install Ruby ${{ matrix.ruby }}
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
-        env:
-          BUNDLE_WITHOUT: release
       - name: Run tests
         run: bundle exec rake spec

data/CHANGELOG.md

@@ -2,6 +2,26 @@
 
 All notable changes to this project will be documented in this file.
 
+## [2.0.0](https://github.com/voxpupuli/beaker-openstack/tree/2.0.0) (2024-02-03)
+
+[Full Changelog](https://github.com/voxpupuli/beaker-openstack/compare/1.0.0...2.0.0)
+
+**Breaking changes:**
+
+- Drop EoL Ruby 2.4/2.5/2.6 support [\#22](https://github.com/voxpupuli/beaker-openstack/pull/22) ([bastelfreak](https://github.com/bastelfreak))
+
+**Implemented enhancements:**
+
+- Add parallel instance creation opt-in option [\#20](https://github.com/voxpupuli/beaker-openstack/pull/20) ([canihavethisone](https://github.com/canihavethisone))
+
+**Merged pull requests:**
+
+- gemspec: Fix typo in Apache-2.0 license name [\#27](https://github.com/voxpupuli/beaker-openstack/pull/27) ([bastelfreak](https://github.com/bastelfreak))
+- Apply best practices for our changelog generator [\#26](https://github.com/voxpupuli/beaker-openstack/pull/26) ([bastelfreak](https://github.com/bastelfreak))
+- Cleanup Gemfile, add beaker as runtime dependency [\#24](https://github.com/voxpupuli/beaker-openstack/pull/24) ([bastelfreak](https://github.com/bastelfreak))
+- dependabot: check for github actions and bundler [\#21](https://github.com/voxpupuli/beaker-openstack/pull/21) ([bastelfreak](https://github.com/bastelfreak))
+- Update fakefs requirement from ~\> 1.3 to ~\> 2.4 [\#19](https://github.com/voxpupuli/beaker-openstack/pull/19) ([dependabot[bot]](https://github.com/apps/dependabot))
+
 ## [1.0.0](https://github.com/voxpupuli/beaker-openstack/tree/1.0.0) (2021-07-09)
 
 [Full Changelog](https://github.com/voxpupuli/beaker-openstack/compare/0.3.0...1.0.0)

data/Gemfile

@@ -2,23 +2,7 @@ source ENV['GEM_SOURCE'] || "https://rubygems.org"
 
 gemspec
 
-def location_for(place, fake_version = nil)
-  if place =~ /^git:([^#]*)#(.*)/
-    [fake_version, { :git => $1, :branch => $2, :require => false }].compact
-  elsif place =~ /^file:\/\/(.*)/
-    ['>= 0', { :path => File.expand_path($1), :require => false }]
-  else
-    [place, { :require => false }]
-  end
-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'] || '~> 4.0')
-end
-
-group :release do
-  gem 'github_changelog_generator', :require => false
+group :release, optional: true do
+  gem 'faraday-retry', '~> 2.1', require: false
+  gem 'github_changelog_generator','~> 1.16', '>= 1.16.4', require: false
 end

data/README.md

@@ -137,6 +137,7 @@ CONFIG:
   openstack_volume_support: <true/false>
   security_group: ['default']
   preserve_hosts: <always/onfail/onpass/never>
+  create_in_parallel: true
   run_in_parallel: ['configure', 'install']
   type: <foss/git/pe>
 ```
@@ -154,6 +155,11 @@ Further, you can opt to use a static master by setting the master's hypervisor t
     ip: <master_ip>
 ```
 
+Additionally, you can set instance creation to occur in parallel instead of sequentially via this CONFIG entry:
+```yaml
+create_in_parallel: true
+```
+
 Additional parameter information is available at https://github.com/voxpupuli/beaker/blob/master/docs/concepts/argument_processing_and_precedence.md
 
 There is a simple rake task to invoke acceptance test for the library once the two environment variables are set:

data/Rakefile

@@ -169,13 +169,14 @@ end
 begin
   require 'rubygems'
   require 'github_changelog_generator/task'
-
+rescue LoadError
+  # github_changelog_generator is an optional group
+else
   GitHubChangelogGenerator::RakeTask.new :changelog do |config|
     config.header = "# Changelog\n\nAll notable changes to this project will be documented in this file."
-    config.exclude_labels = %w{duplicate question invalid wontfix wont-fix skip-changelog modulesync}
+    config.exclude_labels = %w[duplicate question invalid wontfix wont-fix skip-changelog github_actions]
     config.user = 'voxpupuli'
     config.project = 'beaker-openstack'
     config.future_release = Gem::Specification.load("#{config.project}.gemspec").version
   end
-rescue LoadError
 end

data/beaker-openstack.gemspec

@@ -10,17 +10,19 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/voxpupuli/beaker-openstack'
   s.summary     = %q{Beaker DSL Extension Helpers!}
   s.description = %q{For use for the Beaker acceptance testing tool}
-  s.license     = 'Apache2'
+  s.license     = 'Apache-2.0'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.required_ruby_version = '>= 2.7', '< 4'
+
   # Testing dependencies
   s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'rspec-its'
-  s.add_development_dependency 'fakefs', '~> 1.3'
+  s.add_development_dependency 'fakefs', '~> 2.4'
   s.add_development_dependency 'rake', '>= 12.3.3'
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'pry', '~> 0.10'
@@ -33,6 +35,5 @@ Gem::Specification.new do |s|
   # Run time dependencies
   s.add_runtime_dependency 'stringify-hash', '~> 0.0.0'
   s.add_runtime_dependency 'fog-openstack', '~> 1.0.0'
-
+  s.add_runtime_dependency 'beaker', '~> 5.6'
 end
-

data/lib/beaker/hypervisor/openstack.rb

@@ -250,86 +250,123 @@ module Beaker
       ip
     end
 
-    #Create new instances in OpenStack
+    # Create new instances in OpenStack, depending on if create_in_parallel is true or not
     def provision
-      @logger.notify "Provisioning OpenStack"
-
-      @hosts.each do |host|
-        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 = {
-          :flavor_ref => flavor(host[:flavor]).id,
-          :image_ref  => image(host[:image]).id,
-          :nics       => [ {'net_id' => network(@options[:openstack_network]).id } ],
-          :name       => host[:vmhostname],
-          :hostname   => host[:vmhostname],
-          :user_data  => host[:user_data] || "#cloud-config\nmanage_etc_hosts: true\n",
-          :key_name   => host[:keyname],
-        }
-        options[:security_groups] = security_groups(@options[:security_group]) unless @options[:security_group].nil?
-        vm = @compute_client.servers.create(options)
-
-        #wait for the new instance to start up
-        try = 1
-        attempts = @options[:timeout].to_i / SLEEPWAIT
-
-        while try <= attempts
-          begin
-            vm.wait_for(5) { ready? }
-            break
-          rescue Fog::Errors::TimeoutError => e
-            if try >= attempts
-              @logger.debug "Failed to connect to new OpenStack instance #{host.name} (#{host[:vmhostname]})"
-              raise e
-            end
-            @logger.debug "Timeout connecting to instance #{host.name} (#{host[:vmhostname]}), trying again..."
-          end
-          sleep SLEEPWAIT
-          try += 1
-        end
+      if @options[:create_in_parallel]
+        # Enable abort on exception for threads
+        Thread.abort_on_exception = true
+        @logger.notify "Provisioning OpenStack in parallel"
+        provision_parallel
+      else
+        @logger.notify "Provisioning OpenStack sequentially"
+        provision_sequential
+      end
+      hack_etc_hosts @hosts, @options
+    end
 
-        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"]
+    # Parallel creation wrapper
+    def provision_parallel
+      # Array to store threads
+      threads = @hosts.map do |host|
+        Thread.new do
+          create_instance_resources(host)
         end
+      end
+      # Wait for all threads to finish
+      threads.each(&:join)
+    end
 
-        @logger.debug "OpenStack host #{host.name} (#{host[:vmhostname]}) assigned ip: #{host[:ip]}"
-
-        #set metadata
-        vm.metadata.update({:jenkins_build_url => @options[:jenkins_build_url].to_s,
-                            :department        => @options[:department].to_s,
-                            :project           => @options[:project].to_s })
-        @vms << vm
-
-        # Wait for the host to accept ssh logins
-        host.wait_for_port(22)
+    # Sequential creation wrapper
+    def provision_sequential
+      @hosts.each do |host|
+        create_instance_resources(host)
+      end
+    end
 
-        #enable root if user is not root
-        enable_root(host)
+    # Create the actual instance resources
+    def create_instance_resources(host)
+      @logger.notify "Provisioning OpenStack"
+      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
 
-        provision_storage(host, vm) if @options[:openstack_volume_support]
-        @logger.notify "OpenStack Volume Support Disabled, can't provision volumes" if not @options[:openstack_volume_support]
+      create_or_associate_keypair(host, hostname)
+      @logger.debug "Provisioning #{host.name} (#{host[:vmhostname]})"
+      options = {
+        :flavor_ref => flavor(host[:flavor]).id,
+        :image_ref  => image(host[:image]).id,
+        :nics       => [{'net_id' => network(@options[:openstack_network]).id}],
+        :name       => host[:vmhostname],
+        :hostname   => host[:vmhostname],
+        :user_data  => host[:user_data] || "#cloud-config\nmanage_etc_hosts: true\n",
+        :key_name   => host[:keyname],
+      }
+      options[:security_groups] = security_groups(@options[:security_group]) unless @options[:security_group].nil?
+      vm = @compute_client.servers.create(options)
+
+      # Wait for the new instance to start up
+      try = 1
+      attempts = @options[:timeout].to_i / SLEEPWAIT
+
+      while try <= attempts
+        begin
+          vm.wait_for(5) { ready? }
+          break
+        rescue Fog::Errors::TimeoutError => e
+          if try >= attempts
+            @logger.debug "Failed to connect to new OpenStack instance #{host.name} (#{host[:vmhostname]})"
+            raise e
+          end
+          @logger.debug "Timeout connecting to instance #{host.name} (#{host[:vmhostname]}), trying again..."
+        end
+        sleep SLEEPWAIT
+        try += 1
       end
 
-      hack_etc_hosts @hosts, @options
+      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]}"
+    
+      # Set metadata
+      vm.metadata.update({:jenkins_build_url => @options[:jenkins_build_url].to_s,
+                          :department        => @options[:department].to_s,
+                          :project           => @options[:project].to_s })
+      @vms << vm
+
+      # Wait for the host to accept SSH logins
+      host.wait_for_port(22)
+
+      # Enable root if the user is not root
+      enable_root(host)
+
+      provision_storage(host, vm) if @options[:openstack_volume_support]
+      @logger.notify "OpenStack Volume Support Disabled, can't provision volumes" if not @options[:openstack_volume_support]
+
+    # Handle exceptions in the thread
+    rescue => e
+      @logger.error "Thread #{host} failed with error: #{e.message}"
+      # Call cleanup function to delete orphaned hosts
+      cleanup
+      # Pass the error to the main thread to terminate all threads
+      Thread.main.raise(e)
+      # Terminate the current thread (to prevent hack_etc_hosts trying to run after error raised)
+      Thread.kill(Thread.current)
     end
 
-    #Destroy any OpenStack instances
+    # Destroy any OpenStack instances
     def cleanup
       @logger.notify "Cleaning up OpenStack"
       @vms.each do |vm|
@@ -361,7 +398,7 @@ module Beaker
       end
     end
 
-    # enable root on a single host (the current one presumably) but only
+    # Enable root on a single host (the current one presumably) but only
     # if the username isn't 'root'
     def enable_root(host)
       if host['user'] != 'root'

data/lib/beaker-openstack/version.rb

@@ -1,3 +1,3 @@
 module BeakerOpenstack
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beaker-openstack
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-09 00:00:00.000000000 Z
+date: 2024-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: beaker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.6'
 description: For use for the Beaker acceptance testing tool
 email: voxpupuli@groups.io
 executables:
@@ -190,7 +204,7 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/voxpupuli/beaker-openstack
 licenses:
-- Apache2
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -200,14 +214,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: Beaker DSL Extension Helpers!