vmfloaty 0.7.9 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c7884840968e8735caff3146f276a2f9075cf79
-  data.tar.gz: 172f0dc34672fb184d62bb4dc7eb93d306e9d413
+  metadata.gz: 17d69277c7eb6a7e91324b79897833147913c900
+  data.tar.gz: af3ff211ec20d651442e2277cf12b42605e6b75f
 SHA512:
-  metadata.gz: ebfe08176a0505aa253849222afc98cf5b08361db264cee13fce6947b292434f1c466e23291fdee722b3b0cf658ac50335d61f78397190e3b489c237cab10806
-  data.tar.gz: 0d776b18978fb5fe8a1c893e1f2c1198fd78c7190561388eb7b1be334d79923ae0a39fa498e3007e7bc3c09834c05145cac5790195fa39c6c4e19d6f719254ae
+  metadata.gz: f14e92275d92c7aaca9d71d17a580588490e195adc4e192ab15f5d8149096d0fbab161adb63be404002beb2ca3a345fee99e9646d8e127fa9522da86fa2a344c
+  data.tar.gz: 48f146c619671dfc7f60e88e73c23f626e6a6798de1480c9209e05045830c02e4a4a3896a1164daa5f6e494883b1da73181ca1ab82c84a3b51b1bfbb6e9316d4

data/README.md

@@ -7,6 +7,8 @@ A CLI helper tool for [Puppet Labs vmpooler](https://github.com/puppetlabs/vmpoo
 
 <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.
+
 ## Install
 
 Grab the latest from ruby gems...
@@ -66,8 +68,10 @@ floaty get centos-7-x86_64=2 debian-7-x86_64 windows-10=3 --token mytokenstring
 
 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:
 
+#### Basic configuration
+
 ```yaml
-#file at /Users/me/.vmfloaty.yml
+# file at /Users/me/.vmfloaty.yml
 url: 'https://vmpooler.mycompany.net/api/v1'
 user: 'brian'
 token: 'tokenstring'
@@ -75,6 +79,66 @@ token: 'tokenstring'
 
 Now vmfloaty will use those config files if no flag was specified.
 
+#### 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.
+
+To configure multiple services, you can set up your `~/.vmfloaty.yml` config file like this:
+
+```yaml
+# file at /Users/me/.vmfloaty.yml
+user: 'brian'
+services:
+  main:
+    url: 'https://vmpooler.mycompany.net/api/v1'
+    token: 'tokenstring'
+  alternate:
+    url: 'https://vmpooler.alternate.net/api/v1'
+    token: 'alternate-tokenstring'
+```
+
+- If you run `floaty` without a `--service <name>` option, vmfloaty will use the first configured service by default.
+  With the config file above, the default would be to use the 'main' vmpooler instance.
+- If keys are missing for a configured service, vmfloaty will attempt to fall back to the top-level values.
+  With the config file above, 'brian' will be used as the username for both configured services, since neither specifies a username.
+
+Examples using the above configuration:
+
+List available vm types from our main vmpooler instance:
+```sh
+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
+floaty list --service alternate
+```
+
+#### Using a Nonstandard Pooler service
+
+vmfloaty is capable of working with Puppet's [nonstandard pooler](https://github.com/puppetlabs/nspooler) in addition to the default vmpooler API. To add a nonstandard pooler service, specify an API `type` value in your service configuration, like this:
+
+```yaml
+# file at /Users/me/.vmfloaty.yml
+user: 'brian'
+services:
+  vm:
+    url: 'https://vmpooler.mycompany.net/api/v1'
+    token: 'tokenstring'
+  ns:
+    url: 'https://nspooler.mycompany.net/api/v1'
+    token: 'nspooler-tokenstring'
+    type: 'nonstandard'  # <-- 'type' is necessary for any non-vmpooler service
+```
+
+With this configuration, you could list available OS types from nspooler like this:
+
+```sh
+floaty list --service ns
+```
+
 #### Valid config keys
 
 Here are the keys that vmfloaty currently supports:
@@ -87,6 +151,8 @@ Here are the keys that vmfloaty currently supports:
   + String
 - url
   + String
+- services
+  + Map
 
 ### Tab Completion
 

data/lib/vmfloaty/errors.rb

@@ -15,3 +15,9 @@ class MissingParamError < StandardError
     super
   end
 end
+
+class ModifyError < StandardError
+  def initialize(msg="Could not modify VM")
+    super
+  end
+end

data/lib/vmfloaty/nonstandard_pooler.rb

@@ -0,0 +1,135 @@
+require 'vmfloaty/errors'
+require 'vmfloaty/http'
+require 'faraday'
+require 'json'
+
+class NonstandardPooler
+  def self.list(verbose, url, os_filter = nil)
+    conn = Http.get_conn(verbose, url)
+
+    response = conn.get 'status'
+    response_body = JSON.parse(response.body)
+    os_list = response_body.keys.sort
+    os_list.delete 'ok'
+
+    os_filter ? os_list.select { |i| i[/#{os_filter}/] } : os_list
+  end
+
+  def self.list_active(verbose, url, token)
+    status = Auth.token_status(verbose, url, token)
+    status['reserved_hosts'] || []
+  end
+
+  def self.retrieve(verbose, os_type, token, url)
+    conn = Http.get_conn(verbose, url)
+    conn.headers['X-AUTH-TOKEN'] = token if token
+
+    os_string = ''
+    os_type.each do |os, num|
+      num.times do |_i|
+        os_string << os + '+'
+      end
+    end
+
+    os_string = os_string.chomp('+')
+
+    if os_string.empty?
+      raise MissingParamError, 'No operating systems provided to obtain.'
+    end
+
+    response = conn.post "host/#{os_string}"
+
+    res_body = JSON.parse(response.body)
+
+    if res_body['ok']
+      res_body
+    elsif response.status == 401
+      raise AuthError, "HTTP #{response.status}: The token provided could not authenticate to the pooler.\n#{res_body}"
+    else
+      raise "HTTP #{response.status}: Failed to obtain VMs from the pooler at #{url}/host/#{os_string}. #{res_body}"
+    end
+  end
+
+  def self.modify(verbose, url, hostname, token, modify_hash)
+    if token.nil?
+      raise TokenError, 'Token provided was nil; Request cannot be made to modify VM'
+    end
+
+    modify_hash.each do |key, value|
+      unless [:reason, :reserved_for_reason].include? key
+        raise ModifyError, "Configured service type does not support modification of #{key}"
+      end
+    end
+
+    if modify_hash[:reason]
+      # "reason" is easier to type than "reserved_for_reason", but nspooler needs the latter
+      modify_hash[:reserved_for_reason] = modify_hash.delete :reason
+    end
+
+    conn = Http.get_conn(verbose, url)
+    conn.headers['X-AUTH-TOKEN'] = token
+
+    response = conn.put do |req|
+      req.url "host/#{hostname}"
+      req.body = modify_hash.to_json
+    end
+
+    response.body.empty? ? {} : JSON.parse(response.body)
+  end
+
+  def self.disk(verbose, url, hostname, token, disk)
+    raise ModifyError, 'Configured service type does not support modification of disk space'
+  end
+
+  def self.snapshot(verbose, url, hostname, token)
+    raise ModifyError, 'Configured service type does not support snapshots'
+  end
+
+  def self.revert(verbose, url, hostname, token, snapshot_sha)
+    raise ModifyError, 'Configured service type does not support snapshots'
+  end
+
+  def self.delete(verbose, url, hosts, token)
+    if token.nil?
+      raise TokenError, 'Token provided was nil; Request cannot be made to delete VM'
+    end
+
+    conn = Http.get_conn(verbose, url)
+
+    conn.headers['X-AUTH-TOKEN'] = token if token
+
+    response_body = {}
+
+    unless hosts.is_a? Array
+      hosts = hosts.split(',')
+    end
+    hosts.each do |host|
+      response = conn.delete "host/#{host}"
+      res_body = JSON.parse(response.body)
+      response_body[host] = res_body
+    end
+
+    response_body
+  end
+
+  def self.status(verbose, url)
+    conn = Http.get_conn(verbose, url)
+
+    response = conn.get '/status'
+    JSON.parse(response.body)
+  end
+
+  def self.summary(verbose, url)
+    conn = Http.get_conn(verbose, url)
+
+    response = conn.get '/summary'
+    JSON.parse(response.body)
+  end
+
+  def self.query(verbose, url, hostname)
+    conn = Http.get_conn(verbose, url)
+
+    response = conn.get "host/#{hostname}"
+    JSON.parse(response.body)
+  end
+end

data/lib/vmfloaty/pooler.rb

@@ -19,6 +19,15 @@ class Pooler
     hosts
   end
 
+  def self.list_active(verbose, url, token)
+    status = Auth.token_status(verbose, url, token)
+    vms = []
+    if status[token] && status[token]['vms']
+      vms = status[token]['vms']['running']
+    end
+    vms
+  end
+
   def self.retrieve(verbose, os_type, token, url)
     # NOTE:
     #   Developers can use `Utils.generate_os_hash` to
@@ -54,25 +63,28 @@ class Pooler
     end
   end
 
-  def self.modify(verbose, url, hostname, token, lifetime, tags)
+  def self.modify(verbose, url, hostname, token, modify_hash)
     if token.nil?
       raise TokenError, "Token provided was nil. Request cannot be made to modify vm"
     end
 
-    modify_body = {}
-    if lifetime
-      modify_body['lifetime'] = lifetime
-    end
-    if tags
-      modify_body['tags'] = tags
+    modify_hash.keys.each do |key|
+      unless [:tags, :lifetime, :disk].include? key
+        raise ModifyError, "Configured service type does not support modification of #{key}."
+      end
     end
 
     conn = Http.get_conn(verbose, url)
     conn.headers['X-AUTH-TOKEN'] = token
 
+    if modify_hash['disk']
+      disk(verbose, url, hostname, token, modify_hash['disk'])
+      modify_hash.delete 'disk'
+    end
+
     response = conn.put do |req|
       req.url "vm/#{hostname}"
-      req.body = modify_body.to_json
+      req.body = modify_hash.to_json
     end
 
     res_body = JSON.parse(response.body)

data/lib/vmfloaty/service.rb

@@ -0,0 +1,133 @@
+require 'commander/user_interaction'
+require 'commander/command'
+require 'vmfloaty/utils'
+require 'vmfloaty/ssh'
+
+class Service
+
+  attr_reader :config
+
+  def initialize(options, config_hash = {})
+    options ||= Commander::Command::Options.new
+    @config = Utils.get_service_config config_hash, options
+    @service_object = Utils.get_service_object @config['type']
+  end
+
+  def method_missing(m, *args, &block)
+    if @service_object.respond_to? m
+      @service_object.send(m, *args, &block)
+    else
+      super
+    end
+  end
+
+  def url
+    @config['url']
+  end
+
+  def type
+    @service_object.name
+  end
+
+  def user
+    unless @config['user']
+      puts "Enter your pooler service username:"
+      @config['user'] = STDIN.gets.chomp
+    end
+    @config['user']
+  end
+
+  def token
+    unless @config['token']
+      puts "No token found. Retrieving a token..."
+      @config['token'] = get_new_token(nil)
+    end
+    @config['token']
+  end
+
+  def get_new_token(verbose)
+    username = user
+    pass = Commander::UI::password "Enter your pooler service password:", '*'
+    Auth.get_token(verbose, url, username, pass)
+  end
+
+  def delete_token(verbose, token_value = @config['token'])
+    username = user
+    pass = Commander::UI::password "Enter your pooler service password:", '*'
+    Auth.delete_token(verbose, url, username, pass, token_value)
+  end
+
+  def token_status(verbose, token_value)
+    token_value ||= @config['token']
+    Auth.token_status(verbose, url, token_value)
+  end
+
+  def list(verbose, os_filter = nil)
+    @service_object.list verbose, url, os_filter
+  end
+
+  def list_active(verbose)
+    @service_object.list_active verbose, url, token
+  end
+
+  def retrieve(verbose, os_types, use_token = true)
+    puts 'Requesting a vm without a token...' unless use_token
+    token_value = use_token ? token : nil
+    @service_object.retrieve verbose, os_types, token_value, url
+  end
+
+  def ssh(verbose, host_os, use_token = true)
+    token_value = nil
+    if use_token
+      begin
+        token_value = token || get_new_token(verbose)
+      rescue TokenError => e
+        STDERR.puts e
+        STDERR.puts 'Could not get token... requesting vm without a token anyway...'
+      end
+    end
+    Ssh.ssh(verbose, host_os, token_value, url)
+  end
+
+  def pretty_print_running(verbose, hostnames = [])
+    if hostnames.empty?
+      puts "You have no running VMs."
+    else
+      puts "Running VMs:"
+      @service_object.pretty_print_hosts(verbose, hostnames, url)
+    end
+  end
+
+  def query(verbose, hostname)
+    @service_object.query verbose, url, hostname
+  end
+
+  def modify(verbose, hostname, modify_hash)
+    @service_object.modify verbose, url, hostname, token, modify_hash
+  end
+
+  def delete(verbose, hosts)
+    @service_object.delete verbose, url, hosts, token
+  end
+
+  def status(verbose)
+    @service_object.status verbose, url
+  end
+
+  def summary(verbose)
+    @service_object.summary verbose, url
+  end
+
+  def snapshot(verbose, hostname)
+    @service_object.snapshot verbose, url, hostname, token
+  end
+
+  def revert(verbose, hostname, snapshot_sha)
+    @service_object.revert verbose, url, hostname, token, snapshot_sha
+  end
+
+  def disk(verbose, hostname, disk)
+    @service_object.disk(verbose, url, hostname, token, disk)
+  end
+
+end