wavefront-cli 2.16.0 → 2.16.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce414a92ff374362682499450746072dbe34c460c189bd66d65013286baf3f29
-  data.tar.gz: 138bfc2d8a0a9bdc1b295c89e65b076fbfbcb546ea1431d8e1f00b22c8811164
+  metadata.gz: de13eb5191a726a988bf5e7527a242d15ab045cbc4a7df386476fa7ba8c2c63d
+  data.tar.gz: b91a909c79cbb17c5dc80782348a7113e25e11da49f522e2b28addefbfcbf3eb
 SHA512:
-  metadata.gz: e68d2827509748ccb6b5694c95c1b33eab50c0cf093332f6dbb3acc4e41586a9949b490dc3e6017edf3b788b029bb5dd1ac38b1b29e33aa3943591324340a93c
-  data.tar.gz: 2da872908d448dfd09624aa5200b7189ff8badf1f2361733cf90739135b4a2e85d1bfb25b7ffa53d303fb55bd90b62a39b87b8307fa3259f4ec58d44b333714d
+  metadata.gz: b7f3aa5ebf65c897d373325018ff2f4ddd21d209e63af7ff10867b1dd3c3a9084db8e1a150e3d1a75463a9ff27c77d584d48e58b1b523403d62382e61dffbac3
+  data.tar.gz: 4b5e9fddcb5e4ddf782c4b8a9a525ff7cef4565456f7d0d9ab5de77041db178f1937372aa7f6bef5e96877b8ea16b40fc69a3ae4aef3712e840c6ab9989fdc0b

data/.travis.yml

@@ -1,11 +1,12 @@
 language: ruby
 cache: bundler
 rvm:
-- 2.2.10
-- 2.3.8
-- 2.4.5
-- 2.5.3
-before_install: gem install bundler --no-rdoc --no-ri
+  - 2.2.10
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+  - 2.6.0
+before_install: gem install bundler --no-document
 deploy:
   provider: rubygems
   api_key:

data/HISTORY.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 2.16.1 (29/12/2018)
+
+* Fix regression which broke query time ranges.
+* Fix regression which made `--noop` silent unless `--verbose` was
+  also specified.
+* Fix crash if `wf metric` matched no series.
+* Fix bug calculating query granularity when only one end of a
+  time range is specified.
+* Add much more comprehensive `--noop` tests.
+* Better handling of `--noop` on commands which cannot support it.
+
 ## 2.16.0 (23/12/2018)
 * Add `config` command to quickly set up and manage profiles.
 

data/lib/wavefront-cli/alert.rb

@@ -17,7 +17,10 @@ module WavefrontCli
       wf.unsnooze(options[:'<id>'])
     end
 
+    # rubocop:disable Metrics/AbcSize
     def do_delete
+      cannot_noop!
+
       word = if wf.describe(options[:'<id>']).status.code == 200
                'Soft'
              else
@@ -27,6 +30,7 @@ module WavefrontCli
       puts "#{word} deleting alert '#{options[:'<id>']}'."
       wf.delete(options[:'<id>'])
     end
+    # rubocop:enable Metrics/AbcSize
 
     def do_summary
       wf.summary

data/lib/wavefront-cli/base.rb

@@ -123,15 +123,17 @@ module WavefrontCli
     end
 
     # Make a common wavefront-sdk options object from standard CLI
-    # options.
+    # options. We force verbosity on for a noop, otherwise we get no
+    # output.
     #
     # @return [Hash] containing `debug`, `verbose`, and `noop`.
     #
     def mk_opts
       ret = { debug:   options[:debug],
-              verbose: options[:verbose],
               noop:    options[:noop] }
 
+      ret[:verbose] = options[:noop] ? true : options[:verbose]
+
       ret.merge!(extra_options) if respond_to?(:extra_options)
       ret
     end
@@ -387,12 +389,9 @@ module WavefrontCli
     end
 
     def do_update
+      cannot_noop!
       k, v = options[:'<key=value>'].split('=', 2)
       wf.update(options[:'<id>'], k => v)
-    rescue NoMethodError
-      raise(WavefrontCli::Exception::UnsupportedOperation,
-            'Updates require two API calls. We cannot do the second ' \
-            'when -n is set.')
     end
 
     def do_search(cond = options[:'<condition>'])
@@ -478,5 +477,13 @@ module WavefrontCli
 
       [resp, data]
     end
+
+    # Operations which do require multiple operations cannot be
+    # perormed as a no-op. Drop in a call to this method for those
+    # things. The exception is caught in controller.rb
+    #
+    def cannot_noop!
+      raise WavefrontCli::Exception::UnsupportedNoop if options[:noop]
+    end
   end
 end

data/lib/wavefront-cli/controller.rb

@@ -134,6 +134,8 @@ class WavefrontCliController
     abort "Unsupported operation.\n#{e.message}"
   rescue WavefrontCli::Exception::UnsupportedOutput => e
     abort e.message
+  rescue WavefrontCli::Exception::UnsupportedNoop
+    abort 'Multiple API call operations cannot be performed as no-ops.'
   rescue Wavefront::Exception::UnsupportedWriter => e
     abort "Unsupported writer '#{e.message}'."
   rescue StandardError => e

data/lib/wavefront-cli/dashboard.rb

@@ -14,7 +14,10 @@ module WavefrontCli
       wf.describe(options[:'<id>'], options[:version])
     end
 
+    # rubocop:disable Metrics/AbcSize
     def do_delete
+      cannot_noop!
+
       word = if wf.describe(options[:'<id>']).status.code == 200
                'Soft'
              else
@@ -24,6 +27,7 @@ module WavefrontCli
       puts "#{word} deleting dashboard '#{options[:'<id>']}'."
       wf.delete(options[:'<id>'])
     end
+    # rubocop:enable Metrics/AbcSize
 
     def do_history
       wf.history(options[:'<id>'])

data/lib/wavefront-cli/derivedmetric.rb

@@ -15,6 +15,8 @@ module WavefrontCli
 
     # rubocop:disable Metrics/AbcSize
     def do_delete
+      cannot_noop!
+
       word = if wf.describe(options[:'<id>']).status.code == 200
                'Soft'
              else

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

@@ -6,7 +6,7 @@ module WavefrontDisplay
   #
   class Metric < Base
     def do_describe
-      bail_out if no_data
+      bail_out if no_data?
 
       @data = data['hosts'].map do |h, _aggr|
         { host: h[:host], last_update: human_time(h[:last_update]) }

data/lib/wavefront-cli/exception.rb

@@ -14,6 +14,7 @@ module WavefrontCli
     class UnparseableInput < RuntimeError; end
     class UnparseableResponse < RuntimeError; end
     class UnsupportedFileFormat < RuntimeError; end
+    class UnsupportedNoop < RuntimeError; end
     class UnsupportedOperation < RuntimeError; end
     class UnsupportedOutput < RuntimeError; end
   end

data/lib/wavefront-cli/query.rb

@@ -47,8 +47,6 @@ module WavefrontCli
       all_aliases
     end
 
-    private
-
     # @return [Hash] options for the SDK query method
     #
     # rubocop:disable Metrics/AbcSize
@@ -71,22 +69,16 @@ module WavefrontCli
     #   given, that; if not, ten minutes ago
     #
     def window_start
-      if options[:start]
-        parse_time(options[:start], true)
-      else
-        (Time.now - 600).to_i
-      end
+      t = options[:start] ? options[:start].dup : Time.now - 600
+      parse_time(t, true)
     end
 
     # @return [Integer] end of query window. If one has been
     #   given, that; if not, now
     #
     def window_end
-      if options[:end]
-        parse_time(options[:end], true)
-      else
-        Time.now.to_i
-      end
+      t = options[:end] ? options[:end].dup : Time.now
+      parse_time(t, true)
     end
 
     def granularity(t_start, t_end)
@@ -96,6 +88,8 @@ module WavefrontCli
     # Work out a sensible granularity based on the time window
     #
     def default_granularity(window)
+      window = window.abs / 1000
+
       if window < 300
         :s
       elsif window < 10_800

data/lib/wavefront-cli/version.rb

@@ -1 +1 @@
-WF_CLI_VERSION = '2.16.0'.freeze
+WF_CLI_VERSION = '2.16.1'.freeze

data/spec/spec_helper.rb

@@ -48,7 +48,7 @@ def permutations
                                  e: ENDPOINT }]]
 end
 
-# Object returned by cmd_to_call. Has just enough methods to satisy
+# Object returned by cmd_to_call. Has just enough methods to satisfy
 # the SDK
 #
 class DummyResponse
@@ -74,7 +74,8 @@ CANNED_RESPONSE = DummyResponse.new
 # @param cmd [String] command line args to supply to the Wavefront
 #  command
 # @param call [Hash]
-#
+# rubocop:disable Metrics/AbcSize
+# rubocop:disable Metrics/PerceivedComplexity
 def cmd_to_call(word, args, call, sdk_class = nil)
   headers = { 'Accept':          /.*/,
               'Accept-Encoding': /.*/,
@@ -91,7 +92,13 @@ def cmd_to_call(word, args, call, sdk_class = nil)
     describe "with #{word} #{args}" do
       fmts.each do |fmt|
         cmd = "#{word} #{args} #{opts} #{fmt}"
-        uri = 'https://' + vals[:e] + call[:path]
+
+        uri = if call[:regex]
+                Regexp.new(call[:path])
+              else
+                'https://' + vals[:e] + call[:path]
+              end
+
         h = headers.dup
         h[:Authorization] = "Bearer #{vals[:t]}"
 
@@ -121,6 +128,65 @@ def cmd_to_call(word, args, call, sdk_class = nil)
     end
   end
 end
+# rubocop:enable Metrics/PerceivedComplexity
+# rubocop:enable Metrics/AbcSize
+
+# Test no-ops
+#
+# @param output [Array] [URI, params]
+#
+def cmd_noop(word, cmd, output, sdk_class = nil)
+  cmd = [word] + cmd.split + ['--noop'] + ["-t #{TOKEN} -E #{ENDPOINT}"]
+
+  exit_code = output == :impossible ? 1 : 0
+
+  it "runs #{cmd.join(' ')} and gets output without an API call" do
+    out, err = capture_io do
+      sdk_class ||= Object.const_get("WavefrontCli::#{word.capitalize}")
+      require "wavefront-sdk/#{sdk_class.name.split('::').last.downcase}"
+      begin
+        WavefrontCliController.new(cmd).run
+      rescue SystemExit => e
+        assert_equal(exit_code, e.status)
+      end
+    end
+
+    if output == :impossible
+      assert_equal('Multiple API call operations cannot be performed ' \
+                   "as no-ops.\n", err)
+      assert_empty(out)
+    else
+      out = out.split("\n")
+      refute_empty(out)
+      assert_equal("SDK INFO: uri: #{output.first}", out.first)
+      if output.size > 1
+        assert_equal("SDK INFO: params: #{output.last}", out.last)
+      end
+      assert_empty(err)
+    end
+  end
+end
+
+# Wrapper to standard noop tests
+#
+def noop_tests(cmd, id, nodelete = false, pth = nil, sdk_class = nil)
+  pth ||= cmd
+  cmd_noop(cmd, 'list',
+           ["GET https://metrics.wavefront.com/api/v2/#{pth}",
+            offset: 0, limit: 100], sdk_class)
+  cmd_noop(cmd, "describe #{id}",
+           ["GET https://metrics.wavefront.com/api/v2/#{pth}/#{id}"],
+           sdk_class)
+
+  if nodelete == :skip
+  elsif nodelete
+    cmd_noop(cmd, "delete #{id}", :impossible, sdk_class)
+  else
+    cmd_noop(cmd, "delete #{id}",
+             ["DELETE https://metrics.wavefront.com/api/v2/#{pth}/#{id}"],
+             sdk_class)
+  end
+end
 
 # Run a command we expect to fail, returning stdout and stderr
 #

data/spec/wavefront-cli/alert_spec.rb

@@ -88,4 +88,5 @@ describe "#{word} command" do
               body: search_body('in_maintenance'))
   cmd_to_call(word, 'queries', path: "/api/v2/#{word}?limit=999&offset=0")
   tag_tests(word, id, bad_id)
+  noop_tests(word, id, true)
 end

data/spec/wavefront-cli/cloudintegration_spec.rb

@@ -12,6 +12,7 @@ describe 'cloudintegration command' do
   missing_creds(word, ['list', "describe #{id}", "delete #{id}",
                        "undelete #{id}"])
   list_tests(word, 'cloudintegration', k)
+  noop_tests(word, id, false, 'cloudintegration', k)
   cmd_to_call(word, "describe #{id}",
               { path: "/api/v2/cloudintegration/#{id}" }, k)
   cmd_to_call(word, "delete #{id}",

data/spec/wavefront-cli/dashboard_spec.rb

@@ -11,6 +11,7 @@ describe "#{word} command" do
   missing_creds(word, ['list', "describe #{id}", "delete #{id}",
                        "undelete #{id}", "history #{id}"])
   list_tests(word)
+  noop_tests(word, id, true)
   cmd_to_call(word, "describe #{id}", path: "/api/v2/#{word}/#{id}")
   cmd_to_call(word, "describe -v 7 #{id}",
               path: "/api/v2/#{word}/#{id}/history/7")

data/spec/wavefront-cli/derivedmetric_spec.rb

@@ -14,6 +14,7 @@ describe "#{word} command" do
   missing_creds(word, ['list', "describe #{id}", "delete #{id}",
                        "undelete #{id}", "history #{id}"])
   list_tests(word, nil, k)
+  noop_tests(word, id, true, word, k)
   cmd_to_call(word, "describe #{id}", { path: "/api/v2/#{word}/#{id}" }, k)
   cmd_to_call(word, "describe -v 7 #{id}",
               { path: "/api/v2/#{word}/#{id}/history/7" }, k)

data/spec/wavefront-cli/externallink_spec.rb

@@ -10,16 +10,12 @@ word   = 'link'
 
 describe "#{word} command" do
   missing_creds(word, ['list', "describe #{id}", "delete #{id}"])
-
   list_tests(word, 'extlink', k)
-
+  noop_tests(word, id, false, 'extlink', k)
   cmd_to_call(word, "describe #{id}", { path: "/api/v2/extlink/#{id}" }, k)
-
   cmd_to_call(word, "delete #{id}",
               { method: :delete, path: "/api/v2/extlink/#{id}" }, k)
-
   invalid_ids(word, ["describe #{bad_id}", "delete #{bad_id}"])
-
   cmd_to_call(word, "search -L 100 id~#{id}",
               { method: :post,
                 path:   '/api/v2/search/extlink',

data/spec/wavefront-cli/integration_spec.rb

@@ -12,7 +12,7 @@ describe "#{word} command" do
                        "uninstall #{id}", "status #{id}", 'statuses',
                        'manifests'])
   list_tests(word)
-
+  noop_tests(word, id, :skip, 'integration')
   cmd_to_call(word, "status #{id}", path: "/api/v2/#{word}/#{id}/status")
 
   cmd_to_call(word, "install #{id}",

data/spec/wavefront-cli/{maintanancewindow_spec.rb → maintenancewindow_spec.rb}

@@ -11,6 +11,7 @@ word = 'window'
 describe "#{word} command" do
   missing_creds(word, ['list', "describe #{id}", "delete #{id}"])
   list_tests(word, 'maintenancewindow', k)
+  noop_tests(word, id, false, 'maintenancewindow', k)
   cmd_to_call(word, "describe #{id}",
               { path: "/api/v2/maintenancewindow/#{id}" }, k)
   cmd_to_call(word, "delete #{id}",

data/spec/wavefront-cli/message_spec.rb

@@ -9,6 +9,11 @@ require_relative "../../lib/wavefront-cli/#{word}"
 
 describe "#{word} command" do
   missing_creds(word, ['list', "mark #{id}"])
+  cmd_noop(word, 'list',
+           ["GET https://metrics.wavefront.com/api/v2/#{word}",
+            offset: 0, limit: 100, unreadOnly: true])
+  cmd_noop(word, "mark #{id}",
+           ["POST https://metrics.wavefront.com/api/v2/#{word}/#{id}/read"])
 
   cmd_to_call(word, 'list',
               path: "/api/v2/#{word}?limit=100&offset=0&unreadOnly=true")

data/spec/wavefront-cli/metric_spec.rb

@@ -9,6 +9,9 @@ require_relative "../../lib/wavefront-cli/#{word}"
 
 describe "#{word} command" do
   missing_creds(word, ["describe #{id}"])
+  cmd_noop(word, "describe #{id}",
+           ["GET https://metrics.wavefront.com/api/v2/chart/#{word}/detail",
+            [[:m, 'dev.cli.test']]])
   cmd_to_call(word, "describe #{id}",
               path: "/api/v2/chart/#{word}/detail?m=#{id}")
   cmd_to_call(word, "describe -g ptn1 #{id}",

data/spec/wavefront-cli/proxy_spec.rb

@@ -11,6 +11,7 @@ describe "#{word} command" do
   missing_creds(word, ['list', 'versions', "describe #{id}", "delete #{id}",
                        "undelete #{id}", "rename #{id} newname"])
   list_tests(word)
+  noop_tests(word, id)
   cmd_to_call(word, "describe #{id}", path: "/api/v2/#{word}/#{id}")
   cmd_to_call(word, 'versions', path: "/api/v2/#{word}?limit=999&offset=0")
   cmd_to_call(word, "rename #{id} newname",

data/spec/wavefront-cli/query_spec.rb

@@ -15,8 +15,23 @@ t2 = parse_time('12:10', true)
 o = '-g m -s 12:00'
 
 describe "#{word} command" do
+  cmd_to_call(word, "-s -2h #{q}",
+              path: '/api/v2/chart/api\\?g=m&i=false' \
+                    '&listMode=true&q=ts\(%22dev.cli.test%22\)' \
+                    '&s=[0-9]{13}&sorted=true&strict=true&summarization=mean',
+              regex: true)
+
   missing_creds(word, ["-g m -s 12:00 '#{q}'", "raw #{q}"])
 
+  cmd_noop(word, "-s #{t1} #{q}",
+           ['GET https://metrics.wavefront.com/api/v2/chart/api',
+            i: false, summarization: 'mean', listMode: true, strict: true,
+            sorted: true, q: q, g: :h, s: t1])
+
+  cmd_noop(word, 'raw dev.cli.test',
+           ['GET https://metrics.wavefront.com/api/v2/chart/raw',
+            metric: 'dev.cli.test'])
+
   cmd_to_call(word, "#{o} #{q}",
               path: '/api/v2/chart/api?g=m&i=false&listMode=true' \
                     "&q=ts(%22dev.cli.test%22)&s=#{t1}&sorted=true" \
@@ -63,3 +78,35 @@ describe "#{word} command" do
               path: '/api/v2/chart/raw?metric=dev.cli.test&source=h1' \
                     "&startTime=#{t1}&endTime=#{t2}")
 end
+
+class QueryTest < MiniTest::Test
+  attr_reader :wf
+
+  def setup
+    @wf = WavefrontCli::Query.new(endpoint: ENDPOINT)
+  end
+
+  def test_window_start
+    assert_kind_of(Numeric, wf.window_start)
+    assert_equal(13, wf.window_start.to_s.length)
+  end
+
+  def test_window_end
+    assert_kind_of(Numeric, wf.window_start)
+    assert_equal(13, wf.window_start.to_s.length)
+  end
+
+  def test_default_granularity
+    minute = 60_000
+    assert_equal(:s, wf.default_granularity(100))
+    assert_equal(:s, wf.default_granularity(10_000))
+    assert_equal(:m, wf.default_granularity(120 * minute))
+    assert_equal(:h, wf.default_granularity(4 * 60 * minute))
+    assert_equal(:d, wf.default_granularity(4 * 24 * 60 * minute))
+    assert_equal(:s, wf.default_granularity(-100))
+    assert_equal(:s, wf.default_granularity(-10_000))
+    assert_equal(:m, wf.default_granularity(-120 * minute))
+    assert_equal(:h, wf.default_granularity(-4 * 60 * minute))
+    assert_equal(:d, wf.default_granularity(-4 * 24 * 60 * minute))
+  end
+end

data/spec/wavefront-cli/savedsearch_spec.rb

@@ -11,6 +11,7 @@ k = WavefrontCli::SavedSearch
 describe "#{word} command" do
   missing_creds(word, ['list', "describe #{id}", "delete #{id}"])
   list_tests(word, 'savedsearch', k)
+  noop_tests(word, id, false, 'savedsearch', k)
   cmd_to_call(word, "describe #{id}", { path: "/api/v2/#{word}/#{id}" }, k)
   cmd_to_call(word, "delete #{id}",
               { method: :delete, path: "/api/v2/#{word}/#{id}" }, k)

data/spec/wavefront-cli/source_spec.rb

@@ -27,4 +27,8 @@ describe "#{word} command" do
                                   matchingMethod: 'STARTSWITH' }],
                         sort: { field: 'id', ascending: true } },
               headers: JSON_POST_HEADERS)
+  cmd_noop(word, 'list',
+           ['GET https://metrics.wavefront.com/api/v2/source'])
+  cmd_noop(word, 'describe src',
+           ['GET https://metrics.wavefront.com/api/v2/source/src'])
 end

data/spec/wavefront-cli/user_spec.rb

@@ -28,4 +28,8 @@ describe "#{word} command" do
               headers: hdrs)
 
   invalid_ids(word, ["describe #{bad_id}", "delete #{bad_id}"])
+  cmd_noop(word, 'list',
+           ["GET https://metrics.wavefront.com/api/v2/#{word}"])
+  cmd_noop(word, 'describe rob@a.com',
+           ["GET https://metrics.wavefront.com/api/v2/#{word}/rob@a.com"])
 end

data/spec/wavefront-cli/webhook_spec.rb

@@ -10,6 +10,7 @@ require_relative "../../lib/wavefront-cli/#{word}"
 describe "#{word} command" do
   missing_creds(word, ['list', "describe #{id}", "delete #{id}"])
   list_tests(word)
+  noop_tests(word, id)
   cmd_to_call(word, "describe #{id}", path: "/api/v2/#{word}/#{id}")
   cmd_to_call(word, "delete #{id}", method: :delete,
                                     path:   "/api/v2/#{word}/#{id}")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-cli
 version: !ruby/object:Gem::Version
-  version: 2.16.0
+  version: 2.16.1
 platform: ruby
 authors:
 - Robert Fisher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-24 00:00:00.000000000 Z
+date: 2018-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt
@@ -304,7 +304,7 @@ files:
 - spec/wavefront-cli/event_spec.rb
 - spec/wavefront-cli/externallink_spec.rb
 - spec/wavefront-cli/integration_spec.rb
-- spec/wavefront-cli/maintanancewindow_spec.rb
+- spec/wavefront-cli/maintenancewindow_spec.rb
 - spec/wavefront-cli/message_spec.rb
 - spec/wavefront-cli/metric_spec.rb
 - spec/wavefront-cli/opt_handler_spec.rb
@@ -385,7 +385,7 @@ test_files:
 - spec/wavefront-cli/event_spec.rb
 - spec/wavefront-cli/externallink_spec.rb
 - spec/wavefront-cli/integration_spec.rb
-- spec/wavefront-cli/maintanancewindow_spec.rb
+- spec/wavefront-cli/maintenancewindow_spec.rb
 - spec/wavefront-cli/message_spec.rb
 - spec/wavefront-cli/metric_spec.rb
 - spec/wavefront-cli/opt_handler_spec.rb