wavefront-cli 8.2.0 → 8.5.0

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

data/spec/wavefront-cli/proxy_spec.rb

@@ -36,6 +36,19 @@ class ProxyEndToEndTest < EndToEndTest
     assert_abort_on_missing_creds("rename #{id} newname")
   end
 
+  def test_shutdown
+    assert_output("Requested shutdown of proxy '#{id}'.\n") do
+      assert_cmd_puts("shutdown #{id}", "/api/v2/proxy/#{id}",
+                      { shutdown: true }.to_json)
+    end
+
+    assert_noop("shutdown #{id}",
+                "uri: PUT https://default.wavefront.com/api/v2/proxy/#{id}",
+                'body: {"shutdown":true}')
+    assert_invalid_id("shutdown #{invalid_id}")
+    assert_abort_on_missing_creds("shutdown #{id}")
+  end
+
   private
 
   def id

data/spec/wavefront-cli/serviceaccount_spec.rb

@@ -41,20 +41,36 @@ class ServiceAccountEndToEndTest < EndToEndTest
     assert_abort_on_missing_creds("groups #{id}")
   end
 
-  def test_permissions
+  def test_roles
     quietly do
-      assert_cmd_gets("permissions #{id}", "/api/v2/#{api_path}/#{id}")
+      assert_cmd_gets("roles #{id}", "/api/v2/#{api_path}/#{id}")
     end
 
-    assert_invalid_id("permissions #{invalid_id}")
-    assert_usage('permissions')
+    assert_invalid_id("roles #{invalid_id}")
+    assert_usage('roles')
 
     assert_noop(
-      "permissions #{id}",
+      "roles #{id}",
       "uri: GET https://default.wavefront.com/api/v2/#{api_path}/#{id}"
     )
 
-    assert_abort_on_missing_creds("permissions #{id}")
+    assert_abort_on_missing_creds("roles #{id}")
+  end
+
+  def test_ingestionpolicy
+    quietly do
+      assert_cmd_gets("ingestionpolicy #{id}", "/api/v2/#{api_path}/#{id}")
+    end
+
+    assert_invalid_id("ingestionpolicy #{invalid_id}")
+    assert_usage('ingestionpolicy')
+
+    assert_noop(
+      "ingestionpolicy #{id}",
+      "uri: GET https://default.wavefront.com/api/v2/#{api_path}/#{id}"
+    )
+
+    assert_abort_on_missing_creds("ingestionpolicy #{id}")
   end
 
   def test_activate
@@ -85,7 +101,7 @@ class ServiceAccountEndToEndTest < EndToEndTest
                        '/api/v2/account/serviceaccount',
                        identifier: id,
                        active: true,
-                       groups: [],
+                       roles: [],
                        tokens: [],
                        userGroups: [])
     end
@@ -95,8 +111,8 @@ class ServiceAccountEndToEndTest < EndToEndTest
       'uri: POST https://default.wavefront.com/api/v2/account/serviceaccount',
       'body: ' + { identifier: id,
                    active: true,
-                   groups: [],
                    tokens: [],
+                   roles: [],
                    userGroups: [] }.to_json
     )
 
@@ -111,43 +127,56 @@ class ServiceAccountEndToEndTest < EndToEndTest
                        identifier: id,
                        description: 'words',
                        active: false,
-                       groups: [],
+                       roles: [],
                        tokens: [],
                        userGroups: [])
     end
   end
 
-  def test_create_account_in_usergroups
+  def test_create_account_with_usergroups
     quietly do
       assert_cmd_posts("create -g #{usergroups[0]} -g #{usergroups[1]} #{id}",
                        '/api/v2/account/serviceaccount',
                        identifier: id,
                        active: true,
-                       groups: [],
                        tokens: [],
+                       roles: [],
                        userGroups: usergroups)
     end
   end
 
+  def test_create_account_with_roles
+    quietly do
+      assert_cmd_posts("create -r #{roles[0]} -r #{roles[1]} #{id}",
+                       '/api/v2/account/serviceaccount',
+                       identifier: id,
+                       active: true,
+                       tokens: [],
+                       roles: roles,
+                       userGroups: [])
+    end
+  end
+
   def test_create_account_with_tokens
     quietly do
       assert_cmd_posts("create -k #{tokens[0]} -k #{tokens[1]} #{id}",
                        '/api/v2/account/serviceaccount',
                        identifier: id,
                        active: true,
-                       groups: [],
                        tokens: tokens,
+                       roles: [],
                        userGroups: [])
     end
   end
 
-  def test_create_account_with_permissions
+  def test_create_account_with_ingestion_policy
     quietly do
-      assert_cmd_posts("create -p #{permissions[0]} -p #{permissions[1]} #{id}",
+      assert_cmd_posts("create -p #{ingestion_policy} #{id}",
                        '/api/v2/account/serviceaccount',
                        identifier: id,
                        active: true,
-                       groups: permissions,
+                       ingestionPolicyId: ingestion_policy,
+                       roles: [],
                        tokens: [],
                        userGroups: [])
     end
@@ -158,8 +187,8 @@ class ServiceAccountEndToEndTest < EndToEndTest
                       "create -g abcdefg #{id}")
   end
 
-  def test_create_invalid_permission
-    assert_exits_with("'123456' is not a valid Wavefront permission.",
+  def test_create_invalid_ingestion_policy
+    assert_exits_with("'123456' is not a valid ingestion policy ID.",
                       "create -p 123456 #{id}")
   end
 
@@ -358,8 +387,9 @@ class ServiceAccountEndToEndTest < EndToEndTest
     'service account'
   end
 
-  def permissions
-    %w[alerts_management events_management]
+  def roles
+    %w[07fc5cdd-0979-489e-8f70-325f39d15e55
+       0a42adf6-e738-4c5d-9e53-fd10bd979a31]
   end
 
   def tokens
@@ -372,6 +402,10 @@ class ServiceAccountEndToEndTest < EndToEndTest
        abcdef12-1234-abcd-1234-abcdef012345]
   end
 
+  def ingestion_policy
+    'test-policy-1607616352537'
+  end
+
   def import_fields
     %i[identifier description active tokens groups userGroups]
   end

data/wavefront-cli.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency 'docopt', '~> 0.6.0'
   gem.add_runtime_dependency 'inifile', '~> 3.0'
-  gem.add_runtime_dependency 'wavefront-sdk', '~> 5.2'
+  gem.add_runtime_dependency 'wavefront-sdk', '~> 5.4', '>= 5.4.2'
 
   gem.add_development_dependency 'minitest', '~> 5.14'
   gem.add_development_dependency 'rake', '~> 13.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-cli
 version: !ruby/object:Gem::Version
-  version: 8.2.0
+  version: 8.5.0
 platform: ruby
 authors:
 - Robert Fisher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-06 00:00:00.000000000 Z
+date: 2021-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt
@@ -44,14 +44,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.4.2
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -226,6 +232,7 @@ files:
 - lib/wavefront-cli/display/webhook.rb
 - lib/wavefront-cli/display/write.rb
 - lib/wavefront-cli/event.rb
+- lib/wavefront-cli/event_store.rb
 - lib/wavefront-cli/exception.rb
 - lib/wavefront-cli/exception_handler.rb
 - lib/wavefront-cli/externallink.rb
@@ -316,6 +323,7 @@ files:
 - spec/wavefront-cli/display/printer/long_spec.rb
 - spec/wavefront-cli/display/printer/terse_spec.rb
 - spec/wavefront-cli/event_spec.rb
+- spec/wavefront-cli/event_store_spec.rb
 - spec/wavefront-cli/externallink_spec.rb
 - spec/wavefront-cli/integration_spec.rb
 - spec/wavefront-cli/maintenancewindow_spec.rb
@@ -455,6 +463,7 @@ test_files:
 - spec/wavefront-cli/display/printer/long_spec.rb
 - spec/wavefront-cli/display/printer/terse_spec.rb
 - spec/wavefront-cli/event_spec.rb
+- spec/wavefront-cli/event_store_spec.rb
 - spec/wavefront-cli/externallink_spec.rb
 - spec/wavefront-cli/integration_spec.rb
 - spec/wavefront-cli/maintenancewindow_spec.rb