wavefront-client 3.2.0 → 3.3.0

data/spec/wavefront/cli/resources/alert.human2

@@ -0,0 +1,14 @@
+name                  Test Alert
+created               2016-07-29 16:54:22 +0100
+severity              WARN
+condition             ts("dev.cli.test_metric") > 0
+displayExpression     ts("dev.cli.test_metric")
+minutes               5
+resolveAfterMinutes
+updated               2016-07-29 16:55:35 +0100
+alertStates           CHECKING
+metricsUsed
+hostsUsed
+additionalInformation This alert has been made up to feed into the test
+                      framework for the Ruby CLI. It is not real. Even this
+                      text is just placeholder text.

data/spec/wavefront/cli/resources/alert.json

@@ -0,0 +1,38 @@
+[
+  {
+    "customerTagsWithCounts": {
+      "test": 1
+    },
+    "userTagsWithCounts": {
+    },
+    "created": 1469807662271,
+    "name": "Test Alert",
+    "conditionQBEnabled": false,
+    "displayExpressionQBEnabled": false,
+    "condition": "ts(\"dev.cli.test_metric\") > 0",
+    "displayExpression": "ts(\"dev.cli.test_metric\")",
+    "minutes": 5,
+    "target": "someone@example.com",
+    "failingHostLabelPairs": [
+
+    ],
+    "updated": 1469807735018,
+    "severity": "WARN",
+    "additionalInformation": "This alert has been made up to feed into the test framework for the Ruby CLI. It is not real. Even this text is just placeholder text.",
+    "activeMaintenanceWindows": [
+
+    ],
+    "inMaintenanceHostLabelPairs": [
+
+    ],
+    "prefiringHostLabelPairs": [
+
+    ],
+    "alertStates": [
+      "CHECKING"
+    ],
+    "inTrash": false,
+    "numMetricsUsed": 0,
+    "numHostsUsed": 0
+  }
+]

data/spec/wavefront/cli/resources/alert.raw

@@ -0,0 +1 @@
+[{"customerTagsWithCounts":{"test":1},"userTagsWithCounts":{},"created":1469807662271,"name":"Test Alert","conditionQBEnabled":false,"displayExpressionQBEnabled":false,"condition":"ts(\"dev.cli.test_metric\") > 0","displayExpression":"ts(\"dev.cli.test_metric\")","minutes":5,"target":"someone@example.com","failingHostLabelPairs":[],"updated":1469807735018,"severity":"WARN","additionalInformation":"This alert has been made up to feed into the test framework for the Ruby CLI. It is not real. Even this text is just placeholder text.","activeMaintenanceWindows":[],"inMaintenanceHostLabelPairs":[],"prefiringHostLabelPairs":[],"alertStates":["CHECKING"],"inTrash":false,"numMetricsUsed":0,"numHostsUsed":0}]

data/spec/wavefront/cli/resources/alert.ruby

@@ -0,0 +1 @@
+"[{\"customerTagsWithCounts\":{\"test\":1},\"userTagsWithCounts\":{},\"created\":1469807662271,\"name\":\"Test Alert\",\"conditionQBEnabled\":false,\"displayExpressionQBEnabled\":false,\"condition\":\"ts(\\\"dev.cli.test_metric\\\") > 0\",\"displayExpression\":\"ts(\\\"dev.cli.test_metric\\\")\",\"minutes\":5,\"target\":\"someone@example.com\",\"failingHostLabelPairs\":[],\"updated\":1469807735018,\"severity\":\"WARN\",\"additionalInformation\":\"This alert has been made up to feed into the test framework for the Ruby CLI. It is not real. Even this text is just placeholder text.\",\"activeMaintenanceWindows\":[],\"inMaintenanceHostLabelPairs\":[],\"prefiringHostLabelPairs\":[],\"alertStates\":[\"CHECKING\"],\"inTrash\":false,\"numMetricsUsed\":0,\"numHostsUsed\":0}]"

data/spec/wavefront/cli/resources/write.parabola

@@ -0,0 +1,49 @@
+1470075208 6760
+1470075209 6290
+1470075210 5840
+1470075211 5410
+1470075212 5000
+1470075213 4610
+1470075214 4240
+1470075215 3890
+1470075216 3560
+1470075217 3250
+1470075218 2960
+1470075219 2690
+1470075220 2440
+1470075221 2210
+1470075222 2000
+1470075223 1810
+1470075224 1640
+1470075225 1490
+1470075226 1360
+1470075227 1250
+1470075228 1160
+1470075229 1090
+1470075230 1040
+1470075231 1010
+1470075232 1000
+1470075233 1010
+1470075234 1040
+1470075235 1090
+1470075236 1160
+1470075237 1250
+1470075238 1360
+1470075239 1490
+1470075240 1640
+1470075241 1810
+1470075242 2000
+1470075243 2210
+1470075244 2440
+1470075245 2690
+1470075246 2960
+1470075247 3250
+1470075248 3560
+1470075249 3890
+1470075250 4240
+1470075251 4610
+1470075252 5000
+1470075253 5410
+1470075254 5840
+1470075255 6290
+1470075256 6760

data/spec/wavefront/cli/write_spec.rb

@@ -0,0 +1,112 @@
+require 'spec_helper'
+require 'socket'
+
+opts = {}
+args = 'write'
+k = Wavefront::Cli::Write.new(opts, args)
+
+describe '#write_metric' do
+  it 'writes a point to a socket' do
+    socket = Mocket.new
+    allow(TCPSocket).to receive(:new).and_return(socket)
+    now = Time.now
+    expect(socket).to receive(:puts).with(
+      "1234 test.metric #{now.to_i} host=testhost")
+    k.write_metric('test.metric', '1234', {
+      timestamp: now, host_name: 'testhost'})
+  end
+
+  it 'writes a point with tags to a socket' do
+    socket = Mocket.new
+    allow(TCPSocket).to receive(:new).and_return(socket)
+    now = Time.now
+    expect(socket).to receive(:puts).with(
+      "5678 test.metric2 #{now.to_i} host=testhost t1=\"v1\" t2=\"v2\"")
+    k.write_metric('test.metric2', '5678', {
+      timestamp: now, host_name: 'testhost', point_tags:
+      {t1: 'v1', t2: 'v2'}})
+  end
+end
+
+describe '#valid_host?' do
+
+  it 'accepts valid hostnames' do
+    expect(k.valid_host?('valid-host')).to be_truthy
+  end
+
+  it 'rejects invalid hostnames' do
+    expect(k.valid_host?('!nval!d_HOST')).to be_falsey
+    expect(k.valid_host?('a' * 1025)).to be_falsey
+  end
+
+end
+
+describe '#valid_value?' do
+
+  it 'accepts real numbers' do
+    expect(k.valid_value?(123)).to be true
+    expect(k.valid_value?(-123)).to be true
+    expect(k.valid_value?(1.23)).to be true
+    expect(k.valid_value?(1.5e07)).to be true
+  end
+
+  it 'accepts integer-type strings' do
+    expect(k.valid_value?('123')).to be true
+    expect(k.valid_value?('-123')).to be true
+  end
+
+  it 'accepts exponential-type strings' do
+    expect(k.valid_value?('1.23e06')).to be true
+    expect(k.valid_value?('-1.23e06')).to be true
+  end
+
+  it 'rejects random strings' do
+    %w(abc 1.2.3 1.2e2e3 6e).each do |str|
+      expect{k.valid_value?(str)}.to raise_exception(
+       Wavefront::Exception::InvalidMetricValue)
+    end
+  end
+end
+
+describe '#valid_metric?' do
+  it 'accepts some valid metrics' do
+    expect(k.valid_metric?('valid.metric.path')).to be true
+    expect(k.valid_metric?('valid.metric-path')).to be true
+    expect(k.valid_metric?('valid.metric_path')).to be true
+  end
+
+  it 'rejects non-strings' do
+    [123, {k: 'v'}, []].each do |el|
+      expect{k.valid_metric?(el)}.to raise_exception(
+       Wavefront::Exception::InvalidMetricName)
+    end
+  end
+
+  it 'rejects too-long paths' do
+    expect{k.valid_metric?('aaaa.' * 300 )}.to raise_exception(
+       Wavefront::Exception::InvalidMetricName)
+  end
+
+  it 'rejects single-element paths' do
+      expect{k.valid_metric?('metric')}.to raise_exception(
+       Wavefront::Exception::InvalidMetricName)
+  end
+
+  it 'rejects invalid characters' do
+    expect{k.valid_metric?('!nval!d.metric')}.to raise_exception(
+       Wavefront::Exception::InvalidMetricName)
+  end
+end
+
+describe '#prep_tags' do
+  it 'handles invalid input' do
+    expect(k.prep_tags('string')).to eq([])
+    expect(k.prep_tags({key: 'val'})).to eq([])
+    expect(k.prep_tags(['badtag1', 'badtag2'])).to eq([])
+  end
+
+  it 'handles sample valid input' do
+    expect(k.prep_tags(['key1=val1', 'key2=val2'])).to eq(
+      [['key1', 'val1'], ['key2', 'val2']])
+  end
+end

data/spec/wavefront/cli_spec.rb

@@ -0,0 +1,68 @@
+=begin
+    Copyright 2015 Wavefront Inc.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+   limitations under the License.
+
+=end
+
+require 'spec_helper'
+require 'pathname'
+require 'tempfile'
+
+# A sample config file with two profiles.
+#
+pf_src = %Q(
+[default]
+token = 12345678-abcd-1234-abcd-123456789012
+endpoint = metrics.wavefront.com
+format = human
+proxy = wavefront.localnet
+
+[other]
+token = abcdefab-0123-abcd-0123-abcdefabcdef
+endpoint = test.wavefront.com
+format = human
+)
+
+describe Wavefront::Cli do
+
+  profile = Tempfile.new('wf_test_profile')
+  cf = profile.path
+  profile.write(pf_src)
+  profile.close
+
+  it 'does not complain when there is no config file' do
+    k = Wavefront::Cli.new({config: '/no/file', profile: 'default'}, false)
+    expect(k.load_profile).to be_kind_of(NilClass)
+  end
+
+  it 'loads the specified profile' do
+    k = Wavefront::Cli.new({config: cf, profile: 'other'}, false)
+    pf = k.load_profile
+    expect(pf).not_to include('proxy')
+    expect(pf[:token]).to eq('abcdefab-0123-abcd-0123-abcdefabcdef')
+  end
+
+  it 'loads the default when no profile is specified' do
+    k = Wavefront::Cli.new({config: cf}, false)
+    pf = k.load_profile
+    expect(pf[:proxy]).to eq('wavefront.localnet')
+    expect(pf[:token]).to eq('12345678-abcd-1234-abcd-123456789012')
+  end
+
+  it 'prefers command-line options to config file values' do
+    k = Wavefront::Cli.new({config: cf, format: 'graphite'}, false)
+    pf = k.load_profile
+    expect(pf[:format]).to eq('graphite')
+    expect(pf[:token]).to eq('12345678-abcd-1234-abcd-123456789012')
+  end
+end

data/spec/wavefront/events_spec.rb

@@ -0,0 +1,111 @@
+=begin
+    Copyright 2016 Wavefront Inc.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+   limitations under the License.
+
+=end
+
+require 'spec_helper'
+
+describe Wavefront::Events do
+
+  describe "#initialize" do
+    it 'puts the token in a suitable header' do
+      k = Wavefront::Events.new(TEST_TOKEN)
+      expect(k.headers).to eq({ :'X-AUTH-TOKEN' =>  TEST_TOKEN })
+    end
+  end
+
+  describe '#create_uri' do
+    it 'generates a correct URI if host and path are supplied' do
+      k = Wavefront::Events.new(TEST_TOKEN)
+      res = k.create_uri({
+        host: 'test.wavefront.com', path: '/alternate/api/'
+      })
+
+      expect(res).to be_kind_of(URI)
+      expect(res.port).to be(443)
+      expect(res.host).to eq('test.wavefront.com')
+      expect(res.path).to eq('/alternate/api/')
+      expect(res.query).to be(nil)
+    end
+
+    it 'generates a correct URI if no host or path are supplied' do
+      k = Wavefront::Events.new(TEST_TOKEN)
+      res = k.create_uri
+
+      expect(res).to be_kind_of(URI)
+      expect(res.port).to be(443)
+      expect(res.host).to eq('metrics.wavefront.com')
+      expect(res.path).to eq('/api/events/')
+      expect(res.query).to be(nil)
+    end
+  end
+
+  describe '#close_uri' do
+    it 'generates a correct URI if host and path are supplied' do
+      k = Wavefront::Events.new(TEST_TOKEN)
+      res = k.close_uri({
+        host: 'test.wavefront.com', path: '/alternate/api/'
+      })
+
+      expect(res).to be_kind_of(URI)
+      expect(res.port).to be(443)
+      expect(res.host).to eq('test.wavefront.com')
+      expect(res.path).to eq('/alternate/api/close')
+      expect(res.query).to be(nil)
+    end
+
+    it 'generates a correct URI if no host or path are supplied' do
+      k = Wavefront::Events.new(TEST_TOKEN)
+      res = k.close_uri
+
+      expect(res).to be_kind_of(URI)
+      expect(res.port).to be(443)
+      expect(res.host).to eq('metrics.wavefront.com')
+      expect(res.path).to eq('/api/events/close')
+      expect(res.query).to be(nil)
+    end
+  end
+
+  describe '#create_qs' do
+    payload = { key1: 'val1', key2: 'val2' }
+
+    it 'generates a query string with no hosts' do
+      k = Wavefront::Events.new(TEST_TOKEN)
+      expect(k.create_qs(payload)).to eq('key1=val1&key2=val2')
+    end
+
+    it 'generates a query string with single host as a string' do
+      payload[:h] = ['host1']
+      k = Wavefront::Events.new(TEST_TOKEN)
+      expect(k.create_qs(payload)).to eq('key1=val1&key2=val2&h=host1')
+    end
+
+    it 'generates a query string with multiple hosts' do
+      payload[:h] = ['host1', 'host2', 'host3']
+      k = Wavefront::Events.new(TEST_TOKEN)
+      expect(k.create_qs(payload)).to eq(
+        'key1=val1&key2=val2&h=host1&h=host2&h=host3')
+    end
+  end
+
+  describe '#hash_to_qs' do
+    it 'makes a proper query string' do
+      k = Wavefront::Events.new(TEST_TOKEN)
+        expect(k.hash_to_qs({
+        key1: 'val1',
+        key2: 'value 2'
+      })).to eq('key1=val1&key2=value%202')
+    end
+  end
+end

data/spec/wavefront/mixins_spec.rb

@@ -1,4 +1,4 @@
-=begin 
+=begin
     Copyright 2015 Wavefront Inc.
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -26,4 +26,19 @@ describe Wavefront::Mixins do
     expect(interpolate_schema(wavefront_schema, HOST, 1)).to eq("a.#{HOST}.b.c.d.e")
     expect(interpolate_schema(wavefront_schema, HOST, 2)).to eq("a.b.#{HOST}.c.d.e")
   end
+
+  it 'provides a method to parse times' do
+    expect(parse_time(1469711187)).to eq(1469711187)
+    expect(parse_time('1469711187')).to eq(1469711187)
+    expect(parse_time('2016-07-28 14:25:36 +0100')).to eq(1469712336)
+    expect(parse_time('2016-07-28')).to eq(1469664000)
+    expect(parse_time(Time.now)).to be_kind_of(Integer)
+    expect{parse_time('nonsense')}.to raise_exception(RuntimeError,
+                                  "cannot parse timestamp 'nonsense'.")
+  end
+
+  it 'provides a method to convert epoch times to milliseconds' do
+    expect(time_to_ms(1469711187)).to eq(1469711187000)
+    expect(time_to_ms('1469711187')).to be(false)
+  end
 end

data/spec/wavefront/writer_spec.rb

@@ -15,15 +15,8 @@ See the License for the specific language governing permissions and
 =end
 
 require 'spec_helper'
-require 'pathname'
 require 'socket'
 
-class Mocket
-  def puts(str)
-    return true
-  end
-end
-
 describe Wavefront::Writer do
 
   it 'has some defaults' do