wavefront-cli 3.2.0 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8904f27867cfabaaaf9c47132f52a439fa5fdef900745986789c901a0f61ef0
-  data.tar.gz: f30e315802c139c36f53c7d9e462e7b684bac5ab0ddebbead90210edbe317385
+  metadata.gz: 0cbeefd7b752bca0b1a5a3b886219b8ff0df8d6407ac1c3589e21f04faa1df7e
+  data.tar.gz: 36bbb2c1753d13d5911f91c0959af065d250e2d582b503d5731bd067ea1eebc9
 SHA512:
-  metadata.gz: 9fbc2243bf64547d80d6082c1e0c6308dfd1327d112b67897afaf98b715841aed1323bf2aa3394656eb357c17404354c80e315e26d641c30289a2466fc0dce93
-  data.tar.gz: 21808c3a636e72bbcf056fad0572e96d313f2e87823e9c04d88fc5934ac308686f1cb1f7a96306cef81ae61a4a65453228265a1d4eff6636a46d9081485ef6e2
+  metadata.gz: c9a1cb2a6a26f242fb5a992497e4346d4844395d34c74958c03575116a6cdcbe712a4364bb6bf7a23fd8bb73d356b3905e4aa722305e3df228cdf84d28bf4613
+  data.tar.gz: 4f48260461f4222092f383dbd175d90ce4e0a1c58b7ff78260035b106abd14e86e71a6cf98f3d4e3b34bcefd7532db938f8c770fcdbf506f78ef3ca524a9daea

data/HISTORY.md

@@ -1,7 +1,12 @@
 # Changelog
 
+## 3.2.1 (09/05/2019)
+* Fix for new API ACL format.
+* Require 3.3.0 of [the SDK](https://github.com/snltd/wavefront-sdk).
+
 ## 3.2.0 (30/04/2019)
 * New `apitoken` command lets you manage your own API tokens.
+* Support for alert ACLs.
 * Require 3.2.0 of [the SDK](https://github.com/snltd/wavefront-sdk).
 
 ## 3.1.4 (02/05/2019)

data/lib/wavefront-cli/alert.rb

@@ -1,13 +1,18 @@
 require_relative 'base'
+require_relative 'command_mixins/tag'
+require_relative 'command_mixins/acl'
 
 module WavefrontCli
   #
   # CLI coverage for the v2 'alert' API.
   #
   class Alert < WavefrontCli::Base
+    include WavefrontCli::Mixin::Tag
+    include WavefrontCli::Mixin::Acl
+
     def import_fields
       %w[name condition minutes target severity displayExpression
-         tags additionalInformation]
+         tags additionalInformation resolveAfterMinutes]
     end
 
     def do_describe
@@ -22,25 +27,22 @@ module WavefrontCli
       wf.unsnooze(options[:'<id>'])
     end
 
-    # rubocop:disable Metrics/AbcSize
     def do_delete
-      cannot_noop!
-
-      word = if wf.describe(options[:'<id>']).status.code == 200
-               'Soft'
-             else
-               'Permanently'
-             end
+      smart_delete
+    end
 
-      puts "#{word} deleting alert '#{options[:'<id>']}'."
-      wf.delete(options[:'<id>'])
+    def do_clone
+      wf.clone(options[:'<id>'], options[:version]&.to_i)
     end
-    # rubocop:enable Metrics/AbcSize
 
     def do_summary
       wf.summary
     end
 
+    def do_latest
+      wf.versions(options[:'<id>'])
+    end
+
     def do_history
       wf.history(options[:'<id>'], options[:offset], options[:limit])
     end

data/lib/wavefront-cli/base.rb

@@ -394,6 +394,21 @@ module WavefrontCli
       wf.delete(options[:'<id>'])
     end
 
+    # Some objects support soft deleting. To handle that, call this
+    # method from do_delete
+    #
+    def smart_delete(object_type = klass_word)
+      cannot_noop!
+      puts smart_delete_message(object_type)
+      wf.delete(options[:'<id>'])
+    end
+
+    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>'])
+    end
+
     def do_undelete
       wf.undelete(options[:'<id>'])
     end
@@ -445,26 +460,6 @@ module WavefrontCli
       end
     end
 
-    def do_tags
-      wf.tags(options[:'<id>'])
-    end
-
-    def do_tag_add
-      wf.tag_add(options[:'<id>'], options[:'<tag>'].first)
-    end
-
-    def do_tag_delete
-      wf.tag_delete(options[:'<id>'], options[:'<tag>'].first)
-    end
-
-    def do_tag_set
-      wf.tag_set(options[:'<id>'], options[:'<tag>'])
-    end
-
-    def do_tag_clear
-      wf.tag_set(options[:'<id>'], [])
-    end
-
     # Most things will re-import with the POST method if you remove
     # the ID.
     #

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

@@ -0,0 +1,84 @@
+module WavefrontCli
+  module Mixin
+    #
+    # Standard ACL commands. Mix this module in to get ACL support.
+    #
+    module Acl
+      def do_acls
+        wf.acls([options[:'<id>']])
+      end
+
+      def do_acl_clear
+        wf.acl_set(options[:'<id>'], [], [everyone_id])
+        do_acls
+      end
+
+      def do_acl_grant
+        return grant_view if options[:view]
+        return grant_modify if options[:modify]
+
+        raise WavefrontCli::Exception::InsufficientData
+      end
+
+      def do_acl_revoke
+        return revoke_view if options[:view]
+        return revoke_modify if options[:modify]
+
+        raise WavefrontCli::Exception::InsufficientData
+      end
+
+      # @return [String] UUID of 'Everyone' group
+      # @raise WavefrontCli::Exception::UserGroupNotFound if group
+      #   does not exist. This is caught in the controller.
+      #
+      def everyone_id
+        require 'wavefront-sdk/search'
+        wfs = Wavefront::Search.new(mk_creds, mk_opts)
+        query = conds_to_query(['name=Everyone'])
+        wfs.search(:usergroup, query).response.items.first.id
+      rescue RuntimeError
+        raise WavefrontCli::Exception::UserGroupNotFound, 'Everyone'
+      end
+
+      def grant_modify
+        wf.acl_add(options[:'<id>'], [], options[:'<name>'])
+        do_acls
+      end
+
+      def grant_view
+        wf.acl_add(options[:'<id>'], options[:'<name>'], [])
+        do_acls
+      end
+
+      def revoke_view
+        wf.acl_delete(options[:'<id>'], options[:'<name>'], [])
+        do_acls
+      end
+
+      def revoke_modify
+        wf.acl_delete(options[:'<id>'], [], options[:'<name>'])
+        do_acls
+      end
+
+      # @param action [Symbol] :grant_to or :revoke_from
+      # @return [Wavefront::Response]
+      #
+      def _acl_action(action)
+        entity_type, entities = acl_entities
+
+        resp = send(format('%s_%s', action, entity_type),
+                    options[:'<id>'],
+                    entities)
+
+        print_status(resp.status)
+        do_acls
+      end
+
+      def print_status(status)
+        puts status.message unless status.message.empty?
+      rescue NoMethodError
+        nil
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module WavefrontCli
+  module Mixin
+    #
+    # Standard tag commands
+    #
+    module Tag
+      def do_tags
+        wf.tags(options[:'<id>'])
+      end
+
+      def do_tag_add
+        wf.tag_add(options[:'<id>'], options[:'<tag>'].first)
+      end
+
+      def do_tag_delete
+        wf.tag_delete(options[:'<id>'], options[:'<tag>'].first)
+      end
+
+      def do_tag_set
+        wf.tag_set(options[:'<id>'], options[:'<tag>'])
+      end
+
+      def do_tag_clear
+        wf.tag_set(options[:'<id>'], [])
+      end
+    end
+  end
+end

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

@@ -13,8 +13,11 @@ class WavefrontCommandAlert < WavefrontCommandBase
      "snoozed #{CMN} [-o offset] [-L limit]",
      "describe #{CMN} [-v version] <id>",
      "delete #{CMN} <id>",
+     "clone #{CMN} [-v version] <id>",
      "undelete #{CMN} <id>",
      "history #{CMN} [-o offset] [-L limit] <id>",
+     "clone #{CMN} [-v version] <id>",
+     "latest #{CMN} <id>",
      "import #{CMN} <file>",
      "snooze #{CMN} [-T time] <id>",
      "update #{CMN} <key=value> <id>",
@@ -29,6 +32,7 @@ class WavefrontCommandAlert < WavefrontCommandBase
      "queries #{CMN} [-b] [<id>]",
      "install #{CMN} <id>",
      "uninstall #{CMN} <id>",
+     acl_commands,
      "summary #{CMN} [-a]"]
   end
 

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

@@ -50,10 +50,8 @@ class WavefrontCommandBase
   def acl_commands
     ["acls #{CMN} <id>",
      "acl #{CMN} clear <id>",
-     "acl #{CMN} grant (view | modify) on <id> to " \
-     '(user | group) <name>...',
-     "acl #{CMN} revoke (view | modify) on <id> from " \
-     '(user | group) <name>...']
+     "acl #{CMN} grant (view | modify) on <id> to <name>...",
+     "acl #{CMN} revoke (view | modify) on <id> from <name>..."]
   end
 
   # Inheriting classes must override this method

data/lib/wavefront-cli/controller.rb

@@ -142,8 +142,7 @@ class WavefrontCliController
     abort "Unsupported writer '#{e.message}'."
   rescue StandardError => e
     warn "general error: #{e}"
-    warn "re-run with '-D' for stack trace." unless opts[:debug]
-    warn "Backtrace:\n\t#{e.backtrace.join("\n\t")}" if opts[:debug]
+    warn "Backtrace:\n\t#{e.backtrace.join("\n\t")}"
     abort
   end
   # rubocop:enable Metrics/MethodLength

data/lib/wavefront-cli/dashboard.rb

@@ -1,10 +1,15 @@
 require_relative 'base'
+require_relative 'command_mixins/tag'
+require_relative 'command_mixins/acl'
 
 module WavefrontCli
   #
   # CLI coverage for the v2 'dashboard' API.
   #
   class Dashboard < WavefrontCli::Base
+    include WavefrontCli::Mixin::Tag
+    include WavefrontCli::Mixin::Acl
+
     def list_filter(list)
       return list unless options[:nosystem]
       list.tap { |l| l.response.items.delete_if { |d| d[:systemOwned] } }
@@ -14,20 +19,9 @@ module WavefrontCli
       wf.describe(options[:'<id>'], options[:version])
     end
 
-    # rubocop:disable Metrics/AbcSize
     def do_delete
-      cannot_noop!
-
-      word = if wf.describe(options[:'<id>']).status.code == 200
-               'Soft'
-             else
-               'Permanently'
-             end
-
-      puts "#{word} deleting dashboard '#{options[:'<id>']}'."
-      wf.delete(options[:'<id>'])
+      smart_delete
     end
-    # rubocop:enable Metrics/AbcSize
 
     def do_history
       wf.history(options[:'<id>'])
@@ -59,136 +53,5 @@ module WavefrontCli
       wf.unfavorite(options[:'<id>'])
       do_favs
     end
-
-    def do_acls
-      wf.acls([options[:'<id>']])
-    end
-
-    def do_acl_clear
-      wf.acl_set(options[:'<id>'], [], [id: everyone_id, name: 'Everyone'])
-      do_acls
-    end
-
-    def do_acl_grant
-      acl_action(:grant_to)
-    end
-
-    def do_acl_revoke
-      acl_action(:revoke_from)
-    end
-
-    # Based on command-line options, return an array describing the
-    # users or groups (entities) which will be granted or revoked a
-    # privilege.
-    # @return [Array] [type_of_entity, [Hash]...]
-    #
-    def acl_entities
-      acl_type = options[:modify] ? :modify : :view
-
-      if options[:user]
-        [:users, user_lists(acl_type, options[:'<name>'])]
-      else
-        [:groups, group_lists(acl_type, options[:'<name>'])]
-      end
-    end
-
-    # Make a list of users to be given to the SDK ACL methods. Users
-    # are defined as a Hash, with keys :id and :name.
-    # @param acl_type [Symbol] :view or :modify
-    # @param users [Array] user names
-    # @return [Array[Hash]]
-    #
-    def user_lists(acl_type, users)
-      { view: [], modify: [] }.tap do |l|
-        l[acl_type] = users.map { |u| { id: u, name: u } }
-      end
-    end
-
-    # Generate arrays ready for passing to the SDK acl methods
-    # @return see #user_lists, but name and id are not the same.
-    #
-    def group_lists(acl_type, groups)
-      { view: [], modify: [] }.tap do |l|
-        l[acl_type] = groups.each_with_object([]) do |g, a|
-          name = group_name(g)
-
-          if name.nil?
-            puts "Cannot find group with id '#{g}'."
-            next
-          end
-
-          a.<< ({ id: g, name: name })
-        end
-      end
-    end
-
-    private
-
-    # When given an ACL action (grant or revoke), call the right
-    # method with the right arguments.
-    # @param action [Symbol] :grant_to or :revoke_from
-    # @return [Wavefront::Response]
-    #
-    def acl_action(action)
-      entity_type, entities = acl_entities
-
-      resp = send(format('%s_%s', action, entity_type),
-                  options[:'<id>'],
-                  entities)
-
-      print_status(resp.status)
-      do_acls
-    end
-
-    # The #grant_to_ and #revoke_from_ methods are called by
-    # #acl_action, and speak to the SDK. They all return a
-    # Wavefront::Response object.
-    #
-    def grant_to_users(id, lists)
-      wf.acl_add(id, lists[:view], lists[:modify])
-    end
-
-    def revoke_from_users(id, lists)
-      wf.acl_delete(id, lists[:view], lists[:modify])
-    end
-
-    def grant_to_groups(id, lists)
-      wf.acl_add(id, lists[:view], lists[:modify])
-    end
-
-    def revoke_from_groups(id, lists)
-      wf.acl_delete(id, lists[:view], lists[:modify])
-    end
-
-    def print_status(status)
-      puts status.message unless status.message.empty?
-    rescue NoMethodError
-      nil
-    end
-
-    # Get the name of a user group, given the ID.
-    # @param group_id [String] UUID of a group
-    # @return [String, Nil] name of group, nil if it does not exist
-    #
-    def group_name(group_id)
-      require 'wavefront-sdk/usergroup'
-      wfs = Wavefront::UserGroup.new(mk_creds, mk_opts)
-      wfs.describe(group_id).response.name
-    rescue RuntimeError
-      nil
-    end
-
-    # @return [String] UUID of 'Everyone' group
-    # @raise WavefrontCli::Exception::UserGroupNotFound if group
-    #   does not exist. This is caught in the controller.
-    #
-    def everyone_id
-      require 'wavefront-sdk/search'
-      wfs = Wavefront::Search.new(mk_creds, mk_opts)
-      query = conds_to_query(['name=Everyone'])
-      wfs.search(:usergroup, query).response.items.first.id
-    rescue RuntimeError
-      raise WavefrontCli::Exception::UserGroupNotFound, 'Everyone'
-    end
   end
 end

data/lib/wavefront-cli/derivedmetric.rb

@@ -1,10 +1,13 @@
 require_relative 'base'
+require_relative 'command_mixins/tag'
 
 module WavefrontCli
   #
   # CLI coverage for the v2 'derivedmetric' API.
   #
   class DerivedMetric < WavefrontCli::Base
+    include WavefrontCli::Mixin::Tag
+
     def validator_exception
       Wavefront::Exception::InvalidDerivedMetricId
     end
@@ -13,22 +16,9 @@ module WavefrontCli
       wf.describe(options[:'<id>'], options[:version])
     end
 
-    # rubocop:disable Metrics/AbcSize
     def do_delete
-      cannot_noop!
-
-      word = if wf.describe(options[:'<id>']).status.code == 200
-               'Soft'
-             else
-               'Permanently'
-             end
-
-      puts format('%s deleting derived metric definition %s', word,
-                  options[:'<id>'])
-
-      wf.delete(options[:'<id>'])
+      smart_delete('derived metric')
     end
-    # rubocop:enable Metrics/AbcSize
 
     def do_history
       wf.history(options[:'<id>'])

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

@@ -48,6 +48,10 @@ module WavefrontDisplay
       puts "Unsnoozed alert '#{options[:'<id>']}'."
     end
 
+    def do_latest
+      puts data.max
+    end
+
     # rubocop:disable Metrics/AbcSize
     def do_summary
       kw = data.keys.map(&:size).max + 2
@@ -63,5 +67,9 @@ module WavefrontDisplay
         multicolumn(:id, :condition)
       end
     end
+
+    def do_version
+      puts data.max
+    end
   end
 end

data/lib/wavefront-cli/event.rb

@@ -2,6 +2,7 @@ require 'fileutils'
 require 'open3'
 require 'wavefront-sdk/support/mixins'
 require_relative 'base'
+require_relative 'command_mixins/tag'
 
 EVENT_STATE_DIR = Pathname.new('/var/tmp/wavefront')
 
@@ -12,6 +13,7 @@ module WavefrontCli
   class Event < Base
     attr_reader :state_dir
     include Wavefront::Mixins
+    include WavefrontCli::Mixin::Tag
 
     def post_initialize(_options)
       @state_dir = EVENT_STATE_DIR + (Etc.getlogin || 'notty')

data/lib/wavefront-cli/source.rb

@@ -1,10 +1,13 @@
 require_relative 'base'
+require_relative 'command_mixins/tag'
 
 module WavefrontCli
   #
   # CLI coverage for the v2 'source' API.
   #
   class Source < WavefrontCli::Base
+    include WavefrontCli::Mixin::Tag
+
     def do_list
       wf.list(options[:limit], options[:cursor])
     end

data/lib/wavefront-cli/version.rb

@@ -1 +1 @@
-WF_CLI_VERSION = '3.2.0'.freeze
+WF_CLI_VERSION = '3.2.1'.freeze

data/spec/.rubocop.yml

@@ -10,7 +10,7 @@ Metrics/BlockLength:
   Max: 120
 
 Metrics/MethodLength:
-  Max: 80
+  Max: 100
 
 Metrics/AbcSize:
   Max: 45

data/spec/spec_helper.rb

@@ -64,6 +64,8 @@ class DummyResponse
   def empty?
     false
   end
+
+  def status; end
 end
 
 CANNED_RESPONSE = DummyResponse.new
@@ -75,9 +77,11 @@ CANNED_RESPONSE = DummyResponse.new
 # @param cmd [String] command line args to supply to the Wavefront
 #  command
 # @param call [Hash]
+# @param spies [Array[Hash]] array of spies to set up, for stubbing
+#   methods in any class. Hash has keys :class, :method, :return.
 # rubocop:disable Metrics/AbcSize
 # rubocop:disable Metrics/PerceivedComplexity
-def cmd_to_call(word, args, call, sdk_class = nil, extra_method = nil)
+def cmd_to_call(word, args, call, sdk_class = nil, spies = [])
   headers = { 'Accept':          /.*/,
               'Accept-Encoding': /.*/,
               'Authorization':  'Bearer 0123456789-ABCDEF',
@@ -115,16 +119,10 @@ def cmd_to_call(word, args, call, sdk_class = nil, extra_method = nil)
           end
 
           require "wavefront-sdk/#{sdk_class.name.split('::').last.downcase}"
-          # This lets us mock out methods which happen after the
-          # thing we're interested in. For instance when you
-          # favourite a dashboard, the CLI calls do_favs to display
-          # the new favourite list, sending another API call, which
-          # has been tested elsewhere.
-          #
-          if extra_method
+          spies.each do |spy|
             Spy.on_instance_method(
-              Object.const_get(extra_method.first), extra_method.last
-            ).and_return(true)
+              Object.const_get(spy[:class]), spy[:method]
+            ).and_return(spy[:return])
           end
 
           Spy.on_instance_method(
@@ -315,11 +313,75 @@ def tag_tests(cmd, id, bad_id, pth = nil, klass = nil)
                      "tag delete #{id} #{BAD_TAG}"])
 end
 
+def acl_tests(cmd, id, bad_id, pth = nil, klass = nil)
+  gid1 = '2659191e-aad4-4302-a94e-9667e1517127'
+  pth ||= cmd
+
+  cmd_to_call(cmd, "acls #{id}", { path: "/api/v2/#{pth}/acl?id=#{id}" },
+              klass)
+
+  spies = [{ class:  "WavefrontCli::#{cmd.capitalize}",
+             method: :do_acls,
+             return: true }]
+
+  cmd_to_call(cmd, "acl clear #{id}",
+              { method:  :put,
+                path:    "/api/v2/#{pth}/acl/set",
+                body:    [{ entityId:  id,
+                            viewAcl:   [],
+                            modifyAcl: %w[abcd-1234] }].to_json,
+                headers: JSON_POST_HEADERS }, klass, [
+                  { class:  "WavefrontCli::#{cmd.capitalize}",
+                    method: :everyone_id,
+                    return: 'abcd-1234' },
+                  { class:  "WavefrontCli::#{cmd.capitalize}",
+                    method: :do_acls,
+                    return: true }
+                ])
+
+  cmd_to_call(cmd, "acl grant view on #{id} to testuser1 testuser2",
+              { method:  :post,
+                path:    "/api/v2/#{pth}/acl/add",
+                body:    [{ entityId:  id,
+                            viewAcl:   %w[testuser1 testuser2],
+                            modifyAcl: [] }].to_json,
+                headers: JSON_POST_HEADERS }, klass, spies)
+  cmd_to_call(cmd, "acl revoke view on #{id} from testuser1",
+              { method:  :post,
+                path:    "/api/v2/#{pth}/acl/remove",
+                body:    [{ entityId:  id,
+                            viewAcl:   %w[testuser1],
+                            modifyAcl: [] }].to_json,
+                headers: JSON_POST_HEADERS }, klass, spies)
+
+  cmd_to_call(cmd, "acl grant modify on #{id} to testuser1",
+              { method:  :post,
+                path:    "/api/v2/#{pth}/acl/add",
+                body:    [{ entityId:  id,
+                            viewAcl:   [],
+                            modifyAcl: %w[testuser1] }].to_json,
+                headers: JSON_POST_HEADERS }, klass, spies)
+  cmd_to_call(cmd, "acl revoke modify on #{id} from testuser1",
+              { method:  :post,
+                path:    "/api/v2/#{pth}/acl/remove",
+                body:    [{ entityId:  id,
+                            viewAcl:   [],
+                            modifyAcl: %w[testuser1] }].to_json,
+                headers: JSON_POST_HEADERS }, klass, spies)
+
+  invalid_ids(cmd, ["acls #{bad_id}",
+                    "acl clear #{bad_id}",
+                    "acl grant modify on #{bad_id} to testuser1",
+                    "acl revoke view on #{bad_id} from #{gid1}"])
+end
+
+# Unit tests
+#
 class CliMethodTest < MiniTest::Test
   attr_reader :wf
 
   def setup
-    @wf = CliClass.new({})
+    @wf = cliclass.new({})
   end
 
   def import_tester(word, have_fields, do_not_have_fields = [])

data/spec/wavefront-cli/alert_spec.rb

@@ -19,16 +19,29 @@ require_relative '../spec_helper'
 require_relative "../../lib/wavefront-cli/#{word}"
 
 describe "#{word} command" do
-  missing_creds(word, ['list', "describe #{id}", "snooze #{id}",
-                       'queries', 'snoozed', "install #{id}",
-                       "uninstall #{id}", 'firing',
-                       'currently firing', 'summary',
-                       "delete #{id}", "undelete #{id}", "history #{id}"])
+  missing_creds(word, ['list',
+                       "describe #{id}",
+                       "snooze #{id}",
+                       'queries',
+                       'snoozed',
+                       "clone #{id}",
+                       "install #{id}",
+                       "uninstall #{id}",
+                       'firing',
+                       'currently firing',
+                       'summary',
+                       "acls #{id}",
+                       "acl grant view on #{id} to testuser1",
+                       "acl revoke modify on #{id} from group1",
+                       "delete #{id}",
+                       "undelete #{id}",
+                       "history #{id}"])
   list_tests(word)
   cmd_to_call(word, "describe #{id}", path: "/api/v2/#{word}/#{id}")
   cmd_to_call(word, "describe -v 7 #{id}",
               path: "/api/v2/#{word}/#{id}/history/7")
   cmd_to_call(word, "history #{id}", path: "/api/v2/#{word}/#{id}/history")
+  cmd_to_call(word, "latest #{id}", path: "/api/v2/#{word}/#{id}/history")
 
   it 'deletes with a check on inTrash' do
     stub_request(:get,
@@ -43,6 +56,12 @@ describe "#{word} command" do
                 method: :delete, path: "/api/v2/#{word}/#{id}")
   end
 
+  cmd_to_call(word, "clone #{id}",
+              method: :post, path: "/api/v2/#{word}/#{id}/clone")
+  cmd_to_call(word, "clone #{id} -v 5",
+              method: :post,
+              path: "/api/v2/#{word}/#{id}/clone",
+              body: { id: id, v: 5, name: nil })
   cmd_to_call(word, "undelete #{id}",
               method: :post, path: "/api/v2/#{word}/#{id}/undelete")
   cmd_to_call(word, "snooze #{id}",
@@ -90,15 +109,18 @@ describe "#{word} command" do
   tag_tests(word, id, bad_id)
   noop_tests(word, id, true)
   test_list_output(word)
+  acl_tests(word, id, bad_id)
 end
 
-CliClass = WavefrontCli::Alert
-
 class TestAlertMethods < CliMethodTest
   def test_import_method
     import_tester(:window,
-                  %i[startTimeInSeconds endTimeInSeconds
-                     relevantCustomerTags title relevantHostTags],
+                  %i[condition displayExpression resolveAfterMinutes
+                     minutes severity tags target name],
                   %i[id])
   end
+
+  def cliclass
+    WavefrontCli::Alert
+  end
 end

data/spec/wavefront-cli/config_spec.rb

@@ -85,59 +85,97 @@ class WavefrontCliConfigTest < MiniTest::Test
     input_list = %w[2501b9c3-61e3-4f07-bee2-250aa06a9cab
                     test.wavefront.com myproxy json]
 
-    x = wfo.stub(:read_input, proc { input_list.shift }) do
-      wfo.create_profile('prof')
+    out, err = capture_io do
+      x = wfo.stub(:read_input, proc { input_list.shift }) do
+        wfo.create_profile('prof')
+      end
+
+      assert_instance_of(IniFile, x)
+      assert_equal('2501b9c3-61e3-4f07-bee2-250aa06a9cab',
+                   x[:prof]['token'])
+      assert_equal('test.wavefront.com', x[:prof]['endpoint'])
+      assert_equal('myproxy', x[:prof]['proxy'])
+      assert_equal('json', x[:prof]['format'])
     end
 
-    assert_instance_of(IniFile, x)
-    assert_equal('2501b9c3-61e3-4f07-bee2-250aa06a9cab', x[:prof]['token'])
-    assert_equal('test.wavefront.com', x[:prof]['endpoint'])
-    assert_equal('myproxy', x[:prof]['proxy'])
-    assert_equal('json', x[:prof]['format'])
+    assert_match(/Creating profile 'prof'./, out)
+    assert_match(/Wavefront API token/, out)
+    assert_match(/Wavefront API endpoint/, out)
+    assert_match(/Wavefront proxy endpoint/, out)
+    assert_match(/default output format/, out)
+    assert_empty(err)
   end
 
   def test_create_profile_2
     input_list = ['2501b9c3-61e3-4f07-bee2-250aa06a9cab', '', '', '']
 
-    x = wfo.stub(:read_input, proc { input_list.shift }) do
-      wfo.create_profile('prof')
+    out, err = capture_io do
+      x = wfo.stub(:read_input, proc { input_list.shift }) do
+        wfo.create_profile('prof')
+      end
+
+      assert_instance_of(IniFile, x)
+      assert_equal('2501b9c3-61e3-4f07-bee2-250aa06a9cab',
+                   x[:prof]['token'])
+      assert_equal('metrics.wavefront.com', x[:prof]['endpoint'])
+      assert_equal('wavefront', x[:prof]['proxy'])
+      assert_equal('human', x[:prof]['format'])
     end
 
-    assert_instance_of(IniFile, x)
-    assert_equal('2501b9c3-61e3-4f07-bee2-250aa06a9cab', x[:prof]['token'])
-    assert_equal('metrics.wavefront.com', x[:prof]['endpoint'])
-    assert_equal('wavefront', x[:prof]['proxy'])
-    assert_equal('human', x[:prof]['format'])
+    assert_match(/Creating profile 'prof'./, out)
+    assert_match(/Wavefront API token/, out)
+    assert_match(/Wavefront API endpoint/, out)
+    assert_match(/Wavefront proxy endpoint/, out)
+    assert_match(/default output format/, out)
+    assert_empty(err)
   end
 
   def test_create_profile_3
     input_list = ['X501b9c3-61e3-4f07-bee2-250aa06a9cab', '', '', '']
 
-    assert_raises(WavefrontCli::Exception::InvalidValue) do
-      wfo.stub(:read_input, proc { input_list.shift }) do
-        wfo.create_profile('prof')
+    out, err = capture_io do
+      assert_raises(WavefrontCli::Exception::InvalidValue) do
+        wfo.stub(:read_input, proc { input_list.shift }) do
+          wfo.create_profile('prof')
+        end
       end
     end
+
+    assert_match(/Creating profile 'prof'./, out)
+    assert_match(/Wavefront API token/, out)
+    assert_empty(err)
   end
 
   def test_create_profile_4
     input_list = ['2501b9c3-61e3-4f07-bee2-250aa06a9cab', 'end', '', '']
 
-    assert_raises(WavefrontCli::Exception::InvalidValue) do
-      wfo.stub(:read_input, proc { input_list.shift }) do
-        wfo.create_profile('prof')
+    out, err = capture_io do
+      assert_raises(WavefrontCli::Exception::InvalidValue) do
+        wfo.stub(:read_input, proc { input_list.shift }) do
+          wfo.create_profile('prof')
+        end
       end
     end
+
+    assert_match(/Creating profile 'prof'./, out)
+    assert_match(/Wavefront API token/, out)
+    assert_empty(err)
   end
 
   def test_create_profile_5
     input_list = ['', '', '', '']
 
-    assert_raises(WavefrontCli::Exception::MandatoryValue) do
-      wfo.stub(:read_input, proc { input_list.shift }) do
-        wfo.create_profile('prof')
+    out, err = capture_io do
+      assert_raises(WavefrontCli::Exception::MandatoryValue) do
+        wfo.stub(:read_input, proc { input_list.shift }) do
+          wfo.create_profile('prof')
+        end
       end
     end
+
+    assert_match(/Creating profile 'prof'./, out)
+    assert_match(/Wavefront API token/, out)
+    assert_empty(err)
   end
 
   def test_do_setup; end

data/spec/wavefront-cli/controller_spec.rb

@@ -7,7 +7,7 @@ require_relative '../../lib/wavefront-cli/controller'
 #
 class WavefrontCliHelpTest < MiniTest::Test
   def test_no_args
-    WavefrontCliController.new([])
+    capture_io { WavefrontCliController.new([]) }
   rescue SystemExit => e
     assert_equal(1, e.status)
     assert_match(/^Usage/, e.message)
@@ -16,14 +16,14 @@ class WavefrontCliHelpTest < MiniTest::Test
   end
 
   def test_version
-    WavefrontCliController.new(%w[--version])
+    capture_io { WavefrontCliController.new(%w[--version]) }
   rescue SystemExit => e
     assert_equal(1, e.status)
     assert_match(/^\d+\.\d+\.\d+$/, e.message)
   end
 
   def test_help
-    WavefrontCliController.new(%w[--help])
+    capture_io { WavefrontCliController.new(%w[--help]) }
   rescue SystemExit => e
     assert_equal(1, e.status)
     assert_match(/^Commands:$/, e.message)
@@ -33,7 +33,7 @@ class WavefrontCliHelpTest < MiniTest::Test
   def test_command_help
     CMDS.each do |cmd|
       begin
-        WavefrontCliController.new([cmd, '--help'])
+        capture_io { WavefrontCliController.new([cmd, '--help']) }
       rescue SystemExit => e
         assert(e.message.split("\n").map(&:size).max <= TW)
         assert_equal(1, e.status)
@@ -46,15 +46,19 @@ class WavefrontCliHelpTest < MiniTest::Test
   end
 
   def test_malformed_config
-    WavefrontCliController.new(['alert', 'list',
-                                "--config=#{RES_DIR}/malformed.conf"])
+    capture_io do
+      WavefrontCliController.new(['alert', 'list',
+                                  "--config=#{RES_DIR}/malformed.conf"])
+    end
   rescue SystemExit => e
     assert_equal(1, e.status)
     assert e.message.start_with?('Could not load configuration file')
   end
 
   def test_missing_config
-    WavefrontCliController.new(%w[alert list --config=/no/such/file])
+    capture_io do
+      WavefrontCliController.new(%w[alert list --config=/no/such/file])
+    end
   rescue SystemExit => e
     assert_equal(1, e.status)
     assert_equal("Configuration file '/no/such/file' not found.", e.message)

data/spec/wavefront-cli/dashboard_spec.rb

@@ -7,28 +7,6 @@ word = 'dashboard'
 require_relative '../spec_helper'
 require_relative "../../lib/wavefront-cli/#{word}"
 
-# Method tests. CLI tests follow
-#
-class WavefrontCliDashboardTest < MiniTest::Test
-  attr_reader :wf
-
-  def setup
-    @wf = WavefrontCli::Dashboard.new({})
-  end
-
-  def test_user_lists
-    assert_equal({ modify: [],
-                   view: [{ name: 'a@bc.com', id: 'a@bc.com' },
-                          { name: 'x@yz.com', id: 'x@yz.com' }] },
-                 wf.user_lists(:view, %w[a@bc.com x@yz.com]))
-
-    assert_equal({ view: [],
-                   modify: [{ name: 'a@bc.com', id: 'a@bc.com' },
-                            { name: 'x@yz.com', id: 'x@yz.com' }] },
-                 wf.user_lists(:modify, %w[a@bc.com x@yz.com]))
-  end
-end
-
 describe "#{word} command" do
   missing_creds(word, ['list', "describe #{id}", "delete #{id}",
                        "undelete #{id}", "history #{id}"])
@@ -73,30 +51,38 @@ describe "#{word} command" do
                         sort:   { field:     'id',
                                   ascending: true } }.to_json)
 
+  spies = [{ class:  'WavefrontCli::Dashboard',
+             method: :do_favs,
+             return: nil }]
+
   cmd_to_call(word,
               "fav #{id}",
               { method: :post,
                 path:   "/api/v2/#{word}/#{id}/favorite" },
               nil,
-              ['WavefrontCli::Dashboard', :do_favs])
+              spies)
 
   cmd_to_call(word,
               "unfav #{id}",
               { method: :post,
                 path:   "/api/v2/#{word}/#{id}/unfavorite" },
               nil,
-              ['WavefrontCli::Dashboard', :do_favs])
+              spies)
+
   cmd_to_call(word, "undelete #{id}",
               method: :post, path: "/api/v2/#{word}/#{id}/undelete")
   invalid_ids(word, ["describe #{bad_id}", "delete #{bad_id}",
                      "undelete #{bad_id}"])
   tag_tests(word, id, bad_id)
   test_list_output(word)
+  acl_tests(word, id, bad_id)
 end
 
-CliClass = WavefrontCli::Dashboard
-
 class TestAlertMethods < CliMethodTest
+  def cliclass
+    WavefrontCli::Dashboard
+  end
+
   def test_import_method
     import_tester(:dashboard,
                   %i[description name parameters tags url creatorId

data/spec/wavefront-cli/derivedmetric_spec.rb

@@ -80,12 +80,14 @@ describe "#{word} command" do
   test_list_output(word, k)
 end
 
-CliClass = WavefrontCli::DerivedMetric
-
 class TestDerivedMetricMethods < CliMethodTest
   def test_import_method
     import_tester(:derivedmetric,
                   %i[tags minutes name query metricsUsed hostsUsed],
                   %i[id])
   end
+
+  def cliclass
+    WavefrontCli::DerivedMetric
+  end
 end

data/spec/wavefront-cli/maintenancewindow_spec.rb

@@ -37,9 +37,11 @@ describe "#{word} command" do
   test_list_output(word, k)
 end
 
-CliClass = WavefrontCli::MaintenanceWindow
-
 class TestMaintenanceWindowMethods < CliMethodTest
+  def cliclass
+    WavefrontCli::MaintenanceWindow
+  end
+
   def test_import_method
     import_tester(:window,
                   %i[startTimeInSeconds endTimeInSeconds

data/spec/wavefront-cli/notificant_spec.rb

@@ -34,12 +34,14 @@ describe "#{word} command" do
   test_list_output(word)
 end
 
-CliClass = WavefrontCli::Notificant
-
 class TestNotificantMethods < CliMethodTest
   def test_import_method
     import_tester(:notificant,
                   %i[method title creatorId triggers template],
                   %i[id])
   end
+
+  def cliclass
+    WavefrontCli::Notificant
+  end
 end

data/spec/wavefront-cli/opt_handler_spec.rb

@@ -20,7 +20,7 @@ class OptHandlerTest < MiniTest::Test
   end
 
   def test_missing_config
-    WavefrontCli::OptHandler.new(config: '/no/such/file')
+    capture_io { WavefrontCli::OptHandler.new(config: '/no/such/file') }
   rescue SystemExit => e
     assert_equal(1, e.status)
     assert_match("Configuration file '/no/such/file' not found.", e.message)

data/spec/wavefront-cli/stdlib/array_spec.rb

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 
+require_relative '../../spec_helper'
 require_relative '../../../lib/wavefront-cli/stdlib/array'
 
 # Test extensions to stlib Array

data/wavefront-cli.gemspec

@@ -24,13 +24,13 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency 'docopt', '~> 0.6.0'
   gem.add_runtime_dependency 'inifile', '~> 3.0'
-  gem.add_runtime_dependency 'wavefront-sdk', '~> 3.2', '>= 3.2.0'
+  gem.add_runtime_dependency 'wavefront-sdk', '~> 3.3', '>= 3.3.0'
 
   gem.add_development_dependency 'minitest', '~> 5.11', '>= 5.11.0'
   gem.add_development_dependency 'rake', '~> 12.0'
   gem.add_development_dependency 'rubocop', '~> 0.54.0'
-  gem.add_development_dependency 'spy', '~> 0.4.0'
-  gem.add_development_dependency 'webmock', '~> 3.0'
+  gem.add_development_dependency 'spy', '~> 1.0.0'
+  gem.add_development_dependency 'webmock', '~> 3.5'
   gem.add_development_dependency 'yard', '~> 0.9.5'
 
   gem.required_ruby_version = Gem::Requirement.new('>= 2.3.0')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-cli
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.2.1
 platform: ruby
 authors:
 - Robert Fisher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-07 00:00:00.000000000 Z
+date: 2019-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt
@@ -44,20 +44,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.3.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.3.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -112,28 +112,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -169,6 +169,8 @@ files:
 - lib/wavefront-cli/apitoken.rb
 - lib/wavefront-cli/base.rb
 - lib/wavefront-cli/cloudintegration.rb
+- lib/wavefront-cli/command_mixins/acl.rb
+- lib/wavefront-cli/command_mixins/tag.rb
 - lib/wavefront-cli/commands/.rubocop.yml
 - lib/wavefront-cli/commands/alert.rb
 - lib/wavefront-cli/commands/apitoken.rb