wavefront-cli 4.2.1 → 4.3.0

data/lib/wavefront-cli/exception.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WavefrontCli
   #
   # CLI-specific exceptions. These should generally be caught in the
@@ -11,6 +13,7 @@ module WavefrontCli
     class ImpossibleSearch < RuntimeError; end
     class InsufficientData < RuntimeError; end
     class InvalidInput < RuntimeError; end
+    class InvalidQuery < RuntimeError; end
     class InvalidValue < RuntimeError; end
     class ProfileExists < RuntimeError; end
     class ProfileNotFound < RuntimeError; end

data/lib/wavefront-cli/externallink.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 module WavefrontCli
@@ -14,12 +16,12 @@ module WavefrontCli
     end
 
     def do_create
-      body = { name:              options[:'<name>'],
-               template:          options[:'<template>'],
-               description:       options[:'<description>'],
+      body = { name: options[:'<name>'],
+               template: options[:'<template>'],
+               description: options[:'<description>'],
                metricFilterRegex: options[:metricregex],
                sourceFilterRegex: options[:sourceregex],
-               pointFilterRegex:  point_filter_regexes }
+               pointFilterRegex: point_filter_regexes }
 
       wf.create(body.select { |_k, v| v })
     end

data/lib/wavefront-cli/integration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 module WavefrontCli

data/lib/wavefront-cli/maintenancewindow.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'wavefront-sdk/support/mixins'
 require_relative 'base'
 
@@ -29,9 +31,9 @@ module WavefrontCli
     end
 
     def build_body
-      ret = { title:              options[:'<title>'],
+      ret = { title: options[:'<title>'],
               startTimeInSeconds: window_start,
-              endTimeInSeconds:   window_end }
+              endTimeInSeconds: window_end }
 
       ret[:reason] = options[:desc] if options[:desc]
       ret
@@ -60,21 +62,25 @@ module WavefrontCli
     end
 
     def do_extend_by
-      begin
-        to_add = options[:'<time>'].to_seconds
-      rescue ArgumentError
-        abort "Could not parse time range '#{options[:'<time>']}'."
-      end
-
+      cannot_noop!
+      to_add = parse_range_to_add
       old_end = wf.describe(options[:'<id>']).response.endTimeInSeconds
       change_end_time(old_end + to_add)
     end
 
+    def parse_range_to_add
+      options[:'<time>'].to_seconds
+    rescue ArgumentError
+      abort "Could not parse time range '#{options[:'<time>']}'."
+    end
+
     def do_extend_to
+      cannot_noop!
       change_end_time(parse_time(options[:'<time>']))
     end
 
     def do_close
+      cannot_noop!
       change_end_time(Time.now.to_i)
     end
 
@@ -83,22 +89,27 @@ module WavefrontCli
     end
 
     def do_ongoing
-      w = wf.ongoing
-      ok_exit('No maintenance windows currently ongoing.') if w.empty?
-      w
+      ret = wf.ongoing
+
+      exit if options[:noop]
+
+      return ret unless ret.is_a?(Wavefront::Response) && ret.empty?
+
+      ok_exit('No maintenance windows currently ongoing.')
     end
 
     def do_pending
       range = options[:'<hours>'].to_f
       range = 24 unless range.positive?
 
-      w = wf.pending(range)
+      ret = wf.pending(range)
 
-      if w.empty?
-        ok_exit(format('No maintenance windows in the next %s hours.',
-                       range))
-      end
-      w
+      exit if options[:noop]
+
+      return ret unless ret.is_a?(Wavefront::Response) && ret.empty?
+
+      ok_exit(format('No maintenance windows in the next %<range>s hours.',
+                     range: range))
     end
   end
 end

data/lib/wavefront-cli/message.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 module WavefrontCli
@@ -16,6 +18,8 @@ module WavefrontCli
     end
 
     def do_read
+      cannot_noop!
+
       resp = wf.list(0, :all, false).response.items.select do |msg|
         msg[:id] == options[:'<id>']
       end

data/lib/wavefront-cli/metric.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 module WavefrontCli
@@ -14,10 +16,11 @@ module WavefrontCli
 
     def extra_validation
       return unless options[:'<metric>']
+
       begin
         wf_metric_name?(options[:'<metric>'])
       rescue Wavefront::Exception::InvalidMetricName
-        abort "'#{options[:'<metric>']}' is not a valid metric."
+        abort "'#{options[:'<metric>']}' is not a valid metric ID."
       end
     end
   end

data/lib/wavefront-cli/notificant.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 module WavefrontCli

data/lib/wavefront-cli/opt_handler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pathname'
 require 'wavefront-sdk/credentials'
 require_relative 'constants.rb'

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WavefrontOutput
   #
   # WavefrontCli::Base looks for a class WavefrontOutput::Format
@@ -33,6 +35,7 @@ module WavefrontOutput
 
     def filtered_response(resp)
       return resp unless options[:itemsonly]
+
       items_only(resp)
     end
 
@@ -45,8 +48,8 @@ module WavefrontOutput
       end
 
       raise(WavefrontCli::Exception::UnsupportedOutput,
-            format("'%s' format does not support items-only output.",
-                   my_format))
+            format("'%<format>s' format does not support items-only output.",
+                   format: my_format))
     end
 
     def my_format
@@ -54,7 +57,9 @@ module WavefrontOutput
     end
 
     def command_class_name
-      format('Wavefront%sOutput::%s', my_format.capitalize, cmd.capitalize)
+      format('Wavefront%<format>sOutput::%<command>s',
+             format: my_format.capitalize,
+             command: cmd.capitalize)
     end
 
     def command_file

data/lib/wavefront-cli/output/csv.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 module WavefrontOutput

data/lib/wavefront-cli/output/csv/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WavefrontCsvOutput
   #
   # Standard output template

data/lib/wavefront-cli/output/csv/query.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'set'
 require_relative 'base'
 
@@ -21,8 +23,8 @@ module WavefrontCsvOutput
     def post_initialize
       @headers = []
       @formatopts = extract_formatopts
-      @data_map    = options[:raw] ? raw_output : query_output
-      @columns     = all_keys.freeze
+      @data_map = options[:raw] ? raw_output : query_output
+      @columns = all_keys.freeze
     end
 
     # @return [Array[Hash]] which goes in the @data_map
@@ -66,6 +68,7 @@ module WavefrontCsvOutput
     #
     def csv_headers
       return [] unless formatopts.include?('headers')
+
       [columns.map { |c| csv_value(c) }.join(',')]
     end
 
@@ -89,7 +92,7 @@ module WavefrontCsvOutput
     end
 
     def quote_value(value)
-      format('"%s"', value.to_s.gsub(/"/, '\"'))
+      format('"%<value>s"', value: value.to_s.gsub(/"/, '\"'))
     end
 
     # Turn a string of output options into an easy-to-query array
@@ -102,10 +105,10 @@ module WavefrontCsvOutput
     # Tags have their keys removed.
     #
     def csv_format(path, value, timestamp, source, tags = nil)
-      ret = { path:      path,
-              value:     value,
+      ret = { path: path,
+              value: value,
               timestamp: timestamp,
-              source:    source }
+              source: source }
 
       ret.tap { |r| tags.each { |k, v| r[k.to_sym] = tag_val(k, v) } }
     end
@@ -113,7 +116,11 @@ module WavefrontCsvOutput
     # We may be doing key=val or just val, depending on the formatter options
     #
     def tag_val(key, val)
-      formatopts.include?('tagkeys') ? format('%s=%s', key, val) : val
+      if formatopts.include?('tagkeys')
+        format('%<key>s=%<value>s', key: key, value: val)
+      else
+        val
+      end
     end
   end
 end

data/lib/wavefront-cli/output/hcl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 module WavefrontOutput

data/lib/wavefront-cli/output/hcl/alert.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 module WavefrontHclOutput

data/lib/wavefront-cli/output/hcl/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'securerandom'
 require 'json'
 
@@ -27,8 +29,9 @@ module WavefrontHclOutput
     end
 
     def open_output
-      format('resource "wavefront_%s" "%s" {', resource_name,
-             SecureRandom.uuid)
+      format('resource "wavefront_%<name>s" "%<uuid>s" {',
+             name: resource_name,
+             uuid: SecureRandom.uuid)
     end
 
     def close_output
@@ -48,6 +51,7 @@ module WavefrontHclOutput
     #
     def required_fields
       return resp if hcl_fields.empty?
+
       resp.select { |k, _v| hcl_fields.include?(k) }
     end
 
@@ -65,7 +69,9 @@ module WavefrontHclOutput
 
       quote_handler = :quote_value unless respond_to?(quote_handler)
 
-      format('  %s = %s', key.to_snake, send(quote_handler, val))
+      format('  %<key>s = %<value>s',
+             key: key.to_snake,
+             value: send(quote_handler, val))
     end
 
     # Tags need to be in an array. They aren't always called "tags"
@@ -86,7 +92,7 @@ module WavefrontHclOutput
     def quote_value(val)
       case val.class.to_s.to_sym
       when :String
-        format('"%s"', val.gsub(/\"/, '\"'))
+        format('"%<value>s"', value: val.gsub(/\"/, '\"'))
       else
         val
       end

data/lib/wavefront-cli/output/hcl/dashboard.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 require_relative 'stdlib/string'
 require_relative 'stdlib/array'
@@ -54,7 +56,9 @@ module WavefrontHclOutput
       fields = %w[units name description]
 
       lines = chart.each_with_object([]) do |(k, v), a|
-        a.<< format('%s = %s', k, quote_value(v)) if fields.include?(k)
+        next unless fields.include?(k)
+
+        a.<< format('%<key>s = %<value>s', key: k, value: quote_value(v))
       end
 
       lines.<< "source = #{handle_sources(chart[:sources])}"
@@ -66,17 +70,22 @@ module WavefrontHclOutput
     end
 
     def handle_source(source)
-      fields = %w[name query disabled scatterPlotSource querybuilderEnabled
-                  sourceDescription]
-
       source.each_with_object([]) do |(k, v), a|
-        if fields.include?(k)
-          k = 'queryBuilderEnabled' if k == 'querybuilderEnabled'
-          a.<< format('%s = %s', k.to_snake, quote_value(v))
-        end
+        next unless source_fields.include?(k)
+
+        k = 'queryBuilderEnabled' if k == 'querybuilderEnabled'
+
+        a.<< format('%<key>s = %<value>s',
+                    key: k.to_snake,
+                    value: quote_value(v))
       end.to_hcl_obj(14)
     end
 
+    def source_fields
+      %w[name query disabled scatterPlotSource querybuilderEnabled
+         sourceDescription]
+    end
+
     def qhandle_sections(val)
       val
     end

data/lib/wavefront-cli/output/hcl/notificant.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 module WavefrontHclOutput

data/lib/wavefront-cli/output/hcl/stdlib/array.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Extensions to stdlib Array
 #

data/lib/wavefront-cli/output/hcl/stdlib/string.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Extensions to stdlib String
 #

data/lib/wavefront-cli/output/json.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 module WavefrontOutput

data/lib/wavefront-cli/output/ruby.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 module WavefrontOutput

data/lib/wavefront-cli/output/wavefront.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 module WavefrontOutput

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'wavefront-sdk/stdlib/hash'
 require_relative '../csv/base'
 
@@ -30,19 +32,20 @@ module WavefrontWavefrontOutput
     def query_output
       check_query_response
 
-      resp[:timeseries].each_with_object('') do |ts, a|
+      resp[:timeseries].each_with_object([]) do |ts, a|
         ts[:data].each do |point|
           a.<< wavefront_format(ts[:label],
                                 point[1],
                                 point[0],
                                 ts[:host],
-                                ts[:tags]) + "\n"
+                                ts[:tags])
         end
-      end
+      end.join("\n")
     end
 
     def wavefront_format(path, value, timestamp, source, tags = nil)
-      arr = [path, value, timestamp, format('source=%s', source)]
+      arr = [path, value, timestamp, format('source=%<source>s',
+                                            source: source)]
       arr.<< tags.to_wf_tag if tags && !tags.empty?
       arr.join(' ')
     end