wavefront-cli 2.1.4 → 2.1.5

data/README.md

@@ -1,5 +1,5 @@
 # Wavefront CLI
-[![Build Status](https://travis-ci.org/snltd/wavefront-cli.svg?branch=master)](https://travis-ci.org/snltd/wavefront-cli) [![Code Climate](https://codeclimate.com/github/snltd/wavefront-cli/badges/gpa.svg)](https://codeclimate.com/github/snltd/wavefront-cli) [![Issue Count](https://codeclimate.com/github/snltd/wavefront-cli/badges/issue_count.svg)](https://codeclimate.com/github/snltd/wavefront-cli) [![Dependency Status](https://gemnasium.com/badges/github.com/snltd/wavefront-cli.svg)](https://gemnasium.com/github.com/snltd/wavefront-cli) [![Gem Version](https://badge.fury.io/rb/wavefront-cli.svg)](https://badge.fury.io/rb/wavefront-cli) ![](http://ruby-gem-downloads-badge.herokuapp.com/wavefront-cli?type=total)
+[![Build Status](https://travis-ci.org/snltd/wavefront-cli.svg?branch=master)](https://travis-ci.org/snltd/wavefront-cli) [![Maintainability](https://api.codeclimate.com/v1/badges/9b712047af0b2dafc146/maintainability)](https://codeclimate.com/github/snltd/wavefront-cli/maintainability) [![Dependency Status](https://gemnasium.com/badges/github.com/snltd/wavefront-cli.svg)](https://gemnasium.com/github.com/snltd/wavefront-cli) [![Gem Version](https://badge.fury.io/rb/wavefront-cli.svg)](https://badge.fury.io/rb/wavefront-cli) ![](http://ruby-gem-downloads-badge.herokuapp.com/wavefront-cli?type=total)
 
 
 This package provides a command-line interface to

data/lib/wavefront-cli/alert.rb

@@ -41,10 +41,9 @@ module WavefrontCli
     #
     # @param raw [Hash] Ruby hash of imported data
     #
-    # rubocop:disable Metrics/MethodLength
     def import_to_create(raw)
-      ret = %w(name condition minutes target severity displayExpression
-               additionalInformation).each_with_object({}) do |k, aggr|
+      ret = %w[name condition minutes target severity displayExpression
+               additionalInformation].each_with_object({}) do |k, aggr|
         aggr[k.to_sym] = raw[k]
       end
 

data/lib/wavefront-cli/base.rb

@@ -29,10 +29,7 @@ module WavefrontCli
       @klass_word = sdk_class.split('::').last.downcase
       validate_input
 
-      if options.include?(:help) && options[:help]
-        puts options
-        exit 0
-      end
+      options_and_exit if options[:help]
 
       require File.join('wavefront-sdk', @klass_word)
       @klass = Object.const_get(sdk_class)
@@ -40,6 +37,11 @@ module WavefrontCli
       send(:post_initialize, options) if respond_to?(:post_initialize)
     end
 
+    def options_and_exit
+      puts options
+      exit 0
+    end
+
     def run
       @wf = klass.new(mk_creds, mk_opts)
       dispatch
@@ -65,8 +67,8 @@ module WavefrontCli
       send(:extra_validation) if respond_to?(:extra_validation)
     end
 
-    def validate_tags
-      Array(options[:'<tag>']).each do |t|
+    def validate_tags(key = :'<tag>')
+      Array(options[key]).each do |t|
         begin
           send(:wf_tag?, t)
         rescue Wavefront::Exception::InvalidTag
@@ -89,8 +91,7 @@ module WavefrontCli
     def mk_creds
       { token:    options[:token],
         endpoint: options[:endpoint],
-        agent:    "wavefront-cli-#{WF_CLI_VERSION}"
-      }
+        agent:    "wavefront-cli-#{WF_CLI_VERSION}" }
     end
 
     # Make a common wavefront-sdk options object from standard CLI
@@ -101,8 +102,7 @@ module WavefrontCli
     def mk_opts
       { debug:   options[:debug],
         verbose: options[:verbose],
-        noop:    options[:noop],
-      }
+        noop:    options[:noop] }
     end
 
     # To allow a user to default to different output formats for
@@ -143,7 +143,7 @@ module WavefrontCli
       #
       m_list.sort_by(&:length).reverse.each do |m|
         if m.reject { |w| options[w.to_sym] }.empty?
-          method = (%w(do) + m).join('_')
+          method = (%w[do] + m).join('_')
           return display(public_send(method), method)
         end
       end
@@ -171,7 +171,7 @@ module WavefrontCli
     def display(data, method)
       exit if options[:noop]
 
-      [:status, :response].each do |b|
+      %i[status response].each do |b|
         abort "no #{b} block in API response" unless data.respond_to?(b)
       end
 
@@ -274,7 +274,7 @@ module WavefrontCli
 
       begin
         prepped = import_to_create(raw)
-      rescue => e
+      rescue StandardError => e
         puts e if options[:debug]
         raise 'could not parse input.'
       end
@@ -299,16 +299,23 @@ module WavefrontCli
       require 'wavefront-sdk/search'
       wfs = Wavefront::Search.new(mk_creds, mk_opts)
 
-      query = options[:'<condition>'].each_with_object([]) do |c, aggr|
-        key, value = c.split(/\W/, 2)
+      query = conds_to_query(options[:'<condition>'])
+
+      wfs.search(klass_word, query, limit: options[:limit],
+                                    offset: options[:offset] ||
+                                            options[:cursor])
+    end
+
+    # Turn a list of search conditions into an API query
+    #
+    def conds_to_query(conds)
+      conds.each_with_object([]) do |cond, aggr|
+        key, value = cond.split(/\W/, 2)
         q = { key: key, value: value }
-        q[:matchingMethod] = 'EXACT' if c.start_with?("#{key}=")
-        q[:matchingMethod] = 'STARTSWITH' if c.start_with?("#{key}^")
+        q[:matchingMethod] = 'EXACT' if cond.start_with?("#{key}=")
+        q[:matchingMethod] = 'STARTSWITH' if cond.start_with?("#{key}^")
         aggr.<< q
       end
-
-      wfs.search(klass_word, query, { limit: options[:limit],
-                                      offset: options[:offset] || options[:cursor]})
     end
 
     def do_tags

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

@@ -6,7 +6,6 @@ class WavefrontCommandAlert < WavefrontCommandBase
   def description
     'view and manage alerts'
   end
-
   def _commands
     ["list #{CMN} [-l] [-f format] [-o offset] [-L limit]",
      "describe #{CMN} [-f format] [-v version] <id>",

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

@@ -12,13 +12,13 @@ class WavefrontCommandEvent < WavefrontCommandBase
       '[-o cursor]',
      "describe #{CMN} [-f format] <id>",
      "create #{CMN} [-d description] [-s time] [-i | -e time] " \
-     '[-S severity] [-T type] [-H host...] [-N] <event>',
+     '[-S severity] [-T type] [-H host...] [-g tag...] [-N] <event>',
      "close #{CMN} [<id>]",
      "delete #{CMN} <id>",
      "update #{CMN} <key=value> <id>",
      "search #{CMN} [-f format] [-o offset] [-L limit] [-l] <condition>...",
      "wrap #{CMN} [-C command] [-d description] [-S severity] [-T type] " \
-     '[-H host...] <event>',
+     '[-H host...] [-g tag...] <event>',
      tag_commands,
      'show [-D]']
   end
@@ -37,6 +37,7 @@ class WavefrontCommandEvent < WavefrontCommandBase
      '-H, --host=STRING         source to which event applies',
      '-N, --nostate             do not create a local file recording ' \
      'the event',
+     '-g, --evtag=TAG           event tag',
      '-C, --command=COMMAND     command to run',
      '-f, --format=STRING       output format']
   end

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

@@ -12,7 +12,6 @@ class WavefrontCommandQuery < WavefrontCommandBase
            '[-ivO] [-S mode] [-N name] [-p points] <query>',
      "raw #{CMN} [-H host] [-s time] [-e time] [-f format] <metric>"]
   end
-
   def _options
     [common_options,
      '-g, --granularity=STRING  query granularity (d, h, m, or s)',

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

@@ -14,7 +14,6 @@ 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

@@ -14,7 +14,6 @@ class WavefrontCommandWrite < WavefrontCommandBase
      '[-p port] [-F format] [-m metric] [-T tag...] ' \
      '[-r rate] <file>']
   end
-
   def _options
     ['-E, --proxy=URI            proxy endpoint',
      '-t, --time=TIME            time of data point (omit to use ' \

data/lib/wavefront-cli/constants.rb

@@ -1,5 +1,4 @@
 module WavefrontCli
-
   # Universal truths
   #
   module Constants

data/lib/wavefront-cli/controller.rb

@@ -1,9 +1,9 @@
 # For development against a local checkout of the SDK, uncomment
 # this block
 #
-# dir = Pathname.new(__FILE__).dirname.realpath.parent.parent.parent
-# $LOAD_PATH.<< dir + 'lib'
-# $LOAD_PATH.<< dir + 'wavefront-sdk' + 'lib'
+dir = Pathname.new(__FILE__).dirname.realpath.parent.parent.parent
+$LOAD_PATH.<< dir + 'lib'
+$LOAD_PATH.<< dir + 'wavefront-sdk' + 'lib'
 
 require 'pathname'
 require 'pp'
@@ -82,14 +82,14 @@ class WavefrontCliController
     Object.const_get('WavefrontCli').const_get(cmds[cmd].sdk_class).new(opts)
   rescue WavefrontCli::Exception::UnhandledCommand
     abort 'Fatal error. Unsupported command.'
-  rescue => e
+  rescue StandardError => e
     p e
   end
 
   def run_command(hook)
     hook.validate_opts
     hook.run
-  rescue => e
+  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]

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

@@ -6,9 +6,9 @@ module WavefrontDisplay
   #
   class Alert < Base
     def do_list
-      long_output [:id, :minutes, :target, :status, :tags, :hostsUsed,
-                   :condition, :displayExpression, :severity,
-                   :additionalInformation]
+      long_output %i[id minutes target status tags hostsUsed
+                     condition displayExpression severity
+                     additionalInformation]
     end
 
     def do_list_brief
@@ -37,8 +37,6 @@ module WavefrontDisplay
     def do_unsnooze
       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/lib/wavefront-cli/display/dashboard.rb

@@ -6,9 +6,9 @@ module WavefrontDisplay
   #
   class Dashboard < Base
     def do_list
-      long_output [:id, :minutes, :target, :status, :tags, :hostsUsed,
-                   :condition, :displayExpression, :severity,
-                   :additionalInformation]
+      long_output %i[id minutes target status tags hostsUsed
+                     condition displayExpression severity
+                     additionalInformation]
     end
 
     def do_describe

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

@@ -6,8 +6,8 @@ module WavefrontDisplay
   #
   class Webhook < Base
     def do_list
-      long_output([:id, :title, :description, :createdEpochMillis,
-                   :updatedEpochMillis, :updaterId, :creatorId])
+      long_output(%i[id title description createdEpochMillis
+                     updatedEpochMillis updaterId creatorId])
     end
 
     def do_list_brief

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

@@ -5,7 +5,7 @@ module WavefrontDisplay
   #
   class Write < Base
     def do_point
-      [:sent, :rejected, :unsent].each do |k|
+      %i[sent rejected unsent].each do |k|
         puts format('  %12s %d', k.to_s, data[k])
       end
 

data/lib/wavefront-cli/event.rb

@@ -4,7 +4,6 @@ require_relative './base'
 require 'open3'
 
 EVENT_STATE_DIR = Pathname.new('/var/tmp/wavefront')
-
 module WavefrontCli
   #
   # CLI coverage for the v2 'event' API.
@@ -14,19 +13,14 @@ module WavefrontCli
     include Wavefront::Mixins
 
     def post_initialize(_options)
-      begin
-        @state_dir = EVENT_STATE_DIR + Etc.getlogin
-      rescue
-        @state_dir = EVENT_STATE_DIR + 'notty'
-      end
-
+      @state_dir = EVENT_STATE_DIR + (Etc.getlogin || 'notty')
       create_state_dir
     end
 
     def do_list
-      options[:start] = Time.now - 600 unless options[:start]
-      options[:end] = Time.now unless options[:end]
-      wf.list(options[:start], options[:end], options[:limit] || 100,
+      wf.list(options[:start]  || Time.now - 600,
+              options[:end]    || Time.now,
+              options[:limit]  || 100,
               options[:cursor] || nil)
     end
 
@@ -38,6 +32,7 @@ module WavefrontCli
     # You can override the options generated by docopt. This is how
     # #wrap() works.
     #
+    # rubocop:disable Metrics/CyclomaticComplexity
     def do_create(opts = nil)
       opts ||= options
 
@@ -45,20 +40,7 @@ module WavefrontCli
 
       t_start = parse_time(opts[:start], true)
 
-      body = { name:        opts[:'<event>'],
-               startTime:   t_start,
-               annotations: {} }
-
-      body[:annotations][:details] = opts[:desc] if opts[:desc]
-      body[:annotations][:severity] = opts[:severity] if opts[:severity]
-      body[:annotations][:type] = opts[:type] if opts[:type]
-      body[:hosts] = opts[:host] if opts[:host]
-
-      if opts[:instant]
-        body[:endTime] = t_start + 1
-      elsif opts[:end]
-        body[:endTime] = parse_time(opts[:end], true)
-      end
+      body = create_body(opts, t_start)
 
       resp = wf.create(body)
 
@@ -77,16 +59,8 @@ module WavefrontCli
     #
     def do_close(id = nil)
       id ||= options[:'<id>']
-      ev_file = nil
-
-      ev = if !id
-             pop_event
-           elsif id =~ /^\d{13}:.+/
-             ev_file = state_dir + id
-             id
-           else
-             pop_event(id)
-           end
+      ev_file = id =~ /^\d{13}:.+/ ? state_dir + id : nil
+      ev = local_event(id)
 
       abort "No locally stored event matches '#{id}'." unless ev
 
@@ -96,11 +70,7 @@ module WavefrontCli
     end
 
     def do_show
-      begin
-        events = state_dir.children
-      rescue Errno::ENOENT
-        raise 'There is no event state directory on this host.'
-      end
+      events = local_event_list
 
       if events.size.zero?
         puts 'No open events.'
@@ -123,6 +93,46 @@ module WavefrontCli
 
     private
 
+    # return [Hash] body for #create() method
+    #
+    def create_body(opts, t_start)
+      body = { name:        opts[:'<event>'],
+               startTime:   t_start,
+               annotations: {} }
+
+      body[:annotations][:details] = opts[:desc] if opts[:desc]
+      body[:annotations][:severity] = opts[:severity] if opts[:severity]
+      body[:annotations][:type] = opts[:type] if opts[:type]
+      body[:hosts] = opts[:host] if opts[:host]
+      body[:tags] = opts[:evtag] if opts[:evtag]
+
+      if opts[:instant]
+        body[:endTime] = t_start + 1
+      elsif opts[:end]
+        body[:endTime] = parse_time(opts[:end], true)
+      end
+
+      body
+    end
+
+    # @return a local event from the stack directory
+    #
+    def local_event(id)
+      if !id
+        pop_event
+      elsif id =~ /^\d{13}:.+/
+        id
+      else
+        pop_event(id)
+      end
+    end
+
+    def local_event_list
+      state_dir.children
+    rescue Errno::ENOENT
+      raise '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
@@ -130,19 +140,17 @@ module WavefrontCli
     # rubocop:disable Lint/AssignmentInCondition
     #
     def run_wrapped_cmd(cmd)
-      puts 'Command output follows, on STDERR:'
-      puts '-' * (TW - 4)
+      separator = '-' * (TW - 4)
+
+      puts "Command output follows, on STDERR:\n#{separator}"
       ret = nil
 
       Open3.popen2e(cmd) do |_in, out, thr|
-        while l = out.gets
-          STDERR.puts l
-        end
-
+        while l = out.gets do STDERR.puts(l) end
         ret = thr.value.exitstatus
       end
 
-      puts '-' * (TW - 4)
+      puts separator
       ret
     end
 
@@ -155,7 +163,7 @@ module WavefrontCli
 
       begin
         File.open(fname, 'w') { hosts.to_s }
-      rescue
+      rescue StandardError
         raise 'Event was created but state file was not.'
       end
 
@@ -172,6 +180,7 @@ module WavefrontCli
     def validate_input
       validate_id if options[:'<id>'] && !options[:close]
       validate_tags if options[:'<tag>']
+      validate_tags(:evtag) if options[:evtag]
       send(:extra_validation) if respond_to?(:extra_validation)
     end
 
@@ -180,20 +189,25 @@ module WavefrontCli
     # Chances are you'll only ever have one in-play at once.
     #
     # @param name [String] name of event
-    # Returns an array of [timestamp, event_name]
+    # @eturn an array of [timestamp, event_name]
     #
-    def pop_event(name = false)
+    def pop_event(name = nil)
       return false unless state_dir.exist?
 
-      list = state_dir.children
-
-      list.select! { |f| f.basename.to_s.split(':').last == name } if name
-
+      list = local_events_with_name(name)
       return false if list.empty?
 
       ev_file = list.sort.last
       File.unlink(ev_file)
       ev_file.basename.to_s
     end
+
+    def local_events_with_name(name = nil)
+      list = local_event_list
+
+      return list unless name
+
+      list.select { |f| f.basename.to_s.split(':').last == name }
+    end
   end
 end

data/lib/wavefront-cli/integration.rb

@@ -5,7 +5,6 @@ module WavefrontCli
   # CLI coverage for the v2 'integration' API.
   #
   class Integration < WavefrontCli::Base
-
     def do_status
       wf.status(options[:'<id>'])
     end

data/lib/wavefront-cli/maintenancewindow.rb

@@ -6,7 +6,6 @@ module WavefrontCli
   # CLI coverage for the v2 'maintenancewindow' API.
   #
   class MaintenanceWindow < WavefrontCli::Base
-
     include Wavefront::Mixins
 
     def validator_method
@@ -18,24 +17,10 @@ module WavefrontCli
     end
 
     def do_create
-      body = { title: options[:'<title>'] }
-
-      body[:startTimeInSeconds] = if options[:start]
-                                    parse_time(options[:start])
-                                  else
-                                    Time.now.to_i
-                                  end
-
-      body[:endTimeInSeconds] = if options[:end]
-                                  parse_time(options[:end])
-                                else
-                                  body[:startTimeInSeconds] + 3600
-                                end
-
-      body[:reason] = options[:desc] if options[:desc]
+      body = build_body
 
-      [%i(CustomerTags atag), %i(HostTags htag),
-       %i(HostNames host)].each do |key, opt|
+      [%i[CustomerTags atag], %i[HostTags htag],
+       %i[HostNames host]].each do |key, opt|
         k = ('relevant' + key.to_s).to_sym
         body[k] = options[opt] unless options[opt].empty?
       end
@@ -43,10 +28,41 @@ module WavefrontCli
       wf.create(body)
     end
 
+    def build_body
+      ret = { title:              options[:'<title>'],
+              startTimeInSeconds: window_start,
+              endTimeInSeconds:   window_end }
+
+      ret[:reason] = options[:desc] if options[:desc]
+      ret
+    end
+
+    # @return [Integer] start time of window, in seconds. If not
+    #   given as an option, start it now
+    #
+    def window_start
+      if options[:start]
+        parse_time(options[:start])
+      else
+        Time.now.to_i
+      end
+    end
+
+    # @return [Integer] end time of window, in seconds. If not
+    #   given as an option, end it in an hour
+    #
+    def window_end
+      if options[:end]
+        parse_time(options[:end])
+      else
+        window_start + 3600
+      end
+    end
+
     def do_extend_by
       begin
         to_add = options[:'<time>'].to_seconds
-      rescue
+      rescue ArgumentError
         abort "Could not parse time range '#{options[:'<time>']}'."
       end
 
@@ -63,7 +79,7 @@ module WavefrontCli
     end
 
     def change_end_time(ts)
-      wf.update(options[:'<id>'], { endTimeInSeconds: ts })
+      wf.update(options[:'<id>'], endTimeInSeconds: ts)
     end
   end
 end

data/lib/wavefront-cli/opt_handler.rb

@@ -64,7 +64,7 @@ module WavefrontCli
     #
     def load_profile(cred_opts)
       creds = Wavefront::Credentials.new(cred_opts).config
-      Hash[creds.map{ |k, v| [k.to_sym, v] }]
+      Hash[creds.map { |k, v| [k.to_sym, v] }]
     end
   end
 end