wavefront-cli 5.1.1 → 7.2.0

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

@@ -1,103 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-
-module WavefrontDisplay
-  #
-  # Format human-readable output for user management.
-  #
-  class User < Base
-    def do_list_brief
-      data.each { |user| puts user[:identifier] }
-    end
-
-    def do_groups
-      groups = data.first.userGroups
-
-      if groups.empty?
-        puts 'User does not belong to any groups.'
-      else
-        groups.each { |u| puts format('%<id>s (%<name>s)', u) }
-      end
-    end
-
-    def do_privileges
-      puts(if data.first[:groups].empty?
-             'User does not have any Wavefront privileges.'
-           else
-             data.first[:groups]
-           end)
-    end
-
-    def do_create
-      info = data[0]
-      puts format("Created user '%<user>s'.\nPermission groups\n" \
-                  "%<perm_groups>s\nUser groups\n%<user_groups>s",
-                  user: info[:identifier],
-                  perm_groups: groups_as_string(info[:groups]),
-                  user_groups: user_groups_as_string(info[:userGroups]))
-    end
-
-    def groups_as_string(groups)
-      return '  <none>' if groups.empty?
-
-      data.response.groups.map do |g|
-        format('  %<group>s', group: g)
-      end.join("\n  ")
-    end
-
-    def user_groups_as_string(groups)
-      return '  <none>' if groups.empty?
-
-      groups.map { |g| format('  %<name>s (%<id>s)', g) }.join("\n")
-    end
-
-    def do_delete
-      puts format('Deleted %<quoted_user>s.',
-                  quoted_user: quoted(options[:'<user>']))
-    end
-
-    def do_invite
-      puts format("Sent invitation to '%<id>s'.", id: options[:'<id>'])
-    end
-
-    def do_grant
-      puts format("Granted '%<priv>s' to '%<id>s'.",
-                  priv: options[:'<privilege>'],
-                  id: options[:'<id>'])
-    end
-
-    def do_revoke
-      puts format("Revoked '%<priv>s' from '%<id>s'.",
-                  priv: options[:'<privilege>'],
-                  id: options[:'<id>'])
-    end
-
-    def do_join
-      puts format("Added '%<id>s' to %<quoted_group>s.",
-                  id: options[:'<id>'],
-                  quoted_group: quoted(options[:'<group>']))
-    end
-
-    def do_leave
-      puts format("Removed '%<id>s' from %<quoted_group>s.",
-                  id: options[:'<id>'],
-                  quoted_group: quoted(options[:'<group>']))
-    end
-
-    def do_business_functions
-      puts data.sort
-    end
-
-    def do_validate_brief
-      valid = data[0][:validUsers]
-      invalid = data[0][:invalidIdentifiers]
-
-      puts 'valid ',
-           valid.empty? ? '  <none>' : valid.map { |u| "  #{u[:identifier]}" }
-
-      puts 'invalid',
-           invalid.empty? ? '  <none>' : invalid.map { |u| "  #{u}" }
-    end
-  end
-end

data/lib/wavefront-cli/monitoredcluster.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-require_relative 'command_mixins/tag'
-
-module WavefrontCli
-  #
-  # CLI coverage for the v2 'maintenancewindow' API.
-  #
-  class MonitoredCluster < WavefrontCli::Base
-    include WavefrontCli::Mixin::Tag
-
-    def do_create
-      body = { version: options[:version],
-               name: options[:'<name>'],
-               platform: options[:'<platform>'],
-               id: options[:'<id>'],
-               additionalTags: {},
-               tags: [] }
-      wf.create(body)
-    end
-
-    def do_merge
-      wf.merge(options[:'<id_to>'], options[:'<id_from>'])
-    end
-
-    def validator_exception
-      Wavefront::Exception::InvalidMonitoredClusterId
-    end
-
-    def descriptive_name
-      'monitored cluster'
-    end
-
-    def extra_validation
-      return unless options[:merge]
-
-      validate_merge_id(options[:'<id_to>'])
-      validate_merge_id(options[:'<id_from>'])
-    end
-
-    private
-
-    def validate_merge_id(id)
-      wf_monitoredcluster_id?(id)
-    rescue Wavefront::Exception::InvalidMonitoredClusterId
-      abort "'#{id}' is not a valid cluster ID."
-    end
-  end
-end

data/lib/wavefront-cli/user.rb

@@ -1,92 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-
-module WavefrontCli
-  #
-  # CLI coverage for the v2 'user' API.
-  #
-  class User < WavefrontCli::Base
-    def do_list
-      wf.list
-    end
-
-    def do_delete
-      wf.delete_users(options[:'<user>'])
-    end
-
-    def do_create
-      wf_user_id?(options[:'<id>'])
-      wf.create(user_body, options[:email])
-    end
-
-    alias do_groups do_describe
-    alias do_privileges do_describe
-
-    def do_join
-      wf.add_groups_to_user(options[:'<id>'], options[:'<group>'])
-    end
-
-    def do_leave
-      wf.remove_groups_from_user(options[:'<id>'], options[:'<group>'])
-    end
-
-    def do_grant
-      wf.grant(options[:'<id>'], options[:'<privilege>'])
-    end
-
-    def do_revoke
-      wf.revoke(options[:'<id>'], options[:'<privilege>'])
-    end
-
-    def do_invite
-      wf_user_id?(options[:'<id>'])
-      wf.invite([user_body])
-    end
-
-    def do_business_functions
-      wf_user_id?(options[:'<id>'])
-      wf.business_functions(options[:'<id>'])
-    end
-
-    def do_validate
-      wf.validate_users(options[:'<user>'])
-    end
-
-    def import_to_create(raw)
-      { emailAddress: raw['items']['identifier'],
-        groups: raw['items']['groups'] }.tap do |r|
-        if raw['items'].key?('userGroups')
-          r['userGroups'] = raw['items']['userGroups'].map { |g| g['id'] }
-        end
-      end
-    end
-
-    # Object used to create and invite users.
-    #
-    def user_body
-      { emailAddress: options[:'<id>'],
-        groups: options[:permission],
-        userGroups: options[:group] }
-    end
-
-    # Because of the way docopt works, we have to call the user ID
-    # parameter something else on the delete command. This means the
-    # automatic validtion doesn't work, and we have to do it
-    # ourselves.
-    #
-    def extra_validation
-      options[:'<user>']&.each { |u| validate_user(u) }
-    end
-
-    def validate_user(user)
-      wf_user_id?(user)
-    rescue Wavefront::Exception::InvalidUserId
-      abort failed_validation_message(user)
-    end
-
-    def item_dump_call
-      wf.list.response.items
-    end
-  end
-end

data/spec/wavefront-cli/monitoredcluster_spec.rb

@@ -1,85 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require_relative '../support/command_base'
-require_relative '../test_mixins/tag'
-require_relative '../../lib/wavefront-cli/monitoredcluster'
-
-# Ensure 'cluster' commands produce the correct API calls.
-#
-class MonitoredClusterEndToEndTest < EndToEndTest
-  include WavefrontCliTest::Delete
-  include WavefrontCliTest::Describe
-  include WavefrontCliTest::List
-  include WavefrontCliTest::Search
-  include WavefrontCliTest::Tag
-
-  def test_create
-    quietly do
-      assert_cmd_posts("create EKS cluster #{id}",
-                       '/api/v2/monitoredcluster',
-                       version: nil,
-                       name: 'cluster',
-                       platform: 'EKS',
-                       id: 'test-cluster',
-                       additionalTags: {},
-                       tags: [])
-    end
-
-    assert_abort_on_missing_creds("create EKS cluster #{id}")
-    assert_noop("create EKS -v 1.2 cluster #{id}",
-                'uri: POST https://default.wavefront.com/api/v2/monitoredcluster',
-                "body: #{ { version: '1.2',
-                            name: 'cluster',
-                            platform: 'EKS',
-                            id: 'test-cluster',
-                            additionalTags: {},
-                            tags: [] }.to_json}")
-  end
-
-  def test_merge
-    quietly do
-      assert_cmd_puts(
-        "merge #{id} #{id2}", "/api/v2/monitoredcluster/merge/#{id}/#{id2}",
-        {}
-      )
-    end
-
-    assert_noop("merge #{id} #{id2}",
-                'uri: PUT https://default.wavefront.com/api/v2/' \
-                "monitoredcluster/merge/#{id}/#{id2}",
-                'body: null')
-    assert_invalid_id("merge #{invalid_id} #{id2} -D")
-    assert_abort_on_missing_creds("merge #{id} #{id2}")
-  end
-
-  private
-
-  def id
-    'test-cluster'
-  end
-
-  def id2
-    'other-cluster'
-  end
-
-  def invalid_id
-    '!__BAD__!'
-  end
-
-  def cmd_word
-    'cluster'
-  end
-
-  def api_path
-    'monitoredcluster'
-  end
-
-  def sdk_class_name
-    'MonitoredCluster'
-  end
-
-  def friendly_name
-    'monitored cluster'
-  end
-end

data/spec/wavefront-cli/resources/responses/user-list.json

@@ -1 +0,0 @@
-{"items":[{"identifier":"dev+sysdef@wavefront.com","customer":"sysdef","lastSuccessfulLogin":1549996596333,"groups":["agent_management","alerts_management","dashboard_management","ingestion","events_management","host_tag_management","user_management","embedded_charts","metrics_management","application_management","external_links_management"]},{"identifier":"rob@somewhere.xyz","customer":"sysdef","lastSuccessfulLogin":1550676149122,"groups":["agent_management","host_tag_management","events_management","alerts_management","dashboard_management","metrics_management","embedded_charts","ingestion","user_management","application_management","external_links_management"]},{"identifier":"sam@elsewhere.net","customer":"sysdef","lastSuccessfulLogin":1541000935563,"groups":[]},{"identifier":"services@example.com","customer":"sysdef","groups":[]},{"identifier":"someone@example.com","customer":"sysdef","lastSuccessfulLogin":1535977667674,"groups":["host_tag_management","dashboard_management","embedded_charts","metrics_management","agent_management","events_management","external_links_management","alerts_management","ingestion","user_management","application_management"]}],"offset":0,"limit":5,"totalItems":5,"modeItems":false}

data/spec/wavefront-cli/user_spec.rb

@@ -1,311 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require_relative '../support/command_base'
-require_relative '../../lib/wavefront-cli/user'
-
-# Ensure 'user' commands produce the correct API calls.
-#
-class UserEndToEndTest < EndToEndTest
-  include WavefrontCliTest::Search
-  include WavefrontCliTest::Describe
-
-  def test_list
-    quietly do
-      assert_cmd_gets('list', '/api/v2/user')
-    end
-    assert_noop('list',
-                'uri: GET https://default.wavefront.com/api/v2/user')
-    assert_abort_on_missing_creds('list')
-  end
-
-  def test_create
-    out, err = capture_io do
-      assert_cmd_posts(
-        "create #{id}", '/api/v2/user?sendEmail=false',
-        {  emailAddress: id,
-           groups: [],
-           userGroups: [] },
-        { status: { result: 'OK', message: '', code: 200 },
-          response: { identifier: 'test1@sysdef.xyz',
-                      customer: 'sysdef',
-                      groups: [],
-                      userGroups:
-        [{ id: '2659191e-aad4-4302-a94e-9667e1517127',
-           name: 'Everyone',
-           permissions: [],
-           customer: 'sysdef',
-           properties:
-           { nameEditable: false,
-             permissionsEditable: true,
-             usersEditable: false },
-           description: 'System group which contains all users' }] } }.to_json
-      )
-    end
-
-    assert_empty err
-    out = out.split("\n")
-    assert_equal("Created user 'test1@sysdef.xyz'.", out[0])
-    assert_equal('Permission groups', out[1])
-    assert_equal('  <none>', out[2])
-    assert_equal('User groups', out[3])
-    assert_match(/^  Everyone \([0-9a-f\-]{36}\)$/, out.last)
-  end
-
-  def test_create_with_email_invite
-    out, err = capture_io do
-      assert_cmd_posts(
-        "create -e #{id}", '/api/v2/user?sendEmail=true',
-        {  emailAddress: id,
-           groups: [],
-           userGroups: [] },
-        { status: { result: 'OK', message: '', code: 200 },
-          response: { identifier: 'test1@sysdef.xyz',
-                      customer: 'sysdef',
-                      groups: [],
-                      userGroups:
-        [{ id: '2659191e-aad4-4302-a94e-9667e1517127',
-           name: 'Everyone',
-           permissions: [],
-           customer: 'sysdef',
-           properties:
-           { nameEditable: false,
-             permissionsEditable: true,
-             usersEditable: false },
-           description: 'System group which contains all users' }] } }.to_json
-      )
-    end
-
-    assert_empty err
-    out = out.split("\n")
-    assert_equal("Created user 'test1@sysdef.xyz'.", out[0])
-    assert_equal('Permission groups', out[1])
-    assert_equal('  <none>', out[2])
-    assert_equal('User groups', out[3])
-    assert_match(/^  Everyone \([0-9a-f\-]{36}\)$/, out.last)
-  end
-
-  def test_create_with_groups
-    out, err = capture_io do
-      assert_cmd_posts(
-        "create -g #{groups[0]} -g #{groups[1]} #{id}",
-        '/api/v2/user?sendEmail=false',
-        {  emailAddress: id,
-           groups: [],
-           userGroups: groups },
-        { status: { result: 'OK', message: '', code: 200 },
-          response: { identifier: 'test1@sysdef.xyz',
-                      customer: 'sysdef',
-                      groups: [],
-                      userGroups:
-        [{ id: '2659191e-aad4-4302-a94e-9667e1517127',
-           name: 'Everyone',
-           permissions: [],
-           customer: 'sysdef',
-           properties:
-           { nameEditable: false,
-             permissionsEditable: true,
-             usersEditable: false },
-           description: 'System group which contains all users' }] } }.to_json
-      )
-    end
-
-    assert_empty err
-    out = out.split("\n")
-    assert_equal("Created user 'test1@sysdef.xyz'.", out[0])
-    assert_equal('Permission groups', out[1])
-    assert_equal('  <none>', out[2])
-    assert_equal('User groups', out[3])
-    assert_match(/^  Everyone \([0-9a-f\-]{36}\)$/, out.last)
-  end
-
-  def test_invite
-    assert_repeated_output("Sent invitation to '#{id}'.") do
-      assert_cmd_posts("invite -m #{privilege} -g #{groups[1]} #{id}",
-                       '/api/v2/user/invite',
-                       [{ emailAddress: id,
-                          groups: [privilege],
-                          userGroups: [groups[1]] }].to_json)
-    end
-
-    assert_invalid_id("invite -m #{privilege} #{invalid_id}")
-    assert_abort_on_missing_creds("invite -m #{privilege} #{id}")
-    assert_usage('invite')
-  end
-
-  def test_delete
-    assert_repeated_output("Deleted '#{id}'.") do
-      assert_cmd_posts("delete #{id}",
-                       '/api/v2/user/deleteUsers',
-                       [id].to_json)
-    end
-
-    assert_invalid_id("delete #{invalid_id}")
-    assert_abort_on_missing_creds("delete #{id}")
-    assert_usage('delete')
-  end
-
-  def test_groups
-    assert_repeated_output('a7d26e51-cce1-4515-5ae8-1946f57ef5b3 (Everyone)') do
-      assert_cmd_gets("groups #{id}", "/api/v2/user/#{id}",
-                      [{ identifier: 'someone@example.com',
-                         userGroups:
-     [{ id: 'a7d26e51-cce1-4515-5ae8-1946f57ef5b3',
-        name: 'Everyone',
-        description: 'System group which contains all users' }] }].to_json)
-    end
-
-    assert_invalid_id("groups #{invalid_id}")
-    assert_abort_on_missing_creds("groups #{id}")
-    assert_usage('groups')
-  end
-
-  def test_privileges
-    quietly do
-      assert_cmd_gets("privileges #{id}", "/api/v2/user/#{id}")
-    end
-
-    assert_invalid_id("privileges #{invalid_id}")
-    assert_usage('privileges')
-
-    assert_noop(
-      "privileges #{id}",
-      "uri: GET https://default.wavefront.com/api/v2/user/#{id}"
-    )
-
-    assert_abort_on_missing_creds("privileges #{id}")
-  end
-
-  def test_join
-    assert_repeated_output("Added '#{id}' to '#{groups[0]}'.") do
-      assert_cmd_posts("join #{id} #{groups[0]}",
-                       "/api/v2/user/#{id}/addUserGroups",
-                       [groups[0]].to_json)
-    end
-  end
-
-  def test_leave
-    assert_repeated_output(
-      "Removed '#{id}' from '#{groups[0]}', '#{groups[1]}'."
-    ) do
-      assert_cmd_posts("leave #{id} #{groups[0]} #{groups[1]}",
-                       "/api/v2/user/#{id}/removeUserGroups",
-                       groups.to_json)
-    end
-
-    assert_invalid_id("leave #{invalid_id} #{groups[0]} #{groups[1]}")
-    assert_abort_on_missing_creds("leave #{id} #{groups[0]} #{groups[1]}")
-    assert_usage('leave')
-  end
-
-  def test_grant
-    assert_repeated_output("Granted '#{privilege}' to '#{id}'.") do
-      assert_cmd_posts("grant #{privilege} to #{id}",
-                       "/api/v2/user/#{id}/grant",
-                       group: privilege)
-    end
-
-    assert_invalid_id("grant #{privilege} to #{invalid_id}")
-    assert_abort_on_missing_creds("grant #{privilege} to #{id}")
-    assert_usage("grant #{privilege}")
-  end
-
-  def test_revoke
-    assert_repeated_output("Revoked '#{privilege}' from '#{id}'.") do
-      assert_cmd_posts("revoke #{privilege} from #{id}",
-                       "/api/v2/user/#{id}/revoke",
-                       group: privilege)
-    end
-
-    assert_invalid_id("revoke #{privilege} from #{invalid_id}")
-    assert_abort_on_missing_creds("revoke #{privilege} from #{id}")
-    assert_usage("revoke #{privilege} #{id}")
-  end
-
-  # We have to override most of the dump tests because of the
-  # fudgery that goes on in the user API class.
-  #
-  def test_dump_json
-    out, err = capture_io do
-      assert_raises(SystemExit) do
-        assert_cmd_gets('dump --format=json', '/api/v2/user', list_response)
-      end
-      Spy.teardown
-    end
-
-    assert_empty(err)
-    assert_equal('[{"items":[{"identifier":"user1@example.com"},' \
-                 '{"identifier":"user2@example.com"}]}]', out.strip)
-  end
-
-  def test_dump_yaml
-    out, err = capture_io do
-      assert_raises(SystemExit) do
-        assert_cmd_gets('dump --format=yaml', '/api/v2/user', list_response)
-      end
-      Spy.teardown
-    end
-
-    assert_empty(err)
-    assert_equal("---\n- items:\n  - identifier: user1@example.com\n  " \
-                 '- identifier: user2@example.com', out.strip)
-  end
-
-  def test_business_functions
-    quietly do
-      assert_cmd_gets("business functions #{id}",
-                      "/api/v2/user/#{id}/businessFunctions")
-    end
-
-    assert_noop("business functions #{id}",
-                'uri: GET https://default.wavefront.com/api/v2/user/' \
-                "#{id}/businessFunctions")
-    assert_invalid_id("business functions #{invalid_id}")
-    assert_abort_on_missing_creds("business functions #{id}")
-    assert_usage('business functions')
-  end
-
-  def test_validate
-    quietly do
-      assert_cmd_posts("validate #{user_list.join(' ')}",
-                       '/api/v2/user/validateUsers',
-                       user_list.to_json,
-                       IO.read(RES_DIR + 'responses' + 'user-validate.json'))
-    end
-  end
-
-  private
-
-  def id
-    'someonesomewhere.com'
-  end
-
-  def invalid_id
-    'bad' * 200
-  end
-
-  def cmd_word
-    'user'
-  end
-
-  def groups
-    %w[2659191e-aad4-4302-a94e-9667e1517127
-       abcdef12-1234-abcd-1234-abcdef012345]
-  end
-
-  def list_response
-    { items: [{ identifier: 'user1@example.com' },
-              { identifier: 'user2@example.com' }] }.to_json
-  end
-
-  def privilege
-    'alerts_management'
-  end
-
-  def user_list
-    %w[rob@somewhere.xyz
-       services@elsewhere.net
-       rob@elsewhere.net
-       no-such-thing]
-  end
-end