kitchen-vmpool 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65858fcfc101cec7b6e0f8a6ee346eec09dac93e
-  data.tar.gz: 433d4c11777002d5239e0b095c6863a66df324a9
+  metadata.gz: a292b2bf0b4134c9da983f663e16acbaa2f9582f
+  data.tar.gz: 1b41ec5d409d1fb0446036b1368a62b6354bfab2
 SHA512:
-  metadata.gz: a5bdd70bea4907ec7f6c14c1696f018e9bd23636e7cb6062f186cf34dddef52a51cb1284826341c5011810aec778957e8511501d6f4e4e54ec939a8850d55b81
-  data.tar.gz: adc49044d3030ed33a1576c3c3ab950c552f5210b750793037e7d0add19f8ebee3ecfada9eca7bcbb09dcfc29c07854ac6303b25d5a03c89230cdc003d357571
+  metadata.gz: c8dd58b8dff118a7a95c3cee1e41859a3196eb2fb05d72cf04e0d105001cb05f68598b6d28af4d3d08c30e388d1c16632ff171abe373bb711e4e9bc88301b497
+  data.tar.gz: 7b934a2d02593fc3ba9942b3e16e90e342079b61c5fcf8ab204377eed615a405a81eba81ce17eb15c54af90f0712660af4b8dd62ad7ddfadb8073dabfdde1f9d

data/.gitignore

@@ -1,6 +1,6 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
+#/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/
@@ -10,3 +10,5 @@
 
 # rspec failure tracking
 .rspec_status
+.kitchen/
+.kitchen.local.yml

data/.kitchen.yml

@@ -0,0 +1,30 @@
+---
+
+# Example kitchen file configured to use vmpooler
+# if using this please ensure you have vmpooler running on localhost:8080
+# You can start a dummy instance via docker
+# docker run -e VMPOOLER_DEBUG=true -p 8080:4567 \
+#  -e VMPOOLER_LOG='/var/log/vmpooler/vmpooler.log' -it --rm --name pooler nwops/vmpooler
+driver:
+  name: vmpool
+  state_store: vmpooler
+  store_options:
+    user: 'jdoe'
+    pass: 'jdoe123'
+    token: 'token'
+    host_url: 'http://localhost:8080'
+platforms:
+    - name: debian-7-x86_64
+      driver:
+        pool_name: debian-7-x86_64
+    - name: debian-7-i386
+      driver:
+        pool_name: debian-7-i386
+
+provisioner:
+  name: shell
+
+suites:
+  - name: default
+    run_list:
+    attributes:

data/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+## 0.4.0
+ * Adds vmpooler store for the ultimate in pool stores
+
 ## v0.3.2
  * Destroy process does not output correct hostname
  * Delete old instances from used_instances pool
@@ -18,4 +21,4 @@
  
 ## v0.2.0
  * adds a gitlab commit store
- * Fix accounting bugs with used and pool instances
+ * Fix accounting bugs with used and pool instances

data/Gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: .
+  specs:
+    kitchen-vmpool (0.4.0)
+      gitlab (~> 4.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    artifactory (2.8.2)
+    coderay (1.1.1)
+    diff-lcs (1.3)
+    gitlab (4.2.0)
+      httparty
+      terminal-table
+    httparty (0.15.6)
+      multi_xml (>= 0.5.2)
+    method_source (0.8.2)
+    mixlib-install (2.1.12)
+      artifactory
+      mixlib-shellout
+      mixlib-versioning
+      thor
+    mixlib-shellout (2.3.2)
+    mixlib-versioning (1.2.2)
+    multi_xml (0.6.0)
+    net-scp (1.2.1)
+      net-ssh (>= 2.6.5)
+    net-ssh (4.1.0)
+    net-ssh-gateway (1.3.0)
+      net-ssh (>= 2.6.5)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (12.0.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    safe_yaml (1.0.4)
+    slop (3.6.0)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    test-kitchen (1.16.0)
+      mixlib-install (>= 1.2, < 3.0)
+      mixlib-shellout (>= 1.2, < 3.0)
+      net-scp (~> 1.1)
+      net-ssh (>= 2.9, < 5.0)
+      net-ssh-gateway (~> 1.2)
+      safe_yaml (~> 1.0)
+      thor (~> 0.19, < 0.19.2)
+    thor (0.19.1)
+    unicode-display_width (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  gitlab
+  kitchen-vmpool!
+  pry
+  rake
+  rspec
+  test-kitchen
+
+BUNDLED WITH
+   1.15.4

data/README.md

@@ -1,11 +1,13 @@
-# Kitchen::Vmpool
+# Kitchen-Vmpool
 
 Ever wished you didn't have to wait for test-kitchen to create a test node?  With kitchen-vmpool you can create your test nodes
 ahead of time and simply populate the pool with the list of hostnames.  During the create step test kitchen will select a member
 of the test pool and you will instantly have a system to work with.
 
 Kitchen-vmpool allows external scripts or programs to populate the pool so it is not tied to any single vm/container technology.
-Additionaly, kitchen-vmpool contains a pluggable storage backend so that you can store the pool information in just about anything. 
+Additionaly, kitchen-vmpool contains a pluggable storage backend so that you can store the pool information in just about anything.
+
+Increase your perceived test kitchen host creation time by 200x!
 
 ## Installation
 
@@ -24,13 +26,37 @@ Or install it yourself as:
 
 ## Usage
 
-To use setup the kitchen driver to use the vmpool store and configure one of the stores if required. 
+To use setup the kitchen driver to use the vmpool store and configure one of the stores if required.
+
+## Intro
+### Adding members to the pool
+Kitchen-vmpool is agnostic to any vm/container technology.  This means you can use whatever provisioning mechanism you need to create a system or container.
+However, it is expected that you will be provisioning hosts outside of your normal test-kitchen workflow.  
+So all those cool fancy kitchen driver plugins cannot be used with vmpool.  But if you are reading this, that means your drivers take too long to spin up
+an instance anyways.  So this means that you will need an external process that spins up instances.
+
+In fact there is a tool that helps immensely with this already: [VMPooler](https://github.com/puppetlabs/vmpooler)
+
+As I mentioned about you can use vmpooler or create a script to initially and constly generate your pool members.
+Expect a scheduled/cron job to constant keep pool members in the pool.
+
+An example working script I created for usage with VMware VRA can be found in the exe folder of this gem.  However, I will
+later be transitioning to [VMPooler](https://github.com/puppetlabs/vmpooler).
+
+### State Stores
+When we are working with vmpools we need a way to store metadata about that pools and how many instances are required and currently available for each pool.  The easiest way to do this at first is to put that data in a file.
+However, most people need things like central locking and management layers in front of that data.  So Kitchen-vmpool creates a framework for many other
+state stores to be used.  Vmpool even allows the user to create their own state store and package as a separate gem.  
+Test kitchen will use these state stores to get members of the pools in order to test against.
+
+## Currently Available State stores
 
 ### Gitlab Commit Store Example
 If you have no central place to store files the gitlab_commit store may be an option for you.
-If you have a simple setup thus may suffice.  If you plan to expand your usage of test kitchen to 
+If you have a simple setup this may suffice.  If you plan to expand your usage of test kitchen to
 include multiple parallel test runs, you may run into race conditions due to the lack of a central queue
 to handle reads and writes.  Perfect for simple setups.  Later on you can move to a different state store.
+Due to a gitlab bug I recommend naming your file without a file extension.
 
 ```yaml
 driver:
@@ -40,7 +66,7 @@ driver:
   store_options:
     pool_file: 'vmpool'
     project_id: 329302
-    
+
 platforms:
     - name: rhel6
       driver:
@@ -48,13 +74,14 @@ platforms:
     - name: windows10
       driver:
         pool_name: windows10_pool  
-    
+
 ```
 
 ### Gitlab Snippet Store Example
 I don't recommend using the snippet store because gitlab's permission's model only allows a single
 user to make changes.  Therefore this is a bad central place to keep things if only a single user can update.
-Use this as an example to create your own store providers.
+Use this as an example to create your own store providers.  This originally sounded like a good idea, but later turned out
+to be bad idea due to the permissions model in Gitlab.
 
 ```yaml
 driver:
@@ -65,7 +92,7 @@ driver:
     pool_file: 'vmpool'
     project_id: 329302
     snippet_id: 49
-    
+
 platforms:
     - name: rhel6
       driver:
@@ -85,7 +112,29 @@ driver:
   state_store: file
   store_options:
     pool_file: 'vmpool'
-    
+
+platforms:
+    - name: rhel6
+      driver:
+        pool_name: base_rhel6_pool
+    - name: windows10
+      driver:
+        pool_name: windows10_pool      
+```
+
+### Vmpooler store
+Consider the Vmpooler state store to be the ultimate backend for kitchen-vmpool. You can now setup
+[vmpooler](https://github.com/puppetlabs/vmpooler) to continuously regenerate virtual machines in the background.
+
+```yaml
+driver:
+  name: vmpool
+  state_store: vmpooler
+  store_options:
+    user: 'jdoe'
+    pass: 'jdoe123'
+    token: 'token'
+    host_url: 'http://localhost:8080'
 platforms:
     - name: rhel6
       driver:
@@ -95,8 +144,22 @@ platforms:
         pool_name: windows10_pool      
 ```
 
-### Pool data structure
-The basic structure of the pool data can be found below.  This is the current format that each state store will follow. 
+You will notice that the `reuse_instances` and `pool_file` options are not needed in this driver config. However, we do need to supply some new options. The vmpooler store relies on an external service, so we need to provide an address
+(`host_url`) and authentication credentials (`token` or `user` and `pass`).
+
+For the platforms you will want to supply the pool_name that matches with your vmpooler's pools.
+
+You can create a test dummy instance of vmpooler to play around with:
+
+`docker run -e VMPOOLER_DEBUG=true -p 8080:4567  -e VMPOOLER_LOG='/var/log/vmpooler/vmpooler.log' -it --rm --name pooler nwops/vmpooler`
+
+Vmpooler should start running on http://localhost:8080
+
+### File based pool data structure
+File based state stores require a file to store the data.  Duh!  In order to have
+a common format between all the file based state stores you should use the data structure
+below.  If you make your own state store you can do whatever you desire.  All state stores in this gem will use the
+format below.
 
 ```yaml
 base_rhel6_pool:
@@ -105,27 +168,20 @@ base_rhel6_pool:
   pool_instances: []
   requests: []
   used_instances: []
-  
+
 windows10_pool:
   payload_file: windows10_payload.json
   size: 1
   pool_instances: []
   requests: []
   used_instances: []
-     
+
 ```
 
-The payload_file key is not required and was used for other purposes outside of kitchen-vmpool in order to create the instances.
+The `payload_file` key is not required and was used for other purposes outside of kitchen-vmpool in order to create the vra instances.
 It can be expected that some users will throw extra metadata in these pools for their own purposes.  So care must be
-taken to not wipe out this data when creating a store.
-
-### Puppet's VMpooler
-Consider the VMpooler state store to be the ultimate backend for kitchen-vmpool.  While vmpool doesn't currently support vmpooler
-it is on the roadmap to support. 
-
-https://github.com/puppetlabs/vmpooler
+taken to not wipe out this data when creating a new state store.
 
-Once the vmpooler state store is implemented this kitchen plugin might be pretty popular.
 
 ## Development
 
@@ -140,13 +196,13 @@ Puppet's vmpooler will handle the maintenance of the pool state which is probabl
 
 In order to create a new state store you must do the following:
 
-1. inherit from the BaseStore or a subclass of the BaseStore
+1. Inherit from the BaseStore or a subclass of the BaseStore
 2. Implement the following methods:
-    * initialize(options = {}) 
+    * initialize(options = {})
     * take_pool_member
-    * mark_unused
-    
-4. All other methods used with your store must be private 
+    * cleanup
+
+3. All other methods used with your store must be private
 
 You must be careful to overwrite the entire pool data.  It is expected that some users
 will put other metadata in the pool file for other purposes.  So when you write your data
@@ -168,15 +224,18 @@ module Kitchen
           return member
         end
 
-        # @param name [String] - the hostname to mark not used
-        # @return Array[String] - list of unused instances
-        def mark_unused(name, pool_name, reuse = false)
-          if reuse
-            used_hosts(pool_name).delete(name)
-            pool_hosts(pool_name) << name unless pool_hosts(pool_name).include?(name)
+        # @param pool_member [String] a VM instance
+        # @param pool_name [String] a VM pool
+        # @param reuse_instances [Boolean] whether or not to mark used VM instances as unused
+        def cleanup(pool_member:, pool_name:, reuse_instances:, &block)
+          used_status = 'used'
+
+          if reuse_instances
+            mark_unused(pool_member, pool_name)
+            used_status = 'unused'
           end
-          save
-          pool_hosts(pool_name)
+
+          block.call(pool_member, used_status)
         end
       end
     end
@@ -191,14 +250,85 @@ You can pass configuration to your store by setting the `store_options` in the d
 that allows the user to pass in required settings if your store requires configuration.  It is up to you
 use these options since not every store will require configuration.
 
+### Custom State Store Distrubtion
+If you think many will benefit from your new state store please create a PR and have it merged to the kithen-vmpool core.
+We want to limit dependencies so if your fancy state store has some dependencies it would probably be best to create your own gem.
+
+It is easiest to create a gem using bundler.  Please use the naming convention kitchen-vmpool-storename when creating your gem.
+
+1. `bundler gem --test=rspec kitchen-vmpool-fancystore`
+2. Create a kitchen/driver directory
+3. Move the vmpool directory underneath kitchen/driver directory
+4. rename vmpool directory to vmpool_stores
+```
+lib
+└── kitchen
+    └── driver
+        └── vmpool_stores
+            ├── fancystore
+            │   └── version.rb
+            └── fancystore.rb --> your code goes in this file
+
+```
+
+There is much more to bundling this into a gem but the procedures are the same for every gem.  So add gem dependencies if required
+and be sure to add unit tests for your state store.
 
 ### Development Setup
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+
+## VMware VRA Pool creation scripts
+I had a need to interface kitchen-vmpool with VRA in order to build catalog items.  So I ended up creating some basic scripts that utilize the [vmware-vra gem](https://github.com/chef-partners/vmware-vra-gem)
+to help build the catalog items.  I am also using the gitlab_commit store as my storage backend.  Don't ask why it is all I had.
+
+Warning: this code is very custom for my own needs and utilizes the gitlab_commit store for state storage.  
+
+### Usage
+
+Gems required:
+ - hashdiff
+ - vmware-vra
+ - gitlab
+ - highline
+
+Help: `vra_create_pool -h`
+Create a pool: `vra_create_pool -f vmpool -p 1234`
+
+Requires the basic file based vmpool file
+
+```yaml
+base_rhel6_pool:
+  payload_file: base_rhel6_payload.json
+  size: 1
+  pool_instances: []
+  requests: []
+  used_instances: []
+
+```
+
+I have some PRs open to help make using VRA payloads files easier with vmware-vra.
+
+See:
+  - https://github.com/chef-partners/vmware-vra-gem/pull/57
+  - https://github.com/chef-partners/vmware-vra-gem/pull/56
+
+You should be able to easily swap out the store for something else too.  Just edit the vra_create_pool file here.
+
+```ruby
+# @return [Hash] - a store hash that contains one or more pools
+# @option project_id [Integer] - the project id in gitlab
+# @option pool_file [String] - the snipppet file name
+def store(store_options = options)
+  # create a new instance of the store with the provided options
+  @store ||= Kitchen::Driver::VmpoolStores::GitlabCommitStore.new(store_options)
+end
+
+```
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/logicminds/kitchen-vmpool. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/nwops/kitchen-vmpool. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/Rakefile

@@ -4,3 +4,10 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+
+begin
+  require 'kitchen/rake_tasks'
+  Kitchen::RakeTasks.new
+rescue LoadError
+  puts '>>>>> Kitchen gem not loaded, omitting tasks' unless ENV['CI']
+end

data/lib/kitchen/driver/vmpool.rb

@@ -49,13 +49,18 @@ module Kitchen
 
       # (see Base#destroy)
       def destroy(state)
-        return if state[:hostname].nil?
-        store.mark_unused(state[:hostname], config[:pool_name], config[:reuse_instances])
-        if config[:reuse_instances]
-          info("Marking pool member #{state[:hostname]} as unused")
-        else
-          info("Marking pool member #{state[:hostname]} as used")
+        return unless state[:hostname]
+
+        opts = {
+            pool_member: state[:hostname],
+            pool_name: config[:pool_name],
+            reuse_instances: config[:reuse_instances],
+        }
+
+        store.cleanup(**opts) do |host, used_status|
+          info("Marking pool member #{host} as #{used_status}")
         end
+
         state.delete(:hostname)
       end
 
@@ -79,7 +84,6 @@ module Kitchen
           klass.send(:new, store_opts)
         end
       end
-
     end
   end
 end

data/lib/kitchen/driver/vmpool_stores/base_store.rb

@@ -4,10 +4,22 @@ require 'kitchen'
 module Kitchen
   module Driver
     class PoolMemberNotFound < Exception; end
+    class PoolNotFound < Exception; end
+    class PoolIsEmpty < Exception; end
+    class PoolMemberUnavailable < Exception; end
+    class TokenNotCreated < Exception; end
+    class AuthenticationRequired < Exception; end
+    class InvalidCredentials < Exception; end
+    class PoolMemberNotDestroyed < Exception; end
+    class InvalidUrl < Exception; end
 
     module VmpoolStores
       class BaseStore
 
+        def initialize(options = {})
+          
+        end
+
         # @return [String] - a random host from the list of systems
         # mark them used so nobody else can use it
         # @param pool_name [String] - the name of the pool to yank the memeber from
@@ -15,10 +27,11 @@ module Kitchen
           raise NotImplemented
         end
 
-        # @param name [String] - the hostname to mark not used
-        # @param pool_name [String] - the name of the pool to yank the memeber from
-        # @return Array[String] - list of unused instances
-        def mark_unused(name, pool_name, reuse = false)
+        # @param pool_member [String] - the name of the VM
+        # @param pool_name [String] - the name of the pool
+        # @param reuse_instances [Boolean] - whether or not the VM should be discarded when used
+        # a callback that executes when a pool member has been run
+        def cleanup(pool_member: nil, pool_name: nil, reuse_instances: false, &block)
           raise NotImplemented
         end
       end

data/lib/kitchen/driver/vmpool_stores/file_base_store.rb

@@ -1,4 +1,5 @@
 require "kitchen/driver/vmpool_stores/base_store"
+require 'kitchen/logging'
 
 module Kitchen
   module Driver
@@ -15,18 +16,20 @@ module Kitchen
           member = pool_hosts(pool_name).sample
           raise Kitchen::Driver::PoolMemberNotFound.new("No pool members exist for #{pool_name}, please create some pool members") unless member
           mark_used(member, pool_name)
-          return member
+          member
         end
 
-        # @param name [String] - the hostname to mark not used
-        # @return Array[String] - list of unused instances
-        def mark_unused(name, pool_name, reuse = false)
-          if reuse
-            used_hosts(pool_name).delete(name)
-            pool_hosts(pool_name) << name unless pool_hosts(pool_name).include?(name)
+        # @param pool_member [String] a VM instance
+        # @param pool_name [String] a VM pool
+        # @param reuse_instances [Boolean] whether or not to mark used VM instances as unused
+        def cleanup(pool_member:, pool_name:, reuse_instances:)
+          used_status = 'used'
+
+          if reuse_instances
+            mark_unused(pool_member, pool_name)
+            used_status = 'unused'
           end
-          save
-          pool_hosts(pool_name)
+          yield(pool_member, used_status) if block_given?
         end
 
         def pool_data(refresh = false)
@@ -63,6 +66,27 @@ module Kitchen
 
         private
 
+        # @param name [String] - the hostname to mark used
+        # @return Array[String] - list of used instances
+        def mark_used(name, pool_name)
+          # ideally the member should not already be in this array
+          # but just in case we will protect against that
+          pool_hosts(pool_name).delete(name)
+          used_hosts(pool_name) << name unless used_hosts(pool_name).include?(name)
+          save
+          used_hosts(pool_name)
+        end
+
+        # @param name [String] - the hostname to mark not used
+        # @return Array[String] - list of unused instances
+        def mark_unused(name, pool_name)
+          used_hosts(pool_name).delete(name)
+          pool_hosts(pool_name) << name unless pool_hosts(pool_name).include?(name)
+          save
+          pool_hosts(pool_name)
+        end
+
+
         # @return Array[String] - a list of pool names
         def pool_names
           pool_data.keys
@@ -89,17 +113,6 @@ module Kitchen
           pool(pool_name)['used_instances'] ||= []
         end
 
-        # @param name [String] - the hostname to mark used
-        # @return Array[String] - list of used instances
-        def mark_used(name, pool_name)
-          # ideally the member should not already be in this array
-          # but just in case we will protect against that
-          pool_hosts(pool_name).delete(name)
-          used_hosts(pool_name) << name unless used_hosts(pool_name).include?(name)
-          save
-          used_hosts(pool_name)
-        end
-        
         def read_content
           raise NotImplementedError
         end

data/lib/kitchen/driver/vmpool_stores/file_store.rb

@@ -1,8 +1,11 @@
 require "kitchen/driver/vmpool_stores/file_base_store"
+require 'kitchen/logging'
+
 module Kitchen
   module Driver
     module VmpoolStores
       class FileStore < FileBaseStore
+        include Kitchen::Logging
 
         # @option pool_file [String] - the file path that holds the pool information
         def initialize(options = nil)

data/lib/kitchen/driver/vmpool_stores/vmpooler_store.rb

@@ -0,0 +1,147 @@
+require 'net/http'
+require 'timeout'
+require 'json'
+require_relative 'base_store'
+
+module Kitchen
+  module Driver
+    module VmpoolStores
+      class VmpoolerStore < BaseStore
+        attr_reader :vmpooler_url, :token, :tags, :lifetime
+
+        # @param [Hash] opts
+        # @option opts [String] :host_url The hostname to use in http requests.
+        # @option opts [String] :user (nil) A username for authentication. Optional only if token is valid.
+        # @option opts [String] :password (nil) A password for authentication. Optional only if token is valid.
+        # @option opts [String] :token (nil) A preloaded token to use in requests. Optional only if
+        #                                       user and pass are valid.
+        # @raise [InvalidUrl] if vmpooler url is invalid
+        def initialize(opts = {})
+          host_url = opts.fetch('host_url')
+          user = opts.fetch('user', nil)
+          pass = opts.fetch('pass', nil)
+          token = opts.fetch('token', nil)
+          @tags = opts.fetch('tags', { purpose: 'vmpooler-default' })
+          @lifetime = opts.fetch('lifetime', nil)
+          @vmpooler_url = URI.join(host_url, '/api/v1/').to_s
+          raise Kitchen::Driver::InvalidUrl.new("Bad url: #{vmpooler_url}") unless valid_url?(URI.join(vmpooler_url, 'vm'))
+          @token = valid_token?(token) ? token : create_token(user, pass)
+        end
+
+        # @param pool_name [String] the pool to take from
+        # @return [String] a pool member from the pool
+        def take_pool_member(pool_name)
+          fetch_pool_member(pool_name)
+        end
+
+        # @param pool_member [String] the pool member to destroy
+        def cleanup(pool_member:, pool_name: nil, reuse_instances: false)
+          used_status = 'destroyed'
+          destroy_pool_member(pool_member)
+          yield(pool_member, used_status) if block_given?
+        end
+
+        private
+
+        # @param token [String] the token to validate
+        # @return [true] if the token url is valid
+        # @return [false] if the token url is invalid
+        def valid_token?(token)
+          if token and token.length > 5
+            token_url = URI.join(vmpooler_url, 'token', token).to_s
+            valid_url?(token_url)
+          end
+        end
+
+        # @param url [String] a url to validate
+        # @return [true] if the http response code is 200
+        # @return [false] if the http response code is not 200
+        def valid_url?(url)
+          if url
+            uri = URI(url)
+            response = Net::HTTP.get_response(uri)
+            response.code == '200'
+          end
+        end
+
+        # @param pool_member [String] a VM instance to destroy
+        # @raise [PoolMemberNotFound] if the pool member was not found
+        # @raise [PoolMemberNotDestroyed] if the pool member was not destroyed
+        def destroy_pool_member(pool_member)
+          uri = URI.join(vmpooler_url, 'vm/', pool_member)
+          request = Net::HTTP::Delete.new(uri)
+          request.add_field('X-AUTH-TOKEN', token)
+
+          req_options = {
+              use_ssl: uri.scheme == 'https',
+          }
+
+          response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+            http.request(request)
+          end
+
+          case
+          when response.code == '404'
+            raise Kitchen::Driver::PoolMemberNotFound.new("Pool member #{pool_member} was not found")
+          when response.code != '200'
+            raise Kitchen::Driver::PoolMemberNotDestroyed.new("Error destroying pool member: code #{response.code}, message #{response.body}")
+          end
+        end
+
+        # @param user [String]
+        # @param pass [String]
+        # @return [String] a new token if the http response code is 200
+        # @raise [InvalidCredentials] if the http response code is 401
+        # @raise [TokenNotCreated] if the http response code is otherwise not 200
+        def create_token(user, pass)
+          uri = URI.join(vmpooler_url, 'token')
+          request = Net::HTTP::Post.new(uri)
+          request.basic_auth(user, pass)
+
+          req_options = {
+              use_ssl: uri.scheme == 'https',
+          }
+
+          response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+            http.request(request)
+          end
+
+          return JSON.parse(response.body)['token'] if response.code == '200'
+          raise Kitchen::Driver::InvalidCredentials.new("Username or password are invalid") if response.code == '401'
+          raise Kitchen::Driver::TokenNotCreated.new("Unable to create token, got response code: #{response.code}")
+        end
+
+        # @return Array[String] - array of hostnames
+        # @param pool_name [String] - the name of the pool to get hostnames from
+        # @param number_of_vms [Integer] - a postive number of vms to fetch
+        def fetch_pool_member(pool_name, number_of_vms = 1)
+          uri = URI.join(vmpooler_url, 'vm')
+          request = Net::HTTP::Post.new(uri)
+          request.body = JSON.dump({ pool_name => number_of_vms.to_s })
+          request.add_field('X-AUTH-TOKEN', token)
+
+          req_options = {
+              use_ssl: uri.scheme == 'https',
+          }
+
+          response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+            http.request(request)
+          end
+
+          case response.code
+          when '200'
+            data = JSON.parse(response.body)
+            data[pool_name]['hostname']
+          when '503'
+            msg = "Pool #{pool_name} does not have enough active pool members, please try later."
+            raise Kitchen::Driver::PoolMemberUnavailable.new(msg)
+          when '404'
+            raise Kitchen::Driver::PoolNotFound.new("Pool #{pool_name} was not found")
+          else
+            raise Exception.new("Error: code #{response.code}, message #{response.body}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kitchen-vmpool/version.rb

@@ -1,3 +1,3 @@
 module KitchenVmpool
-  VERSION = "0.3.2"
-end
+  VERSION = "0.4.0"
+end

data/vmpool.yaml

@@ -1,8 +1,7 @@
 ---
 base_rhel6_pool:
-  pool_name: base_rhel6
   payload_file: base_rhel6_payload.json
-  instances: 1
+  size: 1
   pool_instances: []
   requests: []
   used_instances: []

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-vmpool
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Corey Osman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-11 00:00:00.000000000 Z
+date: 2017-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gitlab
@@ -75,12 +75,15 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".DS_Store"
 - ".gitignore"
+- ".kitchen.yml"
 - ".rspec"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -97,6 +100,7 @@ files:
 - lib/kitchen/driver/vmpool_stores/gitlab_base_store.rb
 - lib/kitchen/driver/vmpool_stores/gitlab_commit_store.rb
 - lib/kitchen/driver/vmpool_stores/gitlab_snippet_store.rb
+- lib/kitchen/driver/vmpool_stores/vmpooler_store.rb
 - vmpool.yaml
 homepage: https://gitlab.com/nwops/kitchen-vmpool
 licenses: