wavefront-cli 8.5.1 → 10.0.0

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

@@ -45,8 +45,8 @@ module WavefrontDisplay
         run_list
       elsif method == 'do_search'
         run_search
-      elsif respond_to?("#{method}_brief") && !options[:long]
-        send("#{method}_brief")
+      elsif respond_to?(:"#{method}_brief") && !options[:long]
+        send(:"#{method}_brief")
       elsif respond_to?(method)
         send(method)
       else

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module WavefrontDisplay
+  #
+  # Format human-readable output for config commands.
+  #
+  class Cluster < Base
+    def do_location
+      puts data
+    end
+    alias do_profiles do_location
+    alias do_show do_location
+    alias do_envvars do_location
+
+    def do_about
+      long_output
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module WavefrontDisplay
+  #
+  # Format human-readable output of the metrics policy.
+  #
+  class MetricsPolicy < Base
+    def do_history
+      readable_time_arr(:updateTime)
+      long_output
+    end
+  end
+end

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

@@ -77,17 +77,15 @@ module WavefrontDisplayPrinter
     #
     # Make an array of hashes: { key, value, depth }
     #
-    # rubocop:disable Style/CaseLikeIf
     def make_list(data, aggr = [], depth = 0, last_key = nil)
       if data.is_a?(Hash)
         append_hash(data, aggr, depth)
       elsif data.is_a?(Array)
         append_array(data, aggr, depth, last_key)
       else
-        aggr.<< ['', preened_value(data), depth]
+        aggr << ['', preened_value(data), depth]
       end
     end
-    # rubocop:enable Style/CaseLikeIf
 
     def smart_value(val)
       val.to_s.empty? && opts[:none] ? '<none>' : preened_value(val)
@@ -99,16 +97,14 @@ module WavefrontDisplayPrinter
     # @return [Integer]
     #
     def longest_key_col(data)
-      data.map { |d| d[0].size + opts[:padding] + opts[:indent] * d[2] }.max
+      data.map { |d| d[0].size + opts[:padding] + (opts[:indent] * d[2]) }.max
     end
 
     # Turn the list made by #make_list into user output
     # @return [String]
     #
     def to_s
-      list.map do |item|
-        stringify_line(item)
-      end.join("\n")
+      list.map { |item| stringify_line(item) }.join("\n")
     end
 
     # @param item [Array] of the form [key, value, indent_level]
@@ -154,7 +150,6 @@ module WavefrontDisplayPrinter
     # @param depth [Integer]
     # @return [Array[Array]]
     #
-    # rubocop:disable Style/CaseLikeIf
     def append_hash(data, aggr, depth)
       data.each_pair do |k, v|
         if v.is_a?(Hash)
@@ -162,13 +157,12 @@ module WavefrontDisplayPrinter
         elsif v.is_a?(Array)
           aggr = append_array_values(k, v, aggr, depth)
         else
-          aggr.<< [k, smart_value(v), depth]
+          aggr << [k, smart_value(v), depth]
         end
       end
 
       aggr
     end
-    # rubocop:enable Style/CaseLikeIf
 
     # Part of the #make_list recursion. Deals with arrays.
     #
@@ -183,7 +177,7 @@ module WavefrontDisplayPrinter
 
         if opts[:separator] && element.is_a?(Hash) && i < data.size &&
            depth < opts[:sep_depth]
-          aggr.<< ['', :separator, depth]
+          aggr << ['', :separator, depth]
         end
       end
 
@@ -202,9 +196,9 @@ module WavefrontDisplayPrinter
     #
     def append_hash_values(key, values, aggr, depth)
       if values.empty? && opts[:none]
-        aggr.<< [key, '<none>', depth]
+        aggr << [key, '<none>', depth]
       else
-        aggr.<< [key, nil, depth]
+        aggr << [key, nil, depth]
         make_list(values, aggr, depth + 1)
       end
     end
@@ -218,13 +212,13 @@ module WavefrontDisplayPrinter
     #
     def append_array_values(key, values, aggr, depth)
       if values.empty? && opts[:none]
-        aggr.<< [key, '<none>', depth]
-      elsif values.all? { |w| w.is_a?(String) }
+        aggr << [key, '<none>', depth]
+      elsif values.all?(String)
         values.sort!
-        aggr.<< [key, preened_value(values.shift), depth]
+        aggr << [key, preened_value(values.shift), depth]
         make_list(values, aggr, depth, key)
       else
-        aggr.<< [key, nil, depth]
+        aggr << [key, nil, depth]
         make_list(values, aggr, depth + 1, key)
       end
     end

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

@@ -16,7 +16,7 @@ class WavefrontSparkline
   attr_reader :sparkline
 
   def initialize(series)
-    @sparkline = '>' + generate_sparkline(series) + '<'
+    @sparkline = ">#{generate_sparkline(series)}<"
   end
 
   # @return [String] the block corresponding to the given value in
@@ -38,8 +38,8 @@ class WavefrontSparkline
   def make_fit(vals)
     return vals if vals.size < SPARK_WIDTH
 
-    vals.<< vals.last if vals.size.odd?
-    ret = vals.each_slice(2).with_object([]) { |s, a| a.<< s.sum / 2 }
+    vals << vals.last if vals.size.odd?
+    ret = vals.each_slice(2).with_object([]) { |s, a| a << (s.sum / 2) }
     make_fit(ret)
   end
 

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

@@ -86,7 +86,7 @@ module WavefrontDisplay
       if data.empty?
         puts 'No aliases defined.'
       else
-        data.each_key { |k| puts k.to_s[2..-1] }
+        data.each_key { |k| puts k.to_s[2..] }
       end
     end
 

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

@@ -13,7 +13,8 @@ module WavefrontDisplay
     def do_point
       @not_sent = data['rejected'] + data['unsent']
       report unless nothing_to_say?
-      exit not_sent.zero? ? 0 : 1
+
+      raise unless not_sent.zero?
     end
 
     def nothing_to_say?

data/lib/wavefront-cli/event.rb

@@ -38,7 +38,7 @@ module WavefrontCli
     def do_show
       events = state.list
 
-      if events.size.zero?
+      if events.empty?
         puts 'No open events.'
       else
         events.sort.reverse_each { |e| puts e.basename }
@@ -94,7 +94,7 @@ module WavefrontCli
     end
 
     def window_start
-      parse_time((options[:start] || Time.now - 600), true)
+      parse_time((options[:start] || (Time.now - 600)), true)
     end
 
     def window_end

data/lib/wavefront-cli/exception_handler.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'faraday'
+
 module WavefrontCli
   #
   # Handle fatal errors.
@@ -19,7 +21,8 @@ module WavefrontCli
         abort "\nOperation aborted at user request."
       when WavefrontCli::Exception::ConfigFileNotFound
         abort "Configuration file #{exception}' not found."
-      when WavefrontCli::Exception::CredentialError
+      when WavefrontCli::Exception::CredentialError,
+           Wavefront::Exception::CredentialError
         handle_missing_credentials(exception)
       when WavefrontCli::Exception::MandatoryValue
         abort 'A value must be supplied.'
@@ -41,6 +44,8 @@ module WavefrontCli
         abort "'#{exception}' is not a valid API token ID."
       when Wavefront::Exception::InvalidIngestionPolicyId
         abort "'#{exception}' is not a valid ingestion policy ID."
+      when Wavefront::Exception::InvalidVersion
+        abort "'#{exception}' is not a valid version."
       when WavefrontCli::Exception::InvalidValue
         abort "Invalid value for #{exception}."
       when WavefrontCli::Exception::ProfileExists
@@ -77,6 +82,8 @@ module WavefrontCli
         abort 'Search on non-existent key. Please use a top-level field.'
       when Wavefront::Exception::InvalidSamplingValue
         abort 'Sampling rates must be between 0 and 0.05.'
+      when Faraday::ConnectionFailed
+        abort 'Error connecting to remote host.'
       else
         warn "general error: #{exception}"
         backtrace_message(exception)

data/lib/wavefront-cli/helpers/load_file.rb

@@ -40,11 +40,11 @@ module WavefrontCli
       private
 
       def load_json(file)
-        read_json(IO.read(file))
+        read_json(File.read(file))
       end
 
       def load_yaml(file)
-        read_yaml(IO.read(file))
+        read_yaml(File.read(file))
       end
 
       # Read STDIN and return a Ruby object, assuming that STDIN is

data/lib/wavefront-cli/maintenancewindow.rb

@@ -27,7 +27,7 @@ module WavefrontCli
 
       [%i[CustomerTags atag], %i[HostTags htag],
        %i[HostNames host]].each do |key, opt|
-        k = ('relevant' + key.to_s).to_sym
+        k = :"relevant#{key}"
         body[k] = options[opt] unless options[opt].empty?
       end
 

data/lib/wavefront-cli/metricspolicy.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'wavefront-sdk/support/mixins'
+require_relative 'base'
+require_relative 'helpers/load_file'
+
+module WavefrontCli
+  #
+  # CLI coverage for the metricspolicy part of the v2 'usage' API.
+  #
+  class MetricsPolicy < WavefrontCli::Base
+    def do_describe
+      wf.describe(options[:version])
+    end
+
+    def do_history
+      wf.history(options[:offset] || 0, options[:limit] || 100)
+    end
+
+    def do_revert
+      wf.revert(options[:'<version>'])
+    end
+
+    def do_update
+      raw = WavefrontCli::Helper::LoadFile.new(options[:'<file>']).load
+      rules = process_update(raw)
+      wf.update(policyRules: rules)
+    end
+
+    # It looks like the API expects arrays of ID strings for accounts, groups,
+    # and roles, but when you export one, those fields are objects with name
+    # and ID.
+    #
+    def process_update(raw)
+      raw[:policyRules].tap do |rule|
+        rule[:accounts] = rule[:accounts].map { |r| r[:id] }
+        rule[:userGroups] = rule[:userGroups].map { |r| r[:id] }
+        rule[:roles] = rule[:roles].map { |r| r[:id] }
+      end
+    end
+  end
+end

data/lib/wavefront-cli/opt_handler.rb

@@ -43,11 +43,10 @@ module WavefrontCli
     # constructor.
     # @param cli_opts [Hash] options from docopt, which may include
     #   the location of the config file and the stanza within it
-    # @return [Hash] keys are none, one, or both of :file and
-    #   :profile
+    # @return [Hash] keys are none, one, or both of :file and :profile
     #
     def setup_cred_opts(cli_opts)
-      cred_opts = { raise_on_no_profile: true }
+      cred_opts = cli_opts[:config] ? { raise_on_no_profile: true } : {}
 
       if cli_opts[:config]
         cred_opts[:file] = Pathname.new(cli_opts[:config])

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

@@ -32,7 +32,7 @@ module WavefrontCsvOutput
     def raw_output
       resp.each_with_object([]) do |point, a|
         point[:points].each do |p|
-          a.<< csv_format(options[:'<metric>'],
+          a << csv_format(options[:'<metric>'],
                           p[:value],
                           p[:timestamp],
                           options[:host],
@@ -48,7 +48,7 @@ module WavefrontCsvOutput
 
       resp[:timeseries].each_with_object([]) do |ts, a|
         ts[:data].each do |point|
-          a.<< csv_format(ts[:label],
+          a << csv_format(ts[:label],
                           point[1],
                           point[0],
                           ts[:host],
@@ -92,7 +92,7 @@ module WavefrontCsvOutput
     end
 
     def quote_value(value)
-      format('"%<value>s"', value: 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

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

@@ -61,9 +61,9 @@ module WavefrontHclOutput
     # @return [String]
     #
     def handler(key, val)
-      key_handler = "khandle_#{key}".to_sym
-      value_handler = "vhandle_#{key}".to_sym
-      quote_handler = "qhandle_#{key}".to_sym
+      key_handler = :"khandle_#{key}"
+      value_handler = :"vhandle_#{key}"
+      quote_handler = :"qhandle_#{key}"
       key = send(key_handler) if respond_to?(key_handler)
       val = send(value_handler, val) if respond_to?(value_handler)
 
@@ -92,7 +92,7 @@ module WavefrontHclOutput
     def quote_value(val)
       case val.class.to_s.to_sym
       when :String
-        format('"%<value>s"', value: val.gsub(/"/, '\"'))
+        format('"%<value>s"', value: val.gsub('"', '\"'))
       else
         val
       end

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

@@ -32,19 +32,19 @@ module WavefrontHclOutput
     # @return [String] HCL list of vals
     #
     def listmaker(vals, method)
-      vals.each_with_object([]) { |v, a| a.<< send(method, v) }.to_hcl_list
+      vals.each_with_object([]) { |v, a| a << send(method, v) }.to_hcl_list
     end
 
     def vhandle_sections(vals)
       vals.each_with_object([]) do |section, a|
-        a.<< ("name = \"#{section[:name]}\"\n      row = " +
+        a << ("name = \"#{section[:name]}\"\n      row = " +
               handle_rows(section[:rows])).braced(4)
       end.to_hcl_list
     end
 
     def handle_rows(rows)
       rows.each_with_object([]) do |row, a|
-        a.<< ('chart = ' + handle_charts(row[:charts]).to_s).braced(8)
+        a << "chart = #{handle_charts(row[:charts])}".braced(8)
       end.to_hcl_list
     end
 
@@ -58,10 +58,10 @@ module WavefrontHclOutput
       lines = chart.each_with_object([]) do |(k, v), a|
         next unless fields.include?(k)
 
-        a.<< format('%<key>s = %<value>s', key: k, value: quote_value(v))
+        a << format('%<key>s = %<value>s', key: k, value: quote_value(v))
       end
 
-      lines.<< "source = #{handle_sources(chart[:sources])}"
+      lines << "source = #{handle_sources(chart[:sources])}"
       lines.to_hcl_obj(10)
     end
 
@@ -75,7 +75,7 @@ module WavefrontHclOutput
 
         k = 'queryBuilderEnabled' if k == 'querybuilderEnabled'
 
-        a.<< format('%<key>s = %<value>s',
+        a << format('%<key>s = %<value>s',
                     key: k.to_snake,
                     value: quote_value(v))
       end.to_hcl_obj(14)
@@ -91,7 +91,7 @@ module WavefrontHclOutput
     end
 
     def quote_value(val)
-      val.gsub!(/\$/, '$$') if val.is_a?(String)
+      val.gsub!('$', '$$') if val.is_a?(String)
       super
     end
   end

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

@@ -9,7 +9,7 @@ class Array
   # @return [String]
   #
   def to_hcl_list
-    '[' + join(',') + ']'
+    "[#{join(',')}]"
   end
 
   # Turn an array into a string which represents an HCL object

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

@@ -20,11 +20,11 @@ module WavefrontWavefrontOutput
     def raw_output
       resp.each_with_object('') do |point, a|
         point[:points].each do |p|
-          a.<< wavefront_format(options[:'<metric>'],
-                                p[:value],
-                                p[:timestamp],
-                                options[:host],
-                                point[:tags]) + "\n"
+          a << "#{wavefront_format(options[:'<metric>'],
+                                   p[:value],
+                                   p[:timestamp],
+                                   options[:host],
+                                   point[:tags])}\n"
         end
       end
     end
@@ -34,7 +34,7 @@ module WavefrontWavefrontOutput
 
       resp[:timeseries].each_with_object([]) do |ts, a|
         ts[:data].each do |point|
-          a.<< wavefront_format(ts[:label],
+          a << wavefront_format(ts[:label],
                                 point[1],
                                 point[0],
                                 ts[:host],
@@ -46,7 +46,7 @@ module WavefrontWavefrontOutput
     def wavefront_format(path, value, timestamp, source, tags = nil)
       arr = [path, value, timestamp, format('source=%<source>s',
                                             source: source)]
-      arr.<< tags.to_wf_tag if tags && !tags.empty?
+      arr << tags.to_wf_tag if tags && !tags.empty?
       arr.join(' ')
     end
   end

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

@@ -9,7 +9,7 @@ class Array
   def max_length
     return 0 if empty?
 
-    map(&:to_s).map(&:length).max
+    map { |x| x.to_s.length }.max
   end
 
   # @return [Integer] the length of the longest value in an array of

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

@@ -10,7 +10,7 @@ class String
   # @param indent [Integer] size of hanging indent, in chars
   #
   def cmd_fold(twidth = TW, indent = 10)
-    gsub(/(-\w) /, '\\1^').scan_line(twidth - 12).join("\n" + ' ' * indent)
+    gsub(/(-\w) /, '\\1^').scan_line(twidth - 12).join("\n#{' ' * indent}")
                           .restored
   end
 
@@ -35,7 +35,7 @@ class String
   # @return [String] the folded line
   #
   def fold(twidth = TW, indent = 10, prefix = '')
-    chunks = gsub(/default: /, 'default:^').scan_line(twidth - 8)
+    chunks = gsub('default: ', 'default:^').scan_line(twidth - 8)
     first_line = format("%<padding>s%<text>s\n",
                         padding: prefix,
                         text: chunks.shift)
@@ -58,7 +58,7 @@ class String
   #
   def value_fold(indent = 0, twidth = TW)
     max_line_length = twidth - indent - 4
-    scan_line(max_line_length).join("\n" + ' ' * indent)
+    scan_line(max_line_length).join("\n#{' ' * indent}")
   end
 
   # @param width [Integer] length of longest string (width of
@@ -94,7 +94,7 @@ class String
   #
   def to_snake
     gsub(/(.)([A-Z])/) do
-      Regexp.last_match[1] + '_' + Regexp.last_match[2].downcase
+      "#{Regexp.last_match[1]}_#{Regexp.last_match[2].downcase}"
     end
   end
 
@@ -102,7 +102,7 @@ class String
 
   def indent_folded_lines(chunks, twidth, indent, prefix)
     chunks.join(' ').scan_line(twidth - indent - 5).map do |line|
-      prefix + ' ' * indent + line
+      "#{prefix}#{' ' * indent}#{line}"
     end
   end
 end

data/lib/wavefront-cli/usage.rb

@@ -18,7 +18,7 @@ module WavefrontCli
     end
 
     def default_start
-      parse_time(Time.now - 60 * 60 * 24)
+      parse_time(Time.now - 86_400)
     end
   end
 end

data/lib/wavefront-cli/version.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-WF_CLI_VERSION = '8.5.1'
+WF_CLI_VERSION = '10.0.0'

data/lib/wavefront-cli/write.rb

@@ -11,7 +11,7 @@ module WavefrontCli
     attr_reader :fmt
 
     include Wavefront::Mixins
-    SPLIT_PATTERN = /\s(?=(?:[^"]|"[^"]*")*$)/.freeze
+    SPLIT_PATTERN = /\s(?=(?:[^"]|"[^"]*")*$)/
 
     # rubocop:disable Metrics/AbcSize
     def do_point(value = options[:'<value>'])
@@ -74,8 +74,8 @@ module WavefrontCli
     end
     # rubocop:enable Metrics/AbcSize
 
-    # Turn our user's representation of a distribution into one
-    # which suits Wavefront. The SDK can do this for us.
+    # Turn our user's representation of a distribution into one which suits
+    # Wavefront. The SDK can do this for us.
     #
     def mk_dist
       xpanded = expand_dist(options[:'<val>'])
@@ -83,7 +83,11 @@ module WavefrontCli
     end
 
     def extra_options
-      options[:using] ? { writer: options[:using] } : {}
+      if options[:using]
+        { writer: options[:using] }
+      else
+        { writer: :http }
+      end
     end
 
     # I chose to prioritise UI consistency over internal elegance
@@ -108,6 +112,7 @@ module WavefrontCli
         port: options[:port] || default_port,
         socket: options[:socket],
         endpoint: options[:endpoint],
+        agent: "wavefront-cli-#{WF_CLI_VERSION}",
         token: options[:token] }
     end
 
@@ -115,18 +120,9 @@ module WavefrontCli
       distribution? ? 40_000 : 2878
     end
 
+    # The SDK writer plugins validate the credentials they need
     def validate_opts
       validate_opts_file if options[:file]
-
-      if options[:using] == 'unix'
-        return true if options[:socket]
-
-        raise(WavefrontCli::Exception::CredentialError, 'No socket path.')
-      end
-
-      return true if options[:proxy]
-
-      raise(WavefrontCli::Exception::CredentialError, 'No proxy address.')
     end
 
     def validate_opts_file
@@ -167,7 +163,7 @@ module WavefrontCli
     #
     def process_input_file(data)
       data.each_with_object([]) do |l, a|
-        a.<< process_line(l)
+        a << process_line(l)
       rescue WavefrontCli::Exception::UnparseableInput => e
         puts "Bad input. #{e.message}."
         next
@@ -239,7 +235,7 @@ module WavefrontCli
     #
     def extract_ts(chunks)
       ts = chunks[fmt.index('t')]
-      return parse_time(ts) if valid_timestamp?(ts)
+      parse_time(ts) if valid_timestamp?(ts)
     rescue TypeError
       Time.now.utc.to_i
     end
@@ -426,17 +422,17 @@ module WavefrontCli
     #
     def valid_timestamp?(timestamp)
       (timestamp.is_a?(Integer) ||
-        timestamp.is_a?(String) && timestamp.match(/^\d+$/)) &&
+        (timestamp.is_a?(String) && timestamp.match(/^\d+$/))) &&
         timestamp.to_i > 946_684_800 &&
         timestamp.to_i < (Time.now.to_i + 31_557_600)
     end
 
     def setup_fmt(fmt)
-      @fmt = fmt.split('')
+      @fmt = fmt.chars
     end
 
     def load_data(file)
-      IO.read(file)
+      File.read(file)
     rescue StandardError
       raise WavefrontCli::Exception::FileNotFound
     end

data/spec/constants.rb

@@ -12,10 +12,9 @@ TW = 80
 
 ENDPOINT = 'metrics.wavefront.com'
 TOKEN = '0123456789-ABCDEF'
-RES_DIR = ROOT + 'spec' + 'wavefront-cli' + 'resources'
-CF = RES_DIR + 'wavefront.conf'
-CF_VAL =  IniFile.load(CF)
-JSON_POST_HEADERS = {
-  'Content-Type': 'application/json', Accept: 'application/json'
-}.freeze
+RES_DIR = ROOT.join('spec', 'wavefront-cli', 'resources')
+CF = RES_DIR.join('wavefront.conf')
+CF_VAL = IniFile.load(CF)
+JSON_POST_HEADERS = { 'Content-Type': 'application/json',
+                      Accept: 'application/json' }.freeze
 TEE_ZERO = Time.now.freeze