wavefront-cli 4.2.1 → 4.3.0

data/spec/wavefront-cli/output/wavefront_spec.rb

@@ -1,6 +1,9 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require_relative '../../spec_helper'
+require 'minitest/autorun'
+require_relative 'helpers'
+require_relative '../../support/supported_commands'
 require_relative '../../../lib/wavefront-cli/output/wavefront'
 
 # Test the Wavefront instantiation of the base class
@@ -9,8 +12,7 @@ class WavefrontOutputBaseTest < MiniTest::Test
   attr_reader :wfo
 
   def setup
-    @wfo = WavefrontOutput::Wavefront.new(load_query_response,
-                                          class: 'query')
+    @wfo = WavefrontOutput::Wavefront.new(load_query_response, class: 'query')
   end
 
   def test_my_format
@@ -36,7 +38,7 @@ class WavefrontOutputBaseTest < MiniTest::Test
       assert klass.respond_to?(:run)
     end
 
-    (CMDS - supported_commands).each do |cmd|
+    (SupportedCommands.new.all - supported_commands).each do |cmd|
       wfo = WavefrontOutput::Wavefront.new(load_query_response, class: cmd)
       assert_raises(LoadError) { wfo.command_class }
     end

data/spec/wavefront-cli/output/yaml_spec.rb

@@ -1,7 +1,9 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'yaml'
-require_relative '../../spec_helper'
+require_relative 'helpers'
+require 'minitest/autorun'
 require_relative '../../../lib/wavefront-cli/output/yaml'
 
 # Test YAML output

data/spec/wavefront-cli/proxy_spec.rb

@@ -1,30 +1,52 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-id = 'fd248f53-378e-4fbe-bbd3-efabace8d724'
-bad_id = '__bad_id__'
-word = 'proxy'
-
-require_relative '../spec_helper'
-require_relative "../../lib/wavefront-cli/#{word}"
-
-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",
-              method: :put,
-              path:   "/api/v2/#{word}/#{id}",
-              body:   { name: 'newname' }.to_json)
-  cmd_to_call(word, "delete #{id}",
-              method: :delete, path: "/api/v2/#{word}/#{id}")
-  cmd_to_call(word, "undelete #{id}",
-              method: :post, path: "/api/v2/#{word}/#{id}/undelete")
-  invalid_ids(word, ["describe #{bad_id}", "delete #{bad_id}",
-                     "undelete #{bad_id}", "rename #{bad_id} newname"])
-  invalid_something(word, ["rename #{id} '(>_<)'"], 'proxy name')
-  search_tests(word, id)
-  test_list_output(word)
+require_relative '../support/command_base'
+require_relative '../../lib/wavefront-cli/proxy'
+
+# Ensure 'proxy' commands produce the correct API calls.
+#
+class ProxyEndToEndTest < EndToEndTest
+  include WavefrontCliTest::DeleteUndelete
+  include WavefrontCliTest::Describe
+  include WavefrontCliTest::List
+  include WavefrontCliTest::Search
+
+  def test_versions
+    quietly do
+      assert_cmd_gets('versions', '/api/v2/proxy?limit=999&offset=0')
+    end
+
+    assert_abort_on_missing_creds('versions')
+    assert_noop('versions',
+                'uri: GET https://default.wavefront.com/api/v2/proxy',
+                'params: {:offset=>0, :limit=>999}')
+  end
+
+  def test_rename
+    quietly do
+      assert_cmd_puts("rename #{id} newname", "/api/v2/proxy/#{id}",
+                      tokenID: id, tokenName: 'newname')
+    end
+
+    assert_noop("rename #{id} newname",
+                "uri: PUT https://default.wavefront.com/api/v2/proxy/#{id}",
+                'body: {"name":"newname"}')
+    assert_invalid_id("rename #{invalid_id} newname")
+    assert_abort_on_missing_creds("rename #{id} newname")
+  end
+
+  private
+
+  def id
+    'fd248f53-378e-4fbe-bbd3-efabace8d724'
+  end
+
+  def invalid_id
+    '__BAD__'
+  end
+
+  def cmd_word
+    'proxy'
+  end
 end

data/spec/wavefront-cli/query_spec.rb

@@ -1,105 +1,187 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-word = 'query'
-
-require_relative '../spec_helper'
-require_relative "../../lib/wavefront-cli/#{word}"
+require_relative '../support/command_base'
+require_relative '../../lib/wavefront-cli/query'
 require 'wavefront-sdk/support/mixins'
-# rubocop:disable Style/MixinUsage
-include Wavefront::Mixins
-# rubocop:enable Style/MixinUsage
 
-q = 'ts("dev.cli.test")'
-#
-# The SDK has got smarter about calculating granularity options, so
-# we can't use any kind of absolute time any more. We round time
-# down to the nearest minute, because that's how users will most
-# likely specify it.
+# Ensure 'query' commands produce the correct API calls.
 #
-t1_t = Time.now - (30 * 60)
-t1_t = Time.at(t1_t.to_i - t1_t.sec)
-t2_t = Time.at(t1_t + (10 * 60))
-
-t1 = parse_time(t1_t, true)
-t2 = parse_time(t2_t, true)
-o = "-g m -s #{t1_t.strftime('%H:%M')}"
-s_and_e_opts = "-s #{t1_t.strftime('%H:%M')} -e #{t2_t.strftime('%H:%M')}"
-
-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, ["#{o} '#{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: :m, 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" \
-                    '&strict=true&summarization=mean')
-
-  cmd_to_call(word, "#{s_and_e_opts} #{q}",
-              path: "/api/v2/chart/api?e=#{t2}&g=m&i=false" \
-                    '&listMode=true&q=ts(%22dev.cli.test%22)' \
-                    "&s=#{t1}&sorted=true&strict=true&summarization=mean")
-
-  cmd_to_call(word, "-g s #{s_and_e_opts} -S max #{q}",
-              path: "/api/v2/chart/api?e=#{t2}&g=s&i=false" \
-                    '&listMode=true&q=ts(%22dev.cli.test%22)' \
-                    "&s=#{t1}&sorted=true&strict=true&summarization=max")
-
-  cmd_to_call(word, "-g s #{s_and_e_opts} -p 100 #{q}",
-              path: "/api/v2/chart/api?e=#{t2}&g=s&i=false" \
-                    '&listMode=true&q=ts(%22dev.cli.test%22)' \
-                    "&s=#{t1}&sorted=true&summarization=mean&strict=true" \
-                    '&p=100')
-
-  cmd_to_call(word, "-iO -g h #{s_and_e_opts} -p 100 #{q}",
-              path: "/api/v2/chart/api?e=#{t2}&g=h&i=true" \
-                    '&listMode=true&q=ts(%22dev.cli.test%22)' \
-                    "&s=#{t1}&sorted=true&summarization=mean" \
-                    '&strict=true&p=100&includeObsoleteMetrics=true')
-
-  cmd_to_call(word, "-N query -g h #{s_and_e_opts} -p 100 #{q}",
-              path: "/api/v2/chart/api?e=#{t2}&g=h&i=false" \
-                    '&listMode=true&q=ts(%22dev.cli.test%22)' \
-                    "&s=#{t1}&sorted=true&summarization=mean" \
-                    '&strict=true&p=100&n=query')
-
-  cmd_to_call(word, 'raw dev.cli.test',
-              path: '/api/v2/chart/raw?metric=dev.cli.test')
-
-  cmd_to_call(word, 'raw -H h1 dev.cli.test',
-              path: '/api/v2/chart/raw?metric=dev.cli.test&source=h1')
-
-  cmd_to_call(word, "raw -s #{t1_t.strftime('%H:%M')} -H h1 dev.cli.test",
-              path: '/api/v2/chart/raw?metric=dev.cli.test&source=h1' \
-                    "&startTime=#{t1}")
-
-  cmd_to_call(word, "raw #{s_and_e_opts} -H h1 dev.cli.test",
-              path: '/api/v2/chart/raw?metric=dev.cli.test&source=h1' \
-                    "&startTime=#{t1}&endTime=#{t2}")
-end
+class QueryEndToEndTest < EndToEndTest
+  include Wavefront::Mixins
+
+  def test_query_specifying_start_of_window_no_sparkline
+    out, err = capture_io do
+      assert_cmd_gets_with_params("-s #{epoch_time[0]} -k #{query}",
+                                  '/api/v2/chart/api',
+                                  { q: query,
+                                    g: 'm',
+                                    s: epoch_time[0].to_s }, canned_response)
+    end
+
+    assert_empty(err)
+    assert_match(/name\s+ts\("cpu.0.pc.user"\)/, out)
+    assert_match(/query\s+ts\("cpu.0.pc.user"\)/, out)
+    refute_match(/sparkline/, out)
+
+    assert_noop(
+      "-s #{epoch_time[0]} -k #{query}",
+      'uri: GET https://default.wavefront.com/api/v2/chart/api',
+      'params: {:i=>false, :summarization=>"mean", :listMode=>true, ' \
+      ':strict=>true, :sorted=>true, :q=>"ts(\"dev.cli.test\")", ' \
+      ":g=>:m, :s=>#{epoch_time[0]}}"
+    )
+  end
+
+  def test_query_with_start_and_end
+    out, err = capture_io do
+      assert_cmd_gets_with_params("#{start_and_end_opts} #{query}",
+                                  '/api/v2/chart/api',
+                                  { q: query,
+                                    g: 'm',
+                                    s: epoch_time[0].to_s,
+                                    e: epoch_time[1].to_s }, canned_response)
+    end
+
+    assert_empty(err)
+    assert_match(/query\s+ts\("cpu.0.pc.user"\)/, out)
+  end
+
+  def test_query_with_start_and_end_and_max_summary
+    out, err = capture_io do
+      assert_cmd_gets_with_params("#{start_and_end_opts} -S max #{query}",
+                                  '/api/v2/chart/api',
+                                  { q: query,
+                                    g: 'm',
+                                    summarization: 'max',
+                                    s: epoch_time[0].to_s,
+                                    e: epoch_time[1].to_s }, canned_response)
+    end
+
+    assert_empty(err)
+    assert_match(/query\s+ts\("cpu.0.pc.user"\)/, out)
+  end
+
+  def test_query_with_start_and_end_and_max_number_of_points
+    out, err = capture_io do
+      assert_cmd_gets_with_params("#{start_and_end_opts} -p 100 #{query}",
+                                  '/api/v2/chart/api',
+                                  { q: query,
+                                    g: 'm',
+                                    p: '100',
+                                    s: epoch_time[0].to_s,
+                                    e: epoch_time[1].to_s }, canned_response)
+    end
+
+    assert_empty(err)
+    assert_match(/query\s+ts\("cpu.0.pc.user"\)/, out)
+  end
+
+  def test_query_with_start_and_end_and_granularity_and_obsolete
+    out, err = capture_io do
+      assert_cmd_gets_with_params("#{start_and_end_opts} -g h -O #{query}",
+                                  '/api/v2/chart/api',
+                                  { q: query,
+                                    g: 'h',
+                                    includeObsoleteMetrics: 'true',
+                                    s: epoch_time[0].to_s,
+                                    e: epoch_time[1].to_s }, canned_response)
+    end
+
+    assert_empty(err)
+    assert_match(/query\s+ts\("cpu.0.pc.user"\)/, out)
+  end
+
+  def test_query_with_start_and_end_and_name
+    out, err = capture_io do
+      assert_cmd_gets_with_params(
+        "#{start_and_end_opts} -g s -N query #{query}",
+        '/api/v2/chart/api',
+        { q: query,
+          g: 's',
+          n: 'query',
+          s: epoch_time[0].to_s,
+          e: epoch_time[1].to_s }, canned_response
+      )
+    end
 
-describe 'output formatting' do
-  it 'tests query output' do
-    out, err = command_output(word, :do_default, nil, 'query-cpu.json')
-    refute_empty(out)
     assert_empty(err)
-    assert out.start_with?('name ')
+    assert_match(/query\s+ts\("cpu.0.pc.user"\)/, out)
+  end
+
+  def test_raw
+    assert_cmd_gets('raw dev.cli.test',
+                    '/api/v2/chart/raw?metric=dev.cli.test')
+
+    assert_noop('raw dev.cli.test',
+                'uri: GET https://default.wavefront.com/api/v2/chart/raw',
+                'params: {:metric=>"dev.cli.test"}')
+    assert_abort_on_missing_creds('raw dev.cli.test')
+  end
+
+  def test_error_if_the_query_is_a_literal_raw
+    out, err = capture_io do
+      assert_raises(SystemExit) do
+        assert_cmd_gets_with_params('raw',
+                                    '/api/v2/chart/api',
+                                    { g: 'm', q: 'raw' },
+                                    { errorMessage: 'mock error' }.to_json)
+      end
+    end
+
+    assert_empty(out)
+    assert_equal("Invalid query. API message: 'mock error'.", err.strip)
+  end
+
+  def test_raw_with_host
+    assert_cmd_gets('raw -H h1 dev.cli.test',
+                    '/api/v2/chart/raw?metric=dev.cli.test&source=h1')
+  end
+
+  def test_raw_with_start_and_host
+    assert_cmd_gets("raw -s #{wall_time[0].strftime('%H:%M')} " \
+                    '-H h1 dev.cli.test',
+                    '/api/v2/chart/raw?metric=dev.cli.test&source=h1' \
+                    "&startTime=#{epoch_time[0]}")
+  end
+
+  def test_raw_with_start_and_end_and_host
+    assert_cmd_gets("raw #{start_and_end_opts} -H h1 dev.cli.test",
+                    '/api/v2/chart/raw?metric=dev.cli.test&source=h1' \
+                    "&startTime=#{epoch_time[0]}&endTime=#{epoch_time[1]}")
+  end
+
+  private
+
+  def query
+    'ts("dev.cli.test")'
+  end
+
+  def invalid_id
+    '__BAD__'
+  end
+
+  def cmd_word
+    'query'
+  end
+
+  def canned_response
+    IO.read(RES_DIR + 'responses' + 'query.json')
   end
 end
 
+#
+# describe 'output formatting' do
+#   it 'tests query output' do
+#     out, err = command_output(word, :do_default, nil, 'query-cpu.json')
+#     refute_empty(out)
+#     assert_empty(err)
+#     assert out.start_with?('name ')
+#   end
+# end
+
+# Query tests
+#
 class QueryTest < MiniTest::Test
   attr_reader :wf
 

data/spec/wavefront-cli/resources/responses/query.json

@@ -0,0 +1 @@
+{"query":"ts(\"cpu.0.pc.user\")","name":"ts(\"cpu.0.pc.user\")","granularity":60,"timeseries":[{"label":"cpu.0.pc.user","host":"cube","tags":{"env":"lab"},"data":[[1567773120,25.359955893658334],[1567773180,22.03986909081],[1567773240,17.05377062129167],[1567773300,24.38730402552667],[1567773360,18.931883242503336],[1567773420,2.7780920554299997],[1567773480,2.9629818391683336],[1567773540,2.7025604580616664],[1567773600,3.4189161957333334],[1567773660,2.59600675876]]}],"stats":{"keys":124,"points":695,"summaries":572,"buffer_keys":124,"compacted_keys":1,"compacted_points":572,"latency":300,"queries":5,"s3_keys":0,"cpu_ns":3080507,"skipped_compacted_keys":0,"cached_compacted_keys":0,"query_tasks":0,"dropped_summaries":0}}

data/spec/wavefront-cli/resources/updates/alert.json

@@ -0,0 +1,15 @@
+{
+    "id": "1556812163465",
+    "name": "PKS - too many containers not running",
+    "target": "target:9wltLtYXsP8Je2kI",
+    "tags": {
+        "customerTags": [
+            "pks"
+        ]
+    },
+    "condition": "sum(ts(pks.kube.pod.container.status.running.gauge)) / (sum(ts(pks.kube.pod.container.status.running.gauge)) + sum(ts(pks.kube.pod.container.status.waiting.gauge)) + sum(ts(pks.kube.pod.container.status.terminated.gauge))) < 0.8",
+    "displayExpression": "sum(ts(pks.kube.pod.container.status.running.gauge)) / (sum(ts(pks.kube.pod.container.status.running.gauge)) + sum(ts(pks.kube.pod.container.status.waiting.gauge)) + sum(ts(pks.kube.pod.container.status.terminated.gauge)))",
+    "minutes": 5,
+    "resolveAfterMinutes": 5,
+    "severity": "SEVERE"
+}

data/spec/wavefront-cli/resources/updates/dashboard.json

@@ -0,0 +1 @@
+{"canUserModify":true,"description":"very simple dashboard for CLI tests","hidden":false,"name":"test dashboard","id":"test_dashboard","parameters":{},"tags":{"customerTags":["test.dashboard"]},"customer":"sysdef","url":"test_dashboard","systemOwned":false,"creatorId":"rob@sysdef.xyz","updaterId":"rob@sysdef.xyz","eventFilterType":"BYCHART","sections":[{"name":"Proxy Section","rows":[{"charts":[{"base":0,"units":"Units","name":"New Chart","sources":[{"name":"New Query","query":"ts(\"~proxy.points.2878.*\")","secondaryAxis":false,"scatterPlotSource":"Y","querybuilderEnabled":false,"sourceDescription":""}],"includeObsoleteMetrics":false,"noDefaultEvents":false,"chartAttributes":null,"chartSettings":{"type":"line","autoColumnTags":false},"interpolatePoints":false}],"heightFactor":100}]}],"parameterDetails":{},"displayDescription":false,"displaySectionTableOfContents":true,"displayQueryParameters":false,"chartTitleScalar":0,"eventQuery":"","defaultTimeWindow":"2h","viewsLastDay":0,"viewsLastWeek":0,"viewsLastMonth":0,"acl":{"canView":[],"canModify":["a7d2e651-cec1-4154-a5e8-1946f57ef5b3"]},"createdEpochMillis":1556807658025,"updatedEpochMillis":1556807741557,"deleted":false,"numFavorites":0,"favorite":false,"numCharts":1,"orphan":false}

data/spec/wavefront-cli/savedsearch_spec.rb

@@ -1,21 +1,38 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require_relative '../spec_helper'
-
-id = '4rUipOK3'
-bad_id = '__BAD__'
-word = 'savedsearch'
-require_relative "../../lib/wavefront-cli/#{word}"
-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)
-  search_tests(word, id, k, 'savedsearch')
-  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)
-  invalid_ids(word, ["describe #{bad_id}", "delete #{bad_id}"])
-  test_list_output(word, k)
+require_relative '../support/command_base'
+require_relative '../../lib/wavefront-cli/savedsearch'
+
+# Ensure 'savedsearch' commands produce the correct API calls.
+#
+class SavedSearchEndToEndTest < EndToEndTest
+  include WavefrontCliTest::List
+  include WavefrontCliTest::Describe
+  include WavefrontCliTest::Delete
+  include WavefrontCliTest::Dump
+  # include WavefrontCliTest::Import
+  include WavefrontCliTest::Search
+
+  private
+
+  def id
+    '4rUipOK3'
+  end
+
+  def invalid_id
+    '__BAD__'
+  end
+
+  def cmd_word
+    'savedsearch'
+  end
+
+  def sdk_class_name
+    'SavedSearch'
+  end
+
+  def friendly_name
+    'saved search'
+  end
 end