wavefront-cli 4.2.1 → 4.3.0

data/lib/wavefront-cli/apitoken.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 module WavefrontCli

data/lib/wavefront-cli/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 require 'json'
 require 'wavefront-sdk/validators'
@@ -91,7 +93,7 @@ module WavefrontCli
     def validate_input
       validate_id if options[:'<id>']
       validate_tags if options[:'<tag>']
-      send(:extra_validation) if respond_to?(:extra_validation)
+      extra_validation if respond_to?(:extra_validation)
     end
 
     def validate_tags(key = :'<tag>')
@@ -112,7 +114,9 @@ module WavefrontCli
     end
 
     def failed_validation_message(input)
-      format("'%s' is not a valid %s ID.", input, klass_word)
+      format("'%<value>s' is not a valid %<thing>s ID.",
+             value: input,
+             thing: klass_word)
     end
 
     # Make a wavefront-sdk credentials object from standard
@@ -121,9 +125,9 @@ module WavefrontCli
     # @return [Hash] containing `token` and `endpoint`.
     #
     def mk_creds
-      { token:    options[:token],
+      { token: options[:token],
         endpoint: options[:endpoint],
-        agent:    "wavefront-cli-#{WF_CLI_VERSION}" }
+        agent: "wavefront-cli-#{WF_CLI_VERSION}" }
     end
 
     # Make a common wavefront-sdk options object from standard CLI
@@ -133,8 +137,8 @@ module WavefrontCli
     # @return [Hash] containing `debug`, `verbose`, and `noop`.
     #
     def mk_opts
-      ret = { debug:   options[:debug],
-              noop:    options[:noop] }
+      ret = { debug: options[:debug],
+              noop: options[:noop] }
 
       ret[:verbose] = options[:noop] ? true : options[:verbose]
 
@@ -219,12 +223,14 @@ module WavefrontCli
       exit if options[:noop]
 
       check_response_blocks(data)
+      warning_message(data.status)
       status_error_handler(data, method)
       handle_response(data.response, format_var, method)
     end
 
     def status_error_handler(data, method)
       return if check_status(data.status)
+
       handle_error(method, data.status.code) if format_var == :human
       display_api_error(data.status)
     end
@@ -242,7 +248,7 @@ module WavefrontCli
     # @return System exit
     #
     def display_api_error(status)
-      method = format('handle_errcode_%s', status.code).to_sym
+      method = format('handle_errcode_%<code>s', code: status.code).to_sym
 
       msg = if respond_to?(method)
               send(method, status)
@@ -250,8 +256,15 @@ module WavefrontCli
               status.message || 'No further information'
             end
 
-      abort format('ERROR: API code %s. %s.', status.code,
-                   msg.chomp('.')).fold(TW, 7)
+      abort format('ERROR: API code %<code>s. %<message>s.',
+                   code: status.code,
+                   message: msg.chomp('.')).fold(TW, 7)
+    end
+
+    def warning_message(status)
+      return unless status.status.between?(201, 299)
+
+      puts format("API WARNING: '%<message>s'.", message: status.message)
     end
 
     def display_no_api_response(data, method)
@@ -279,20 +292,25 @@ module WavefrontCli
       end
     end
 
-    # rubocop:disable Metrics/AbcSize
-    def parseable_output(format, resp)
+    def parseable_output(output_format, resp)
       options[:class] = klass_word
       options[:hcl_fields] = hcl_fields
-      require_relative File.join('output', format.to_s)
-      oclass = Object.const_get(format('WavefrontOutput::%s',
-                                       format.to_s.capitalize))
-      oclass.new(resp, options).run
+      cli_output_class(output_format).new(resp, options).run
     rescue LoadError
       raise(WavefrontCli::Exception::UnsupportedOutput,
-            format("The '%s' command does not support '%s' output.",
-                   options[:class], format))
+            unsupported_format_message(output_format))
+    end
+
+    def cli_output_class(output_format)
+      require_relative File.join('output', output_format.to_s)
+      Object.const_get(format('WavefrontOutput::%<class>s',
+                              class: output_format.to_s.capitalize))
+    end
+
+    def unsupported_format_message(output_format)
+      format("The '%<command>s' command does not support '%<format>s' output.",
+             command: options[:class], format: output_format)
     end
-    # rubocop:enable Metrics/AbcSize
 
     def hcl_fields
       []
@@ -311,13 +329,12 @@ module WavefrontCli
     #
     def validate_opts
       unless options[:token]
-        raise(WavefrontCli::Exception::CredentialError,
-              'Missing API token.')
+        raise(WavefrontCli::Exception::CredentialError, 'Missing API token.')
       end
 
       return true if options[:endpoint]
-      raise(WavefrontCli::Exception::CredentialError,
-            'Missing API endpoint.')
+
+      raise(WavefrontCli::Exception::CredentialError, 'Missing API endpoint.')
     end
 
     # Give it a path to a file (as a string) and it will return the
@@ -335,18 +352,22 @@ module WavefrontCli
       return load_from_stdin if path == '-'
 
       file = Pathname.new(path)
+      extname = file.extname.downcase
 
       raise WavefrontCli::Exception::FileNotFound unless file.exist?
 
-      extname = file.extname.downcase
+      return load_json(file) if extname == '.json'
+      return load_yaml(file) if %w[.yaml .yml].include?(extname)
 
-      if extname == '.json'
-        JSON.parse(IO.read(file), symbolize_names: true)
-      elsif %w[.yaml .yml].include?(extname)
-        YAML.safe_load(IO.read(file), symbolize_names: true)
-      else
-        raise WavefrontCli::Exception::UnsupportedFileFormat
-      end
+      raise WavefrontCli::Exception::UnsupportedFileFormat
+    end
+
+    def load_json(file)
+      JSON.parse(IO.read(file), symbolize_names: true)
+    end
+
+    def load_yaml(file)
+      YAML.safe_load(IO.read(file), symbolize_names: true)
     end
 
     # Read STDIN and return a Ruby object, assuming that STDIN is
@@ -389,20 +410,33 @@ module WavefrontCli
       wf.describe(options[:'<id>'])
     end
 
-    # rubocop:disable Metrics/AbcSize
     def do_dump
-      items = wf.list(ALL_PAGE_SIZE, :all).response.items
+      cannot_noop!
 
       if options[:format] == 'yaml'
-        ok_exit items.to_yaml
+        ok_exit dump_yaml
       elsif options[:format] == 'json'
-        ok_exit items.to_json
+        ok_exit dump_json
       else
-        abort format("Dump format must be 'json' or 'yaml'. (Tried '%s')",
-                     options[:format])
+        abort format("Dump format must be 'json' or 'yaml'. " \
+                     "(Tried '%<format>s')", options)
       end
     end
-    # rubocop:enable Metrics/AbcSize
+
+    def dump_yaml
+      JSON.parse(item_dump_call.to_json).to_yaml
+    end
+
+    def dump_json
+      item_dump_call.to_json
+    end
+
+    # Broken out into its own method because 'users' does not use
+    # pagination
+    #
+    def item_dump_call
+      wf.list(ALL_PAGE_SIZE, :all).response.items
+    end
 
     def do_import
       raw = load_file(options[:'<file>'])
@@ -411,6 +445,7 @@ module WavefrontCli
       [raw].flatten.each do |obj|
         resp = import_object(obj)
         next if options[:noop]
+
         errs += 1 unless resp.ok?
         puts import_message(obj, resp)
       end
@@ -419,10 +454,10 @@ module WavefrontCli
     end
 
     def import_message(obj, resp)
-      format('%-15s %-10s %s',
-             obj[:id] || obj[:url],
-             resp.ok? ? 'IMPORTED' : 'FAILED',
-             resp.status.message)
+      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)
@@ -456,7 +491,10 @@ module WavefrontCli
     def smart_delete_message(object_type)
       desc = wf.describe(options[:'<id>'])
       word = desc.ok? ? 'Soft' : 'Permanently'
-      format("%s deleting %s '%s'", word, object_type, options[:'<id>'])
+      format("%<soft_or_hard>s deleting %<object>s '%<id>s'",
+             soft_or_hard: word,
+             object: object_type,
+             id: options[:'<id>'])
     end
 
     def do_undelete
@@ -479,17 +517,25 @@ module WavefrontCli
     # If the user has specified --all, override any limit and offset
     # values
     #
+    # rubocop:disable Metrics/MethodLength
     def range_hash
+      offset_key = :offset
+
       if options[:all]
         limit  = :all
         offset = ALL_PAGE_SIZE
+      elsif options[:cursor]
+        offset_key = :cursor
+        limit = options[:limit]
+        offset = options[:cursor]
       else
         limit  = options[:limit]
-        offset = options[:offset] || options[:cursor]
+        offset = options[:offset]
       end
 
-      { limit: limit, offset: offset }
+      { limit: limit, offset_key => offset }
     end
+    # rubocop:enable Metrics/MethodLength
 
     # The search URI pattern doesn't always match the command name,
     # or class name. Override this method if this is the case.
@@ -510,11 +556,11 @@ module WavefrontCli
       end
     end
 
-    # rubocop:disable Metrics/CyclomaticComplexity
-    # rubocop:disable Metrics/MethodLength
     # @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
       when /^\w+~/
@@ -533,8 +579,8 @@ module WavefrontCli
         raise(WavefrontCli::Exception::UnparseableSearchPattern, cond)
       end
     end
-    # rubocop:enable Metrics/CyclomaticComplexity
     # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/CyclomaticComplexity
 
     # Most things will re-import with the POST method if you remove
     # the ID.
@@ -579,6 +625,7 @@ module WavefrontCli
     # @param aggr [Array] values of matched keys
     # @return [Array]
     #
+    # rubocop:disable Metrics/MethodLength
     def extract_values(obj, key, aggr = [])
       if obj.is_a?(Hash)
         obj.each_pair do |k, v|
@@ -594,5 +641,6 @@ module WavefrontCli
 
       aggr
     end
+    # rubocop:enable Metrics/MethodLength
   end
 end

data/lib/wavefront-cli/cloudintegration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 module WavefrontCli
@@ -9,6 +11,10 @@ module WavefrontCli
       Wavefront::Exception::InvalidCloudIntegrationId
     end
 
+    def do_delete
+      smart_delete('cloud integration')
+    end
+
     def do_enable
       wf.enable(options[:'<id>'])
     end

data/lib/wavefront-cli/command_mixins/acl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WavefrontCli
   module Mixin
     #
@@ -9,6 +11,7 @@ module WavefrontCli
       end
 
       def do_acl_clear
+        cannot_noop!
         wf.acl_set(options[:'<id>'], [], [everyone_id])
         do_acls
       end
@@ -66,7 +69,9 @@ module WavefrontCli
       def _acl_action(action)
         entity_type, entities = acl_entities
 
-        resp = send(format('%s_%s', action, entity_type),
+        resp = send(format('%<action>s_%<type>s',
+                           action: action,
+                           type: entity_type),
                     options[:'<id>'],
                     entities)
 

data/lib/wavefront-cli/command_mixins/tag.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WavefrontCli
   module Mixin
     #

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

@@ -1,7 +1,6 @@
 ---
 
-inherit_from: ../../../.rubocop.yml
-
-# Some of these methods are long, but they're just lists
+# There are long things in here, but they're fine
+#
 Metrics/MethodLength:
-  Enabled: false
+  Max: 25

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 # Define the Alert command
@@ -12,7 +14,6 @@ class WavefrontCommandAlert < WavefrontCommandBase
      "clone #{CMN} [-v version] <id>",
      "undelete #{CMN} <id>",
      "history #{CMN} [-o offset] [-L limit] <id>",
-     "clone #{CMN} [-v version] <id>",
      "latest #{CMN} <id>",
      "dump #{CMN}",
      "import #{CMN} [-u] <file>",

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

@@ -1,8 +1,14 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 
 # Define the apitoken command.
 #
 class WavefrontCommandApitoken < WavefrontCommandBase
+  def description
+    "view and your own #{things}"
+  end
+
   def thing
     'API token'
   end

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

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 require_relative '../stdlib/string'
 
-CMN = '[-DnVM] [-c file] [-P profile] [-E endpoint] [-t token] ' \
-      '[-f format]'.freeze
+CMN = '[-DnVM] [-c file] [-P profile] [-E endpoint] [-t token] [-f format]'
 
 # A base class which all command classes extend.
 #
@@ -100,45 +101,53 @@ class WavefrontCommandBase
   #   testing far simpler.
   # @return [String] the subcommands the command offers.
   #
-  #
   def commands(term_width = TW)
-    _commands.flatten.each_with_object("Usage:\n") do |cmd, ret|
-      ret.<< '  ' + "#{CMD} #{word} #{cmd}\n".cmd_fold(term_width) + "\n"
-    end + "  #{CMD} #{word} --help"
+    text_arr = %w[Usage:]
+
+    _commands.flatten.each do |cmd|
+      text_arr.<< '  ' + "#{CMD} #{word} #{cmd}\n".cmd_fold(term_width)
+    end
+
+    text_arr.<< "  #{CMD} #{word} --help"
+    text_arr.join("\n")
   end
 
   # @param term_width [Integer] force a terminal width. Makes
   #   testing far simpler.
   # @return [String] the options the command understands.
   #
-  # rubocop:disable Metrics/AbcSize
   def options(term_width = TW)
     width = option_column_width
-    ret = ''
+    text_arr = if global_options.empty?
+                 []
+               else
+                 global_option_text(width, term_width)
+               end
 
-    unless global_options.empty?
-      ret.<< "Global options:\n"
-      global_options.each { |o| ret.<< opt_row(o, width, term_width) }
-      ret.<< "\n"
-    end
+    text_arr.<< 'Options:'
+    _options.flatten.each { |o| text_arr.<< opt_row(o, width, term_width) }
+    text_arr.join("\n")
+  end
 
-    ret.<< "Options:\n"
-    _options.flatten.each { |o| ret.<< opt_row(o, width, term_width) }
-    ret
+  def global_option_text(width, term_width)
+    text_arr = ['Global options:']
+    global_options.each { |o| text_arr.<< opt_row(o, width, term_width) }
+    text_arr.<< ''
   end
-  # rubocop:enable Metrics/AbcSize
 
   # Formats an option string.
   #
-  # @param opt [String] the option string
+  # @param opt_str [String] the option string
   # @param width [Integer] the width of the short + long options
   #   columns. This is used to indent following lines
   # @param term_width [Integer] the width of the user's terminal
   #
-  def opt_row(opt, width, term_width = TW)
-    format("  %s %-#{width}s %s\n", *opt.split(/\s+/, 3))
-      .opt_fold(term_width, width + 5)
+  # rubocop:disable Style/FormatStringToken
+  def opt_row(opt_str, width, term_width = TW)
+    format("  %s %-#{width}s %s",
+           *opt_str.split(/\s+/, 3)).opt_fold(term_width, width + 5)
   end
+  # rubocop:enable Style/FormatStringToken
 
   # @return [Integer] the width of the column containing short and
   #   long options