wavefront-cli 6.1.0 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d0fa52b33cb79a4b67bcb7054e9a998584630efc8318962b85e929029391af5
-  data.tar.gz: 9c5151b963d5cb5931b3c8d868e568f951a56de590a72d9277048ae36de3b086
+  metadata.gz: b1e0ee9608157074b898b31b5c169f432e4feed2d4af31e184b80016675f73cc
+  data.tar.gz: 4e845f4a56684903f2f1d800ee41cad9a8062a969a8fcb31e839bd51fac3891c
 SHA512:
-  metadata.gz: dd09d2f689141ab55e41cc8ec2e234b5e06c7e79f497587026f43acee11b624c8b06d436004d27fcb861c0b89731fa9f736c0c0490ca60e8ef20ec3de7612b40
-  data.tar.gz: f76f25fe45d6042e0800c658c482115658a122f56781c2b37835da1b2529a602c4f932f60fefd4f79fc1a91305619bfc82b0cf7c750986e7968ec823a69e6025
+  metadata.gz: 4635ae95d16aeb2bcb779010fc435945300991f1853ba75488a9e2914b6860129be4257ca13d5765c004efb746ce5f03fa7d686f71bb13ec5fe860f77c4cddbe
+  data.tar.gz: 501b3425f488c977363b42ec9d362d3e0c56ef8ba0b7cc91a2feb1da8bb2b91d2a1c27ade8cf8d3e5c01f3bde74cf0a582ead9c84f4dc4f0ae6e71c1a3691cc9

data/.rubocop.yml

@@ -8,10 +8,43 @@ Metrics/ClassLength:
 
 Style/IfUnlessModifier:
   Enabled: false # because it wants to make lines >80 chars
-
 Style/HashEachMethods:
     Enabled: true
 Style/HashTransformKeys:
     Enabled: true
 Style/HashTransformValues:
     Enabled: true
+
+# New compatabilities
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
+Style/AccessorGrouping:
+  Enabled: true
+Style/BisectedAttrAccessor:
+  Enabled: true
+Style/RedundantAssignment:
+  Enabled: true
+Style/RedundantFetchBlock:
+  Enabled: true
+
+# Is nothing sacred?
+Layout/LineLength:
+  Max: 80

data/HISTORY.md

@@ -1,17 +1,33 @@
 # Changelog
 
+## 7.1.0 (2020-08-07)
+* Remove `user` command. (Breaking change.)
+* Add `account` command.
+* Complete coverage of roles and user groups.
+* Add `alert affected hosts` command to show which hosts are affected by one
+  or all firing alerts.
+* Remove obsolete `group` subcommands. (`grant` and `revoke`).
+* Add `write noise` command to send a flow of random data to an endpoint.
+* Better information when working with cloud integrations.
+
+## 7.0.0 (unreleased)
+
 ## 6.1.0 (2020-06-02)
 * Add `-A` flag to `proxy list` command, to only list active proxies
 
 ## 6.0.0 (2020-04-07)
 * Remove `cluster` command. (Breaking change.)
+* Add `role` command.
+* Add `--nocache`, `--nostrict` and `--histogram-view` options to `query`
+  command.
+* Require 5.x of [the SDK](https://github.com/snltd/wavefront-sdk).
 
 ## 5.1.2 (2020-02-28)
 * Fix regression in HCL dashboard export.
 * Properly handle unavailable port when sending distributions to a proxy.
 
 ## 5.1.1 (2020-02-20)
-* Say whether `--upsert` did and update or an import.
+* Say whether `--upsert` did an update or an import.
 
 ## 5.1.0 (2020-02-20)
 * Add `-U` (`--upsert`) option to `import` sub-commands.

data/README.md

@@ -51,7 +51,6 @@ Commands:
   source             view and manage source tags and descriptions
   spy                monitor traffic going into Wavefront
   usage              view and manage usage reports
-  user               view and manage Wavefront users
   usergroup          view and manage Wavefront user groups
   webhook            view and manage webhooks
   window             view and manage maintenance windows
@@ -103,7 +102,7 @@ $ wf proxy list
 
 You can get more verbose listings with the `-l` flag. Results may be
 paginated. You can progress through pages with the `-L` and `-o`
-options, or user `--all` to get everything in one go.
+options, or use `--all` to get everything in one go.
 
 ### Describing Things
 
@@ -151,7 +150,7 @@ mentioned above, human-readable listings and desctiptions may omit
 data which is not likely to be useful, or which is extremely hard to
 present in a readable way.
 
-If you `describe` an object like a dashboard, user, webhook etc as
+If you `describe` an object like a dashboard, account, webhook etc as
 `json` or `yaml`, and send the output to a file, you can re-import
 that data. The format of the file to be imported is automatically
 detected.

data/lib/wavefront-cli/account.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module WavefrontCli
+  #
+  # CLI coverage for the v2 'account' API.
+  #
+  class Account < WavefrontCli::Base
+    alias do_roles do_describe
+    alias do_groups do_describe
+    alias do_ingestionpolicy do_describe
+    alias do_permissions do_describe
+
+    def do_role_add_to
+      wf_account_id?(options[:'<id>'])
+      wf.add_roles(options[:'<id>'], options[:'<role>'])
+    end
+
+    def do_role_remove_from
+      wf_account_id?(options[:'<id>'])
+      wf.remove_roles(options[:'<id>'], options[:'<role>'])
+    end
+
+    def do_group_add_to
+      wf_account_id?(options[:'<id>'])
+      wf.add_user_groups(options[:'<id>'], options[:'<group>'])
+    end
+
+    def do_group_remove_from
+      wf_account_id?(options[:'<id>'])
+      wf.remove_user_groups(options[:'<id>'], options[:'<group>'])
+    end
+
+    def do_business_functions
+      wf_user_id?(options[:'<id>'])
+      wf.business_functions(options[:'<id>'])
+    end
+
+    def do_grant_to
+      wf.grant(options[:'<account>'], options[:'<permission>'])
+    end
+
+    def do_revoke_from
+      wf.revoke(options[:'<account>'], options[:'<permission>'])
+    end
+
+    def do_ingestionpolicy_add_to
+      wf_account_id?(options[:'<id>'])
+      wf.add_ingestion_policy(options[:'<policy>'], [options[:'<id>']])
+    end
+
+    def do_ingestionpolicy_remove_from
+      wf_account_id?(options[:'<id>'])
+      wf_ingestionpolicy_id?(options[:'<policy>'])
+      wf.remove_ingestion_policy(options[:'<policy>'], [options[:'<id>']])
+    end
+
+    def do_create_user
+      wf_user_id?(options[:'<id>'])
+      wf.user_create(user_body)
+    end
+
+    def do_invite_user
+      wf_user_id?(options[:'<id>'])
+      wf.user_invite([user_body])
+    end
+
+    def do_validate
+      wf.validate_accounts(options[:'<account>'])
+    end
+
+    def extra_validation
+      validate_policy
+      validate_permission
+      validate_roles
+      validate_groups
+      validate_accounts
+    end
+
+    private
+
+    def validate_policy
+      wf_ingestionpolicy_id?(options[:'<policy>']) if options[:'<policy>']
+    end
+
+    def validate_permission
+      wf_permission?(options[:'<permission>']) if options[:'<permission>']
+    end
+
+    def validate_roles
+      options[:'<role>'].each { |r| wf_role_id?(r) }
+    end
+
+    def validate_groups
+      options[:'<group>'].each { |g| wf_usergroup_id?(g) }
+    end
+
+    def validate_accounts
+      options[:'<account>'].each { |a| wf_account_id?(a) }
+    end
+
+    # Object used to create and invite users. We deal with the permissions
+    # seperately because if we don't supply any and they get compacted out,
+    # the user is created with a default set of perms, and we don't want that.
+    #
+    def user_body
+      raw = {
+        emailAddress: options[:'<id>'],
+        roles: options[:roleid],
+        ingestionPolicyId: options[:policyid],
+        userGroups: options[:groupid]
+      }.reject { |_k, v| v&.empty? }.compact
+
+      raw[:groups] = options[:permission]
+      raw
+    end
+  end
+end

data/lib/wavefront-cli/alert.rb

@@ -50,6 +50,14 @@ module WavefrontCli
       wf.history(options[:'<id>'], options[:offset], options[:limit])
     end
 
+    def do_affected_hosts
+      if options[:'<id>']
+        affected_hosts_for_id(options[:'<id>'])
+      else
+        all_affected_hosts
+      end
+    end
+
     def do_currently
       state = options[:'<state>'].to_s
 
@@ -146,5 +154,26 @@ module WavefrontCli
         end
       end.compact
     end
+
+    def all_affected_hosts
+      cannot_noop!
+      in_state(:firing).tap do |r|
+        r.response = r.response.items.each_with_object({}) do |alert, aggr|
+          aggr[alert[:id]] = affected_hosts_for_id(alert[:id]).response
+        end
+      end
+    end
+
+    def affected_hosts_for_id(id)
+      resp = wf.describe(id)
+
+      return if options[:noop]
+
+      return resp unless resp.ok? && resp.response.key?(:failingHostLabelPairs)
+
+      resp.tap do |r|
+        r.response = r.response[:failingHostLabelPairs].map { |h| h[:host] }
+      end
+    end
   end
 end

data/lib/wavefront-cli/base.rb

@@ -485,7 +485,6 @@ module WavefrontCli
     # @param cond [String] a search condition, like "key=value"
     # @return [Hash] of matchingMethod and negated
     #
-    # rubocop:disable Metrics/CyclomaticComplexity
     # rubocop:disable Metrics/MethodLength
     def matching_method(cond)
       case cond
@@ -506,7 +505,6 @@ module WavefrontCli
       end
     end
     # rubocop:enable Metrics/MethodLength
-    # rubocop:enable Metrics/CyclomaticComplexity
 
     # Return a detailed description of one item, if an ID has been
     # given, or all items if it has not.

data/lib/wavefront-cli/commands/.rubocop.yml

@@ -11,3 +11,37 @@ Style/HashTransformKeys:
     Enabled: true
 Style/HashTransformValues:
     Enabled: true
+
+# new compatabilities
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
+Style/AccessorGrouping:
+  Enabled: true
+Style/BisectedAttrAccessor:
+  Enabled: true
+Style/RedundantAssignment:
+  Enabled: true
+Style/RedundantFetchBlock:
+  Enabled: true
+
+# Is nothing sacred?
+Layout/LineLength:
+  Max: 80

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+# Define the account command.
+#
+class WavefrontCommandAccount < WavefrontCommandBase
+  def description
+    "view and manage Wavefront #{things}"
+  end
+
+  def _commands
+    ["list #{CMN} [-sSal] [-O fields] [-o offset] [-L limit]",
+     "describe #{CMN} <id>",
+     "create user #{CMN} [-m permission...] [-g group-id...] " \
+     '[-r role-id...] [-i policy-id] <id>',
+     "invite user #{CMN} [-m permission...] [-g group-id...] " \
+     '[-r role-id...] [-i policy-id] <id>',
+     "delete #{CMN} <id>",
+     "dump #{CMN}",
+     "import #{CMN} [-uU] <file>",
+     "role #{CMN} add to <id> <role>...",
+     "role #{CMN} remove from <id> <role>...",
+     "roles #{CMN} <id>",
+     "ingestionpolicy #{CMN} add to <id> <policy>",
+     "ingestionpolicy #{CMN} remove from <id> <policy>",
+     "ingestionpolicy #{CMN} <id>",
+     "group #{CMN} add to <id> <group>...",
+     "group #{CMN} remove from <id> <group>...",
+     "groups #{CMN} <id>",
+     "grant #{CMN} <permission> to <account>...",
+     "revoke #{CMN} <permission> from <account>...",
+     "permissions #{CMN} <id>",
+     "business functions #{CMN} <id>",
+     "validate #{CMN} [-l] <account>...",
+     "search #{CMN} [-al] [-o offset] [-L limit] [-O fields] <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",
+     '-s, --service            list only service accounts',
+     '-S, --user               list only user accounts',
+     '-O, --fields=F1,F2,...   only show given fields',
+     "-u, --update             update an existing #{thing}",
+     "-U, --upsert             import new or update existing #{thing}",
+     '-m, --permission=STRING  Wavefront permission name',
+     '-g, --groupid=STRING     Wavefront usergroup ID',
+     '-r, --roleid=STRING      Wavefront role ID',
+     '-i, --policyid=STRING    Wavefront ingestion policy ID']
+  end
+
+  def postscript
+    'Service accounts can be partially managed with this command, but ' \
+    "'wf serviceaccount' has more features.\n\nFor a list of permissions, " \
+    "run 'wf settings list permissions'.".fold(TW, 0)
+  end
+end

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

@@ -8,6 +8,7 @@ class WavefrontCommandAlert < WavefrontCommandBase
   def _commands
     ["list #{CMN} [-al] [-O fields] [-o offset] [-L limit]",
      "firing #{CMN} [-o offset] [-L limit]",
+     "affected #{CMN} hosts [<id>]",
      "snoozed #{CMN} [-o offset] [-L limit]",
      "describe #{CMN} [-v version] <id>",
      "delete #{CMN} <id>",

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

@@ -165,6 +165,6 @@ class WavefrontCommandBase
   # @return [String] a full options string which docopt understands
   #
   def docopt
-    commands + "\n\n" + options + "\n" + postscript
+    commands + "\n\n" + options + "\n\n" + postscript
   end
 end

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

@@ -12,7 +12,7 @@ class WavefrontCommandQuery < WavefrontCommandBase
   def _commands
     ['aliases [-DV] [-c file] [-P profile]',
      "#{CMN} [-g granularity] [-s time] [-e time] " \
-           '[-WikvO] [-S mode] [-N name] [-p points] [-F options] <query>',
+           '[-ikvCGKOW] [-S mode] [-N name] [-p points] [-F options] <query>',
      "raw #{CMN} [-H host] [-s time] [-e time] " \
            '[-F options] <metric>',
      "run #{CMN} [-g granularity] [-s time] [-e time] " \
@@ -36,6 +36,9 @@ class WavefrontCommandQuery < WavefrontCommandBase
      '-F, --format-opts=STRING  comma-separated options to pass to ' \
                                 'output formatter',
      '-k, --nospark             do not show sparkline',
+     '-C, --nocache             do not use the query cache',
+     '-K, --nostrict            allow points outside the query window',
+     '-G, --histogram-view      use histogram view rather than metric',
      '-W, --nowarn              do not show API warning messages']
   end
 

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+# Define the 'role' command.
+#
+class WavefrontCommandRole < WavefrontCommandBase
+  def _commands
+    ["list #{CMN} [-al] [-O fields] [-o offset] [-L limit]",
+     "describe #{CMN} <id>",
+     "create #{CMN} [-d description] [-p permission...] <name>",
+     "delete #{CMN} <id>",
+     "dump #{CMN}",
+     "import #{CMN} [-uU] <file>",
+     "set #{CMN} <key=value> <id>",
+     "accounts #{CMN} <id>",
+     "groups #{CMN} <id>",
+     "permissions #{CMN} <id>",
+     "give #{CMN} <id> to <member>...",
+     "take #{CMN} <id> from <member>...",
+     "grant #{CMN} <permission> to <id>",
+     "revoke #{CMN} <permission> from <id>",
+     "search #{CMN} [-al] [-o offset] [-L limit] [-O fields] <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}",
+     "-U, --upsert             import new or update existing #{thing}",
+     "-d, --description=STRING description of #{thing}",
+     '-p, --permission=STRING  Wavefront permission']
+  end
+
+  def postscript
+    "A role 'member' can be an account ID or a usergroup ID. 'wf settings " \
+    "list permissions' will give you a list of all currently supported " \
+    'permissions.'.fold(TW, 0)
+  end
+end