wavefront-cli 8.2.0 → 8.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afeb72ce32ce32e70e1f405234608ce5109d039aa6045b89e73e8351d95e459f
-  data.tar.gz: 06b2ab6daedba6a696b9c63208bfe9465695f224f6fab58c49c9408051f81e3f
+  metadata.gz: 363b1be94331165aacf1538c797d07bdbefda71e801335bb4e35df97cb0bd950
+  data.tar.gz: 5563b27f93c679dde5947c220d80c37816ba6faf8844d08111cbf7dcc65a76c1
 SHA512:
-  metadata.gz: 75b2159704ea25f5f1dea58b16e9e968b9b3ba17668a6f014a0ff75ce63be91179601a5cc917ab526b281a36d3c4e254ec8dbe0af9ac57f21274a4fbeeb5faab
-  data.tar.gz: 672954a741cf305255820402b0a62bf9ac8facafb9e5fbf63c633a3355117516253cc50e68247fb019e7b1797f6117062acf32b3e30d012e995a55e37c0bb53f
+  metadata.gz: ce61f68ba09a6ba395143fa92abeadcdb0de127f8991fe61b979ae49379d026973c5d47a09d6d4f0b306006a15f95a717cac02160af0b727f2858ba66a9fddae
+  data.tar.gz: 111d9d52a0e0c3955164e1872198531b9e2bd61184dc430050029efdf8d19f9cd845885a7f1d5d5685d03dbf7de0845453d95f888e13eb0195b83fd25437116d

data/HISTORY.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## 8.5.0 (2021-01-12)
+* Allow attachment of roles and ingestion policies when creating service
+  accounts.
+* Improved introspection of service accounts.
+* Refactor `event` command. This improves test coverage, fixes handling
+  event names with numeric suffix, and fixes searching.
+
+## 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.
 
@@ -12,7 +33,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

@@ -10,15 +10,14 @@ class WavefrontCommandEvent < WavefrontCommandBase
   end
 
   def _commands
-    ["list #{CMN} [-l] [-O fields] [-s start] [-e end] " \
-     '[-L limit] [-o cursor]',
+    ["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>",
      "set #{CMN} <key=value> <id>",
-     "search #{CMN} [-o offset] [-L limit] [-l] [-O fields] <condition>...",
+     "search #{CMN} [-al] [-o cursor] [-L limit] [-O fields] <condition>...",
      "wrap #{CMN} [-C command] [-d description] [-S severity] [-T type] " \
      '[-H host...] [-g tag...] <event>',
      tag_commands,
@@ -28,11 +27,14 @@ class WavefrontCommandEvent < WavefrontCommandBase
   def _options
     [common_options,
      "-l, --long                list #{things} in detail",
+     "-a, --all                 list all #{things}",
      "-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/commands/serviceaccount.rb

@@ -20,14 +20,15 @@ class WavefrontCommandServiceaccount < WavefrontCommandBase
   def _commands
     ["list #{CMN} [-l] [-O fields]",
      "describe #{CMN} <id>",
-     "create #{CMN} [-I] [-d description] [-p permission...] [-g group...] " \
-     '[-k usertoken...] <id>',
+     "create #{CMN} [-I] [-d description] [-p policy] [-r role...] " \
+     '[-g group...] [-k usertoken...] <id>',
      "activate #{CMN} <id>",
      "delete #{CMN} <account>...",
      "deactivate #{CMN} <id>",
      "dump #{CMN}",
      "groups #{CMN} <id>",
-     "permissions #{CMN} <id>",
+     "roles #{CMN} <id>",
+     "ingestionpolicy #{CMN} <id>",
      "join #{CMN} <id> <group>...",
      "leave #{CMN} <id> <group>...",
      "grant #{CMN} <permission> to <id>",
@@ -52,7 +53,8 @@ class WavefrontCommandServiceaccount < WavefrontCommandBase
      "-U, --upsert             import new or update existing #{thing}",
      "-I, --inactive           create an inactive #{thing}",
      "-d, --desc=STRING        description of #{thing}",
-     "-p, --permission=STRING  give #{thing} this permission",
+     "-r, --role=STRING        give #{thing} this role",
+     "-p, --policy=STRING      give #{thing} this ingestion policy",
      "-g, --group=STRING       add #{thing} to this user group",
      '-N, --name=STRING        name of token',
      '-k, --usertoken=STRING   API token']

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/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/serviceaccount.rb

@@ -35,14 +35,22 @@ module WavefrontDisplay
       end
     end
 
+    def do_roles
+      if data[:roles].empty?
+        puts 'Account does not have any roles attached.'
+      else
+        data[:roles].each { |r| puts format('%<id>s (%<name>s)', r) }
+      end
+    end
+
     alias do_join do_groups
     alias do_leave do_groups
 
-    def do_permissions
-      if data[:groups].empty?
-        puts 'Account does not have any Wavefront permissions.'
+    def do_ingestionpolicy
+      if data[:ingestionPolicy].empty?
+        puts 'Account does not have an ingestion policy attached.'
       else
-        puts data[:groups]
+        puts format('%<id>s (%<name>s)', data[:ingestionPolicy])
       end
     end
 

data/lib/wavefront-cli/event.rb

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 
-require 'fileutils'
-require 'open3'
 require 'wavefront-sdk/support/mixins'
 require_relative 'base'
+require_relative 'event_store'
 require_relative 'command_mixins/tag'
 
 module WavefrontCli
@@ -11,14 +10,13 @@ module WavefrontCli
   # CLI coverage for the v2 'event' API.
   #
   class Event < Base
-    attr_reader :state_dir
+    attr_reader :state
 
     include Wavefront::Mixins
     include WavefrontCli::Mixin::Tag
 
-    def post_initialize(_options)
-      @state_dir = event_state_dir + (Etc.getlogin || 'notty')
-      create_dir(state_dir)
+    def post_initialize(options)
+      @state = WavefrontCli::EventStore.new(options)
     end
 
     def do_list
@@ -31,38 +29,14 @@ module WavefrontCli
       t_start = parse_time(opts[:start], true)
       body = create_body(opts, t_start)
       resp = wf.create(body)
-      create_state_file(resp.response[:id]) if state_file_needed?(opts)
-      resp
-    end
-
-    def state_file_needed?(opts)
-      !(opts[:nostate] || opts[:end] || opts[:instant])
-    end
-
-    # The user doesn't have to give us an event ID.  If no event
-    # name is given, we'll pop the last event off the stack. If an
-    # event name is given and it doesn't look like a full WF event
-    # name, we'll look for something on the stack.  If it does look
-    # like a real event, we'll make an API call straight away.
-    #
-    def do_close(id = nil)
-      id ||= options[:'<id>']
-      ev = local_event(id)
-      ev_file = event_file(id)
-
-      abort "No locally stored event matches '#{id}'." unless ev
-
-      res = wf.close(ev)
-      ev_file.unlink if ev_file&.exist? && res.status.code == 200
-      res
-    end
+      return if opts[:noop]
 
-    def event_file(id)
-      id =~ /^\d{13}:.+/ ? state_dir + id : nil
+      state.create!(resp.response[:id])
+      resp
     end
 
     def do_show
-      events = local_event_list
+      events = state.list
 
       if events.size.zero?
         puts 'No open events.'
@@ -77,21 +51,54 @@ module WavefrontCli
       create_opts = options
       create_opts[:desc] ||= create_opts[:command]
       event_id = do_create(create_opts).response.id
-      exit_code = run_wrapped_cmd(options[:command])
+      exit_code = state.run_wrapped_cmd(options[:command])
       do_close(event_id)
       puts "Command exited #{exit_code}."
       exit exit_code
     end
 
-    # We can override the temp directory with the WF_EVENT_STATE_DIR. This is
-    # primarily for testing.
+    # The user doesn't have to give us an event ID. If no event name is given,
+    # we'll pop the last event off the stack. If an event name is given and it
+    # doesn't look like a full WF event name, we'll look for something on the
+    # stack. If it does look like a real event, we'll make an API call
+    # straight away.
     #
-    def event_state_dir
-      if ENV['WF_EVENT_STATE_DIR']
-        Pathname.new(ENV['WF_EVENT_STATE_DIR'])
-      else
-        EVENT_STATE_DIR
-      end
+    def do_close(id = nil)
+      id ||= options[:'<id>']
+      ev = state.event(id)
+      ev_file = state.event_file(id)
+
+      abort "No locally stored event matches '#{id}'." unless ev
+
+      res = wf.close(ev)
+      ev_file.unlink if ev_file&.exist? && res.status.code == 200
+      res
+    end
+
+    # We have to override the normal validation methods because an event can
+    # be referred to by only a part of its name. This happens when the user
+    # refers to events on the local stack.
+    #
+    def validate_input
+      validate_id if options[:'<id>'] && !options[:close]
+      validate_tags if options[:'<tag>']
+      validate_tags(:evtag) if options[:evtag]
+      send(:extra_validation) if respond_to?(:extra_validation)
+    end
+
+    def list_args
+      [window_start,
+       window_end,
+       options[:limit] || 100,
+       options[:cursor] || nil]
+    end
+
+    def window_start
+      parse_time((options[:start] || Time.now - 600), true)
+    end
+
+    def window_end
+      parse_time((options[:end] || Time.now), true)
     end
 
     # return [Hash] body for #create() method
@@ -122,128 +129,5 @@ module WavefrontCli
         r[:type] = opts[:type] if opts[:type]
       end
     end
-
-    # @return a local event from the stack directory
-    #
-    def local_event(id)
-      if !id
-        pop_event
-      elsif id =~ /^\d{13}:.+/
-        id
-      else
-        pop_event(id)
-      end
-    end
-
-    def local_event_list
-      events = state_dir.children
-      abort 'No locally recorded events.' if events.empty?
-
-      events
-    rescue Errno::ENOENT
-      raise(WavefrontCli::Exception::SystemError,
-            'There is no event state directory on this host.')
-    end
-
-    # Run a command, stream stderr and stdout to the screen (they
-    # get combined -- could be an issue for someone somewhere) and
-    # return the command's exit code
-    #
-    def run_wrapped_cmd(cmd)
-      separator = '-' * (TW - 4)
-
-      puts "Command output follows, on STDERR:\n#{separator}"
-      ret = nil
-
-      Open3.popen2e(cmd) do |_in, out, thr|
-        # rubocop:disable Lint/AssignmentInCondition
-        while l = out.gets do warn l end
-        # rubocop:enable Lint/AssignmentInCondition
-        ret = thr.value.exitstatus
-      end
-
-      puts separator
-      ret
-    end
-
-    # Write a state file. We put the hosts bound to the event into the
-    # file. These aren't currently used by anything in the CLI, but they
-    # might be useful to someone, somewhere, someday.
-    #
-    def create_state_file(id)
-      fname = state_dir + id
-      File.open(fname, 'w') { |fh| fh.puts(event_file_data) }
-      puts "Event state recorded at #{fname}."
-    rescue StandardError
-      puts 'NOTICE: event was created but state file was not.'
-    end
-
-    # Record event data in the state file. We don't currently use it, but it
-    # might be useful to someone someday.
-    #
-    # @return [String]
-    #
-    def event_file_data
-      { hosts: options[:host],
-        description: options[:desc],
-        severity: options[:severity],
-        tags: options[:evtag] }.to_json
-    end
-
-    def create_dir(state_dir)
-      FileUtils.mkdir_p(state_dir)
-      raise unless state_dir.exist? && state_dir.directory? &&
-                   state_dir.writable?
-    rescue StandardError
-      raise(WavefrontCli::Exception::SystemError,
-            "Cannot create writable system directory at '#{state_dir}'.")
-    end
-
-    def validate_input
-      validate_id if options[:'<id>'] && !options[:close]
-      validate_tags if options[:'<tag>']
-      validate_tags(:evtag) if options[:evtag]
-      send(:extra_validation) if respond_to?(:extra_validation)
-    end
-
-    # Get the last event this script created. If you supply a name, you
-    # get the last event with that name. If not, you get the last event.
-    # Chances are you'll only ever have one in-play at once.
-    #
-    # @param name [String] name of event
-    # @eturn an array of [timestamp, event_name]
-    #
-    def pop_event(name = nil)
-      return false unless state_dir.exist?
-
-      list = local_events_with_name(name)
-      return false if list.empty?
-
-      ev_file = list.max
-      File.unlink(ev_file)
-      ev_file.basename.to_s
-    end
-
-    def local_events_with_name(name = nil)
-      list = local_event_list
-      return list unless name
-
-      list.select { |f| f.basename.to_s.split(':').last == name }
-    end
-
-    def list_args
-      [window_start,
-       window_end,
-       options[:limit] || 100,
-       options[:cursor] || nil]
-    end
-
-    def window_start
-      parse_time((options[:start] || Time.now - 600), true)
-    end
-
-    def window_end
-      parse_time((options[:end] || Time.now), true)
-    end
   end
 end