wavefront-cli 4.2.1 → 4.3.0

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 # Define the cloud integration command.

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 # Define the Configure command

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 # Define the dashboard command.

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 # Define the derivedmetric command.

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 # Define the event command.
@@ -20,7 +22,7 @@ class WavefrontCommandEvent < WavefrontCommandBase
      "wrap #{CMN} [-C command] [-d description] [-S severity] [-T type] " \
      '[-H host...] [-g tag...] <event>',
      tag_commands,
-     'show [-D]']
+     "show #{CMN}"]
   end
 
   def _options

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 # Define the integration command.
@@ -18,7 +20,6 @@ class WavefrontCommandIntegration < WavefrontCommandBase
      "alert install #{CMN} <id>",
      "alert uninstall #{CMN} <id>",
      "installed #{CMN}",
-     "manifests #{CMN}",
      "search #{CMN} [-al] [-o offset] [-L limit] <condition>..."]
   end
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 # Define the external link command.

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 # Define the message command.

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 # Define the metric command.

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 # Define the notificant command.

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 # Define the proxy command.

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 # Define the query command.

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 # Define the saved search command.

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+# Define the service account command.
+#
+class WavefrontCommandServiceaccount < WavefrontCommandBase
+  def thing
+    'service account'
+  end
+
+  def sdk_file
+    'serviceaccount'
+  end
+
+  def sdk_class
+    'ServiceAccount'
+  end
+
+  def _commands
+    ["list #{CMN} [-l] [-O fields]",
+     "describe #{CMN} <id>",
+     "create #{CMN} [-I] [-d description] [-m permission...] [-g group...] " \
+     '[-k usertoken...] <id>',
+     "activate #{CMN} <id>",
+     "deactivate #{CMN} <id>",
+     "dump #{CMN}",
+     "groups #{CMN} <id>",
+     "privileges #{CMN} <id>",
+     "join #{CMN} <id> <group>...",
+     "leave #{CMN} <id> <group>...",
+     "grant #{CMN} <privilege> to <id>",
+     "revoke #{CMN} <privilege> from <id>",
+     "set #{CMN} <key=value> <id>",
+     "import #{CMN} [-u] <file>",
+     "apitoken list #{CMN} [-O fields] <id>",
+     "apitoken create #{CMN} [-N name] <id>",
+     "apitoken delete #{CMN} <id> <token_id>",
+     "apitoken rename #{CMN} <id> <token_id> <name>",
+     "search #{CMN} [-al] [-o offset] [-L limit] <condition>..."]
+  end
+
+  def _options
+    [common_options,
+     "-l, --long               list #{things} in detail",
+     "-a, --all                list all #{things}",
+     "-o, --offset=n           start from nth #{thing}",
+     "-L, --limit=COUNT        number of #{things} to list",
+     '-O, --fields=F1,F2,...   only show given fields',
+     "-u, --update             update an existing #{thing}",
+     "-I, --inactive           create an inactive #{thing}",
+     "-d, --desc=STRING        description of #{thing}",
+     "-m, --permission=STRING  give #{thing} this permission",
+     "-g, --group=STRING       add #{thing} to this user group",
+     '-N, --name=STRING        name of token',
+     '-k, --usertoken=STRING   API token']
+  end
+end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 # Define the settings command.

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 # Define the source command.
@@ -13,7 +15,7 @@ class WavefrontCommandSource < WavefrontCommandBase
      "description set  #{CMN} <id> <description>",
      "description clear  #{CMN} <id>",
      "clear  #{CMN} <id>",
-     "search #{CMN} [-o offset] [-L limit] [-l] <condition>...",
+     "search #{CMN} [-al] [-o cursor] [-L limit] <condition>...",
      tag_commands]
   end
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 # Define the user command.
@@ -16,11 +18,11 @@ class WavefrontCommandUser < WavefrontCommandBase
      "describe #{CMN} <id>",
      "create #{CMN} [-e] [-m permission...] [-g group...] <id>",
      "invite #{CMN} [-m permission...] [-g group...] <id>",
-     "set #{CMN} <key=value> <id>",
      "delete #{CMN} <user>...",
      "dump #{CMN}",
      "import #{CMN} [-u] <file>",
      "groups #{CMN} <id>",
+     "privileges #{CMN} <id>",
      "join #{CMN} <id> <group>...",
      "leave #{CMN} <id> <group>...",
      "grant #{CMN} <privilege> to <id>",
@@ -31,6 +33,7 @@ class WavefrontCommandUser < WavefrontCommandBase
   def _options
     [common_options,
      "-l, --long               list #{things} in detail",
+     "-a, --all                list all #{things}",
      "-o, --offset=n           start from nth #{thing}",
      "-L, --limit=COUNT        number of #{things} to list",
      '-O, --fields=F1,F2,...   only show given fields',

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 # Define the usergroup command.
@@ -39,6 +41,7 @@ class WavefrontCommandUsergroup < WavefrontCommandBase
   def _options
     [common_options,
      "-l, --long               list #{things} in detail",
+     "-a, --all                list all #{things}",
      "-o, --offset=n           start from nth #{thing}",
      "-L, --limit=COUNT        number of #{things} to list",
      '-O, --fields=F1,F2,...   only show given fields',

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 # Define the webhook command.

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 # Define the maintenance window command.

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 # Define the write command.

data/lib/wavefront-cli/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'inifile'
 require_relative 'exception'
 require_relative 'base'
@@ -32,7 +34,7 @@ module WavefrontCli
         test: proc { |v| %w[human json yaml].include?(v) } }
     ].freeze
 
-    RX = /^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$/
+    RX = /^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$/.freeze
 
     def initialize(options)
       @options = options
@@ -57,11 +59,11 @@ module WavefrontCli
       require 'wavefront-sdk/defs/version'
       require_relative 'display/base'
 
-      info = { 'wf version':    WF_CLI_VERSION,
-               'wf path':       CMD_PATH.realpath.to_s,
-               'SDK version':   WF_SDK_VERSION,
-               'SDK location':  WF_SDK_LOCATION.to_s,
-               'Ruby version':  RUBY_VERSION,
+      info = { 'wf version': WF_CLI_VERSION,
+               'wf path': CMD_PATH.realpath.to_s,
+               'SDK version': WF_SDK_VERSION,
+               'SDK location': WF_SDK_LOCATION.to_s,
+               'Ruby version': RUBY_VERSION,
                'Ruby platform': Gem::Platform.local.os.capitalize }
 
       WavefrontDisplay::Base.new(info).long_output
@@ -90,11 +92,15 @@ module WavefrontCli
     def create_profile(profile)
       puts "Creating profile '#{profile}'."
 
-      str = CONFIGURABLES.each_with_object("[#{profile}]") do |t, a|
-        a.<< format("\n%s=%s", t[:key], read_thing(t))
+      prof_arr = ["[#{profile}]"]
+
+      CONFIGURABLES.each do |c|
+        prof_arr.<< format('%<key>s=%<value>s',
+                           key: c[:key],
+                           value: read_thing(c))
       end
 
-      IniFile.new(content: str)
+      IniFile.new(content: prof_arr.join("\n"))
     end
 
     def do_delete
@@ -114,7 +120,9 @@ module WavefrontCli
 
     def do_envvars
       %w[WAVEFRONT_ENDPOINT WAVEFRONT_TOKEN WAVEFRONT_PROXY].each do |v|
-        puts format('%-20s %s', v, ENV[v] || 'unset')
+        puts format('%-20<var>s %<value>s',
+                    var: v,
+                    value: ENV[v] || 'unset')
       end
     end
 
@@ -127,8 +135,8 @@ module WavefrontCli
     end
 
     def input_prompt(label, default)
-      ret = format('  %s', label)
-      ret.<< format(' [%s]', default) unless default.nil?
+      ret = format('  %<label>s', label: label)
+      ret.<< format(' [%<value>s]', value: default) unless default.nil?
       ret + ':> '
     end
 
@@ -152,15 +160,18 @@ module WavefrontCli
     def validate_input(input, default, test)
       if input.empty?
         raise WavefrontCli::Exception::MandatoryValue if default.nil?
+
         input = default
       end
 
       return input if test.call(input)
+
       raise WavefrontCli::Exception::InvalidValue
     end
 
     def present?
       return true if config_file.exist?
+
       raise WavefrontCli::Exception::ConfigFileNotFound, config_file
     end
 

data/lib/wavefront-cli/constants.rb

@@ -1,18 +1,20 @@
+# frozen_string_literal: true
+
 require 'pathname'
 
 module WavefrontCli
   # Universal truths
   #
   module Constants
-    HUMAN_TIME_FORMAT = '%F %T'.freeze
-    HUMAN_TIME_FORMAT_MS = '%F %T.%3N'.freeze
+    HUMAN_TIME_FORMAT = '%F %T'
+    HUMAN_TIME_FORMAT_MS = '%F %T.%3N'
 
     # The CLI will use these options if they are not supplied on the
     # command line or in a config file.
     #
     DEFAULT_OPTS = {
       endpoint: 'metrics.wavefront.com',
-      format:   :human
+      format: :human
     }.freeze
 
     # How many objects to get in each request when we are asked for
@@ -26,6 +28,10 @@ module WavefrontCli
 
     # Split regex for searches
     #
-    SEARCH_SPLIT = /\^|!\^|=|!=|~|!~/
+    SEARCH_SPLIT = /\^|!\^|=|!=|~|!~/.freeze
+
+    # Where we store local event information
+    #
+    EVENT_STATE_DIR = Pathname.new('/var/tmp/wavefront')
   end
 end

data/lib/wavefront-cli/controller.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 # For development against a local checkout of the SDK, uncomment
 # this definition
 #
 # DEVELOPMENT = true
 
 if defined?(DEVELOPMENT)
-  dir = Pathname.new(__FILE__).dirname.realpath.parent.parent.parent
+  dir = Pathname.new(__dir__).realpath.parent.parent.parent
   $LOAD_PATH.<< dir + 'lib'
   $LOAD_PATH.<< dir + 'wavefront-sdk' + 'lib'
 end
@@ -17,7 +19,7 @@ require_relative 'exception'
 require_relative 'opt_handler'
 require_relative 'stdlib/string'
 
-CMD_DIR = Pathname.new(__FILE__).dirname + 'commands'
+CMD_DIR = Pathname.new(__dir__) + 'commands'
 
 # Dynamically generate a CLI interface from files which describe
 # each subcomand.
@@ -33,20 +35,36 @@ class WavefrontCliController
     @usage = docopt_hash
     cmd, opts = parse_args
     @opts = parse_opts(opts)
-    cli_class_obj = load_cli_class(cmd, @opts)
+    cli_class_obj = cli_class(cmd, @opts)
     run_command(cli_class_obj)
   end
 
   # What you see when you do 'wf --help'
   # @return [String]
   #
+  # rubocop:disable Metrics/MethodLength
   def default_help
-    s = "Wavefront CLI\n\nUsage:\n  #{CMD} command [options]\n" \
-        "  #{CMD} --version\n  #{CMD} --help\n\nCommands:\n"
+    s = ['Wavefront CLI',
+         '',
+         'Usage:',
+         "  #{CMD} command [options]",
+         "  #{CMD} --version",
+         "  #{CMD} --help",
+         '',
+         'Commands:',
+         '']
+
+    cmds.sort.each do |k, v|
+      s.<< format('  %-18<command>s %<desc>s',
+                  command: k,
+                  desc: v.description)
+    end
 
-    cmds.sort.each { |k, v| s.<< format("  %-18s %s\n", k, v.description) }
-    s.<< "\nUse '#{CMD} <command> --help' for further information.\n"
+    s.<< ''
+    s.<< "Use '#{CMD} <command> --help' for further information."
+    s.join("\n")
   end
+  # rubocop:enable Metrics/MethodLength
 
   # @return [Hash] command descriptions for docopt.
   #
@@ -59,23 +77,25 @@ class WavefrontCliController
   # Parse the input. The first Docopt.docopt handles the default
   # options, the second works on the command.
   #
-  # rubocop:disable Metrics/AbcSize
   def parse_args
     Docopt.docopt(usage[:default], version: WF_CLI_VERSION, argv: args)
   rescue Docopt::Exit => e
     cmd = args.empty? ? nil : args.first.to_sym
 
     abort e.message unless usage.key?(cmd)
+    parse_cmd(cmd)
+  end
 
-    begin
-      [cmd, sanitize_keys(Docopt.docopt(usage[cmd], argv: args))]
-    rescue Docopt::DocoptLanguageError => e
-      abort "Mangled command description:\n#{e.message}"
-    rescue Docopt::Exit => e
-      abort e.message
-    end
+  # Parse a command.
+  # @param cmd [String] given command
+  #
+  def parse_cmd(cmd)
+    [cmd, sanitize_keys(Docopt.docopt(usage[cmd], argv: args))]
+  rescue Docopt::DocoptLanguageError => e
+    abort "Mangled command description:\n#{e.message}"
+  rescue Docopt::Exit => e
+    abort e.message
   end
-  # rubocop:enable Metrics/AbcSize
 
   def parse_opts(options)
     WavefrontCli::OptHandler.new(options).opts
@@ -86,10 +106,8 @@ class WavefrontCliController
   # @param cmd [String]
   # @return WavefrontCli::cmd
   #
-  # rubocop:disable Metrics/AbcSize
-  def load_cli_class(cmd, opts)
-    require_relative File.join('.', cmds[cmd].sdk_file)
-    Object.const_get('WavefrontCli').const_get(cmds[cmd].sdk_class).new(opts)
+  def cli_class(cmd, opts)
+    load_cli_class(cmd, opts)
   rescue WavefrontCli::Exception::UnhandledCommand
     abort 'Fatal error. Unsupported command. Please open a Github issue.'
   rescue WavefrontCli::Exception::InvalidInput => e
@@ -97,10 +115,14 @@ class WavefrontCliController
   rescue RuntimeError => e
     abort "Unable to run command. #{e.message}."
   end
-  # rubocop:enable Metrics/AbcSize
 
-  # rubocop:disable Metrics/AbcSize
+  def load_cli_class(cmd, opts)
+    require_relative File.join('.', cmds[cmd].sdk_file)
+    Object.const_get('WavefrontCli').const_get(cmds[cmd].sdk_class).new(opts)
+  end
+
   # rubocop:disable Metrics/MethodLength
+  # rubocop:disable Metrics/AbcSize
   def run_command(cli_class_obj)
     cli_class_obj.validate_opts
     cli_class_obj.run
@@ -112,6 +134,10 @@ class WavefrontCliController
     handle_missing_credentials(e)
   rescue WavefrontCli::Exception::MandatoryValue
     abort 'A value must be supplied.'
+  rescue Wavefront::Exception::InvalidPermission => e
+    abort "'#{e}' is not a valid privilege."
+  rescue Wavefront::Exception::InvalidUserGroupId => e
+    abort "'#{e}' is not a valid user group id."
   rescue WavefrontCli::Exception::InvalidValue => e
     abort "Invalid value for #{e}."
   rescue WavefrontCli::Exception::ProfileExists => e
@@ -122,10 +148,14 @@ class WavefrontCliController
     abort 'File not found.'
   rescue WavefrontCli::Exception::InsufficientData => e
     abort "Insufficient data. #{e.message}"
+  rescue WavefrontCli::Exception::InvalidQuery => e
+    abort "Invalid query. API message: '#{e.message}'."
   rescue WavefrontCli::Exception::SystemError => e
     abort "Host system error. #{e.message}"
   rescue WavefrontCli::Exception::UnparseableInput => e
     abort "Cannot parse input. #{e.message}"
+  rescue WavefrontCli::Exception::UnparseableSearchPattern
+    abort 'Searches require a key, a value, and a match operator.'
   rescue WavefrontCli::Exception::UnsupportedFileFormat
     abort 'Unsupported file format.'
   rescue WavefrontCli::Exception::UnsupportedOperation => e
@@ -188,6 +218,7 @@ class WavefrontCliController
   #
   def import_command(path)
     return if path.extname != '.rb' || path.basename.to_s == 'base.rb'
+
     k_name = path.basename.to_s[0..-4]
     require(CMD_DIR + k_name)
     Object.const_get("WavefrontCommand#{k_name.capitalize}").new