wavefront-client 3.5.3 → 3.5.4

data/spec/spec_helper.rb

@@ -22,6 +22,7 @@ require 'wavefront/alerting'
 require 'wavefront/events'
 require 'wavefront/batch_writer'
 require 'wavefront/validators'
+require 'wavefront/opt_handler'
 require 'wavefront/cli'
 require 'wavefront/cli/alerts'
 require 'wavefront/cli/events'
@@ -79,3 +80,44 @@ end
 def concat_url(*args)
   'https://' + args.join('/').squeeze('/')
 end
+
+def raw(str)
+  #
+  # eval. I know. But some of the CLI tests dump raw Ruby hashes in the
+  # debug output. This parses them so you can check them. They'll be
+  # prefixed with 'POST' or 'GET'
+  #
+  eval(str.split[1..-1].join(' '))
+end
+
+def wf(args = '')
+  #
+  # Run the 'wavefront' CLI command, with arguments, and return a struct
+  # for easy access
+  #
+  ret = OpenStruct.new
+  env = {'RUBYLIB' => [LIB.to_s, ENV['RUBYLIB']].join(':') }
+
+  puts "testing #{WF} #{args}"
+  stdout, stderr, status = Open3.capture3(env, "#{WF} #{args}")
+
+  ret.status = status.exitstatus
+  ret.stdout_a = stdout.split("\n")
+  ret.stdout = stdout.strip
+  ret.stderr_a = stderr.split("\n")
+  ret.stderr = stderr.strip
+  ret
+end
+
+# A matcher that tells you whether you have a key=value setting in a query
+# string. Call it with have_element([:key, value])
+#
+RSpec::Matchers.define :have_element do |expected|
+  match do |str|
+    str.sub(/^\S+ /, '').sub(/^.*\?/, '').split('&').
+        each_with_object([]) do |e, aggr|
+      k, v = e.split('=')
+      aggr.<< [k.to_sym, v]
+    end.include?([expected[0].to_sym, URI.escape(expected[1].to_s)])
+  end
+end

data/spec/wavefront/alerting_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.
@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 
 =end
 
-require 'spec_helper'
+require_relative '../spec_helper'
 require 'pathname'
 
 describe Wavefront::Alerting do
@@ -55,7 +55,7 @@ describe Wavefront::Alerting do
     end
 
     it 'makes API request with specified path' do
-      path = '/api/new_alerts' 
+      path = '/api/new_alerts'
       expect(RestClient).to receive(:get).with("https://#{File.join(Wavefront::Alerting::DEFAULT_HOST, path, "all?t=#{TEST_TOKEN}")}")
       @wave.all({ :path => path })
     end
@@ -73,7 +73,7 @@ describe Wavefront::Alerting do
     end
 
     it 'makes API request with both appended private tags and shared tags' do
-      private_tag = 'first' 
+      private_tag = 'first'
       shared_tag = 'second'
       expect(RestClient).to receive(:get).with("https://#{File.join(Wavefront::Alerting::DEFAULT_HOST, Wavefront::Alerting::DEFAULT_PATH, "all?t=#{TEST_TOKEN}&customerTag=second&userTag=first")}")
       @wave.all({ :private_tags => private_tag, :shared_tags => shared_tag })
@@ -82,30 +82,29 @@ describe Wavefront::Alerting do
 
   describe '#active' do
     it 'requests all active alerts' do
-      expect(@wave).to receive(:get_alerts).with("active", {}) 
+      expect(@wave).to receive(:get_alerts).with("active", {})
       @wave.active
     end
   end
 
   describe '#snoozed' do
     it 'requests all snoozed alerts' do
-      expect(@wave).to receive(:get_alerts).with("snoozed", {}) 
+      expect(@wave).to receive(:get_alerts).with("snoozed", {})
       @wave.snoozed
     end
   end
 
   describe '#invalid' do
     it 'requests all invalid alerts' do
-      expect(@wave).to receive(:get_alerts).with("invalid", {}) 
+      expect(@wave).to receive(:get_alerts).with("invalid", {})
       @wave.invalid
     end
   end
 
   describe '#affected_by_maintenance' do
     it 'requests all affected_by_maintenance alerts' do
-      expect(@wave).to receive(:get_alerts).with("affected_by_maintenance", {}) 
+      expect(@wave).to receive(:get_alerts).with("affected_by_maintenance", {})
       @wave.affected_by_maintenance
     end
   end
-  
 end

data/spec/wavefront/batch_writer_spec.rb

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 
 =end
 
-require 'spec_helper'
+require_relative '../spec_helper'
 require 'socket'
 
 opts = {}

data/spec/wavefront/cli/alerts_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require_relative '../../spec_helper'
 require 'pathname'
 require 'json'
 require 'erb'
@@ -9,7 +9,8 @@ states = %w(active affected_by_maintenance all invalid snoozed)
 formats = %w(ruby json human)
 
 opts = {
-  token: TEST_TOKEN,
+  token:    TEST_TOKEN,
+  endpoint: TEST_HOST,
 }
 
 describe Wavefront::Cli::Alerts do
@@ -35,7 +36,7 @@ describe Wavefront::Cli::Alerts do
       k = Wavefront::Cli::Alerts.new(opts, ['all'])
 
       states.each do |state|
-        expect(k.valid_state?(wfa, state.to_sym)).to be(true)
+        expect(k.valid_state?(wfa, state)).to be(true)
       end
     end
   end
@@ -94,7 +95,7 @@ describe Wavefront::Cli::Alerts do
     it 'reconstructs human output' do
       out = ERB.new(IO.read(Pathname.new(__FILE__).dirname +
                             'resources' + 'alert.human.erb')).result
-      expect(k.humanize(JSON.parse(src)).join("\n") + "\n").to eq(out)
+      expect(k.humanize(JSON.parse(src)).join("\n")).to eq(out)
     end
   end
 

data/spec/wavefront/cli/batch_write_spec.rb

@@ -1,7 +1,9 @@
 require 'pathname'
-require 'spec_helper'
+require_relative '../../spec_helper'
 
-opts = {}
+opts = {
+  proxy: 'wavefront.localnet',
+}
 
 describe '#run' do
 end

data/spec/wavefront/cli/events_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require_relative '../../spec_helper'
 require 'pathname'
 require 'json'
 
@@ -8,7 +8,8 @@ states = %w(active affected_by_maintenance all invalid snoozed)
 formats = %w(ruby json human)
 
 opts = {
-  token: TEST_TOKEN,
+  token:    TEST_TOKEN,
+  endpoint: TEST_HOST,
 }
 
 describe Wavefront::Cli::Alerts do

data/spec/wavefront/cli/sources_spec.rb

@@ -2,11 +2,12 @@
 # Due to dependency requirements, webmock does not work with Ruby
 # 1.9.3. For as long as we have to support that, it's off the table.
 #
-require 'spec_helper'
+require_relative '../../spec_helper'
 #require 'webmock/rspec'
 
 opts = {
-  token: TEST_TOKEN,
+  token:    TEST_TOKEN,
+  endpoint: TEST_HOST,
 }
 
 describe Wavefront::Cli::Sources do

data/spec/wavefront/cli/write_spec.rb

@@ -1,7 +1,9 @@
-require 'spec_helper'
+require_relative '../../spec_helper'
 require 'socket'
 
-opts = {}
+opts = {
+  proxy: 'wavefront.localnet',
+}
 args = 'write'
 k = Wavefront::Cli::Write.new(opts, args)
 

data/spec/wavefront/cli_spec.rb

@@ -14,55 +14,23 @@ See the License for the specific language governing permissions and
 
 =end
 
-require 'spec_helper'
-require 'pathname'
-require 'tempfile'
+require_relative '../spec_helper'
 
-# 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
-)
+# Just test initialization
 
 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')
+  it 'raises an error if no token is set' do
+    wf = Wavefront::Cli.new({}, nil)
+    expect{wf.validate_opts}.to raise_exception(RuntimeError)
   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')
+  it 'raises an error if no endpoint is set' do
+    wf = Wavefront::Cli.new({token: 'abcdef' }, nil)
+    expect{wf.validate_opts}.to raise_exception(RuntimeError)
   end
 
-  it 'prefers config file values to command-line options' do
-    k = Wavefront::Cli.new({config: cf, format: 'graphite'}, false)
-    pf = k.load_profile
-    expect(pf[:format]).to eq('human')
-    expect(pf[:token]).to eq('12345678-abcd-1234-abcd-123456789012')
+  it 'does not raise an error if an endpoint and token are set' do
+    wf = Wavefront::Cli.new({token: 'abcdef', endpoint: 'wavefront' }, nil)
+    expect{wf.validate_opts}.to_not raise_exception
   end
 end

data/spec/wavefront/client_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.
@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 
 =end
 
-require 'spec_helper'
+require_relative '../spec_helper'
 require 'pathname'
 
 describe Wavefront::Client do

data/spec/wavefront/events_spec.rb

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 
 =end
 
-require 'spec_helper'
+require_relative '../spec_helper'
 
 describe Wavefront::Events do
 

data/spec/wavefront/metadata_spec.rb

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 
 =end
 
-require 'spec_helper'
+require_relative '../spec_helper'
 require 'pathname'
 
 describe Wavefront::Metadata do

data/spec/wavefront/mixins_spec.rb

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 
 =end
 
-require 'spec_helper'
+require_relative '../spec_helper'
 require 'wavefront/mixins'
 
 HOST = 'i-12345678'

data/spec/wavefront/opt_handler_spec.rb

@@ -0,0 +1,89 @@
+=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_relative '../spec_helper'
+require 'pathname'
+require 'socket'
+
+# DEFAULT_OPTS come from the real constants.rb file
+
+describe Wavefront::OptHandler do
+  config_file = Pathname.new(__FILE__).dirname + 'resources' + 'conf.yaml'
+
+  it 'uses defaults if nothing else is supplied' do
+    opts = Wavefront::OptHandler.new(Pathname.new('/nofile'), {}).opts
+
+    expect(opts.class).to be(Hash)
+    expect(opts[:endpoint]).to eq('metrics.wavefront.com')
+    expect(opts[:host]).to eq(Socket.gethostname)
+    expect(opts[:sourceformat]).to eq(:human)
+  end
+
+  it 'ensures options override defaults' do
+    cli_opts = {
+      endpoint: 'myendpoint.wavefront.com',
+      sourceformat: 'ruby',
+    }
+
+    opts = Wavefront::OptHandler.new(Pathname.new('/nofile'), cli_opts).opts
+
+    expect(opts.class).to be(Hash)
+    expect(opts[:endpoint]).to eq('myendpoint.wavefront.com')
+    expect(opts[:host]).to eq(Socket.gethostname)
+    expect(opts[:sourceformat]).to eq('ruby')
+  end
+
+  it 'ensures default config file values override defaults' do
+    opts = Wavefront::OptHandler.new(config_file, {}).opts
+
+    expect(opts.class).to be(Hash)
+    expect(opts[:endpoint]).to eq('default.wavefront.com')
+    expect(opts[:host]).to eq(Socket.gethostname)
+    expect(opts[:sourceformat]).to eq('raw')
+    expect(opts[:format]).to eq(:raw)
+  end
+
+  it 'ensures alternate stanza config file values override defaults' do
+    opts = Wavefront::OptHandler.new(config_file, {profile: 'other'}).opts
+
+    expect(opts.class).to be(Hash)
+    expect(opts[:endpoint]).to eq('other.wavefront.com')
+    expect(opts[:host]).to eq(Socket.gethostname)
+    expect(opts[:sourceformat]).to eq(:human)
+    expect(opts[:format]).to eq(:raw)
+  end
+
+  it 'ensures command line options override defaults and config files' do
+    cli_opts = {
+      endpoint: 'cli.wavefront.com',
+      sourceformat: 'ruby',
+    }
+
+    opts = Wavefront::OptHandler.new(config_file, cli_opts).opts
+
+    expect(opts.class).to be(Hash)
+    expect(opts[:endpoint]).to eq('cli.wavefront.com')
+    expect(opts[:host]).to eq(Socket.gethostname)
+    expect(opts[:sourceformat]).to eq('ruby')
+    expect(opts[:format]).to eq(:raw)
+  end
+
+  it 'issues a warning if there is no config file' do
+    expect{Wavefront::OptHandler.new(Pathname.new('/nofile'), {})}.
+      to match_stdout("'/nofile' not found. Taking options from command-line.")
+  end
+
+end

data/spec/wavefront/resources/conf.yaml

@@ -0,0 +1,10 @@
+[default]
+token = 12345678-abcd-1234-abcd-123456789012
+endpoint = default.wavefront.com
+proxy = wavefront.localnet
+sourceformat = raw
+
+[other]
+token = abcdefab-0123-abcd-0123-abcdefabcdef
+endpoint = other.wavefront.com
+proxy = otherwf.localnet

data/spec/wavefront/response_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.
@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 
 =end
 
-require 'spec_helper'
+require_relative '../spec_helper'
 require 'pathname'
 require 'json'
 
@@ -72,7 +72,7 @@ describe Wavefront::Response::Highcharts do
   it 'returns something that resembles highcharts output' do
     example_response = File.read(Pathname.new(__FILE__).parent.parent.join('example_response.json'))
     response = Wavefront::Response::Highcharts.new(example_response)
-    
+
     expect(response.highcharts[0]['data'].size).to eq(30)
     JSON.parse(response.to_json).each { |m| expect(m.keys.size).to eq(2) }
   end