vmfloaty 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cf673c0a3e005fc4ef5102d232206f3105215de4f19cd76725de335b62937fd
-  data.tar.gz: e4791593e75d31d42a8f05cfb28b3655e42218ac1a7191ae1c8391ccdad5133b
+  metadata.gz: cfd72279e6067194457cfff7e798bffb6c3f7e516a215ab25507836a35918dfa
+  data.tar.gz: e5f63b9b99f8969e557cf14993d89063353b2b8d2201e2945204375f4c8599f1
 SHA512:
-  metadata.gz: b22ad1332f3a663407a6ce964525606938134925e0b91ccd151a8f9a4abc265cab53cddd9509ce92555abb357dc213f2beef50a02ea72eb501db31c9e3936983
-  data.tar.gz: 8436c38cc6a99b76c4e65da0dfa653edbbdbe9b7fcefb9607942983cd24014c40ab14f556b06e7d6a449dc57f84740e09df2668e15129cdb5dccbb3b6e746eff
+  metadata.gz: 57500a3436d64a3edc4aa8a11bcfc5590a05788268fb7c556d70816a0dede112225298f657a762c8a5eec3b829117f91599e286115237e5e039dfe5554d9d2c2
+  data.tar.gz: 288ded1bca5cfe6bff06be880b17264ddd49a10674649a1424515af7a48d646eb0b693123aee0ec353b6bb57424f209ca7cd653e1fd3287831b137593ebfe50b

data/extras/completions/floaty.bash

@@ -2,29 +2,37 @@
 
 _vmfloaty()
 {
-  local cur prev subcommands template_subcommands hostname_subcommands
+  local cur prev commands template_arg_commands hostname_arg_commands service_subcommands
+
   COMPREPLY=()
   cur="${COMP_WORDS[COMP_CWORD]}"
   prev="${COMP_WORDS[COMP_CWORD-1]}"
 
-  subcommands="delete get help list modify query revert service snapshot ssh status summary token"
-  template_subcommands="get ssh"
-  hostname_subcommands="delete modify query revert snapshot"
+  commands="delete get help list modify query revert service snapshot ssh status summary token"
+  template_arg_commands="get ssh"
+  hostname_arg_commands="delete modify query revert snapshot"
+  service_subcommands="types examples"
 
   if [[ $cur == -* ]] ; then
     # TODO: option completion
     COMPREPLY=()
-  elif [[ $template_subcommands =~ (^| )$prev($| ) ]] ; then
+  elif [[ $template_arg_commands =~ (^| )$prev($| ) ]] ; then
     if [[ -z "$_vmfloaty_avail_templates" ]] ; then
+      # TODO: need a --hostnameonly equivalent here because the section headers of
+      # `floaty list` are adding some spurious entries (including files in current
+      # directory because part of the headers is `**` which is getting expanded)
       _vmfloaty_avail_templates=$(floaty list 2>/dev/null)
     fi
 
     COMPREPLY=( $(compgen -W "${_vmfloaty_avail_templates}" -- "${cur}") )
-  elif [[ $hostname_subcommands =~ (^| )$prev($| ) ]] ; then
+  elif [[ $hostname_arg_commands =~ (^| )$prev($| ) ]] ; then
     _vmfloaty_active_hostnames=$(floaty list --active --hostnameonly 2>/dev/null)
     COMPREPLY=( $(compgen -W "${_vmfloaty_active_hostnames}" -- "${cur}") )
-  else
-    COMPREPLY=( $(compgen -W "${subcommands}" -- "${cur}") )
+  elif [[ "service" == $prev ]] ; then
+    COMPREPLY=( $(compgen -W "${service_subcommands}" -- "${cur}") )
+  elif [[ $1 == $prev ]] ; then
+    # only show top level commands we are at root
+    COMPREPLY=( $(compgen -W "${commands}" -- "${cur}") )
   fi
 }
 complete -F _vmfloaty floaty

data/extras/completions/floaty.zsh

@@ -1,26 +1,32 @@
 _floaty()
 {
-  local line subcommands template_subcommands hostname_subcommands
+  local line commands template_arg_commands hostname_arg_commands service_subcommands
 
-  subcommands="delete get help list modify query revert snapshot ssh status summary token"
+  commands="delete get help list modify query revert service snapshot ssh status summary token"
 
-  template_subcommands=("get" "ssh")
-  hostname_subcommands=("delete" "modify" "query" "revert" "snapshot")
+  template_arg_commands=("get" "ssh")
+  hostname_arg_commands=("delete" "modify" "query" "revert" "snapshot")
+  service_subcommands=("types" "examples")
 
   _arguments -C \
-    "1: :(${subcommands})" \
+    "1: :(${commands})" \
     "*::arg:->args"
 
-  if ((template_subcommands[(Ie)$line[1]])); then
+  if ((template_arg_commands[(Ie)$line[1]])); then
     _floaty_template_sub
-  elif ((hostname_subcommands[(Ie)$line[1]])); then
+  elif ((hostname_arg_commands[(Ie)$line[1]])); then
     _floaty_hostname_sub
+  elif [[ "service" == $line[1] ]]; then
+    _arguments "1: :(${service_subcommands})"
   fi
 }
 
 _floaty_template_sub()
 {
   if [[ -z "$_vmfloaty_avail_templates" ]] ; then
+    # TODO: need a --hostnameonly equivalent here because the section headers of
+    # `floaty list` are adding some spurious entries (including files in current
+    # directory because part of the headers is `**` which is getting expanded)
     _vmfloaty_avail_templates=$(floaty list 2>/dev/null)
   fi
 

data/lib/vmfloaty/abs.rb

@@ -64,7 +64,7 @@ class ABS
   end
 
   def self.get_active_requests(verbose, url, user)
-    conn = Http.get_conn(verbose, url)
+    conn = Http.get_conn(verbose, supported_abs_url(url))
     res = conn.get 'status/queue'
     if valid_json?(res.body)
       requests = JSON.parse(res.body)
@@ -105,7 +105,7 @@ class ABS
 
   def self.delete(verbose, url, hosts, token, user)
     # In ABS terms, this is a "returned" host.
-    conn = Http.get_conn(verbose, url)
+    conn = Http.get_conn(verbose, supported_abs_url(url))
     conn.headers['X-AUTH-TOKEN'] = token if token
 
     FloatyLogger.info "Trying to delete hosts #{hosts}" if verbose
@@ -163,7 +163,7 @@ class ABS
 
   # List available VMs in ABS
   def self.list(verbose, url, os_filter = nil)
-    conn = Http.get_conn(verbose, url)
+    conn = Http.get_conn(verbose, supported_abs_url(url))
 
     os_list = []
 
@@ -245,11 +245,10 @@ class ABS
     #   }
     # }
 
-    conn = Http.get_conn(verbose, url)
+    conn = Http.get_conn(verbose, supported_abs_url(url))
     conn.headers['X-AUTH-TOKEN'] = token if token
 
-    saved_job_id = DateTime.now.strftime('%Q')
-    vmpooler_config = Utils.get_vmpooler_service_config(config['vmpooler_fallback'])
+    saved_job_id = user + "-" + DateTime.now.strftime('%Q')
     req_obj = {
       :resources => os_types,
       :job       => {
@@ -258,9 +257,14 @@ class ABS
           :user => user,
         },
       },
-      :vm_token => vmpooler_config['token'] # request with this token, on behalf of this user
     }
 
+    if config['vmpooler_fallback'] # optional and not available as cli flag
+      vmpooler_config = Utils.get_vmpooler_service_config(config['vmpooler_fallback'])
+      # request with this token, on behalf of this user
+      req_obj[:vm_token] = vmpooler_config['token']
+    end
+
     if config['priority']
       req_obj[:priority] = if config['priority'] == 'high'
                              1
@@ -284,15 +288,20 @@ class ABS
 
     validate_queue_status_response(res.status, res.body, "Initial request", verbose)
 
-    (1..retries).each do |i|
-      queue_place, res_body = check_queue(conn, saved_job_id, req_obj, verbose)
-      return translated(res_body, saved_job_id) if res_body
+    begin
+      (1..retries).each do |i|
+        queue_place, res_body = check_queue(conn, saved_job_id, req_obj, verbose)
+        return translated(res_body, saved_job_id) if res_body
 
-      sleep_seconds = 10 if i >= 10
-      sleep_seconds = i if i < 10
-      FloatyLogger.info "Waiting #{sleep_seconds} seconds to check if ABS request has been filled.  Queue Position: #{queue_place}... (x#{i})"
+        sleep_seconds = 10 if i >= 10
+        sleep_seconds = i if i < 10
+        FloatyLogger.info "Waiting #{sleep_seconds} seconds to check if ABS request has been filled.  Queue Position: #{queue_place}... (x#{i})"
 
-      sleep(sleep_seconds)
+        sleep(sleep_seconds)
+      end
+    rescue SystemExit, Interrupt
+      FloatyLogger.info "\n\nFloaty interrupted, you can query the state of your request via\n1) `floaty query #{saved_job_id}` or delete it via\n2) `floaty delete #{saved_job_id}`"
+      exit 1
     end
     nil
   end
@@ -339,7 +348,7 @@ class ABS
   end
 
   def self.status(verbose, url)
-    conn = Http.get_conn(verbose, url)
+    conn = Http.get_conn(verbose, supported_abs_url(url))
 
     res = conn.get 'status'
 
@@ -357,7 +366,7 @@ class ABS
     return @active_hostnames if @active_hostnames && !@active_hostnames.empty?
 
     # If using the cli query job_id
-    conn = Http.get_conn(verbose, url)
+    conn = Http.get_conn(verbose, supported_abs_url(url))
     queue_info_res = conn.get "status/queue/info/#{job_id}"
     if valid_json?(queue_info_res.body)
       queue_info = JSON.parse(queue_info_res.body)
@@ -402,4 +411,15 @@ class ABS
   rescue TypeError, JSON::ParserError => e
     return false
   end
+
+  # when missing, adds the required api/v2 in the url
+  def self.supported_abs_url(url)
+    expected_ending = "api/v2"
+    if !url.include?(expected_ending)
+      # add a slash if missing
+      expected_ending = "/#{expected_ending}" if url[-1] != "/"
+      url = "#{url}#{expected_ending}"
+    end
+    url
+  end
 end

data/lib/vmfloaty/service.rb

@@ -139,7 +139,7 @@ class Service
 
   # some methods do not exist for ABS, and if possible should target the Pooler service
   def maybe_use_vmpooler
-    if @service_object.is_a?(ABS.class)
+    if @service_object == ABS # this is not an instance
       if !self.silent
         FloatyLogger.info "The service in use is ABS, but the requested method should run against vmpooler directly, using fallback_vmpooler config from ~/.vmfloaty.yml"
         self.silent = true

data/lib/vmfloaty/utils.rb

@@ -116,7 +116,7 @@ class Utils
 
         output_target.puts "- [JobID:#{host_data['request']['job']['id']}] <#{host_data['state']}>"
         host_data['allocated_resources'].each do |allocated_resources, _i|
-          if allocated_resources['engine'] == "vmpooler"
+          if allocated_resources['engine'] == "vmpooler" && service.config["vmpooler_fallback"]
             vmpooler_service = service.clone
             vmpooler_service.silent = true
             vmpooler_service.maybe_use_vmpooler
@@ -254,6 +254,7 @@ class Utils
       'url'   => config['url'],
       'user'  => config['user'],
       'token' => config['token'],
+      'vmpooler_fallback' => config['vmpooler_fallback'],
       'type'  => config['type'] || 'vmpooler',
     }
 

data/lib/vmfloaty/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 class Vmfloaty
-  VERSION = '1.0.0'
+  VERSION = '1.1.1'
 end
 

data/spec/vmfloaty/abs_spec.rb

@@ -11,11 +11,11 @@ describe ABS do
 
   describe '#list' do
     it 'skips empty platforms and lists aws' do
-      stub_request(:get, "http://foo/status/platforms/vmpooler").
+      stub_request(:get, "http://foo/api/v2/status/platforms/vmpooler").
           to_return(:status => 200, :body => "", :headers => {})
-      stub_request(:get, "http://foo/status/platforms/ondemand_vmpooler").
+      stub_request(:get, "http://foo/api/v2/status/platforms/ondemand_vmpooler").
           to_return(:status => 200, :body => "", :headers => {})
-      stub_request(:get, "http://foo/status/platforms/nspooler").
+      stub_request(:get, "http://foo/api/v2/status/platforms/nspooler").
           to_return(:status => 200, :body => "", :headers => {})
       body = '{
                 "aws_platforms": [
@@ -26,7 +26,7 @@ describe ABS do
                   "redhat-8-arm64"
                 ]
               }'
-      stub_request(:get, "http://foo/status/platforms/aws").
+      stub_request(:get, "http://foo/api/v2/status/platforms/aws").
           to_return(:status => 200, :body => body, :headers => {})
 
 
@@ -35,16 +35,16 @@ describe ABS do
       expect(results).to include("amazon-6-x86_64", "amazon-7-x86_64", "amazon-7-arm64", "centos-7-x86-64-west", "redhat-8-arm64")
     end
     it 'legacy JSON string, prior to PR 306' do
-      stub_request(:get, "http://foo/status/platforms/vmpooler").
+      stub_request(:get, "http://foo/api/v2/status/platforms/vmpooler").
           to_return(:status => 200, :body => "", :headers => {})
-      stub_request(:get, "http://foo/status/platforms/ondemand_vmpooler").
+      stub_request(:get, "http://foo/api/v2/status/platforms/ondemand_vmpooler").
           to_return(:status => 200, :body => "", :headers => {})
-      stub_request(:get, "http://foo/status/platforms/nspooler").
+      stub_request(:get, "http://foo/api/v2/status/platforms/nspooler").
           to_return(:status => 200, :body => "", :headers => {})
       body = '{
           "aws_platforms": "[\"amazon-6-x86_64\",\"amazon-7-x86_64\",\"amazon-7-arm64\",\"centos-7-x86-64-west\",\"redhat-8-arm64\"]"
       }'
-      stub_request(:get, "http://foo/status/platforms/aws").
+      stub_request(:get, "http://foo/api/v2/status/platforms/aws").
           to_return(:status => 200, :body => body, :headers => {})
 
       results = ABS.list(false, "http://foo")
@@ -125,7 +125,7 @@ describe ABS do
       end
 
       it 'will skip a line with a null value returned from abs' do
-        stub_request(:get, 'https://abs.example.com/status/queue')
+        stub_request(:get, 'https://abs.example.com/api/v2/status/queue')
           .to_return(:status => 200, :body => @active_requests_response, :headers => {})
 
         ret = ABS.get_active_requests(false, @abs_url, @test_user)
@@ -156,9 +156,9 @@ describe ABS do
       end
 
       it 'will delete the whole job' do
-        stub_request(:get, 'https://abs.example.com/status/queue')
+        stub_request(:get, 'https://abs.example.com/api/v2/status/queue')
           .to_return(:status => 200, :body => @active_requests_response, :headers => {})
-        stub_request(:post, 'https://abs.example.com/return')
+        stub_request(:post, 'https://abs.example.com/api/v2/return')
           .with(:body => @return_request)
           .to_return(:status => 200, :body => 'OK', :headers => {})
 

data/spec/vmfloaty/utils_spec.rb

@@ -5,6 +5,11 @@ require 'json'
 require 'commander/command'
 require_relative '../../lib/vmfloaty/utils'
 
+# allow changing config in service for tests
+class Service
+  attr_writer :config
+end
+
 describe Utils do
   describe '#standardize_hostnames' do
     before :each do
@@ -441,7 +446,7 @@ describe Utils do
       end
 
       let(:default_output_first_line) { "- [JobID:#{hostname}] <allocated>" }
-      let(:default_output_second_line) { "  - #{fqdn} (#{template}, 7.67/48 hours, user: bob, role: agent)" }
+      let(:default_output_second_line) { "  - #{fqdn} (#{template})" }
 
       it 'prints output with job id, host, and template' do
         expect(STDOUT).to receive(:puts).with(default_output_first_line)
@@ -450,6 +455,16 @@ describe Utils do
         subject
       end
 
+      it 'prints more information when vmpooler_fallback is set output with job id, host, template, lifetime, user and role' do
+        fallback = {'vmpooler_fallback' => 'vmpooler'}
+        service.config.merge! fallback
+        default_output_second_line="  - #{fqdn} (#{template}, 7.67/48 hours, user: bob, role: agent)"
+        expect(STDOUT).to receive(:puts).with(default_output_first_line)
+        expect(STDOUT).to receive(:puts).with(default_output_second_line)
+
+        subject
+      end
+
       context 'when print_to_stderr option is true' do
         let(:print_to_stderr) { true }
 
@@ -529,7 +544,7 @@ describe Utils do
       end
 
       let(:default_output_first_line) { "- [JobID:#{hostname}] <allocated>" }
-      let(:default_output_second_line) { "  - #{fqdn} (#{template}, 7.67/48 hours, user: bob, role: agent)" }
+      let(:default_output_second_line) { "  - #{fqdn} (#{template})" }
       let(:default_output_third_line) { "  - #{fqdn_ns} (#{template_ns})" }
 
       it 'prints output with job id, host, and template' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vmfloaty
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Brian Cain
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-22 00:00:00.000000000 Z
+date: 2020-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -115,18 +115,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: CLI application to interface with vmpooler
 test_files:
-- spec/spec_helper.rb
+- spec/vmfloaty/vmfloaty_services_spec.rb
+- spec/vmfloaty/utils_spec.rb
+- spec/vmfloaty/abs/auth_spec.rb
+- spec/vmfloaty/abs_spec.rb
+- spec/vmfloaty/pooler_spec.rb
 - spec/vmfloaty/ssh_spec.rb
-- spec/vmfloaty/auth_spec.rb
 - spec/vmfloaty/service_spec.rb
-- spec/vmfloaty/abs/auth_spec.rb
 - spec/vmfloaty/nonstandard_pooler_spec.rb
-- spec/vmfloaty/pooler_spec.rb
-- spec/vmfloaty/abs_spec.rb
-- spec/vmfloaty/utils_spec.rb
-- spec/vmfloaty/vmfloaty_services_spec.rb
+- spec/vmfloaty/auth_spec.rb
+- spec/spec_helper.rb