wavefront-cli 4.2.1 → 4.3.0

data/spec/wavefront-cli/message_spec.rb

@@ -1,33 +1,76 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-id = 'CLUSTER::IHjNaHM9'
-bad_id = '(>_<)'
-word = 'message'
-
-require_relative '../spec_helper'
-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")
-  cmd_to_call(word, 'list -L 50',
-              path: "/api/v2/#{word}?limit=50&offset=0&unreadOnly=true")
-  cmd_to_call(word, 'list -L 20 -o 8 -a',
-              path: "/api/v2/#{word}?limit=20&offset=8&unreadOnly=false")
-  cmd_to_call(word, 'list -a -o 60',
-              path: "/api/v2/#{word}?limit=100&offset=60&unreadOnly=false")
-  cmd_to_call(word, 'list -a',
-              path: "/api/v2/#{word}?offset=0&limit=100&unreadOnly=false")
-  cmd_to_call(word, 'list -L 50 -a',
-              path: "/api/v2/#{word}?offset=0&limit=50&unreadOnly=false")
-  cmd_to_call(word, "mark #{id}",
-              method: :post, path: "/api/v2/#{word}/#{id}/read")
-  invalid_ids(word, ["mark #{bad_id}"])
+require_relative '../support/command_base'
+require_relative '../../lib/wavefront-cli/message'
+
+# Ensure 'message' commands produce the correct API calls.
+#
+class MessageEndToEndTest < EndToEndTest
+  def test_list
+    quietly do
+      assert_cmd_gets('list',
+                      '/api/v2/message?limit=100&offset=0&unreadOnly=true')
+      assert_cmd_gets('list -l',
+                      '/api/v2/message?limit=100&offset=0&unreadOnly=true')
+    end
+
+    assert_noop('list',
+                'uri: GET https://default.wavefront.com/api/v2/message',
+                'params: ' + {
+                  offset: 0, limit: 100, unreadOnly: true
+                }.to_s)
+
+    assert_abort_on_missing_creds('list')
+  end
+
+  def test_list_offsets
+    quietly do
+      assert_cmd_gets('list --offset 2 --limit 3',
+                      '/api/v2/message?limit=3&offset=2&unreadOnly=true')
+    end
+  end
+
+  def test_list_all
+    quietly do
+      assert_cmd_gets('list -a',
+                      '/api/v2/message?limit=100&offset=0&unreadOnly=false')
+    end
+  end
+
+  def test_read
+    # TODO: add a proper chained test like we have for
+    # MaintenanceWindow#close, when there's some sample data to work
+    # with. i.e. next time Wavefront send me a message
+    assert_cannot_noop("read #{id}")
+    assert_abort_on_missing_creds("read #{id}")
+    assert_usage('read')
+  end
+
+  def test_mark
+    quietly do
+      assert_cmd_posts("mark #{id}", "/api/v2/message/#{id}/read")
+    end
+
+    assert_noop("mark #{id}",
+                'uri: POST https://default.wavefront.com/api/v2/' \
+                "message/#{id}/read",
+                'body: null')
+    assert_abort_on_missing_creds("mark #{id}")
+    assert_usage('mark')
+  end
+
+  private
+
+  def id
+    'CLUSTER::IHjNaHM9'
+  end
+
+  def invalid_id
+    '(>_<)'
+  end
+
+  def cmd_word
+    'message'
+  end
 end

data/spec/wavefront-cli/metric_spec.rb

@@ -1,25 +1,63 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-id = 'dev.cli.test'
-bad_id = '(>_<)'
-word = 'metric'
-
-require_relative '../spec_helper'
-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}",
-              path: "/api/v2/chart/#{word}/detail?m=#{id}&h=ptn1")
-  cmd_to_call(word, "describe -g ptn1 -g ptn2 #{id}",
-              path: "/api/v2/chart/#{word}/detail?m=#{id}&h=ptn1&h=ptn2")
-  cmd_to_call(word, "describe -g ptn1 -g ptn2 -o 10 #{id}",
-              path: "/api/v2/chart/#{word}/detail?m=#{id}&h=ptn1&h=ptn2&c=10")
-
-  invalid_ids(word, ["describe #{bad_id}"])
+require_relative '../support/command_base'
+require_relative '../../lib/wavefront-cli/metric'
+
+# Ensure 'metric' commands produce the correct API calls.
+#
+class MetricEndToEndTest < EndToEndTest
+  def test_describe
+    out, err = capture_io do
+      assert_raises(SystemExit) do
+        assert_cmd_gets("describe #{id}",
+                        "/api/v2/chart/metric/detail?m=#{id}")
+      end
+    end
+
+    assert_empty(err)
+    assert_equal("Did not find metric 'dev.cli.test'.", out.strip)
+
+    assert_invalid_id("describe #{invalid_id}")
+    assert_usage('describe')
+    assert_abort_on_missing_creds("describe #{id}")
+  end
+
+  def test_describe_with_globs
+    out, err = capture_io do
+      assert_raises(SystemExit) do
+        assert_cmd_gets("describe -g ptn1 -g ptn2 #{id}",
+                        "/api/v2/chart/metric/detail?m=#{id}&h=ptn1&h=ptn2")
+      end
+    end
+
+    assert_empty(err)
+    assert_equal("Did not find metric 'dev.cli.test'.", out.strip)
+  end
+
+  def test_describe_with_glob_and_offset
+    out, err = capture_io do
+      assert_raises(SystemExit) do
+        assert_cmd_gets("describe -g ptn1 -o 5 #{id}",
+                        "/api/v2/chart/metric/detail?m=#{id}&h=ptn1&c=5")
+      end
+    end
+
+    assert_empty(err)
+    assert_equal("Did not find metric 'dev.cli.test'.", out.strip)
+  end
+
+  private
+
+  def id
+    'dev.cli.test'
+  end
+
+  def invalid_id
+    '(>_<)'
+  end
+
+  def cmd_word
+    'metric'
+  end
 end

data/spec/wavefront-cli/notificant_spec.rb

@@ -1,39 +1,52 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-id = '9wltLtYXsP8Je2kI'
-bad_id = '__bad_id__'
-word = 'notificant'
-
-require_relative '../spec_helper'
-require_relative "../../lib/wavefront-cli/#{word}"
-
-describe "#{word} command" do
-  missing_creds(word, ['list',
-                       "describe #{id}",
-                       'import file',
-                       "delete #{id}",
-                       "test #{id}",
-                       'search name=pattern'])
-  invalid_ids(word, ["describe #{bad_id}",
-                     "delete #{bad_id}",
-                     "test #{bad_id}",
-                     "set #{bad_id} key=value"])
-  list_tests(word)
-  cmd_to_call(word, "describe #{id}", path: "/api/v2/#{word}/#{id}")
-  list_tests(word)
-  search_tests(word, id)
-  noop_tests(word, id)
-  test_list_output(word)
-end
+require_relative '../support/command_base'
+require_relative '../../lib/wavefront-cli/notificant'
+
+# Ensure 'notificant' commands produce the correct API calls.
+#
+class NotificantEndToEndTest < EndToEndTest
+  include WavefrontCliTest::Delete
+  include WavefrontCliTest::Describe
+  include WavefrontCliTest::Dump
+  # include WavefrontCliTest::Import
+  include WavefrontCliTest::List
+  include WavefrontCliTest::Search
+  include WavefrontCliTest::Set
+
+  def test_test
+    assert_repeated_output("Testing notificant '#{id}'.") do
+      assert_cmd_posts("test #{id}", "/api/v2/notificant/test/#{id}")
+    end
+
+    assert_noop("test #{id}",
+                'uri: POST https://default.wavefront.com/api/v2/' \
+                "notificant/test/#{id}", 'body: null')
+    assert_invalid_id("test #{invalid_id}")
+    assert_usage('test')
+    assert_abort_on_missing_creds("test #{id}")
+  end
+
+  private
+
+  def id
+    '9wltLtYXsP8Je2kI'
+  end
+
+  def invalid_id
+    '__BAD__'
+  end
+
+  def cmd_word
+    'notificant'
+  end
 
-class TestNotificantMethods < CliMethodTest
-  def test_import_method
-    import_tester(:notificant,
-                  %i[method title creatorId triggers template],
-                  %i[id])
+  def set_key
+    'title'
   end
 
-  def cliclass
-    WavefrontCli::Notificant
+  def import_fields
+    %i[method title creatorId triggers template]
   end
 end

data/spec/wavefront-cli/opt_handler_spec.rb

@@ -1,6 +1,9 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require_relative '../spec_helper'
+require 'minitest/autorun'
+require_relative '../constants'
+require_relative '../../lib/wavefront-cli/exception'
 require_relative '../../lib/wavefront-cli/opt_handler'
 
 # Some of these tests will be skipped if you have a ~/.wavefront

data/spec/wavefront-cli/output/csv/query_spec.rb

@@ -1,6 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require_relative '../../../spec_helper'
+require 'minitest/autorun'
+require_relative '../helpers'
 require_relative '../../../../lib/wavefront-cli/output/csv/query'
 
 # Test CSV output
@@ -59,35 +61,35 @@ class WavefrontOutputCsvTest < MiniTest::Test
   def test_map_row_to_csv
     assert_equal(',,,,,,,,,,', wfq.map_row_to_csv(merp: 1))
     assert_equal('test.path,1,1544529523,testsource,,"unit test",,,,,',
-                 wfq.map_row_to_csv(path:        'test.path',
-                                    value:       1,
-                                    timestamp:   1_544_529_523,
-                                    source:      'testsource',
+                 wfq.map_row_to_csv(path: 'test.path',
+                                    value: 1,
+                                    timestamp: 1_544_529_523,
+                                    source: 'testsource',
                                     environment: 'unit test'))
     assert_equal('"test.path","1","1544529523","testsource",,"unit test",,,,,',
-                 wfqq.map_row_to_csv(path:        'test.path',
-                                     value:       1,
-                                     timestamp:   1_544_529_523,
-                                     source:      'testsource',
+                 wfqq.map_row_to_csv(path: 'test.path',
+                                     value: 1,
+                                     timestamp: 1_544_529_523,
+                                     source: 'testsource',
                                      environment: 'unit test'))
   end
 
   def test_csv_format
-    assert_equal({ path:        'test.path',
-                   value:       1,
-                   timestamp:   1_544_529_523,
-                   source:      'testsource',
+    assert_equal({ path: 'test.path',
+                   value: 1,
+                   timestamp: 1_544_529_523,
+                   source: 'testsource',
                    environment: 'test',
-                   dc:          'travis' },
+                   dc: 'travis' },
                  wfq.csv_format('test.path', 1, 1_544_529_523, 'testsource',
                                 environment: 'test', dc: 'travis'))
 
-    assert_equal({ path:        'test.path',
-                   value:       1,
-                   timestamp:   1_544_529_523,
-                   source:      'testsource',
+    assert_equal({ path: 'test.path',
+                   value: 1,
+                   timestamp: 1_544_529_523,
+                   source: 'testsource',
                    environment: 'environment=test',
-                   dc:          'dc=travis' },
+                   dc: 'dc=travis' },
                  wft.csv_format('test.path', 1, 1_544_529_523, 'testsource',
                                 environment: 'test', dc: 'travis'))
   end

data/spec/wavefront-cli/output/csv_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/csv'
 
 # Test the CSV instantiation of the base class
@@ -35,7 +38,7 @@ class CsvOutputBaseTest < MiniTest::Test
       assert klass.respond_to?(:run)
     end
 
-    (CMDS - supported_commands).each do |cmd|
+    (SupportedCommands.new.all - supported_commands).each do |cmd|
       wfo = WavefrontOutput::Csv.new(load_query_response, class: cmd)
       assert_raises(LoadError) { wfo.command_class }
     end

data/spec/wavefront-cli/output/hcl_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/hcl'
 
 # Test HCL stuff
@@ -35,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::Hcl.new(load_query_response, class: cmd)
       assert_raises(LoadError) { wfo.command_class }
     end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'json'
+require_relative '../../constants'
+
+# Load in a canned query response
+#
+def load_query_response
+  load_file('sample_query_response.json')
+end
+
+def load_raw_query_response
+  load_file('sample_raw_query_response.json')
+end
+
+def load_file(file)
+  JSON.parse(IO.read(RES_DIR + file), symbolize_names: true)
+end

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

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

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

@@ -1,6 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require_relative '../../spec_helper'
+require 'minitest/autorun'
+require_relative 'helpers'
 require_relative '../../../lib/wavefront-cli/output/ruby'
 
 # We can't really test this without `eval`-ing the output, and

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

@@ -1,6 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require_relative '../../../spec_helper'
+require 'minitest/autorun'
+require_relative '../helpers'
 require_relative '../../../../lib/wavefront-cli/output/wavefront/query'
 
 # Test Wavefront wire-format output