wavefront-cli 8.3.0 → 8.5.1

data/spec/wavefront-cli/controller_spec.rb

@@ -22,6 +22,18 @@ class WavefrontCliHelpTest < MiniTest::Test
     assert_match(/^  \w+ --help$/, e.message)
   end
 
+  def test_commands_no_args
+    SupportedCommands.new.all.each do |cmd|
+      _test_command_no_args(cmd)
+    end
+  end
+
+  def _test_command_no_args(cmd)
+    capture_io { WavefrontCliController.new([cmd]) }
+  rescue SystemExit => e
+    assert e.message.end_with?("wf #{cmd} --help")
+  end
+
   def test_version
     capture_io { WavefrontCliController.new(%w[--version]) }
   rescue SystemExit => e
@@ -40,6 +52,7 @@ class WavefrontCliHelpTest < MiniTest::Test
     end
   end
 
+  # rubocop:disable Style/RedundantBegin
   def test_command_help
     SupportedCommands.new.all.each do |cmd|
       begin
@@ -54,6 +67,7 @@ class WavefrontCliHelpTest < MiniTest::Test
       end
     end
   end
+  # rubocop:enable Style/RedundantBegin
 
   def test_malformed_config
     capture_io do

data/spec/wavefront-cli/event_spec.rb

@@ -3,6 +3,7 @@
 
 require 'tmpdir'
 require_relative '../support/command_base'
+require_relative '../test_mixins/tag'
 require_relative '../../lib/wavefront-cli/event'
 require 'wavefront-sdk/support/mixins'
 
@@ -15,12 +16,11 @@ class EventEndToEndTest < EndToEndTest
   attr_reader :test_state_dir
 
   include Wavefront::Mixins
-  include WavefrontCliTest::Describe
-  include WavefrontCliTest::Delete
-  # Ones above work, ones below don't
+  # include WavefrontCliTest::Describe
+  # include WavefrontCliTest::Delete
   # include WavefrontCliTest::Search
-  # include WavefrontCliTest::Set
-  # include WavefrontCliTest::Tags
+  # #include WavefrontCliTest::Set
+  # include WavefrontCliTest::Tag
 
   def before_setup
     @test_state_dir = Pathname.new(Dir.mktmpdir)
@@ -31,11 +31,6 @@ class EventEndToEndTest < EndToEndTest
     FileUtils.rm_r(test_state_dir)
   end
 
-  def cmd_instance
-    cmd_class.new(event_state_dir: TEST_EVENT_DIR)
-    puts cmd_class
-  end
-
   def test_list_no_options
     str = '/api/v2/event\?' \
           'earliestStartTimeEpochMillis=\d{13}+&' \
@@ -65,6 +60,22 @@ class EventEndToEndTest < EndToEndTest
     end
   end
 
+  def test_show_with_no_local_events
+    assert_exits_with('No locally recorded events.', 'show')
+  end
+
+  def test_show
+    setup_test_state_dir
+
+    out, err = capture_io do
+      assert_raises(SystemExit) { wf.new("event show -c #{CF}".split) }
+    end
+
+    assert_empty(err)
+    assert_equal("1568133440530:ev3:0\n1568133440520:ev2:0\n" \
+                 "1568133440515:ev1:1\n1568133440510:ev1:0\n", out)
+  end
+
   def test_create
     mock_id = "#{start_time}:#{event_name}:1"
     state_file = state_dir + mock_id
@@ -100,8 +111,8 @@ class EventEndToEndTest < EndToEndTest
     refute state_file.exist?
 
     out, err = capture_io do
-      assert_cmd_posts('create -d reason -H host1 -H host2 -g ' \
-                       "mytag #{event_name}",
+      assert_cmd_posts('create -d reason -H host1 -H host2 -g mytag ' \
+                       "#{event_name}",
                        '/api/v2/event',
                        { name: event_name,
                          startTime: a_ms_timestamp,
@@ -148,15 +159,6 @@ class EventEndToEndTest < EndToEndTest
     assert_match(/\ntags          tag1\n              tag2\n/, out)
   end
 
-  def test_close_named_event
-    quietly do
-      assert_cmd_posts('close 1568133440520:ev2:0',
-                       '/api/v2/event/1568133440520:ev2:0/close')
-    end
-
-    assert_abort_on_missing_creds("close #{id}")
-  end
-
   def test_close_with_no_local_events
     quietly { assert_cmd_posts("close #{id}", "/api/v2/event/#{id}/close") }
     assert_exits_with('No locally recorded events.', 'close')
@@ -212,26 +214,47 @@ class EventEndToEndTest < EndToEndTest
     end
   end
 
-  def test_show
-    setup_test_state_dir
+  def test_window_start
+    wfse = WavefrontCli::Event.new(start: wall_time[0], end: wall_time[1])
+    assert_kind_of(Numeric, wfse.window_start)
+    assert_equal(epoch_ms_time[0], wfse.window_start)
+  end
 
-    out, err = capture_io do
-      assert_raises(SystemExit) { wf.new("event show -c #{CF}".split) }
-    end
+  def test_window_end
+    wfse = WavefrontCli::Event.new(start: wall_time[0], end: wall_time[1])
+    assert_kind_of(Numeric, wfse.window_end)
+    assert_equal(epoch_ms_time[1], wfse.window_end)
+  end
 
-    assert_empty(err)
-    assert_equal("1568133440530:ev3:0\n1568133440520:ev2:0\n" \
-                 "1568133440515:ev1:1\n1568133440510:ev1:0\n", out)
+  def test_list_args_defaults
+    wfe = WavefrontCli::Event.new({})
+    x = wfe.list_args
+    assert_instance_of(Array, x)
+    assert_equal(4, x.size)
+    assert_in_delta(((Time.now - 600).to_i * 1000), x[0], 1000)
+    assert_in_delta((Time.now.to_i * 1000), x[1], 1000)
+    assert_equal(100, x[2])
+    assert_nil(x[3])
+  end
+
+  def test_list_args_options
+    wfse = WavefrontCli::Event.new(limit: 55,
+                                   start: wall_time[0],
+                                   cursor: id,
+                                   end: wall_time[1])
+    x = wfse.list_args
+    assert_instance_of(Array, x)
+    assert_equal(4, x.size)
+    assert_equal(epoch_ms_time[0], x[0])
+    assert_equal(epoch_ms_time[1], x[1])
+    assert_equal(55, x[2])
+    assert_equal(id, x[3])
   end
 
   private
 
   def id
-    '1481553823153:testev'
-  end
-
-  def event_name
-    'test_event'
+    '1481553823153:testev:0'
   end
 
   def invalid_id
@@ -242,18 +265,24 @@ class EventEndToEndTest < EndToEndTest
     'event'
   end
 
+  def event_name
+    'test_event'
+  end
+
   def start_time
     1_481_553_823_153
   end
 
-  def import_fields
-    %i[method title creatorId triggers template]
+  def epoch_ms_time
+    wall_time.map { |t| (t.to_i * 1000) }
   end
 
   def state_dir
     test_state_dir + (Etc.getlogin || 'notty')
   end
 
+  # Puts some test events in the state directory
+  #
   def setup_test_state_dir
     FileUtils.mkdir_p(state_dir)
 
@@ -285,79 +314,10 @@ class EventEndToEndTest < EndToEndTest
                  "https://#{perm[:endpoint]}/api/v2/event/#{mock_id}/close")
       .with(body: 'null')
   end
-end
-
-# Unit tests for class methods
-#
-class EventMethodTests < Minitest::Test
-  attr_reader :wf, :wfse
-
-  def setup
-    @wf = WavefrontCli::Event.new({})
-    @wfse = WavefrontCli::Event.new(start: wall_time[0],
-                                    end: wall_time[1],
-                                    limit: 55,
-                                    cursor: '1481553823153:testev')
-  end
-
-  def test_create_dir_ok
-    base = Pathname.new(Dir.mktmpdir)
-    dir = base + 'testdir'
-    refute dir.exist?
-    wf.create_dir(dir)
-    assert dir.exist?
-    dir.unlink
-    base.unlink
-  end
-
-  def test_create_dir_fail
-    spy = Spy.on(FileUtils, :mkdir_p).and_return(false)
-
-    assert_raises(WavefrontCli::Exception::SystemError) do
-      wf.create_dir(Pathname.new('/any/old/directory'))
-    end
-
-    assert spy.has_been_called?
-    spy.unhook
-  end
-
-  def test_list_args_defaults
-    x = wf.list_args
-    assert_instance_of(Array, x)
-    assert_equal(4, x.size)
-    assert_in_delta(((Time.now - 600).to_i * 1000), x[0], 1000)
-    assert_in_delta((Time.now.to_i * 1000), x[1], 1000)
-    assert_equal(100, x[2])
-    assert_nil(x[3])
-  end
-
-  def test_list_args_options
-    x = wfse.list_args
-    assert_instance_of(Array, x)
-    assert_equal(4, x.size)
-    assert_equal(epoch_ms_time[0], x[0])
-    assert_equal(epoch_ms_time[1], x[1])
-    assert_equal(55, x[2])
-    assert_equal('1481553823153:testev', x[3])
-  end
-
-  def test_window_start
-    assert_kind_of(Numeric, wf.window_start)
-    assert_equal(epoch_ms_time[0], wfse.window_start)
-  end
-
-  def test_window_end
-    assert_kind_of(Numeric, wf.window_end)
-    assert_equal(epoch_ms_time[1], wfse.window_end)
-  end
 
-  private
-
-  def wall_time
-    [Time.at(1_568_112_000), Time.at(1_568_112_999)]
-  end
-
-  def epoch_ms_time
-    wall_time.map { |t| (t.to_i * 1000) }
+  # Event searching uses a cursor, not an offset
+  #
+  def cannot_handle_offsets
+    true
   end
 end

data/spec/wavefront-cli/event_store_spec.rb

@@ -0,0 +1,186 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'pathname'
+require 'spy'
+require 'minitest/autorun'
+require_relative '../../lib/wavefront-cli/event_store'
+
+TEST_EVENT_STORE_DIR = Pathname.new(Dir.mktmpdir)
+
+# Tests for event store class. This is tested well via the interface of the
+# events CLI class.
+#
+class Test < MiniTest::Test
+  attr_reader :wf
+
+  include WavefrontCli::Constants
+
+  def before_setup
+    FileUtils.mkdir_p(TEST_EVENT_STORE_DIR)
+  end
+
+  def setup
+    @wf = WavefrontCli::EventStore.new({}, TEST_EVENT_STORE_DIR)
+  end
+
+  def teardown
+    FileUtils.rm_r(TEST_EVENT_STORE_DIR)
+  end
+
+  def test_state_file_needed?
+    wf1 = WavefrontCli::EventStore.new({}, TEST_EVENT_STORE_DIR)
+    assert wf1.state_file_needed?
+
+    wf2 = WavefrontCli::EventStore.new({ nostate: true }, TEST_EVENT_STORE_DIR)
+    refute wf2.state_file_needed?
+
+    wf3 = WavefrontCli::EventStore.new({ instant: true }, TEST_EVENT_STORE_DIR)
+    refute wf3.state_file_needed?
+
+    wf4 = WavefrontCli::EventStore.new({ start: Time.now - 20, end: Time.now },
+                                       TEST_EVENT_STORE_DIR)
+    refute wf4.state_file_needed?
+  end
+
+  def test_event_file
+    x = wf.event_file(id)
+    assert_instance_of(Pathname, x)
+    assert_equal(wf.dir, x.dirname)
+    assert_equal(id, x.basename.to_s)
+
+    assert_nil(wf.event_file('not_a_valid_id'))
+  end
+
+  def test_create_dir_ok
+    dir = TEST_EVENT_STORE_DIR + 'testdir'
+    refute dir.exist?
+    wf.create_dir(dir)
+    assert dir.exist?
+    dir.unlink
+  end
+
+  def test_list
+    setup_test_state_dir
+
+    x = wf.list
+    assert(x.all? { |e| e.is_a?(Pathname) })
+    assert_equal(4, x.size)
+
+    empty_test_state_dir
+  end
+
+  def test_list_empty_stack
+    out, err = capture_io { assert_raises(SystemExit) { wf.list } }
+    assert_empty(out)
+    assert_equal("No locally recorded events.\n", err)
+  end
+
+  def test_pop_event
+    setup_test_state_dir
+
+    assert (wf.dir + '1568133440530:ev3:0').exist?
+    assert_equal('1568133440530:ev3:0', wf.pop_event!)
+    refute (wf.dir + '1568133440530:ev3:0').exist?
+
+    empty_test_state_dir
+  end
+
+  def test_pop_event_named
+    setup_test_state_dir
+
+    assert (wf.dir + '1568133440515:ev1:1').exist?
+    assert_equal('1568133440515:ev1:1', wf.pop_event!('ev1'))
+    refute (wf.dir + '1568133440515:ev1:1').exist?
+
+    empty_test_state_dir
+  end
+
+  def test_event_specific
+    setup_test_state_dir
+
+    assert (wf.dir + '1568133440515:ev1:1').exist?
+    assert_equal('1568133440515:ev1:1', wf.event('1568133440515:ev1:1'))
+    assert (wf.dir + '1568133440515:ev1:1').exist?
+
+    empty_test_state_dir
+  end
+
+  def test_pop_event_empty_stack
+    out, err = capture_io { assert_raises(SystemExit) { wf.pop_event! } }
+    assert_empty(out)
+    assert_equal("No locally recorded events.\n", err)
+  end
+
+  def test_event_state_dir
+    ENV['WF_EVENT_STATE_DIR'] = nil
+    assert_equal(EVENT_STATE_DIR, wf.event_state_dir)
+
+    ENV['WF_EVENT_STATE_DIR'] = '/tmp/tester'
+    assert_equal(Pathname.new('/tmp/tester'), wf.event_state_dir)
+    ENV['WF_EVENT_STATE_DIR'] = nil
+
+    assert_equal(Pathname.new('/tmp/mydir'), wf.event_state_dir('/tmp/mydir'))
+  end
+
+  def test_create_dir_fail
+    spy = Spy.on(FileUtils, :mkdir_p).and_return(false)
+
+    assert_raises(WavefrontCli::Exception::SystemError) do
+      wf.create_dir(Pathname.new('/any/old/directory'))
+    end
+
+    assert spy.has_been_called?
+    spy.unhook
+  end
+
+  def test_event_file_data
+    wf = WavefrontCli::EventStore.new({ desc: 'test event' },
+                                      TEST_EVENT_STORE_DIR)
+    x = wf.event_file_data
+    assert_instance_of(String, x)
+    y = JSON.parse(x, symbolize_names: true)
+    assert_equal('test event', y[:description])
+    assert_equal(%i[hosts description severity tags], y.keys)
+    assert_nil(y[:tags])
+  end
+
+  def test_create
+    refute (wf.dir + id).exist?
+    out, err = capture_io { wf.create!(id) }
+    assert_match(/Event state recorded at .*1481553823153:testev:0./, out)
+    assert_empty(err)
+    assert (wf.dir + id).exist?
+  end
+
+  def test_create_with_nostate
+    wf1 = WavefrontCli::EventStore.new(nostate: true)
+    assert_nil wf1.create!(id)
+  end
+
+  private
+
+  def id
+    '1481553823153:testev:0'
+  end
+
+  def dummy_event_files
+    %w[1568133440510:ev1:0
+       1568133440515:ev1:1
+       1568133440520:ev2:0
+       1568133440530:ev3:0]
+  end
+
+  def setup_test_state_dir
+    dummy_event_files.each do |f|
+      File.open(wf.dir + f, 'w') { |fh| fh.puts('dummy_data') }
+    end
+  end
+
+  def empty_test_state_dir
+    dummy_event_files.each do |f|
+      file = wf.dir + f
+      FileUtils.rm(file) if file.exist?
+    end
+  end
+end