puppetlabs/vmfloaty
2
0
Fork 0
mirror of https://github.com/puppetlabs/vmfloaty.git synced 2026-01-26 05:28:40 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Move logger instance to class var in FloatyLogger

Browse source 
This moves the instance of the logger class to a class variable in the
`FloatyLogger` class and provides three class methods to log with in the
rest of the project `FloatyLogger.info`, `FloatyLogger.warn`, and
`FloatyLogger.error`.
This commit is contained in:
Austin Blatt 2020-08-12 09:49:15 -07:00
parent 8ec90007ca
commit 35faeab6be
7 changed files with 59 additions and 47 deletions
Download patch file Download diff file Expand all files Collapse all files

44
lib/vmfloaty.rb
View file

@ -18,10 +18,6 @@ require 'vmfloaty/logger'
class Vmfloaty
include Commander::Methods
def self.logger
@logger ||= FloatyLogger.new
end
def run # rubocop:disable Metrics/AbcSize
program :version, Vmfloaty::VERSION
program :description, "A CLI helper tool for Puppet's vmpooler to help you stay afloat"
@ -50,7 +46,7 @@ class Vmfloaty
force = options.force
if args.empty?
logger.error '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
@ -59,13 +55,13 @@ class Vmfloaty
max_pool_request = 5
large_pool_requests = os_types.select { |_, v| v > max_pool_request }
if !large_pool_requests.empty? && !force
logger.error "Requesting vms over #{max_pool_request} requires a --force flag."
logger.error 'Try again with `floaty get --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?
logger.error '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
@ -156,7 +152,7 @@ class Vmfloaty
modify_all = options.all
if hostname.nil? && !modify_all
logger.error 'ERROR: Provide a hostname or specify --all.'
FloatyLogger.error 'ERROR: Provide a hostname or specify --all.'
exit 1
end
running_vms = modify_all ? service.list_active(verbose) : hostname.split(',')
@ -177,7 +173,7 @@ class Vmfloaty
begin
modified_hash[vm] = service.modify(verbose, vm, modify_hash)
rescue ModifyError => e
logger.error e
FloatyLogger.error e
ok = false
end
end
@ -247,20 +243,20 @@ class Vmfloaty
end
end
else
logger.info 'You did not provide any hosts to delete'
FloatyLogger.info 'You did not provide any hosts to delete'
exit 1
end
unless failures.empty?
logger.info 'Unable to delete the following VMs:'
FloatyLogger.info 'Unable to delete the following VMs:'
failures.each do |hostname|
logger.info "- #{hostname}"
FloatyLogger.info "- #{hostname}"
end
logger.info '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?
logger.info unless failures.empty?
FloatyLogger.info unless failures.empty?
puts 'Scheduled the following VMs for deletion:'
successes.each do |hostname|
puts "- #{hostname}"
@ -288,7 +284,7 @@ class Vmfloaty
begin
snapshot_req = service.snapshot(verbose, hostname)
rescue TokenError, ModifyError => e
logger.error e
FloatyLogger.error e
exit 1
end
@ -313,12 +309,12 @@ class Vmfloaty
hostname = args[0]
snapshot_sha = args[1] || options.snapshot
logger.info "Two snapshot arguments were given....using snapshot #{snapshot_sha}" if args[1] && options.snapshot
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
logger.error e
FloatyLogger.error e
exit 1
end
@ -393,14 +389,14 @@ class Vmfloaty
status = service.token_status(verbose, token_value)
puts status
when nil
logger.error 'No action provided'
FloatyLogger.error 'No action provided'
exit 1
else
logger.error "Unknown action: #{action}"
FloatyLogger.error "Unknown action: #{action}"
exit 1
end
rescue TokenError => e
logger.error e
FloatyLogger.error e
exit 1
end
exit 0
@ -424,13 +420,13 @@ class Vmfloaty
use_token = !options.notoken
if args.empty?
logger.error '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
logger.info "Can't ssh to multiple hosts; Using #{host_os} only..." if args.length > 1
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
@ -457,7 +453,7 @@ class Vmfloaty
puts completion_file
exit 0
else
logger.error "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

18
lib/vmfloaty/abs.rb
View file

@ -68,7 +68,7 @@ class ABS
ret_val.push(req_hash)
rescue NoMethodError
Vmfloaty.logger.warn "Warning: couldn't parse line returned from abs/status/queue: "
FloatyLogger.warn "Warning: couldn't parse line returned from abs/status/queue: "
end
end
@ -85,7 +85,7 @@ class ABS
conn = Http.get_conn(verbose, url)
conn.headers['X-AUTH-TOKEN'] = token if token
Vmfloaty.logger.info "Trying to delete hosts #{hosts}" if verbose
FloatyLogger.info "Trying to delete hosts #{hosts}" if verbose
requests = get_active_requests(verbose, url, user)
jobs_to_delete = []
@ -113,7 +113,7 @@ class ABS
}
jobs_to_delete.push(req_hash)
else
Vmfloaty.logger.info "When using ABS you must delete all vms that you requested at the same time: Can't delete #{req_hash['request']['job']['id']}: #{hosts} does not include all of #{req_hash['allocated_resources']}"
FloatyLogger.info "When using ABS you must delete all vms that you requested at the same time: Can't delete #{req_hash['request']['job']['id']}: #{hosts} does not include all of #{req_hash['allocated_resources']}"
end
end
end
@ -127,7 +127,7 @@ class ABS
'hosts' => job['allocated_resources'],
}
Vmfloaty.logger.info "Deleting #{req_obj}" if verbose
FloatyLogger.info "Deleting #{req_obj}" if verbose
return_result = conn.post 'return', req_obj.to_json
req_obj['hosts'].each do |host|
@ -220,11 +220,11 @@ class ABS
end
end
Vmfloaty.logger.info "Posting to ABS #{req_obj.to_json}" if verbose
FloatyLogger.info "Posting to ABS #{req_obj.to_json}" if verbose
# os_string = os_type.map { |os, num| Array(os) * num }.flatten.join('+')
# raise MissingParamError, 'No operating systems provided to obtain.' if os_string.empty?
Vmfloaty.logger.info "Requesting VMs with job_id: #{saved_job_id}. Will retry for up to an hour."
FloatyLogger.info "Requesting VMs with job_id: #{saved_job_id}. Will retry for up to an hour."
res = conn.post 'request', req_obj.to_json
retries = 360
@ -237,7 +237,7 @@ class ABS
sleep_seconds = 10 if i >= 10
sleep_seconds = i if i < 10
Vmfloaty.logger.info "Waiting #{sleep_seconds} seconds to check if ABS request has been filled. Queue Position: #{queue_place}... (x#{i})"
FloatyLogger.info "Waiting #{sleep_seconds} seconds to check if ABS request has been filled. Queue Position: #{queue_place}... (x#{i})"
sleep(sleep_seconds)
end
@ -276,7 +276,7 @@ class ABS
end
def self.snapshot(_verbose, _url, _hostname, _token)
Vmfloaty.logger.info "Can't snapshot with ABS, use '--service vmpooler' (even for vms checked out with ABS)"
FloatyLogger.info "Can't snapshot with ABS, use '--service vmpooler' (even for vms checked out with ABS)"
end
def self.status(verbose, url)
@ -297,7 +297,7 @@ class ABS
def self.query(verbose, url, hostname)
return @active_hostnames if @active_hostnames
Vmfloaty.logger.info "For vmpooler/snapshot information, use '--service vmpooler' (even for vms checked out with ABS)"
FloatyLogger.info "For vmpooler/snapshot information, use '--service vmpooler' (even for vms checked out with ABS)"
conn = Http.get_conn(verbose, url)
res = conn.get "host/#{hostname}"

2
lib/vmfloaty/conf.rb
View file

@ -8,7 +8,7 @@ class Conf
begin
conf = YAML.load_file("#{Dir.home}/.vmfloaty.yml")
rescue StandardError
Vmfloaty.logger.warn "WARNING: There was no config file at #{Dir.home}/.vmfloaty.yml"
FloatyLogger.warn "WARNING: There was no config file at #{Dir.home}/.vmfloaty.yml"
end
conf
end

18
lib/vmfloaty/logger.rb
View file

@ -1,6 +1,22 @@
require 'logger'
class FloatyLogger < ::Logger
def self.logger
@@logger ||= FloatyLogger.new
end
def self.info(msg)
FloatyLogger.logger.info msg
end
def self.warn(msg)
FloatyLogger.logger.warn msg
end
def self.error(msg)
FloatyLogger.logger.error msg
end
def initialize
super(STDERR)
self.level = ::Logger::INFO
@ -8,4 +24,4 @@ class FloatyLogger < ::Logger
"#{msg}\n"
end
end
end
end

4
lib/vmfloaty/pooler.rb
View file

@ -60,10 +60,10 @@ class Pooler
while check_ondemandvm(verbose, request_id, url) == false
return false if (Time.now - start_time).to_i > timeout
Vmfloaty.logger.info "waiting for request #{request_id} to be fulfilled"
FloatyLogger.info "waiting for request #{request_id} to be fulfilled"
sleep 5
end
Vmfloaty.logger.info "The request has been fulfilled"
FloatyLogger.info "The request has been fulfilled"
check_ondemandvm(verbose, request_id, url)
end

10
lib/vmfloaty/service.rb
View file

@ -36,7 +36,7 @@ class Service
def user
unless @config['user']
Vmfloaty.logger.info "Enter your #{@config['url']} service username:"
FloatyLogger.info "Enter your #{@config['url']} service username:"
@config['user'] = STDIN.gets.chomp
end
@config['user']
@ -44,7 +44,7 @@ class Service
def token
unless @config['token']
Vmfloaty.logger.info 'No token found. Retrieving a token...'
FloatyLogger.info 'No token found. Retrieving a token...'
@config['token'] = get_new_token(nil)
end
@config['token']
@ -76,7 +76,7 @@ class Service
end
def retrieve(verbose, os_types, use_token = true, ondemand = nil)
Vmfloaty.logger.info 'Requesting a vm without a token...' unless use_token
FloatyLogger.info 'Requesting a vm without a token...' unless use_token
token_value = use_token ? token : nil
@service_object.retrieve verbose, os_types, token_value, url, user, @config, ondemand
end
@ -91,8 +91,8 @@ class Service
begin
token_value = token || get_new_token(verbose)
rescue TokenError => e
Vmfloaty.logger.error e
Vmfloaty.logger.info 'Could not get token... requesting vm without a token anyway...'
FloatyLogger.error e
FloatyLogger.info 'Could not get token... requesting vm without a token anyway...'
end
end
Ssh.ssh(verbose, self, host_os, token_value)

10
lib/vmfloaty/utils.rb
View file

@ -109,8 +109,8 @@ class Utils
raise "Invalid service type #{service.type}"
end
rescue StandardError => e
Vmfloaty.logger.error("Something went wrong while trying to gather information on #{hostname}:")
Vmfloaty.logger.error(e)
FloatyLogger.error("Something went wrong while trying to gather information on #{hostname}:")
FloatyLogger.error(e)
end
end
end
@ -134,7 +134,7 @@ class Utils
char = 'o'
puts "#{name.ljust(width)} #{(char * ready).green}#{(char * pending).yellow}#{(char * missing).red}"
rescue StandardError => e
Vmfloaty.logger.error "#{name.ljust(width)} #{e.red}"
FloatyLogger.error "#{name.ljust(width)} #{e.red}"
end
end
puts message.colorize(status_response['status']['ok'] ? :default : :red)
@ -153,11 +153,11 @@ class Utils
char = 'o'
puts "#{name.ljust(width)} #{(char * ready).green}#{(char * pending).yellow}#{(char * missing).red}"
rescue StandardError => e
Vmfloaty.logger.error "#{name.ljust(width)} #{e.red}"
FloatyLogger.error "#{name.ljust(width)} #{e.red}"
end
end
when 'ABS'
Vmfloaty.logger.error 'ABS Not OK' unless status_response
FloatyLogger.error 'ABS Not OK' unless status_response
puts 'ABS is OK'.green if status_response
else
raise "Invalid service type #{service.type}"