wavefront-cli 8.1.0 → 8.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53d7cbfa6e04c70f7c9c2af901ec42da4783b5b2f4aaa7552ebb53bf840395da
-  data.tar.gz: cef50e1684db66aa4a525c7ba91088a491bb790b8562c720437a12e7692b4390
+  metadata.gz: d96bb27765c031f9998dfa45406581de1852f0fbdc0abff4bcea45b679963299
+  data.tar.gz: d40011ef4d521dd738fb594095366ee7e506bc35c9bad83e2ad421eeedab16bb
 SHA512:
-  metadata.gz: 3ec1eacceffa1fefad6050e42eb5c3891133da9e23bcb5e62de8ee558b9535d27936e95a3a66eb6eac616d4effe371b3f66334e6a652548d3ae0b06d39747853
-  data.tar.gz: 241a752fb0fd12225e8fa26a342380a15040d37d694fc90c23604bb96691e4ad54f97617cc1fcf688f495e8ed42f44ef0e60c9122ddaa9b2cbd7b13dbb86ac3e
+  metadata.gz: f4777538a7b6f116f56c24382b9f3ea54ca78d5306009a3876857ff963f481561ff28e5c925cf0e62152e686caaa3c54e3abe90f48f16cb6e7cd6f87ede9f857
+  data.tar.gz: 1bfab61e86f92ff9284207627615f07a701092afb6bd6f839471833db3610fb60c8e013c56b57a50329c67650e1a778c6581adb61804f4365675cb1838cb7c4f

data/HISTORY.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 8.4.1 (2021-01-04)
+* Bugfix docopt error on `event` command.
+
+## 8.4.0 (2020-12-16)
+* Add `-f raw` option to dump the raw API response.
+* Bugfix `set` subcommand, which was not reliable on certain object types.
+* Require >=5.4.1 of [the SDK](https://github.com/snltd/wavefront-sdk).
+
+## 8.3.1 (2020-11-17)
+* Catch ctrl-c properly.
+
+## 8.3.0 (2020-10-31)
+* Add `wf proxy shutdown` command.
+
+## 8.2.0 (2020-10-06)
+* Display spans in human-readable query output.
+
 ## 8.1.0 (2020-10-04)
 * Display traces in human-readable query output.
 
@@ -9,7 +26,6 @@
 
 ## 8.0.0 (2020-09-20
 * Drop Ruby 2.4.0 support. (Breaking change.)
->>>>>>> master
 
 ## 7.2.0 (2020-08-12)
 * Add `cloudintegration awsid generate` command.

data/lib/wavefront-cli/base.rb

@@ -147,6 +147,7 @@ module WavefrontCli
               noop: options[:noop] }
 
       ret[:verbose] = options[:noop] ? true : options[:verbose]
+      ret[:raw_response] = true if options[:format] == 'raw'
 
       ret.merge!(extra_options) if respond_to?(:extra_options)
       ret
@@ -228,6 +229,8 @@ module WavefrontCli
 
       exit if options[:noop]
 
+      ok_exit data if options[:format] == 'raw'
+
       check_response_blocks(data)
       warning_message(data.status)
       status_error_handler(data, method)

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

@@ -13,7 +13,7 @@ class WavefrontCommandEvent < WavefrontCommandBase
     ["list #{CMN} [-l] [-O fields] [-s start] [-e end] " \
      '[-L limit] [-o cursor]',
      "describe #{CMN} <id>",
-     "create #{CMN} [-d description] [-s time] [-i | -e time] " \
+     "create #{CMN} [-d description] [-s start] [-i | -e end] " \
      '[-S severity] [-T type] [-H host...] [-g tag...] [-N] <event>',
      "close #{CMN} [<id>]",
      "delete #{CMN} <id>",
@@ -31,8 +31,10 @@ class WavefrontCommandEvent < WavefrontCommandBase
      "-o, --cursor=EVENT        start listing from given #{thing}",
      '-O, --fields=F1,F2,...    only show given fields',
      "-L, --limit=COUNT         number of #{things} to list",
-     "-s, --start=TIME          time at which #{thing} begins",
-     "-e, --end=TIME            time at which #{thing} ends",
+     "-s, --start=TIME          start of listed #{things} or time at which " \
+     "#{thing} begins",
+     "-e, --end=TIME            end of listed #{things} or time at which " \
+     "#{thing} ends",
      "-S, --severity=SEVERITY   severity of #{thing}",
      "-i, --instant             create an instantaneous #{thing}",
      "-T, --type=TYPE           type of #{thing}",

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

@@ -16,6 +16,7 @@ class WavefrontCommandProxy < WavefrontCommandBase
      "undelete #{CMN} <id>",
      "rename #{CMN} <id> <name>",
      "search #{CMN} [-al] [-o offset] [-L limit] [-O fields] <condition>...",
+     "shutdown #{CMN} <id>",
      "versions #{CMN}"]
   end
 

data/lib/wavefront-cli/controller.rb

@@ -39,6 +39,15 @@ class WavefrontCliController
     @opts = parse_opts(opts)
     cli_class_obj = cli_class(cmd, @opts)
     run_command(cli_class_obj)
+  rescue Interrupt
+    handle_interrupt!
+  end
+
+  def handle_interrupt!
+    raise if opts[:debug]
+
+    puts "\nCancelled at user's request."
+    exit 0
   end
 
   # What you see when you do 'wf --help'

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

@@ -33,6 +33,7 @@ module WavefrontDisplay
 
       @data = prioritize_keys(data, priority_keys)
       @options = options
+      @printer_opts = {}
     end
 
     # find the correct method to deal with the output of the user's
@@ -152,7 +153,8 @@ module WavefrontDisplay
         puts 'No data.'
       else
         require_relative 'printer/long'
-        puts WavefrontDisplayPrinter::Long.new(data, fields, modified_data)
+        puts WavefrontDisplayPrinter::Long.new(data, fields, modified_data,
+                                               @printer_opts)
         pagination_line
       end
     end

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

@@ -29,11 +29,13 @@ module WavefrontDisplayPrinter
 
     # Default options. Can all be overridden by passing them in the
     # initializer options hash.
+    # After sep_depth indentations we do not print separator lines
     #
     def default_opts
       { indent: 2,
         padding: 2,
         separator: true,
+        sep_depth: 3,
         none: true }
     end
 
@@ -179,7 +181,8 @@ module WavefrontDisplayPrinter
       data.each.with_index(1) do |element, i|
         aggr = make_list(element, aggr, depth, last_key)
 
-        if opts[:separator] && element.is_a?(Hash) && i < data.size && depth < 3
+        if opts[:separator] && element.is_a?(Hash) && i < data.size &&
+           depth < opts[:sep_depth]
           aggr.<< ['', :separator, depth]
         end
       end

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

@@ -26,6 +26,10 @@ module WavefrontDisplay
       multicolumn(:id, :version, :name)
     end
 
+    def do_shutdown
+      puts "Requested shutdown of proxy '#{options[:'<id>']}'."
+    end
+
     private
 
     def filter_inactive_proxies!

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

@@ -16,15 +16,18 @@ module WavefrontDisplay
             data[:errorMessage].split("\n").first)
     end
 
+    # rubocop:disable Metrics/AbcSize
     def default_data_object
       { name: data.name,
         query: data.query,
         timeseries: mk_timeseries(data),
         traces: mk_traces(data),
+        spans: mk_spans(data),
         events: mk_events(data) }.tap do |d|
           d[:warnings] = data[:warnings] if show_warnings?
         end
     end
+    # rubocop:enable Metrics/AbcSize
 
     def show_warnings?
       data.key?(:warnings) && !options[:nowarn]
@@ -61,6 +64,12 @@ module WavefrontDisplay
       data[:traces].map { |t| humanize_trace(t) }
     end
 
+    def mk_spans(data)
+      return [] unless data.key?(:spans)
+
+      data[:spans].map { |t| humanize_span(t) }
+    end
+
     def do_run
       do_default
     end
@@ -107,17 +116,24 @@ module WavefrontDisplay
     end
 
     def humanize_trace(data)
+      @printer_opts[:sep_depth] = 3
+
       data.tap do |t|
         t[:start] = human_time(t[:start_ms])
         t[:end] = human_time(t[:end_ms])
         t.delete(:start_ms)
         t.delete(:end_ms)
         t.delete(:startMs)
-        t.spans = t.spans.map { |s| humanize_span(s) }
+        t.spans = t.spans.map { |s| humanize_trace_span(s) }
       end
     end
 
-    def humanize_span(span)
+    def humanize_span(data)
+      @printer_opts[:sep_depth] = 2
+      data
+    end
+
+    def humanize_trace_span(span)
       span.tap do |s|
         s[:startMs] = human_time(s[:startMs])
       end

data/lib/wavefront-cli/event.rb

@@ -2,6 +2,7 @@
 
 require 'fileutils'
 require 'open3'
+require 'etc'
 require 'wavefront-sdk/support/mixins'
 require_relative 'base'
 require_relative 'command_mixins/tag'

data/lib/wavefront-cli/proxy.rb

@@ -32,6 +32,10 @@ module WavefrontCli
       version_info(raw).sort_by { |p| Gem::Version.new(p[:version]) }.reverse
     end
 
+    def do_shutdown
+      wf.shutdown(options[:'<id>'])
+    end
+
     def version_info(raw)
       raw.response.items.map do |i|
         { id: i.id, version: i.version, name: i.name }

data/lib/wavefront-cli/version.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-WF_CLI_VERSION = '8.1.0'
+WF_CLI_VERSION = '8.4.1'

data/spec/spec_helper.rb

@@ -22,7 +22,6 @@ unless defined?(CMD)
     'Content-Type': 'application/json', Accept: 'application/json'
   }.freeze
   BAD_TAG = '*BAD_TAG*'
-  TW = 80
   HOME_CONFIG = Pathname.new(ENV['HOME']) + '.wavefront'
 end
 

data/spec/wavefront-cli/controller_spec.rb

@@ -22,6 +22,18 @@ class WavefrontCliHelpTest < MiniTest::Test
     assert_match(/^  \w+ --help$/, e.message)
   end
 
+  def test_commands_no_args
+    SupportedCommands.new.all.each do |cmd|
+      _test_command_no_args(cmd)
+    end
+  end
+
+  def _test_command_no_args(cmd)
+    capture_io { WavefrontCliController.new([cmd]) }
+  rescue SystemExit => e
+    assert e.message.end_with?("wf #{cmd} --help")
+  end
+
   def test_version
     capture_io { WavefrontCliController.new(%w[--version]) }
   rescue SystemExit => e

data/spec/wavefront-cli/display/printer/long_spec.rb

@@ -52,12 +52,14 @@ class TestWavefrontDisplayPrinterLong < MiniTest::Test
     assert_equal({ indent: 4,
                    padding: 3,
                    separator: true,
+                   sep_depth: 3,
                    none: true }, pr.opts)
 
     pr = WavefrontDisplayPrinter::Long.new({}, nil, nil, none: false)
     assert_equal({ indent: 2,
                    padding: 2,
                    separator: true,
+                   sep_depth: 3,
                    none: false }, pr.opts)
   end
 

data/spec/wavefront-cli/proxy_spec.rb

@@ -36,6 +36,19 @@ class ProxyEndToEndTest < EndToEndTest
     assert_abort_on_missing_creds("rename #{id} newname")
   end
 
+  def test_shutdown
+    assert_output("Requested shutdown of proxy '#{id}'.\n") do
+      assert_cmd_puts("shutdown #{id}", "/api/v2/proxy/#{id}",
+                      { shutdown: true }.to_json)
+    end
+
+    assert_noop("shutdown #{id}",
+                "uri: PUT https://default.wavefront.com/api/v2/proxy/#{id}",
+                'body: {"shutdown":true}')
+    assert_invalid_id("shutdown #{invalid_id}")
+    assert_abort_on_missing_creds("shutdown #{id}")
+  end
+
   private
 
   def id

data/wavefront-cli.gemspec

@@ -26,7 +26,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', '~> 5.2'
+  gem.add_runtime_dependency 'wavefront-sdk', '~> 5.4', '>= 5.4.1'
 
   gem.add_development_dependency 'minitest', '~> 5.14'
   gem.add_development_dependency 'rake', '~> 13.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-cli
 version: !ruby/object:Gem::Version
-  version: 8.1.0
+  version: 8.4.1
 platform: ruby
 authors:
 - Robert Fisher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-04 00:00:00.000000000 Z
+date: 2021-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt
@@ -44,14 +44,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.4.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement