beaker-openstack 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55a3c90aebd4a0b7dbc596deec04e3282296b5828f3f7276a60816bd4683681f
-  data.tar.gz: 73ab6d4c7a3b267237882aa003a5af527f5819855d24e4dc9d594130dfcb68e2
+  metadata.gz: 463f56401c60a764c430d4060402b55246487e6c54e9e02b64accb6f29f45f2d
+  data.tar.gz: 98dcaa06a97b49f62ddca1ccfd8fbb394ac186292bb1cdac5818a0f6112f8b2e
 SHA512:
-  metadata.gz: cf439d1e7731e19723cda5c1e0fb3d7f0f384bcb9a4fed9ec2feb5173b9b181ff8d0414f9c0aa95fe965d2f0c2ee2038183ac0589a5b3b485e45f810385dfca4
-  data.tar.gz: 2ecf5c50a16e62d6c334aa033d9c5d36ccc0836205e1326fc3eb22af5352bb0079ec14329598b22d9bb94f4e51f80e71c194be9f418bacead8609c4a1a6137ce
+  metadata.gz: 587b4cfda5e1725de8d70958efa9e24b1f61a63b3f28d04f1dd826f00b27ac3a5a930318967ecc205d0ed629351a2e3bafc3c563149d2a9e519a02ff7a3a98ac
+  data.tar.gz: 46c9e5b7acf1c06b17a61e293b454bdca1daa61d668e251f666c486474969b6e064b5981ba9633e77fb734ded8ff3a8190cd5d36f7e9acd10f5e9d9a8ed28c92

data/.github/workflows/release.yml

@@ -24,7 +24,7 @@ jobs:
         shell: bash
         run: gem build --verbose *.gemspec
       - name: Upload gem to GitHub cache
-        uses: actions/upload-artifact@v6
+        uses: actions/upload-artifact@v7
         with:
           name: gem-artifact
           path: '*.gem'
@@ -39,7 +39,7 @@ jobs:
       contents: write # clone repo and create release
     steps:
       - name: Download gem from GitHub cache
-        uses: actions/download-artifact@v7
+        uses: actions/download-artifact@v8
         with:
           name: gem-artifact
       - name: Create Release
@@ -56,7 +56,7 @@ jobs:
       packages: write # publish to rubygems.pkg.github.com
     steps:
       - name: Download gem from GitHub cache
-        uses: actions/download-artifact@v7
+        uses: actions/download-artifact@v8
         with:
           name: gem-artifact
       - name: Publish gem to GitHub packages
@@ -73,7 +73,7 @@ jobs:
       id-token: write # rubygems.org authentication
     steps:
       - name: Download gem from GitHub cache
-        uses: actions/download-artifact@v7
+        uses: actions/download-artifact@v8
         with:
           name: gem-artifact
       - uses: rubygems/configure-rubygems-credentials@v1.0.0
@@ -92,7 +92,7 @@ jobs:
       - release-to-rubygems
     steps:
       - name: Download gem from GitHub cache
-        uses: actions/download-artifact@v7
+        uses: actions/download-artifact@v8
         with:
           name: gem-artifact
       - name: Install Ruby

data/CHANGELOG.md

@@ -2,7 +2,19 @@
 
 All notable changes to this project will be documented in this file.
 
-## [2.1.0](https://github.com/voxpupuli/beaker-openstack/tree/2.1.0) (2025-12-31)
+## [3.0.0](https://github.com/voxpupuli/beaker-openstack/tree/3.0.0) (2026-04-02)
+
+[Full Changelog](https://github.com/voxpupuli/beaker-openstack/compare/2.1.0...3.0.0)
+
+**Breaking changes:**
+
+- Major rewrite fixing root and additional volume creation, floating IP and keypair management, logging and cleanup. Keystone v2 support removed \(v3 required\) [\#38](https://github.com/voxpupuli/beaker-openstack/pull/38) ([canihavethisone](https://github.com/canihavethisone))
+
+**Merged pull requests:**
+
+- Updated gemspec to modern syntax [\#37](https://github.com/voxpupuli/beaker-openstack/pull/37) ([canihavethisone](https://github.com/canihavethisone))
+
+## [2.1.0](https://github.com/voxpupuli/beaker-openstack/tree/2.1.0) (2026-01-01)
 
 [Full Changelog](https://github.com/voxpupuli/beaker-openstack/compare/2.0.0...2.1.0)
 

data/Gemfile

@@ -4,5 +4,5 @@ gemspec
 
 group :release, optional: true do
   gem 'faraday-retry', '~> 2.1', require: false
-  gem 'github_changelog_generator','~> 1.16', '>= 1.16.4', require: false
+  gem 'github_changelog_generator', '>= 1.16.4', '< 2', require: false
 end

data/README.md

@@ -7,50 +7,117 @@
 [![RubyGem Downloads](https://img.shields.io/gem/dt/beaker-openstack.svg)](https://rubygems.org/gems/beaker-openstack)
 [![Donated by Puppet Inc](https://img.shields.io/badge/donated%20by-Puppet%20Inc-fb7047.svg)](#transfer-notice)
 
-Beaker library to use openstack hypervisor
+Beaker hypervisor support for provisioning hosts on OpenStack clouds.
 
-# How to use this wizardry
+This version of beaker-openstack has been fully modernized and now supports:
 
-This gem that allows you to use hosts with [openstack](openstack.md) hypervisor with [beaker](https://github.com/puppetlabs/beaker). 
+- Keystone v3 authentication (v2 removed)
+- Neutron networking only (Nova-network removed)
+- Deterministic floating IP allocation
+- Boot-from-volume provisioning
+- Optional additional Cinder volumes
+- Updated keypair lifecycle management
+- Stronger credential validation and error reporting
+- Predictable provisioning and teardown behavior
+- Updated RSpec suite and acceptance test flow
 
-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
+# Overview
 
-This library is included as a dependency of Beaker 3.x versions, so there's nothing to do.
+beaker-openstack provides an OpenStack hypervisor implementation for Beaker.
+It provisions OpenStack instances, assigns floating IPs, manages keypairs, and optionally provisions volumes.
 
-## With Beaker 4.x
+Beaker automatically loads hypervisors based on the `hypervisor:` field in your nodeset.
+No explicit require is needed.
 
-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'
-~~~
+# Compatibility
 
-# Spec tests
+## Beaker 3.x
+Beaker 3.x included hypervisors directly.
+This gem remains compatible, but Beaker 3 is no longer maintained.
 
-Spec test live under the `spec` folder. There are the default rake task and therefore can run with a simple command:
-```bash
-bundle exec rake test:spec
+## Beaker 4.x and later
+Beaker 4.x removed all bundled hypervisors.
+You must include this gem explicitly:
+
+Gemfile:
+```
+gem 'beaker', '~> 4.0'
+gem 'beaker-openstack', '~> 3.0'
 ```
+---------------------------------------------------------------------
 
-# Acceptance tests
+# Installation
 
-We run beaker's base acceptance tests with this library to see if the hypervisor is working with beaker. Please check our [openstack docs](openstack.md) to create host file to run acceptance tests. You need to set two environment variables before running acceptance tests:
+Add to your Gemfile or gemspec: `gem 'beaker-openstack'`
 
-1. `OPENSTACK_HOSTS` - Path to hostfile with hosts using openstack hypervisor
+Then install: `bundle install`
 
-2. `OPENSTACK_KEY` - Path to private key that is used to SSH into Openstack VMs 
+---------------------------------------------------------------------
 
-You will need at least two hosts defined in a nodeset file. An example comprehensive nodeset is below (note that not all parameters are required):
+# Configuration
+
+All OpenStack configuration is provided under the `CONFIG:` section of your nodeset.
+
+Required parameters:
+```
+- openstack_auth_url
+- openstack_username
+- openstack_api_key
+- openstack_project_name
+- openstack_network
+```
+
+Optional parameters:
+```
+- openstack_keyname
+- security_group
+- openstack_floating_ip
+- floating_ip_pool
+- openstack_volume_support
+- openstack_region
+- openstack_project_id
+- openstack_user_domain
+- openstack_user_domain_id
+- openstack_project_domain
+- openstack_project_domain_id
+- preserve_hosts
+- create_in_parallel
+- run_in_parallel
+- timeout
+```
+
+Notes:
+
+- When using `_id` parameters, ensure all three IDs match the parameter type:
+```
+openstack_project_id
+openstack_user_domain_id
+openstack_project_domain_id
+```
 
-```yaml
+- Static master nodes can be defined with:
+```
+hypervisor: none
+hostname: <master_hostname>
+vmhostname: <master_hostname>
+ip: <master_ip>
+```
+
+- Additionally, you can set instance creation to occur in parallel instead of sequentially via this CONFIG entry:
+`create_in_parallel: true`
+
+- For parameter precedence, see: [Beaker argument processing](https://github.com/voxpupuli/beaker/blob/master/docs/concepts/argument_processing_and_precedence.md)
 
+---------------------------------------------------------------------
+
+# Nodeset Examples
+
+You will need at least two hosts defined in a nodeset file. An example comprehensive nodeset is below (note that not all parameters are required):
+```
 HOSTS:
   master:
     roles:
@@ -59,7 +126,7 @@ HOSTS:
       - dashboard
       - database
     hypervisor: openstack
-    platform: <my_platform> 
+    platform: <my_platform>
     user: <host_username>
     image: <host_image>
     flavor: <host_flavor>
@@ -134,6 +201,7 @@ CONFIG:
   openstack_network: <insert_network>
   openstack_keyname: <insert_key>
   openstack_floating_ip: <true/false>
+  floating_ip_pool: <insert_network or uuid>
   openstack_volume_support: <true/false>
   security_group: ['default']
   preserve_hosts: <always/onfail/onpass/never>
@@ -142,31 +210,120 @@ CONFIG:
   type: <foss/git/pe>
 ```
 
-Note that when using _id parameters, you must also match the parameter type across the following when domain is specified:
-- openstack_project_id
-- openstack_user_domain_id
-- openstack_project_domain_id 
-
-Further, you can opt to use a static master by setting the master's hypervisor to none, and identifying its location thus:
-```yaml
-    hypervisor: none
-    hostname: <master_hostname>
-    vmhostname: <master_hostname>
-    ip: <master_ip>
+Boot-from-volume example:
+```
+HOSTS:
+  agent_1:
+    roles:
+      - agent
+    hypervisor: openstack
+    image: <host_image>
+    flavor: <host_flavor>
+    root_volume:
+      size: <size in Gb>
+      delete_on_termination: <true/false>
 ```
 
-Additionally, you can set instance creation to occur in parallel instead of sequentially via this CONFIG entry:
-```yaml
-create_in_parallel: true
+Additional volumes example:
+```
+HOSTS:
+  agent_2:
+    roles:
+      - agent
+    hypervisor: openstack
+    image: <host_image>
+    flavor: <host_flavor>
+    root_volume:
+      size: <size in Gb>
+      delete_on_termination: <true/false>
+    volumes:
+      data1:
+        size: <size in Gb>
+        description: second-volume
 ```
 
-Additional parameter information is available at https://github.com/voxpupuli/beaker/blob/master/docs/concepts/argument_processing_and_precedence.md
+Notes:
+- `root_volume` replaces ephemeral disk.
+- `volumes` are attached after instance is ACTIVE.
+- `volume_size` defaults to image minimum unless overridden.
+- `Floating IPs` are allocated deterministically if enabled.
+
+---------------------------------------------------------------------
+
+# Volume Provisioning
+- Instance boots from Cinder volume instead of ephemeral disk if root_volume is set.
+- Volume size can be overridden via volume_size.
+- The volume size defaults to the image minimum size unless overridden by volume_size (in Gb).
+- Additional volumes are created after the instance becomes ACTIVE.
+---------------------------------------------------------------------
+
+# Floating IP Allocation
+- Managed via Neutron.
+- If `openstack_floating_ip: true`, a floating IP is created.
+- IP is attached to instance's primary port.
+- Allocation is deterministic and logged clearly
+
+---------------------------------------------------------------------
+
+# Spec Tests
 
-There is a simple rake task to invoke acceptance test for the library once the two environment variables are set:
-```bash
+RSpec tests live under spec/.
+Run them with:
+`bundle exec rake test:spec`
+
+The spec suite includes:
+- Credential validation
+- Keypair lifecycle
+- Volume provisioning logic
+- Floating IP allocation
+- Error handling and retries
+
+---------------------------------------------------------------------
+
+# Acceptance Tests
+
+Acceptance tests require:
+- `OPENSTACK_HOSTS` - path to a nodeset using the OpenStack hypervisor
+- `OPENSTACK_KEY` - path to the private SSH key used for the instances
+
+Run acceptance tests:
+```
 bundle exec rake test:acceptance
 ```
 
+At least one host must use the OpenStack hypervisor.
+
+---------------------------------------------------------------------
+
+# Troubleshooting
+
+## Authentication failures:
+Ensure all three Keystone v3 IDs are correct:
+- `openstack_project_id`
+- `openstack_user_domain_id`
+- `openstack_project_domain_id`
+
+## Floating IP not assigned:
+Check:
+- Neutron external network exists
+- Security groups allow SSH ingress
+
+## Volume creation errors:
+Verify:
+- Cinder backend is available
+- Volume type exists (if specified)
+
+SSH timeouts:
+Use:
+```
+ssh:
+  keepalive: true
+  keepalive_interval: 5
+```
+---------------------------------------------------------------------
+
 # Contributing
 
-Please refer to puppetlabs/beaker's [contributing](https://github.com/puppetlabs/beaker/blob/master/CONTRIBUTING.md) guide.
+Contributions are welcome.
+Please follow the Beaker project?s contribution guidelines:
+https://github.com/voxpupuli/.github/blob/master/CONTRIBUTING.md

data/beaker-openstack.gemspec

@@ -1,40 +1,44 @@
-# -*- encoding: utf-8 -*-
-$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
-require 'beaker-openstack/version'
+# frozen_string_literal: true
+
+# Use require_relative for the version file and avoid unshifting to $LOAD_PATH manually
+require_relative 'lib/beaker-openstack/version'
 
 Gem::Specification.new do |s|
   s.name        = "beaker-openstack"
   s.version     = BeakerOpenstack::VERSION
-  s.authors     = 'Vox Pupuli'
-  s.email       = 'voxpupuli@groups.io'
+  s.authors     = ['Vox Pupuli']
+  s.email       = ['voxpupuli@groups.io']
   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.summary     = 'Beaker hypervisor support for OpenStack'
+  s.description = 'Provides OpenStack hypervisor implementation for the Beaker acceptance testing tool.'
   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.require_paths = ['lib']
+
+  s.metadata = {
+    'source_code_uri'   => 'https://github.com/voxpupuli/beaker-openstack',
+    'changelog_uri'     => 'https://github.com/voxpupuli/beaker-openstack/blob/main/CHANGELOG.md',
+    'bug_tracker_uri'   => 'https://github.com/voxpupuli/beaker-openstack/issues'
+  }
 
-  # Ruby compatibility
+  # Ruby compatibility: Dropped EoL 2.4/2.5/2.6 support in version 2.0.0
   s.required_ruby_version = '>= 2.7', '< 5'
 
-  # Testing dependencies
+  # Runtime dependencies
+  s.add_runtime_dependency 'stringify-hash', '~> 0.0.0'
+  s.add_runtime_dependency 'fog-openstack', '~> 1.0'
+  # Updated for modern Beaker compatibility (Beaker 6.x and 7.x)
+  s.add_runtime_dependency 'beaker', '>= 5.6', '< 8'
+
+  # Testing & Development dependencies
   s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'rspec-its'
   s.add_development_dependency 'fakefs', '>= 2.4', '< 4'
   s.add_development_dependency 'rake', '>= 12.3.3'
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'pry', '~> 0.10'
-
-  # Documentation dependencies
   s.add_development_dependency 'yard'
-  s.add_development_dependency 'markdown'
-  s.add_development_dependency 'thin'
-
-  # Runtime dependencies
-  s.add_runtime_dependency 'stringify-hash', '~> 0.0.0'
-  s.add_runtime_dependency 'fog-openstack', '~> 1.0'
-  s.add_runtime_dependency 'beaker', '>= 5.6', '< 8'
 end