kitchen-openstack 3.6.1 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bf1574cdbe6419f37ab9bc32f6413f7164314932
-  data.tar.gz: ae7cda2a687a2be7324cc9e847da7f048f1563ab
+SHA256:
+  metadata.gz: d3c139f8629d8896b075e11cb86e24e39895b8d98f82fe252577b781a1181f65
+  data.tar.gz: 178e6d4f4fbdc151d8cb90a3a9073f39901aab259b35955a970d1152fc4b3e2f
 SHA512:
-  metadata.gz: 48aaf584c9a96d253155688c2dfc71b0d5bc05e09f4e42a7857e42808af41fa90714eb624c5f78a20fd08d36562a1dae373152c0fcf24096d0bdb0b58f5fa8f3
-  data.tar.gz: 51923035e0b3ceda15cfa7f526ca7f0d5272c29991478acdb40726f8191c10be1d90e57558f90222b899bfc93074b0d2d2b758f2f71d36218c321a031fb8735e
+  metadata.gz: ab2a070947110663f54193aa73379f5740ec0bc353f962e4523fcc1cd721382f216db25f97a0d1199ba22208126543460fbd76e2da63493c88884f1f956fe6b4
+  data.tar.gz: 4d1f3d1d6f753183beabf8493c87335fd7e42485d6e889410ed4e115031c5480e7fab107a7419b6166797a081ff67a293692fd7fc27598368f31eb890377108d

data/README.md

@@ -1,10 +1,7 @@
 # <a name="title"></a> Kitchen::OpenStack: A Test Kitchen Driver for OpenStack
 
 [![Gem Version](https://img.shields.io/gem/v/kitchen-openstack.svg)][gem]
-[![Build Status](https://img.shields.io/travis/test-kitchen/kitchen-openstack.svg)][travis]
-[![Code Climate](https://img.shields.io/codeclimate/github/test-kitchen/kitchen-openstack.svg)][codeclimate]
-[![Coverage Status](https://img.shields.io/coveralls/test-kitchen/kitchen-openstack.svg)][coveralls]
-[![Dependency Status](https://img.shields.io/gemnasium/test-kitchen/kitchen-openstack.svg)][gemnasium]
+![CI](https://github.com/test-kitchen/kitchen-openstack/workflows/CI/badge.svg)
 
 A [Test Kitchen][kitchen_ci] Driver for [OpenStack][openstack_web].
 
@@ -12,12 +9,22 @@ This driver uses the [fog gem][fog_web] to provision and destroy nova instances.
 
 Shamelessly copied from [Fletcher Nichol](https://github.com/fnichol)'s awesome work on an [EC2 driver](https://github.com/test-kitchen/kitchen-ec2), and [Adam Leff](https://github.com/adamleff)'s amazing work on an [VRO driver](https://github.com/chef-partners/kitchen-vro).
 
+## Status
+
+This software project is no longer under active development as it has no active maintainers. The software may continue to work for some or all use cases, but issues filed in GitHub will most likely not be triaged. If a new maintainer is interested in working on this project please come chat with us in #test-kitchen on Chef Community Slack.
+
 ## Requirements
 
 There are **no** external system requirements for this driver. However you will need access to an OpenStack cloud.
 
 ## Installation and Setup
 
+This plugin ships out of the box with Chef Workstation, which is the easiest way to make sure you always have the latest testing dependencies in a single package.
+
+[Download Chef Workstation](https://downloads.chef.io/tools/workstation) to get started
+
+### Manual Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -36,12 +43,6 @@ Or install it yourself as:
 $ gem install kitchen-openstack
 ```
 
-Or if using [chefdk][chefdk_dl] install with:
-
-```bash
-$ chef gem install kitchen-openstack
-```
-
 ## Minimum Configuration
 
 ```yaml
@@ -177,7 +178,7 @@ security_groups:
 
 ### user\_data
 
-If your vms have `cloud-init` enabled you can use the `user_data` in your
+If your VMs have `cloud-init` enabled you can use the `user_data` in your
 kitchen.yml to inject commands at boot time.
 
 ```
@@ -193,9 +194,28 @@ for example:
 echo "do whatever you want to pre-configure your machine"
 ```
 
+### cloud\_config
+
+If your VMs have `cloud-init` enabled you can use `cloud_config` to generate userdata for use by cloud-init in the [cloud-config format](https://cloudinit.readthedocs.io/en/latest/topics/format.html#cloud-config-data). This provides a convenient way to specify cloud-init config inline. As the cloud-config format uses YAML the resulting userdata is essentially a copy+paste of `cloud_config` with the header line '#cloud-config'
+
+```
+    driver_config:
+      cloud_config:
+        hostname: my-hostname
+```
+
+This will pass the following user data to OpenStack:
+
+```
+#cloud-config
+hostname: my-hostname
+```
+
+The `cloud_config` and `user_data` options are mutually exclusive.
+
 ### config\_drive
 
-If your vms require config drive.
+If your VMs require config drive.
 
 ```
     config_drive: true
@@ -282,6 +302,9 @@ Otherwise set this to `false`.
 #### creation\_timeout
 Timeout to wait for volume to become available.  If a large volume is provisioned, it might take time to provision it on the backend.  Maximum amount of time to wait for volume to be created and be available.
 
+#### attach\_timeout
+If using a customized version of Openstack such a VMWare Integrated OPenstack (VIO), it may mark a volume active even though it is still performing some actions which may cause test kitchen to attach the volume to early which results in errors. Specify in seconds the amount of time to delay attaching the volume after its been marked active. Default timeout is 0.
+
 #### Example
 
 ```yaml
@@ -292,6 +315,7 @@ block_device_mapping:
   availability_zone: nova
   delete_on_termination: false
   creation_timeout: 120
+  attach_timeout: 240
 ```
 
 ## Network and Communication Configuration
@@ -445,10 +469,6 @@ Apache 2.0 (see [LICENSE][license])
 
 
 [gem]: https://rubygems.org/gems/kitchen-openstack
-[travis]: https://travis-ci.org/test-kitchen/kitchen-openstack
-[codeclimate]: https://codeclimate.com/github/test-kitchen/kitchen-openstack
-[coveralls]: https://coveralls.io/r/test-kitchen/kitchen-openstack
-[gemnasium]: https://gemnasium.com/test-kitchen/kitchen-openstack
 
 [author]:           https://github.com/RoboticCheese
 [maintainer]:       https://github.com/jjasghar
@@ -456,8 +476,7 @@ Apache 2.0 (see [LICENSE][license])
 [license]:          https://github.com/test-kitchen/kitchen-openstack/blob/master/LICENSE.txt
 [repo]:             https://github.com/test-kitchen/kitchen-openstack
 [driver_usage]:     https://github.com/test-kitchen/kitchen-openstack
-[chef_omnibus_dl]:  http://www.chef.io/chef/install/
-[chefdk_dl]:        https://downloads.chef.io/chef-dk
+[chef_omnibus_dl]:  https://downloads.chef.io/tools/infra-client
 [kitchen_ci]:       http://kitchen.ci
 
 [openstack_web]:    http://www.openstack.org

data/lib/kitchen/driver/openstack.rb

@@ -1,11 +1,11 @@
-# Encoding: UTF-8
+# frozen_string_literal: true
 
 #
 # Author:: Jonathan Hartman (<j@p4nt5.com>)
 # Author:: JJ Asghar (<jj@chef.io>)
 #
 # Copyright (C) 2013-2015, Jonathan Hartman
-# Copyright (C) 2015-2017, Chef Inc
+# Copyright (C) 2015-2020, Chef Software Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -21,7 +21,8 @@
 
 require "kitchen"
 require "fog/openstack"
-require "ohai"
+require "ohai" unless defined?(Ohai::System)
+require "yaml"
 require_relative "openstack_version"
 require_relative "openstack/volume"
 
@@ -116,8 +117,7 @@ module Kitchen
             pub_ip = pub[config[:public_ip_order].to_i] || nil
             if pub_ip
               info "Retrieve the ID of floating IP <#{pub_ip}>"
-              floating_ip_id = network.list_floating_ips(floating_ip_address: pub_ip)
-                                      .body["floatingips"][0]["id"]
+              floating_ip_id = network.list_floating_ips(floating_ip_address: pub_ip).body["floatingips"][0]["id"]
               network.delete_floating_ip(floating_ip_id)
               info "OpenStack Floating IP <#{pub_ip}> released."
             end
@@ -133,7 +133,6 @@ module Kitchen
 
       def openstack_server
         server_def = {
-          provider: "OpenStack",
           connection_options: {},
         }
         required_server_settings.each { |s| server_def[s] = config[s] }
@@ -147,7 +146,7 @@ module Kitchen
       end
 
       def optional_server_settings
-        Fog::Compute::OpenStack.recognized.select do |k|
+        Fog::OpenStack::Compute.recognized.select do |k|
           k.to_s.start_with?("openstack")
         end - required_server_settings
       end
@@ -157,11 +156,11 @@ module Kitchen
       end
 
       def network
-        Fog::Network.new(openstack_server)
+        Fog::OpenStack::Network.new(openstack_server)
       end
 
       def compute
-        Fog::Compute.new(openstack_server)
+        Fog::OpenStack::Compute.new(openstack_server)
       end
 
       def volume
@@ -174,7 +173,8 @@ module Kitchen
 
       def create_server
         server_def = init_configuration
-        fail(ActionFailed, "Cannot specify both network_ref and network_id") if config[:network_id] && config[:network_ref] # rubocop:disable SignalException
+        raise(ActionFailed, "Cannot specify both network_ref and network_id") if config[:network_id] && config[:network_ref]
+
         if config[:network_id]
           networks = [].concat([config[:network_id]])
           server_def[:nics] = networks.flatten.map do |net_id|
@@ -201,6 +201,12 @@ module Kitchen
           server_def[c] = optional_config(c) if config[c]
         end
 
+        if config[:cloud_config]
+          raise(ActionFailed, "Cannot specify both cloud_config and user_data") if config[:user_data]
+
+          server_def[:user_data] = Kitchen::Util.stringified_hash(config[:cloud_config]).to_yaml.gsub(/^---\n/, "#cloud-config\n")
+        end
+
         # Can't use the Fog bootstrap and/or setup methods here; they require a
         # public IP address that can't be guaranteed to exist across all
         # OpenStack deployments (e.g. TryStack ARM only has private IPs).
@@ -208,8 +214,9 @@ module Kitchen
       end
 
       def init_configuration
-        fail(ActionFailed, "Cannot specify both image_ref and image_id") if config[:image_id] && config[:image_ref] # rubocop:disable SignalException
-        fail(ActionFailed, "Cannot specify both flavor_ref and flavor_id") if config[:flavor_id] && config[:flavor_ref] # rubocop:disable SignalException
+        raise(ActionFailed, "Cannot specify both image_ref and image_id") if config[:image_id] && config[:image_ref]
+        raise(ActionFailed, "Cannot specify both flavor_ref and flavor_id") if config[:flavor_id] && config[:flavor_ref]
+
         {
           name: config[:server_name],
           image_ref: config[:image_id] || find_image(config[:image_ref]).id,
@@ -231,21 +238,24 @@ module Kitchen
 
       def find_image(image_ref)
         image = find_matching(compute.images, image_ref)
-        fail(ActionFailed, "Image not found") unless image # rubocop:disable SignalException
+        raise(ActionFailed, "Image not found") unless image
+
         debug "Selected image: #{image.id} #{image.name}"
         image
       end
 
       def find_flavor(flavor_ref)
         flavor = find_matching(compute.flavors, flavor_ref)
-        fail(ActionFailed, "Flavor not found") unless flavor # rubocop:disable SignalException
+        raise(ActionFailed, "Flavor not found") unless flavor
+
         debug "Selected flavor: #{flavor.id} #{flavor.name}"
         flavor
       end
 
       def find_network(network_ref)
         net = find_matching(network.networks.all, network_ref)
-        fail(ActionFailed, "Network not found") unless net # rubocop:disable SignalException
+        raise(ActionFailed, "Network not found") unless net
+
         debug "Selected net: #{net.id} #{net.name}"
         net
       end
@@ -261,7 +271,7 @@ module Kitchen
       def default_name
         [
           instance.name.gsub(/\W/, "")[0..14],
-          (Etc.getpwuid.name || "nologin").gsub(/\W/, "")[0..14],
+          ((Etc.getpwuid ? Etc.getpwuid.name : Etc.getlogin) || "nologin").gsub(/\W/, "")[0..14],
           Socket.gethostname.gsub(/\W/, "")[0..22],
           Array.new(7) { rand(36).to_s(36) }.join,
         ].join("-")
@@ -297,8 +307,10 @@ module Kitchen
         @@ip_pool_lock.synchronize do
           info "Attaching floating IP from <#{pool}> pool"
           if config[:allocate_floating_ip]
-            network_id = network.list_networks(name: pool)
-                                .body["networks"][0]["id"]
+            network_id = network
+              .list_networks(
+                name: pool
+              ).body["networks"][0]["id"]
             resp = network.create_floating_ip(network_id)
             ip = resp.body["floatingip"]["floating_ip_address"]
             info "Created floating IP <#{ip}> from <#{pool}> pool"
@@ -308,8 +320,9 @@ module Kitchen
               i.ip if i.fixed_ip.nil? && i.instance_id.nil? && i.pool == pool
             end.compact
             if free_addrs.empty?
-              fail ActionFailed, "No available IPs in pool <#{pool}>" # rubocop:disable SignalException
+              raise ActionFailed, "No available IPs in pool <#{pool}>"
             end
+
             config[:floating_ip] = free_addrs[0]
           end
           attach_ip(server, config[:floating_ip])
@@ -325,7 +338,7 @@ module Kitchen
         begin
           pub = server.public_ip_addresses
           priv = server.private_ip_addresses
-        rescue Fog::Compute::OpenStack::NotFound, Excon::Errors::Forbidden
+        rescue Fog::OpenStack::Compute::NotFound, Excon::Errors::Forbidden
           # See Fog issue: https://github.com/fog/fog/issues/2160
           addrs = server.addresses
           addrs["public"] && pub = addrs["public"].map { |i| i["addr"] }
@@ -352,8 +365,7 @@ module Kitchen
         # should also work for private networks
         if config[:openstack_network_name]
           debug "Using configured net: #{config[:openstack_network_name]}"
-          return filter_ips(server.addresses[config[:openstack_network_name]])
-                 .first["addr"]
+          return filter_ips(server.addresses[config[:openstack_network_name]]).first["addr"]
         end
 
         pub, priv = get_public_private_ips(server)
@@ -361,7 +373,7 @@ module Kitchen
         pub, priv = parse_ips(pub, priv)
         pub[config[:public_ip_order].to_i] ||
           priv[config[:private_ip_order].to_i] ||
-          fail(ActionFailed, "Could not find an IP") # rubocop:disable SignalException
+          raise(ActionFailed, "Could not find an IP")
       end
 
       def filter_ips(addresses)
@@ -406,7 +418,7 @@ module Kitchen
       end
 
       def disable_ssl_validation
-        require "excon"
+        require "excon" unless defined?(Excon)
         Excon.defaults[:ssl_verify_peer] = false
       end
 
@@ -436,7 +448,7 @@ module Kitchen
         if name.start_with?("/") && name.end_with?("/")
           regex = Regexp.new(name[1...-1])
           # check for regex name match
-          collection.each { |single| return single if regex =~ single.name }
+          collection.each { |single| return single if regex&.match?(single.name) }
         else
           # check for exact id match
           collection.each { |single| return single if single.id == name }

data/lib/kitchen/driver/openstack/volume.rb

@@ -1,4 +1,4 @@
-# Encoding: UTF-8
+# frozen_string_literal: true
 
 #
 # Author:: Jonathan Hartman (<j@p4nt5.com>)
@@ -35,7 +35,7 @@ module Kitchen
         end
 
         def volume(openstack_server)
-          Fog::Volume.new(openstack_server)
+          Fog::OpenStack::Volume.new(openstack_server)
         end
 
         def create_volume(config, os)
@@ -47,10 +47,13 @@ module Kitchen
             opt[key] = bdm[key]
           end
           @logger.info "Creating Volume..."
-          resp = volume(os).create_volume("#{config[:server_name]}-volume",
-                                          "#{config[:server_name]} volume",
-                                          bdm[:volume_size],
-                                          opt)
+          resp = volume(os)
+            .create_volume(
+              "#{config[:server_name]}-volume",
+              "#{config[:server_name]} volume",
+              bdm[:volume_size],
+              opt
+            )
           vol_id = resp[:body]["volume"]["id"]
 
           # Get Volume Model to make waiting for ready easy
@@ -66,9 +69,17 @@ module Kitchen
           vol_model.wait_for(creation_timeout) do
             sleep(1)
             raise("Failed to make volume") if status.casecmp("error".downcase) == 0
+
             ready?
           end
 
+          attach_timeout = bdm.key?(:attach_timeout) ? bdm[:attach_timeout] : 0
+
+          if attach_timeout > 0
+            @logger.debug "Sleeping for an additional #{attach_timeout} seconds before attaching volume to wait for Openstack to finish disk creation process.."
+            sleep(attach_timeout)
+          end
+
           @logger.debug "Volume Ready"
 
           vol_id

data/lib/kitchen/driver/openstack_version.rb

@@ -1,10 +1,10 @@
-# Encoding: UTF-8
+# frozen_string_literal: true
 
 #
 # Author:: Jonathan Hartman (<j@p4nt5.com>)
 #
 # Copyright (C) 2013-2015, Jonathan Hartman
-# Copyright (C) 2015-2018, Chef Software Inc
+# Copyright (C) 2015-2021, Chef Software Inc
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -23,6 +23,6 @@ module Kitchen
   #
   # @author Jonathan Hartman <j@p4nt5.com>
   module Driver
-    OPENSTACK_VERSION = "3.6.1".freeze
+    OPENSTACK_VERSION = "6.0.0"
   end
 end

metadata

@@ -1,64 +1,50 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-openstack
 version: !ruby/object:Gem::Version
-  version: 3.6.1
+  version: 6.0.0
 platform: ruby
 authors:
 - Jonathan Hartman
 - JJ Asghar
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-06-06 00:00:00.000000000 Z
+date: 2021-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-kitchen
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: fog-openstack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
-- !ruby/object:Gem::Dependency
-  name: unf
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: ohai
   requirement: !ruby/object:Gem::Requirement
@@ -115,20 +101,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: cane
-  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: countloc
   requirement: !ruby/object:Gem::Requirement
@@ -157,48 +129,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '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: simplecov-console
-  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: coveralls
-  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: github_changelog_generator
   requirement: !ruby/object:Gem::Requirement
@@ -221,26 +151,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rubocop.yml"
-- ".travis.yml"
-- CHANGELOG.md
-- Gemfile
-- LICENSE.txt
 - README.md
-- Rakefile
-- kitchen-openstack.gemspec
 - lib/kitchen/driver/openstack.rb
 - lib/kitchen/driver/openstack/volume.rb
 - lib/kitchen/driver/openstack_version.rb
-- spec/kitchen/driver/openstack/volume_spec.rb
-- spec/kitchen/driver/openstack_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/test-kitchen/kitchen-openstack
 licenses:
-- Apache
+- Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -248,19 +167,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: A Test Kitchen OpenStack Nova driver
-test_files:
-- spec/kitchen/driver/openstack/volume_spec.rb
-- spec/kitchen/driver/openstack_spec.rb
-- spec/spec_helper.rb
+test_files: []