kennel 1.68.0 → 1.72.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb534c9bfadda4d374201e3e6b00eddbe5596af1376b8e11e071b27c7d1eaa28
-  data.tar.gz: 33566de8715eb98743470f5d40f9e77744a1932de3900652cf8f01b72ffbe5f6
+  metadata.gz: 1406c5a505ce76ac2af360ba94344a9c942b9c84381f5c695ff18015c62ca530
+  data.tar.gz: 04c66c7a56702edd27248c9c71a5c9aa87787c65714aa95112b8479bc5e3fc59
 SHA512:
-  metadata.gz: 57b28c3702ce5bf31b81dcfc104e61cb4ef936564df0575ef65812dc0d2224202c71d120f53b82527464dd50f545388e7d130600941b2fb75e9e2361b1dc499a
-  data.tar.gz: 97b1954e09f674ce834ad717fa90112f8e1e905d244040b0d2360b41f0bfde0955da5d69a86985964525efd2aa89ee13fdcbd22beffcbea2911aa5a795906788
+  metadata.gz: 0d0b0abc841eca42e4e13a67634c22653bb56f212304baff189344339a8aeaa877eb753dbd06c5989c938b53eb5ff5c9b3764c726556aebdf5ec20c379498922
+  data.tar.gz: 1458d96d7d17b04beae03734106d305e55c05006de958c0eb54b2e2ab982b7646209a8d4331604b02a754fb84ccee346525a330a18161b14fc604006478067e3

data/Readme.md

@@ -23,7 +23,7 @@ Manage datadog monitors/dashboards/slos as code
     ```
  - add a basic projects and teams so others can copy-paste to get started
  - setup travis build for your repo
- - uncomment `.travis.yml` section for automated github PR feedback and datadog updates on merge
+ - uncomment `.travis.yml` section for automated PR planing and datadog updates on merge
  - follow `Setup` in your repos Readme.md
 <!-- NOT IN -->
 
@@ -72,7 +72,7 @@ end
 ### Updating an existing monitor
  - use [datadog monitor UI](https://app.datadoghq.com/monitors/manage) to find a monitor
  - get the `id` from the url
- - run `RESOURCE=monitor ID=12345 bundle exec rake kennel:import` and copy the output
+ - run `URL='https://app.datadoghq.com/monitors/123' bundle exec rake kennel:import` and copy the output
  - find or create a project in `projects/`
  - add the monitor to `parts: [` list, for example:
   ```Ruby
@@ -118,7 +118,7 @@ end
 ### Updating an existing dashboard
  - go to [datadog dashboard UI](https://app.datadoghq.com/dashboard/lists) and click on _New Dashboard_ to find a dashboard
  - get the `id` from the url
- - run `RESOURCE=dashboard ID=abc-def-ghi bundle exec rake kennel:import` and copy the output
+ - run `URL='https://app.datadoghq.com/dashboard/bet-foo-bar' bundle exec rake kennel:import` and copy the output
  - find or create a project in `projects/`
  - add a dashboard to `parts: [` list, for example:
   ```Ruby

data/lib/kennel/github_reporter.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# Not used in here, but in our templated repo ... so keeping it around for now.
 module Kennel
   class GithubReporter
     MAX_COMMENT_SIZE = 65536

data/lib/kennel/models/dashboard.rb

@@ -16,12 +16,13 @@ module Kennel
       TIMESERIES_DEFAULTS = { show_legend: false, legend_size: "0" }.freeze
       SUPPORTED_DEFINITION_OPTIONS = [:events, :markers, :precision].freeze
 
-      settings :title, :description, :definitions, :widgets, :layout_type
+      settings :title, :description, :definitions, :widgets, :layout_type, :template_variable_presets
 
       defaults(
         description: -> { "" },
         definitions: -> { [] },
         widgets: -> { [] },
+        template_variable_presets: -> { [] },
         id: -> { nil }
       )
 
@@ -102,6 +103,7 @@ module Kennel
           title: "#{title}#{LOCK}",
           description: description,
           template_variables: render_template_variables,
+          template_variable_presets: template_variable_presets,
           widgets: all_widgets
         }
 
@@ -116,6 +118,10 @@ module Kennel
         Utils.path_to_url "/dashboard/#{id}"
       end
 
+      def self.parse_url(url)
+        url[/\/dashboard\/([a-z\d-]+)/, 1]
+      end
+
       def resolve_linked_tracking_ids(id_map)
         widgets = as_json[:widgets].flat_map { |w| [w, *w.dig(:definition, :widgets) || []] }
         widgets.each do |widget|
@@ -163,6 +169,10 @@ module Kennel
         super
 
         validate_template_variables data, :widgets
+
+        # Avoid diff from datadog presets sorting.
+        presets = data[:template_variable_presets]
+        invalid! "template_variable_presets must be sorted by name" if presets != presets.sort_by { |p| p[:name] }
       end
 
       def render_definitions

data/lib/kennel/models/monitor.rb

@@ -120,6 +120,12 @@ module Kennel
         Utils.path_to_url "/monitors##{id}/edit"
       end
 
+      # datadog uses both / and # as separator in it's links
+      def self.parse_url(url)
+        return unless id = url[/\/monitors[\/#](\d+)/, 1]
+        Integer(id)
+      end
+
       def self.normalize(expected, actual)
         super
         options = actual.fetch(:options)

data/lib/kennel/models/record.rb

@@ -11,6 +11,14 @@ module Kennel
       settings :id, :kennel_id
 
       class << self
+        def parse_any_url(url)
+          subclasses.detect do |s|
+            if id = s.parse_url(url)
+              break s.api_resource, id
+            end
+          end
+        end
+
         private
 
         def normalize(_expected, actual)

data/lib/kennel/models/slo.rb

@@ -62,6 +62,10 @@ module Kennel
         Utils.path_to_url "/slo?slo_id=#{id}"
       end
 
+      def self.parse_url(url)
+        url[/\/slo\?slo_id=([a-z\d]+)/, 1]
+      end
+
       def resolve_linked_tracking_ids(id_map)
         as_json[:monitor_ids] = as_json[:monitor_ids].map do |id|
           id.is_a?(String) ? resolve_link(id, :monitor, id_map) : id

data/lib/kennel/syncer.rb

@@ -19,6 +19,7 @@ module Kennel
       end
       @expected.each { |e| add_tracking_id e }
       calculate_diff
+      prevent_irreversible_partial_updates
     end
 
     def plan
@@ -42,7 +43,6 @@ module Kennel
         Kennel.out.puts "Created #{e.class.api_resource} #{tracking_id(e.as_json)} #{e.url(reply.fetch(:id))}"
       end
 
-      block_irreversible_partial_updates
       @update.each do |id, e|
         @api.update e.class.api_resource, id, e.as_json
         Kennel.out.puts "Updated #{e.class.api_resource} #{tracking_id(e.as_json)} #{e.url(id)}"
@@ -151,7 +151,7 @@ module Kennel
       return if list.empty?
       list.each do |_, e, a, diff|
         api_resource = (e ? e.class.api_resource : a.fetch(:api_resource))
-        Kennel.out.puts Utils.color(color, "#{step} #{api_resource} #{tracking_id(e&.as_json || a)}")
+        Kennel.out.puts Utils.color(color, "#{step} #{api_resource} #{e&.tracking_id || tracking_id(a)}")
         print_diff(diff) if diff # only for update
       end
     end
@@ -159,12 +159,12 @@ module Kennel
     def print_diff(diff)
       diff.each do |type, field, old, new|
         if type == "+"
-          temp = new.inspect
-          new = old.inspect
+          temp = Utils.pretty_inspect(new)
+          new = Utils.pretty_inspect(old)
           old = temp
         else # ~ and -
-          old = old.inspect
-          new = new.inspect
+          old = Utils.pretty_inspect(old)
+          new = Utils.pretty_inspect(new)
         end
 
         if (old + new).size > 100
@@ -177,18 +177,30 @@ module Kennel
       end
     end
 
-    def block_irreversible_partial_updates
+    # Do not add tracking-id when working with existing ids on a branch,
+    # so resource do not get deleted from merges to master.
+    # Also make sure the diff still makes sense, by kicking out the now noop-update.
+    #
+    # Note: ideally we'd never add tracking in the first place, but at that point we do not know the diff yet
+    def prevent_irreversible_partial_updates
       return unless @project_filter
-      return if @update.none? do |_, e, _, diff|
-        e.id && diff.any? do |_, field, old, new = nil|
-          TRACKING_FIELDS.include?(field.to_sym) && tracking_value(old) != tracking_value(new)
+      @update.select! do |_, e, _, diff|
+        next true unless e.id # short circuit for performance
+
+        diff.select! do |field_diff|
+          (_, field, old, new) = field_diff
+          next true unless tracking_field?(field)
+
+          if (old_tracking = tracking_value(old))
+            old_tracking == tracking_value(new) || raise("do not update! (atm unreachable)")
+          else
+            field_diff[3] = remove_tracking_id(e) # make plan output match update
+            old != field_diff[3]
+          end
         end
+
+        !diff.empty?
       end
-      raise <<~TEXT
-        Updates with PROJECT= filter should not update tracking id in #{TRACKING_FIELDS.join("/")} of resources with a set `id:`,
-        since this makes them get deleted by a full update.
-        Remove the `id:` to test them out, which will result in a copy being created and later deleted.
-      TEXT
     end
 
     def resolve_linked_tracking_ids(actual)
@@ -212,6 +224,13 @@ module Kennel
       json[field] = "#{json[field]}\n-- Managed by kennel #{e.tracking_id} in #{e.project.class.file_location}, do not modify manually".lstrip
     end
 
+    def remove_tracking_id(e)
+      json = e.as_json
+      field = tracking_field(json)
+      value = json[field]
+      json[field] = value.dup.sub!(/\n?-- Managed by kennel .*/, "") || raise("did not find tracking id in #{value}")
+    end
+
     def tracking_id(a)
       tracking_value a[tracking_field(a)]
     end
@@ -223,5 +242,9 @@ module Kennel
     def tracking_field(a)
       TRACKING_FIELDS.detect { |f| a.key?(f) }
     end
+
+    def tracking_field?(field)
+      TRACKING_FIELDS.include?(field.to_sym)
+    end
   end
 end

data/lib/kennel/tasks.rb

@@ -68,7 +68,7 @@ namespace :kennel do
     Kennel.update
   end
 
-  desc "update if this is a push to the default branch, otherwise plan (report to github with GITHUB_TOKEN)"
+  desc "update if this is a push to the default branch, otherwise plan"
   task :travis do
     on_default_branch = (ENV["TRAVIS_BRANCH"] == (ENV["DEFAULT_BRANCH"] || "master"))
     is_push = (ENV["TRAVIS_PULL_REQUEST"] == "false")
@@ -79,9 +79,7 @@ namespace :kennel do
         "kennel:plan" # show plan in travis logs
       end
 
-    Kennel::GithubReporter.report(ENV["GITHUB_TOKEN"]) do
-      Rake::Task[task_name].invoke
-    end
+    Rake::Task[task_name].invoke
   end
 
   desc "show unmuted alerts filtered by TAG, for example TAG=team:foo"
@@ -111,12 +109,18 @@ namespace :kennel do
     end
   end
 
-  desc "Convert existing resources to copy-pastable definitions to import existing resources RESOURCE=[dashboard,monitor,slo] ID=1234"
+  desc "Convert existing resources to copy-pasteable definitions to import existing resources (call with URL= or call with RESOURCE= and ID=)"
   task import: :environment do
-    resource = ENV["RESOURCE"] || Kennel::Tasks.abort("Call with RESOURCE=dashboard or monitor or slo")
-    id = ENV["ID"] || Kennel::Tasks.abort("Call with ID=1234")
-    id = Integer(id) if id =~ /^\d+$/ # dashboards can have alphanumeric ids
-    puts Kennel::Importer.new(Kennel.send(:api)).import(resource, id)
+    if (id = ENV["ID"]) && (resource = ENV["RESOURCE"])
+      id = Integer(id) if id =~ /^\d+$/ # dashboards can have alphanumeric ids
+    elsif (url = ENV["URL"])
+      resource, id = Kennel::Models::Record.parse_any_url(url) || Kennel::Tasks.abort("Unable to parse url")
+    else
+      possible_resources = Kennel::Models::Record.subclasses.map(&:api_resource)
+      Kennel::Tasks.abort("Call with URL= or call with RESOURCE=#{possible_resources.join(" or ")} and ID=")
+    end
+
+    Kennel.out.puts Kennel::Importer.new(Kennel.send(:api)).import(resource, id)
   end
 
   desc "Dump ALL of datadog config as raw json ... useful for grep/search TYPE=slo|monitor|dashboard"

data/lib/kennel/utils.rb

@@ -19,6 +19,7 @@ module Kennel
           .gsub(/::/, "_") # Foo::Bar -> foo_bar
           .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2') # FOOBar -> foo_bar
           .gsub(/([a-z\d])([A-Z])/, '\1_\2') # fooBar -> foo_bar
+          .tr("-", "_") # foo-bar -> foo_bar
           .downcase
       end
 
@@ -142,6 +143,17 @@ module Kennel
         else []
         end
       end
+
+      # TODO: use awesome-print or similar, but it has too many monkey-patches
+      # https://github.com/amazing-print/amazing_print/issues/36
+      def pretty_inspect(object)
+        string = object.inspect
+        string.gsub!(/:([a-z_]+)=>/, "\\1: ")
+        10.times do
+          string.gsub!(/{(\S.*?\S)}/, "{ \\1 }") || break
+        end
+        string
+      end
     end
   end
 end

data/lib/kennel/version.rb

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

data/template/Readme.md

@@ -54,7 +54,7 @@ end
 ### Updating an existing monitor
  - use [datadog monitor UI](https://app.datadoghq.com/monitors/manage) to find a monitor
  - get the `id` from the url
- - run `RESOURCE=monitor ID=12345 bundle exec rake kennel:import` and copy the output
+ - run `URL='https://app.datadoghq.com/monitors/123' bundle exec rake kennel:import` and copy the output
  - find or create a project in `projects/`
  - add the monitor to `parts: [` list, for example:
   ```Ruby
@@ -100,7 +100,7 @@ end
 ### Updating an existing dashboard
  - go to [datadog dashboard UI](https://app.datadoghq.com/dashboard/lists) and click on _New Dashboard_ to find a dashboard
  - get the `id` from the url
- - run `RESOURCE=dashboard ID=abc-def-ghi bundle exec rake kennel:import` and copy the output
+ - run `URL='https://app.datadoghq.com/dashboard/bet-foo-bar' bundle exec rake kennel:import` and copy the output
  - find or create a project in `projects/`
  - add a dashboard to `parts: [` list, for example:
   ```Ruby

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kennel
 version: !ruby/object:Gem::Version
-  version: 1.68.0
+  version: 1.72.0
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-11 00:00:00.000000000 Z
+date: 2020-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday