wavefront-cli 5.1.2 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aff5882ee50326f0642694b667dd8001e36846542253c6ea9506c0b6bb29158b
-  data.tar.gz: 1fa12f61b0f0d765bb03b0123fe5e4927e5e2b7bacb141bdfbb603d0287a25f1
+  metadata.gz: 4935d9901fe186c38fdbe357b4ee52d3b98d3bc6a214f4c3648d52229f760e92
+  data.tar.gz: acbf0f389bbfc37c2bc61ab1aa772afdbc92984d4d7592bf8f8f93ba606d78be
 SHA512:
-  metadata.gz: d405cdf2a4ffcc1e5b39241cf4b070204708b56dbb2f53e6548f0dd683ac99f2b941f073f8804d4168494e2071b4813c68e0442b791f68698f4444290c722f67
-  data.tar.gz: 7919e72fc0bb6ff56bc187d2a0fbdb24dbe8f54d79eab2b5cd244333fc73112def3a64f08cd83f3d39044193199519cf320045dd5ff21d27c3eb2599ca2a5f3f
+  metadata.gz: 8efc8b7a1363bc0e0b0b3800ce70b0fb1b4cb8b8dd61a03fdd56be5376fe4abf178975414926dfff03ae742f66f7469f5810c29bd0fafcc070423fd34175c5e3
+  data.tar.gz: 725f41a25db164bf4c3f5835df9ff490bfe54e1f4b3cc2beb461d1000bd1ef212584f995501e8706aa876c989ec258176239996d50bb943c963395d7a5a1367d

data/.rubocop.yml

@@ -1,14 +1,19 @@
 ---
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.5
+  NewCops: enable
 
 Metrics/ClassLength:
   Max: 400
 
-Style/HashEachMethods:
-    Enabled: true
-Style/HashTransformKeys:
-    Enabled: true
-Style/HashTransformValues:
-    Enabled: true
+Style/IfUnlessModifier:
+  Enabled: false # because it wants to make lines >80 chars
+Style/StringConcatenation:
+  Enabled: false
+Style/OptionalBooleanParameter:
+  Enabled: false
+
+# Is nothing sacred?
+Layout/LineLength:
+  Max: 80

data/.travis.yml

@@ -1,10 +1,9 @@
 language: ruby
 cache: bundler
 rvm:
-  - 2.4.9
-  - 2.5.7
-  - 2.6.5
-  - 2.7.0
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
 before_install: gem install bundler --no-document
 deploy:
   provider: rubygems
@@ -14,7 +13,7 @@ deploy:
   on:
     tags: true
     repo: snltd/wavefront-cli
-    ruby: 2.6.5
+    ruby: 2.6.6
 notifications:
   email: false
   slack:

data/HISTORY.md

@@ -1,11 +1,42 @@
 # Changelog
 
+## 8.0.0 (2020-09-20
+* Drop Ruby 2.4.0 support. (Breaking change.)
+
+## 7.2.0 (2020-08-12)
+* Add `cloudintegration awsid generate` command.
+* Add `cloudintegration awsid delete <external_id>` command.
+* Add `cloudintegration awsid validate <external_id>` command.
+* Require 5.1.x of [the SDK](https://github.com/snltd/wavefront-sdk).
+
+## 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

@@ -15,7 +15,7 @@ $ gem install wavefront-cli
 
 It is built on [our Wavefront Ruby
 SDK](https://github.com/snltd/wavefront-sdk) and requires Ruby >=
-2.4. It has no "native extension" dependencies.
+2.5. It has no "native extension" dependencies.
 
 For a far more comprehensive overview/tutorial, please read [this
 article](https://sysdef.xyz/article/wavefront-cli).
@@ -33,7 +33,6 @@ Commands:
   alert              view and manage alerts
   apitoken           view and your own API tokens
   cloudintegration   view and manage cloud integrations
-  cluster            view and manage monitored clusters
   config             create and manage local configuration
   dashboard          view and manage dashboards
   derivedmetric      view and manage derived metrics
@@ -52,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
@@ -104,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
 
@@ -152,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

@@ -102,12 +102,10 @@ module WavefrontCli
 
     def validate_tags(key = :'<tag>')
       Array(options[key]).each do |t|
-        begin
-          send(:wf_tag?, t)
-        rescue Wavefront::Exception::InvalidTag
-          raise(WavefrontCli::Exception::InvalidInput,
-                "'#{t}' is not a valid tag.")
-        end
+        send(:wf_tag?, t)
+      rescue Wavefront::Exception::InvalidTag
+        raise(WavefrontCli::Exception::InvalidInput,
+              "'#{t}' is not a valid tag.")
       end
     end
 
@@ -371,9 +369,10 @@ module WavefrontCli
     def do_dump
       cannot_noop!
 
-      if options[:format] == 'yaml'
+      case options[:format]
+      when 'yaml'
         ok_exit dump_yaml
-      elsif options[:format] == 'json'
+      when 'json'
         ok_exit dump_json
       else
         abort format("Dump format must be 'json' or 'yaml'. " \
@@ -485,7 +484,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 +504,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.
@@ -541,7 +538,8 @@ module WavefrontCli
     #
     # rubocop:disable Metrics/MethodLength
     def extract_values(obj, key, aggr = [])
-      if obj.is_a?(Hash)
+      case obj.class
+      when Hash
         obj.each_pair do |k, v|
           if k == key && !v.to_s.empty?
             aggr.<< v
@@ -549,7 +547,7 @@ module WavefrontCli
             extract_values(v, key, aggr)
           end
         end
-      elsif obj.is_a?(Array)
+      when Array
         obj.each { |e| extract_values(e, key, aggr) }
       end
 

data/lib/wavefront-cli/cloudintegration.rb

@@ -22,5 +22,17 @@ module WavefrontCli
     def do_disable
       wf.disable(options[:'<id>'])
     end
+
+    def do_awsid_generate
+      wf.create_aws_external_id
+    end
+
+    def do_awsid_delete
+      wf.delete_aws_external_id(options[:'<external_id>'])
+    end
+
+    def do_awsid_confirm
+      wf.confirm_aws_external_id(options[:'<external_id>'])
+    end
   end
 end

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

@@ -1,13 +1,19 @@
 ---
+AllCops:
+  NewCops: enable
 
 # There are long things in here, but they're fine
 #
 Metrics/MethodLength:
   Max: 25
 
-Style/HashEachMethods:
-    Enabled: true
-Style/HashTransformKeys:
-    Enabled: true
-Style/HashTransformValues:
-    Enabled: true
+# Is nothing sacred?
+Layout/LineLength:
+  Max: 80
+
+Style/IfUnlessModifier:
+  Enabled: false # because it wants to make lines >80 chars
+Style/StringConcatenation:
+  Enabled: false
+Style/OptionalBooleanParameter:
+  Enabled: false

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