wavefront-cli 3.1.1 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83c302c633dd23f3749b0afc4b6459c07352a627a6446bba2d692e323c24a1ed
-  data.tar.gz: b9a62872d2961ba16e4328fa4841a382e7a78d788c473df6c4b13518aa26eb67
+  metadata.gz: bfee50381c5609e38fdefab8aa7db8b7daf58fbbc547437d3a09654c65060f0b
+  data.tar.gz: 9fa8ef583e2e0e5547cbd81a84ab5fafe56e1e26b7738918f20d092187e332f6
 SHA512:
-  metadata.gz: 6bd512328c814a40ffc3f4e8cb3384e3bdba1d5d58f5df08f311ae2a4dece9686a38bd3ff13f11ac0fdf11e971dc8dc85b0f9f31558bf25194b021035a5c41b8
-  data.tar.gz: 72e59111e5394b44fc7177dbb9bd38e2a6baa4ee0c388768f2a3d6f5c5803b2a19840db4948b113b3775189dbb50fe4155f6ecd9acd147f035deb83cacfb078f
+  metadata.gz: 2d4c4b99f8e0bdc57fd43f7813b47830e17dfdf4349f9c6ae2fc27b97474ccd3db2db0bc23dd368e937ccdd281c6982489f47438d4cdaad43d8f484cf53f956f
+  data.tar.gz: 2a12e2a4af8f144d3f0dca74265b98dac65d0187320d6d26557725bd559d5c07b965e0987f3232b23d7597df67e31711bf1f22dd01f7cd2e2008dba8396c7aba

data/HISTORY.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 3.1.2 (06/04/2019)
+* Bugfix on handling of invalid config files.
+* Explicitly specifying a missing config file now causes an error
+  whether or not credentials available from other mechanisms.
+* Require 3.0.2 of [the SDK](https://github.com/snltd/wavefront-sdk).
+
 ## 3.1.1 (05/04/2019)
 * Usernames do not have to be e-mail addresses.
 * Require 3.0.1 of [the SDK](https://github.com/snltd/wavefront-sdk).

data/lib/wavefront-cli/config.rb

@@ -161,7 +161,7 @@ module WavefrontCli
 
     def present?
       return true if config_file.exist?
-      raise WavefrontCli::Exception::ConfigFileNotFound
+      raise WavefrontCli::Exception::ConfigFileNotFound, config_file
     end
 
     # @return [Pathname] path to config file, from options, or from

data/lib/wavefront-cli/controller.rb

@@ -72,7 +72,7 @@ class WavefrontCliController
     begin
       [cmd, sanitize_keys(Docopt.docopt(usage[cmd], argv: args))]
     rescue Docopt::DocoptLanguageError => e
-      abort "mangled command description:\n#{e.message}"
+      abort "Mangled command description:\n#{e.message}"
     rescue Docopt::Exit => e
       abort e.message
     end
@@ -109,7 +109,7 @@ class WavefrontCliController
   rescue Interrupt
     abort "\nOperation aborted at user request."
   rescue WavefrontCli::Exception::ConfigFileNotFound => e
-    abort "Configuration file '#{e}' not found."
+    abort "Configuration file #{e}' not found."
   rescue WavefrontCli::Exception::CredentialError => e
     handle_missing_credentials(e)
   rescue WavefrontCli::Exception::MandatoryValue
@@ -153,7 +153,7 @@ class WavefrontCliController
   # @param error [WavefrontCli::Exception::CredentialError]
   #
   def handle_missing_credentials(error)
-    if DEFAULT_CONFIG.exist?
+    if DEFAULT_CONFIG.exist? && DEFAULT_CONFIG.file?
       abort "Credential error. #{error.message}"
     else
       puts 'No credentials supplied on the command line or via ' \

data/lib/wavefront-cli/exception.rb

@@ -1,4 +1,8 @@
 module WavefrontCli
+  #
+  # CLI-specific exceptions. These should generally be caught in the
+  # controller.
+  #
   class Exception
     class CredentialError < RuntimeError; end
     class MandatoryValue < RuntimeError; end

data/lib/wavefront-cli/opt_handler.rb

@@ -29,6 +29,10 @@ module WavefrontCli
       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)
+    rescue WavefrontCli::Exception::ConfigFileNotFound => e
+      abort "Configuration file '#{e}' not found."
+    rescue Wavefront::Exception::InvalidConfigFile => e
+      abort "Could not load configuration file '#{e.message}'."
     end
 
     # Create an options hash to pass to the Wavefront::Credentials
@@ -45,7 +49,7 @@ module WavefrontCli
         cred_opts[:file] = Pathname.new(cli_opts[:config])
 
         unless cred_opts[:file].exist?
-          puts "config file '#{cred_opts[:file]}' not found."
+          raise WavefrontCli::Exception::ConfigFileNotFound, cred_opts[:file]
         end
       end
 

data/lib/wavefront-cli/version.rb

@@ -1 +1 @@
-WF_CLI_VERSION = '3.1.1'.freeze
+WF_CLI_VERSION = '3.1.2'.freeze

data/spec/spec_helper.rb

@@ -248,15 +248,20 @@ end
 def missing_creds(cmd, subcmds)
   describe 'commands with missing credentials' do
     subcmds.each do |subcmd|
-      it "'#{subcmd}' errors and tells the user to use a token" do
-        out, err = fail_command("#{cmd} #{subcmd} -c /f")
-
-        if HOME_CONFIG.exist?
-          assert_equal("Credential error. Missing API token.\n", err)
-          assert_match(%r{config file '/f' not found.}, out)
-        else
-          assert_match(/Please run 'wf config setup'/, out)
-        end
+      it "'#{subcmd}' tells the user config file not found" do
+        _out, err = fail_command("#{cmd} #{subcmd} -c /f")
+        assert_equal("Configuration file '/f' not found.\n", err)
+      end
+
+      # I've generally got a config file on my dev box, but Travis
+      # won't have one. Therefore this test probably won't get run
+      # locally, but it will get run in CI, which is what counts.
+      #
+      next if HOME_CONFIG.exist?
+
+      it "'#{subcmd}' errors and tells the user to generate config" do
+        out, _err = fail_command("#{cmd} #{subcmd}")
+        assert_match(/Please run 'wf config setup'/, out)
       end
     end
   end

data/spec/wavefront-cli/controller_spec.rb

@@ -44,6 +44,21 @@ class WavefrontCliHelpTest < MiniTest::Test
       end
     end
   end
+
+  def test_malformed_config
+    WavefrontCliController.new(['alert', 'list',
+                                "--config=#{RES_DIR}/malformed.conf"])
+  rescue SystemExit => e
+    assert_equal(1, e.status)
+    assert e.message.start_with?('Could not load configuration file')
+  end
+
+  def test_missing_config
+    WavefrontCliController.new(%w[alert list --config=/no/such/file])
+  rescue SystemExit => e
+    assert_equal(1, e.status)
+    assert_equal("Configuration file '/no/such/file' not found.", e.message)
+  end
 end
 
 # To test internal methods, make a subclass with no initializer,

data/spec/wavefront-cli/opt_handler_spec.rb

@@ -3,13 +3,15 @@
 require_relative '../spec_helper'
 require_relative '../../lib/wavefront-cli/opt_handler'
 
+# Some of these tests will be skipped if you have a ~/.wavefront
+# config file. CI will never have that.
+#
+INTERFERING_FILE = Pathname.new(ENV['HOME']) + '.wavefront'
+
 # 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)
@@ -17,37 +19,37 @@ class OptHandlerTest < MiniTest::Test
     assert x.opts.keys.include?(:endpoint)
   end
 
+  def test_missing_config
+    WavefrontCli::OptHandler.new(config: '/no/such/file')
+  rescue SystemExit => e
+    assert_equal(1, e.status)
+    assert_match("Configuration file '/no/such/file' not found.", e.message)
+  end
+
   def test_no_config_no_env
-    opts = { config: '/nosuchfile' }
-    x = WavefrontCli::OptHandler.new(opts)
+    return if INTERFERING_FILE.exist?
+
+    x = WavefrontCli::OptHandler.new({})
     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
+    return if INTERFERING_FILE.exist?
+
     ENV['WAVEFRONT_TOKEN'] = 'abcd1234'
     ENV['WAVEFRONT_ENDPOINT'] = 'myendpoint.wavefront.com'
-    opts = { config: '/nosuchfile' }
-    x = WavefrontCli::OptHandler.new(opts)
+    x = WavefrontCli::OptHandler.new({})
     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_nil o[:config]
     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

data/spec/wavefront-cli/resources/malformed.conf

@@ -0,0 +1 @@
+this is not a valid config file

data/wavefront-cli.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency 'docopt', '~> 0.6.0'
   gem.add_runtime_dependency 'inifile', '~> 3.0'
-  gem.add_runtime_dependency 'wavefront-sdk', '~> 3.0', '>= 3.0.1'
+  gem.add_runtime_dependency 'wavefront-sdk', '~> 3.0', '>= 3.0.2'
 
   gem.add_development_dependency 'minitest', '~> 5.11', '>= 5.11.0'
   gem.add_development_dependency 'rake', '~> 12.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-cli
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.1.2
 platform: ruby
 authors:
 - Robert Fisher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-05 00:00:00.000000000 Z
+date: 2019-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt
@@ -47,7 +47,7 @@ dependencies:
         version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: 3.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -57,7 +57,7 @@ dependencies:
         version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: 3.0.2
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -311,6 +311,7 @@ files:
 - spec/wavefront-cli/resources/display/user-human-long
 - spec/wavefront-cli/resources/display/user-human-long-no_sep
 - spec/wavefront-cli/resources/display/user-input.json
+- spec/wavefront-cli/resources/malformed.conf
 - spec/wavefront-cli/resources/responses/README.md
 - spec/wavefront-cli/resources/responses/alert-list.json
 - spec/wavefront-cli/resources/responses/backups.json
@@ -418,6 +419,7 @@ test_files:
 - spec/wavefront-cli/resources/display/user-human-long
 - spec/wavefront-cli/resources/display/user-human-long-no_sep
 - spec/wavefront-cli/resources/display/user-input.json
+- spec/wavefront-cli/resources/malformed.conf
 - spec/wavefront-cli/resources/responses/README.md
 - spec/wavefront-cli/resources/responses/alert-list.json
 - spec/wavefront-cli/resources/responses/backups.json