vmfloaty 0.8.2 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 04b7261aa013260aba635e266b003d845e4a2c58
-  data.tar.gz: 83bbc1c12ace45c6a1ea288121762f13d3b841ae
+SHA256:
+  metadata.gz: 248dd5c9a8890b8990a7dad8dd7a21f52c8a8c2b65112c55449a5b5d3ac818af
+  data.tar.gz: 22cf2070b571a0feded3967308e6b11d42b5ea296d94be7c434a73454611f6df
 SHA512:
-  metadata.gz: 4e38aedb270708b75d9464744b73b507a6dfdab100567a079287b6b06aa0ac57fabaa03e0e18761c5d1b21e2921f15fbd36ab5beeddcbf3266cac2981d90931c
-  data.tar.gz: 04ddaf46164b38bf84df47ee8d5a0e96d87b6be5d64941ee72a075e5264511c7556b8fdd85a2875fadfea37820cfbc307adc6dd46eb32621c1cb552d70cbec94
+  metadata.gz: 8cd836baeb4a37720024616f1ce113046fc6291cc73694edbaf74ee727648c1339ada9e004ba0d630822a315948d69bb9e6c67da1ec04df3ae079bf207a432c7
+  data.tar.gz: 46e15ff3d3d1cecd68cb92ed3fcd5d8240f68f45f704dff9fbf1e87007cae7b95b2d6f9d4b08753979b2c82fa6f412534a93e3bb17b96fb052003e821b31cf94

data/README.md

@@ -1,40 +1,64 @@
-vmfloaty
-========
-
-[![Gem Version](https://badge.fury.io/rb/vmfloaty.svg)](https://badge.fury.io/rb/vmfloaty) [![Build Status](https://travis-ci.org/briancain/vmfloaty.svg?branch=master)](https://travis-ci.org/briancain/vmfloaty)
-
-A CLI helper tool for [Puppet Labs vmpooler](https://github.com/puppetlabs/vmpooler) to help you stay afloat.
-
-<img src="http://i.imgur.com/xGcGwuH.jpg" width=200 height=200>
-
-This project is still supported by @briancain and @demophoon. Ping either of us if you'd like something merged and released.
+# vmfloaty
+
+[![Gem Version](https://badge.fury.io/rb/vmfloaty.svg)](https://badge.fury.io/rb/vmfloaty)
+[![Build Status](https://travis-ci.com/puppetlabs/vmfloaty.svg?branch=master)](https://travis-ci.com/puppetlabs/vmfloaty)
+[![Coverage Status](https://coveralls.io/repos/github/puppetlabs/vmfloaty/badge.svg?branch=master)](https://coveralls.io/github/puppetlabs/vmfloaty?branch=master)
+[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=puppetlabs/vmfloaty)](https://dependabot.com)
+
+A CLI helper tool for [Puppet's vmpooler](https://github.com/puppetlabs/vmpooler) to help you stay afloat.
+
+![float image](float.jpg)
+
+- [Install](#install)
+- [Usage](#usage)
+  - [Example workflow](#example-workflow)
+  - [vmfloaty dotfile](#vmfloaty-dotfile)
+    - [Basic configuration](#basic-configuration)
+    - [Default to Puppet's ABS instead of vmpooler](#default-to-puppets-abs-instead-of-vmpooler)
+    - [Configuring multiple services](#configuring-multiple-services)
+    - [Using a Nonstandard Pooler service](#using-a-nonstandard-pooler-service)
+    - [Valid config keys](#valid-config-keys)
+  - [Tab Completion](#tab-completion)
+- [vmpooler API](#vmpooler-api)
+- [Using the Pooler class](#using-the-pooler-class)
+  - [Example Projects](#example-projects)
+- [Special thanks](#special-thanks)
 
 ## Install
 
 Grab the latest from ruby gems...
 
-```
-$ gem install vmfloaty
-...
-...
-$ floaty --help
+```bash
+gem install vmfloaty
 ```
 
 ## Usage
 
-```
-    delete   Schedules the deletion of a host or hosts
-    get      Gets a vm or vms based on the os argument
-    help     Display global or [command] help documentation
-    list     Shows a list of available vms from the pooler or vms obtained with a token
-    modify   Modify a vms tags, time to live, and disk space
-    query    Get information about a given vm
-    revert   Reverts a vm to a specified snapshot
-    snapshot Takes a snapshot of a given vm
-    ssh      Grabs a single vm and sshs into it
-    status   Prints the status of pools in vmpooler
-    summary  Prints a summary of vmpooler
-    token    Retrieves or deletes a token or checks token status
+```plain
+$ floaty --help
+  NAME:
+
+    floaty
+
+  DESCRIPTION:
+
+    A CLI helper tool for Puppet's vmpooler to help you stay afloat
+
+  COMMANDS:
+
+    completion Outputs path to completion script
+    delete     Schedules the deletion of a host or hosts
+    get        Gets a vm or vms based on the os argument
+    help       Display global or [command] help documentation
+    list       Shows a list of available vms from the pooler or vms obtained with a token
+    modify     Modify a VM's tags, time to live, disk space, or reservation reason
+    query      Get information about a given vm
+    revert     Reverts a vm to a specified snapshot
+    snapshot   Takes a snapshot of a given vm
+    ssh        Grabs a single vm and sshs into it
+    status     Prints the status of pools in the pooler service
+    summary    Prints a summary of a pooler service
+    token      Retrieves or deletes a token or checks token status
 
   GLOBAL OPTIONS:
 
@@ -52,33 +76,43 @@ $ floaty --help
 
 Grabbing a token for authenticated pooler requests:
 
-```
-floaty token get --user username --url https://vmpooler.mycompany.net/api/v1
+```bash
+floaty token get --user username --url https://vmpooler.example.net/api/v1
 ```
 
 This command will then ask you to log in. If successful, it will return a token that you can save either in a dotfile or use with other cli commands.
 
 Grabbing vms:
 
-```
-floaty get centos-7-x86_64=2 debian-7-x86_64 windows-10=3 --token mytokenstring --url https://vmpooler.mycompany.net/api/v1
+```bash
+floaty get centos-7-x86_64=2 debian-7-x86_64 windows-10=3 --token mytokenstring --url https://vmpooler.example.net/api/v1
 ```
 
 ### vmfloaty dotfile
 
-If you do not wish to continuely specify various config options with the cli, you can have a dotfile in your home directory for some defaults. For example:
+If you do not wish to continually specify various config options with the cli, you can have a dotfile in your home directory for some defaults. For example:
 
 #### Basic configuration
 
 ```yaml
-# file at /Users/me/.vmfloaty.yml
-url: 'https://vmpooler.mycompany.net/api/v1'
+# file at ~/.vmfloaty.yml
+url: 'https://vmpooler.example.net/api/v1'
 user: 'brian'
 token: 'tokenstring'
 ```
 
 Now vmfloaty will use those config files if no flag was specified.
 
+#### Default to Puppet's ABS instead of vmpooler
+
+```yaml
+# file at ~/.vmfloaty.yml
+url: 'https://abs.example.net'
+user: 'brian'
+token: 'tokenstring'
+type: 'abs'
+```
+
 #### Configuring multiple services
 
 Most commands allow you to specify a `--service <servicename>` option to allow the use of multiple vmpooler instances. This can be useful when you'd rather not specify a `--url` or `--token` by hand for alternate services.
@@ -90,10 +124,10 @@ To configure multiple services, you can set up your `~/.vmfloaty.yml` config fil
 user: 'brian'
 services:
   main:
-    url: 'https://vmpooler.mycompany.net/api/v1'
+    url: 'https://vmpooler.example.net/api/v1'
     token: 'tokenstring'
   alternate:
-    url: 'https://vmpooler.alternate.net/api/v1'
+    url: 'https://vmpooler.example.com/api/v1'
     token: 'alternate-tokenstring'
 ```
 
@@ -105,14 +139,16 @@ services:
 Examples using the above configuration:
 
 List available vm types from our main vmpooler instance:
-```sh
+
+```bash
 floaty list --service main
 # or, since the first configured service is used by default:
 floaty list
 ```
 
 List available vm types from our alternate vmpooler instance:
-```sh
+
+```bash
 floaty list --service alternate
 ```
 
@@ -125,17 +161,22 @@ vmfloaty is capable of working with Puppet's [nonstandard pooler](https://github
 user: 'brian'
 services:
   vm:
-    url: 'https://vmpooler.mycompany.net/api/v1'
+    url: 'https://vmpooler.example.net/api/v1'
     token: 'tokenstring'
   ns:
-    url: 'https://nspooler.mycompany.net/api/v1'
+    url: 'https://nspooler.example.net/api/v1'
     token: 'nspooler-tokenstring'
     type: 'nonstandard'  # <-- 'type' is necessary for any non-vmpooler service
+  abs:
+    url: 'https://abs.example.net/'
+    token: 'abs-tokenstring'
+    type: 'abs'  # <-- 'type' is necessary for any non-vmpooler service
+
 ```
 
 With this configuration, you could list available OS types from nspooler like this:
 
-```sh
+```bash
 floaty list --service ns
 ```
 
@@ -143,20 +184,16 @@ floaty list --service ns
 
 Here are the keys that vmfloaty currently supports:
 
-- verbose
-  + Boolean
-- token
-  + String
-- user
-  + String
-- url
-  + String
-- services
-  + Map
+- verbose (Boolean)
+- token (String)
+- user (String)
+- url (String)
+- services (String)
+- type (String)
 
 ### Tab Completion
 
-There is a basic completion script for Bash (and possibly other shells) included with the gem in the [extras/completions](https://github.com/briancain/vmfloaty/blob/master/extras/completions) folder. To activate, that file simply needs to be sourced somehow in your shell profile.
+There is a basic completion script for Bash (and possibly other shells) included with the gem in the [extras/completions](https://github.com/puppetlabs/vmfloaty/blob/master/extras/completions) folder. To activate, that file simply needs to be sourced somehow in your shell profile.
 
 For convenience, the path to the completion script for the currently active version of the gem can be found with the `floaty completion` subcommand. This makes it easy to add the completion script to your profile like so:
 
@@ -181,6 +218,10 @@ vmfloaty providers a `Pooler` class that gives users the ability to make request
 ### Example Projects
 
 - [John McCabe: vmpooler-bitbar](https://github.com/johnmccabe/vmpooler-bitbar/)
-  + vmpooler status and management in your menubar with bitbar
+  - vmpooler status and management in your menubar with bitbar
 - [Brian Cain: vagrant-vmpooler](https://github.com/briancain/vagrant-vmpooler)
-  + Use Vagrant to manage your vmpooler instances
+  - Use Vagrant to manage your vmpooler instances
+
+## Special thanks
+
+Special thanks to [Brian Cain](https://github.com/briancain) as he is the original author of vmfloaty! Vast amounts of this code exist thanks to his efforts.

data/bin/floaty

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
 
 require 'vmfloaty'
 

data/lib/vmfloaty.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'rubygems'
 require 'commander'
@@ -13,13 +13,14 @@ require 'vmfloaty/conf'
 require 'vmfloaty/utils'
 require 'vmfloaty/service'
 require 'vmfloaty/ssh'
+require 'vmfloaty/logger'
 
 class Vmfloaty
   include Commander::Methods
 
-  def run
+  def run # rubocop:disable Metrics/AbcSize
     program :version, Vmfloaty::VERSION
-    program :description, 'A CLI helper tool for Puppet Labs VM poolers to help you stay afloat'
+    program :description, "A CLI helper tool for Puppet's vmpooler to help you stay afloat"
 
     config = Conf.read_config
 
@@ -33,9 +34,11 @@ class Vmfloaty
       c.option '--user STRING', String, 'User to authenticate with'
       c.option '--url STRING', String, 'URL of pooler service'
       c.option '--token STRING', String, 'Token for pooler service'
+      c.option '--priority STRING', 'Priority for supported backends(ABS) (High(1), Medium(2), Low(3))'
       c.option '--notoken', 'Makes a request without a token'
       c.option '--force', 'Forces vmfloaty to get requested vms'
       c.option '--json', 'Prints retrieved vms in JSON format'
+      c.option '--ondemand', 'Requested vms are provisioned upon receival of the request, tracked by a request ID'
       c.action do |args, options|
         verbose = options.verbose || config['verbose']
         service = Service.new(options, config)
@@ -43,28 +46,32 @@ class Vmfloaty
         force = options.force
 
         if args.empty?
-          STDERR.puts "No operating systems provided to obtain. See `floaty get --help` for more information on how to get VMs."
+          FloatyLogger.error 'No operating systems provided to obtain. See `floaty get --help` for more information on how to get VMs.'
           exit 1
         end
 
         os_types = Utils.generate_os_hash(args)
 
         max_pool_request = 5
-        large_pool_requests = os_types.select{|_,v| v > max_pool_request}
-        if ! large_pool_requests.empty? and ! force
-          STDERR.puts "Requesting vms over #{max_pool_request} requires a --force flag."
-          STDERR.puts "Try again with `floaty get --force`"
+        large_pool_requests = os_types.select { |_, v| v > max_pool_request }
+        if !large_pool_requests.empty? && !force
+          FloatyLogger.error "Requesting vms over #{max_pool_request} requires a --force flag."
+          FloatyLogger.error 'Try again with `floaty get --force`'
           exit 1
         end
 
         if os_types.empty?
-          STDERR.puts "No operating systems provided to obtain. See `floaty get --help` for more information on how to get VMs."
+          FloatyLogger.error 'No operating systems provided to obtain. See `floaty get --help` for more information on how to get VMs.'
           exit 1
         end
 
-        response = service.retrieve(verbose, os_types, use_token)
+        response = service.retrieve(verbose, os_types, use_token, options.ondemand)
+        request_id = response['request_id'] if options.ondemand
+        response = service.wait_for_request(verbose, request_id) if options.ondemand
+
         hosts = Utils.standardize_hostnames(response)
-        if options.json
+
+        if options.json || options.ondemand
           puts JSON.pretty_generate(hosts)
         else
           puts Utils.format_host_output(hosts)
@@ -84,6 +91,7 @@ class Vmfloaty
       c.option '--url STRING', String, 'URL of pooler service'
       c.action do |args, options|
         verbose = options.verbose || config['verbose']
+
         service = Service.new(options, config)
         filter = args[0]
 
@@ -143,18 +151,18 @@ class Vmfloaty
         hostname = args[0]
         modify_all = options.all
 
-        if hostname.nil? and !modify_all
-          STDERR.puts "ERROR: Provide a hostname or specify --all."
+        if hostname.nil? && !modify_all
+          FloatyLogger.error 'ERROR: Provide a hostname or specify --all.'
           exit 1
         end
-        running_vms = modify_all ? service.list_active(verbose) : hostname.split(",")
+        running_vms = modify_all ? service.list_active(verbose) : hostname.split(',')
 
         tags = options.tags ? JSON.parse(options.tags) : nil
         modify_hash = {
-            lifetime: options.lifetime,
-            disk: options.disk,
-            tags: tags,
-            reason: options.reason
+          :lifetime => options.lifetime,
+          :disk     => options.disk,
+          :tags     => tags,
+          :reason   => options.reason,
         }
         modify_hash.delete_if { |_, value| value.nil? }
 
@@ -165,17 +173,17 @@ class Vmfloaty
             begin
               modified_hash[vm] = service.modify(verbose, vm, modify_hash)
             rescue ModifyError => e
-              STDERR.puts e
+              FloatyLogger.error e
               ok = false
             end
           end
           if ok
             if modify_all
-              puts "Successfully modified all VMs."
+              puts 'Successfully modified all VMs.'
             else
               puts "Successfully modified VM #{hostname}."
             end
-            puts "Use `floaty list --active` to see the results."
+            puts 'Use `floaty list --active` to see the results.'
           end
         end
       end
@@ -183,9 +191,11 @@ class Vmfloaty
 
     command :delete do |c|
       c.syntax = 'floaty delete hostname,hostname2 [options]'
+      c.syntax += "\n    floaty delete job1,job2 [options] (only supported with ABS)"
       c.summary = 'Schedules the deletion of a host or hosts'
-      c.description = 'Given a comma separated list of hostnames, or --all for all vms, vmfloaty makes a request to the pooler service to schedule the deletion of those vms.'
+      c.description = 'Given a comma separated list of hostnames, or --all for all vms, vmfloaty makes a request to the pooler service to schedule the deletion of those vms. If you are using the ABS service, you can also pass in JobIDs here. Note that passing in a Job ID will delete *all* of the hosts in the job.' # rubocop:disable Layout/LineLength
       c.example 'Schedules the deletion of a host or hosts', 'floaty delete myhost1,myhost2 --url http://vmpooler.example.com'
+      c.example 'Schedules the deletion of a JobID or JobIDs', 'floaty delete 1579300120799,1579300120800 --url http://abs.example.com'
       c.option '--verbose', 'Enables verbose output'
       c.option '--service STRING', String, 'Configured pooler service name'
       c.option '--all', 'Deletes all vms acquired by a token'
@@ -205,15 +215,12 @@ class Vmfloaty
         if delete_all
           running_vms = service.list_active(verbose)
           if running_vms.empty?
-            STDERR.puts "You have no running VMs."
+            puts 'You have no running VMs.'
           else
-            Utils.pretty_print_hosts(verbose, service, running_vms)
+            Utils.pretty_print_hosts(verbose, service, running_vms, true)
             # Confirm deletion
-            puts
             confirmed = true
-            unless force
-              confirmed = agree('Delete all these VMs? [y/N]')
-            end
+            confirmed = agree('Delete all these VMs? [y/N]') unless force
             if confirmed
               response = service.delete(verbose, running_vms)
               response.each do |hostname, result|
@@ -236,20 +243,20 @@ class Vmfloaty
             end
           end
         else
-          STDERR.puts "You did not provide any hosts to delete"
+          FloatyLogger.info 'You did not provide any hosts to delete'
           exit 1
         end
 
         unless failures.empty?
-          STDERR.puts 'Unable to delete the following VMs:'
+          FloatyLogger.info 'Unable to delete the following VMs:'
           failures.each do |hostname|
-            STDERR.puts "- #{hostname}"
+            FloatyLogger.info "- #{hostname}"
           end
-          STDERR.puts 'Check `floaty list --active`; Do you need to specify a different service?'
+          FloatyLogger.info 'Check `floaty list --active`; Do you need to specify a different service?'
         end
 
         unless successes.empty?
-          puts unless failures.empty?
+          FloatyLogger.info unless failures.empty?
           puts 'Scheduled the following VMs for deletion:'
           successes.each do |hostname|
             puts "- #{hostname}"
@@ -277,7 +284,7 @@ class Vmfloaty
         begin
           snapshot_req = service.snapshot(verbose, hostname)
         rescue TokenError, ModifyError => e
-          STDERR.puts e
+          FloatyLogger.error e
           exit 1
         end
 
@@ -302,14 +309,12 @@ class Vmfloaty
         hostname = args[0]
         snapshot_sha = args[1] || options.snapshot
 
-        if args[1] && options.snapshot
-          STDERR.puts "Two snapshot arguments were given....using snapshot #{snapshot_sha}"
-        end
+        FloatyLogger.info "Two snapshot arguments were given....using snapshot #{snapshot_sha}" if args[1] && options.snapshot
 
         begin
           revert_req = service.revert(verbose, hostname, snapshot_sha)
         rescue TokenError, ModifyError => e
-          STDERR.puts e
+          FloatyLogger.error e
           exit 1
         end
 
@@ -372,28 +377,26 @@ class Vmfloaty
 
         begin
           case action
-            when 'get'
-              token = service.get_new_token(verbose)
-              puts token
-            when 'delete'
-              result = service.delete_token(verbose, options.token)
-              puts result
-            when 'status'
-              token_value = options.token
-              if token_value.nil?
-                token_value = args[1]
-              end
-              status = service.token_status(verbose, token_value)
-              puts status
-            when nil
-              STDERR.puts 'No action provided'
-              exit 1
-            else
-              STDERR.puts "Unknown action: #{action}"
-              exit 1
+          when 'get'
+            token = service.get_new_token(verbose)
+            puts token
+          when 'delete'
+            result = service.delete_token(verbose, options.token)
+            puts result
+          when 'status'
+            token_value = options.token
+            token_value = args[1] if token_value.nil?
+            status = service.token_status(verbose, token_value)
+            puts status
+          when nil
+            FloatyLogger.error 'No action provided'
+            exit 1
+          else
+            FloatyLogger.error "Unknown action: #{action}"
+            exit 1
           end
         rescue TokenError => e
-          STDERR.puts e
+          FloatyLogger.error e
           exit 1
         end
         exit 0
@@ -417,15 +420,13 @@ class Vmfloaty
         use_token = !options.notoken
 
         if args.empty?
-          STDERR.puts "No operating systems provided to obtain. See `floaty ssh --help` for more information on how to get VMs."
+          FloatyLogger.error 'No operating systems provided to obtain. See `floaty ssh --help` for more information on how to get VMs.'
           exit 1
         end
 
         host_os = args.first
 
-        if args.length > 1
-          STDERR.puts "Can't ssh to multiple hosts; Using #{host_os} only..."
-        end
+        FloatyLogger.info "Can't ssh to multiple hosts; Using #{host_os} only..." if args.length > 1
 
         service.ssh(verbose, host_os, use_token)
         exit 0
@@ -435,13 +436,13 @@ class Vmfloaty
     command :completion do |c|
       c.syntax = 'floaty completion [options]'
       c.summary = 'Outputs path to completion script'
-      c.description = Utils.strip_heredoc(<<-EOF)
+      c.description = Utils.strip_heredoc(<<-DESCRIPTION)
         Outputs path to a completion script for the specified shell (or 'bash' if not specified). This makes it easy to add the completion script to your profile:
 
           source $(floaty completion --shell bash)
 
         This subcommand will exit non-zero with an error message if no completion script is available for the requested shell.
-      EOF
+      DESCRIPTION
       c.example 'Gets path to bash tab completion script', 'floaty completion --shell bash'
       c.option '--shell STRING', String, 'Shell to request completion script for'
       c.action do |_, options|
@@ -452,7 +453,7 @@ class Vmfloaty
           puts completion_file
           exit 0
         else
-          STDERR.puts "Could not find completion file for '#{shell}': No such file #{completion_file}"
+          FloatyLogger.error "Could not find completion file for '#{shell}': No such file #{completion_file}"
           exit 1
         end
       end