wavefront-cli 2.1.2 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40a642f73bf1dcaa8bfe36bb00ad3c56acf5d2f7
-  data.tar.gz: 2920cf7de19ec00f16897a89d75a7c84a3fb9a55
+  metadata.gz: 1098aac042355b553d4b5e6b1ae5bad73794a61a
+  data.tar.gz: 97495d06c18f86febbc78578bfae1c60eec8b260
 SHA512:
-  metadata.gz: 81bd3003b6d18cfadb87aa8c4fd21898b1ac6779413c1dd44544aedbd6f8a1106bc0e0774c869ebef345b91887785363b6c9c95ea932e1e3842fe490778903b1
-  data.tar.gz: 6038bd021543276e6b90a05b275664c2a61e52bec2c4460e1018f1c619fd26ab589e863972f7e425f1a749ae4504e8e4c7e2bd6c45e30bdb219653293422effc
+  metadata.gz: 178fe53faaad7d665bf497b35177884b37b03175788e0cf7a808a3a7430aa655efd5ba3bd1941ea122ffd5b5e85aa5e90039906775088aa52fe390f59928a25d
+  data.tar.gz: 0ce5b99c7cf2af4376a6a5750243bc06155dbad7ef9c2908fd7e220e344a95af84ef6adc7c6166022e446a4035c213d4967be072cfe1f42724269a60a3734c36

data/lib/wavefront-cli/controller.rb

@@ -1,14 +1,17 @@
+# For development against a local checkout of the SDK, uncomment
+# this block
+#
+# dir = Pathname.new(__FILE__).dirname.realpath.parent.parent.parent
+# $LOAD_PATH.<< dir + 'lib'
+# $LOAD_PATH.<< dir + 'wavefront-sdk' + 'lib'
+
 require 'pathname'
 require 'pp'
 require 'docopt'
 require_relative './version'
-require_relative './opt_handler'
 require_relative './exception'
 
-# $LOAD_PATH.<< Pathname.new(__FILE__).dirname.realpath.parent.parent
-                # .parent + 'lib'
-# $LOAD_PATH.<< Pathname.new(__FILE__).dirname.realpath.parent.parent
-                # .parent + 'wavefront-sdk' + 'lib'
+require_relative './opt_handler'
 
 CMD_DIR = Pathname.new(__FILE__).dirname + 'commands'
 
@@ -29,7 +32,8 @@ class WavefrontCliController
     run_command(hook)
   end
 
-  # What you see when you do 'wavefront --help'
+  # What you see when you do 'wf --help'
+  # @return [String]
   #
   def default_help
     s = "Wavefront CLI\n\nUsage:\n  #{CMD} command [options]\n" \
@@ -39,7 +43,7 @@ class WavefrontCliController
     s.<< "\nUse '#{CMD} <command> --help' for further information.\n"
   end
 
-  # Make a hash of command descriptions for docopt.
+  # @return [Hash] command descriptions for docopt.
   #
   def docopt_hash
     cmds.each_with_object(default: default_help) do |(k, v), ret|
@@ -67,11 +71,12 @@ class WavefrontCliController
   end
 
   def parse_opts(o)
-    WavefrontCli::OptHandler.new(conf_file, o).opts
+    WavefrontCli::OptHandler.new(o).opts
   end
 
   # Get the SDK class we need to run the command we've been given.
   #
+  # @param cmd [String]
   def load_sdk(cmd, opts)
     require_relative File.join('.', cmds[cmd].sdk_file)
     Object.const_get('WavefrontCli').const_get(cmds[cmd].sdk_class).new(opts)
@@ -93,6 +98,7 @@ class WavefrontCliController
 
   # Each command is defined in its own file. Dynamically load all
   # those commands.
+  # @return [Hash] :command => CommandClass
   #
   def load_commands
     CMD_DIR.children.each_with_object({}) do |f, ret|
@@ -113,24 +119,12 @@ class WavefrontCliController
     Object.const_get("WavefrontCommand#{k_name.capitalize}").new
   end
 
-  # The default config file path.
-  #
-  # @return [Pathname] where we excpect to find a config file
-  #
-  def conf_file
-    if ENV['HOME']
-      Pathname.new(ENV['HOME']) + '.wavefront'
-    else
-      Pathname.new('/etc/wavefront/client.conf')
-    end
-  end
-
   # Symbolize, and remove dashes from option keys
   #
   # @param h [Hash] options hash
   # return [Hash] h with modified keys
   #
   def sanitize_keys(h)
-    h.each_with_object({}) { |(k, v), r| r[k.delete('-').to_sym] = v }
+    h.each_with_object({}) { |(k, v), r| r[k.to_s.delete('-').to_sym] = v }
   end
 end

data/lib/wavefront-cli/opt_handler.rb

@@ -1,5 +1,6 @@
 require 'inifile'
 require 'pathname'
+require 'wavefront-sdk/credentials'
 require_relative './constants.rb'
 
 module WavefrontCli
@@ -23,40 +24,47 @@ module WavefrontCli
   class OptHandler
     include WavefrontCli::Constants
 
-    attr_reader :opts, :cli_opts, :conf_file
+    attr_reader :opts
 
-    def initialize(conf_file, cli_opts = {})
-      @conf_file = if cli_opts.key?(:config) && cli_opts[:config]
-                     Pathname.new(cli_opts[:config])
-                   else
-                     conf_file
-                   end
-
-      @cli_opts = cli_opts.reject { |_k, v| v.nil? }
-
-      @opts = DEFAULT_OPTS.merge(load_profile).merge(@cli_opts)
+    def initialize(cli_opts = {})
+      cred_opts = setup_cred_opts(cli_opts)
+      cli_opts.reject! { |_k, v| v.nil? }
+      @opts = DEFAULT_OPTS.merge(load_profile(cred_opts)).merge(cli_opts)
     end
 
-    # Load in configuration options from the (optionally) given
-    # section of an ini-style configuration file. If the file's not
-    # there, we don't consider that an error. Returns a hash of
-    # options which matches what Docopt gives us.
+    # Create an options hash to pass to the Wavefront::Credentials
+    # constructor.
+    # @param cli_opts [Hash] options from docopt, which may include
+    #   the location of the config file and the stanza within it
+    # @return [Hash] keys are none, one, or both of :file and
+    #   :profile
     #
-    # rubocop:disable Metrics/AbcSize
-    def load_profile
-      unless conf_file.exist?
-        puts "config file '#{conf_file}' not found. Taking options " \
-             'from command-line.'
-        return {}
-      end
+    def setup_cred_opts(cli_opts)
+      cred_opts = {}
 
-      pf = cli_opts.fetch(:profile, 'default')
+      if cli_opts[:config]
+        cred_opts[:file] = Pathname.new(cli_opts[:config])
 
-      puts "reading '#{pf}' profile from '#{conf_file}'" if cli_opts[:debug]
-
-      IniFile.load(conf_file)[pf].each_with_object({}) do |(k, v), memo|
-        memo[k.to_sym] = v
+        unless cred_opts[:file].exist?
+          puts "config file '#{cred_opts[:file]}' not found."
+        end
       end
+
+      cred_opts[:profile] = cli_opts[:profile] if cli_opts[:profile]
+      cred_opts
+    end
+
+    # Load credentials (and other config) using the SDK Credentials
+    # class. This allows the user to override values with
+    # environment variables
+    #
+    # @param cred_opts [Hash] options to pass to
+    #   Wavefront::Credentials constructor
+    # @return [Hash] keys are :token, :endpoint etc
+    #
+    def load_profile(cred_opts)
+      creds = Wavefront::Credentials.new(cred_opts).config
+      Hash[creds.map{ |k, v| [k.to_sym, v] }]
     end
   end
 end

data/lib/wavefront-cli/version.rb

@@ -1 +1 @@
-WF_CLI_VERSION = '2.1.2'.freeze
+WF_CLI_VERSION = '2.1.3'.freeze

data/spec/spec_helper.rb

@@ -7,21 +7,23 @@ require 'minitest/spec'
 require 'pathname'
 require_relative '../lib/wavefront-cli/controller'
 
-CMD = 'wavefront'.freeze
-ENDPOINT = 'metrics.wavefront.com'
-TOKEN = '0123456789-ABCDEF'
-RES_DIR = Pathname.new(__FILE__).dirname + 'wavefront-cli' + 'resources'
-CF = RES_DIR + 'conf.yaml'
-CF_VAL =  IniFile.load(CF)
-JSON_POST_HEADERS = {
-    :'Content-Type' => 'application/json', :Accept => 'application/json'
-}.freeze
-
-CMDS = %w(alert integration dashboard event link message metric
-          proxy query savedsearch source user window webhook write).freeze
-
-BAD_TAG="*BAD TAG*"
-TW = 80
+unless defined?(CMD)
+  CMD = 'wavefront'.freeze
+  ENDPOINT = 'metrics.wavefront.com'
+  TOKEN = '0123456789-ABCDEF'
+  RES_DIR = Pathname.new(__FILE__).dirname + 'wavefront-cli' + 'resources'
+  CF = RES_DIR + 'wavefront.conf'
+  CF_VAL =  IniFile.load(CF)
+  JSON_POST_HEADERS = {
+      :'Content-Type' => 'application/json', :Accept => 'application/json'
+  }.freeze
+
+  CMDS = %w(alert integration dashboard event link message metric
+            proxy query savedsearch source user window webhook write).freeze
+
+  BAD_TAG="*BAD TAG*"
+  TW = 80
+end
 
 # Return an array of CLI permutations and the values to which they relate
 #

data/spec/wavefront-cli/commands/base_spec.rb

@@ -1,7 +1,5 @@
 #!/usr/bin/env ruby
 
-CMD = 'test'.freeze
-
 require 'pathname'
 require_relative(File.join('../../../lib/wavefront-cli/commands',
                            Pathname.new(__FILE__).basename

data/spec/wavefront-cli/commands/spec_helper.rb

@@ -1,4 +1,2 @@
 require 'minitest/autorun'
 require 'minitest/spec'
-
-TW = 80

data/spec/wavefront-cli/{cli_help_spec.rb → controller_spec.rb}

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require_relative '../../lib/wavefront-cli/controller'
 require_relative '../spec_helper'
+require_relative '../../lib/wavefront-cli/controller'
 
 # Be sure the CLI behaves properly when people ask for help
 #
@@ -47,3 +47,25 @@ class WavefrontCliHelpTest < MiniTest::Test
     end
   end
 end
+
+# To test internal methods, make a subclass with no initializer,
+# so we can get at the methods without triggering one of the things
+# tested above.
+#
+class Giblets < WavefrontCliController
+  def initialize; end
+end
+
+class GibletsTest < MiniTest::Test
+  attr_reader :wfc
+
+  def setup
+    @wfc = Giblets.new
+  end
+
+  def test_sanitize_keys
+    h_in = { '--help': true, stuff: false, 'key' => 'value' }
+    assert_equal(wfc.sanitize_keys(h_in),
+                 { help: true, stuff: false, key: 'value' })
+  end
+end

data/spec/wavefront-cli/display/base_spec.rb

@@ -1,7 +1,5 @@
 #!/usr/bin/env ruby
 
-CMD = 'test'.freeze
-
 require 'date'
 require 'map'
 require 'pathname'

data/spec/wavefront-cli/display/spec_helper.rb

@@ -1,5 +1,3 @@
 require 'minitest/autorun'
 require 'minitest/spec'
 require 'spy/integration'
-
-TW = 80

data/spec/wavefront-cli/opt_handler_spec.rb

@@ -0,0 +1,102 @@
+#!/usr/bin/env ruby
+
+require_relative '../spec_helper'
+require_relative '../../lib/wavefront-cli/opt_handler'
+
+# Test option handler class. End to end tests because the work is
+# always done in the constructor
+#
+class OptHandlerTest < MiniTest::Test
+
+  # This one has to be kind of vague because I have a config file on
+  # the box I develop on, which will always be picked up. Other
+  # tests are more specific
+  def test_no_opts
+    x = WavefrontCli::OptHandler.new
+    assert x.is_a?(WavefrontCli::OptHandler)
+    assert x.opts.is_a?(Hash)
+    assert x.opts.keys.include?(:endpoint)
+  end
+
+  def test_no_config_no_env
+    opts = { config: '/nosuchfile' }
+    x = WavefrontCli::OptHandler.new(opts)
+    o = x.opts
+    assert x.is_a?(WavefrontCli::OptHandler)
+    assert o.is_a?(Hash)
+    refute o.keys.include?(:token)
+    assert_equal(o[:config], '/nosuchfile')
+    assert_equal(o[:endpoint], 'metrics.wavefront.com')
+
+    assert_output("config file '/nosuchfile' not found.\n") do
+      WavefrontCli::OptHandler.new(opts)
+    end
+  end
+
+  def test_no_config_env
+    ENV['WAVEFRONT_TOKEN'] = 'abcd1234'
+    ENV['WAVEFRONT_ENDPOINT'] = 'myendpoint.wavefront.com'
+    opts = { config: '/nosuchfile' }
+    x = WavefrontCli::OptHandler.new(opts)
+    o = x.opts
+    assert x.is_a?(WavefrontCli::OptHandler)
+    assert o.is_a?(Hash)
+    assert_equal(o[:token], 'abcd1234')
+    assert_equal(o[:config], '/nosuchfile')
+    assert_equal(o[:endpoint], 'myendpoint.wavefront.com')
+    refute o.keys.include?(:proxy)
+
+    assert_output("config file '/nosuchfile' not found.\n") do
+      WavefrontCli::OptHandler.new(opts)
+    end
+    ENV['WAVEFRONT_TOKEN'] = nil
+    ENV['WAVEFRONT_ENDPOINT'] = nil
+  end
+
+  def test_default_config_no_env
+    opts = { config: CF }
+    x = WavefrontCli::OptHandler.new(opts)
+    o = x.opts
+    assert x.is_a?(WavefrontCli::OptHandler)
+    assert o.is_a?(Hash)
+    assert_equal(o[:token], '12345678-abcd-1234-abcd-123456789012')
+    assert_equal(o[:config], CF)
+    assert_equal(o[:endpoint], 'default.wavefront.com')
+    assert_equal(o[:proxy], 'wavefront.localnet')
+    assert_output("") { WavefrontCli::OptHandler.new(opts) }
+  end
+
+  def test_alt_config_env
+    ENV['WAVEFRONT_TOKEN'] = 'abdc1234'
+    ENV['WAVEFRONT_ENDPOINT'] = nil
+    opts = { config: CF, profile: 'other' }
+    x = WavefrontCli::OptHandler.new(opts)
+    o = x.opts
+    assert x.is_a?(WavefrontCli::OptHandler)
+    assert o.is_a?(Hash)
+    assert_equal(o[:token], 'abdc1234')
+    assert_equal(o[:config], CF)
+    assert_equal(o[:endpoint], 'other.wavefront.com')
+    assert_equal(o[:proxy], 'otherwf.localnet')
+    assert_output("") { WavefrontCli::OptHandler.new(opts) }
+    ENV['WAVEFRONT_TOKEN'] = nil
+    ENV['WAVEFRONT_ENDPOINT'] = nil
+  end
+
+  def test_alt_config_env
+    ENV['WAVEFRONT_TOKEN'] = nil
+    ENV['WAVEFRONT_ENDPOINT'] = 'myendpoint.wavefront.com'
+    opts = { config: CF, profile: 'other' }
+    x = WavefrontCli::OptHandler.new(opts)
+    o = x.opts
+    assert x.is_a?(WavefrontCli::OptHandler)
+    assert o.is_a?(Hash)
+    assert_equal(o[:token], 'abcdefab-0123-abcd-0123-abcdefabcdef')
+    assert_equal(o[:config], CF)
+    assert_equal(o[:endpoint], 'myendpoint.wavefront.com')
+    assert_equal(o[:proxy], 'otherwf.localnet')
+    assert_output("") { WavefrontCli::OptHandler.new(opts) }
+    ENV['WAVEFRONT_TOKEN'] = nil
+    ENV['WAVEFRONT_ENDPOINT'] = nil
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-cli
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.1.3
 platform: ruby
 authors:
 - Robert Fisher
@@ -217,7 +217,6 @@ files:
 - spec/spec_helper.rb
 - spec/wavefront-cli/alert_spec.rb
 - spec/wavefront-cli/base_spec.rb
-- spec/wavefront-cli/cli_help_spec.rb
 - spec/wavefront-cli/cloudintegration_spec.rb
 - spec/wavefront-cli/commands/alert_spec.rb
 - spec/wavefront-cli/commands/base_spec.rb
@@ -233,6 +232,7 @@ files:
 - spec/wavefront-cli/commands/webhook_spec.rb
 - spec/wavefront-cli/commands/window_spec.rb
 - spec/wavefront-cli/commands/write_spec.rb
+- spec/wavefront-cli/controller_spec.rb
 - spec/wavefront-cli/dashboard_spec.rb
 - spec/wavefront-cli/display/base_spec.rb
 - spec/wavefront-cli/display/printer/base_spec.rb
@@ -245,9 +245,10 @@ files:
 - spec/wavefront-cli/maintanancewindow_spec.rb
 - spec/wavefront-cli/message_spec.rb
 - spec/wavefront-cli/metric_spec.rb
+- spec/wavefront-cli/opt_handler_spec.rb
 - spec/wavefront-cli/proxy_spec.rb
 - spec/wavefront-cli/query_spec.rb
-- spec/wavefront-cli/resources/conf.yaml
+- spec/wavefront-cli/resources/wavefront.conf
 - spec/wavefront-cli/savedsearch_spec.rb
 - spec/wavefront-cli/source_spec.rb
 - spec/wavefront-cli/string_spec.rb
@@ -282,7 +283,6 @@ test_files:
 - spec/spec_helper.rb
 - spec/wavefront-cli/alert_spec.rb
 - spec/wavefront-cli/base_spec.rb
-- spec/wavefront-cli/cli_help_spec.rb
 - spec/wavefront-cli/cloudintegration_spec.rb
 - spec/wavefront-cli/commands/alert_spec.rb
 - spec/wavefront-cli/commands/base_spec.rb
@@ -298,6 +298,7 @@ test_files:
 - spec/wavefront-cli/commands/webhook_spec.rb
 - spec/wavefront-cli/commands/window_spec.rb
 - spec/wavefront-cli/commands/write_spec.rb
+- spec/wavefront-cli/controller_spec.rb
 - spec/wavefront-cli/dashboard_spec.rb
 - spec/wavefront-cli/display/base_spec.rb
 - spec/wavefront-cli/display/printer/base_spec.rb
@@ -310,9 +311,10 @@ test_files:
 - spec/wavefront-cli/maintanancewindow_spec.rb
 - spec/wavefront-cli/message_spec.rb
 - spec/wavefront-cli/metric_spec.rb
+- spec/wavefront-cli/opt_handler_spec.rb
 - spec/wavefront-cli/proxy_spec.rb
 - spec/wavefront-cli/query_spec.rb
-- spec/wavefront-cli/resources/conf.yaml
+- spec/wavefront-cli/resources/wavefront.conf
 - spec/wavefront-cli/savedsearch_spec.rb
 - spec/wavefront-cli/source_spec.rb
 - spec/wavefront-cli/string_spec.rb