wavefront-cli 8.5.1 → 9.0.0

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}".to_sym
         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],

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)

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/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
 
@@ -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 = '9.0.0'

data/lib/wavefront-cli/write.rb

@@ -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
@@ -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'
+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
+JSON_POST_HEADERS = { 'Content-Type': 'application/json',
+                      Accept: 'application/json' }.freeze
 TEE_ZERO = Time.now.freeze

data/spec/support/command_base.rb

@@ -9,11 +9,13 @@ require_relative '../../lib/wavefront-cli/controller'
 # commands.
 #
 class EndToEndTest < MiniTest::Test
+  attr_accessor :single_perm
   attr_reader :wf
 
   def setup
     before_setup if respond_to?(:before_setup)
     @wf = WavefrontCliController
+    @single_perm = false
   end
 
   def api_path
@@ -79,4 +81,14 @@ class EndToEndTest < MiniTest::Test
     { status: { result: 'OK', message: '', code: 200 },
       items: [] }.to_json
   end
+
+  def blank_envvars
+    %w[WAVEFRONT_ENDPOINT WAVEFRONT_PROXY WAVEFRONT_TOKEN].each do |v|
+      ENV[v] = nil
+    end
+  end
+
+  def config?
+    Pathname.new(Dir.home).join('.wavefront').exist?
+  end
 end

data/spec/support/minitest_assertions.rb

@@ -147,10 +147,13 @@ module Minitest
     end
 
     def assert_cmd_posts(command, api_path, payload = 'null',
-                         response = dummy_response)
+                         response = nil, extra_headers = {})
+      response ||= dummy_response
       all_permutations do |p|
         assert_posts("https://#{p[:endpoint]}#{api_path}",
-                     mk_headers(p[:token]), payload, response) do
+                     mk_headers(p[:token], extra_headers),
+                     payload,
+                     response) do
           wf.new("#{cmd_word} #{command} #{p[:cmdline]}".split)
         end
       end
@@ -166,7 +169,7 @@ module Minitest
     end
 
     def assert_cmd_deletes(command, api_path, response = dummy_response)
-      permutations.each do |p|
+      all_permutations do |p|
         assert_deletes("https://#{p[:endpoint]}#{api_path}",
                        mk_headers(p[:token]), response) do
           wf.new("#{cmd_word} #{command} #{p[:cmdline]}".split)
@@ -188,13 +191,14 @@ module Minitest
       assert_empty(err)
     end
 
-    # Run tests with all available permutations. We'll always need
-    # to mock out display, unless we don't, when even if we do, it
-    # won't matter.
+    # Run tests with all available permutations, unless the single_perm class
+    # variable is set. This lets us run tests faster by running fewer (but
+    # still a good random selection) and lets us run tests which must only be
+    # run once, like tests which pop stuff off the event stack.
     #
     def all_permutations
       perms = permutations
-      perms = [perms[2]]
+      perms = perms.shuffle.take(1) if @single_perm || ENV['FAST_TESTS']
 
       perms.each do |p|
         yield(p)
@@ -213,11 +217,11 @@ module Minitest
 
     private
 
-    def mk_headers(token = nil)
+    def mk_headers(token = nil, extra_headers = {})
       { Accept: /.*/,
         'Accept-Encoding': /.*/,
-        Authorization: 'Bearer ' + (token || '0123456789-ABCDEF'),
-        'User-Agent': "wavefront-cli-#{WF_CLI_VERSION}" }
+        Authorization: "Bearer #{token || '0123456789-ABCDEF'}",
+        'User-Agent': "wavefront-cli-#{WF_CLI_VERSION}" }.merge(extra_headers)
     end
 
     # Every command we simulate running is done under the following

data/spec/support/output_tester.rb

@@ -14,7 +14,7 @@ class OutputTester
   # @return [Object] canned raw responses used to test outputs
   #
   def load_input(file, only_items = true)
-    ret = JSON.parse(IO.read(RES_DIR + 'display' + file),
+    ret = JSON.parse(File.read(RES_DIR.join('display', file)),
                      symbolize_names: true)
     only_items ? ret[:items] : ret
   end
@@ -23,7 +23,7 @@ class OutputTester
   # @return [String]
   #
   def load_expected(file)
-    IO.read(RES_DIR + 'display' + file)
+    File.read(RES_DIR.join('display', file))
   end
 
   def in_and_out(input, expected, only_items = true)

data/spec/support/supported_commands.rb

@@ -2,11 +2,13 @@
 
 require_relative '../constants'
 
+# Produces a list of wf's commands
+#
 class SupportedCommands
   attr_reader :cmd_dir
 
   def initialize
-    @cmd_dir = ROOT + 'lib' + 'wavefront-cli' + 'commands'
+    @cmd_dir = ROOT.join('lib', 'wavefront-cli', 'commands')
   end
 
   def all

data/spec/test_mixins/import.rb

@@ -61,11 +61,11 @@ module WavefrontCliTest
     private
 
     def import_file
-      RES_DIR + 'imports' + "#{api_path}.json"
+      RES_DIR.join('imports', "#{api_path}.json")
     end
 
     def update_file
-      RES_DIR + 'updates' + "#{api_path}.json"
+      RES_DIR.join('updates', "#{api_path}.json")
     end
   end
 end

data/spec/test_mixins/search.rb

@@ -18,17 +18,19 @@ module WavefrontCliTest
                          sort: { field: 'id', ascending: true })
       end
 
+      json_body = { limit: 10,
+                    offset: 0,
+                    query: [{ key: 'id',
+                              value: id,
+                              matchingMethod: 'EXACT',
+                              negated: false }],
+                    sort: { field: 'id', ascending: true } }.to_json
+
       assert_noop(
         "search id=#{id}",
         'uri: POST https://default.wavefront.com/api/v2/search/' \
         "#{search_api_path}",
-        'body: ' + { limit: 10,
-                     offset: 0,
-                     query: [{ key: 'id',
-                               value: id,
-                               matchingMethod: 'EXACT',
-                               negated: false }],
-                     sort: { field: 'id', ascending: true } }.to_json
+        "body: #{json_body}"
       )
       assert_abort_on_missing_creds("search id=#{id}")
       assert_usage('search')

data/spec/test_mixins/set.rb

@@ -23,7 +23,7 @@ module WavefrontCliTest
 
     def run_command(perm)
       wf.new("#{cmd_word} set #{set_key}=new_value #{id} " \
-            "#{perm[:cmdline]}".split)
+             "#{perm[:cmdline]}".split)
     rescue SystemExit => e
       p e
     end

data/spec/wavefront-cli/account_spec.rb

@@ -228,10 +228,12 @@ class AccountEndToEndTest < EndToEndTest
     cmd = "validate #{user_list.join(' ')}"
 
     quietly do
-      assert_cmd_posts(cmd,
-                       '/api/v2/account/validateAccounts',
-                       user_list.to_json,
-                       IO.read(RES_DIR + 'responses' + 'user-validate.json'))
+      assert_cmd_posts(
+        cmd,
+        '/api/v2/account/validateAccounts',
+        user_list.to_json,
+        File.read(RES_DIR.join('responses', 'user-validate.json'))
+      )
     end
 
     assert_noop(cmd,

data/spec/wavefront-cli/alert_spec.rb

@@ -21,6 +21,25 @@ class AlertEndToEndTest < EndToEndTest
   include WavefrontCliTest::History
   include WavefrontCliTest::Acl
 
+  # This test isn't run if whoever runs it has a config file, because it tests
+  # wf's behaviour only if that file does not exist. CI will never have that
+  # file.
+  #
+  def test_no_config_no_envvars
+    skip if config?
+
+    blank_envvars
+    wf = WavefrontCliController
+
+    out, err = capture_io do
+      assert_raises(SystemExit) { wf.new(%w[alert list]) }
+    end
+
+    assert_empty(err)
+    assert out.start_with?('Credential error. Missing api token.')
+    assert_match(/You may also run 'wf config setup'/, out)
+  end
+
   def test_latest
     quietly do
       assert_cmd_gets("latest #{id}", "/api/v2/alert/#{id}/history")
@@ -48,10 +67,12 @@ class AlertEndToEndTest < EndToEndTest
                        id: id, v: nil, name: nil)
     end
 
+    json_body = { id: id, name: nil, v: nil }.to_json
+
     assert_noop("clone #{id}",
                 'uri: POST https://default.wavefront.com/api/v2/' \
                 "alert/#{id}/clone",
-                'body: ' + { id: id, name: nil, v: nil }.to_json)
+                "body: #{json_body}")
 
     assert_invalid_id("clone #{invalid_id}")
     assert_usage('clone')
@@ -65,10 +86,12 @@ class AlertEndToEndTest < EndToEndTest
                        id: id, v: 5, name: nil)
     end
 
+    json_body = { id: id, name: nil, v: 5 }.to_json
+
     assert_noop("clone #{id} --version 5",
                 'uri: POST https://default.wavefront.com/api/v2/' \
                 "alert/#{id}/clone",
-                'body: ' + { id: id, name: nil, v: 5 }.to_json)
+                "body: #{json_body}")
 
     assert_invalid_id("clone -v 10 #{invalid_id}")
     assert_usage('clone -v')
@@ -173,7 +196,7 @@ class AlertEndToEndTest < EndToEndTest
     assert_noop('snoozed',
                 'uri: POST https://default.wavefront.com/api/v2/' \
                 'search/alert',
-                'body: ' + state_search('snoozed').to_json)
+                "body: #{state_search('snoozed').to_json}")
 
     assert_abort_on_missing_creds('snoozed')
   end
@@ -193,7 +216,7 @@ class AlertEndToEndTest < EndToEndTest
     assert_noop('firing',
                 'uri: POST https://default.wavefront.com/api/v2/' \
                 'search/alert',
-                'body: ' + state_search('firing').to_json)
+                "body: #{state_search('firing').to_json}")
 
     assert_abort_on_missing_creds('firing')
   end
@@ -213,7 +236,7 @@ class AlertEndToEndTest < EndToEndTest
     assert_noop('currently firing',
                 'uri: POST https://default.wavefront.com/api/v2/' \
                 'search/alert',
-                'body: ' + state_search('firing').to_json)
+                "body: #{state_search('firing').to_json}")
 
     assert_abort_on_missing_creds('currently firing')
   end
@@ -233,7 +256,7 @@ class AlertEndToEndTest < EndToEndTest
     assert_noop('currently in_maintenance',
                 'uri: POST https://default.wavefront.com/api/v2/' \
                 'search/alert',
-                'body: ' + state_search('in_maintenance').to_json)
+                "body: #{state_search('in_maintenance').to_json}")
 
     assert_abort_on_missing_creds('currently in_maintenance')
   end

data/spec/wavefront-cli/commands/base_spec.rb

@@ -68,7 +68,7 @@ class WavefrontCommmandBaseTest < MiniTest::Test
     assert wf.commands.start_with?("Usage:\n")
     assert wf.commands.match(/ --help$/)
 
-    wf.commands(600).split("\n")[1..-1].each do |c|
+    wf.commands(600).split("\n")[1..].each do |c|
       next if skip_cmd && c.match(skip_cmd)
 
       assert_match(/^  \w+/, c)
@@ -80,7 +80,7 @@ class WavefrontCommmandBaseTest < MiniTest::Test
     assert wf.options(600).start_with?("Global options:\n")
     assert_match(/\nOptions:/, wf.options)
 
-    wf.options(600).split("\n")[1..-1].each do |o|
+    wf.options(600).split("\n")[1..].each do |o|
       next if o == 'Global options:' || o == 'Options:' || o.empty?
 
       assert_instance_of(String, o)

data/spec/wavefront-cli/commands/config_spec.rb

@@ -20,7 +20,7 @@ class WavefrontCommmandConfigTest < WavefrontCommmandBaseTest
     refute wf.options(600).start_with?("Global options:\n")
     assert_match(/Options:\n/, wf.options)
 
-    wf.options(600).split("\n")[1..-1].each do |o|
+    wf.options(600).split("\n")[1..].each do |o|
       next if o == 'Global options:' || o == 'Options:' || o.empty?
 
       assert_instance_of(String, o)
@@ -35,7 +35,7 @@ class WavefrontCommmandConfigTest < WavefrontCommmandBaseTest
     assert wf.commands.start_with?("Usage:\n")
     assert wf.commands.match(/ --help$/)
 
-    wf.commands(600).split("\n")[1..-1].each do |c|
+    wf.commands(600).split("\n")[1..].each do |c|
       next if skip_cmd && c.match(skip_cmd)
 
       assert_match(/^  \w+/, c)