wavefront-sdk 3.7.0 → 5.1.0

data/spec/wavefront-sdk/core/api_caller_spec.rb

@@ -37,6 +37,49 @@ class WavefrontApiCallerTest < MiniTest::Test
     assert_requested(:get, uri, headers: headers)
   end
 
+  def test_get_flat_params
+    query = { rkey: %w[val1 val2 val3], ukey: 36 }
+    uri = "#{uri_base}/path?rkey=val1&rkey=val2&rkey=val3&ukey=36"
+    stub_request(:get, uri).to_return(body: DUMMY_RESPONSE, status: 200)
+    wf.get_flat_params('/path', query)
+    assert_requested(:get, uri, headers: headers)
+  end
+
+  def test_get_stream
+    uri = "#{uri_base}/path?key1=val1"
+    stub_request(:get, uri).to_return(body: DUMMY_RESPONSE, status: 200)
+    out, err = capture_io { wf.get_stream('/path', key1: 'val1') }
+    assert_requested(:get, uri, headers: headers)
+    assert_equal(out.strip, DUMMY_RESPONSE)
+    assert_empty(err)
+  end
+
+  def test_get_stream_array_params
+    uri = "#{uri_base}/path?key=val1&key=val2"
+    stub_request(:get, uri).to_return(body: DUMMY_RESPONSE, status: 200)
+    out, err = capture_io { wf.get_stream('/path', key: %w[val1 val2]) }
+    assert_requested(:get, uri, headers: headers)
+    assert_equal(out.strip, DUMMY_RESPONSE)
+    assert_empty(err)
+  end
+
+  def test_get_stream_timestamp
+    uri = "#{uri_base}/path?key1=val1"
+    stub_request(:get, uri).to_return(body: DUMMY_RESPONSE, status: 200)
+
+    out, err = capture_io do
+      wf.get_stream('/path',
+                    { key1: 'val1' },
+                    timestamp_chunks: true)
+    end
+
+    assert_requested(:get, uri, headers: headers)
+    out_lines = out.split("\n")
+    assert_match(/^\d{4}-\d\d-\d\d \d\d:\d\d:\d\d \+\d{4}$/, out_lines[0])
+    assert_equal(out_lines[1], DUMMY_RESPONSE)
+    assert_empty(err)
+  end
+
   def test_post
     uri = "#{uri_base}/path"
     obj = { key: 'value' }

data/spec/wavefront-sdk/metric_helper_spec.rb

@@ -118,7 +118,7 @@ class WavefrontMetricHelperTest < MiniTest::Test
     assert_equal(1, out.select do |o|
                       o[:value] == [[2, 10.0], [1, 11.0],
                                     [1, 12.0]]
-                    end .size)
+                    end.size)
     assert_equal(1, out.select { |o| o[:tags] == WH_TAGS }.size)
     assert_equal(3, out.select { |o| o[:path] == 'test.dist1' }.size)
   end

data/spec/wavefront-sdk/role_spec.rb

@@ -0,0 +1,96 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../spec_helper'
+require_relative '../test_mixins/general'
+
+# Unit tests for Wavefront::Role
+#
+class WavefrontRoleTest < WavefrontTestBase
+  include WavefrontTest::Create
+  include WavefrontTest::Delete
+  include WavefrontTest::Describe
+  include WavefrontTest::List
+  include WavefrontTest::Update
+
+  def test_add_assignees
+    assert_posts("/api/v2/role/#{id}/addAssignees", assignees.to_json) do
+      wf.add_assignees(id, assignees)
+    end
+
+    assert_raises(Wavefront::Exception::InvalidRoleId) do
+      wf.add_assignees(invalid_id, assignees)
+    end
+  end
+
+  def test_remove_assignees
+    assert_posts("/api/v2/role/#{id}/removeAssignees", assignees.to_json) do
+      wf.remove_assignees(id, assignees)
+    end
+
+    assert_raises(Wavefront::Exception::InvalidRoleId) do
+      wf.remove_assignees(invalid_id, assignees)
+    end
+  end
+
+  def test_grant
+    assert_posts("/api/v2/role/grant/#{permission}", roles.to_json) do
+      wf.grant(permission, roles)
+    end
+
+    assert_raises(Wavefront::Exception::InvalidRoleId) do
+      wf.grant(permission, [invalid_id])
+    end
+
+    assert_raises(Wavefront::Exception::InvalidPermission) do
+      wf.grant('made_up_permission', roles)
+    end
+  end
+
+  def test_revoke
+    assert_posts("/api/v2/role/revoke/#{permission}", roles.to_json) do
+      wf.revoke(permission, roles)
+    end
+
+    assert_raises(Wavefront::Exception::InvalidRoleId) do
+      wf.revoke(permission, [invalid_id])
+    end
+
+    assert_raises(Wavefront::Exception::InvalidPermission) do
+      wf.revoke('made_up_permission', roles)
+    end
+  end
+
+  private
+
+  def api_class
+    :role
+  end
+
+  def id
+    'f8dc0c14-91a0-4ca9-8a2a-7d47f4db4672'
+  end
+
+  def roles
+    %w[f8dc0c14-91a0-4ca9-8a2a-7d47f4db4672
+       2659191e-aad4-4302-a94e-9667e1517127]
+  end
+
+  def assignees
+    roles.push('sa::test')
+  end
+
+  def invalid_id
+    '__BAD_ID__'
+  end
+
+  def payload
+    { name: 'test role',
+      permissions: %w[alerts_management events_management],
+      description: 'dummy role for unit tests' }
+  end
+
+  def permission
+    'alerts_management'
+  end
+end

data/spec/wavefront-sdk/spy_spec.rb

@@ -0,0 +1,113 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../spec_helper'
+require_relative '../../lib/wavefront-sdk/spy'
+
+# Unit tests for Spy class
+#
+class WavefrontSpyTest < MiniTest::Test
+  attr_reader :wf
+
+  def setup
+    @wf = Wavefront::Spy.new(CREDS)
+  end
+
+  def test_points
+    capture_io do
+      assert_gets('/api/spy/points?sampling=0.01') { wf.points }
+      assert_gets('/api/spy/points?sampling=0.05') { wf.points(0.05) }
+
+      assert_gets('/api/spy/points?sampling=0.05&metric=my_prefix') do
+        wf.points(0.05, prefix: 'my_prefix')
+      end
+
+      assert_gets('/api/spy/points?sampling=0.05&metric=my_prefix&host=h1') do
+        wf.points(0.05, prefix: 'my_prefix', host: 'h1')
+      end
+
+      assert_gets('/api/spy/points?sampling=0.02&metric=my_prefix&' \
+                  'pointTagKey=mytag') do
+        wf.points(0.02, prefix: 'my_prefix', tag_key: 'mytag')
+      end
+
+      assert_gets('/api/spy/points?sampling=0.02&metric=my_prefix&' \
+                  'pointTagKey=tag1&pointTagKey=tag2') do
+        wf.points(0.02, prefix: 'my_prefix', tag_key: %w[tag1 tag2])
+      end
+    end
+  end
+
+  def test_histograms
+    capture_io do
+      assert_gets('/api/spy/histograms?sampling=0.01') { wf.histograms }
+      assert_gets('/api/spy/histograms?sampling=0.05') { wf.histograms(0.05) }
+
+      assert_gets('/api/spy/histograms?sampling=0.05&histogram=my_prefix') do
+        wf.histograms(0.05, prefix: 'my_prefix')
+      end
+
+      assert_gets(
+        '/api/spy/histograms?sampling=0.05&histogram=my_prefix&host=h1'
+      ) do
+        wf.histograms(0.05, prefix: 'my_prefix', host: 'h1')
+      end
+
+      assert_gets('/api/spy/histograms?sampling=0.02&histogram=my_prefix&' \
+                  'histogramTagKey=the_tag') do
+        wf.histograms(0.02, prefix: 'my_prefix', tag_key: 'the_tag')
+      end
+
+      assert_gets('/api/spy/histograms?sampling=0.02&histogram=my_prefix&' \
+                  'histogramTagKey=tag1&histogramTagKey=tag2') do
+        wf.histograms(0.02, prefix: 'my_prefix', tag_key: %w[tag1 tag2])
+      end
+    end
+  end
+
+  def test_spans
+    capture_io do
+      assert_gets('/api/spy/spans?sampling=0.01') { wf.spans }
+      assert_gets('/api/spy/spans?sampling=0.05') { wf.spans(0.05) }
+
+      assert_gets('/api/spy/spans?sampling=0.05&name=my_prefix') do
+        wf.spans(0.05, prefix: 'my_prefix')
+      end
+
+      assert_gets(
+        '/api/spy/spans?sampling=0.05&name=my_prefix&host=h1'
+      ) do
+        wf.spans(0.05, prefix: 'my_prefix', host: 'h1')
+      end
+
+      assert_gets('/api/spy/spans?sampling=0.02&name=my_prefix&' \
+                  'spanTagKey=the_tag') do
+        wf.spans(0.02, prefix: 'my_prefix', tag_key: 'the_tag')
+      end
+
+      assert_gets('/api/spy/spans?sampling=0.02&name=my_prefix&' \
+                  'spanTagKey=tag1&spanTagKey=tag2') do
+        wf.spans(0.02, prefix: 'my_prefix', tag_key: %w[tag1 tag2])
+      end
+    end
+  end
+
+  def test_ids
+    capture_io do
+      assert_gets('/api/spy/ids?sampling=0.01') { wf.ids }
+      assert_gets('/api/spy/ids?sampling=0.05') { wf.ids(0.05) }
+
+      assert_gets('/api/spy/ids?sampling=0.05&type=METRIC') do
+        wf.ids(0.05, type: 'METRIC')
+      end
+
+      assert_gets('/api/spy/ids?sampling=0.05&type=SPAN&name=my_prefix') do
+        wf.ids(0.05, type: 'SPAN', prefix: 'my_prefix')
+      end
+    end
+  end
+
+  def dummy_response
+    DUMMY_RESPONSE
+  end
+end

data/spec/wavefront-sdk/unstable/chart_spec.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../../spec_helper'
+require_relative '../../../lib/wavefront-sdk/unstable/chart'
+
+# Unit tests for Chart class
+#
+class WavefrontChartTest < MiniTest::Test
+  attr_reader :wf
+
+  def setup
+    @wf = Wavefront::Unstable::Chart.new(CREDS)
+  end
+
+  def test_all_metrics
+    assert_gets('/chart/metrics/all?l=100&q=&trie=true') do
+      wf.metrics_under('')
+    end
+  end
+
+  def test_metrics_under
+    assert_gets('/chart/metrics/all?l=100&q=test.path&trie=true') do
+      wf.metrics_under('test.path')
+    end
+
+    assert_gets('/chart/metrics/all?l=10&q=test.path&trie=true') do
+      wf.metrics_under('test.path', nil, 10)
+    end
+
+    assert_gets('/chart/metrics/all?l=100&p=last.one&q=test.path&trie=true') do
+      wf.metrics_under('test.path', 'last.one')
+    end
+  end
+
+  def dummy_response
+    { metrics: ['test data'] }.to_json
+  end
+end

data/spec/wavefront-sdk/user_spec.rb

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require 'logger'
 require_relative '../spec_helper'
 require_relative '../test_mixins/general'
 
@@ -13,6 +14,13 @@ class WavefrontUserTest < WavefrontTestBase
   include WavefrontTest::Describe
   include WavefrontTest::Update
 
+  # Override the parent constructor so we can suppress all the 'deprecated'
+  # log messages
+  #
+  def setup
+    @wf = Wavefront::User.new(CREDS, logger: Logger.new('/dev/null'))
+  end
+
   def test_list
     assert_gets('/api/v2/user') { wf.list }
   end

data/spec/wavefront-sdk/usergroup_spec.rb

@@ -7,7 +7,8 @@ require_relative '../test_mixins/general'
 # Unit tests for WavefrontUserGroup
 #
 class WavefrontUserGroupTest < WavefrontTestBase
-  attr_reader :users, :groups, :permission, :invalid_groups, :invalid_users
+  attr_reader :users, :groups, :permission, :invalid_groups, :invalid_users,
+              :roles, :invalid_roles
 
   include WavefrontTest::Create
   include WavefrontTest::Delete
@@ -39,22 +40,28 @@ class WavefrontUserGroupTest < WavefrontTestBase
     assert_invalid_id { wf.remove_users_from_group(invalid_id, users) }
   end
 
-  def test_grant
-    assert_posts("/api/v2/usergroup/grant/#{permission}",
-                 groups.to_json) do
-      wf.grant(permission, groups)
+  def test_add_roles_to_group
+    assert_posts("/api/v2/usergroup/#{id}/addRoles", roles.to_json) do
+      wf.add_roles_to_group(id, roles)
     end
 
-    assert_invalid_id { wf.grant(permission, invalid_groups) }
+    assert_raises(Wavefront::Exception::InvalidRoleId) do
+      wf.add_roles_to_group(id, invalid_roles)
+    end
+
+    assert_invalid_id { wf.add_roles_to_group(invalid_id, roles) }
   end
 
-  def test_revoke
-    assert_posts("/api/v2/usergroup/revoke/#{permission}",
-                 groups.to_json) do
-      wf.revoke(permission, groups)
+  def test_remove_roles_from_group
+    assert_posts("/api/v2/usergroup/#{id}/removeRoles", roles.to_json) do
+      wf.remove_roles_from_group(id, roles)
+    end
+
+    assert_raises(Wavefront::Exception::InvalidRoleId) do
+      wf.remove_roles_from_group(id, invalid_roles)
     end
 
-    assert_invalid_id { wf.revoke(permission, invalid_groups) }
+    assert_invalid_id { wf.remove_roles_from_group(invalid_id, roles) }
   end
 
   def setup_fixtures
@@ -63,7 +70,10 @@ class WavefrontUserGroupTest < WavefrontTestBase
     @groups = %w[f8dc0c14-91a0-4ca9-8a2a-7d47f4db4672
                  2659191e-aad4-4302-a94e-9667e1517127]
     @users = %w[someone@somewhere.com other@elsewhere.net]
+    @roles = %w[abcdef14-91a0-4ca9-8a2a-7d47f4db4672
+                fedcba1e-aad4-4302-a94e-9667e1517127]
     @invalid_users = ['bad' * 500, '']
+    @invalid_roles = ['some nonsense']
   end
 
   private

data/spec/wavefront-sdk/validators_spec.rb

@@ -386,4 +386,35 @@ class WavefrontValidatorsTest < MiniTest::Test
     bad = ['', [], {}, 'a' * 1000]
     good_and_bad('wf_account_id?', 'InvalidAccountId', good, bad)
   end
+
+  def test_wf_managedcluster_id
+    good = %w[test-cluster other-cluster cluster]
+    bad = ['', [], {}, 'a' * 1000, '£"^WR"!']
+    good_and_bad('wf_monitoredcluster_id?',
+                 'InvalidMonitoredClusterId',
+                 good,
+                 bad)
+  end
+
+  def test_wf_sampling_value
+    good = [0, 0.01, 0.003, 0.05]
+    bad = ['a', 0.1, 0.99, 1, -1, 1.1]
+    good_and_bad('wf_sampling_value?', 'InvalidSamplingValue', good, bad)
+  end
+
+  def test_wf_role_id
+    good = %w[2bfdcac7-1c9c-4c4b-9b56-c41c22c586dc
+              17db4cc1-65f6-40a8-a1fa-6fcae460c4bd
+              fca312fb-5ff4-420d-862d-5d6d99ed6bcf
+              3a1957e0-459e-49e5-9209-3888a4e8ac5b]
+
+    bad = %w[fa312fb-5ff4-420d-862d-5d6d99ed6bcf thing 123]
+    good_and_bad('wf_role_id?', 'InvalidRoleId', good, bad)
+  end
+
+  def test_wf_aws_external_id
+    good = %w[ah5Z9dkr46jbvLtJ HqOM4mru5svd3uFp c1lBxILCBNxLKdx9]
+    bad = %w[h5Z9dkr46jbvLtJ HqOM4mru5svd3uFp3 c!lBx!LC*NxLKdx*]
+    good_and_bad('wf_aws_external_id?', 'InvalidAwsExternalId', good, bad)
+  end
 end

data/wavefront-sdk.gemspec

@@ -23,17 +23,17 @@ Gem::Specification.new do |gem|
   gem.bindir        = 'bin'
 
   gem.add_dependency 'addressable', '~> 2.7'
-  gem.add_dependency 'faraday', '~> 0.17.0'
+  gem.add_dependency 'faraday', '~> 1.0'
   gem.add_dependency 'inifile', '~> 3.0'
   gem.add_dependency 'map', '~> 6.6'
 
   gem.add_development_dependency 'minitest', '~> 5.11'
-  gem.add_development_dependency 'rake', '~> 12.3'
-  gem.add_development_dependency 'rubocop', '~> 0.79'
+  gem.add_development_dependency 'rake', '~> 13.0'
+  gem.add_development_dependency 'rubocop', '= 0.87.1'
   gem.add_development_dependency 'simplecov', '~> 0.16'
   gem.add_development_dependency 'spy', '~> 1.0.0'
   gem.add_development_dependency 'webmock', '~> 3.7'
   gem.add_development_dependency 'yard', '~> 0.9'
 
-  gem.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  gem.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
 end