beaker-openstack 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d6633df09acdbb5609695abe943b7d8ca80d4793
-  data.tar.gz: b121d5093ba7cb858cf96854949ada97ae53aacf
+SHA256:
+  metadata.gz: ec8d2595a3b94ae10ba8dbc5b29529506c36c5133b3fa56ae93a1f52d07d9686
+  data.tar.gz: 0d7518b15835c1b50b8a33e58a739e56a4d76a5c6593f17a64daa12592f915f0
 SHA512:
-  metadata.gz: 6f9ad76c1b51b2ac3e190ecf931fea129b308f7bac7f6573f89b1956c4d7f7ad7237f09a22ea0619b82b9ae5662e230614700b906f334cc564d198947438543f
-  data.tar.gz: 88e8e676509fa13b677597e773719b850691ba4eed0581748a6318edfe1c7a9ae843eefe7c5d185d623b1a58ac49f3cacbf285660a1e3db7a1552511f00d57f5
+  metadata.gz: bc97fe129ef779dd643011e1a5b9f55c99c3f92659d397019a657dadf45da0364872f0eab3b32fb195561ff02e65e63e2a41e2d2a51e25d6bc8c90fbdd58f9a6
+  data.tar.gz: 14b0b253f8008aa4729257fa46cfc1e47a05436fe9bff420dc92b75040364878e6ce058f7266c0210eb037af3b49febaa38feb07428fbc002195135229538c16

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/release.yml

@@ -0,0 +1,31 @@
+name: Release
+
+on:
+  create:
+    ref_type: tag
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    if: github.repository == 'voxpupuli/beaker-openstack'
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install Ruby 3.0
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.0'
+        env:
+          BUNDLE_WITHOUT: release
+      - name: Build gem
+        run: gem build *.gemspec
+      - name: Publish gem to rubygems.org
+        run: gem push *.gem
+        env:
+          GEM_HOST_API_KEY: '${{ secrets.RUBYGEMS_AUTH_TOKEN }}'
+      - name: Setup GitHub packages access
+        run: |
+          mkdir -p ~/.gem
+          echo ":github: Bearer ${{ secrets.GITHUB_TOKEN }}" >> ~/.gem/credentials
+          chmod 0600 ~/.gem/credentials
+      - name: Publish gem to GitHub packages
+        run: gem push --key github --host https://rubygems.pkg.github.com/voxpupuli *.gem

data/.github/workflows/test.yml

@@ -0,0 +1,29 @@
+name: Test
+
+on:
+  - pull_request
+  - push
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - "2.4"
+          - "2.5"
+          - "2.6"
+          - "2.7"
+          - "3.0"
+    steps:
+      - uses: actions/checkout@v2
+      - 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

@@ -0,0 +1,44 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [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)
+
+**Merged pull requests:**
+
+- Cleanup README/gemspec/GitHub actions [\#13](https://github.com/voxpupuli/beaker-openstack/pull/13) ([bastelfreak](https://github.com/bastelfreak))
+- Update fakefs requirement from ~\> 0.6 to ~\> 1.3 [\#11](https://github.com/voxpupuli/beaker-openstack/pull/11) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Add Vox Pupuli's CI bits [\#10](https://github.com/voxpupuli/beaker-openstack/pull/10) ([genebean](https://github.com/genebean))
+- Add openstack\_project\_id logic etc, expand example nodeset in readme [\#9](https://github.com/voxpupuli/beaker-openstack/pull/9) ([canihavethisone](https://github.com/canihavethisone))
+
+## [0.3.0](https://github.com/voxpupuli/beaker-openstack/tree/0.3.0) (2019-06-17)
+
+[Full Changelog](https://github.com/voxpupuli/beaker-openstack/compare/0.2.0...0.3.0)
+
+**Merged pull requests:**
+
+- hypervisor/openstack: fix usage with V3 API [\#5](https://github.com/voxpupuli/beaker-openstack/pull/5) ([GiedriusS](https://github.com/GiedriusS))
+- \(BKR-1509\) Hypervisor usage instructions for Beaker 4.0 [\#4](https://github.com/voxpupuli/beaker-openstack/pull/4) ([Dakta](https://github.com/Dakta))
+
+## [0.2.0](https://github.com/voxpupuli/beaker-openstack/tree/0.2.0) (2018-01-09)
+
+[Full Changelog](https://github.com/voxpupuli/beaker-openstack/compare/0.1.0...0.2.0)
+
+**Merged pull requests:**
+
+- \(BKR-1270\) Use fog-openstack instead of fog [\#3](https://github.com/voxpupuli/beaker-openstack/pull/3) ([Sharpie](https://github.com/Sharpie))
+
+## [0.1.0](https://github.com/voxpupuli/beaker-openstack/tree/0.1.0) (2017-07-28)
+
+[Full Changelog](https://github.com/voxpupuli/beaker-openstack/compare/9fc506a9a93f9985fb3f36132a91805026f19d79...0.1.0)
+
+**Merged pull requests:**
+
+- \(MAINT\) Update docs [\#2](https://github.com/voxpupuli/beaker-openstack/pull/2) ([rishijavia](https://github.com/rishijavia))
+- \(MAINT\) Update env variable to correct hypervisor [\#1](https://github.com/voxpupuli/beaker-openstack/pull/1) ([rishijavia](https://github.com/rishijavia))
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/Gemfile

@@ -16,10 +16,9 @@ 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", *location_for(ENV['BEAKER_VERSION'] || '~> 4.0')
 end
 
-
-if File.exists? "#{__FILE__}.local"
-  eval(File.read("#{__FILE__}.local"), binding)
+group :release do
+  gem 'github_changelog_generator', :require => false
 end

data/README.md

@@ -1,5 +1,12 @@
 # beaker-openstack
 
+[![License](https://img.shields.io/github/license/voxpupuli/beaker-openstack.svg)](https://github.com/voxpupuli/beaker-openstack/blob/master/LICENSE)
+[![Test](https://github.com/voxpupuli/beaker-openstack/actions/workflows/test.yml/badge.svg)](https://github.com/voxpupuli/beaker-openstack/actions/workflows/test.yml)
+[![Release](https://github.com/voxpupuli/beaker-openstack/actions/workflows/release.yml/badge.svg)](https://github.com/voxpupuli/beaker-openstack/actions/workflows/release.yml)
+[![RubyGem Version](https://img.shields.io/gem/v/beaker-openstack.svg)](https://rubygems.org/gems/beaker-openstack)
+[![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
 
 # How to use this wizardry
@@ -40,33 +47,115 @@ We run beaker's base acceptance tests with this library to see if the hypervisor
 
 2. `OPENSTACK_KEY` - Path to private key that is used to SSH into Openstack VMs 
 
-You will need two hosts with same platform. A template of what hosts file is below:
+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):
 
 ```yaml
+
 HOSTS:
-  host-1:
+  master:
+    roles:
+      - agent
+      - master
+      - dashboard
+      - database
     hypervisor: openstack
     platform: <my_platform> 
     user: <host_username>
     image: <host_image>
+    flavor: <host_flavor>
+    ssh:
+      user: cloud-user
+      password: <cloud-user_password>
+      auth_methods:
+        - password
+        - publickey
+      keys:
+        - <relative_path/public_key>
+    user_data: |
+      #cloud-config
+      output: {all: '| tee -a /var/log/cloud-init-output.log'}
+      disable_root: <True/False>
+      ssh_pwauth: <True/False>
+      chpasswd:
+        list: |
+           root:<root_password>
+           cloud-user:<cloud-user_password>
+        expire: False
+      runcmd:
+        - <my_optional_commands>
+
+  agent_1:
     roles:
       - agent
-      - master
-      - dashboard
-      - database
       - default
-  host-2:
     hypervisor: openstack
     platform: <my_platform>
     user: <host_username>
     image: <host_image>
-    roles:
-      - agent
+    flavor: <host_flavor>
+    ssh:
+      user: cloud-user
+      password: <cloud-user_password>
+      auth_methods:
+        - publickey
+      keys:
+        - <relative_path/public_key>
+      number_of_password_prompts: 0
+      keepalive: true
+      keepalive_interval: 5
+    user_data: |
+      #cloud-config
+      output: {all: '| tee -a /var/log/cloud-init-output.log'}
+      disable_root: <True/False>
+      ssh_pwauth: <True/False>
+      chpasswd:
+        list: |
+           root:<root_password>
+           cloud-user:<cloud-user_password>
+        expire: False
+      runcmd:
+        - <my_optional_commands>
+
 CONFIG:
+  log_level: <trace/debug/verbose/info/notify/warn>
+  trace_limit: 50
+  timesync: <true/false>
   nfs_server: none
   consoleport: 443
+  openstack_username: <insert_username>
+  openstack_api_key: <insert_password>
+#  openstack_project_name: <insert_project_name>     # alternatively use openstack_project_id
+  openstack_project_id: <insert_id>
+#  openstack_user_domain: <insert user_domain>       # alternatively use openstack_user_domain_id
+  openstack_user_domain_id: <insert_id>
+#  openstack_project_domain: <insert_project_domain> # alternatively use openstack_project_domain_id
+  openstack_project_domain_id: <insert_id>
+  openstack_auth_url: http://<keystone_ip>:5000/v3/
+  openstack_network: <insert_network>
+  openstack_keyname: <insert_key>
+  openstack_floating_ip: <true/false>
+  openstack_volume_support: <true/false>
+  security_group: ['default']
+  preserve_hosts: <always/onfail/onpass/never>
+  run_in_parallel: ['configure', 'install']
+  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>
+```
+
+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:
 ```bash
 bundle exec rake test:acceptance

data/Rakefile

@@ -58,6 +58,7 @@ task 'test:acceptance' => 'test:acceptance:quick'
 # global defaults
 task :test => 'test:spec'
 task :default => :test
+task :spec => 'test:spec'
 
 ###########################################################
 #
@@ -164,3 +165,17 @@ namespace :docs do
     end
   end
 end
+
+begin
+  require 'rubygems'
+  require 'github_changelog_generator/task'
+
+  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.user = 'voxpupuli'
+    config.project = 'beaker-openstack'
+    config.future_release = Gem::Specification.load("#{config.project}.gemspec").version
+  end
+rescue LoadError
+end

data/beaker-openstack.gemspec

@@ -5,9 +5,9 @@ require 'beaker-openstack/version'
 Gem::Specification.new do |s|
   s.name        = "beaker-openstack"
   s.version     = BeakerOpenstack::VERSION
-  s.authors     = ["Rishi Javia, Kevin Imber, Tony Vu"]
-  s.email       = ["rishi.javia@puppet.com, kevin.imber@puppet.com, tony.vu@puppet.com"]
-  s.homepage    = "https://github.com/puppetlabs/beaker-openstack"
+  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.license     = 'Apache2'
@@ -20,13 +20,8 @@ Gem::Specification.new do |s|
   # Testing dependencies
   s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'rspec-its'
-  # 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 'fakefs', '~> 1.3'
+  s.add_development_dependency 'rake', '>= 12.3.3'
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'pry', '~> 0.10'
 

data/lib/beaker-openstack/version.rb

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

data/lib/beaker/hypervisor/openstack.rb

@@ -14,6 +14,11 @@ module Beaker
     #@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 (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_project_id The project id to access the OpenStack instance with (alternative to openstack_project_name)
+    #@option options [String] :openstack_user_domain The user domain name to access the OpenStack instance with
+    #@option options [String] :openstack_user_domain_id The user domain id to access the OpenStack instance with (alternative to openstack_user_domain)
+    #@option options [String] :openstack_project_domain The project domain to access the OpenStack instance with
+    #@option options [String] :openstack_project_domain_id The project domain id to access the OpenStack instance with (alternative to openstack_project_domain)
     #@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)
@@ -38,16 +43,25 @@ module Beaker
       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]
+      raise 'You must specify an Openstack project name (:openstack_project_name) or Openstack project id (:openstack_project_id) for OpenStack instances!' if is_v3 and (!@options[:openstack_project_name] and !@options[:openstack_project_id])
+      raise 'You must specify either Openstack project name (:openstack_project_name) or Openstack project id (:openstack_project_id) not both!' if is_v3 and (@options[:openstack_project_name] and @options[:openstack_project_id])
+      raise 'You may specify either Openstack user domain (:openstack_user_domain) or Openstack user domain id (:openstack_user_domain_id) not both!' if is_v3 and (@options[:openstack_user_domain] and @options[:openstack_user_domain_id])
+      raise 'You may specify either Openstack project domain (:openstack_project_domain) or Openstack project domain id (:openstack_project_domain_id) not both!' if is_v3 and (@options[:openstack_project_domain] and @options[:openstack_project_domain_id])
+      raise 'Invalid option specified: v3 API expects :openstack_project_name or :openstack_project_id, 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 or :openstack_project_id for OpenStack instances!' if !is_v3 and (@options[:openstack_project_name] or @options[:openstack_project_id])
+      # Ensure that _id and non _id params are not mixed (due to bug in fog-openstack)
+      raise 'You must not mix _id values non _id (name) values. Please use the same type for (:openstack_project_), (:openstack_user_domain) and (:openstack_project_domain)!' if is_v3 and (@options[:openstack_project_name] or @options[:openstack_user_domain] or @options[:openstack_project_domain]) and (@options[:openstack_project_id] or @options[:openstack_user_domain_id] or @options[:openstack_project_domain_id])
 
       # 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]}
+        if @options[:openstack_project_id]
+          extra_credentials = {:openstack_project_id => @options[:openstack_project_id]}
+        else
+          extra_credentials = {:openstack_project_name => @options[:openstack_project_name]}
+        end
       end
 
       # Common keystone authentication credentials
@@ -62,8 +76,16 @@ module Beaker
 
       # Keystone version 3 requires users and projects to be scoped
       if is_v3
-        @credentials[:openstack_user_domain]    = @options[:openstack_user_domain] || 'Default'
-        @credentials[:openstack_project_domain] = @options[:openstack_project_domain] || 'Default'
+        if @options[:openstack_user_domain_id]
+          @credentials[:openstack_user_domain_id] = @options[:openstack_user_domain_id]
+        else
+          @credentials[:openstack_user_domain]    = @options[:openstack_user_domain] || 'Default'
+        end
+        if @options[:openstack_project_domain_id]
+          @credentials[:openstack_project_domain_id] = @options[:openstack_project_domain_id]
+        else
+          @credentials[:openstack_project_domain]    = @options[:openstack_project_domain] || 'Default'
+        end        
       end
 
       @compute_client ||= Fog::Compute.new(@credentials)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beaker-openstack
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
-- Rishi Javia, Kevin Imber, Tony Vu
+- Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-17 00:00:00.000000000 Z
+date: 2021-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -165,15 +165,18 @@ dependencies:
       - !ruby/object:Gem::Version
         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
+email: voxpupuli@groups.io
 executables:
 - beaker-openstack
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/release.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".simplecov"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -185,7 +188,7 @@ files:
 - openstack.md
 - spec/beaker/hypervisor/openstack_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/puppetlabs/beaker-openstack
+homepage: https://github.com/voxpupuli/beaker-openstack
 licenses:
 - Apache2
 metadata: {}
@@ -204,8 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Beaker DSL Extension Helpers!