wavefront-cli 2.4.0 → 2.5.0

data/lib/wavefront-cli/display/alert.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 module WavefrontDisplay
   #

data/lib/wavefront-cli/display/cloudintegration.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 module WavefrontDisplay
   #

data/lib/wavefront-cli/display/dashboard.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 module WavefrontDisplay
   #

data/lib/wavefront-cli/display/derivedmetric.rb

@@ -0,0 +1,14 @@
+require_relative 'base'
+
+module WavefrontDisplay
+  #
+  # Format human-readable output for derived metric definitions.
+  #
+  class DerivedMetric < Base
+    def do_describe
+      readable_time(:created, :updated, :createdEpochMillis,
+                    :updatedEpochMillis)
+      long_output
+    end
+  end
+end

data/lib/wavefront-cli/display/event.rb

@@ -1,5 +1,5 @@
 require 'date'
-require_relative './base'
+require_relative 'base'
 
 module WavefrontDisplay
   #

data/lib/wavefront-cli/display/externallink.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 module WavefrontDisplay
   #

data/lib/wavefront-cli/display/integration.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 module WavefrontDisplay
   #

data/lib/wavefront-cli/display/maintenancewindow.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 module WavefrontDisplay
   #

data/lib/wavefront-cli/display/message.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 module WavefrontDisplay
   #

data/lib/wavefront-cli/display/metric.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 module WavefrontDisplay
   #

data/lib/wavefront-cli/display/notificant.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 module WavefrontDisplay
   #

data/lib/wavefront-cli/display/printer/long.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 require_relative '../../string'
 
 module WavefrontDisplayPrinter

data/lib/wavefront-cli/display/printer/sparkline.rb

@@ -0,0 +1,54 @@
+# The Unicode characters which we use to make a sparkline
+#
+BLOCKS = [' ', "\u2581", "\u2582", "\u2583", "\u2585", "\u2586",
+          "\u2587", "\u2588"].freeze
+
+# How long the sparkline should be
+#
+SPARK_WIDTH = TW - 20
+
+# A class to create very simple single-row sparklines of a Wavefront
+# result.
+#
+class WavefrontSparkline
+  attr_reader :sparkline
+
+  def initialize(series)
+    @sparkline = '>' + generate_sparkline(series) + '<'
+  end
+
+  # @return [String] the block corresponding to the given value in
+  #   the given range. The `rescue` clause handles occasions when
+  #   Wavefront returns NaN as a value, or if the range is zero.
+  #
+  def sized_block(v, range)
+    BLOCKS[(v / range * (BLOCKS.length - 1)).floor]
+  rescue StandardError
+    BLOCKS.first
+  end
+
+  # A recursive function which repeatedly halves a data series until
+  # it fits inside SPARK_WIDTH characters. It does this by merging
+  # adjacent pairs and finding the mean. This is crude.
+  # @param vals [Array] a series of values to display
+  # @return [Array]
+  #
+  def make_fit(vals)
+    return vals if vals.size < SPARK_WIDTH
+    vals.<< vals.last if vals.size.odd?
+    ret = vals.each_slice(2).with_object([]) { |s, a| a.<< s.inject(:+) / 2 }
+    make_fit(ret)
+  end
+
+  # @param data [Array] a series of [time, value] data points
+  # @return [String] the sparkline itself
+  #
+  def generate_sparkline(data)
+    values = data.map { |_k, v| v }
+    max = values.max || 0
+    min = values.min || 0
+    v_range = max - min
+    values = make_fit(values)
+    values.map { |v| sized_block(v - min, v_range) }.join
+  end
+end

data/lib/wavefront-cli/display/printer/terse.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 module WavefrontDisplayPrinter
 

data/lib/wavefront-cli/display/proxy.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 module WavefrontDisplay
   #

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

@@ -1,4 +1,5 @@
-require_relative './base'
+require_relative 'base'
+require_relative 'printer/sparkline'
 
 module WavefrontDisplay
   #
@@ -6,29 +7,37 @@ module WavefrontDisplay
   #
   class Query < Base
     def do_default
-      ts = if data.key?(:timeseries)
-             data[:timeseries].each do |s|
-               s[:data] = humanize_series(s[:data])
-             end
-           else
-             []
-           end
-
-      events = if data.key?(:events)
-                 data[:events].map { |s| humanize_event(s) }
-               else
-                 []
-               end
-
-      new = { name:       data.name,
-              query:      data.query,
-              timeseries: ts,
-              events:     events }
-
-      @data = new
+      d_obj = { name:       data.name,
+                query:      data.query,
+                timeseries: mk_timeseries(data),
+                events:     mk_events(data) }
+
+      if data.key?(:warnings) && !options[:nowarn]
+        d_obj[:warnings] = data[:warnings]
+      end
+
+      @data = d_obj
       long_output
     end
 
+    def mk_timeseries(data)
+      return []  unless data.key?(:timeseries)
+
+      data[:timeseries].each do |s|
+        unless options[:nospark]
+          s[:sparkline] = WavefrontSparkline.new(s[:data]).sparkline
+          s.reorder!({label: nil, sparkline: nil})
+        end
+
+        s[:data] = humanize_series(s[:data])
+      end
+    end
+
+    def mk_events(data)
+      return [] unless data.key?(:events)
+      data[:events].map { |s| humanize_event(s) }
+    end
+
     def do_run
       do_default
     end

data/lib/wavefront-cli/display/report.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 module WavefrontDisplay
   #

data/lib/wavefront-cli/display/savedsearch.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 module WavefrontDisplay
   #

data/lib/wavefront-cli/display/source.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 module WavefrontDisplay
   #

data/lib/wavefront-cli/display/user.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 module WavefrontDisplay
   #

data/lib/wavefront-cli/display/webhook.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 module WavefrontDisplay
   #

data/lib/wavefront-cli/display/write.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 module WavefrontDisplay
   # Format human-readable output when writing points.

data/lib/wavefront-cli/event.rb

@@ -1,6 +1,6 @@
 require 'fileutils'
 require 'wavefront-sdk/mixins'
-require_relative './base'
+require_relative 'base'
 require 'open3'
 
 EVENT_STATE_DIR = Pathname.new('/var/tmp/wavefront')

data/lib/wavefront-cli/externallink.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 module WavefrontCli
   #

data/lib/wavefront-cli/integration.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 module WavefrontCli
   #

data/lib/wavefront-cli/maintenancewindow.rb

@@ -1,5 +1,5 @@
 require 'wavefront-sdk/mixins'
-require_relative './base'
+require_relative 'base'
 
 module WavefrontCli
   #

data/lib/wavefront-cli/message.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 module WavefrontCli
   #

data/lib/wavefront-cli/metric.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 module WavefrontCli
   #

data/lib/wavefront-cli/notificant.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 module WavefrontCli
   #

data/lib/wavefront-cli/opt_handler.rb

@@ -1,7 +1,7 @@
 require 'inifile'
 require 'pathname'
 require 'wavefront-sdk/credentials'
-require_relative './constants.rb'
+require_relative 'constants.rb'
 
 module WavefrontCli
   #

data/lib/wavefront-cli/proxy.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 module WavefrontCli
   #

data/lib/wavefront-cli/query.rb

@@ -1,5 +1,5 @@
 require 'wavefront-sdk/mixins'
-require_relative './base'
+require_relative 'base'
 
 module WavefrontCli
   #

data/lib/wavefront-cli/savedsearch.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 module WavefrontCli
   #

data/lib/wavefront-cli/source.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 module WavefrontCli
   #

data/lib/wavefront-cli/string.rb

@@ -9,7 +9,7 @@ class String
   #
   def cmd_fold(tw = TW, indent = 10)
     gsub(/(-\w) /, '\\1^').scan_line(tw - 12).join("\n" + ' ' * indent)
-                          .tr('^', ' ')
+                          .restored
   end
 
   # Wrapper around #fold()
@@ -24,8 +24,8 @@ class String
 
   # Fold long lines with a hanging indent. Originally a special case
   # for option folding, now addded the prefix parameter to make it
-  # more general.
-  #
+  # more general. Don't line-break default values, because it also
+  # breaks docopt.
   #
   # @param tw [Integer] terminal width
   # @param indent [Integer] size of hanging indent, in chars
@@ -33,16 +33,23 @@ class String
   # @return [String] the folded line
   #
   def fold(tw = TW, indent = 10, prefix = '')
-    chunks = scan_line(tw - 8)
+    chunks = gsub(/default: /, 'default:^').scan_line(tw - 8)
     first_line = format("%s%s\n", prefix, chunks.shift)
 
-    return first_line if chunks.empty?
+    return first_line.restored if chunks.empty?
 
     rest = chunks.join(' ').scan_line(tw - indent - 5).map do |l|
       prefix + ' ' * indent + l
     end
 
-    first_line + rest.join("\n") + "\n"
+    (first_line + rest.join("\n") + "\n").restored
+  end
+
+  # We use a carat as a temporary whitespace character to avoid
+  # undesirable line breaking. This puts it back
+  #
+  def restored
+    tr('^', ' ')
   end
 
   # @param width [Integer] length of longest string (width of

data/lib/wavefront-cli/user.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 module WavefrontCli
   #

data/lib/wavefront-cli/version.rb

@@ -1 +1 @@
-WF_CLI_VERSION = '2.4.0'.freeze
+WF_CLI_VERSION = '2.5.0'.freeze

data/lib/wavefront-cli/webhook.rb

@@ -1,4 +1,4 @@
-require_relative './base'
+require_relative 'base'
 
 module WavefrontCli
   #

data/spec/spec_helper.rb

@@ -162,27 +162,27 @@ def list_tests(cmd, pth = nil, k = nil)
               k)
 end
 
-def tag_tests(cmd, id, bad_id, pth = nil)
+def tag_tests(cmd, id, bad_id, pth = nil, k = nil)
   pth ||= cmd
-  cmd_to_call(cmd, "tags #{id}", path: "/api/v2/#{pth}/#{id}/tag")
+  cmd_to_call(cmd, "tags #{id}", { path: "/api/v2/#{pth}/#{id}/tag" }, k)
   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)
+              { method: :post,
+                path:    "/api/v2/#{pth}/#{id}/tag",
+                body:    %w[mytag].to_json,
+                headers: JSON_POST_HEADERS }, k)
   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)
+              { method: :post,
+                path: "/api/v2/#{pth}/#{id}/tag",
+                body: %w[mytag1 mytag2].to_json,
+                headers: JSON_POST_HEADERS }, k)
   cmd_to_call(cmd, "tag add #{id} mytag",
-              method: :put, path: "/api/v2/#{pth}/#{id}/tag/mytag")
+              { method: :put, path: "/api/v2/#{pth}/#{id}/tag/mytag" }, k)
   cmd_to_call(cmd, "tag delete #{id} mytag",
-              method: :delete, path: "/api/v2/#{pth}/#{id}/tag/mytag")
-  cmd_to_call(cmd, "tag clear #{id}", method:  :post,
-                                      path:    "/api/v2/#{pth}/#{id}/tag",
-                                      body:    [].to_json,
-                                      headers: JSON_POST_HEADERS)
+              { method: :delete, path: "/api/v2/#{pth}/#{id}/tag/mytag" }, k)
+  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}"])