wavefront-cli 4.2.1 → 4.3.0

data/spec/wavefront-cli/integration_spec.rb

@@ -1,45 +1,143 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-id = 'tester'
-bad_id = '%%badid%%'
-word = 'integration'
+require_relative '../support/command_base'
+require_relative '../../lib/wavefront-cli/integration'
 
-require_relative '../spec_helper'
-require_relative "../../lib/wavefront-cli/#{word}"
+# Ensure 'integration' commands produce the correct API calls.
+#
+class IntegrationEndToEndTest < EndToEndTest
+  include WavefrontCliTest::List
+  include WavefrontCliTest::Describe
+  include WavefrontCliTest::Search
 
-describe "#{word} command" do
-  missing_creds(word, ['list', "describe #{id}", "install #{id}",
-                       "uninstall #{id}", "status #{id}", 'statuses',
-                       'manifests'])
-  list_tests(word)
-  noop_tests(word, id, :skip, 'integration')
-  cmd_to_call(word, "status #{id}", path: "/api/v2/#{word}/#{id}/status")
+  def test_install
+    quietly do
+      assert_cmd_posts("install #{id}",
+                       "/api/v2/integration/#{id}/install",
+                       'null')
+    end
 
-  cmd_to_call(word, "install #{id}",
-              method: :post, path: "/api/v2/#{word}/#{id}/install")
+    assert_invalid_id("install #{invalid_id}")
+    assert_usage('install')
+    assert_abort_on_missing_creds("install #{id}")
 
-  cmd_to_call(word, "uninstall #{id}",
-              method: :post, path: "/api/v2/#{word}/#{id}/uninstall")
+    assert_noop("install #{id}",
+                'uri: POST https://default.wavefront.com/api/v2/' \
+                "integration/#{id}/install",
+                'body: null')
+  end
 
-  cmd_to_call(word, "alert install #{id}",
-              method: :post,
-              path:   "/api/v2/#{word}/#{id}/install-all-alerts")
+  def test_uninstall
+    quietly do
+      assert_cmd_posts("uninstall #{id}",
+                       "/api/v2/integration/#{id}/uninstall",
+                       'null')
+    end
 
-  cmd_to_call(word, "alert uninstall #{id}",
-              method: :post,
-              path:   "/api/v2/#{word}/#{id}/uninstall-all-alerts")
+    assert_invalid_id("uninstall #{invalid_id}")
+    assert_usage('uninstall')
+    assert_abort_on_missing_creds("uninstall #{id}")
 
-  cmd_to_call(word, "describe #{id}", path: "/api/v2/#{word}/#{id}")
+    assert_noop("uninstall #{id}",
+                'uri: POST https://default.wavefront.com/api/v2/' \
+                "integration/#{id}/uninstall",
+                'body: null')
+  end
 
-  cmd_to_call(word, "status #{id}", path: "/api/v2/#{word}/#{id}/status")
+  def test_manifests
+    assert_exits_with('Human-readable manifest output is not supported.',
+                      'manifests -f human')
 
-  cmd_to_call(word, 'installed', path: "/api/v2/#{word}/installed")
+    quietly do
+      assert_cmd_gets('manifests -f json', '/api/v2/integration/manifests')
+    end
 
-  cmd_to_call(word, 'manifests -f json', path: "/api/v2/#{word}/manifests")
+    assert_noop('manifests --format yaml',
+                'uri: GET https://default.wavefront.com/api/v2/' \
+                'integration/manifests')
+    assert_abort_on_missing_creds('manifests')
+  end
 
-  invalid_ids(word, ["describe #{bad_id}", "install #{bad_id}",
-                     "alert install #{bad_id}",
-                     "alert uninstall #{bad_id}",
-                     "uninstall #{bad_id}", "status #{bad_id}"])
-  test_list_output(word)
+  def test_status
+    quietly do
+      assert_cmd_gets("status #{id}", "/api/v2/integration/#{id}/status")
+    end
+
+    assert_invalid_id("status #{invalid_id}")
+    assert_noop("status #{id}",
+                'uri: GET https://default.wavefront.com/api/v2/' \
+                "integration/#{id}/status")
+    assert_abort_on_missing_creds("status #{id}")
+  end
+
+  def test_statuses
+    quietly do
+      assert_cmd_gets('statuses', '/api/v2/integration/status')
+    end
+
+    assert_noop('statuses',
+                'uri: GET https://default.wavefront.com/api/v2/' \
+                'integration/status')
+    assert_abort_on_missing_creds('statuses')
+  end
+
+  def test_alert_install
+    quietly do
+      assert_cmd_posts("alert install #{id}",
+                       "/api/v2/integration/#{id}/install-all-alerts",
+                       'null')
+    end
+
+    assert_invalid_id("alert install #{invalid_id}")
+    assert_usage('alert install')
+    assert_abort_on_missing_creds("alert install #{id}")
+
+    assert_noop("alert install #{id}",
+                'uri: POST https://default.wavefront.com/api/v2/' \
+                "integration/#{id}/install-all-alerts",
+                'body: null')
+  end
+
+  def test_alert_uninstall
+    quietly do
+      assert_cmd_posts("alert uninstall #{id}",
+                       "/api/v2/integration/#{id}/uninstall-all-alerts",
+                       'null')
+    end
+
+    assert_invalid_id("alert uninstall #{invalid_id}")
+    assert_usage('alert uninstall')
+    assert_abort_on_missing_creds("alert uninstall #{id}")
+
+    assert_noop("alert uninstall #{id}",
+                'uri: POST https://default.wavefront.com/api/v2/' \
+                "integration/#{id}/uninstall-all-alerts",
+                'body: null')
+  end
+
+  def test_installed
+    quietly do
+      assert_cmd_gets('installed', '/api/v2/integration/installed')
+    end
+
+    assert_noop('installed',
+                'uri: GET https://default.wavefront.com/api/v2/' \
+                'integration/installed')
+    assert_abort_on_missing_creds('installed')
+  end
+
+  private
+
+  def id
+    'tester'
+  end
+
+  def invalid_id
+    '%%badid%%'
+  end
+
+  def cmd_word
+    'integration'
+  end
 end

data/spec/wavefront-cli/maintenancewindow_spec.rb

@@ -1,41 +1,279 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require_relative '../spec_helper'
+require_relative '../support/command_base'
 require_relative '../../lib/wavefront-cli/maintenancewindow'
 
-id = '1493324005091'
-bad_id = '__BAD__'
-k = WavefrontCli::MaintenanceWindow
-word = 'window'
-
-describe "#{word} command" do
-  missing_creds(word, ['list', "describe #{id}", "delete #{id}"])
-  list_tests(word, 'maintenancewindow', k)
-  noop_tests(word, id, false, 'maintenancewindow', k)
-  search_tests(word, id, k, 'maintenancewindow')
-  cmd_to_call(word, "describe #{id}",
-              { path: "/api/v2/maintenancewindow/#{id}" }, k)
-  cmd_to_call(word, "delete #{id}",
-              { method: :delete, path: "/api/v2/maintenancewindow/#{id}" }, k)
-  invalid_ids(word, ["describe #{bad_id}", "delete #{bad_id}"])
-  cmd_to_call(word, 'create -d testing -H shark tester',
-              { method: :post, path: '/api/v2/maintenancewindow',
-                body: {
-                },
-                headers: JSON_POST_HEADERS },
-              WavefrontCli::MaintenanceWindow)
-  test_list_output(word, k)
-end
+# Ensure 'window' commands produce the correct API calls.
+#
+class MaintenanceWindowEndToEndTest < EndToEndTest
+  include WavefrontCliTest::List
+  include WavefrontCliTest::Describe
+  include WavefrontCliTest::Dump
+  include WavefrontCliTest::Delete
+  # include WavefrontCliTest::Import
+  include WavefrontCliTest::Set
+  include WavefrontCliTest::Search
+
+  def test_create
+    quietly do
+      assert_cmd_posts('create -d testing --host shark test_window',
+                       '/api/v2/maintenancewindow',
+                       endTimeInSeconds: a_timestamp,
+                       reason: 'testing',
+                       relevantHostNames: %w[shark],
+                       startTimeInSeconds: a_timestamp,
+                       title: 'test_window')
+    end
+
+    assert_abort_on_missing_creds('create -d testing -H box test_window')
+    assert_usage('create test_window')
+  end
+
+  def test_create_with_boundaries
+    quietly do
+      assert_cmd_posts('create --desc testing -H shark -s 1566776337 ' \
+                       '-H box -e 1566776399 test_window',
+                       '/api/v2/maintenancewindow',
+                       endTimeInSeconds: 1_566_776_399,
+                       reason: 'testing',
+                       relevantHostNames: %w[shark box],
+                       startTimeInSeconds: 1_566_776_337,
+                       title: 'test_window')
+    end
+
+    assert_noop(
+      'create --desc testing -H shark -s 1566776337 -H box ' \
+      '-e 1566776399 test_window',
+      'uri: POST https://default.wavefront.com/api/v2/maintenancewindow',
+      'body: ' + { title: 'test_window',
+                   startTimeInSeconds: 1_566_776_337,
+                   endTimeInSeconds: 1_566_776_399,
+                   reason: 'testing',
+                   relevantHostNames: %w[shark box] }.to_json
+    )
+  end
+
+  def test_create_with_boundaries_and_tags
+    quietly do
+      assert_cmd_posts('create -d testing -A alert_tag_1 -A alert_tag_2 ' \
+                       '--start 1566776337 --end 1566776399 test_window',
+                       '/api/v2/maintenancewindow',
+                       endTimeInSeconds: 1_566_776_399,
+                       reason: 'testing',
+                       relevantCustomerTags: %w[alert_tag_1 alert_tag_2],
+                       startTimeInSeconds: 1_566_776_337,
+                       title: 'test_window')
+    end
+  end
+
+  def test_close
+    quietly do
+      all_permutations do |p|
+        get_stub = stub_request(
+          :get,
+          "https://#{p[:endpoint]}/api/v2/maintenancewindow/#{id}"
+        ).to_return(body: canned_response.to_json, status: 200)
+
+        put_stub = stub_request(
+          :put,
+          "https://#{p[:endpoint]}/api/v2/maintenancewindow/#{id}"
+        ).with(body: { id: '1538845632142',
+                       reason: 'CLI testing',
+                       relevantCustomerTags: [],
+                       relevantHostTags: ['physical'],
+                       startTimeInSeconds: 1_538_812_800,
+                       endTimeInSeconds: a_timestamp,
+                       title: 'test_2' })
+                   .to_return(body: dummy_response, status: 200)
+
+        wf.new("window close #{id} #{p[:cmdline]}".split)
+
+        assert_requested(get_stub)
+        assert_requested(put_stub)
+      end
+    end
+
+    assert_cannot_noop("close #{id}")
+    assert_abort_on_missing_creds("close #{id}")
+    assert_usage('close')
+  end
+
+  def test_extend_to
+    quietly do
+      all_permutations do |p|
+        get_stub = stub_request(
+          :get,
+          "https://#{p[:endpoint]}/api/v2/maintenancewindow/#{id}"
+        ).to_return(body: canned_response.to_json, status: 200)
+
+        put_stub = stub_request(
+          :put,
+          "https://#{p[:endpoint]}/api/v2/maintenancewindow/#{id}"
+        ).with(body: { id: '1538845632142',
+                       reason: 'CLI testing',
+                       relevantCustomerTags: [],
+                       relevantHostTags: ['physical'],
+                       startTimeInSeconds: 1_538_812_800,
+                       endTimeInSeconds: 1_566_781_528,
+                       title: 'test_2' })
+                   .to_return(body: dummy_response, status: 200)
+
+        wf.new("window extend to 1566781528 #{id} #{p[:cmdline]}".split)
+
+        assert_requested(get_stub)
+        assert_requested(put_stub)
+      end
+    end
+
+    assert_cannot_noop("extend to 2:00 #{id}")
+    assert_usage("extend #{id} to 2:00")
+    assert_usage('extend')
+  end
+
+  def test_extend_by
+    quietly do
+      all_permutations do |p|
+        get_stub = stub_request(
+          :get,
+          "https://#{p[:endpoint]}/api/v2/maintenancewindow/#{id}"
+        ).to_return(body: canned_response.to_json, status: 200)
+
+        put_stub = stub_request(
+          :put,
+          "https://#{p[:endpoint]}/api/v2/maintenancewindow/#{id}"
+        ).with(body: { id: '1538845632142',
+                       reason: 'CLI testing',
+                       relevantCustomerTags: [],
+                       relevantHostTags: ['physical'],
+                       startTimeInSeconds: 1_538_812_800,
+                       endTimeInSeconds: a_timestamp,
+                       title: 'test_2' })
+                   .to_return(body: dummy_response, status: 200)
+
+        wf.new("window extend by 1h #{id} #{p[:cmdline]}".split)
+
+        assert_requested(get_stub, times: 2)
+        assert_requested(put_stub)
+      end
+    end
+
+    assert_cannot_noop("extend by 1h #{id}")
+    assert_usage("extend 1h #{id}")
+    assert_usage("extend by an hour #{id}")
+  end
+
+  def test_ongoing
+    out, err = capture_io do
+      assert_raises(SystemExit) do
+        assert_cmd_posts('ongoing',
+                         '/api/v2/search/maintenancewindow',
+                         state_search('ongoing').to_json)
+      end
+    end
+
+    assert_noop(
+      'ongoing',
+      'uri: POST https://default.wavefront.com/api/v2/search/maintenancewindow',
+      'body: ' + { limit: 999,
+                   offset: 0,
+                   query: [{ key: 'runningState',
+                             value: 'ongoing',
+                             matchingMethod: 'EXACT' }],
+                   sort: { field: 'runningState',
+                           ascending: true } }.to_json
+    )
+
+    assert_empty(err)
+    assert_equal('No maintenance windows currently ongoing.', out.strip)
+    assert_abort_on_missing_creds('ongoing')
+  end
+
+  def test_pending
+    out, err = capture_io do
+      assert_raises(SystemExit) do
+        assert_cmd_posts('pending',
+                         '/api/v2/search/maintenancewindow',
+                         state_search('pending').to_json)
+      end
+    end
+
+    assert_noop(
+      'pending',
+      'uri: POST https://default.wavefront.com/api/v2/search/maintenancewindow',
+      'body: ' + { limit: 999,
+                   offset: 0,
+                   query: [{ key: 'runningState',
+                             value: 'pending',
+                             matchingMethod: 'EXACT' }],
+                   sort: { field: 'runningState',
+                           ascending: true } }.to_json
+    )
+
+    assert_empty(err)
+    assert_equal('No maintenance windows in the next 24 hours.', out.strip)
+    assert_abort_on_missing_creds('pending')
+  end
+
+  private
+
+  def id
+    '1493324005091'
+  end
+
+  def invalid_id
+    '__BAD__'
+  end
+
+  def cmd_word
+    'window'
+  end
+
+  def api_path
+    'maintenancewindow'
+  end
+
+  def sdk_class_name
+    'MaintenanceWindow'
+  end
+
+  def friendly_name
+    'maintenance window'
+  end
+
+  def set_key
+    'title'
+  end
+
+  def import_fields
+    %i[startTimeInSeconds endTimeInSeconds relevantCustomerTags
+       title relevantHostTags]
+  end
 
-class TestMaintenanceWindowMethods < CliMethodTest
-  def cliclass
-    WavefrontCli::MaintenanceWindow
+  def canned_response
+    { id: '1538845632142',
+      reason: 'CLI testing',
+      customerId: 'sysdef',
+      relevantCustomerTags: [],
+      title: 'test_2',
+      startTimeInSeconds: 1_538_812_800,
+      endTimeInSeconds: 1_566_780_739,
+      relevantHostTags: ['physical'],
+      creatorId: 'rob@sysdef.xyz',
+      updaterId: 'rob@sysdef.xyz',
+      createdEpochMillis: 1_538_845_632_142,
+      updatedEpochMillis: 1_566_780_740_722,
+      eventName: 'Maintenance Window: test_2',
+      runningState: 'ENDED',
+      sortAttr: 1_000_000 }
   end
 
-  def test_import_method
-    import_tester(:window,
-                  %i[startTimeInSeconds endTimeInSeconds
-                     relevantCustomerTags title relevantHostTags],
-                  %i[id])
+  def state_search(state)
+    { limit: 999,
+      offset: 0,
+      query: [{ key: 'runningState',
+                value: state,
+                matchingMethod: 'EXACT' }],
+      sort: { field: 'runningState', ascending: true } }
   end
 end