From c14403682a02494f89fe4ea60ccd89f0de70aead Mon Sep 17 00:00:00 2001 From: Glenn Sarti Date: Thu, 2 Mar 2017 20:18:11 -0800 Subject: [PATCH] (maint) Fix rubocop offenses This commit updates VM Pooler to fix any existing rubocop offenses and also fixes any offenses in the lib/vmpooler.rb file. This commit also regenerates the Todo file. --- .rubocop.yml | 4 +++- .rubocop_todo.yml | 29 ++++------------------------- lib/vmpooler.rb | 16 ++++++++-------- lib/vmpooler/pool_manager.rb | 14 +++++++------- 4 files changed, 22 insertions(+), 41 deletions(-) diff --git a/.rubocop.yml b/.rubocop.yml index 5dafadb..f49c992 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -29,13 +29,15 @@ Metrics/PerceivedComplexity: Enabled: false Metrics/CyclomaticComplexity: Enabled: false -# - Long Methods, Classes and blocks +# - Long Methods, Classes, Blocks, and Modules Metrics/MethodLength: Enabled: false Metrics/ClassLength: Enabled: false Metrics/BlockLength: Enabled: false +Metrics/ModuleLength: + Enabled: false # Either sytnax for regex is ok diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml index 423c3fa..1d17df2 100644 --- a/.rubocop_todo.yml +++ b/.rubocop_todo.yml @@ -1,6 +1,6 @@ # This configuration was generated by # `rubocop --auto-gen-config` -# on 2017-02-10 13:29:15 -0800 using RuboCop version 0.47.1. +# on 2017-03-02 20:16:29 -0800 using RuboCop version 0.47.1. # The point is for the user to remove these configuration records # one by one as the offenses are removed from the code base. # Note that changes in the inspected code, or installation of new @@ -51,11 +51,6 @@ Lint/UselessAssignment: Metrics/BlockNesting: Max: 5 -# Offense count: 1 -# Configuration parameters: CountComments. -Metrics/ModuleLength: - Max: 289 - # Offense count: 1 # Configuration parameters: CountKeywordArgs. Metrics/ParameterLists: @@ -68,12 +63,6 @@ Performance/RedundantMatch: - 'lib/vmpooler/api/v1.rb' - 'lib/vmpooler/vsphere_helper.rb' -# Offense count: 1 -# Cop supports --auto-correct. -Security/YAMLLoad: - Exclude: - - 'lib/vmpooler.rb' - # Offense count: 1 # Cop supports --auto-correct. # Configuration parameters: EnforcedStyle, SupportedStyles, IndentationWidth. @@ -115,7 +104,7 @@ Style/CaseEquality: Exclude: - 'lib/vmpooler/api/helpers.rb' -# Offense count: 12 +# Offense count: 13 # Cop supports --auto-correct. # Configuration parameters: EnforcedStyle, SupportedStyles, IndentOneStep, IndentationWidth. # SupportedStyles: case, end @@ -125,14 +114,6 @@ Style/CaseIndentation: - 'lib/vmpooler/api/v1.rb' - 'lib/vmpooler/vsphere_helper.rb' -# Offense count: 2 -# Cop supports --auto-correct. -# Configuration parameters: EnforcedStyle, SupportedStyles. -# SupportedStyles: is_a?, kind_of? -Style/ClassCheck: - Exclude: - - 'lib/vmpooler.rb' - # Offense count: 1 # Cop supports --auto-correct. Style/ClosingParenthesisIndentation: @@ -415,13 +396,12 @@ Style/SpaceAfterNot: Exclude: - 'lib/vmpooler/pool_manager.rb' -# Offense count: 9 +# Offense count: 7 # Cop supports --auto-correct. # Configuration parameters: EnforcedStyle, SupportedStyles. # SupportedStyles: space, no_space Style/SpaceAroundEqualsInParameterDefault: Exclude: - - 'lib/vmpooler.rb' - 'lib/vmpooler/api/helpers.rb' - 'lib/vmpooler/pool_manager.rb' - 'lib/vmpooler/vsphere_helper.rb' @@ -462,11 +442,10 @@ Style/SpaceInsideParens: Exclude: - 'lib/vmpooler/api/v1.rb' -# Offense count: 4 +# Offense count: 2 # Cop supports --auto-correct. Style/SpaceInsidePercentLiteralDelimiters: Exclude: - - 'lib/vmpooler.rb' - 'lib/vmpooler/api.rb' # Offense count: 47 diff --git a/lib/vmpooler.rb b/lib/vmpooler.rb index 05468d3..26c3faf 100644 --- a/lib/vmpooler.rb +++ b/lib/vmpooler.rb @@ -12,7 +12,7 @@ module Vmpooler require 'yaml' require 'set' - %w( api graphite logger pool_manager vsphere_helper statsd dummy_statsd ).each do |lib| + %w(api graphite logger pool_manager vsphere_helper statsd dummy_statsd).each do |lib| begin require "vmpooler/#{lib}" rescue LoadError @@ -20,12 +20,12 @@ module Vmpooler end end - def self.config(filepath='vmpooler.yaml') + def self.config(filepath = 'vmpooler.yaml') parsed_config = {} if ENV['VMPOOLER_CONFIG'] # Load configuration from ENV - parsed_config = YAML.load(ENV['VMPOOLER_CONFIG']) + parsed_config = YAML.safe_load(ENV['VMPOOLER_CONFIG']) else # Load the configuration file from disk config_file = File.expand_path(filepath) @@ -37,8 +37,8 @@ module Vmpooler if parsed_config[:auth]['provider'] == 'dummy' unless ENV['VMPOOLER_DEBUG'] warning = [ - "Dummy authentication should not be used outside of debug mode", - "please set environment variable VMPOOLER_DEBUG to 'true' if you want to use dummy authentication", + 'Dummy authentication should not be used outside of debug mode', + 'please set environment variable VMPOOLER_DEBUG to \'true\' if you want to use dummy authentication' ] raise warning.join(";\s") @@ -60,13 +60,13 @@ module Vmpooler parsed_config[:pools].each do |pool| parsed_config[:pool_names] << pool['name'] if pool['alias'] - if pool['alias'].kind_of?(Array) + if pool['alias'].is_a?(Array) pool['alias'].each do |a| parsed_config[:alias] ||= {} parsed_config[:alias][a] = pool['name'] parsed_config[:pool_names] << a end - elsif pool['alias'].kind_of?(String) + elsif pool['alias'].is_a?(String) parsed_config[:alias][pool['alias']] = pool['name'] parsed_config[:pool_names] << pool['alias'] end @@ -83,7 +83,7 @@ module Vmpooler parsed_config end - def self.new_redis(host='localhost') + def self.new_redis(host = 'localhost') Redis.new(host: host) end diff --git a/lib/vmpooler/pool_manager.rb b/lib/vmpooler/pool_manager.rb index 52f6d61..079e31c 100644 --- a/lib/vmpooler/pool_manager.rb +++ b/lib/vmpooler/pool_manager.rb @@ -436,7 +436,7 @@ module Vmpooler unless maxloop.zero? break if loop_count >= maxloop - loop_count = loop_count + 1 + loop_count += 1 end end end @@ -468,7 +468,7 @@ module Vmpooler unless maxloop.zero? break if loop_count >= maxloop - loop_count = loop_count + 1 + loop_count += 1 end end end @@ -569,7 +569,7 @@ module Vmpooler finish end - def check_pool(pool,maxloop = 0, loop_delay = 5) + def check_pool(pool, maxloop = 0, loop_delay = 5) $logger.log('d', "[*] [#{pool['name']}] starting worker thread") $vsphere[pool['name']] ||= Vmpooler::VsphereHelper.new $config, $metrics @@ -582,7 +582,7 @@ module Vmpooler unless maxloop.zero? break if loop_count >= maxloop - loop_count = loop_count + 1 + loop_count += 1 end end end @@ -722,7 +722,7 @@ module Vmpooler if $redis.get('vmpooler__tasks__clone').to_i < $config[:config]['task_limit'].to_i begin $redis.incr('vmpooler__tasks__clone') - clone_vm(pool,vsphere) + clone_vm(pool, vsphere) rescue => err $logger.log('s', "[!] [#{pool['name']}] clone failed during check_pool with an error: #{err}") $redis.decr('vmpooler__tasks__clone') @@ -736,7 +736,7 @@ module Vmpooler raise end - def execute!(maxloop = 0, loop_delay = 1) + def execute!(maxloop = 0, loop_delay = 1) $logger.log('d', 'starting vmpooler') # Clear out the tasks manager, as we don't know about any tasks at this point @@ -773,7 +773,7 @@ module Vmpooler unless maxloop.zero? break if loop_count >= maxloop - loop_count = loop_count + 1 + loop_count += 1 end end end