vmfloaty 0.8.1 → 0.10.0

data/lib/vmfloaty/utils.rb

@@ -1,10 +1,13 @@
-require 'vmfloaty/pooler'
+# frozen_string_literal: true
+
+require 'vmfloaty/abs'
 require 'vmfloaty/nonstandard_pooler'
+require 'vmfloaty/pooler'
 
 class Utils
   # TODO: Takes the json response body from an HTTP GET
   # request and "pretty prints" it
-  def self.format_hosts(response_body)
+  def self.standardize_hostnames(response_body)
     # vmpooler response body example when `floaty get` arguments are `ubuntu-1610-x86_64=2 centos-7-x86_64`:
     # {
     #   "ok": true,
@@ -28,35 +31,35 @@ class Utils
     #   }
     # }
 
-    unless response_body.delete('ok')
-      raise ArgumentError, "Bad GET response passed to format_hosts: #{response_body.to_json}"
-    end
+    # abs pooler response body example when `floaty get` arguments are :
+    # {
+    #   "hostname"=>"thin-soutane.delivery.puppetlabs.net",
+    #   "type"=>"centos-7.2-tmpfs-x86_64",
+    #   "engine"=>"vmpooler"
+    # }
 
-    hostnames = []
+    raise ArgumentError, "Bad GET response passed to format_hosts: #{response_body.to_json}" unless response_body.delete('ok')
 
     # vmpooler reports the domain separately from the hostname
     domain = response_body.delete('domain')
 
-    if domain
-      # vmpooler output
-      response_body.each do |os, hosts|
-        if hosts['hostname'].kind_of?(Array)
-          hosts['hostname'].map!{ |host| hostnames << host + "." + domain + " (#{os})"}
-        else
-          hostnames << hosts["hostname"] + ".#{domain} (#{os})"
-        end
-      end
-    else
-      response_body.each do |os, hosts|
-        if hosts['hostname'].kind_of?(Array)
-          hosts['hostname'].map!{ |host| hostnames << host + " (#{os})" }
-        else
-          hostnames << hosts['hostname'] + " (#{os})"
-        end
-      end
+    result = {}
+
+    STDOUT.puts "response body is #{response_body}"
+    filtered_response_body = response_body.reject { |key, _| key == 'request_id' || key == 'ready' }
+    filtered_response_body.each do |os, value|
+      hostnames = Array(value['hostname'])
+      hostnames.map! { |host| "#{host}.#{domain}" } if domain
+      result[os] = hostnames
     end
 
-    hostnames.map { |hostname| puts "- #{hostname}" }
+    result
+  end
+
+  def self.format_host_output(hosts)
+    hosts.flat_map do |os, names|
+      names.map { |name| "- #{name} (#{os})" }
+    end.join("\n")
   end
 
   def self.generate_os_hash(os_args)
@@ -70,13 +73,8 @@ class Utils
     #   ...]
     os_types = {}
     os_args.each do |arg|
-      os_arr = arg.split("=")
-      if os_arr.size == 1
-        # assume they didn't specify an = sign if split returns 1 size
-        os_types[os_arr[0]] = 1
-      else
-        os_types[os_arr[0]] = os_arr[1].to_i
-      end
+      os_arr = arg.split('=')
+      os_types[os_arr[0]] = os_arr.size == 1 ? 1 : os_arr[1].to_i
     end
     os_types
   end
@@ -89,26 +87,29 @@ class Utils
         host_data = response[hostname]
 
         case service.type
-          when 'Pooler'
-            tag_pairs = []
-            unless host_data['tags'].nil?
-              tag_pairs = host_data['tags'].map {|key, value| "#{key}: #{value}"}
-            end
-            duration = "#{host_data['running']}/#{host_data['lifetime']} hours"
-            metadata = [host_data['template'], duration, *tag_pairs]
-            puts "- #{hostname}.#{host_data['domain']} (#{metadata.join(", ")})"
-          when 'NonstandardPooler'
-            line = "- #{host_data['fqdn']} (#{host_data['os_triple']}"
-            line += ", #{host_data['hours_left_on_reservation']}h remaining"
-            unless host_data['reserved_for_reason'].empty?
-              line += ", reason: #{host_data['reserved_for_reason']}"
+        when 'ABS'
+          # For ABS, 'hostname' variable is the jobID
+          if host_data['state'] == 'allocated' || host_data['state'] == 'filled'
+            host_data['allocated_resources'].each do |vm_name, _i|
+              puts "- [JobID:#{host_data['request']['job']['id']}] #{vm_name['hostname']} (#{vm_name['type']}) <#{host_data['state']}>"
             end
-            line += ')'
-            puts line
-          else
-            raise "Invalid service type #{service.type}"
+          end
+        when 'Pooler'
+          tag_pairs = []
+          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['template'], duration, *tag_pairs]
+          puts "- #{hostname}.#{host_data['domain']} (#{metadata.join(', ')})"
+        when 'NonstandardPooler'
+          line = "- #{host_data['fqdn']} (#{host_data['os_triple']}"
+          line += ", #{host_data['hours_left_on_reservation']}h remaining"
+          line += ", reason: #{host_data['reserved_for_reason']}" unless host_data['reserved_for_reason'].empty?
+          line += ')'
+          puts line
+        else
+          raise "Invalid service type #{service.type}"
         end
-      rescue => e
+      rescue StandardError => e
         STDERR.puts("Something went wrong while trying to gather information on #{hostname}:")
         STDERR.puts(e)
       end
@@ -119,45 +120,48 @@ class Utils
     status_response = service.status(verbose)
 
     case service.type
-      when 'Pooler'
-        message = status_response['status']['message']
-        pools = status_response['pools']
-        pools.select! {|_, pool| pool['ready'] < pool['max']} unless verbose
-
-        width = pools.keys.map(&:length).max
-        pools.each do |name, pool|
-          begin
-            max = pool['max']
-            ready = pool['ready']
-            pending = pool['pending']
-            missing = max - ready - pending
-            char = 'o'
-            puts "#{name.ljust(width)} #{(char*ready).green}#{(char*pending).yellow}#{(char*missing).red}"
-          rescue => e
-            puts "#{name.ljust(width)} #{e.red}"
-          end
+    when 'Pooler'
+      message = status_response['status']['message']
+      pools = status_response['pools']
+      pools.select! { |_, pool| pool['ready'] < pool['max'] } unless verbose
+
+      width = pools.keys.map(&:length).max
+      pools.each do |name, pool|
+        begin
+          max = pool['max']
+          ready = pool['ready']
+          pending = pool['pending']
+          missing = max - ready - pending
+          char = 'o'
+          puts "#{name.ljust(width)} #{(char * ready).green}#{(char * pending).yellow}#{(char * missing).red}"
+        rescue StandardError => e
+          puts "#{name.ljust(width)} #{e.red}"
         end
-        puts message.colorize(status_response['status']['ok'] ? :default : :red)
-      when 'NonstandardPooler'
-        pools = status_response
-        pools.delete 'ok'
-        pools.select! {|_, pool| pool['available_hosts'] < pool['total_hosts']} unless verbose
-
-        width = pools.keys.map(&:length).max
-        pools.each do |name, pool|
-          begin
-            max = pool['total_hosts']
-            ready = pool['available_hosts']
-            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}"
-          rescue => e
-            puts "#{name.ljust(width)} #{e.red}"
-          end
+      end
+      puts message.colorize(status_response['status']['ok'] ? :default : :red)
+    when 'NonstandardPooler'
+      pools = status_response
+      pools.delete 'ok'
+      pools.select! { |_, pool| pool['available_hosts'] < pool['total_hosts'] } unless verbose
+
+      width = pools.keys.map(&:length).max
+      pools.each do |name, pool|
+        begin
+          max = pool['total_hosts']
+          ready = pool['available_hosts']
+          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}"
+        rescue StandardError => e
+          puts "#{name.ljust(width)} #{e.red}"
         end
-      else
-        raise "Invalid service type #{service.type}"
+      end
+    when 'ABS'
+      puts 'ABS Not OK'.red unless status_response
+      puts 'ABS is OK'.green if status_response
+    else
+      raise "Invalid service type #{service.type}"
     end
   end
 
@@ -170,9 +174,12 @@ class Utils
   end
 
   def self.get_service_object(type = '')
-    nspooler_strings = ['ns', 'nspooler', 'nonstandard', 'nonstandard_pooler']
+    nspooler_strings = %w[ns nspooler nonstandard nonstandard_pooler]
+    abs_strings = %w[abs alwaysbescheduling always_be_scheduling]
     if nspooler_strings.include? type.downcase
       NonstandardPooler
+    elsif abs_strings.include? type.downcase
+      ABS
     else
       Pooler
     end
@@ -181,10 +188,10 @@ class Utils
   def self.get_service_config(config, options)
     # The top-level url, user, and token values in the config file are treated as defaults
     service_config = {
-        'url' => config['url'],
-        'user' => config['user'],
-        'token' => config['token'],
-        'type' => config['type'] || 'vmpooler'
+      'url'   => config['url'],
+      'user'  => config['user'],
+      'token' => config['token'],
+      'type'  => config['type'] || 'vmpooler',
     }
 
     if config['services']
@@ -195,16 +202,15 @@ class Utils
         service_config.merge! values
       else
         # If the user provided a service name at the command line, use that service if posible, or fail
-        if config['services'][options.service]
-          # If the service is configured but some values are missing, use the top-level defaults to fill them in
-          service_config.merge! config['services'][options.service]
-        else
-          raise ArgumentError, "Could not find a configured service named '#{options.service}' in ~/.vmfloaty.yml"
-        end
+        raise ArgumentError, "Could not find a configured service named '#{options.service}' in ~/.vmfloaty.yml" unless config['services'][options.service]
+
+        # If the service is configured but some values are missing, use the top-level defaults to fill them in
+        service_config.merge! config['services'][options.service]
       end
     end
 
     # Prioritize an explicitly specified url, user, or token if the user provided one
+    service_config['priority'] = options.priority unless options.priority.nil?
     service_config['url'] = options.url unless options.url.nil?
     service_config['token'] = options.token unless options.token.nil?
     service_config['user'] = options.user unless options.user.nil?

data/lib/vmfloaty/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Vmfloaty
-  VERSION = '0.8.1'.freeze
+  VERSION = '0.10.0'
 end

data/spec/spec_helper.rb

@@ -1,3 +1,16 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+])
+SimpleCov.start do
+  add_filter %r{^/spec/}
+end
+
 require 'vmfloaty'
 require 'webmock/rspec'
 

data/spec/vmfloaty/abs/auth_spec.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require_relative '../../../lib/vmfloaty/auth'
+
+describe Pooler do
+  before :each do
+    @abs_url = 'https://abs.example.com/api/v2'
+  end
+
+  describe '#get_token' do
+    before :each do
+      @get_token_response = '{"ok": true,"token":"utpg2i2xswor6h8ttjhu3d47z53yy47y"}'
+      @token = 'utpg2i2xswor6h8ttjhu3d47z53yy47y'
+    end
+
+    it 'returns a token from abs' do
+      stub_request(:post, 'https://first.last:password@abs.example.com/api/v2/token')
+        .to_return(:status => 200, :body => @get_token_response, :headers => {})
+
+      token = Auth.get_token(false, @abs_url, 'first.last', 'password')
+      expect(token).to eq @token
+    end
+
+    it 'raises a token error if something goes wrong' do
+      stub_request(:post, 'https://first.last:password@abs.example.com/api/v2/token')
+        .to_return(:status => 500, :body => '{"ok":false}', :headers => {})
+
+      expect { Auth.get_token(false, @abs_url, 'first.last', 'password') }.to raise_error(TokenError)
+    end
+  end
+
+  describe '#delete_token' do
+    before :each do
+      @delete_token_response = '{"ok":true}'
+      @token = 'utpg2i2xswor6h8ttjhu3d47z53yy47y'
+    end
+
+    it 'deletes the specified token' do
+      stub_request(:delete, 'https://first.last:password@abs.example.com/api/v2/token/utpg2i2xswor6h8ttjhu3d47z53yy47y')
+        .to_return(:status => 200, :body => @delete_token_response, :headers => {})
+
+      expect(Auth.delete_token(false, @abs_url, 'first.last', 'password', @token)).to eq JSON.parse(@delete_token_response)
+    end
+
+    it 'raises a token error if something goes wrong' do
+      stub_request(:delete, 'https://first.last:password@abs.example.com/api/v2/token/utpg2i2xswor6h8ttjhu3d47z53yy47y')
+        .to_return(:status => 500, :body => '{"ok":false}', :headers => {})
+
+      expect { Auth.delete_token(false, @abs_url, 'first.last', 'password', @token) }.to raise_error(TokenError)
+    end
+
+    it 'raises a token error if no token provided' do
+      expect { Auth.delete_token(false, @abs_url, 'first.last', 'password', nil) }.to raise_error(TokenError)
+    end
+  end
+
+  describe '#token_status' do
+    before :each do
+      @token_status_response = '{"ok":true,"utpg2i2xswor6h8ttjhu3d47z53yy47y":{"created":"2015-04-28 19:17:47 -0700"}}'
+      @token = 'utpg2i2xswor6h8ttjhu3d47z53yy47y'
+    end
+
+    it 'checks the status of a token' do
+      stub_request(:get, "#{@abs_url}/token/utpg2i2xswor6h8ttjhu3d47z53yy47y")
+        .with(:headers => { 'Accept' => '*/*', 'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3' })
+        .to_return(:status => 200, :body => @token_status_response, :headers => {})
+
+      expect(Auth.token_status(false, @abs_url, @token)).to eq JSON.parse(@token_status_response)
+    end
+
+    it 'raises a token error if something goes wrong' do
+      stub_request(:get, "#{@abs_url}/token/utpg2i2xswor6h8ttjhu3d47z53yy47y")
+        .with(:headers => { 'Accept' => '*/*', 'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3' })
+        .to_return(:status => 500, :body => '{"ok":false}', :headers => {})
+
+      expect { Auth.token_status(false, @abs_url, @token) }.to raise_error(TokenError)
+    end
+
+    it 'raises a token error if no token provided' do
+      expect { Auth.token_status(false, @abs_url, nil) }.to raise_error(TokenError)
+    end
+  end
+end

data/spec/vmfloaty/abs_spec.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'vmfloaty/utils'
+require 'vmfloaty/errors'
+require 'vmfloaty/abs'
+
+describe ABS do
+  before :each do
+  end
+
+  describe '#format' do
+    it 'returns an hash formatted like a vmpooler return' do
+      abs_formatted_response = [
+        { 'hostname' => 'aaaaaaaaaaaaaaa.delivery.puppetlabs.net', 'type' => 'centos-7.2-x86_64', 'engine' => 'vmpooler' },
+        { 'hostname' => 'aaaaaaaaaaaaaab.delivery.puppetlabs.net', 'type' => 'centos-7.2-x86_64', 'engine' => 'vmpooler' },
+        { 'hostname' => 'aaaaaaaaaaaaaac.delivery.puppetlabs.net', 'type' => 'ubuntu-7.2-x86_64', 'engine' => 'vmpooler' },
+      ]
+
+      vmpooler_formatted_response = ABS.translated(abs_formatted_response)
+
+      vmpooler_formatted_compare = {
+        'centos-7.2-x86_64' => {},
+        'ubuntu-7.2-x86_64' => {},
+      }
+
+      vmpooler_formatted_compare['centos-7.2-x86_64']['hostname'] = ['aaaaaaaaaaaaaaa.delivery.puppetlabs.net', 'aaaaaaaaaaaaaab.delivery.puppetlabs.net']
+      vmpooler_formatted_compare['ubuntu-7.2-x86_64']['hostname'] = ['aaaaaaaaaaaaaac.delivery.puppetlabs.net']
+
+      vmpooler_formatted_compare['ok'] = true
+
+      expect(vmpooler_formatted_response).to eq(vmpooler_formatted_compare)
+      vmpooler_formatted_response.delete('ok')
+      vmpooler_formatted_compare.delete('ok')
+      expect(vmpooler_formatted_response).to eq(vmpooler_formatted_compare)
+    end
+
+    it 'won\'t delete a job if not all vms are listed' do
+      hosts = ['host1']
+      allocated_resources = [
+        {
+          'hostname' => 'host1',
+        },
+        {
+          'hostname' => 'host2',
+        },
+      ]
+      expect(ABS.all_job_resources_accounted_for(allocated_resources, hosts)).to eq(false)
+
+      hosts = ['host1', 'host2']
+      allocated_resources = [
+        {
+          'hostname' => 'host1',
+        },
+        {
+          'hostname' => 'host2',
+        },
+      ]
+      expect(ABS.all_job_resources_accounted_for(allocated_resources, hosts)).to eq(true)
+    end
+
+    before :each do
+      @abs_url = 'https://abs.example.com'
+    end
+
+    describe '#test_abs_status_queue_endpoint' do
+      before :each do
+        # rubocop:disable Layout/LineLength
+        @active_requests_response = '
+        [
+          "{ \"state\":\"allocated\",\"last_processed\":\"2019-12-16 23:00:34 +0000\",\"allocated_resources\":[{\"hostname\":\"take-this.delivery.puppetlabs.net\",\"type\":\"win-2012r2-x86_64\",\"engine\":\"vmpooler\"}],\"audit_log\":{\"2019-12-13 16:45:29 +0000\":\"Allocated take-this.delivery.puppetlabs.net for job 1576255517241\"},\"request\":{\"resources\":{\"win-2012r2-x86_64\":1},\"job\":{\"id\":\"1576255517241\",\"tags\":{\"user\":\"test-user\"},\"user\":\"test-user\",\"time-received\":1576255519},\"priority\":1}}",
+          "null",
+          "{\"state\":\"allocated\",\"last_processed\":\"2019-12-16 23:00:34 +0000\",\"allocated_resources\":[{\"hostname\":\"not-this.delivery.puppetlabs.net\",\"type\":\"win-2012r2-x86_64\",\"engine\":\"vmpooler\"}],\"audit_log\":{\"2019-12-13 16:46:14 +0000\":\"Allocated not-this.delivery.puppetlabs.net for job 1576255565159\"},\"request\":{\"resources\":{\"win-2012r2-x86_64\":1},\"job\":{\"id\":\"1576255565159\",\"tags\":{\"user\":\"not-test-user\"},\"user\":\"not-test-user\",\"time-received\":1576255566},\"priority\":1}}"
+        ]'
+        # rubocop:enable Layout/LineLength
+        @token = 'utpg2i2xswor6h8ttjhu3d47z53yy47y'
+        @test_user = 'test-user'
+      end
+
+      it 'will skip a line with a null value returned from abs' do
+        stub_request(:get, 'https://abs.example.com/status/queue')
+          .to_return(:status => 200, :body => @active_requests_response, :headers => {})
+
+        ret = ABS.get_active_requests(false, @abs_url, @test_user)
+
+        expect(ret[0]).to include(
+          'allocated_resources' => [{
+            'hostname' => 'take-this.delivery.puppetlabs.net',
+            'type'     => 'win-2012r2-x86_64',
+            'engine'   => 'vmpooler',
+          }],
+        )
+      end
+    end
+
+    describe '#test_abs_delete_jobid' do
+      before :each do
+        # rubocop:disable Layout/LineLength
+        @active_requests_response = '
+        [
+          "{ \"state\":\"allocated\", \"last_processed\":\"2020-01-17 22:29:13 +0000\", \"allocated_resources\":[{\"hostname\":\"craggy-chord.delivery.puppetlabs.net\", \"type\":\"centos-7-x86_64\", \"engine\":\"vmpooler\"}, {\"hostname\":\"visible-revival.delivery.puppetlabs.net\", \"type\":\"centos-7-x86_64\", \"engine\":\"vmpooler\"}], \"audit_log\":{\"2020-01-17 22:28:45 +0000\":\"Allocated craggy-chord.delivery.puppetlabs.net, visible-revival.delivery.puppetlabs.net for job 1579300120799\"}, \"request\":{\"resources\":{\"centos-7-x86_64\":2}, \"job\":{\"id\":\"1579300120799\", \"tags\":{\"user\":\"test-user\"}, \"user\":\"test-user\", \"time-received\":1579300120}, \"priority\":3}}"
+        ]'
+        @return_request = { '{"job_id":"1579300120799","hosts":{"hostname":"craggy-chord.delivery.puppetlabs.net","type":"centos-7-x86_64","engine":"vmpooler"},{"hostname":"visible-revival.delivery.puppetlabs.net","type":"centos-7-x86_64","engine":"vmpooler"}}'=>true }
+        # rubocop:enable Layout/LineLength
+        @token = 'utpg2i2xswor6h8ttjhu3d47z53yy47y'
+        @test_user = 'test-user'
+        # Job ID
+        @hosts = ['1579300120799']
+      end
+
+      it 'will delete the whole job' do
+        stub_request(:get, 'https://abs.example.com/status/queue')
+          .to_return(:status => 200, :body => @active_requests_response, :headers => {})
+        stub_request(:post, 'https://abs.example.com/return')
+          .with(:body => @return_request)
+          .to_return(:status => 200, :body => 'OK', :headers => {})
+
+        ret = ABS.delete(false, @abs_url, @hosts, @token, @test_user)
+
+        expect(ret).to include(
+          'craggy-chord.delivery.puppetlabs.net' => { 'ok'=>true }, 'visible-revival.delivery.puppetlabs.net' => { 'ok'=>true },
+        )
+      end
+    end
+  end
+end