wavefront-cli 3.1.3 → 3.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f98d17cf9a5e38f58258bdcf1fd4be6d08a6e92d57d2ae756f43becb165bc0e4
-  data.tar.gz: f06aa55fd7305834f02227413aea031f865c849eefe77156e12d451c15fa0698
+  metadata.gz: 0a1d06ffcd9e35ee8533ad1f02a13de47b8e9cd8a68f77382da1b3fb672c7b15
+  data.tar.gz: 6a20be8bb474cb3b981c641f9c0667a5e7fd4a0b3bc4e3c7a80872fb6019e40f
 SHA512:
-  metadata.gz: d6490226f534671ca73243a249fcb35b686d57beb16b277ead5418409186c023ae823e359472a0daf6b447ef823d91d7bf077ac1377f68a6909b62504c60e84f
-  data.tar.gz: 80b657cd6f9b416860a4169d7ac6d5d7f8f560f61b6096d9e38b74a475c8880e483a80ea9e88c28f5292965954ce0ae0bd2c0ec0116289fdc472d633cbed8394
+  metadata.gz: 5ce5c22835ae09b59dcaf3153d54540f9b9548a213344934bedebf030ae80e3a5eb2be35684de13509558b0889570217f162b396304ae92aeaa043bdc261cbbc
+  data.tar.gz: d28b8c665f5d911090acef88922e4157766deb5f90554c7d4f5a19bf0a81c1d5f9f754e5e866e5382b127becf0ef2ea48fb233435b01c030711a028ff411f52e

data/HISTORY.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 3.1.4 (02/05/2019)
+* Fix `alert import` missing tags bug.
+* Add import and notificants.
+
 ## 3.1.3 (24/04/2019)
 * Fix `write distribution` bug. Points would be sent, but results
   could not be displayed, causing a crash unless you used `-q`.

data/lib/wavefront-cli/alert.rb

@@ -5,6 +5,11 @@ module WavefrontCli
   # CLI coverage for the v2 'alert' API.
   #
   class Alert < WavefrontCli::Base
+    def import_fields
+      %w[name condition minutes target severity displayExpression
+         tags additionalInformation]
+    end
+
     def do_describe
       wf.describe(options[:'<id>'], options[:version])
     end
@@ -118,19 +123,17 @@ module WavefrontCli
     # @param raw [Hash] Ruby hash of imported data
     #
     def import_to_create(raw)
-      ret = %w[name condition minutes target severity displayExpression
-               additionalInformation].each_with_object({}) do |k, aggr|
-        aggr[k.to_sym] = raw[k]
-      end
+      import_fields.each_with_object({}) { |k, a| a[k.to_sym] = raw[k] }
+                   .tap do |ret|
 
-      if raw.key?('resolveAfterMinutes')
-        ret[:resolveMinutes] = raw['resolveAfterMinutes']
-      end
+        if raw.key?('resolveAfterMinutes')
+          ret[:resolveMinutes] = raw['resolveAfterMinutes']
+        end
 
-      if raw.key?('customerTagsWithCounts')
-        ret[:sharedTags] = raw['customerTagsWithCounts'].keys
+        if raw.key?('customerTagsWithCounts')
+          ret[:sharedTags] = raw['customerTagsWithCounts'].keys
+        end
       end
-      ret
     end
   end
 end

data/lib/wavefront-cli/base.rb

@@ -464,7 +464,9 @@ module WavefrontCli
     # the ID.
     #
     def import_to_create(raw)
-      raw.delete_if { |k, _v| k == 'id' }
+      raw.each_with_object({}) do |(k, v), a|
+        a[k.to_sym] = v unless k == 'id'
+      end
     end
 
     # Return a detailed description of one item, if an ID has been

data/lib/wavefront-cli/controller.rb

@@ -1,7 +1,7 @@
 # For development against a local checkout of the SDK, uncomment
 # this definition
 #
-# DEVELOPMENT = true
+DEVELOPMENT = true
 
 if defined?(DEVELOPMENT)
   dir = Pathname.new(__FILE__).dirname.realpath.parent.parent.parent

data/lib/wavefront-cli/version.rb

@@ -1 +1 @@
-WF_CLI_VERSION = '3.1.3'.freeze
+WF_CLI_VERSION = '3.1.4'.freeze

data/spec/spec_helper.rb

@@ -315,6 +315,22 @@ def tag_tests(cmd, id, bad_id, pth = nil, klass = nil)
                      "tag delete #{id} #{BAD_TAG}"])
 end
 
+class CliMethodTest < MiniTest::Test
+  attr_reader :wf
+
+  def setup
+    @wf = CliClass.new({})
+  end
+
+  def import_tester(word, have_fields, do_not_have_fields = [])
+    input = JSON.parse(IO.read(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) }
+    do_not_have_fields.each { |f| refute_includes(x.keys, f) }
+  end
+end
+
 # Load in a canned query response
 #
 def load_query_response

data/spec/wavefront-cli/alert_spec.rb

@@ -91,3 +91,14 @@ describe "#{word} command" do
   noop_tests(word, id, true)
   test_list_output(word)
 end
+
+CliClass = WavefrontCli::Alert
+
+class TestAlertMethods < CliMethodTest
+  def test_import_method
+    import_tester(:window,
+                  %i[startTimeInSeconds endTimeInSeconds
+                     relevantCustomerTags title relevantHostTags],
+                  %i[id])
+  end
+end

data/spec/wavefront-cli/dashboard_spec.rb

@@ -93,3 +93,15 @@ describe "#{word} command" do
   tag_tests(word, id, bad_id)
   test_list_output(word)
 end
+
+CliClass = WavefrontCli::Dashboard
+
+class TestAlertMethods < CliMethodTest
+  def test_import_method
+    import_tester(:dashboard,
+                  %i[description name parameters tags url creatorId
+                     sections parameterDetails displayDescription
+                     acl numCharts],
+                  %i[id])
+  end
+end

data/spec/wavefront-cli/derivedmetric_spec.rb

@@ -79,3 +79,13 @@ describe "#{word} command" do
                 headers: JSON_POST_HEADERS }, k)
   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
+end

data/spec/wavefront-cli/maintenancewindow_spec.rb

@@ -36,3 +36,14 @@ describe "#{word} command" do
               WavefrontCli::MaintenanceWindow)
   test_list_output(word, k)
 end
+
+CliClass = WavefrontCli::MaintenanceWindow
+
+class TestMaintenanceWindowMethods < CliMethodTest
+  def test_import_method
+    import_tester(:window,
+                  %i[startTimeInSeconds endTimeInSeconds
+                     relevantCustomerTags title relevantHostTags],
+                  %i[id])
+  end
+end

data/spec/wavefront-cli/notificant_spec.rb

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+
+id = '9wltLtYXsP8Je2kI'
+bad_id = '__bad_id__'
+word = 'notificant'
+
+require_relative '../spec_helper'
+require_relative "../../lib/wavefront-cli/#{word}"
+
+describe "#{word} command" do
+  missing_creds(word, ['list',
+                       "describe #{id}",
+                       'import file',
+                       "delete #{id}",
+                       "test #{id}",
+                       'search name=pattern'])
+  invalid_ids(word, ["describe #{bad_id}",
+                     "delete #{bad_id}",
+                     "test #{bad_id}",
+                     "update #{bad_id} key=value"])
+  list_tests(word)
+  cmd_to_call(word, "describe #{id}", path: "/api/v2/#{word}/#{id}")
+
+  cmd_to_call(word, "search id=#{id}",
+              method: :post, path: "/api/v2/search/#{word}",
+              body: { limit: 10,
+                      offset: 0,
+                      query: [{ key: 'id',
+                                value: id,
+                                matchingMethod: 'EXACT' }],
+                      sort: { field: 'id', ascending: true } },
+              headers: JSON_POST_HEADERS)
+  noop_tests(word, id)
+  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
+end

data/spec/wavefront-cli/resources/imports/alert.json

@@ -0,0 +1,14 @@
+{
+    "name": "PKS - too many containers not running",
+    "target": "target:9wltLtYXsP8Je2kI",
+    "tags": {
+        "customerTags": [
+            "pks"
+        ]
+    },
+    "condition": "sum(ts(pks.kube.pod.container.status.running.gauge)) / (sum(ts(pks.kube.pod.container.status.running.gauge)) + sum(ts(pks.kube.pod.container.status.waiting.gauge)) + sum(ts(pks.kube.pod.container.status.terminated.gauge))) < 0.8",
+    "displayExpression": "sum(ts(pks.kube.pod.container.status.running.gauge)) / (sum(ts(pks.kube.pod.container.status.running.gauge)) + sum(ts(pks.kube.pod.container.status.waiting.gauge)) + sum(ts(pks.kube.pod.container.status.terminated.gauge)))",
+    "minutes": 5,
+    "resolveAfterMinutes": 5,
+    "severity": "SEVERE"
+}

data/spec/wavefront-cli/resources/imports/dashboard.json

@@ -0,0 +1 @@
+{"canUserModify":true,"description":"very simple dashboard for CLI tests","hidden":false,"name":"test dashboard","id":"test_dashboard","parameters":{},"tags":{"customerTags":["test.dashboard"]},"customer":"sysdef","url":"test_dashboard","systemOwned":false,"creatorId":"rob@sysdef.xyz","updaterId":"rob@sysdef.xyz","eventFilterType":"BYCHART","sections":[{"name":"Proxy Section","rows":[{"charts":[{"base":0,"units":"Units","name":"New Chart","sources":[{"name":"New Query","query":"ts(\"~proxy.points.2878.*\")","secondaryAxis":false,"scatterPlotSource":"Y","querybuilderEnabled":false,"sourceDescription":""}],"includeObsoleteMetrics":false,"noDefaultEvents":false,"chartAttributes":null,"chartSettings":{"type":"line","autoColumnTags":false},"interpolatePoints":false}],"heightFactor":100}]}],"parameterDetails":{},"displayDescription":false,"displaySectionTableOfContents":true,"displayQueryParameters":false,"chartTitleScalar":0,"eventQuery":"","defaultTimeWindow":"2h","viewsLastDay":0,"viewsLastWeek":0,"viewsLastMonth":0,"acl":{"canView":[],"canModify":["a7d2e651-cec1-4154-a5e8-1946f57ef5b3"]},"createdEpochMillis":1556807658025,"updatedEpochMillis":1556807741557,"deleted":false,"numFavorites":0,"favorite":false,"numCharts":1,"orphan":false}

data/spec/wavefront-cli/resources/imports/derivedmetric.json

@@ -0,0 +1 @@
+{"created":1551211178661,"name":"example derived metric","id":"1551211178661","query":"aliasMetric(ts(\"gem.downloads.wavefront-cli\"), \"downloads.cli\")","minutes":5,"tags":{"customerTags":["cli","test"]},"status":["ACTIVE"],"updated":1551211178661,"includeObsoleteMetrics":false,"processRateMinutes":1,"lastProcessedMillis":1556810917164,"updateUserId":"rob@sysdef.xyz","additionalInformation":"example derived metric for CLI testing","inTrash":false,"queryFailing":false,"createUserId":"rob@sysdef.xyz","pointsScannedAtLastQuery":1,"metricsUsed":["gem.downloads.wavefront-cli"],"hostsUsed":["cube-cron"],"creatorId":"rob@sysdef.xyz","updaterId":"rob@sysdef.xyz","createdEpochMillis":1551211178661,"updatedEpochMillis":1551211178661,"queryQBEnabled":false,"deleted":false}

data/spec/wavefront-cli/resources/imports/notificant.json

@@ -0,0 +1 @@
+{"contentType":"","description":"testing CLI","method":"EMAIL","id":"9wltLtYXsP8Je2kI","title":"test target","customerId":"sysdef","creatorId":"rob@sysdef.xyz","updaterId":"rob@sysdef.xyz","createdEpochMillis":1556801433941,"updatedEpochMillis":1556810420754,"template":"just testing","triggers":["ALERT_OPENED","ALERT_RESOLVED"],"recipient":"ops@example.com","customHttpHeaders":{},"emailSubject":"[{{#severity}}{{{severity}}}{{/severity}}] {{{name}}} ({{{notificationId}}})","isHtmlContent":true}

data/spec/wavefront-cli/resources/imports/window.json

@@ -0,0 +1 @@
+{"reason":"CLI testing","customerId":"sysdef","startTimeInSeconds":1538848800,"endTimeInSeconds":1538849400,"relevantCustomerTags":[],"title":"test_1","relevantHostTags":["physical"],"id":"1538845614480","creatorId":"rob@sysdef.xyz","updaterId":"rob@sysdef.xyz","createdEpochMillis":1538845614480,"updatedEpochMillis":1538845614480,"eventName":"Maintenance Window: test_1","runningState":"ENDED","sortAttr":1000000}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-cli
 version: !ruby/object:Gem::Version
-  version: 3.1.3
+  version: 3.1.4
 platform: ruby
 authors:
 - Robert Fisher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-24 00:00:00.000000000 Z
+date: 2019-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt
@@ -293,6 +293,7 @@ files:
 - spec/wavefront-cli/maintenancewindow_spec.rb
 - spec/wavefront-cli/message_spec.rb
 - spec/wavefront-cli/metric_spec.rb
+- spec/wavefront-cli/notificant_spec.rb
 - spec/wavefront-cli/opt_handler_spec.rb
 - spec/wavefront-cli/output/csv/query_spec.rb
 - spec/wavefront-cli/output/csv_spec.rb
@@ -311,6 +312,11 @@ files:
 - spec/wavefront-cli/resources/display/user-human-long
 - spec/wavefront-cli/resources/display/user-human-long-no_sep
 - spec/wavefront-cli/resources/display/user-input.json
+- spec/wavefront-cli/resources/imports/alert.json
+- spec/wavefront-cli/resources/imports/dashboard.json
+- spec/wavefront-cli/resources/imports/derivedmetric.json
+- spec/wavefront-cli/resources/imports/notificant.json
+- spec/wavefront-cli/resources/imports/window.json
 - spec/wavefront-cli/resources/malformed.conf
 - spec/wavefront-cli/resources/responses/README.md
 - spec/wavefront-cli/resources/responses/alert-list.json
@@ -401,6 +407,7 @@ test_files:
 - spec/wavefront-cli/maintenancewindow_spec.rb
 - spec/wavefront-cli/message_spec.rb
 - spec/wavefront-cli/metric_spec.rb
+- spec/wavefront-cli/notificant_spec.rb
 - spec/wavefront-cli/opt_handler_spec.rb
 - spec/wavefront-cli/output/csv/query_spec.rb
 - spec/wavefront-cli/output/csv_spec.rb
@@ -419,6 +426,11 @@ test_files:
 - spec/wavefront-cli/resources/display/user-human-long
 - spec/wavefront-cli/resources/display/user-human-long-no_sep
 - spec/wavefront-cli/resources/display/user-input.json
+- spec/wavefront-cli/resources/imports/alert.json
+- spec/wavefront-cli/resources/imports/dashboard.json
+- spec/wavefront-cli/resources/imports/derivedmetric.json
+- spec/wavefront-cli/resources/imports/notificant.json
+- spec/wavefront-cli/resources/imports/window.json
 - spec/wavefront-cli/resources/malformed.conf
 - spec/wavefront-cli/resources/responses/README.md
 - spec/wavefront-cli/resources/responses/alert-list.json