kitchen-openstack 5.0.1 → 6.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed10521f2bd0acc22db46ff87e0279f2d919fbd66ed6a6088e4825d8a75c5d84
-  data.tar.gz: a0875746a6229f500b4c4e68e68f875527b1b5c90e0ab2616d79dc4035c2147f
+  metadata.gz: a54b200667def52dee3afc0ac1be2f58dbe082396fa6ee17833ac5d0a91d6bfd
+  data.tar.gz: 397fbc6af66ed869b827ac30014c42f6c41a90a386a4a77fcd76a660e921e06b
 SHA512:
-  metadata.gz: d46edbaac847718f7e3a9559c6003f91703bc5fd67c5d4609eab25dc6a0e0e54b495da0293a0f97746862fc0f04ccec675bdc118c2d89973910925b43ad1d81d
-  data.tar.gz: c4702f11e45567513496170e0283802929c5b7802186e6d3c14b80819130b1579231a59b263b4c3bfd3197cc5c5c6716c3dde032494d5e764626c05a279f6296
+  metadata.gz: 10b1f6ee9220f1c0724e0182392d00bd28806e80863d939f565921e5646da09ed681cba71a342da22c25f2bec8023699c9dab39c29a22cef8286eceb83bf645a
+  data.tar.gz: e05e7903c57e1c0b776fe4b751fed1bd596335b0ddf4ba0f0cee4f8ee1174a69c3e1b9f9b92ea8cd1f70adb877eee75d5943c39f6f022f1387e2144690705b5f

data/README.md

@@ -1,9 +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]
+![CI](https://github.com/test-kitchen/kitchen-openstack/workflows/CI/badge.svg)
 
 A [Test Kitchen][kitchen_ci] Driver for [OpenStack][openstack_web].
 
@@ -21,6 +19,12 @@ There are **no** external system requirements for this driver. However you will
 
 ## 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
@@ -39,391 +43,9 @@ 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
-driver:
-  name: openstack
-  openstack_username: [YOUR OPENSTACK USERNAME]
-  openstack_api_key: [YOUR OPENSTACK API KEY] # AKA your OpenStack Password
-  openstack_auth_url: [YOUR OPENSTACK AUTH URL] # if you are using v3, API_URL/v3/auth/tokens
-  openstack_domain_id: [default is 'default'; otherwise YOUR OPENSTACK DOMAIN ID]
-  require_chef_omnibus: [e.g. 'true' or a version number if you need Chef]
-  image_ref: [SERVER IMAGE ID]
-  flavor_ref: [SERVER FLAVOR ID]
-transport:
-  username: ubuntu # For a Ubuntu Box
-```
-
-The `image_ref` and `flavor_ref` options can be specified as an exact id,
-an exact name, or as a regular expression matching the name of the image or flavor.
-
-All of Fog's `openstack` options (`openstack_domain_name`, `openstack_project_name`,
-...) are supported. This includes support for the OpenStack Identity v3 API.
-
-## General Configuration
-
-### name
-
-**Required** Tell test-kitchen what driver to use. ;)
-
-### openstack\_username
-
-**Required** Your OpenStack username.
-
-### openstack\_api\_key
-
-**Required** Your OpenStack API Key, aka your OpenStack password.
-
-### openstack\_auth\_url
-
-**Required** Your OpenStack auth url. If you are using ID v3, you'll need to use `API_URL/v3/auth/tokens`.
-
-### require\_chef_omnibus
-
-**Required** Set to `true` otherwise the specific version of Chef omnibus you want installed.
-
-### image\_ref
-
-**image_ref or image_id required** Server Image Name or ID.
-
-### image\_id
-
-**image_ref or image_id required** Server Image ID.  Specifying the ID instead of reference results in a faster create time.
-
-**Note** If the image UUID changes this value will need to be updated.
-
-### flavor\_ref
-
-**flavor_ref or flavor_id required** Server Flavor Name or ID.
-
-### flavor\_ref
-
-**flavor_ref or flavor_id required** Server Flavor ID.  Specifying the ID instead of reference results in a faster create time.
-
-**Note** If the flavor UUID changes this value will need to be updated.
-
-### server\_name
-
-If a `server_name_prefix` is specified then this prefix will be used when
-generating random names of the form `<NAME PREFIX>-<RANDOM STRING>` e.g.
-`myproject-asdfghjk`. If both `server_name_prefix` and `server_name` are
-specified then the `server_name` takes precedence.
-
-### server\_name\_prefix
-
-If you want to have a static prefix for a random server name.
-
-### port
-
-Set the SSH port for the remote access.
-
-### openstack\_tenant
-
-Your OpenStack tenant id.
-
-### openstack\_region
-
-Your OpenStack region id.
-
-### availability\_zone
-
-Your OpenStack availablity zone.
-
-### openstack\_service\_name
-
-Your OpenStack compute service name.
-
-### openstack\_network\_name
-
-Your OpenStack network name used to connect to, if you have only private network
-connections you want declare this.
-
-### glance\_cache\_wait\_timeout
-When OpenStack downloads the image into cache, it takes extra time to provision.  Timeout controls maximum amount of time to wait for machine to move from the Build/Spawn phase to Active.
-
-### connect\_timeout
-Connect timeout controls maximum amount of time to wait for machine to respond to ssh login request.
-
-### read\_timeout
-### write\_timeout
-Expose read/write timeout parameters passed down to HTTP connection created via [excon](https://github.com/excon/excon). Default timeouts (from excon) are 60 seconds.
-
-### server\_wait
-
-`server_wait` is a workaround to deal with how some VMs with `cloud-init`.
-Some clouds need this some, most OpenStack instances don't. This is a stop gap
-wait makes sure that the machine is in a good state to work with. Ideally the
-transport layer in Test-Kitchen will have a more intelligent way to deal with this.
-There will be a dot that appears every 10 seconds as the timer counts down.
-You may want to add this for **WinRM** instances due to the multiple restarts that
-happen on creation and boot. A good default is `300` seconds to make sure it's
-in a good state.
-
-The default is `0`.
-
-### security\_groups
-
-A list of `security_groups` to join:
-
-```yaml
-security_groups:
-   - [A LIST OF...]
-   - [...SECURITY GROUPS TO JOIN]
-   ```
-
-### user\_data
-
-If your vms have `cloud-init` enabled you can use the `user_data` in your
-kitchen.yml to inject commands at boot time.
-
-```
-    driver_config:
-      user_data: userdata.txt
-```
-
-Then create a `userdata.txt` in the same directory as your .kitchen.yml,
-for example:
-
-```
-#!/bin/sh
-echo "do whatever you want to pre-configure your machine"
-```
-
-### config\_drive
-
-If your vms require config drive.
-
-```
-    config_drive: true
-```
-
-### network\_ref
-
-**Deprecated** A list of network names to create instances with.
-
-```yaml
-network_ref:
-   - [OPENSTACK NETWORK NAMES]
-   - [CREATE INSTANCE WITH]
-```
-
-### network\_id
-
-A list of network ids to create instances with.  Specifying the id instead of reference results in a faster create time.
-
-**Note** If the network UUID changes this value will need to be updated.
-
-```yaml
-network_ref:
-   - [OPENSTACK NETWORK UUIDs]
-   - [TO CREATE INSTANCE WITH]
-```
-
-### no\_ssh\_tcp\_check
-
-**Deprecated** You should be using transport now. This will skip the ssh check to automatically connect.
-
-The default is `false`.
-
-### no\_ssh\_tcp\_check\_sleep
-
-**Deprecated** You should be using transport now. This will sleep for so many seconds. `no_ssh_tcp_check` needs
-to be set to `true`.
-
-### private\_key\_path
-
-**Deprecated** You should be using transport now. The guest image should use `cloud-init` or some other method to fetch key from meta-data service.
-
-### public\_key\_path
-
-**Deprecated** You should be using transport now. The guest image should use `cloud-init` or some other method to fetch key from meta-data service.
-
-## Disk Configuration
-
-### <a name="config-block_device_mapping"></a> block\_device\_mapping
-
-#### make\_volume
-
-Makes a new volume when set to `true`.
-
-The default is `false`.
-
-#### snapshot\_id
-
-When set, will make a volume from that snapshot id.
-
-#### volume\_id
-
-When set, will attach the volume id.
-
-#### device\_name
-
-Set this to `vda` unless you really know what you are doing.
-
-#### availability\_zone
-
-The block storage availability zone.
-
-The default is `nova`.
-
-#### volume\_type
-
-The volume type, this is optional.
-
-#### delete\_on\_termination
-
-This will delete the volume on the instance when `destroy` happens, if set to true.
-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
-block_device_mapping:
-  make_volume: true
-  snapshot_id: 00000-111111-0000222-000
-  device_name: vda
-  availability_zone: nova
-  delete_on_termination: false
-  creation_timeout: 120
-  attach_timeout: 240
-```
-
-## Network and Communication Configuration
-
-### floating\_ip
-
-A specific `floating_ip` can be provided to bind a floating IP to the node.
-Any floating IP will be the IP used for Test Kitchen's Remote calls to the node.
-
-### floating\_ip\_pool
-
-A `floating_ip_pool` can be provided to allocate a floating IP from
-the pool to the instance. If `allocate_floating_ip` is true, the IP will be allocated,
-otherwise the first free floating IP will be used.  It will be the IP used for
-Test Kitchen's Remote calls to the node. If allocated, the floating IP will be
-released once the instance is destroyed.
-
-### allocate\_floating\_ip
-
-If true, allocate a new IP from the specified `floating_ip_pool` and release is afterwards.
-Otherwise, if false (the default), an existing allocated IP.
-
-### \[public\|private\]\_ip\_order
-
-In some complex network scenarios you can have several IP addresses designated
-as public or private. Use `public_ip_order` or `private_ip_order` to control
-which one to use for further SSH connection. Default is 0 (first one)
-
-For example if you have openstack istance that has network with several IPs assigned like
-
-```
-+--------------------------------------+------------+--------+------------+-------------+----------------------------------+
-| ID                                   | Name       | Status | Task State | Power State | Networks                         |
-+--------------------------------------+------------+--------+------------+-------------+----------------------------------+
-| 31c98de4-026f-4d12-b03f-a8a35c6e730b | kitchen    | ACTIVE | None       | Running     | test=10.0.0.1, 10.0.1.1   |
-
-```
-
-to use second `10.0.1.1` IP address you need to specify
+## Usage
 
-```yaml
-  private_ip_order: 1
-```
-assuming that test network is configured as private.
-
-### use_ipv6
-
-If true use IPv6 addresses to for SSH connections. If false, the default, use
-IPv4 addresses for SSH connections.
-
-### network\_ref
-
-The `network_ref` option can be specified as an exact id, an exact name,
-or as a regular expression matching the name of the network. You can pass one
-
-```yaml
-  network_ref: MYNET1
-```
-
-or many networks
-
-```yaml
-network_ref:
-  - MYNET1
-  - MYNET2
-```
-
-The `openstack_network_name` is used to select IP address for SSH connection.
-It's recommended to specify this option in case of multiple networks used for
-instance to provide more control over network connectivity.
-
-Please note that `network_ref` relies on Network Services (`Fog::Network`) and
-it can be unavailable in your OpenStack installation.
-
-
-### disable\_ssl\_validation
-
-```yaml
-  disable_ssl_validation: true
-```
-
-Only disable SSL cert validation if you absolutely know what you are doing,
-but are stuck with an OpenStack deployment without valid SSL certs.
-
-## Example
-
-The following could be used in a `.kitchen.yml` or in a `.kitchen.local.yml`
-to override default configuration.
-
-```yaml
----
-driver:
-  name: openstack
-  openstack_username: [YOUR OPENSTACK USERNAME]
-  openstack_api_key: [YOUR OPENSTACK API KEY] # AKA your OPENSTACK PASSWORD
-  openstack_auth_url: [YOUR OPENSTACK AUTH URL]
-  openstack_domain_id: [default is 'default'; otherwise YOUR OPENSTACK DOMAIN ID]
-  require_chef_omnibus: [e.g. 'true' or a version number if you need Chef]
-  image_ref: [SERVER IMAGE ID]
-  flavor_ref: [SERVER FLAVOR ID]
-  key_name: [KEY NAME]
-  read_timeout: 180
-  write_timeout: 180
-  connect_timeout: 180
-
-transport:
-  ssh_key: /path/to/id_rsa #Path to private key that matches the above openstack key_name
-  connection_timeout: 10
-  connection_retries: 5
-  username: ubuntu
-  password: mysecreatpassword
-
-platforms:
-  - name: ubuntu-14.04
-  - name: ubuntu-15.04
-  - name: centos-7
-    transport:
-      username: centos
-  - name: windows-2012r2
-    transport:
-      password: myadministratorpassword
-
-suites:
-# ...
-```
+See https://kitchen.ci/docs/drivers/openstack/ for documentation.
 
 ## <a name="development"></a> Development
 
@@ -452,10 +74,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
@@ -463,8 +81,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/volume.rb

@@ -1,4 +1,3 @@
-# Encoding: UTF-8
 # frozen_string_literal: true
 
 #

data/lib/kitchen/driver/openstack.rb

@@ -1,4 +1,3 @@
-# Encoding: UTF-8
 # frozen_string_literal: true
 
 #
@@ -22,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"
 
@@ -82,14 +82,16 @@ module Kitchen
         disable_ssl_validation if config[:disable_ssl_validation]
         server = create_server
         state[:server_id] = server.id
-        info "OpenStack instance with ID of <#{state[:server_id]}> is ready."
 
         # this is due to the glance_caching issues. Annoying yes, but necessary.
-        debug "Waiting for VM to be in ACTIVE state for a max time of:#{config[:glance_cache_wait_timeout]} seconds"
+        debug "Waiting for a max time of:#{config[:glance_cache_wait_timeout]} seconds for OpenStack server to be in ACTIVE state"
         server.wait_for(config[:glance_cache_wait_timeout]) do
           sleep(1)
+          raise(Kitchen::InstanceFailure, "OpenStack server ID <#{state[:server_id]}> build failed to ERROR state") if failed?
+
           ready?
         end
+        info "OpenStack server ID <#{state[:server_id]}> created"
 
         if config[:floating_ip]
           attach_ip(server, config[:floating_ip])
@@ -201,6 +203,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).
@@ -412,7 +420,7 @@ module Kitchen
       end
 
       def disable_ssl_validation
-        require "excon"
+        require "excon" unless defined?(Excon)
         Excon.defaults[:ssl_verify_peer] = false
       end
 
@@ -442,7 +450,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_version.rb

@@ -1,11 +1,10 @@
-# Encoding: UTF-8
 # frozen_string_literal: true
 
 #
 # Author:: Jonathan Hartman (<j@p4nt5.com>)
 #
 # Copyright (C) 2013-2015, Jonathan Hartman
-# Copyright (C) 2015-2020, 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.
@@ -24,6 +23,6 @@ module Kitchen
   #
   # @author Jonathan Hartman <j@p4nt5.com>
   module Driver
-    OPENSTACK_VERSION = "5.0.1"
+    OPENSTACK_VERSION = "6.2.0"
   end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-openstack
 version: !ruby/object:Gem::Version
-  version: 5.0.1
+  version: 6.2.0
 platform: ruby
 authors:
 - Jonathan Hartman
 - JJ Asghar
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-09 00:00:00.000000000 Z
+date: 2022-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-kitchen
@@ -20,7 +20,7 @@ dependencies:
         version: 1.4.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -30,7 +30,7 @@ dependencies:
         version: 1.4.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: fog-openstack
   requirement: !ruby/object:Gem::Requirement
@@ -159,7 +159,7 @@ homepage: https://github.com/test-kitchen/kitchen-openstack
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -167,15 +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: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: A Test Kitchen OpenStack Nova driver
 test_files: []