wavefront-cli 4.0.2 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83528e35b66e2a098928edb63b4f62cf4f730153caf886e8d2132dd8ef870340
-  data.tar.gz: 9a6affc13f2b2fc1c41052abbd25dae47c2412a7bd70b39ec84ab8516ee748fa
+  metadata.gz: 48f9a11ef858f502c05d4c4d89080a31267f70d96430e88e44deba5b2f929015
+  data.tar.gz: a1bbc741a8379fb2a5783688a858b8c12b5d020a1501d58478042fc303ca43c3
 SHA512:
-  metadata.gz: 46710487da70d0ea78ec7ba703b608b634a80d8b837b0ac91d0f4b9efad7a36ede6365060eb3f25455f56fbbdfd55b015a92f87c5c684af86e32f77ed00b038e
-  data.tar.gz: d7527a3814e9b2cc8fe1ba1f49fa294122406442e2c5c50ecdafd0f2b6a4a975a2c0c22b74fb01cb5a9379e07977b421d3a526b070714120d2ccfb64f0e59110
+  metadata.gz: 759172c664ff1b81f2e199afceb052a61f31f4c91b7f72ea69ad5e511dc19d7397d9731d7e03269d75b88bd3baa52bfedc3bc289c166a84b590fb71ea9bc7a11
+  data.tar.gz: 5c7a9545f5ea086dce5bc02588ddf678ebad99321e55c68026a9e12ad0645b5a4a0bffcffac155ca238ad79370cd00cf146bd8033780f83dfabe2d7322b6c378

data/HISTORY.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 4.1.0 (27/06/2019)
+* Add `dump` subcommand for all importable object types. Produces
+  JSON or YAML output.
+* Allow batch importing of objects. Works with files produced by
+  `dump` subcommand, or by manually creating a JSON or YAML array of
+  objects. Batch imports are automatically detected by the `import`
+  subcommand.
+
 ## 4.0.2 (20/06/2019)
 * Allow importing of dashboards which have a URL but not an ID.
 

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2017-2018, Sysdef Ltd
+Copyright (c) 2017-2019, Sysdef Ltd
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/README.md

@@ -18,7 +18,7 @@ SDK](https://github.com/snltd/wavefront-sdk) and requires Ruby >=
 2.3. It has no "native extension" dependencies.
 
 For a far more comprehensive overview/tutorial, please read [this
-article](http://sysdef.xyz/post/2017-07-26-wavefront-cli).
+article](https://sysdef.xyz/article/wavefront-cli).
 
 ```
 $ wf --help

data/lib/wavefront-cli/alert.rb

@@ -11,7 +11,7 @@ module WavefrontCli
     include WavefrontCli::Mixin::Acl
 
     def import_fields
-      %w[name condition minutes target severity displayExpression
+      %i[name condition minutes target severity displayExpression
          tags additionalInformation resolveAfterMinutes]
     end
 
@@ -128,8 +128,8 @@ module WavefrontCli
       import_fields.each_with_object({}) { |k, a| a[k.to_sym] = raw[k] }
                    .tap do |ret|
 
-        if raw.key?('resolveAfterMinutes')
-          ret[:resolveMinutes] = raw['resolveAfterMinutes']
+        if raw.key?(:resolveAfterMinutes)
+          ret[:resolveMinutes] = raw[:resolveAfterMinutes]
         end
 
         if raw.key?('customerTagsWithCounts')

data/lib/wavefront-cli/base.rb

@@ -143,9 +143,10 @@ module WavefrontCli
     end
 
     # To allow a user to default to different output formats for
-    # different object, we are able to define a format for each class.
-    # instance, `alertformat` or `agentformat`. This method returns
-    # such a string appropriate for the inheriting class.
+    # different object types, we are able to define a format for
+    # each class.  instance, `alertformat` or `proxyformat`. This
+    # method returns such a symbol appropriate for the inheriting
+    # class.
     #
     # @return [Symbol] name of the option or config-file key which
     #   sets the default output format for this class
@@ -164,25 +165,15 @@ module WavefrontCli
     # @raise WavefrontCli::Exception::UnhandledCommand if the
     #   command does not match a `do_` method.
     #
-    # rubocop:disable Metrics/AbcSize
     def dispatch
+      # Look through each deconstructed method name and see if the
+      # user supplied an option for each component.  Call the first
+      # one that matches. The order will ensure we match
+      # "do_delete_tags" before we match "do_delete".
       #
-      # Take a list of do_ methods, remove the 'do_' from their name,
-      # and break them into arrays of '_' separated words.
-      #
-      m_list = methods.select { |m| m.to_s.start_with?('do_') }.map do |m|
-        m.to_s.split('_')[1..-1]
-      end
-
-      # Sort that array of arrays by length, longest first.  Then look
-      # through each deconstructed method name and see if the user
-      # supplied an option for each component. Call the first one that
-      # matches. The order will ensure we match "do_delete_tags" before
-      # we match "do_delete".
-      #
-      m_list.sort_by(&:length).reverse_each do |m|
-        if m.reject { |w| options[w.to_sym] }.empty?
-          method = (%w[do] + m).join('_')
+      method_word_list.reverse_each do |w_list|
+        if w_list.reject { |w| options[w.to_sym] }.empty?
+          method = name_of_do_method(w_list)
           return display(public_send(method), method)
         end
       end
@@ -193,7 +184,19 @@ module WavefrontCli
 
       raise WavefrontCli::Exception::UnhandledCommand
     end
-    # rubocop:enable Metrics/AbcSize
+
+    def name_of_do_method(word_list)
+      (%w[do] + word_list).join('_')
+    end
+
+    # Take a list of do_ methods, remove the 'do_' from their name,
+    # and break them into arrays of '_' separated words. The array
+    # is sorted by length, longest first.
+    #
+    def method_word_list
+      do_methods = methods.select { |m| m.to_s.start_with?('do_') }
+      do_methods.map { |m| m.to_s.split('_')[1..-1] }.sort_by(&:length)
+    end
 
     # Display a Ruby object as JSON, YAML, or human-readable.  We
     # provide a default method to format human-readable output, but
@@ -208,7 +211,6 @@ module WavefrontCli
     # @param method [String] the name of the method which produced
     #   this output. Used to find a suitable humanize method.
     #
-    # rubocop:disable Metrics/AbcSize
     def display(data, method)
       if no_api_response.include?(method)
         return display_no_api_response(data, method)
@@ -216,18 +218,22 @@ module WavefrontCli
 
       exit if options[:noop]
 
+      check_response_blocks(data)
+      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
+
+    def check_response_blocks(data)
       %i[status response].each do |b|
         abort "no #{b} block in API response" unless data.respond_to?(b)
       end
-
-      unless check_status(data.status)
-        handle_error(method, data.status.code) if format_var == :human
-        display_api_error(data.status)
-      end
-
-      handle_response(data.response, format_var, method)
     end
-    # rubocop:enable Metrics/AbcSize
 
     # Classes can provide methods which give the user information on
     # a given error code. They are named #handle_errcode_xxx, and
@@ -384,24 +390,51 @@ module WavefrontCli
     end
 
     # rubocop:disable Metrics/AbcSize
+    def do_dump
+      items = wf.list(ALL_PAGE_SIZE, :all).response.items
+
+      if options[:format] == 'yaml'
+        ok_exit items.to_yaml
+      elsif options[:format] == 'json'
+        ok_exit items.to_json
+      else
+        abort format("Dump format must be 'json' or 'yaml'. (Tried '%s')",
+                     options[:format])
+      end
+    end
+    # rubocop:enable Metrics/AbcSize
+
     def do_import
       raw = load_file(options[:'<file>'])
-      raw = preprocess_rawfile(raw) if respond_to?(:preprocess_rawfile)
+      errs = 0
 
-      begin
-        prepped = import_to_create(raw)
-      rescue StandardError => e
-        puts e if options[:debug]
-        raise WavefrontCli::Exception::UnparseableInput
+      [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('%-15s %-10s %s',
+             obj[:id] || obj[:url],
+             resp.ok? ? 'IMPORTED' : 'FAILED',
+             resp.status.message)
+    end
+
+    def import_object(raw)
+      raw = preprocess_rawfile(raw) if respond_to?(:preprocess_rawfile)
+      prepped = import_to_create(raw)
+
       if options[:update]
         import_update(raw)
       else
         wf.create(prepped)
       end
     end
-    # rubocop:enable Metrics/AbcSize
 
     def import_update(raw)
       wf.update(raw[:id], raw, false)
@@ -508,8 +541,11 @@ module WavefrontCli
     #
     def import_to_create(raw)
       raw.each_with_object({}) do |(k, v), a|
-        a[k.to_sym] = v unless k == 'id'
+        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

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

@@ -14,6 +14,7 @@ class WavefrontCommandAlert < WavefrontCommandBase
      "history #{CMN} [-o offset] [-L limit] <id>",
      "clone #{CMN} [-v version] <id>",
      "latest #{CMN} <id>",
+     "dump #{CMN}",
      "import #{CMN} [-u] <file>",
      "snooze #{CMN} [-T time] <id>",
      "set #{CMN} <key=value> <id>",

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

@@ -22,6 +22,7 @@ class WavefrontCommandCloudintegration < WavefrontCommandBase
      "undelete #{CMN} <id>",
      "enable #{CMN} <id>",
      "disable #{CMN} <id>",
+     "dump #{CMN}",
      "import #{CMN} [-u] <file>",
      "search #{CMN} [-al] [-o offset] [-L limit] <condition>..."]
   end

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

@@ -6,6 +6,7 @@ class WavefrontCommandDashboard < WavefrontCommandBase
   def _commands
     ["list #{CMN} [-alN] [-O fields] [-o offset] [-L limit]",
      "describe #{CMN} [-v version] <id>",
+     "dump #{CMN}",
      "import #{CMN} [-u] <file>",
      "set #{CMN} <key=value> <id>",
      "delete #{CMN} <id>",

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

@@ -20,6 +20,7 @@ class WavefrontCommandDerivedmetric < WavefrontCommandBase
      "describe #{CMN} [-v version] <id>",
      "create #{CMN} [-d description] [-T tag...] [-b] [-i interval] " \
      '[-r range] <name> <query>',
+     "dump #{CMN}",
      "import #{CMN} [-u] <file>",
      "set #{CMN} <key=value> <id>",
      "delete #{CMN} <id>",

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

@@ -21,6 +21,7 @@ class WavefrontCommandLink < WavefrontCommandBase
      "create #{CMN} [-m regex] [-s regex] [-p str=regex...] <name> " \
      '<description> <template>',
      "delete #{CMN} <id>",
+     "dump #{CMN}",
      "import #{CMN} [-u] <file>",
      "set #{CMN} <key=value> <id>",
      "search #{CMN} [-al] [-o offset] [-L limit] <condition>..."]

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

@@ -14,6 +14,7 @@ class WavefrontCommandNotificant < WavefrontCommandBase
   def _commands
     ["list #{CMN} [-al] [-O fields] [-o offset] [-L limit]",
      "describe #{CMN} <id>",
+     "dump #{CMN}",
      "import #{CMN} [-u] <file>",
      "delete #{CMN} <id>",
      "test #{CMN} <id>",

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

@@ -23,6 +23,7 @@ class WavefrontCommandSavedsearch < WavefrontCommandBase
     ["list #{CMN} [-al] [-O fields] [-o offset] [-L limit]",
      "describe #{CMN} <id>",
      "delete #{CMN} <id>",
+     "dump #{CMN}",
      "import #{CMN} [-u] <file>",
      "search #{CMN} [-al] [-o offset] [-L limit] <condition>..."]
   end

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

@@ -18,6 +18,7 @@ class WavefrontCommandUser < WavefrontCommandBase
      "invite #{CMN} [-m permission...] [-g group...] <id>",
      "set #{CMN} <key=value> <id>",
      "delete #{CMN} <user>...",
+     "dump #{CMN}",
      "import #{CMN} [-u] <file>",
      "groups #{CMN} <id>",
      "join #{CMN} <id> <group>...",

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

@@ -24,6 +24,7 @@ class WavefrontCommandUsergroup < WavefrontCommandBase
      "describe #{CMN} <id>",
      "create #{CMN} [-p permission...] <name>",
      "delete #{CMN} <id>",
+     "dump #{CMN}",
      "import #{CMN} [-u] <file>",
      "set #{CMN} <key=value> <id>",
      "users #{CMN} <id>",

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

@@ -7,6 +7,7 @@ class WavefrontCommandWebhook < WavefrontCommandBase
     ["list #{CMN} [-al] [-O fields] [-o offset] [-L limit]",
      "describe #{CMN} <id>",
      "delete #{CMN} <id>",
+     "dump #{CMN}",
      "import #{CMN} [-u] <file>",
      "set #{CMN} <key=value> <id>",
      "search #{CMN} [-al] [-o offset] [-L limit] <condition>..."]

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

@@ -23,6 +23,7 @@ class WavefrontCommandWindow < WavefrontCommandBase
      "close #{CMN} <id>",
      "extend #{CMN} (by|to) <time> <id>",
      "delete #{CMN} <id>",
+     "dump #{CMN}",
      "import #{CMN} [-u] <file>",
      "set #{CMN} <key=value> <id>",
      "search #{CMN} [-al] [-o offset] [-L limit] <condition>...",

data/lib/wavefront-cli/version.rb

@@ -1 +1 @@
-WF_CLI_VERSION = '4.0.2'.freeze
+WF_CLI_VERSION = '4.1.0'.freeze

data/spec/spec_helper.rb

@@ -430,7 +430,7 @@ class CliMethodTest < MiniTest::Test
   end
 
   def import_tester(word, have_fields, do_not_have_fields = [])
-    input = JSON.parse(IO.read(RES_DIR + 'imports' + "#{word}.json"))
+    input = wf.load_file(RES_DIR + 'imports' + "#{word}.json")
     x = wf.import_to_create(input)
     assert_instance_of(Hash, x)
     have_fields.each { |f| assert_includes(x.keys, f) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-cli
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 4.1.0
 platform: ruby
 authors:
 - Robert Fisher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-20 00:00:00.000000000 Z
+date: 2019-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt