wavefront-cli 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f672ae4ac7f81edd35c18b5ceff7a187b2e2450cf31ec4b8551de2b3c2f5521f
-  data.tar.gz: 4c6d64235013f1a56c92f129347d9e006d72c213f51eabc66cc2055aa7497dcb
+  metadata.gz: d72f979bcf612478ecbde4f9b0ac5e6a5e3bb0be3cf756b80a23f5c75d25a3bd
+  data.tar.gz: deec46d8e93bec91ec04ce09cad50fcf69930257bc1655ab60b4e011b3cff08b
 SHA512:
-  metadata.gz: 8b6e35748122d99bcef965a0f86224679537b0b23b7175ac822255c5ee6321c42938c12eba5a1aca2bbe4dd256435c61525558fed3155dbe6eb70b1e5d3d9255
-  data.tar.gz: db39b5d27705c1d5d4a7f8431e306c0f137ef55322ca8bb958895b0ee0b2331f53d1a7d69fce50c5042de2faf8a9d247cb757277139c8bcd6f4c0ddb2388d6c2
+  metadata.gz: 14517c7aaf32a9f6c16c30cc797ed6d4901e9501f31535f60e7b893e526d2e6368c5aa358dabcd7707bebd8e957429774cc316c085eca1620934bcbc4e8e49c6
+  data.tar.gz: 1b935a46c79c0ad620364e03e9c7213267498d4733f91b0eb906af861240a6bd871e1089d4d52e6600824ffc700fe9f5e2e630399c78af31a250a22b1d5d0a9c

data/lib/wavefront-cli/base.rb

@@ -37,6 +37,18 @@ module WavefrontCli
       send(:post_initialize, options) if respond_to?(:post_initialize)
     end
 
+    # Some subcommands don't make an API call, so they don't return
+    # a Wavefront::Response object. You can override this method
+    # with something which returns an array of methods like that.
+    # They will bypass the usual response checking.
+    #
+    # @return [Array[String]] methods which do not include an API
+    # response
+    #
+    def no_api_response
+      []
+    end
+
     def options_and_exit
       puts options
       exit 0
@@ -47,9 +59,9 @@ module WavefrontCli
       dispatch
     end
 
-    # We normally validate with a predictable method name. Alert IDs are
-    # validated with #wf_alert_id? etc. If you need to change that, override
-    # this method.
+    # We normally validate with a predictable method name. Alert IDs
+    # are validated with #wf_alert_id? etc. If you need to change
+    # that, override this method.
     #
     def validator_method
       "wf_#{klass_word}_id?".to_sym
@@ -169,6 +181,10 @@ module WavefrontCli
     #   this output. Used to find a suitable humanize method.
     #
     def display(data, method)
+      if no_api_response.include?(method)
+        return display_no_api_response(data, method)
+      end
+
       exit if options[:noop]
 
       %i[status response].each do |b|
@@ -183,6 +199,10 @@ module WavefrontCli
       handle_response(data.response, format_var, method)
     end
 
+    def display_no_api_response(data, method)
+      handle_response(data, format_var, method)
+    end
+
     def check_status(status)
       status.respond_to?(:result) && status.result == 'OK'
     end

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

@@ -8,10 +8,14 @@ class WavefrontCommandQuery < WavefrontCommandBase
   end
 
   def _commands
-    ["#{CMN} [-g granularity] [-s time] [-e time] [-f format] " \
+    ['aliases [-DV] [-c file] [-P profile]',
+     "#{CMN} [-g granularity] [-s time] [-e time] [-f format] " \
            '[-ivO] [-S mode] [-N name] [-p points] <query>',
-     "raw #{CMN} [-H host] [-s time] [-e time] [-f format] <metric>"]
+     "raw #{CMN} [-H host] [-s time] [-e time] [-f format] <metric>",
+     "run #{CMN} [-g granularity] [-s time] [-e time] [-f format] " \
+           '[-ivO] [-S mode] [-N name] [-p points] <alias>']
   end
+
   def _options
     [common_options,
      '-g, --granularity=STRING  query granularity (d, h, m, or s)',

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

@@ -20,17 +20,19 @@ module WavefrontDisplay
                  []
                end
 
-      new = {
-        name: data.name,
-        query: data.query,
-        timeseries: ts,
-        events: events
-      }
+      new = { name:       data.name,
+              query:      data.query,
+              timeseries: ts,
+              events:     events }
 
       @data = new
       long_output
     end
 
+    def do_run
+      do_default
+    end
+
     def do_raw
       data.each { |ts| puts humanize_series(ts[:points]).join("\n") }
     end
@@ -39,6 +41,16 @@ module WavefrontDisplay
       puts 'API 404: metric does not exist.'
     end
 
+    def do_aliases
+      if data.empty?
+        puts 'No aliases defined.'
+      else
+        data.each { |k, _v| puts k.to_s[2..-1] }
+      end
+    end
+
+    private
+
     def humanize_event(data)
       data[:start] = human_time(data[:start])
       data[:end] = human_time(data[:end]) if data[:end]

data/lib/wavefront-cli/query.rb

@@ -6,17 +6,49 @@ module WavefrontCli
   # CLI coverage for the v2 'query' API.
   #
   class Query < WavefrontCli::Base
+    attr_reader :query_string
+
     include Wavefront::Mixins
 
+    def no_api_response
+      %w[do_aliases]
+    end
+
     def do_default
+      qs = query_string || options[:'<query>']
+
       t_start     = window_start
       t_end       = window_end
       granularity = granularity(t_start, t_end)
       t_end       = nil unless options[:end]
 
-      wf.query(options[:'<query>'], granularity, t_start, t_end, q_opts)
+      wf.query(qs, granularity, t_start, t_end, q_opts)
+    end
+
+    def do_raw
+      wf.raw(options[:'<metric>'], options[:host], options[:start],
+             options[:end])
+    end
+
+    def do_run
+      alias_key = format('q_%s', options[:'<alias>']).to_sym
+      query = all_aliases.fetch(alias_key, nil)
+
+      unless query
+        abort "Query not found. 'wf query aliases' will show all " \
+              'aliased queries.'
+      end
+
+      @query_string = query
+      do_default
     end
 
+    def do_aliases
+      all_aliases
+    end
+
+    private
+
     # @return [Hash] options for the SDK query method
     #
     def q_opts
@@ -82,9 +114,12 @@ module WavefrontCli
       end
     end
 
-    def do_raw
-      wf.raw(options[:'<metric>'], options[:host], options[:start],
-             options[:end])
+    # @return [Hash] all query aliases for the active profile
+    #
+    def all_aliases
+      WavefrontCli::OptHandler.new(options).opts.select do |line|
+        line.to_s.start_with?('q_')
+      end
     end
   end
 end

data/lib/wavefront-cli/version.rb

@@ -1 +1 @@
-WF_CLI_VERSION = '2.2.0'.freeze
+WF_CLI_VERSION = '2.3.0'.freeze

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

@@ -12,5 +12,6 @@ class WavefrontCommmandQueryTest < WavefrontCommmandBaseTest
   def setup
     @wf = WavefrontCommandQuery.new
     @col_width = 24
+    @skip_cmd = /aliases/
   end
 end

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

@@ -1,2 +1,3 @@
 require 'minitest/autorun'
 require 'minitest/spec'
+require_relative '../../spec_helper'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-cli
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Robert Fisher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-19 00:00:00.000000000 Z
+date: 2018-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt