wavefront-cli 2.8.0 → 2.9.0

data/lib/wavefront-cli/commands/window.rb

@@ -14,6 +14,7 @@ class WavefrontCommandWindow < WavefrontCommandBase
   def sdk_class
     'MaintenanceWindow'
   end
+
   def _commands
     ["list #{CMN} [-l] [-f format] [-o offset] [-L limit]",
      "describe #{CMN} [-f format] <id>",

data/lib/wavefront-cli/commands/write.rb

@@ -11,7 +11,7 @@ class WavefrontCommandWrite < WavefrontCommandBase
     ['point [-DnViq] [-c file] [-P profile] [-E proxy] [-t time] ' \
      '[-p port] [-H host] [-T tag...] <metric> <value>',
      'file [-DnViq] [-c file] [-P profile] [-E proxy] [-H host] ' \
-     '[-p port] [-F format] [-m metric] [-T tag...] <file>']
+     '[-p port] [-F infileformat] [-m metric] [-T tag...] <file>']
   end
 
   def _options

data/lib/wavefront-cli/controller.rb

@@ -31,8 +31,8 @@ class WavefrontCliController
     cmd, opts = parse_args
     @opts = parse_opts(opts)
     pp @opts if @opts[:debug]
-    hook = load_sdk(cmd, @opts)
-    run_command(hook)
+    cli_class_obj = load_cli_class(cmd, @opts)
+    run_command(cli_class_obj)
   end
 
   # What you see when you do 'wf --help'
@@ -57,6 +57,7 @@ class WavefrontCliController
   # Parse the input. The first Docopt.docopt handles the default
   # options, the second works on the command.
   #
+  # rubocop:disable Metrics/AbcSize
   def parse_args
     Docopt.docopt(usage[:default], version: WF_CLI_VERSION, argv: args)
   rescue Docopt::Exit => e
@@ -72,34 +73,61 @@ class WavefrontCliController
       abort e.message
     end
   end
+  # rubocop:enable Metrics/AbcSize
 
-  def parse_opts(o)
-    WavefrontCli::OptHandler.new(o).opts
+  def parse_opts(options)
+    WavefrontCli::OptHandler.new(options).opts
   end
 
-  # Get the SDK class we need to run the command we've been given.
+  # Get the CLI class we need to run the command we've been given.
   #
   # @param cmd [String]
-  def load_sdk(cmd, opts)
+  # @return WavefrontCli::cmd
+  #
+  # rubocop:disable Metrics/AbcSize
+  def load_cli_class(cmd, opts)
     require_relative File.join('.', cmds[cmd].sdk_file)
     Object.const_get('WavefrontCli').const_get(cmds[cmd].sdk_class).new(opts)
   rescue WavefrontCli::Exception::UnhandledCommand
-    abort 'Fatal error. Unsupported command.'
-  rescue StandardError => e
-    p e
+    abort 'Fatal error. Unsupported command. Please open a Github issue.'
+  rescue WavefrontCli::Exception::InvalidInput => e
+    abort "Invalid input. #{e.message}"
+  rescue RuntimeError => e
+    abort "Unable to run command. #{e.message}."
   end
-
-  def run_command(hook)
-    hook.validate_opts
-    hook.run
+  # rubocop:enable Metrics/AbcSize
+
+  # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Metrics/MethodLength
+  def run_command(cli_class_obj)
+    cli_class_obj.validate_opts
+    cli_class_obj.run
+  rescue WavefrontCli::Exception::CredentialError => e
+    abort "Credential error. #{e.message}"
   rescue WavefrontCli::Exception::UnsupportedOutput => e
     abort e.message
+  rescue WavefrontCli::Exception::InsufficientData => e
+    abort "Insufficient data. #{e.message}"
+  rescue WavefrontCli::Exception::UnsupportedFileFormat
+    abort 'Unsupported file format.'
+  rescue WavefrontCli::Exception::UnparseableInput => e
+    abort "Cannot parse input. #{e.message}"
+  rescue WavefrontCli::Exception::FileNotFound
+    abort 'File not found.'
+  rescue WavefrontCli::Exception::UnparseableInput
+    abort 'Cannot parse input.'
+  rescue WavefrontCli::Exception::SystemError => e
+    abort "Host system error. #{e.message}"
+  rescue WavefrontCli::Exception::UnsupportedOperation => e
+    abort "Unsupported operation.\n#{e.message}"
   rescue StandardError => e
-    $stderr.puts "general error: #{e}"
-    $stderr.puts "re-run with '-D' for stack trace." unless opts[:debug]
-    $stderr.puts "Backtrace:\n\t#{e.backtrace.join("\n\t")}" if opts[:debug]
+    warn "general error: #{e}"
+    warn "re-run with '-D' for stack trace." unless opts[:debug]
+    warn "Backtrace:\n\t#{e.backtrace.join("\n\t")}" if opts[:debug]
     abort
   end
+  # rubocop:enable Metrics/MethodLength
+  # rubocop:enable Metrics/AbcSize
 
   # Each command is defined in its own file. Dynamically load all
   # those commands.
@@ -117,9 +145,9 @@ class WavefrontCliController
   # @param f [Pathname] path of file to load
   # return [Class] new class object defining command.
   #
-  def import_command(f)
-    return if f.extname != '.rb' || f.basename.to_s == 'base.rb'
-    k_name = f.basename.to_s[0..-4]
+  def import_command(path)
+    return if path.extname != '.rb' || path.basename.to_s == 'base.rb'
+    k_name = path.basename.to_s[0..-4]
     require(CMD_DIR + k_name)
     Object.const_get("WavefrontCommand#{k_name.capitalize}").new
   end
@@ -129,7 +157,9 @@ class WavefrontCliController
   # @param h [Hash] options hash
   # return [Hash] h with modified keys
   #
-  def sanitize_keys(h)
-    h.each_with_object({}) { |(k, v), r| r[k.to_s.delete('-').to_sym] = v }
+  def sanitize_keys(options)
+    options.each_with_object({}) do |(k, v), r|
+      r[k.to_s.delete('-').to_sym] = v
+    end
   end
 end

data/lib/wavefront-cli/derivedmetric.rb

@@ -13,6 +13,7 @@ module WavefrontCli
       wf.describe(options[:'<id>'], options[:version])
     end
 
+    # rubocop:disable Metrics/AbcSize
     def do_delete
       word = if wf.describe(options[:'<id>']).status.code == 200
                'Soft'
@@ -25,6 +26,7 @@ module WavefrontCli
 
       wf.delete(options[:'<id>'])
     end
+    # rubocop:enable Metrics/AbcSize
 
     def do_history
       wf.history(options[:'<id>'])
@@ -34,6 +36,7 @@ module WavefrontCli
       wf.create(build_body)
     end
 
+    # rubocop:disable Metrics/AbcSize
     def build_body
       ret = { query:                  options[:'<query>'],
               name:                   options[:'<name>'],
@@ -45,6 +48,7 @@ module WavefrontCli
       ret[:tags] = options[:ctag] if valid_tags?
       ret
     end
+    # rubocop:enable Metrics/AbcSize
 
     def valid_tags?
       !options[:ctag].empty? && validate_tags(options[:ctag])

data/lib/wavefront-cli/display/alert.rb

@@ -48,10 +48,12 @@ module WavefrontDisplay
       puts "Unsnoozed alert '#{options[:'<id>']}'."
     end
 
+    # rubocop:disable Metrics/AbcSize
     def do_summary
       kw = data.keys.map(&:size).max + 2
       data.delete_if { |_k, v| v.zero? } unless options[:all]
       data.sort.each { |k, v| puts format("%-#{kw}s%s", k, v) }
     end
+    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/wavefront-cli/display/base.rb

@@ -118,17 +118,20 @@ module WavefrontDisplay
 
     # if this is a section of a larger dataset, say so
     #
+    # rubocop:disable Metrics/AbcSize
     def pagination_line
-      if raw.respond_to?(:moreItems) && raw.moreItems == true
-        if raw.respond_to?(:offset) && raw.respond_to?(:limit)
-          enditem = raw.limit > 0 ? raw.offset + raw.limit - 1 : 0
-          puts format('List shows items %d to %d. Use -o and -L for more.',
-                      raw.offset, enditem)
-        else
-          puts 'List shows paginated output. Use -o and -L for more.'
-        end
+      return unless raw.respond_to?(:moreItems) && raw.moreItems == true
+
+      if raw.respond_to?(:offset) && raw.respond_to?(:limit)
+        puts 'List shows paginated output. Use -o and -L for more.'
+        return
       end
+
+      enditem = raw.limit > 0 ? raw.offset + raw.limit - 1 : 0
+      puts format('List shows items %d to %d. Use -o and -L for more.',
+                  raw.offset, enditem)
     end
+    # rubocop:enable Metrics/AbcSize
 
     # Give it a key-value hash, and it will return the size of the first
     # column to use when formatting that data.
@@ -264,9 +267,10 @@ module WavefrontDisplay
     #   used for unit tests.
     # return [String] a human-readable timestamp
     #
-    def human_time(t, force_utc = false)
-      raise ArgumentError unless t.is_a?(Numeric) || t.is_a?(String)
-      str = t.to_s
+    # rubocop:disable Metrics/MethodLength
+    def human_time(time, force_utc = false)
+      raise ArgumentError unless time.is_a?(Numeric) || time.is_a?(String)
+      str = time.to_s
 
       if str =~ /^\d{13}$/
         fmt = '%Q'
@@ -278,9 +282,12 @@ module WavefrontDisplay
         raise ArgumentError
       end
 
+      # rubocop:disable Style/DateTime
       ret = DateTime.strptime(str, fmt).to_time
+      # rubocop:enable Style/DateTime
       ret = ret.utc if force_utc
       ret.strftime(out_fmt)
     end
+    # rubocop:enable Metrics/MethodLength
   end
 end

data/lib/wavefront-cli/display/metric.rb

@@ -6,16 +6,24 @@ module WavefrontDisplay
   #
   class Metric < Base
     def do_describe
-      if data.empty? || data.hosts.empty?
-        puts 'No matches.'
-        exit
-      end
+      bail_out if no_data
 
       @data = data['hosts'].map do |h, _aggr|
         { host: h[:host], last_update: human_time(h[:last_update]) }
-      end.sort_by { |h| h[:last_update] }.reverse
+      end
+
+      @data.sort_by { |h| h[:last_update] }.reverse
 
       multicolumn(:host, :last_update)
     end
+
+    def no_data?
+      data.empty? || data.hosts.empty?
+    end
+
+    def bail_out
+      puts 'No matches.'
+      exit
+    end
   end
 end

data/lib/wavefront-cli/display/printer/long.rb

@@ -1,5 +1,5 @@
 require_relative 'base'
-require_relative '../../string'
+require_relative '../../stdlib/string'
 
 module WavefrontDisplayPrinter
   #
@@ -27,11 +27,12 @@ module WavefrontDisplayPrinter
     # @kw [Integer] the width of the first (key) column.
     # @returns [Nil]
     #
-    def _two_columns(data, kw = nil, fields = nil)
+    # rubocop:disable Metrics/AbcSize
+    def _two_columns(data, key_col_width = nil, fields = nil)
       [data].flatten.each do |item|
         preen_fields(item, fields)
-        kw = key_width(item) unless kw
-        @kw = kw unless @kw
+        key_col_width ||= key_width(item)
+        @kw ||= key_col_width
         mk_indent(indent)
         item.each { |k, v| parse_line(k, v) }
         add_line(nil) if indent.zero?
@@ -41,6 +42,7 @@ module WavefrontDisplayPrinter
       @kw += 2
       mk_indent(indent)
     end
+    # rubocop:enable Metrics/AbcSize
 
     # Drop any fields not required.
     #
@@ -149,8 +151,8 @@ module WavefrontDisplayPrinter
     # Add a horizontal rule, from the start of the second column to
     # just shy of the end of the terminal
     #
-    def add_rule(kw)
-      add_line(nil, '-' * (TW - kw - 4))
+    def add_rule(key_col_width)
+      add_line(nil, '-' * (TW - key_col_width - 4))
     end
 
     # Make the string which is prepended to each line.  Stepping is
@@ -170,12 +172,14 @@ module WavefrontDisplayPrinter
     # @param val [String, Numeric] what to print in the second column
     # @param tw [Integer] terminal width
     #
-    def mk_line(key, value = '', tw = TW)
+    # rubocop:disable Metrics/AbcSize
+    def mk_line(key, value = '', term_width = TW)
       return indent_str + ' ' * kw + value if !key || key.empty?
 
       indent_str + format("%-#{kw}s%s", key, value)
-                   .fold(tw, kw + indent_str.size, '').rstrip
+                   .fold(term_width, kw + indent_str.size, '').rstrip
     end
+    # rubocop:enable Metrics/AbcSize
 
     # Add a line, prepped by #mk_line() to the out array.
     #

data/lib/wavefront-cli/display/printer/sparkline.rb

@@ -21,8 +21,8 @@ class WavefrontSparkline
   #   the given range. The `rescue` clause handles occasions when
   #   Wavefront returns NaN as a value, or if the range is zero.
   #
-  def sized_block(v, range)
-    BLOCKS[(v / range * (BLOCKS.length - 1)).floor]
+  def sized_block(val, range)
+    BLOCKS[(val / range * (BLOCKS.length - 1)).floor]
   rescue StandardError
     BLOCKS.first
   end

data/lib/wavefront-cli/display/printer/terse.rb

@@ -1,7 +1,7 @@
 require_relative 'base'
 
 module WavefrontDisplayPrinter
-
+  #
   # Print things which are per-row. The terse listings, primarily
   #
   class Terse < Base
@@ -26,6 +26,7 @@ module WavefrontDisplayPrinter
     #
     # @return [Hash] with the same keys as :keys and Integer values
     #
+    # rubocop:disable Metrics/AbcSize
     def longest_keys
       keys.each_with_object(Hash[*keys.map { |k| [k, 0] }.flatten]) \
       do |k, aggr|
@@ -37,6 +38,7 @@ module WavefrontDisplayPrinter
         end
       end
     end
+    # rubocop:enable Metrics/AbcSize
 
     # Print multiple column output. This method does no word
     # wrapping.

data/lib/wavefront-cli/display/query.rb

@@ -6,6 +6,7 @@ module WavefrontDisplay
   # Format human-readable output for queries.
   #
   class Query < Base
+    # rubocop:disable Metrics/AbcSize
     def do_default
       d_obj = { name:       data.name,
                 query:      data.query,
@@ -19,14 +20,15 @@ module WavefrontDisplay
       @data = d_obj
       long_output
     end
+    # rubocop:enable Metrics/AbcSize
 
     def mk_timeseries(data)
-      return []  unless data.key?(:timeseries)
+      return [] unless data.key?(:timeseries)
 
       data[:timeseries].each do |s|
         unless options[:nospark]
           s[:sparkline] = WavefrontSparkline.new(s[:data]).sparkline
-          s.reorder!({label: nil, sparkline: nil})
+          s.reorder!(label: nil, sparkline: nil)
         end
 
         s[:data] = humanize_series(s[:data])
@@ -54,7 +56,7 @@ module WavefrontDisplay
       if data.empty?
         puts 'No aliases defined.'
       else
-        data.each { |k, _v| puts k.to_s[2..-1] }
+        data.each_key { |k| puts k.to_s[2..-1] }
       end
     end
 
@@ -67,6 +69,7 @@ module WavefrontDisplay
       data
     end
 
+    # rubocop:disable Metrics/MethodLength
     def humanize_series(data)
       last_date = nil
 
@@ -84,6 +87,7 @@ module WavefrontDisplay
         last_date = date
         format('%-12s %s    %s', ds, time, val)
       end
+      # rubocop:enable Metrics/MethodLength
     end
   end
 end

data/lib/wavefront-cli/display/write.rb

@@ -4,10 +4,12 @@ module WavefrontDisplay
   # Format human-readable output when writing points.
   #
   class Write < Base
+    # rubocop:disable Metrics/AbcSize
     def do_point
       report unless options[:quiet] || (data[:unsent] + data[:rejected] > 0)
       exit(data.rejected.zero? && data.unsent.zero? ? 0 : 1)
     end
+    # rubocop:enable Metrics/AbcSize
 
     def do_file
       do_point

data/lib/wavefront-cli/event.rb

@@ -1,14 +1,15 @@
 require 'fileutils'
+require 'open3'
 require 'wavefront-sdk/mixins'
 require_relative 'base'
-require 'open3'
 
 EVENT_STATE_DIR = Pathname.new('/var/tmp/wavefront')
+
 module WavefrontCli
   #
   # CLI coverage for the v2 'event' API.
   #
-  class Event < WavefrontCli::Base
+  class Event < Base
     attr_reader :state_dir
     include Wavefront::Mixins
 
@@ -32,7 +33,7 @@ module WavefrontCli
     # You can override the options generated by docopt. This is how
     # #wrap() works.
     #
-    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/AbcSize
     def do_create(opts = nil)
       opts ||= options
 
@@ -50,6 +51,7 @@ module WavefrontCli
 
       resp
     end
+    # rubocop:enable Metrics/AbcSize
 
     # The user doesn't have to give us an event ID.  If no event
     # name is given, we'll pop the last event off the stack. If an
@@ -57,6 +59,7 @@ module WavefrontCli
     # name, we'll look for something on the stack.  If it does look
     # like a real event, we'll make and API call straight away.
     #
+    # rubocop:disable Metrics/AbcSize
     def do_close(id = nil)
       id ||= options[:'<id>']
       ev_file = id =~ /^\d{13}:.+/ ? state_dir + id : nil
@@ -68,6 +71,7 @@ module WavefrontCli
       ev_file.unlink if ev_file && ev_file.exist? && res.status.code == 200
       res
     end
+    # rubocop:enable Metrics/AbcSize
 
     def do_show
       events = local_event_list
@@ -95,6 +99,10 @@ module WavefrontCli
 
     # return [Hash] body for #create() method
     #
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/PerceivedComplexity
+    # rubocop:disable Metrics/MethodLength
     def create_body(opts, t_start)
       body = { name:        opts[:'<event>'],
                startTime:   t_start,
@@ -114,6 +122,10 @@ module WavefrontCli
 
       body
     end
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/AbcSize
 
     # @return a local event from the stack directory
     #
@@ -130,15 +142,14 @@ module WavefrontCli
     def local_event_list
       state_dir.children
     rescue Errno::ENOENT
-      raise 'There is no event state directory on this host.'
+      raise(WavefrontCli::Exception::SystemError,
+            'There is no event state directory on this host.')
     end
 
     # Run a command, stream stderr and stdout to the screen (they
     # get combined -- could be an issue for someone somewhere) and
     # return the command's exit code
     #
-    # rubocop:disable Lint/AssignmentInCondition
-    #
     def run_wrapped_cmd(cmd)
       separator = '-' * (TW - 4)
 
@@ -146,7 +157,9 @@ module WavefrontCli
       ret = nil
 
       Open3.popen2e(cmd) do |_in, out, thr|
+        # rubocop:disable Lint/AssignmentInCondition
         while l = out.gets do STDERR.puts(l) end
+        # rubocop:enable Lint/AssignmentInCondition
         ret = thr.value.exitstatus
       end
 
@@ -160,21 +173,19 @@ module WavefrontCli
     #
     def create_state_file(id, hosts = [])
       fname = state_dir + id
-
-      begin
-        File.open(fname, 'w') { hosts.to_s }
-      rescue StandardError
-        raise 'Event was created but state file was not.'
-      end
-
+      File.open(fname, 'w') { hosts.to_s }
       puts "Event state recorded at #{fname}."
+    rescue StandardError
+      puts 'NOTICE: event was created but state file was not.'
     end
 
     def create_state_dir
       FileUtils.mkdir_p(state_dir)
-      return true if state_dir.exist? && state_dir.directory? &&
-                     state_dir.writable?
-      raise 'Cannot create state directory.'
+      raise unless state_dir.exist? && state_dir.directory? &&
+                   state_dir.writable?
+    rescue StandardError
+      raise(WavefrontCli::Exception::SystemError,
+            "Cannot create writable system directory at '#{state_dir}'.")
     end
 
     def validate_input