kennel 1.98.1 → 1.100.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d0b70ee90aae5a476b1e9a324e02346856e9d76881082d46a2b219efcfe2267
-  data.tar.gz: 86bc3f4777ec06a9b8c171e93ea95b50e9117a74283e3e6c1785d81e87889a4d
+  metadata.gz: 97207492f3f5afd31ab4d3b16db46f8b70a772c101c57bc26c7d135c9ece6a75
+  data.tar.gz: 6a2c515b9116f1da7764a0a509886fee28ec36241e982b425843f6bc64c02067
 SHA512:
-  metadata.gz: d0c6f38a11af7b0876a5637648fe16168aa4c5f6a16bba06f51322c240b02d520bd3abf566bf04b547df7431453d500f97be06b3a03da850ca5395b6ccf04bed
-  data.tar.gz: 45a77a1b2995f12da465a5b2ed64c6f21c93dba68b154367cf06c2a88202b648e223f0f1f80da7052e536b64f66a3cdc72a607fabfb913db3c7657f9e4000051
+  metadata.gz: a4304111e6d35d92ed2b1adbba277a39eb67e7b2e697a5b2cbd031731a1aa968477249f13a18377f7ea4af49bfafd8742060a3ab6c7b7161bb78fd9b63889972
+  data.tar.gz: 8a5588b35ef64e8a91354a5554866f5a59ca354d850ecd96c7d2d164cf79ffe8f6b8cf79ff0c3bc5d4108cba4a600211492ccd0c7033725dc3e2c0a4197e55ef

data/Readme.md

@@ -202,11 +202,11 @@ When manually creating to import, it is best to remove the `id` and delete the m
 When an `id` is set and the original resource is deleted, kennel will fail to update,
 removing the `id` will cause kennel to create a new resource in datadog.
 
-### Organizing large sub-projects / large organiations
+### Organizing many projects
 Having many projects (and their sub-resources) can quickly get out of hand.
 
 Use this class structure to keep things organized:
-```ruby
+```Ruby
 # projects/project_a/base.rb
 module ProjectA
   class Base < Kennel::Models::Project
@@ -217,7 +217,7 @@ module ProjectA
 # projects/project_a/monitors/foo_alert.rb
 module ProjectA
   module Monitors
-    class FooAlert < Kennel::Modesl::Monitor
+    class FooAlert < Kennel::Models::Monitor
       ...
 ```
 

data/lib/kennel/id_map.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module Kennel
+  class IdMap
+    NEW = :new # will be created during this run
+
+    def initialize
+      @map = Hash.new { |h, k| h[k] = {} }
+    end
+
+    def get(type, tracking_id)
+      @map[type][tracking_id]
+    end
+
+    def set(type, tracking_id, id)
+      @map[type][tracking_id] = id
+    end
+
+    def set_new(type, tracking_id)
+      @map[type][tracking_id] = NEW
+    end
+
+    def new?(type, tracking_id)
+      @map[type][tracking_id] == NEW
+    end
+  end
+end

data/lib/kennel/models/dashboard.rb

@@ -189,16 +189,17 @@ module Kennel
           when "uptime"
             if ids = definition[:monitor_ids]
               definition[:monitor_ids] = ids.map do |id|
-                tracking_id?(id) ? (resolve_link(id, :monitor, id_map, **args) || id) : id
+                resolve(id, :monitor, id_map, **args) || id
               end
             end
           when "alert_graph"
-            if (id = definition[:alert_id]) && tracking_id?(id)
-              definition[:alert_id] = (resolve_link(id, :monitor, id_map, **args) || id).to_s
+            if id = definition[:alert_id]
+              resolved = resolve(id, :monitor, id_map, **args) || id
+              definition[:alert_id] = resolved.to_s # even though it's a monitor id
             end
           when "slo"
-            if (id = definition[:slo_id]) && tracking_id?(id)
-              definition[:slo_id] = (resolve_link(id, :slo, id_map, **args) || id).to_s
+            if id = definition[:slo_id]
+              definition[:slo_id] = resolve(id, :slo, id_map, **args) || id
             end
           end
         end
@@ -206,10 +207,6 @@ module Kennel
 
       private
 
-      def tracking_id?(id)
-        id.is_a?(String) && id.include?(":")
-      end
-
       # creates queries from metadata to avoid having to keep q and expression in sync
       #
       # {q: :metadata, metadata: [{expression: "sum:bar", alias_name: "foo"}, ...], }

data/lib/kennel/models/monitor.rb

@@ -121,7 +121,7 @@ module Kennel
         when "composite", "slo alert"
           type = (as_json[:type] == "composite" ? :monitor : :slo)
           as_json[:query] = as_json[:query].gsub(/%{(.*?)}/) do
-            resolve_link($1, type, id_map, **args) || $&
+            resolve($1, type, id_map, **args) || $&
           end
         end
       end
@@ -214,27 +214,47 @@ module Kennel
         end
 
         if ["query alert", "service check"].include?(type) # TODO: most likely more types need this
-          # verify is_match/is_exact_match uses available variables
-          message = data.fetch(:message)
-          used = message.scan(/{{\s*([#^]is(?:_exact)?_match)\s*([^\s}]+)/)
-          if used.any?
-            allowed = data.fetch(:query)[/by\s*[({]([^})]+)[})]/, 1]
-              .to_s.gsub(/["']/, "").split(/\s*,\s*/)
-              .map! { |w| %("#{w}.name") }
-            used.uniq.each do |match, group|
-              next if allowed.include?(group)
-              invalid!(
-                "#{match} used with #{group}, but can only be used with #{allowed.join(", ")}. " \
-                "Group the query by #{group.sub(".name", "").tr('"', "")} or change the #{match}"
-              )
-            end
-          end
+          validate_message_variables(data)
         end
 
         unless ALLOWED_PRIORITY_CLASSES.include?(priority.class)
           invalid! "priority needs to be an Integer"
         end
       end
+
+      # verify is_match/is_exact_match and {{foo.name}} uses available variables
+      def validate_message_variables(data)
+        message = data.fetch(:message)
+
+        used =
+          message.scan(/{{\s*(?:[#^]is(?:_exact)?_match)\s*"([^\s}]+)"/) + # {{#is_match "environment.name" "production"}}
+          message.scan(/{{\s*([^}]+\.name)\s*}}/) # Pod {{pod.name}} failed
+        return if used.empty?
+        used.flatten!(1)
+        used.uniq!
+
+        # TODO
+        # - also match without by
+        # - separate parsers for query and service
+        # - service must always allow `host`, maybe others
+        return unless match = data.fetch(:query).match(/(?:{([^}]*)}\s*)?by\s*[({]([^})]+)[})]/)
+
+        allowed =
+          match[1].to_s.split(/\s*,\s*/).map { |k| k.split(":", 2)[-2] } + # {a:b} -> a TODO: does not work for service check
+          match[2].to_s.gsub(/["']/, "").split(/\s*,\s*/) # by {a} -> a
+
+        allowed.compact!
+        allowed.uniq!
+        allowed.map! { |w| "#{w.tr('"', "")}.name" }
+
+        forbidden = used - allowed
+        return if forbidden.empty?
+
+        invalid! <<~MSG.rstrip
+          Used #{forbidden.join(", ")} in the message, but can only be used with #{allowed.join(", ")}.
+          Group or filter the query by #{forbidden.map { |f| f.sub(".name", "") }.join(", ")} to use it.
+        MSG
+      end
     end
   end
 end

data/lib/kennel/models/record.rb

@@ -100,9 +100,20 @@ module Kennel
 
       private
 
+      def resolve(value, type, id_map, force:)
+        if tracking_id?(value)
+          return resolve_link(value, type, id_map, force: force)
+        end
+
+        value
+      end
+
+      def tracking_id?(id)
+        id.is_a?(String) && id.include?(":")
+      end
+
       def resolve_link(tracking_id, type, id_map, force:)
-        id = id_map[tracking_id]
-        if id == :new
+        if id_map.new?(type.to_s, tracking_id)
           if force
             invalid!(
               "#{type} #{tracking_id} was referenced but is also created by the current run.\n" \
@@ -111,7 +122,7 @@ module Kennel
           else
             nil # will be re-resolved after the linked object was created
           end
-        elsif id
+        elsif id = id_map.get(type.to_s, tracking_id)
           id
         else
           invalid! "Unable to find #{type} #{tracking_id} (does not exist and is not being created by the current run)"

data/lib/kennel/models/slo.rb

@@ -70,7 +70,7 @@ module Kennel
       def resolve_linked_tracking_ids!(id_map, **args)
         return unless as_json[:monitor_ids] # ignore_default can remove it
         as_json[:monitor_ids] = as_json[:monitor_ids].map do |id|
-          id.is_a?(String) ? (resolve_link(id, :monitor, id_map, **args) || id) : id
+          resolve(id, :monitor, id_map, **args) || id
         end
       end
 

data/lib/kennel/models/synthetic_test.rb

@@ -26,7 +26,7 @@ module Kennel
           type: type,
           subtype: subtype,
           options: options,
-          name: name,
+          name: "#{name}#{LOCK}",
           locations: locations == :all ? LOCATIONS : locations
         }
 

data/lib/kennel/syncer.rb

@@ -122,7 +122,7 @@ module Kennel
     def calculate_diff
       @update = []
       @delete = []
-      @id_map = {}
+      @id_map = IdMap.new
 
       actual = Progress.progress("Downloading definitions") { download_definitions }
 
@@ -254,11 +254,17 @@ module Kennel
     end
 
     def populate_id_map(expected, actual)
+      expected.each do |e|
+        @id_map.set_new(e.class.api_resource, e.tracking_id)
+      end
+
       actual.each do |a|
         next unless tracking_id = a.fetch(:tracking_id)
-        @id_map[tracking_id] = a.fetch(:id)
+        @id_map.set(a.fetch(:klass).api_resource, tracking_id, a.fetch(:id))
+        if a[:klass].api_resource == "synthetics/tests"
+          @id_map.set(Kennel::Models::Monitor.api_resource, tracking_id, a.fetch(:monitor_id))
+        end
       end
-      expected.each { |e| @id_map[e.tracking_id] ||= :new }
     end
 
     def resolve_linked_tracking_ids!(list, force: false)

data/lib/kennel/version.rb

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

data/lib/kennel.rb

@@ -9,6 +9,7 @@ require "kennel/version"
 require "kennel/utils"
 require "kennel/progress"
 require "kennel/syncer"
+require "kennel/id_map"
 require "kennel/api"
 require "kennel/github_reporter"
 require "kennel/subclass_tracking"

data/template/Readme.md

@@ -185,11 +185,11 @@ When manually creating to import, it is best to remove the `id` and delete the m
 When an `id` is set and the original resource is deleted, kennel will fail to update,
 removing the `id` will cause kennel to create a new resource in datadog.
 
-### Organizing large sub-projects / large organiations
+### Organizing many projects
 Having many projects (and their sub-resources) can quickly get out of hand.
 
 Use this class structure to keep things organized:
-```ruby
+```Ruby
 # projects/project_a/base.rb
 module ProjectA
   class Base < Kennel::Models::Project
@@ -200,7 +200,7 @@ module ProjectA
 # projects/project_a/monitors/foo_alert.rb
 module ProjectA
   module Monitors
-    class FooAlert < Kennel::Modesl::Monitor
+    class FooAlert < Kennel::Models::Monitor
       ...
 ```
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kennel
 version: !ruby/object:Gem::Version
-  version: 1.98.1
+  version: 1.100.0
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-29 00:00:00.000000000 Z
+date: 2021-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -77,6 +77,7 @@ files:
 - lib/kennel/api.rb
 - lib/kennel/file_cache.rb
 - lib/kennel/github_reporter.rb
+- lib/kennel/id_map.rb
 - lib/kennel/importer.rb
 - lib/kennel/models/base.rb
 - lib/kennel/models/dashboard.rb