wavefront-cli 2.18.0 → 3.0.0

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

@@ -8,15 +8,15 @@ class WavefrontCommandEvent < WavefrontCommandBase
   end
 
   def _commands
-    ["list #{CMN} [-l] [-O fields] [-f format] [-s start] [-e end] " \
+    ["list #{CMN} [-l] [-O fields] [-s start] [-e end] " \
      '[-L limit] [-o cursor]',
-     "describe #{CMN} [-f format] <id>",
+     "describe #{CMN} <id>",
      "create #{CMN} [-d description] [-s time] [-i | -e time] " \
      '[-S severity] [-T type] [-H host...] [-g tag...] [-N] <event>',
      "close #{CMN} [<id>]",
      "delete #{CMN} <id>",
      "update #{CMN} <key=value> <id>",
-     "search #{CMN} [-f format] [-o offset] [-L limit] [-l] <condition>...",
+     "search #{CMN} [-o offset] [-L limit] [-l] <condition>...",
      "wrap #{CMN} [-C command] [-d description] [-S severity] [-T type] " \
      '[-H host...] [-g tag...] <event>',
      tag_commands,

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

@@ -8,8 +8,8 @@ class WavefrontCommandIntegration < WavefrontCommandBase
   end
 
   def _commands
-    ["list #{CMN} [-al] [-O fields] [-f format] [-o offset] [-L limit]",
-     "describe #{CMN} [-f format] <id>",
+    ["list #{CMN} [-al] [-O fields] [-o offset] [-L limit]",
+     "describe #{CMN} <id>",
      "install #{CMN} <id>",
      "uninstall #{CMN} <id>",
      "manifests #{CMN}",
@@ -17,9 +17,9 @@ class WavefrontCommandIntegration < WavefrontCommandBase
      "statuses #{CMN}",
      "alert install #{CMN} <id>",
      "alert uninstall #{CMN} <id>",
-     "installed #{CMN} [-f format]",
-     "manifests #{CMN} [-f format]",
-     "search #{CMN} [-al] [-f format] [-o offset] [-L limit] <condition>..."]
+     "installed #{CMN}",
+     "manifests #{CMN}",
+     "search #{CMN} [-al] [-o offset] [-L limit] <condition>..."]
   end
 
   def _options

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

@@ -16,14 +16,14 @@ class WavefrontCommandLink < WavefrontCommandBase
   end
 
   def _commands
-    ["list #{CMN} [-al] [-O fields] [-f format] [-o offset] [-L limit]",
-     "describe #{CMN} [-f format] <id>",
+    ["list #{CMN} [-al] [-O fields] [-o offset] [-L limit]",
+     "describe #{CMN} <id>",
      "create #{CMN} [-m regex] [-s regex] [-p str=regex...] <name> " \
      '<description> <template>',
      "delete #{CMN} <id>",
      "import #{CMN} <file>",
      "update #{CMN} <key=value> <id>",
-     "search #{CMN} [-al] [-f format] [-o offset] [-L limit] <condition>..."]
+     "search #{CMN} [-al] [-o offset] [-L limit] <condition>..."]
   end
 
   def _options

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

@@ -8,8 +8,8 @@ class WavefrontCommandMessage < WavefrontCommandBase
   end
 
   def _commands
-    ["list #{CMN} [-al] [-O fields] [-f format] [-o offset] [-L limit]",
-     "mark #{CMN} [-f format] <id>"]
+    ["list #{CMN} [-al] [-O fields] [-o offset] [-L limit]",
+     "mark #{CMN} <id>"]
   end
 
   def _options

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

@@ -8,7 +8,7 @@ class WavefrontCommandMetric < WavefrontCommandBase
   end
 
   def _commands
-    ["describe #{CMN} [-f format] [-o offset] [-g glob...] <metric>"]
+    ["describe #{CMN} [-o offset] [-g glob...] <metric>"]
   end
 
   def _options

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

@@ -8,13 +8,13 @@ class WavefrontCommandNotificant < WavefrontCommandBase
   end
 
   def _commands
-    ["list #{CMN} [-al] [-O fields] [-f format] [-o offset] [-L limit]",
-     "describe #{CMN} [-f format] <id>",
+    ["list #{CMN} [-al] [-O fields] [-o offset] [-L limit]",
+     "describe #{CMN} <id>",
      "import #{CMN} <file>",
      "delete #{CMN} <id>",
      "test #{CMN} <id>",
      "update #{CMN} <key=value> <id>",
-     "search #{CMN} [-al] [-f format] [-o offset] [-L limit] <condition>..."]
+     "search #{CMN} [-al] [-o offset] [-L limit] <condition>..."]
   end
 
   def _options

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

@@ -8,12 +8,12 @@ class WavefrontCommandProxy < WavefrontCommandBase
   end
 
   def _commands
-    ["list #{CMN} [-al] [-O fields] [-f format] [-o offset] [-L limit]",
-     "describe #{CMN} [-f format] <id>",
+    ["list #{CMN} [-al] [-O fields] [-o offset] [-L limit]",
+     "describe #{CMN} <id>",
      "delete #{CMN} <id>",
      "undelete #{CMN} <id>",
      "rename #{CMN} <id> <name>",
-     "search #{CMN} [-al] [-f format] [-o offset] [-L limit] <condition>...",
+     "search #{CMN} [-al] [-o offset] [-L limit] <condition>...",
      "versions #{CMN}"]
   end
 

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

@@ -9,11 +9,11 @@ class WavefrontCommandQuery < WavefrontCommandBase
 
   def _commands
     ['aliases [-DV] [-c file] [-P profile]',
-     "#{CMN} [-g granularity] [-s time] [-e time] [-f format] " \
+     "#{CMN} [-g granularity] [-s time] [-e time] " \
            '[-WikvO] [-S mode] [-N name] [-p points] [-F options] <query>',
-     "raw #{CMN} [-H host] [-s time] [-e time] [-f format] " \
+     "raw #{CMN} [-H host] [-s time] [-e time] " \
            '[-F options] <metric>',
-     "run #{CMN} [-g granularity] [-s time] [-e time] [-f format] " \
+     "run #{CMN} [-g granularity] [-s time] [-e time] " \
            '[-F options] [-WkivO] [-S mode] [-N name] [-p points] <alias>']
   end
 

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

@@ -16,11 +16,11 @@ class WavefrontCommandSavedsearch < WavefrontCommandBase
   end
 
   def _commands
-    ["list #{CMN} [-al] [-O fields] [-f format] [-o offset] [-L limit]",
-     "describe #{CMN} [-f format] <id>",
+    ["list #{CMN} [-al] [-O fields] [-o offset] [-L limit]",
+     "describe #{CMN} <id>",
      "delete #{CMN} <id>",
      "import #{CMN} <file>",
-     "search #{CMN} [-al] [-f format] [-o offset] [-L limit] <condition>..."]
+     "search #{CMN} [-al] [-o offset] [-L limit] <condition>..."]
   end
 
   def _options

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

@@ -0,0 +1,22 @@
+require_relative 'base'
+
+# Define the settings command.
+#
+class WavefrontCommandSettings < WavefrontCommandBase
+  def description
+    'view and manage system preferences'
+  end
+
+  def _commands
+    ["list permissions #{CMN} [-l] [-O fields]",
+     "show preferences #{CMN} [-l] [-O fields]",
+     "update #{CMN} <key=value>...",
+     "default usergroups #{CMN} [-l] [-O fields]"]
+  end
+
+  def _options
+    [common_options,
+     '-l, --long              list derived metrics in detail',
+     '-O, --fields=F1,F2,...  only show given fields']
+  end
+end

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

@@ -8,12 +8,12 @@ class WavefrontCommandSource < WavefrontCommandBase
   end
 
   def _commands
-    ["list #{CMN} [-l] [-O fields] [-f format] [-o cursor] [-L limit] [-a]",
-     "describe #{CMN} [-f format] <id>",
+    ["list #{CMN} [-l] [-O fields] [-o cursor] [-L limit] [-a]",
+     "describe #{CMN} <id>",
      "description set  #{CMN} <id> <description>",
      "description clear  #{CMN} <id>",
      "clear  #{CMN} <id>",
-     "search #{CMN} [-f format] [-o offset] [-L limit] [-l] <condition>...",
+     "search #{CMN} [-o offset] [-L limit] [-l] <condition>...",
      tag_commands]
   end
 

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

@@ -13,9 +13,9 @@ class WavefrontCommandUser < WavefrontCommandBase
   #
   def _commands
     ["list #{CMN} [-l] [-O fields]",
-     "describe #{CMN} [-f format] <id>",
-     "create #{CMN} [-e] [-m permission...] [-g group...] [-f format] <id>",
-     "invite #{CMN} [-m permission...] [-g group...] [-f format] <id>",
+     "describe #{CMN} <id>",
+     "create #{CMN} [-e] [-m permission...] [-g group...] <id>",
+     "invite #{CMN} [-m permission...] [-g group...] <id>",
      "update #{CMN} <key=value> <id>",
      "delete #{CMN} <user>...",
      "import #{CMN} <file>",
@@ -24,7 +24,7 @@ class WavefrontCommandUser < WavefrontCommandBase
      "leave #{CMN} <id> <group>...",
      "grant #{CMN} <privilege> to <id>",
      "revoke #{CMN} <privilege> from <id>",
-     "search #{CMN} [-al] [-f format] [-o offset] [-L limit] <condition>..."]
+     "search #{CMN} [-al] [-o offset] [-L limit] <condition>..."]
   end
 
   def _options

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

@@ -16,8 +16,8 @@ class WavefrontCommandUsergroup < WavefrontCommandBase
   end
 
   def _commands
-    ["list #{CMN} [-al] [-O fields] [-f format] [-o offset] [-L limit]",
-     "describe #{CMN} [-f format] <id>",
+    ["list #{CMN} [-al] [-O fields] [-o offset] [-L limit]",
+     "describe #{CMN} <id>",
      "create #{CMN} [-p permission...] <name>",
      "delete #{CMN} <id>",
      "import #{CMN} <file>",
@@ -28,7 +28,7 @@ class WavefrontCommandUsergroup < WavefrontCommandBase
      "remove user #{CMN} <id> <user>...",
      "grant #{CMN} <permission> to <id>",
      "revoke #{CMN} <permission> from <id>",
-     "search #{CMN} [-al] [-f format] [-o offset] [-L limit] <condition>..."]
+     "search #{CMN} [-al] [-o offset] [-L limit] <condition>..."]
   end
 
   def _options
@@ -43,10 +43,7 @@ class WavefrontCommandUsergroup < WavefrontCommandBase
   end
 
   def postscript
-    'Valid permissions at the time of writing are: agent_management, ' \
-    'alerts_management, dashboard_management, embedded_charts, ' \
-    'events_management, external_links_management, host_tag_management, ' \
-    'metrics_management, and user_management. Check the API docs for ' \
-    'an up-to-date list.'.fold(TW, 0)
+    "'wf settings list permissions' will give you a list of all " \
+    'currently supported permissions.'.fold(TW, 0)
   end
 end

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

@@ -8,12 +8,12 @@ class WavefrontCommandWebhook < WavefrontCommandBase
   end
 
   def _commands
-    ["list #{CMN} [-al] [-O fields] [-f format] [-o offset] [-L limit]",
-     "describe #{CMN} [-f format] <id>",
+    ["list #{CMN} [-al] [-O fields] [-o offset] [-L limit]",
+     "describe #{CMN} <id>",
      "delete #{CMN} <id>",
      "import #{CMN} <file>",
      "update #{CMN} <key=value> <id>",
-     "search #{CMN} [-al] [-f format] [-o offset] [-L limit] <condition>..."]
+     "search #{CMN} [-al] [-o offset] [-L limit] <condition>..."]
   end
 
   def _options

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

@@ -16,8 +16,8 @@ class WavefrontCommandWindow < WavefrontCommandBase
   end
 
   def _commands
-    ["list #{CMN} [-al] [-O fields] [-f format] [-o offset] [-L limit]",
-     "describe #{CMN} [-f format] <id>",
+    ["list #{CMN} [-al] [-O fields] [-o offset] [-L limit]",
+     "describe #{CMN} <id>",
      "create #{CMN} -d reason [-s time] [-e time] " \
      '[-A alert_tag...] [-T host_tag...] [-H host...] <title>',
      "close #{CMN} <id>",
@@ -25,7 +25,7 @@ class WavefrontCommandWindow < WavefrontCommandBase
      "delete #{CMN} <id>",
      "import #{CMN} <file>",
      "update #{CMN} <key=value> <id>",
-     "search #{CMN} [-al] [-f format] [-o offset] [-L limit] <condition>...",
+     "search #{CMN} [-al] [-o offset] [-L limit] <condition>...",
      "ongoing #{CMN}",
      "pending #{CMN} [<hours>]"]
   end

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

@@ -10,10 +10,10 @@ class WavefrontCommandWrite < WavefrontCommandBase
   def _commands
     ['point [-DnViq] [-c file] [-P profile] [-E proxy] [-t time] ' \
      '[-p port] [-H host] [-T tag...] [-u method] [-S socket] <metric> ' \
-     '<value>',
+     '[--] <value>',
      'distribution [-DnViq] [-c file] [-P profile] [-E proxy] [-H host] ' \
      '[-p port] [-T tag...] [-u method] [-S socket] [-I interval] ' \
-     '<metric> <val>...',
+     '<metric> [--] <val>...',
      'file [-DnViq] [-c file] [-P profile] [-E proxy] [-H host] ' \
      '[-p port] [-F infileformat] [-m metric] [-T tag...] [-I interval] ' \
      '[-u method] [-S socket] <file>']
@@ -43,7 +43,9 @@ class WavefrontCommandWrite < WavefrontCommandBase
     "with the '-F' option.  Use 't' for timestamp, 'm' for metric " \
     "name, 'v' for value, 's' for source, 'd' for a comma-separated " \
     "distribution, and 'T' for tags. Put 'T' last.  Currently " \
-    "supported transport methods are 'socket' (the default) " \
-    "and 'http'.".cmd_fold(TW, 0)
+    "supported transport methods are 'socket' (write to a proxy: the " \
+    "default); 'api' (write directly to Wavefront); 'http' (write to " \
+    "a proxy over HTTP); and 'unix' (write to a local Unix socket)."
+      .cmd_fold(TW, 0)
   end
 end

data/lib/wavefront-cli/config.rb

@@ -53,6 +53,20 @@ module WavefrontCli
       puts IO.read(config_file)
     end
 
+    def do_about
+      require 'wavefront-sdk/defs/version'
+      require_relative 'display/base'
+
+      info = { 'wf version':    WF_CLI_VERSION,
+               'wf path':       CMD.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
+    end
+
     def base_config
       return read_config if config_file.exist?
 

data/lib/wavefront-cli/controller.rb

@@ -136,6 +136,8 @@ class WavefrontCliController
     abort e.message
   rescue WavefrontCli::Exception::UnsupportedNoop
     abort 'Multiple API call operations cannot be performed as no-ops.'
+  rescue WavefrontCli::Exception::UserGroupNotFound => e
+    abort "Cannot find user group '#{e.message}'."
   rescue Wavefront::Exception::UnsupportedWriter => e
     abort "Unsupported writer '#{e.message}'."
   rescue StandardError => e

data/lib/wavefront-cli/dashboard.rb

@@ -43,33 +43,152 @@ module WavefrontCli
       resp.tap { |r| r.response.items = queries }
     end
 
+    def do_favs
+      require 'wavefront-sdk/search'
+      wfs = Wavefront::Search.new(mk_creds, mk_opts)
+      query = conds_to_query(['favorite=true'])
+      wfs.search(:dashboard, query, limit: :all, sort_field: :id)
+    end
+
     def do_fav
       wf.favorite(options[:'<id>'])
+      do_favs
     end
 
     def do_unfav
       wf.unfavorite(options[:'<id>'])
+      do_favs
+    end
+
+    def do_acls
+      wf.acls([options[:'<id>']])
+    end
+
+    def do_acl_clear
+      wf.acl_set(options[:'<id>'], [], [id: everyone_id, name: 'Everyone'])
+      do_acls
+    end
+
+    def do_acl_grant
+      acl_action(:grant_to)
+    end
+
+    def do_acl_revoke
+      acl_action(:revoke_from)
+    end
+
+    # Based on command-line options, return an array describing the
+    # users or groups (entities) which will be granted or revoked a
+    # privilege.
+    # @return [Array] [type_of_entity, [Hash]...]
+    #
+    def acl_entities
+      acl_type = options[:modify] ? :modify : :view
+
+      if options[:user]
+        [:users, user_lists(acl_type, options[:'<name>'])]
+      else
+        [:groups, group_lists(acl_type, options[:'<name>'])]
+      end
     end
 
-    # @param obj [Object] the thing to search
-    # @param key [String, Symbol] the key to search for
-    # @param aggr [Array] values of matched keys
-    # @return [Array]
+    # Make a list of users to be given to the SDK ACL methods. Users
+    # are defined as a Hash, with keys :id and :name.
+    # @param acl_type [Symbol] :view or :modify
+    # @param users [Array] user names
+    # @return [Array[Hash]]
     #
-    def extract_values(obj, key, aggr = [])
-      if obj.is_a?(Hash)
-        obj.each_pair do |k, v|
-          if k == key && !v.to_s.empty?
-            aggr.<< v
-          else
-            extract_values(v, key, aggr)
+    def user_lists(acl_type, users)
+      { view: [], modify: [] }.tap do |l|
+        l[acl_type] = users.map { |u| { id: u, name: u } }
+      end
+    end
+
+    # Generate arrays ready for passing to the SDK acl methods
+    # @return see #user_lists, but name and id are not the same.
+    #
+    def group_lists(acl_type, groups)
+      { view: [], modify: [] }.tap do |l|
+        l[acl_type] = groups.each_with_object([]) do |g, a|
+          name = group_name(g)
+
+          if name.nil?
+            puts "Cannot find group with id '#{g}'."
+            next
           end
+
+          a.<< ({ id: g, name: name })
         end
-      elsif obj.is_a?(Array)
-        obj.each { |e| extract_values(e, key, aggr) }
       end
+    end
 
-      aggr
+    private
+
+    # When given an ACL action (grant or revoke), call the right
+    # method with the right arguments.
+    # @param action [Symbol] :grant_to or :revoke_from
+    # @return [Wavefront::Response]
+    #
+    def acl_action(action)
+      entity_type, entities = acl_entities
+
+      resp = send(format('%s_%s', action, entity_type),
+                  options[:'<id>'],
+                  entities)
+
+      print_status(resp.status)
+      do_acls
+    end
+
+    # The #grant_to_ and #revoke_from_ methods are called by
+    # #acl_action, and speak to the SDK. They all return a
+    # Wavefront::Response object.
+    #
+    def grant_to_users(id, lists)
+      wf.acl_add(id, lists[:view], lists[:modify])
+    end
+
+    def revoke_from_users(id, lists)
+      wf.acl_delete(id, lists[:view], lists[:modify])
+    end
+
+    def grant_to_groups(id, lists)
+      wf.acl_add(id, lists[:view], lists[:modify])
+    end
+
+    def revoke_from_groups(id, lists)
+      wf.acl_delete(id, lists[:view], lists[:modify])
+    end
+
+    def print_status(status)
+      puts status.message unless status.message.empty?
+    rescue NoMethodError
+      nil
+    end
+
+    # Get the name of a user group, given the ID.
+    # @param group_id [String] UUID of a group
+    # @return [String, Nil] name of group, nil if it does not exist
+    #
+    def group_name(group_id)
+      require 'wavefront-sdk/usergroup'
+      wfs = Wavefront::UserGroup.new(mk_creds, mk_opts)
+      wfs.describe(group_id).response.name
+    rescue RuntimeError
+      nil
+    end
+
+    # @return [String] UUID of 'Everyone' group
+    # @raise WavefrontCli::Exception::UserGroupNotFound if group
+    #   does not exist. This is caught in the controller.
+    #
+    def everyone_id
+      require 'wavefront-sdk/search'
+      wfs = Wavefront::Search.new(mk_creds, mk_opts)
+      query = conds_to_query(['name=Everyone'])
+      wfs.search(:usergroup, query).response.items.first.id
+    rescue RuntimeError
+      raise WavefrontCli::Exception::UserGroupNotFound, 'Everyone'
     end
   end
 end