wavefront-cli 2.8.0 → 2.9.0

data/lib/wavefront-cli/exception.rb

@@ -1,6 +1,14 @@
 module WavefrontCli
   class Exception
+    class CredentialError < RuntimeError; end
+    class FileNotFound < IOError; end
+    class InsufficientData < RuntimeError; end
+    class InvalidInput < RuntimeError; end
+    class SystemError < RuntimeError; end
     class UnhandledCommand < RuntimeError; end
+    class UnparseableInput < RuntimeError; end
+    class UnsupportedFileFormat < RuntimeError; end
+    class UnsupportedOperation < RuntimeError; end
     class UnsupportedOutput < RuntimeError; end
   end
 end

data/lib/wavefront-cli/externallink.rb

@@ -12,5 +12,35 @@ module WavefrontCli
     def validator_exception
       Wavefront::Exception::InvalidExternalLinkId
     end
+
+    def do_create
+      body = { name:              options[:'<name>'],
+               template:          options[:'<template>'],
+               description:       options[:'<description>'],
+               metricFilterRegex: options[:metricregex],
+               sourceFilterRegex: options[:sourceregex],
+               pointFilterRegex:  point_filter_regexes }
+
+      wf.create(body.select { |_k, v| v })
+    end
+
+    def search_key
+      :extlink
+    end
+
+    private
+
+    def point_filter_regexes
+      ret = options[:pointregex].each_with_object({}) do |r, a|
+        begin
+          k, v = r.split('=', 2)
+          a[k.to_sym] = v
+        rescue StandardError
+          puts "cannot parse point regex '#{r}'. Skipping."
+        end
+      end
+
+      ret.empty? ? nil : ret
+    end
   end
 end

data/lib/wavefront-cli/maintenancewindow.rb

@@ -78,8 +78,8 @@ module WavefrontCli
       change_end_time(Time.now.to_i)
     end
 
-    def change_end_time(ts)
-      wf.update(options[:'<id>'], endTimeInSeconds: ts)
+    def change_end_time(timestamp)
+      wf.update(options[:'<id>'], endTimeInSeconds: timestamp)
     end
   end
 end

data/lib/wavefront-cli/output/hcl/base.rb

@@ -2,6 +2,9 @@ require 'securerandom'
 require 'json'
 
 module WavefrontHclOutput
+  #
+  # Output stuff for Hashicorp Configuration Language
+  #
   class Base
     attr_reader :resp, :options
 
@@ -49,43 +52,43 @@ module WavefrontHclOutput
     end
 
     # Format each key-value pair
-    # @param k [String] key
-    # @param v [Any] value
+    # @param key [String] key
+    # @param val [Any] value
     # @return [String]
     #
-    def handler(k, v)
-      key_handler = "khandle_#{k}".to_sym
-      value_handler = "vhandle_#{k}".to_sym
-      quote_handler = "qhandle_#{k}".to_sym
-      k = send(key_handler) if respond_to?(key_handler)
-      v = send(value_handler, v) if respond_to?(value_handler)
+    def handler(key, val)
+      key_handler = "khandle_#{key}".to_sym
+      value_handler = "vhandle_#{key}".to_sym
+      quote_handler = "qhandle_#{key}".to_sym
+      key = send(key_handler) if respond_to?(key_handler)
+      val = send(value_handler, val) if respond_to?(value_handler)
 
       quote_handler = :quote_value unless respond_to?(quote_handler)
 
-      format('  %s = %s', k.to_snake, send(quote_handler, v))
+      format('  %s = %s', key.to_snake, send(quote_handler, val))
     end
 
     # Tags need to be in an array. They aren't always called "tags"
     # by the API.
-    # @param v [Array,Hash,String] tags
+    # @param val [Array,Hash,String] tags
     # @return [Array] of soft-quoted tags
     #
-    def vhandle_tags(v)
-      v = v.values if v.is_a?(Hash)
-      Array(v).flatten
+    def vhandle_tags(val)
+      val = val.values if val.is_a?(Hash)
+      Array(val).flatten
     end
 
     # Some values need to be quoted, some need to be escaped etc
     # etc.
-    # @param v [Object] value
+    # @param val [Object] value
     # @return [String]
     #
-    def quote_value(v)
-      case v.class.to_s.to_sym
+    def quote_value(val)
+      case val.class.to_s.to_sym
       when :String
-        format('"%s"', v.gsub(/\"/, '\"'))
+        format('"%s"', val.gsub(/\"/, '\"'))
       else
-        v
+        val
       end
     end
   end

data/lib/wavefront-cli/output/hcl/dashboard.rb

@@ -1,4 +1,6 @@
 require_relative 'base'
+require_relative 'stdlib/string'
+require_relative 'stdlib/array'
 
 module WavefrontHclOutput
   #
@@ -11,7 +13,7 @@ module WavefrontHclOutput
   # in https://github.com/spaceapegames/terraform-provider-wavefront/blob/master/wavefront/resource_dashboard.go
   #
   class Dashboard < Base
-
+    #
     # Top-level fields
     #
     def hcl_fields
@@ -23,16 +25,16 @@ module WavefrontHclOutput
     end
 
     # @param vals [Array] an array of objects
-    # @param fn [Symbol] a method which knows how to deal with one
+    # @param method [Symbol] a method which knows how to deal with one
     #   of the objects in vals
     # @return [String] HCL list of vals
     #
-    def listmaker(vals, fn)
-      vals.each_with_object([]) { |v, a| a.<< send(fn, v) }.to_hcl_list
+    def listmaker(vals, method)
+      vals.each_with_object([]) { |v, a| a.<< send(method, v) }.to_hcl_list
     end
 
-    def vhandle_sections(v)
-      v.each_with_object([]) do |section, a|
+    def vhandle_sections(vals)
+      vals.each_with_object([]) do |section, a|
         a.<< ("name = \"#{section[:name]}\"\n      row = " +
               handle_rows(section[:rows])).braced(4)
       end.to_hcl_list
@@ -40,7 +42,7 @@ module WavefrontHclOutput
 
     def handle_rows(rows)
       rows.each_with_object([]) do |row, a|
-        a.<< ("chart = " + handle_charts(row[:charts]).to_s).braced(8)
+        a.<< ('chart = ' + handle_charts(row[:charts]).to_s).braced(8)
       end.to_hcl_list
     end
 
@@ -75,40 +77,13 @@ module WavefrontHclOutput
       end.to_hcl_obj(14)
     end
 
-    def qhandle_sections(v)
-      v
+    def qhandle_sections(val)
+      val
     end
 
-    def quote_value(v)
-      v.gsub!(/\$/, '$$') if v.is_a?(String)
+    def quote_value(val)
+      val.gsub!(/\$/, '$$') if v.is_a?(String)
       super
     end
   end
 end
-
-class String
-  def braced(indent = 0)
-    pad = ' ' * indent
-    "\n#{pad}{#{self}\n#{pad}}"
-  end
-end
-
-class Array
-  #
-  # Turn an array into a string which represents an HCL list
-  # @return [String]
-  #
-  def to_hcl_list
-    '[' + self.join(',') + ']'
-  end
-
-  # Turn an array into a string which represents an HCL object
-  # @return [String]
-  #
-  def to_hcl_obj(indent = 0)
-    outpad = ' ' * indent
-    inpad = ' ' * (indent + 2)
-
-    "\n#{outpad}{\n#{inpad}" + self.join("\n#{inpad}") + "\n#{outpad}}"
-  end
-end

data/lib/wavefront-cli/output/hcl/notificant.rb

@@ -11,8 +11,8 @@ module WavefrontHclOutput
          contentType customHttpHeaders]
     end
 
-    def vhandle_template(v)
-      v.gsub(/\s*\n/, '')
+    def vhandle_template(val)
+      val.gsub(/\s*\n/, '')
     end
 
     def resource_name
@@ -23,8 +23,10 @@ module WavefrontHclOutput
       'name'
     end
 
+    # rubocop:disable Naming/MethodName
     def khandle_customHttpHeaders
       'custom_headers'
     end
+    # rubocop:enable Naming/MethodName
   end
 end

data/lib/wavefront-cli/output/hcl/stdlib/array.rb

@@ -0,0 +1,22 @@
+#
+# Extensions to stdlib Array
+#
+class Array
+  #
+  # Turn an array into a string which represents an HCL list
+  # @return [String]
+  #
+  def to_hcl_list
+    '[' + join(',') + ']'
+  end
+
+  # Turn an array into a string which represents an HCL object
+  # @return [String]
+  #
+  def to_hcl_obj(indent = 0)
+    outpad = ' ' * indent
+    inpad = ' ' * (indent + 2)
+
+    "\n#{outpad}{\n#{inpad}" + join("\n#{inpad}") + "\n#{outpad}}"
+  end
+end

data/lib/wavefront-cli/output/hcl/stdlib/string.rb

@@ -0,0 +1,9 @@
+#
+# Extensions to stdlib String
+#
+class String
+  def braced(indent = 0)
+    pad = ' ' * indent
+    "\n#{pad}{#{self}\n#{pad}}"
+  end
+end

data/lib/wavefront-cli/output/wavefront/base.rb

@@ -1,4 +1,7 @@
 module WavefrontWavefrontOutput
+  #
+  # Standard output template
+  #
   class Base
     attr_reader :resp, :options
 

data/lib/wavefront-cli/output/wavefront/query.rb

@@ -39,8 +39,8 @@ module WavefrontWavefrontOutput
       end
     end
 
-    def wavefront_format(path, value, ts, source, tags = nil)
-      arr = [path, value, ts, format('source=%s', source)]
+    def wavefront_format(path, value, timestamp, source, tags = nil)
+      arr = [path, value, timestamp, format('source=%s', source)]
       arr.<< tags.to_wf_tag if tags && !tags.empty?
       arr.join(' ')
     end

data/lib/wavefront-cli/query.rb

@@ -51,6 +51,7 @@ module WavefrontCli
 
     # @return [Hash] options for the SDK query method
     #
+    # rubocop:disable Metrics/AbcSize
     def q_opts
       ret = { autoEvents:             options[:events],
               i:                      options[:inclusive],
@@ -64,6 +65,7 @@ module WavefrontCli
       ret[:p] = options[:points] if options[:points]
       ret
     end
+    # rubocop:enable Metrics/AbcSize
 
     # @return [Integer] start of query window. If one has been
     #   given, that; if not, ten minutes ago

data/lib/wavefront-cli/report.rb

@@ -1,9 +1,12 @@
 require_relative 'base_write'
 
 module WavefrontCli
+  #
+  # Write metrics direct to Wavefront. Sister of WavefrontCli::Write
+  #
   class Report < BaseWrite
-    def send_point(p)
-      call_write(p)
+    def send_point(point)
+      call_write(point)
     rescue Wavefront::Exception::InvalidEndpoint
       abort 'could not speak to API'
     end

data/lib/wavefront-cli/{string.rb → stdlib/string.rb}

@@ -4,22 +4,22 @@ class String
   # Fold long command lines. We can't break on a space after an
   # option or it confuses docopt.
   #
-  # @param tw [Integer] terminal width
+  # @param twidth [Integer] terminal width
   # @param indent [Integer] size of hanging indent, in chars
   #
-  def cmd_fold(tw = TW, indent = 10)
-    gsub(/(-\w) /, '\\1^').scan_line(tw - 12).join("\n" + ' ' * indent)
+  def cmd_fold(twidth = TW, indent = 10)
+    gsub(/(-\w) /, '\\1^').scan_line(twidth - 12).join("\n" + ' ' * indent)
                           .restored
   end
 
   # Wrapper around #fold()
   #
-  # @param tw [Integer] width of terminal, in chars
+  # @param twidth [Integer] width of terminal, in chars
   # @param indent [Integer] hanging indent of following lines
   # @return [String] folded and indented string
   #
-  def opt_fold(tw = TW, indent = 10)
-    fold(tw, indent, '  ')
+  def opt_fold(twidth = TW, indent = 10)
+    fold(twidth, indent, '  ')
   end
 
   # Fold long lines with a hanging indent. Originally a special case
@@ -27,23 +27,25 @@ class String
   # more general. Don't line-break default values, because it also
   # breaks docopt.
   #
-  # @param tw [Integer] terminal width
+  # @param twidth [Integer] terminal width
   # @param indent [Integer] size of hanging indent, in chars
   # @param prefix [String] prepended to every line
   # @return [String] the folded line
   #
-  def fold(tw = TW, indent = 10, prefix = '')
-    chunks = gsub(/default: /, 'default:^').scan_line(tw - 8)
+  # rubocop:disable Metrics/AbcSize
+  def fold(twidth = TW, indent = 10, prefix = '')
+    chunks = gsub(/default: /, 'default:^').scan_line(twidth - 8)
     first_line = format("%s%s\n", prefix, chunks.shift)
 
     return first_line.restored if chunks.empty?
 
-    rest = chunks.join(' ').scan_line(tw - indent - 5).map do |l|
+    rest = chunks.join(' ').scan_line(twidth - indent - 5).map do |l|
       prefix + ' ' * indent + l
     end
 
     (first_line + rest.join("\n") + "\n").restored
   end
+  # rubocop:enable Metrics/AbcSize
 
   # We use a carat as a temporary whitespace character to avoid
   # undesirable line breaking. This puts it back
@@ -84,7 +86,9 @@ class String
   # @return [String]
   #
   def to_snake
-    self.gsub(/(.)([A-Z])/) { Regexp.last_match[1] + '_' +
-                              Regexp.last_match[2].downcase }
+    gsub(/(.)([A-Z])/) do
+      Regexp.last_match[1] + '_' +
+        Regexp.last_match[2].downcase
+    end
   end
 end

data/lib/wavefront-cli/version.rb

@@ -1 +1 @@
-WF_CLI_VERSION = '2.8.0'.freeze
+WF_CLI_VERSION = '2.9.0'.freeze

data/lib/wavefront-cli/write.rb

@@ -12,11 +12,19 @@ module WavefrontCli
     end
 
     def validate_opts
-      unless options[:metric] || options[:format].include?('m')
-        abort "Supply a metric path in the file or with '-m'."
-      end
+      validate_opts_file if options[:file]
+
+      return true if options[:proxy]
+      raise(WavefrontCli::Exception::CredentialError,
+            'Missing proxy address.')
+    end
 
-      raise 'Please supply a proxy address.' unless options[:proxy]
+    def validate_opts_file
+      unless options[:metric] || (options.key?(:infileformat) &&
+                                  options[:infileformat].include?('m'))
+        raise(WavefrontCli::Exception::InsufficientData,
+              "Supply a metric path in the file or with '-m'.")
+      end
     end
 
     def open_connection

data/spec/spec_helper.rb

@@ -8,13 +8,17 @@ require 'pathname'
 require_relative '../lib/wavefront-cli/controller'
 
 def all_commands
-  (Pathname.new(__FILE__).dirname.parent + 'lib' + 'wavefront-cli' +
-   'commands').children.each.with_object([]) do |c, a|
-    a.<< c.basename.to_s.chomp('.rb') unless c.basename.to_s == 'base.rb'
+  cmd_dir = ROOT + 'lib' + 'wavefront-cli' + 'commands'
+
+  files = cmd_dir.children.select do |f|
+    f.extname == '.rb' && f.basename.to_s != 'base.rb'
   end
+
+  files.each.with_object([]) { |c, a| a.<< c.basename.to_s.chomp('.rb') }
 end
 
 unless defined?(CMD)
+  ROOT = Pathname.new(__FILE__).dirname.parent
   CMD = 'wavefront'.freeze
   ENDPOINT = 'metrics.wavefront.com'.freeze
   TOKEN = '0123456789-ABCDEF'.freeze
@@ -75,10 +79,12 @@ def cmd_to_call(word, args, call, sdk_class = nil)
         it "runs #{cmd} and makes the correct API call" do
           if call.key?(:body)
             stub_request(method, uri).with(headers: h, body: call[:body])
-                                     .to_return(body: {}.to_json, status: 200)
+                                     .to_return(body: {}.to_json,
+                                                status: 200)
           else
             stub_request(method, uri).with(headers: h)
-                                     .to_return(body: {}.to_json, status: 200)
+                                     .to_return(body: {}.to_json,
+                                                status: 200)
           end
 
           require "wavefront-sdk/#{sdk_class.name.split('::').last.downcase}"
@@ -88,6 +94,7 @@ def cmd_to_call(word, args, call, sdk_class = nil)
             ),
             :respond
           ).and_return({})
+
           d = Spy.on_instance_method(sdk_class, :display)
           WavefrontCliController.new(cmd.split)
           assert d.has_been_called?
@@ -98,6 +105,7 @@ def cmd_to_call(word, args, call, sdk_class = nil)
     end
   end
 end
+# rubocop:enable Metrics/AbcSize
 
 # Run a command we expect to fail, returning stdout and stderr
 #
@@ -124,7 +132,7 @@ def invalid_tags(cmd, subcmds)
   subcmds.each do |sc|
     it "fails '#{sc}' because of an invalid tag" do
       _out, err = fail_command("#{cmd} #{sc}")
-      assert_equal(err, "'#{BAD_TAG}' is not a valid tag.\n")
+      assert_equal(err, "Invalid input. '#{BAD_TAG}' is not a valid tag.\n")
     end
   end
 end
@@ -146,7 +154,7 @@ def missing_creds(cmd, subcmds)
     subcmds.each do |subcmd|
       it "'#{subcmd}' errors and tells the user to use a token" do
         out, err = fail_command("#{cmd} #{subcmd} -c /f")
-        assert_match(/supply an API token/, err)
+        assert_equal("Credential error. Missing API token.\n", err)
         assert_match(%r{config file '/f' not found.}, out)
       end
     end
@@ -155,41 +163,50 @@ end
 
 # Generic list tests, needed by most commands
 #
-def list_tests(cmd, pth = nil, k = nil)
+def list_tests(cmd, pth = nil, klass = nil)
   pth ||= cmd
-  cmd_to_call(cmd, 'list', { path: "/api/v2/#{pth}?limit=100&offset=0" }, k)
-  cmd_to_call(cmd, 'list -L 50', { path: "/api/v2/#{pth}?limit=50&offset=0" },
-              k)
+  cmd_to_call(cmd, 'list', { path: "/api/v2/#{pth}?limit=100&offset=0" },
+              klass)
+  cmd_to_call(cmd, 'list -L 50',
+              { path: "/api/v2/#{pth}?limit=50&offset=0" },
+              klass)
   cmd_to_call(cmd, 'list -L 20 -o 8',
-              { path: "/api/v2/#{pth}?limit=20&offset=8" }, k)
-  cmd_to_call(cmd, 'list -o 60', { path: "/api/v2/#{pth}?limit=100&offset=60" },
-              k)
+              { path: "/api/v2/#{pth}?limit=20&offset=8" }, klass)
+  cmd_to_call(cmd, 'list -o 60',
+              { path: "/api/v2/#{pth}?limit=100&offset=60" },
+              klass)
 end
 
-def tag_tests(cmd, id, bad_id, pth = nil, k = nil)
+def tag_tests(cmd, id, bad_id, pth = nil, klass = nil)
   pth ||= cmd
-  cmd_to_call(cmd, "tags #{id}", { path: "/api/v2/#{pth}/#{id}/tag" }, k)
+  cmd_to_call(cmd, "tags #{id}", { path: "/api/v2/#{pth}/#{id}/tag" },
+              klass)
   cmd_to_call(cmd, "tag set #{id} mytag",
               { method: :post,
                 path:    "/api/v2/#{pth}/#{id}/tag",
                 body:    %w[mytag].to_json,
-                headers: JSON_POST_HEADERS }, k)
+                headers: JSON_POST_HEADERS }, klass)
   cmd_to_call(cmd, "tag set #{id} mytag1 mytag2",
               { method: :post,
                 path: "/api/v2/#{pth}/#{id}/tag",
                 body: %w[mytag1 mytag2].to_json,
-                headers: JSON_POST_HEADERS }, k)
+                headers: JSON_POST_HEADERS }, klass)
   cmd_to_call(cmd, "tag add #{id} mytag",
-              { method: :put, path: "/api/v2/#{pth}/#{id}/tag/mytag" }, k)
+              { method: :put, path: "/api/v2/#{pth}/#{id}/tag/mytag" },
+              klass)
   cmd_to_call(cmd, "tag delete #{id} mytag",
-              { method: :delete, path: "/api/v2/#{pth}/#{id}/tag/mytag" }, k)
+              { method: :delete, path: "/api/v2/#{pth}/#{id}/tag/mytag" },
+              klass)
   cmd_to_call(cmd, "tag clear #{id}", { method:  :post,
                                         path:    "/api/v2/#{pth}/#{id}/tag",
                                         body:    [].to_json,
-                                        headers: JSON_POST_HEADERS }, k)
-  invalid_ids(cmd, ["tags #{bad_id}", "tag clear #{bad_id}",
-                    "tag add #{bad_id} mytag", "tag delete #{bad_id} mytag"])
-  invalid_tags(cmd, ["tag add #{id} #{BAD_TAG}", "tag delete #{id} #{BAD_TAG}"])
+                                        headers: JSON_POST_HEADERS }, klass)
+  invalid_ids(cmd, ["tags #{bad_id}",
+                    "tag clear #{bad_id}",
+                    "tag add #{bad_id} mytag",
+                    "tag delete #{bad_id} mytag"])
+  invalid_tags(cmd, ["tag add #{id} #{BAD_TAG}",
+                     "tag delete #{id} #{BAD_TAG}"])
 end
 
 # Load in a canned query response