kennel 1.18.2 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 734334b788520b60627349b1938a3ff689a7a7f70a73ea2ae89461c0e0ec36e8
-  data.tar.gz: 72996467fb2c1f1ca7a3af55e0e7a70f28c8db29173dedb5ccb0e9010137ec58
+  metadata.gz: ce664560cea8f70dc49a11711f81a38faab96a425439fc0e58afa0e35318ddf6
+  data.tar.gz: 761f7741b0787dea3d09bc22b15467f8fa5b3626504a593e93d4edd6728a6088
 SHA512:
-  metadata.gz: 2cf10e3bfa2a185ced7fcd831cff8fdac2405a99a053d9c6eb58507fcb06acdf7b73597cd10a77674ce3c57cdd4346ff9651f0b2f56428e690ee2546cbe4cae2
-  data.tar.gz: e9b6b44dbf0e83613ed4492e21cd521105777286e3e094e917baf02d9ada504971396ca176c22856ed8ac33501f7066c98917e8366752c0bfa0ae27e9a6ec05e
+  metadata.gz: d6e9573898edfd15e5fb34f1ab749b6bc5a8f4f70a75d855e229dc9a98af66c30a748b348d4095b7d361bb8f71cda6b75448e08c4cc9f1efda7b6312bf32d791
+  data.tar.gz: 0e42c01940e220d1a4fce162419b4c9279ead3a1f751f74b4ae15033c2399773ed2886779189b2ea93411963ae3e87da230a2656d1dcd21a20de6a26291f1a2e

data/lib/kennel/importer.rb

@@ -2,36 +2,44 @@
 
 module Kennel
   class Importer
-    SORT_ORDER = [:title, :id, :description, :template_variables].freeze
-
-    # TODO: make model diff normalization reusable
-    IGNORED = Models::Base::READONLY_ATTRIBUTES - [:id] + [:created_by, :read_only]
+    SORT_ORDER = [:title, :name, :board_title, :id, :query, :message, :description, :template_variables].freeze
 
     def initialize(api)
       @api = api
     end
 
     def import(resource, id)
-      data = @api.show(resource, id)
-      case resource
-      when "dash"
-        data = data[:dash]
-        IGNORED.each { |k| data.delete(k) }
-        <<~RUBY
-          Kennel::Models::Dash.new(
-            self,
-            #{pretty_print(data).lstrip}
-          )
-        RUBY
-      else
-        raise ArgumentError, "#{resource} is not supported"
+      model =
+        begin
+          Kennel::Models.const_get(resource.capitalize)
+        rescue NameError
+          raise ArgumentError, "#{resource} is not supported"
+        end
+
+      data = @api.show(model.api_resource, id)
+      data = data[resource.to_sym] || data
+      model.normalize({}, data)
+      data[:id] = id
+
+      # flatten monitor options so they are all on the base
+      if resource == "monitor"
+        data.merge!(data.delete(:options))
+        data.merge!(data.delete(:thresholds) || {})
+        data = data.slice(*model.instance_methods)
       end
+
+      <<~RUBY
+        #{model.name}.new(
+          self,
+          #{pretty_print(data).lstrip}
+        )
+      RUBY
     end
 
     private
 
     def pretty_print(hash)
-      list = hash.sort_by { |k, _| SORT_ORDER.index(k) || 999 }
+      list = hash.sort_by { |k, _| [SORT_ORDER.index(k) || 999, k] } # important to the front and rest deterministic
       list.map do |k, v|
         case v
         when Hash, Array

data/lib/kennel/models/base.rb

@@ -53,6 +53,38 @@ module Kennel
           supported = @set.map(&:inspect)
           raise ArgumentError, "Unsupported setting #{name.inspect}, supported settings are #{supported.join(", ")}"
         end
+
+        private
+
+        def normalize(_expected, actual)
+          self::READONLY_ATTRIBUTES.each { |k| actual.delete k }
+        end
+
+        # discard styles/conditional_formats/aggregator if nothing would change when we applied (both are default or nil)
+        def ignore_request_defaults(expected, actual, level1, level2)
+          (actual[level1] || []).each_with_index do |a_w, wi|
+            a_r = a_w.dig(level2, :requests) || []
+            e_r = expected.dig(level1, wi, level2, :requests) || []
+            ignore_defaults e_r, a_r, REQUEST_DEFAULTS
+          end
+        end
+
+        def ignore_defaults(expected, actual, defaults)
+          (expected || []).each_with_index do |e, i|
+            a = actual[i] || {}
+            ignore_default(e, a, defaults)
+          end
+        end
+
+        def ignore_default(expected, actual, defaults)
+          definitions = [actual, expected]
+          defaults.each do |key, default|
+            if definitions.all? { |r| !r.key?(key) || r[key] == default }
+              actual.delete(key)
+              expected.delete(key)
+            end
+          end
+        end
       end
 
       def initialize(options = {})
@@ -86,7 +118,7 @@ module Kennel
         expected = as_json
         expected.delete(:id)
 
-        READONLY_ATTRIBUTES.each { |k| actual.delete k }
+        self.class.send(:normalize, expected, actual)
 
         HashDiff.diff(actual, expected, use_lcs: false)
       end
@@ -101,27 +133,6 @@ module Kennel
 
       private
 
-      # discard styles/conditional_formats/aggregator if nothing would change when we applied (both are default or nil)
-      def ignore_request_defaults(expected, actual, level1, level2)
-        expected[level1].each_with_index do |e_w, wi|
-          e_r = e_w.dig(level2, :requests) || []
-          a_r = actual.dig(level1, wi, level2, :requests) || []
-          ignore_defaults e_r, a_r, REQUEST_DEFAULTS
-        end
-      end
-
-      def ignore_defaults(expected, actual, defaults)
-        expected.each_with_index do |e, i|
-          next unless a = actual[i] # skip newly added
-          defaults.each do |key, default|
-            if [a, e].all? { |r| r[key].nil? || r[key] == default }
-              a.delete(key)
-              e.delete(key)
-            end
-          end
-        end
-      end
-
       # let users know which project/resource failed when something happens during diffing where the backtrace is hidden
       def invalid!(message)
         raise ValidationError, "#{tracking_id} #{message}"

data/lib/kennel/models/dash.rb

@@ -7,6 +7,10 @@ module Kennel
 
       API_LIST_INCOMPLETE = true
       SUPPORTED_GRAPH_OPTIONS = [:events, :markers].freeze
+      READONLY_ATTRIBUTES = (Base::READONLY_ATTRIBUTES + [:resource, :created_by, :read_only]).freeze
+      DEFINITION_DEFAULTS = { autoscale: true }.freeze
+      DASH_DEFAULTS = { template_variables: [] }.freeze
+
       settings :id, :title, :description, :graphs, :kennel_id, :graphs, :definitions
 
       defaults(
@@ -34,7 +38,6 @@ module Kennel
           id: id,
           title: "#{title}#{LOCK}",
           description: description,
-          read_only: false, # TODO: delete it instead
           template_variables: render_template_variables,
           graphs: render_graphs
         }
@@ -44,15 +47,20 @@ module Kennel
         @json
       end
 
-      def diff(actual)
-        actual.delete :resource
-        actual.delete :created_by
-        actual[:template_variables] ||= []
-        actual[:graphs].each do |g|
+      def self.normalize(expected, actual)
+        super
+
+        ignore_default expected, actual, DASH_DEFAULTS
+        (actual[:graphs] || {}).each do |g|
           g[:definition].delete(:status)
         end
-        ignore_request_defaults as_json, actual, :graphs, :definition
-        super
+        ignore_request_defaults expected, actual, :graphs, :definition
+
+        (actual[:graphs] || []).each_with_index do |a_g, i|
+          a_d = a_g[:definition] || {}
+          e_d = expected.dig(:graphs, i, :definition) || {}
+          ignore_default e_d, a_d, DEFINITION_DEFAULTS
+        end
       end
 
       def url(id)
@@ -64,7 +72,7 @@ module Kennel
       def validate_json(data)
         # check for bad variables
         # TODO: do the same check for apm_query and their group_by
-        variables = data.fetch(:template_variables).map { |v| "$#{v.fetch(:name)}" }
+        variables = (data[:template_variables] || []).map { |v| "$#{v.fetch(:name)}" }
         queries = data[:graphs].flat_map { |g| g[:definition][:requests].map { |r| r[:q] }.compact }
         bad = queries.grep_v(/(#{variables.map { |v| Regexp.escape(v) }.join("|")})\b/)
         if bad.any?
@@ -86,7 +94,7 @@ module Kennel
       end
 
       def render_graphs
-        all = definitions.map do |title, viz, type, queries, options = {}, ignored = nil|
+        definitions.map do |title, viz, type, queries, options = {}, ignored = nil|
           if ignored || (!title || !viz || !type || !queries || !options.is_a?(Hash))
             raise ArgumentError, "Expected exactly 5 arguments for each definition (title, viz, type, queries, options)"
           end
@@ -101,11 +109,6 @@ module Kennel
           end
           graph
         end + graphs
-
-        # TODO: solve this via ignore-defaults
-        all.each do |g|
-          g[:definition][:autoscale] = true unless g[:definition].key?(:autoscale)
-        end
       end
     end
   end

data/lib/kennel/models/monitor.rb

@@ -100,7 +100,8 @@ module Kennel
         Utils.path_to_url "/monitors##{id}/edit"
       end
 
-      def diff(actual)
+      def self.normalize(_expected, actual)
+        super
         options = actual.fetch(:options)
         options.delete(:silenced) # we do not manage silenced, so ignore it when diffing
         options[:escalation_message] ||= nil # unset field is not returned and would break the diff
@@ -125,8 +126,6 @@ module Kennel
 
         # nil or "" are not returned from the api
         options[:evaluation_delay] ||= nil
-
-        super
       end
 
       private

data/lib/kennel/models/screen.rb

@@ -11,6 +11,23 @@ module Kennel
         time: {},
         timeframe: "1h"
       }.freeze
+      READONLY_ATTRIBUTES = (Base::READONLY_ATTRIBUTES + [
+        :disableCog,
+        :disableEditing,
+        :isIntegration,
+        :isShared,
+        :original_title,
+        :read_only,
+        :resource,
+        :title,
+        :title_edited,
+        :created_by,
+        :board_bgtype,
+        :height,
+        :width,
+        :showGlobalTimeOnboarding
+      ]).freeze
+      SCREEN_DEFAULTS = { template_variables: [] }.freeze
 
       settings :id, :board_title, :description, :widgets, :kennel_id
 
@@ -46,22 +63,9 @@ module Kennel
         @json
       end
 
-      def diff(actual)
-        actual.delete(:disableCog)
-        actual.delete(:disableEditing)
-        actual.delete(:isIntegration)
-        actual.delete(:isShared)
-        actual.delete(:original_title)
-        actual.delete(:read_only)
-        actual.delete(:resource)
-        actual.delete(:title)
-        actual.delete(:title_edited)
-        actual.delete(:created_by)
-        actual.delete(:board_bgtype)
-        actual.delete(:height)
-        actual.delete(:width)
-        actual.delete(:showGlobalTimeOnboarding)
-        actual[:template_variables] ||= []
+      def self.normalize(expected, actual)
+        super
+
         (actual[:widgets] || []).each do |w|
           # api randomly returns time.live_span or timeframe or empty time hash
           if w.dig(:time, :live_span)
@@ -71,10 +75,9 @@ module Kennel
           COPIED_WIDGET_VALUES.each { |v| w.delete v }
         end
 
-        ignore_defaults as_json[:widgets], actual[:widgets], WIDGET_DEFAULTS
-        ignore_request_defaults as_json, actual, :widgets, :tile_def
-
-        super
+        ignore_default expected, actual, SCREEN_DEFAULTS
+        ignore_defaults expected[:widgets], actual[:widgets], WIDGET_DEFAULTS
+        ignore_request_defaults expected, actual, :widgets, :tile_def
       end
 
       def url(id)
@@ -98,7 +101,7 @@ module Kennel
         widgets.map do |widget|
           widget = widget_defaults(widget[:type]).merge(widget)
           if tile = widget[:tile_def]
-            tile[:autoscale] = true unless widget[:tile_def].key?(:autoscale)
+            tile[:autoscale] = true unless widget[:tile_def].key?(:autoscale) # TODO: use ignore_default
           end
           widget
         end

data/lib/kennel/unmuted_alerts.rb

@@ -7,7 +7,8 @@ module Kennel
     COLORS = {
       "Alert" => :red,
       "Warn" => :yellow,
-      "No Data" => :cyan
+      "No Data" => :cyan,
+      "Ignored" => :magenta # resolved but still broken
     }.freeze
 
     class << self

data/lib/kennel/utils.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 module Kennel
   module Utils
-    COLORS = { red: 31, green: 32, yellow: 33, cyan: 36, default: 0 }.freeze
+    COLORS = { red: 31, green: 32, yellow: 33, cyan: 36, magenta: 35, default: 0 }.freeze
 
     class TeeIO < IO
       def initialize(ios)

data/lib/kennel/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Kennel
-  VERSION = "1.18.2"
+  VERSION = "1.19.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kennel
 version: !ruby/object:Gem::Version
-  version: 1.18.2
+  version: 1.19.0
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-12 00:00:00.000000000 Z
+date: 2018-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday