wavefront-cli 5.1.0 → 7.1.0

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

@@ -74,5 +74,13 @@ module WavefrontDisplay
     def do_version
       puts data.max
     end
+
+    def do_affected_hosts
+      if data == [nil]
+        puts 'Alert event is not attached to any hosts.'
+      else
+        long_output
+      end
+    end
   end
 end

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

@@ -112,7 +112,7 @@ module WavefrontDisplay
     # long listing objects. Subclasses may define their own.
     #
     def priority_keys
-      %i[id name]
+      %i[id name identifier]
     end
 
     def prioritize_keys(data, keys)

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

@@ -8,11 +8,12 @@ module WavefrontDisplay
   #
   class CloudIntegration < Base
     def do_list_brief
-      multicolumn(:id, :service)
+      multicolumn(:id, :service, :name)
     end
 
     def do_describe
-      readable_time(:lastReceivedDataPointMs, :lastProcessingTimestamp)
+      readable_time(:lastReceivedDataPointMs, :lastProcessingTimestamp,
+                    :createdEpochMillis, :updatedEpochMillis)
       drop_fields(:forceSave, :inTrash, :deleted)
       long_output
     end

data/lib/wavefront-cli/display/printer/long.rb

@@ -8,6 +8,7 @@ module WavefrontDisplayPrinter
   #
   class Long
     attr_reader :opts, :list, :kw
+
     #
     # @param data [Hash] of data to display
     # @param fields [Array[Symbol]] requred fields
@@ -55,7 +56,7 @@ module WavefrontDisplayPrinter
     def preened_value(value)
       return value unless value.is_a?(String) && value =~ /<.*>/
 
-      value.gsub(%r{<\/?[^>]*>}, '').delete("\n")
+      value.gsub(%r{</?[^>]*>}, '').delete("\n")
     end
 
     # A recursive function which takes a structure, most likely a

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

@@ -7,6 +7,16 @@ module WavefrontDisplay
   # Format human-readable output for proxies.
   #
   class Proxy < Base
+    def do_list
+      filter_inactive_proxies! if options[:active]
+      super
+    end
+
+    def do_list_brief
+      filter_inactive_proxies! if options[:active]
+      super
+    end
+
     def do_describe
       readable_time(:lastCheckInTime)
       long_output
@@ -15,5 +25,11 @@ module WavefrontDisplay
     def do_versions
       multicolumn(:id, :version, :name)
     end
+
+    private
+
+    def filter_inactive_proxies!
+      data.delete_if { |p| p[:status] != 'ACTIVE' }
+    end
   end
 end

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module WavefrontDisplay
+  #
+  # Format human-readable output for role command
+  #
+  class Role < Base
+    def do_list_brief
+      data.map! do |d|
+        d.merge(acct_count: "#{d[:linkedAccountsCount]} accounts",
+                group_count: "#{d[:linkedGroupsCount]} groups")
+      end
+      multicolumn(:id, :name, :acct_count, :group_count)
+    end
+
+    def do_accounts
+      if data.empty?
+        puts "No accounts have role '#{options[:'<id>']}'."
+      else
+        multicolumn(:identifier)
+      end
+    end
+
+    def do_groups
+      if data.empty?
+        puts "No groups have role '#{options[:'<id>']}'."
+      else
+        multicolumn(:id, :name)
+      end
+    end
+
+    def do_permissions
+      if data[:permissions].empty?
+        puts "Role '#{options[:'<id>']}' has no permissions."
+      else
+        puts data[:permissions]
+      end
+    end
+
+    def do_grant
+      puts format("Granted '%<perm>s' permission to '%<id>s'.",
+                  perm: options[:'<permission>'],
+                  id: options[:'<id>'])
+    end
+
+    def do_revoke
+      puts format("Revoked '%<perm>s' permission from '%<id>s'.",
+                  perm: options[:'<permission>'],
+                  id: options[:'<id>'])
+    end
+
+    def do_give_to
+      puts format("Gave '%<role>s' to %<members>s.",
+                  members: quoted(options[:'<member>']),
+                  role: options[:'<id>']).fold(TW, 0)
+    end
+
+    def do_take_from
+      puts format("Took '%<role>s' from %<members>s.",
+                  members: quoted(options[:'<member>']),
+                  role: options[:'<id>']).fold(TW, 0)
+    end
+  end
+end

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

@@ -8,6 +8,7 @@ module WavefrontDisplay
   #
   class Settings < Base
     def do_list_permissions
+      data.sort_by! { |p| p[:groupName] }
       options[:long] ? long_output : multicolumn(:groupName)
     end
 

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

@@ -15,28 +15,28 @@ module WavefrontDisplay
       puts "Deleted user group '#{options[:'<id>']}'."
     end
 
-    def do_add_user
+    def do_add_to
       puts format("Added %<quoted_user>s to '%<group_id>s'.",
                   quoted_user: quoted(options[:'<user>']),
                   group_id: options[:'<id>']).fold(TW, 0)
     end
 
-    def do_remove_user
+    def do_remove_from
       puts format("Removed %<quoted_user>s from '%<group_id>s'.",
                   quoted_user: quoted(options[:'<user>']),
                   group_id: options[:'<id>']).fold(TW, 0)
     end
 
-    def do_grant
-      puts format("Granted '%<perm>s' permission to '%<group_id>s'.",
-                  perm: options[:'<permission>'],
-                  group_id: options[:'<id>'])
+    def do_add_role
+      puts format("Added %<quoted_role>s to '%<group_id>s'.",
+                  quoted_role: quoted(options[:'<role>']),
+                  group_id: options[:'<id>']).fold(TW, 0)
     end
 
-    def do_revoke
-      puts format("Revoked '%<perm>s' permission from '%<group_id>s'.",
-                  perm: options[:'<permission>'],
-                  group_id: options[:'<id>'])
+    def do_remove_role
+      puts format("Removed %<quoted_role>s from '%<group_id>s'.",
+                  quoted_role: quoted(options[:'<role>']),
+                  group_id: options[:'<id>']).fold(TW, 0)
     end
 
     def do_users
@@ -47,12 +47,16 @@ module WavefrontDisplay
            end)
     end
 
-    def do_permissions
-      puts(if !data.include?(:permissions) || data[:permissions].empty?
-             "Group '#{options[:'<id>']}' has no permissions."
+    def do_roles
+      puts(if !data.include?(:roles) || data[:roles].empty?
+             "Group '#{options[:'<id>']}' has no roles attached."
            else
-             data[:permissions]
+             data[:roles].map { |r| r[:id] }
            end)
     end
+
+    def do_permissions
+      puts data[:roles].map { |r| r[:permissions] }.flatten.sort.uniq
+    end
   end
 end

data/lib/wavefront-cli/exception_handler.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module WavefrontCli
+  #
+  # Handle fatal errors.
+  #
+  module ExceptionMixins
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/PerceivedComplexity
+    def exception_handler(exception)
+      case exception
+      when WavefrontCli::Exception::UnhandledCommand
+        abort 'Fatal error. Unsupported command. Please open a Github issue.'
+      when WavefrontCli::Exception::InvalidInput
+        abort "Invalid input. #{exception.message}"
+      when Interrupt
+        abort "\nOperation aborted at user request."
+      when WavefrontCli::Exception::ConfigFileNotFound
+        abort "Configuration file #{exception}' not found."
+      when WavefrontCli::Exception::CredentialError
+        handle_missing_credentials(exception)
+      when WavefrontCli::Exception::MandatoryValue
+        abort 'A value must be supplied.'
+      when Wavefront::Exception::NetworkTimeout
+        abort 'Connection timed out.'
+      when Wavefront::Exception::InvalidPermission
+        abort "'#{exception}' is not a valid Wavefront permission."
+      when Wavefront::Exception::InvalidUserGroupId
+        abort "'#{exception}' is not a valid user group ID."
+      when Wavefront::Exception::InvalidAccountId
+        abort "'#{exception}' is not a valid system or user account ID."
+      when Wavefront::Exception::InvalidRoleId
+        abort "'#{exception}' is not a valid role ID."
+      when Wavefront::Exception::InvalidApiTokenId
+        abort "'#{exception}' is not a valid API token ID."
+      when Wavefront::Exception::InvalidIngestionPolicyId
+        abort "'#{exception}' is not a valid ingestion policy ID."
+      when WavefrontCli::Exception::InvalidValue
+        abort "Invalid value for #{exception}."
+      when WavefrontCli::Exception::ProfileExists
+        abort "Profile '#{exception}' already exists."
+      when WavefrontCli::Exception::ProfileNotFound
+        abort "Profile '#{exception}' not found."
+      when WavefrontCli::Exception::FileNotFound
+        abort 'File not found.'
+      when WavefrontCli::Exception::InsufficientData
+        abort "Insufficient data. #{exception.message}"
+      when WavefrontCli::Exception::InvalidQuery
+        abort "Invalid query. API message: '#{exception.message}'."
+      when WavefrontCli::Exception::SystemError
+        abort "Host system error. #{exception.message}"
+      when WavefrontCli::Exception::UnparseableInput
+        abort "Cannot parse input. #{exception.message}"
+      when WavefrontCli::Exception::UnparseableSearchPattern
+        abort 'Searches require a key, a value, and a match operator.'
+      when WavefrontCli::Exception::UnsupportedFileFormat
+        abort 'Unsupported file format.'
+      when WavefrontCli::Exception::UnsupportedOperation
+        abort "Unsupported operation.\n#{exception.message}"
+      when WavefrontCli::Exception::UnsupportedOutput
+        abort exception.message
+      when WavefrontCli::Exception::UnsupportedNoop
+        abort 'Multiple API call operations cannot be performed as no-ops.'
+      when WavefrontCli::Exception::UserGroupNotFound
+        abort "Cannot find user group '#{exception.message}'."
+      when Wavefront::Exception::UnsupportedWriter
+        abort "Unsupported writer '#{exception.message}'."
+      when WavefrontCli::Exception::UserError
+        abort "User error: #{exception.message}."
+      when WavefrontCli::Exception::ImpossibleSearch
+        abort 'Search on non-existent key. Please use a top-level field.'
+      when Wavefront::Exception::InvalidSamplingValue
+        abort 'Sampling rates must be between 0 and 0.05.'
+      else
+        warn "general error: #{exception}"
+        backtrace_message(exception)
+        abort
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/CyclomaticComplexity
+  end
+end

data/lib/wavefront-cli/helpers/load_file.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require_relative '../exception'
+
+module WavefrontCli
+  module Helper
+    #
+    # 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
+    #
+    class LoadFile
+      attr_reader :path
+
+      def initialize(path)
+        @path = path
+      end
+
+      def load
+        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
+
+      private
+
+      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
+
+      def read_json(io)
+        JSON.parse(io, symbolize_names: true)
+      end
+
+      def read_yaml(io)
+        YAML.safe_load(io, symbolize_names: true)
+      end
+    end
+  end
+end

data/lib/wavefront-cli/output/hcl/base.rb

@@ -92,7 +92,7 @@ module WavefrontHclOutput
     def quote_value(val)
       case val.class.to_s.to_sym
       when :String
-        format('"%<value>s"', value: val.gsub(/\"/, '\"'))
+        format('"%<value>s"', value: val.gsub(/"/, '\"'))
       else
         val
       end

data/lib/wavefront-cli/output/hcl/dashboard.rb

@@ -91,7 +91,7 @@ module WavefrontHclOutput
     end
 
     def quote_value(val)
-      val.gsub!(/\$/, '$$') if v.is_a?(String)
+      val.gsub!(/\$/, '$$') if val.is_a?(String)
       super
     end
   end

data/lib/wavefront-cli/proxy.rb

@@ -7,6 +7,11 @@ module WavefrontCli
   # CLI coverage for the v2 'proxy' API.
   #
   class Proxy < WavefrontCli::Base
+    def do_list
+      options[:all] = true if options[:active]
+      super
+    end
+
     def no_api_response
       %w[do_versions]
     end

data/lib/wavefront-cli/query.rb

@@ -51,20 +51,26 @@ module WavefrontCli
 
     # @return [Hash] options for the SDK query method
     #
-    # rubocop:disable Metrics/AbcSize
     def q_opts
+      basic_q_opts.tap do |o|
+        o[:n] = options[:name]
+        o[:p] = options[:points]
+        o[:view] = 'HISTOGRAM' if options[:histogramview]
+        o[:cached] = false if options[:nocache]
+      end.compact
+    end
+
+    # Every query gets these options. They're modified by q_opts
+    #
+    def basic_q_opts
       { autoEvents: options[:events],
         i: options[:inclusive],
         summarization: options[:summarize] || 'mean',
         listMode: true,
-        strict: true,
+        strict: !options[:nostrict],
         includeObsoleteMetrics: options[:obsolete],
-        sorted: true }.tap do |o|
-          o[:n] = options[:name] if options[:name]
-          o[:p] = options[:points] if options[:points]
-        end
+        sorted: true }
     end
-    # rubocop:enable Metrics/AbcSize
 
     # @return [Integer] start of query window. If one has been
     #   given, that; if not, ten minutes ago