kennel 1.146.0 → 1.147.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 135900ecb21e1299d4b8fb044235e58363e94b19739d782eb13a3b37f3ebec01
-  data.tar.gz: 9333524bd316ca81abbf42eb678d7c6fb9558bc7ad03e61534eb268e8a7d487e
+  metadata.gz: 7aa3215e281ade43456180bbdbe048939052d0238b1303705842cad7145b5457
+  data.tar.gz: ae9ec09767652ff2839da017731f7f7487e237cbea81d9cebb89f39351bd7cca
 SHA512:
-  metadata.gz: 6d935709f003f87021baae50e8dbc5701bdf98abb9a1b34562669a953ca768e1bcc6354d8eb2f006b0b16514091a550b23bef855b194027bc0179a070354be80
-  data.tar.gz: e4fce646569437007d027fbacfd0086a909f382a861f5c90c938251822b8fd0a1f0072af799d1cfcb1f5d8d570d0ec895a3e3d9ba5c1375ddf5ef6c9f7c29f85
+  metadata.gz: 0064bfa8723de2680d8a7dfd2d050018a040015efa8e57646039cbb825fb3278bbdf29ea8f60de4dc617d61b0ddc69bac4fa050fc125c10be413d1900eca7556
+  data.tar.gz: 5a1dc95851d870c5d00ab6d2b17c357572b44ab058ae87d486e6b4786797211fede1e6ef7dc935fc2e743f0ada6a942556f8222a4dc4b931047ffb7dbb07dc74

data/lib/kennel/models/record.rb

@@ -160,7 +160,7 @@ module Kennel
         bad = Kennel::Utils.all_keys(data).grep_v(Symbol).sort.uniq
         return if bad.empty?
         invalid!(
-          :hash_keys_must_be_symbols,
+          OptionalValidations::UNIGNORABLE,
           "Only use Symbols as hash keys to avoid permanent diffs when updating.\n" \
           "Change these keys to be symbols (usually 'foo' => 1 --> 'foo': 1)\n" \
           "#{bad.map(&:inspect).join("\n")}"

data/lib/kennel/optional_validations.rb

@@ -18,7 +18,7 @@ module Kennel
     end
 
     def invalid!(tag, message)
-      validation_errors << ValidationMessage.new(tag || OptionalValidations::UNIGNORABLE, message)
+      validation_errors << ValidationMessage.new(tag, message)
     end
 
     def self.valid?(parts)

data/lib/kennel/syncer/plan.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+module Kennel
+  class Syncer
+    Plan = Struct.new(:creates, :updates, :deletes) do
+      attr_writer :changes
+
+      def changes
+        @changes || (deletes + creates + updates).map(&:change) # roughly ordered in the way that update works
+      end
+
+      def empty?
+        (creates + updates + deletes).empty?
+      end
+    end
+
+    Change = Struct.new(:type, :api_resource, :tracking_id, :id)
+  end
+end

data/lib/kennel/syncer/{plan_displayer.rb → plan_printer.rb}

@@ -2,19 +2,19 @@
 
 module Kennel
   class Syncer
-    class PlanDisplayer
+    class PlanPrinter
       def initialize
         @attribute_differ = AttributeDiffer.new
       end
 
-      def display(internal_plan)
+      def print(plan)
         Kennel.out.puts "Plan:"
-        if internal_plan.empty?
+        if plan.empty?
           Kennel.out.puts Console.color(:green, "Nothing to do")
         else
-          print_changes "Create", internal_plan.creates, :green
-          print_changes "Update", internal_plan.updates, :yellow
-          print_changes "Delete", internal_plan.deletes, :red
+          print_changes "Create", plan.creates, :green
+          print_changes "Update", plan.updates, :yellow
+          print_changes "Delete", plan.deletes, :red
         end
       end
 

data/lib/kennel/syncer.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 require_relative "./syncer/matched_expected"
-require_relative "./syncer/plan_displayer"
+require_relative "./syncer/plan"
+require_relative "./syncer/plan_printer"
 require_relative "./syncer/resolver"
 require_relative "./syncer/types"
 
@@ -10,15 +11,7 @@ module Kennel
     DELETE_ORDER = ["dashboard", "slo", "monitor", "synthetics/tests"].freeze # dashboards references monitors + slos, slos reference monitors
     LINE_UP = "\e[1A\033[K" # go up and clear
 
-    Plan = Struct.new(:changes, keyword_init: true)
-
-    InternalPlan = Struct.new(:creates, :updates, :deletes) do
-      def empty?
-        creates.empty? && updates.empty? && deletes.empty?
-      end
-    end
-
-    Change = Struct.new(:type, :api_resource, :tracking_id, :id)
+    attr_reader :plan
 
     def initialize(api, expected, actual, filter:, strict_imports: true)
       @api = api
@@ -26,27 +19,16 @@ module Kennel
       @filter = filter
 
       @resolver = Resolver.new(expected: expected, filter: filter)
-
-      internal_plan = calculate_changes(expected: expected, actual: actual)
-      validate_changes(internal_plan)
-      @internal_plan = internal_plan
-
-      @warnings.each { |message| Kennel.out.puts Console.color(:yellow, "Warning: #{message}") }
-    end
-
-    def plan
-      ip = @internal_plan
-      Plan.new(
-        changes: (ip.creates + ip.updates + ip.deletes).map(&:change)
-      )
+      @plan = Plan.new(*calculate_changes(expected: expected, actual: actual))
+      validate_changes
     end
 
     def print_plan
-      PlanDisplayer.new.display(internal_plan)
+      PlanPrinter.new.print(plan)
     end
 
     def confirm
-      return false if internal_plan.empty?
+      return false if plan.empty?
       return true if ENV["CI"] || !Kennel.in.tty? || !Kennel.err.tty?
       Console.ask?("Execute Plan ?")
     end
@@ -54,7 +36,7 @@ module Kennel
     def update
       changes = []
 
-      internal_plan.deletes.each do |item|
+      plan.deletes.each do |item|
         message = "#{item.api_resource} #{item.tracking_id} #{item.id}"
         Kennel.out.puts "Deleting #{message}"
         @api.delete item.api_resource, item.id
@@ -62,7 +44,7 @@ module Kennel
         Kennel.out.puts "#{LINE_UP}Deleted #{message}"
       end
 
-      planned_actions = internal_plan.creates + internal_plan.updates
+      planned_actions = plan.creates + plan.updates
 
       # slos need to be updated first in case their timeframes changed
       # because datadog validates that update+create of slo alerts match an existing timeframe
@@ -86,16 +68,15 @@ module Kennel
         end
       end
 
-      Plan.new(changes: changes)
+      plan.changes = changes
+      plan
     end
 
     private
 
-    attr_reader :filter, :resolver, :internal_plan
+    attr_reader :filter, :resolver
 
     def calculate_changes(expected:, actual:)
-      @warnings = []
-
       Progress.progress "Diffing" do
         resolver.add_actual actual
         filter_actual! actual
@@ -129,7 +110,7 @@ module Kennel
         deletes.sort_by! { |item| DELETE_ORDER.index item.api_resource }
         updates.sort_by! { |item| DELETE_ORDER.index item.api_resource } # slo needs to come before slo alert
 
-        InternalPlan.new(creates, updates, deletes)
+        [creates, updates, deletes]
       end
     end
 
@@ -146,15 +127,16 @@ module Kennel
         if @strict_imports
           raise "Unable to find existing #{resource} with id #{id}\nIf the #{resource} was deleted, remove the `id: -> { #{id} }` line."
         else
-          @warnings << "#{resource} #{e.tracking_id} specifies id #{id}, but no such #{resource} exists. 'id' will be ignored. Remove the `id: -> { #{id} }` line."
+          message = "Warning: #{resource} #{e.tracking_id} specifies id #{id}, but no such #{resource} exists. 'id' will be ignored. Remove the `id: -> { #{id} }` line."
+          Kennel.err.puts Console.color(:yellow, message)
         end
       end
     end
 
     # We've already validated the desired objects ('generated') in isolation.
     # Now that we have made the plan, we can perform some more validation.
-    def validate_changes(internal_plan)
-      internal_plan.updates.each do |item|
+    def validate_changes
+      @plan.updates.each do |item|
         item.expected.validate_update!(item.diff)
       end
     end

data/lib/kennel/template_variables.rb

@@ -17,6 +17,8 @@ module Kennel
     # check for queries that do not use the variables and would be misleading
     # TODO: do the same check for apm_query and their group_by
     def validate_json(data)
+      super
+
       variables = (data[:template_variables] || []).map { |v| "$#{v.fetch(:name)}" }
       return if variables.empty?
 

data/lib/kennel/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kennel
 version: !ruby/object:Gem::Version
-  version: 1.146.0
+  version: 1.147.0
 platform: ruby
 authors:
 - Michael Grosser
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-26 00:00:00.000000000 Z
+date: 2023-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diff-lcs
@@ -113,7 +113,8 @@ files:
 - lib/kennel/subclass_tracking.rb
 - lib/kennel/syncer.rb
 - lib/kennel/syncer/matched_expected.rb
-- lib/kennel/syncer/plan_displayer.rb
+- lib/kennel/syncer/plan.rb
+- lib/kennel/syncer/plan_printer.rb
 - lib/kennel/syncer/resolver.rb
 - lib/kennel/syncer/types.rb
 - lib/kennel/tags_validation.rb