wavefront-sdk 1.6.0 → 1.6.1

data/lib/wavefront-sdk/version.rb

@@ -1 +1 @@
-WF_SDK_VERSION = '1.6.0'.freeze
+WF_SDK_VERSION = '1.6.1'.freeze

data/lib/wavefront-sdk/write.rb

@@ -26,7 +26,6 @@ module Wavefront
     # Open a socket to a Wavefront proxy, putting the descriptor
     # in instance variable @sock.
     #
-    # rubocop:disable Metrics/MethodLength
     def open
       if opts[:noop]
         log('No-op requested. Not opening connection to proxy.')

data/spec/wavefront-sdk/base_write_spec.rb

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+
+require_relative '../../lib/wavefront-sdk/base_write.rb'
+require_relative '../spec_helper'
+require_relative 'resources/dummy_points'
+
+# rubocop:disable Style/MutableConstant
+WBWT_CREDS = { endpoint: 'stub.wavefront.com', token: 'tkn' }
+# rubocop:enable Style/MutableConstant
+
+class WavefrontBaseWriteTest < MiniTest::Test
+  attr_reader :wf, :wf_tags
+
+  def setup
+    @wf = Wavefront::BaseWrite.new(WBWT_CREDS)
+    # @wf_noop = Wavefront::Write.new(W_CREDS, noop: true)
+    @wf_tags = Wavefront::BaseWrite.new(WBWT_CREDS, tags: TAGS)
+  end
+
+  def test_summary_string
+    assert_equal('OK', wf.summary_string(unsent: 0, rejected: 0))
+    assert_equal('ERROR', wf.summary_string(unsent: 0, rejected: 1))
+    assert_equal('ERROR', wf.summary_string(unsent: 1, rejected: 0))
+  end
+
+  def test_prepped_points
+    assert_equal wf.prepped_points(%w[p1 p2 p3 p4]), %w[p1 p2 p3 p4]
+    assert_equal wf.prepped_points([%w[p1 p2 p3 p4]]), %w[p1 p2 p3 p4]
+    assert_equal wf.prepped_points('p1'), %w[p1]
+    assert_equal wf.prepped_points(
+      [{ path: 'p1' }, { path: 'p2' }, { path: 'p3' }], 'prefix'
+    ),
+                 [{ path: 'prefix.p1' }, { path: 'prefix.p2' },
+                  { path: 'prefix.p3' }]
+
+    assert_equal wf.prepped_points({ path: 'p1' }, 'prefix'),
+                 [{ path: 'prefix.p1' }]
+  end
+
+  def test_paths_to_deltas
+    x = wf.paths_to_deltas(POINTS.dup)
+    assert_equal(x.size, 2)
+
+    x.each do |p|
+      assert_instance_of(Hash, p)
+      assert(p[:path].start_with?(DELTA))
+    end
+  end
+
+  def test_hash_to_wf
+    assert_equal(wf.hash_to_wf(POINT),
+                 'test.metric 123456 1469987572 ' \
+                 'source=testhost t1="v1" t2="v2"')
+    assert_equal(wf_tags.hash_to_wf(POINT),
+                 'test.metric 123456 1469987572 ' \
+                 'source=testhost t1="v1" t2="v2" ' \
+                 'gt1="gv1" gt2="gv2"')
+
+    p1 = POINT.dup
+    p1.delete(:ts)
+    assert_equal(wf.hash_to_wf(p1),
+                 'test.metric 123456 source=testhost t1="v1" t2="v2"')
+
+    p2 = POINT.dup
+    p2.delete(:tags)
+    assert_equal(wf.hash_to_wf(p2),
+                 'test.metric 123456 1469987572 source=testhost')
+
+    %i[value path].each do |k|
+      p3 = POINT.dup
+      p3.delete(k)
+
+      assert_raises(Wavefront::Exception::InvalidPoint) do
+        wf.hash_to_wf(p3)
+      end
+
+      assert_raises(Wavefront::Exception::InvalidPoint) do
+        wf_tags.hash_to_wf(p3)
+      end
+    end
+  end
+end

data/spec/wavefront-sdk/logger_spec.rb

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+
+require 'logger'
+require_relative '../spec_helper'
+require_relative '../../lib/wavefront-sdk/logger'
+
+# Test SDK logger class
+#
+class WavefrontLoggerTest < MiniTest::Test
+  attr_reader :wfl
+
+  def setup
+    @wfl = Wavefront::Logger.new
+  end
+
+  def test_format_message
+    assert_equal('SDK INFO: some text', wfl.format_message(:info,
+                                                           'some text'))
+  end
+
+  def test_log_no_logger_debug
+    l = Wavefront::Logger.new(debug: true)
+    assert_output("SDK DEBUG: my message\n") { l.log('my message', :debug) }
+    assert_output("SDK INFO: my message\n") { l.log('my message', :info) }
+    out, err = capture_io { l.log('my message', :error) }
+    assert_equal("SDK ERROR: my message\n", err)
+    assert_empty(out)
+  end
+
+  def test_log_no_logger_no_debug
+    l = Wavefront::Logger.new(debug: false, verbose: false)
+    assert_silent { l.log('my message', :debug) }
+    assert_output("SDK INFO: my message\n") { l.log('my message', :info) }
+    out, err = capture_io { l.log('my message', :error) }
+    assert_equal("SDK ERROR: my message\n", err)
+    assert_empty(out)
+    out, err = capture_io { l.log('my message', :warn) }
+    assert_equal("SDK WARN: my message\n", err)
+    assert_empty(out)
+  end
+
+  def test_log_logger_debug
+    l = Wavefront::Logger.new(logger: Logger.new(STDOUT))
+    out, err = capture_subprocess_io { l.log('my message', :debug) }
+    assert_match(/DEBUG -- : my message$/, out)
+    assert_empty(err)
+  end
+
+  def test_log_logger_info
+    l = Wavefront::Logger.new(logger: Logger.new(STDOUT))
+    out, err = capture_subprocess_io { l.log('my message', :info) }
+    assert_match(/INFO -- : my message$/, out)
+    assert_empty(err)
+  end
+
+  def test_log_logger_error
+    l = Wavefront::Logger.new(logger: Logger.new(STDOUT))
+    out, err = capture_subprocess_io { l.log('my message', :error) }
+    assert_match(/ERROR -- : my message$/, out)
+    assert_empty(err)
+  end
+end

data/spec/wavefront-sdk/mixins_spec.rb

@@ -55,6 +55,23 @@ class WavefrontMixinsTest < MiniTest::Test
     end
   end
 
+  def test_valid_relative_time?
+    assert valid_relative_time?('+1h')
+    assert valid_relative_time?('+1m')
+    assert valid_relative_time?('-1s')
+    assert valid_relative_time?('-10d')
+    assert valid_relative_time?('+1.3h')
+    assert valid_relative_time?('+1h')
+    assert valid_relative_time?('-1h')
+    assert valid_relative_time?('-1.142w')
+    assert valid_relative_time?('+0.002y')
+    refute valid_relative_time?('1h')
+    refute valid_relative_time?('1m')
+    refute valid_relative_time?('-1t')
+    refute valid_relative_time?('-dd')
+    refute valid_relative_time?('-1.1.1d')
+  end
+
   def test_parse_relative_time
     assert_equal parse_relative_time('-5s'), -5
     assert_equal parse_relative_time('-5s', true), -5000

data/spec/wavefront-sdk/resources/dummy_points.rb

@@ -0,0 +1,20 @@
+# Constants used in the write tests
+#
+TAGS    = { gt1: 'gv1', gt2: 'gv2' }.freeze
+
+POINT   = { path:   'test.metric',
+            value:  123_456,
+            ts:     1_469_987_572,
+            source: 'testhost',
+            tags:   { t1: 'v1', t2: 'v2' } }.freeze
+
+POINT_L = 'test.metric 123456 1469987572 source=testhost t1="v1" ' \
+          't2="v2"'.freeze
+
+POINT_A = [POINT,
+           POINT.dup.update(ts: 1_469_987_588, value: 54_321)].freeze
+
+POINTS  = [POINT.dup, { path:   'test.other_metric',
+                        value:  89,
+                        ts:     1_469_987_572,
+                        source: 'otherhost' }].freeze

data/spec/wavefront-sdk/write_spec.rb

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 
 require_relative '../../lib/wavefront-sdk/write.rb'
+require_relative 'resources/dummy_points'
 require 'minitest/autorun'
 require 'webmock/minitest'
 require 'spy'
@@ -9,26 +10,6 @@ require 'socket'
 
 W_CREDS = { proxy: 'wavefront', port: 2878 }.freeze
 
-TAGS = { gt1: 'gv1', gt2: 'gv2' }.freeze
-
-POINT =  { path:   'test.metric',
-           value:  123_456,
-           ts:     1_469_987_572,
-           source: 'testhost',
-           tags:   { t1: 'v1', t2: 'v2' } }.freeze
-
-POINT_L = 'test.metric 123456 1469987572 source=testhost t1="v1" t2="v2"'.freeze
-
-POINT_A = [
-  POINT, POINT.dup.update(ts: 1_469_987_588, value: 54_321)
-].freeze
-
-POINTS = [POINT.dup,
-          { path:   'test.other_metric',
-            value:  89,
-            ts:     1_469_987_572,
-            source: 'otherhost' }].freeze
-
 # This class is sufficiently different to the API calling classes
 # that it doesn't use spec helper or inherit anything.
 #
@@ -85,20 +66,6 @@ class WavefrontWriteTest < MiniTest::Test
     assert mocket_spy.has_been_called?
   end
 
-  def test_prepped_points
-    assert_equal wf.prepped_points(%w[p1 p2 p3 p4]), %w[p1 p2 p3 p4]
-    assert_equal wf.prepped_points([%w[p1 p2 p3 p4]]), %w[p1 p2 p3 p4]
-    assert_equal wf.prepped_points('p1'), %w[p1]
-    assert_equal wf.prepped_points(
-      [{ path: 'p1' }, { path: 'p2' }, { path: 'p3' }], 'prefix'
-    ),
-                 [{ path: 'prefix.p1' }, { path: 'prefix.p2' },
-                  { path: 'prefix.p3' }]
-
-    assert_equal wf.prepped_points({ path: 'p1' }, 'prefix'),
-                 [{ path: 'prefix.p1' }]
-  end
-
   def test_write_array
     mocket = Mocket.new
     Spy.on(TCPSocket, :new).and_return(mocket)
@@ -108,55 +75,12 @@ class WavefrontWriteTest < MiniTest::Test
     assert mocket_spy.has_been_called?
   end
 
-  def test_paths_to_deltas
-    x = wf.paths_to_deltas(POINTS.dup)
-    assert_equal(x.size, 2)
-
-    x.each do |p|
-      assert_instance_of(Hash, p)
-      assert(p[:path].start_with?(DELTA))
-    end
-  end
-
-  def test_hash_to_wf
-    assert_equal(wf.hash_to_wf(POINT),
-                 'test.metric 123456 1469987572 ' \
-                 'source=testhost t1="v1" t2="v2"')
-    assert_equal(wf_tags.hash_to_wf(POINT),
-                 'test.metric 123456 1469987572 ' \
-                 'source=testhost t1="v1" t2="v2" ' \
-                 'gt1="gv1" gt2="gv2"')
-
-    p1 = POINT.dup
-    p1.delete(:ts)
-    assert_equal(wf.hash_to_wf(p1),
-                 'test.metric 123456 source=testhost t1="v1" t2="v2"')
-
-    p2 = POINT.dup
-    p2.delete(:tags)
-    assert_equal(wf.hash_to_wf(p2),
-                 'test.metric 123456 1469987572 source=testhost')
-
-    %i[value path].each do |k|
-      p3 = POINT.dup
-      p3.delete(k)
-
-      assert_raises(Wavefront::Exception::InvalidPoint) do
-        wf.hash_to_wf(p3)
-      end
-
-      assert_raises(Wavefront::Exception::InvalidPoint) do
-        wf_tags.hash_to_wf(p3)
-      end
-    end
-  end
-
-  def test_send_point
+  def test_really_send_point
     mocket = Mocket.new
     Spy.on(TCPSocket, :new).and_return(mocket)
     mocket_spy = Spy.on(mocket, :puts)
     wf.open
-    wf.send_point(POINT_L)
+    wf.really_send_point(POINT_L)
     assert mocket_spy.has_been_called_with?(POINT_L)
   end
 

data/wavefront-sdk.gemspec

@@ -37,3 +37,4 @@ Gem::Specification.new do |gem|
 
   gem.required_ruby_version = Gem::Requirement.new('>= 2.2.0')
 end
+# rubocop:enable Metrics/BlockLength:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-sdk
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.6.1
 platform: ruby
 authors:
 - Robert Fisher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-07 00:00:00.000000000 Z
+date: 2018-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -205,6 +205,7 @@ files:
 - lib/wavefront-sdk/exception.rb
 - lib/wavefront-sdk/externallink.rb
 - lib/wavefront-sdk/integration.rb
+- lib/wavefront-sdk/logger.rb
 - lib/wavefront-sdk/maintenancewindow.rb
 - lib/wavefront-sdk/message.rb
 - lib/wavefront-sdk/metric.rb
@@ -232,6 +233,7 @@ files:
 - spec/spec_helper.rb
 - spec/wavefront-sdk/alert_spec.rb
 - spec/wavefront-sdk/base_spec.rb
+- spec/wavefront-sdk/base_write_spec.rb
 - spec/wavefront-sdk/cloudintegration_spec.rb
 - spec/wavefront-sdk/credentials_spec.rb
 - spec/wavefront-sdk/dashboard_spec.rb
@@ -239,6 +241,7 @@ files:
 - spec/wavefront-sdk/event_spec.rb
 - spec/wavefront-sdk/externallink_spec.rb
 - spec/wavefront-sdk/integration_spec.rb
+- spec/wavefront-sdk/logger_spec.rb
 - spec/wavefront-sdk/maintenancewindow_spec.rb
 - spec/wavefront-sdk/message_spec.rb
 - spec/wavefront-sdk/metric_spec.rb
@@ -248,6 +251,7 @@ files:
 - spec/wavefront-sdk/proxy_spec.rb
 - spec/wavefront-sdk/query_spec.rb
 - spec/wavefront-sdk/report_spec.rb
+- spec/wavefront-sdk/resources/dummy_points.rb
 - spec/wavefront-sdk/resources/test.conf
 - spec/wavefront-sdk/resources/test2.conf
 - spec/wavefront-sdk/response_spec.rb
@@ -291,6 +295,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/wavefront-sdk/alert_spec.rb
 - spec/wavefront-sdk/base_spec.rb
+- spec/wavefront-sdk/base_write_spec.rb
 - spec/wavefront-sdk/cloudintegration_spec.rb
 - spec/wavefront-sdk/credentials_spec.rb
 - spec/wavefront-sdk/dashboard_spec.rb
@@ -298,6 +303,7 @@ test_files:
 - spec/wavefront-sdk/event_spec.rb
 - spec/wavefront-sdk/externallink_spec.rb
 - spec/wavefront-sdk/integration_spec.rb
+- spec/wavefront-sdk/logger_spec.rb
 - spec/wavefront-sdk/maintenancewindow_spec.rb
 - spec/wavefront-sdk/message_spec.rb
 - spec/wavefront-sdk/metric_spec.rb
@@ -307,6 +313,7 @@ test_files:
 - spec/wavefront-sdk/proxy_spec.rb
 - spec/wavefront-sdk/query_spec.rb
 - spec/wavefront-sdk/report_spec.rb
+- spec/wavefront-sdk/resources/dummy_points.rb
 - spec/wavefront-sdk/resources/test.conf
 - spec/wavefront-sdk/resources/test2.conf
 - spec/wavefront-sdk/response_spec.rb