vmfloaty 1.6.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf8e6d210de6ae23fdd371025ace279b939768d1f197b81b2226f326263bc204
-  data.tar.gz: 7da421b68bb4377e31c4e5784e394ab672adb616ce8be4376e55f0006dd81849
+  metadata.gz: 5d8a0fcfd2e8fd42301c8a8c6ec14336444c5d70dda0adaed0731cbddcc90f7d
+  data.tar.gz: f3d5ef1252fbcb9142afba59d78f93d6cdbaaf76f11680a13c91654fbbc308fc
 SHA512:
-  metadata.gz: 846823d38e3b7dc5cfa066efcda72a6f58ad11ce875529a3ac6443551a138fbc3e05e262226e3dd756e93e8d31c9fa5c3bb4639f139158f5903a95c43bfb9b40
-  data.tar.gz: e693187229fb1b845e4a2b24f9bf9b22e7b0e4244887f8c1fc6042e64d6082638266b56421e04a46948b2efc92e4abd3e4d0ccdf28e345e30a89a77909872022
+  metadata.gz: 568f97d95dccec571488649670fb9fb8022ca58ec6a94c7b333d0f45d9f08ce4ff42c82cd8aef9bfc2079920b3178d333989d8422b68d2dfafe96fbaa08968c9
+  data.tar.gz: 7df48c34d04d7b6aaf4c6b4ac66fd845016c44519040192ddb2aa5d69f89043960d974a910cb1c8eceef6014d96f04891c71276ff5367760b0fa45ec5184aa88

data/README.md

@@ -1,34 +1,48 @@
 # vmfloaty
 
 [![Gem Version](https://badge.fury.io/rb/vmfloaty.svg)](https://badge.fury.io/rb/vmfloaty)
-[![CI](https://github.com/puppetlabs/vmfloaty/actions/workflows/ci.yml/badge.svg)](https://github.com/puppetlabs/vmfloaty/actions/workflows/ci.yml)
+[![Test](https://github.com/puppetlabs/vmfloaty/actions/workflows/test.yml/badge.svg)](https://github.com/puppetlabs/vmfloaty/actions/workflows/test.yml)
 
 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)
-    - [Using multiple services](#using-multiple-services)
-    - [Using backends besides VMPooler](#using-backends-besides-vmpooler)
-    - [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)
+- [vmfloaty](#vmfloaty)
+  - [Install](#install)
+    - [Ruby](#ruby)
+    - [Docker](#docker)
+  - [Usage](#usage)
+    - [Example workflow](#example-workflow)
+    - [vmfloaty dotfile](#vmfloaty-dotfile)
+      - [Basic configuration](#basic-configuration)
+      - [Using multiple services](#using-multiple-services)
+      - [Using backends besides VMPooler](#using-backends-besides-vmpooler)
+      - [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)
+  - [Contributing](#contributing)
+    - [Code Reviews](#code-reviews)
+  - [Releasing](#releasing)
+  - [Special thanks](#special-thanks)
 
 ## Install
 
+### Ruby
+
 Grab the latest from ruby gems...
 
 ```bash
 gem install vmfloaty
 ```
 
+### Docker
+
+Run the docker image:
+
+`docker run -it --rm -v ~/.vmfloaty.yml:/home/floatyuser/.vmfloaty.yml ghcr.io/puppetlabs/vmfloaty --help`
+
 ## Usage
 
 ```plain
@@ -164,6 +178,23 @@ vmfloaty providers a `Pooler` class that gives users the ability to make request
 - [Brian Cain: vagrant-vmpooler](https://github.com/briancain/vagrant-vmpooler)
   - Use Vagrant to manage your vmpooler instances
 
+## Contributing
+
+PR's are welcome! We always love to see how others think this tool can be made better.
+
+### Code Reviews
+
+Please wait for multiple code owners to sign off on any notable change.
+
+## Releasing
+
+Follow these steps to publish a new GitHub release, build and push the gem to <https://rubygems.org>, and build and push a Docker Image to GitHub Container Registry:
+
+1. Bump the "VERSION" in `lib/vmfloaty/version.rb` appropriately based on changes in `CHANGELOG.md` since the last release.
+2. Run `./release-prep` to update `Gemfile.lock` and `CHANGELOG.md`.
+3. Commit and push changes to a new branch, then open a pull request against `main` and be sure to add the "maintenance" label.
+4. After the pull request is approved and merged, then navigate to <https://github.com/puppetlabs/vmfloaty/actions/workflows/release.yml> --> Run workflow --> select "main" branch --> Run workflow. This will publish a GitHub release, build and push the gem to RubyGems, and build and push a Docker Image to GitHub Container Registry.
+
 ## 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/lib/vmfloaty/service.rb

@@ -87,7 +87,7 @@ class Service
     @service_object.wait_for_request verbose, requestid, url
   end
 
-  def ssh(verbose, host_os, use_token = true)
+  def ssh(verbose, host_os, use_token = true, ondemand = nil)
     token_value = nil
     if use_token
       begin
@@ -97,7 +97,7 @@ class Service
         FloatyLogger.info 'Could not get token... requesting vm without a token anyway...'
       end
     end
-    Ssh.ssh(verbose, self, host_os, token_value)
+    Ssh.ssh(verbose, self, host_os, token_value, ondemand)
   end
 
   def query(verbose, hostname)

data/lib/vmfloaty/ssh.rb

@@ -14,27 +14,45 @@ class Ssh
     nil
   end
 
-  def self.command_string(verbose, service, host_os, use_token)
+  def self.command_string(verbose, service, host_os, use_token, ondemand = nil)
     ssh_path = which('ssh')
     raise 'Could not determine path to ssh' unless ssh_path
-
-    os_types = {}
+    os_types = Utils.generate_os_hash([host_os])
     os_types[host_os] = 1
 
-    response = service.retrieve(verbose, os_types, use_token)
+    response = service.retrieve(verbose, os_types, use_token, ondemand)
     raise "Could not get vm from #{service.type}:\n #{response}" unless response['ok']
 
     user = /win/.match?(host_os) ? 'Administrator' : 'root'
 
-    hostname = response[host_os]['hostname']
-    hostname = response[host_os]['hostname'][0] if response[host_os]['hostname'].is_a?(Array)
-    hostname = "#{hostname}.#{response['domain']}" unless hostname.end_with?('puppetlabs.net')
+    if ondemand
+      requestid = response['request_id']
+      service.wait_for_request(verbose, requestid)
+      hosts = service.check_ondemandvm(verbose, requestid, service.url)
+      if hosts['domain'].nil?
+        hostname = hosts[host_os]['hostname']
+        hostname = hosts[host_os]['hostname'][0] if hosts[host_os]['hostname'].is_a?(Array)
+      else
+        # Provides backwards compatibility with VMPooler API v1
+        hostname = "#{hosts[host_os]['hostname']}.#{hosts['domain']}"
+        hostname = "#{hosts[host_os]['hostname'][0]}.#{hosts['domain']}" if hosts[host_os]['hostname'].is_a?(Array)
+      end
+    else
+      if response['domain'].nil?
+        hostname = response[host_os]['hostname']
+        hostname = response[host_os]['hostname'][0] if response[host_os]['hostname'].is_a?(Array)
+      else
+        # Provides backwards compatibility with VMPooler API v1
+        hostname = "#{response[host_os]['hostname']}.#{response['domain']}"
+        hostname = "#{response[host_os]['hostname'][0]}.#{response['domain']}" if response[host_os]['hostname'].is_a?(Array)
+      end
+    end
 
     "#{ssh_path} #{user}@#{hostname}"
   end
 
-  def self.ssh(verbose, service, host_os, use_token)
-    cmd = command_string(verbose, service, host_os, use_token)
+  def self.ssh(verbose, service, host_os, use_token, ondemand)
+    cmd = command_string(verbose, service, host_os, use_token, ondemand)
     # TODO: Should this respect more ssh settings? Can it be configured
     #       by users ssh config and does this respect those settings?
     Kernel.exec(cmd)

data/lib/vmfloaty/utils.rb

@@ -9,7 +9,7 @@ class Utils
   # TODO: Takes the json response body from an HTTP GET
   # request and "pretty prints" it
   def self.standardize_hostnames(response_body)
-    # vmpooler response body example when `floaty get` arguments are `ubuntu-1610-x86_64=2 centos-7-x86_64`:
+    # vmpooler api v1 response body example when `floaty get` arguments are `ubuntu-1610-x86_64=2 centos-7-x86_64`:
     # {
     #   "ok": true,
     #   "domain": "delivery.mycompany.net",
@@ -21,6 +21,17 @@ class Utils
     #   }
     # }
 
+    # vmpooler api v2 response body example when `floaty get` arguments are `ubuntu-1610-x86_64=2 centos-7-x86_64`:
+    # {
+    #   "ok": true,
+    #   "ubuntu-1610-x86_64": {
+    #     "hostname": ["gdoy8q3nckuob0i.pooler.example.com", "ctnktsd0u11p9tm.pooler.example.com"]
+    #   },
+    #   "centos-7-x86_64": {
+    #     "hostname": "dlgietfmgeegry2.pooler.example.com"
+    #   }
+    # }
+
     # nonstandard pooler response body example when `floaty get` arguments are `solaris-11-sparc=2 ubuntu-16.04-power8`:
     # {
     #   "ok": true,
@@ -98,7 +109,11 @@ class Utils
 
       puts abs_hostnames.join("\n")
     when 'Pooler'
-      puts "#{hostname}.#{host_data['domain']}"
+      if host_data['domain'].nil?
+        puts hostname
+      else
+        puts "#{hostname}.#{host_data['domain']}"
+      end
     when 'NonstandardPooler'
       puts host_data['fqdn']
     else
@@ -135,7 +150,14 @@ class Utils
         tag_pairs = host_data['tags'].map { |key, value| "#{key}: #{value}" } unless host_data['tags'].nil?
         duration = "#{host_data['running']}/#{host_data['lifetime']} hours"
         metadata = [host_data['state'], host_data['template'], duration, *tag_pairs]
-        message = "- #{hostname}.#{host_data['domain']} (#{metadata.join(', ')})".gsub(/^/, ' ' * indent)
+        # For backwards compatibility with vmpooler api v1
+        message =
+          if host_data['domain']
+            "- #{hostname}.#{host_data['domain']} (#{metadata.join(', ')})".gsub(/^/, ' ' * indent)
+          else
+            "- #{host_data['fqdn']} (#{metadata.join(', ')})".gsub(/^/, ' ' * indent)
+          end
+
         if host_data['state'] && host_data['state'] == 'destroyed'
           output_target.puts "- DESTROYED #{hostname}.#{host_data['domain']}".gsub(/^/, ' ' * indent)
         else
@@ -197,9 +219,9 @@ class Utils
         pending = pool['pending']
         missing = max - ready - pending
         char = 'o'
-        puts "#{name.ljust(width)} #{(char * ready).green}#{(char * pending).yellow}#{(char * missing).red}"
+        puts "#{name.ljust(width)} #{(char * ready)}#{(char * pending)}#{(char * missing)}"
       rescue StandardError => e
-        FloatyLogger.error "#{name.ljust(width)} #{e.red}"
+        FloatyLogger.error "#{name.ljust(width)} #{e}"
       end
       puts message
     when 'NonstandardPooler'
@@ -214,13 +236,13 @@ class Utils
         pending = pool['pending'] || 0 # not available for nspooler
         missing = max - ready - pending
         char = 'o'
-        puts "#{name.ljust(width)} #{(char * ready).green}#{(char * pending).yellow}#{(char * missing).red}"
+        puts "#{name.ljust(width)} #{(char * ready)}#{(char * pending)}#{(char * missing)}"
       rescue StandardError => e
-        FloatyLogger.error "#{name.ljust(width)} #{e.red}"
+        FloatyLogger.error "#{name.ljust(width)} #{e}"
       end
     when 'ABS'
       FloatyLogger.error 'ABS Not OK' unless status_response
-      puts 'ABS is OK'.green if status_response
+      puts 'ABS is OK' if status_response
     else
       raise "Invalid service type #{service.type}"
     end

data/lib/vmfloaty/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Vmfloaty
-  VERSION = '1.6.0'
+  VERSION = '1.8.0'
 end

data/lib/vmfloaty.rb

@@ -484,7 +484,7 @@ class Vmfloaty
 
         FloatyLogger.info "Can't ssh to multiple hosts; Using #{host_os} only..." if args.length > 1
 
-        service.ssh(verbose, host_os, use_token)
+        service.ssh(verbose, host_os, use_token, options.ondemand)
         exit 0
       end
     end

data/spec/vmfloaty/ssh_spec.rb

@@ -4,24 +4,35 @@ require 'spec_helper'
 require 'vmfloaty/ssh'
 
 class ServiceStub
-  def retrieve(_verbose, os_types, _use_token)
+  def retrieve(_verbose, os_types, _use_token, ondemand)
     if os_types.keys[0] == 'abs_host_string'
       return {
         os_types.keys[0] => { 'hostname' => ['abs-hostname.delivery.puppetlabs.net'] },
         'ok' => true
       }
-    end
 
-    {
-      os_types.keys[0] => { 'hostname' => 'vmpooler-hostname' },
-      'domain' => 'delivery.puppetlabs.net',
-      'ok' => true
-    }
+    elsif os_types.keys[0] == 'vmpooler_api_v2_host_string'
+      return {
+        os_types.keys[0] => { 'hostname' => ['vmpooler-v2-hostname.delivery.puppetlabs.net'] },
+        'ok' => true
+      }
+
+    else
+      return {
+        os_types.keys[0] => { 'hostname' => 'vmpooler-v1-hostname' },
+        'domain' => 'delivery.puppetlabs.net',
+        'ok' => true
+      }
+    end
   end
 
   def type
     return 'abs' if os_types == 'abs_host_string'
-    return 'vmpooler' if os_types == 'vmpooler_host_string'
+    return 'vmpooler' if os_types == 'vmpooler_api_v1_host_string' || os_types == 'vmpooler_api_v2_host_string'
+  end
+
+  def wait_for_request(verbose, requestid)
+    return true
   end
 end
 
@@ -29,21 +40,73 @@ describe Ssh do
   before :each do
   end
 
-  it 'gets a hostname string for abs' do
-    verbose = false
-    service = ServiceStub.new
-    host_os = 'abs_host_string'
-    use_token = false
-    cmd = Ssh.command_string(verbose, service, host_os, use_token)
-    expect(cmd).to match(/ssh root@abs-hostname.delivery.puppetlabs.net/)
+  context "for pooled requests" do
+    it 'gets a hostname string for abs' do
+      verbose = false
+      service = ServiceStub.new
+      host_os = 'abs_host_string'
+      use_token = false
+      cmd = Ssh.command_string(verbose, service, host_os, use_token)
+      expect(cmd).to match(/ssh root@abs-hostname.delivery.puppetlabs.net/)
+    end
+
+    it 'gets a hostname string for vmpooler api v1' do
+      verbose = true
+      service = ServiceStub.new
+      host_os = 'vmpooler_api_v1_host_string'
+      use_token = false
+      cmd = Ssh.command_string(verbose, service, host_os, use_token)
+      expect(cmd).to match(/ssh root@vmpooler-v1-hostname.delivery.puppetlabs.net/)
+    end
+
+    it 'gets a hostname string for vmpooler api v2' do
+      verbose = false
+      service = ServiceStub.new
+      host_os = 'vmpooler_api_v2_host_string'
+      use_token = false
+      cmd = Ssh.command_string(verbose, service, host_os, use_token)
+      expect(cmd).to match(/ssh root@vmpooler-v2-hostname.delivery.puppetlabs.net/)
+    end
   end
 
-  it 'gets a hostname string for vmpooler' do
-    verbose = false
-    service = ServiceStub.new
-    host_os = 'vmpooler_host_string'
-    use_token = false
-    cmd = Ssh.command_string(verbose, service, host_os, use_token)
-    expect(cmd).to match(/ssh root@vmpooler-hostname.delivery.puppetlabs.net/)
+  context "for ondemand requests" do
+    let(:service) { ServiceStub.new }
+    let(:url) { 'http://pooler.example.com' }
+
+    it 'gets a hostname string for abs' do
+      verbose = false
+      host_os = 'abs_host_string'
+      use_token = false
+      ondemand = true
+      response = {'abs_host_string' => { 'hostname' => ['abs-hostname.delivery.puppetlabs.net']}}
+      allow(service).to receive(:url)
+      allow(service).to receive(:check_ondemandvm).and_return(response)
+      cmd = Ssh.command_string(verbose, service, host_os, use_token, ondemand)
+      expect(cmd).to match(/ssh root@abs-hostname.delivery.puppetlabs.net/)
+    end
+
+    it 'gets a hostname string for abs' do
+      verbose = false
+      host_os = 'vmpooler_api_v1_host_string'
+      use_token = false
+      ondemand = true
+      response = {'vmpooler_api_v1_host_string' => { 'hostname' => ['vmpooler_api_v1_host_string.delivery.puppetlabs.net']}}
+      allow(service).to receive(:url)
+      allow(service).to receive(:check_ondemandvm).and_return(response)
+      cmd = Ssh.command_string(verbose, service, host_os, use_token, ondemand)
+      expect(cmd).to match(/ssh root@vmpooler_api_v1_host_string.delivery.puppetlabs.net/)
+    end
+
+    it 'gets a hostname string for abs' do
+      verbose = false
+      host_os = 'vmpooler_api_v2_host_string'
+      use_token = false
+      ondemand = true
+      response = {'vmpooler_api_v2_host_string' => { 'hostname' => ['vmpooler_api_v2_host_string.delivery.puppetlabs.net']}}
+      allow(service).to receive(:url)
+      allow(service).to receive(:check_ondemandvm).and_return(response)
+      cmd = Ssh.command_string(verbose, service, host_os, use_token, ondemand)
+      expect(cmd).to match(/ssh root@vmpooler_api_v2_host_string.delivery.puppetlabs.net/)
+    end
   end
 end

data/spec/vmfloaty/utils_spec.rb

@@ -13,7 +13,7 @@ end
 describe Utils do
   describe '#standardize_hostnames' do
     before :each do
-      @vmpooler_response_body = '{
+      @vmpooler_api_v1_response_body = '{
          "ok": true,
          "domain": "delivery.mycompany.net",
          "ubuntu-1610-x86_64": {
@@ -23,6 +23,15 @@ describe Utils do
            "hostname": "dlgietfmgeegry2"
          }
        }'
+       @vmpooler_api_v2_response_body = '{
+         "ok": true,
+         "ubuntu-1610-x86_64": {
+           "hostname": ["gdoy8q3nckuob0i.delivery.mycompany.net", "ctnktsd0u11p9tm.delivery.mycompany.net"]
+         },
+         "centos-7-x86_64": {
+           "hostname": "dlgietfmgeegry2.delivery.mycompany.net"
+         }
+       }'
       @nonstandard_response_body = '{
          "ok": true,
          "solaris-10-sparc": {
@@ -34,8 +43,15 @@ describe Utils do
        }'
     end
 
-    it 'formats a result from vmpooler into a hash of os to hostnames' do
-      result = Utils.standardize_hostnames(JSON.parse(@vmpooler_response_body))
+    it 'formats a result from vmpooler v1 api into a hash of os to hostnames' do
+      result = Utils.standardize_hostnames(JSON.parse(@vmpooler_api_v1_response_body))
+      expect(result).to eq('centos-7-x86_64' => ['dlgietfmgeegry2.delivery.mycompany.net'],
+                           'ubuntu-1610-x86_64' => ['gdoy8q3nckuob0i.delivery.mycompany.net',
+                                                    'ctnktsd0u11p9tm.delivery.mycompany.net'])
+    end
+
+    it 'formats a result from vmpooler v2 api into a hash of os to hostnames' do
+      result = Utils.standardize_hostnames(JSON.parse(@vmpooler_api_v2_response_body))
       expect(result).to eq('centos-7-x86_64' => ['dlgietfmgeegry2.delivery.mycompany.net'],
                            'ubuntu-1610-x86_64' => ['gdoy8q3nckuob0i.delivery.mycompany.net',
                                                     'ctnktsd0u11p9tm.delivery.mycompany.net'])
@@ -264,7 +280,73 @@ describe Utils do
 
     subject { Utils.pretty_print_hosts(verbose, service, hostname, print_to_stderr) }
 
-    describe 'with vmpooler service' do
+    describe 'with vmpooler api v2 service' do
+      let(:service) { Service.new(MockOptions.new, 'url' => url) }
+
+      let(:hostname) { 'mcpy42eqjxli9g2' }
+      let(:fqdn) { [hostname, 'delivery.puppetlabs.net'].join('.') }
+
+      let(:response_body) do
+        {
+          hostname => {
+            'template' => 'ubuntu-1604-x86_64',
+            'lifetime' => 12,
+            'running' => 9.66,
+            'state' => 'running',
+            'ip' => '127.0.0.1',
+            'fqdn' => fqdn
+          }
+        }
+      end
+
+      let(:default_output) { "- #{fqdn} (running, ubuntu-1604-x86_64, 9.66/12 hours)" }
+
+      it 'prints output with host fqdn, template and duration info' do
+        expect($stdout).to receive(:puts).with(default_output)
+
+        subject
+      end
+
+      context 'when tags are supplied' do
+        let(:hostname) { 'aiydvzpg23r415q' }
+        let(:response_body) do
+          {
+            hostname => {
+              'template' => 'redhat-7-x86_64',
+              'lifetime' => 48,
+              'running' => 7.67,
+              'state' => 'running',
+              'tags' => {
+                'user' => 'bob',
+                'role' => 'agent'
+              },
+              'ip' => '127.0.0.1',
+              'fqdn' => fqdn
+            }
+          }
+        end
+
+        it 'prints output with host fqdn, template, duration info, and tags' do
+          output = "- #{fqdn} (running, redhat-7-x86_64, 7.67/48 hours, user: bob, role: agent)"
+
+          expect($stdout).to receive(:puts).with(output)
+
+          subject
+        end
+      end
+
+      context 'when print_to_stderr option is true' do
+        let(:print_to_stderr) { true }
+
+        it 'outputs to stderr instead of stdout' do
+          expect($stderr).to receive(:puts).with(default_output)
+
+          subject
+        end
+      end
+    end
+
+    describe 'with vmpooler api v1 service' do
       let(:service) { Service.new(MockOptions.new, 'url' => url) }
 
       let(:hostname) { 'mcpy42eqjxli9g2' }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vmfloaty
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Brian Cain
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-16 00:00:00.000000000 Z
+date: 2023-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
@@ -52,9 +52,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.5.1
 description: A helper tool for vmpooler to help you stay afloat
-email:
-- brianccain@gmail.com
-- dio-gems@puppet.com
+email: info@puppet.com
 executables:
 - floaty
 extensions: []
@@ -107,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: CLI application to interface with vmpooler