wavefront-cli 5.1.0 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2500c3c1046355e74eaa41f1e612a2f05054ffc54f752f79cac8f4c8f47dfd07
-  data.tar.gz: 9676df59ed6592399703de971ea8b2f691fe09443c74147d60096b3789d83ae5
+  metadata.gz: b1e0ee9608157074b898b31b5c169f432e4feed2d4af31e184b80016675f73cc
+  data.tar.gz: 4e845f4a56684903f2f1d800ee41cad9a8062a969a8fcb31e839bd51fac3891c
 SHA512:
-  metadata.gz: 441cf573c9c17603679bd39d3b1f9d0dcf15ca0fc68f8f0b72fa2969fc9384931d9b549e54b0659e5103f0f09f04d50b45987758ddcd54115ceb450bda832366
-  data.tar.gz: d4236668320cc4167100784cc7c265c22a5d6bddf5e1a44da54c4b20c8b657e782582046551989800b0c4548f611c06aa900f5eb5ed3daaa46e1472d62f0f35a
+  metadata.gz: 4635ae95d16aeb2bcb779010fc435945300991f1853ba75488a9e2914b6860129be4257ca13d5765c004efb746ce5f03fa7d686f71bb13ec5fe860f77c4cddbe
+  data.tar.gz: 501b3425f488c977363b42ec9d362d3e0c56ef8ba0b7cc91a2feb1da8bb2b91d2a1c27ade8cf8d3e5c01f3bde74cf0a582ead9c84f4dc4f0ae6e71c1a3691cc9

data/.rubocop.yml

@@ -1,14 +1,50 @@
 ---
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
 
 Metrics/ClassLength:
   Max: 400
 
+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,5 +1,34 @@
 # 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 an update or an import.
+
 ## 5.1.0 (2020-02-20)
 * Add `-U` (`--upsert`) option to `import` sub-commands.
 

data/README.md

@@ -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

@@ -46,7 +46,7 @@ module WavefrontCli
     end
 
     # Normally we map the class name to a similar one in the SDK.
-    # Overriding his method lets you map to something else.
+    # Overriding this method lets you map to something else.
     #
     def _sdk_class
       self.class.name.sub(/Cli/, '')
@@ -349,60 +349,6 @@ module WavefrontCli
       raise(WavefrontCli::Exception::CredentialError, 'Missing API endpoint.')
     end
 
-    # Give it a path to a file (as a string) and it will return the
-    # contents of that file as a Ruby object. Automatically detects
-    # JSON and YAML. Raises an exception if it doesn't look like
-    # either. If path is '-' then it will read STDIN.
-    #
-    # @param path [String] the file to load
-    # @return [Hash] a Ruby object of the loaded file
-    # @raise WavefrontCli::Exception::UnsupportedFileFormat if the
-    #   filetype is unknown.
-    # @raise pass through any error loading or parsing the file
-    #
-    def load_file(path)
-      return load_from_stdin if path == '-'
-
-      file = Pathname.new(path)
-      extname = file.extname.downcase
-
-      raise WavefrontCli::Exception::FileNotFound unless file.exist?
-
-      return load_json(file) if extname == '.json'
-      return load_yaml(file) if %w[.yaml .yml].include?(extname)
-
-      raise WavefrontCli::Exception::UnsupportedFileFormat
-    end
-
-    def load_json(file)
-      read_json(IO.read(file))
-    end
-
-    def load_yaml(file)
-      read_yaml(IO.read(file))
-    end
-
-    # Read STDIN and return a Ruby object, assuming that STDIN is
-    # valid JSON or YAML. This is a dumb method, it does no
-    # buffering, so STDIN must be a single block of data. This
-    # appears to be a valid assumption for use-cases of this CLI.
-    #
-    # @return [Object]
-    # @raise Wavefront::Exception::UnparseableInput if the input
-    #   does not parse
-    #
-    def load_from_stdin
-      raw = STDIN.read
-
-      if raw.start_with?('---')
-        read_yaml(raw)
-      else
-        read_json(raw)
-      end
-    rescue RuntimeError
-      raise Wavefront::Exception::UnparseableInput
-    end
-
     # Below here are common methods. Most are used by most classes,
     # but if they don't match a command described in the docopt
     # text, the dispatcher will never call them. So, there's no
@@ -451,50 +397,8 @@ module WavefrontCli
     end
 
     def do_import
-      raw = load_file(options[:'<file>'])
-      errs = 0
-
-      [raw].flatten.each do |obj|
-        resp = import_object(obj)
-        next if options[:noop]
-
-        errs += 1 unless resp.ok?
-        puts import_message(obj, resp)
-      end
-
-      exit errs
-    end
-
-    def import_message(obj, resp)
-      format('%-15<id>s %-10<status>s %<message>s',
-             id: obj[:id] || obj[:url],
-             status: resp.ok? ? 'IMPORTED' : 'FAILED',
-             message: resp.status.message)
-    end
-
-    def import_object(raw)
-      raw = preprocess_rawfile(raw) if respond_to?(:preprocess_rawfile)
-      prepped = import_to_create(raw)
-
-      if options[:upsert]
-        import_upsert(raw, prepped)
-      elsif options[:update]
-        import_update(raw)
-      else
-        wf.create(prepped)
-      end
-    end
-
-    def import_upsert(raw, prepped)
-      update_call = import_update(raw)
-      return update_call if update_call.ok?
-
-      puts 'update failed, inserting' if options[:verbose] || options[:debug]
-      wf.create(prepped)
-    end
-
-    def import_update(raw)
-      wf.update(raw[:id], raw, false)
+      require_relative 'subcommands/import'
+      WavefrontCli::Subcommand::Import.new(self, options).run!
     end
 
     def do_delete
@@ -581,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
@@ -602,19 +505,6 @@ module WavefrontCli
       end
     end
     # rubocop:enable Metrics/MethodLength
-    # rubocop:enable Metrics/CyclomaticComplexity
-
-    # Most things will re-import with the POST method if you remove
-    # the ID.
-    #
-    def import_to_create(raw)
-      raw.each_with_object({}) do |(k, v), a|
-        a[k.to_sym] = v unless k == :id
-      end
-    rescue StandardError => e
-      puts e if options[:debug]
-      raise WavefrontCli::Exception::UnparseableInput
-    end
 
     # Return a detailed description of one item, if an ID has been
     # given, or all items if it has not.
@@ -665,14 +555,16 @@ module WavefrontCli
     end
     # rubocop:enable Metrics/MethodLength
 
-    private
-
-    def read_json(io)
-      JSON.parse(io, symbolize_names: true)
-    end
-
-    def read_yaml(io)
-      YAML.safe_load(io, symbolize_names: true)
+    # Most things will re-import with the POST method if you remove
+    # the ID.
+    #
+    def import_to_create(raw)
+      raw.each_with_object({}) do |(k, v), a|
+        a[k.to_sym] = v unless k == :id
+      end
+    rescue StandardError => e
+      puts e if options[:debug]
+      raise WavefrontCli::Exception::UnparseableInput
     end
   end
 end