kennel 1.66.2 → 1.70.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d5c7df715aecb3223069ef066f070a0b78dd699c46feae0052e90facc2ef0f5
-  data.tar.gz: d88d4f7b8ff2ec7458490fd79cf269bc319abf589c17ace29a4d368a29626b2d
+  metadata.gz: 857c5d57edd43c806560c9a97b579398f440ed311dd7b8541e1262af03de51bd
+  data.tar.gz: b75bf7667bcdd473732d1e69231a52a37bdd90366462890a85d39d6325004593
 SHA512:
-  metadata.gz: f7a603b340355a6be34c57d7843729dbdf9d27f910d94511ab4dc6c5a71c32a477160ebfe188fc03675bc28261dc9beb82f27faaceb4be355aceba343bbf5c54
-  data.tar.gz: e320fdfb09fc4f2400cdcad2f16297e6715dbb9094959e8fd50784bc7b1a4b880e65de806caaaa1b3e016ce90a4d8217e1c3e174b757cf6d83895273e5652b80
+  metadata.gz: 51662e560022e916c3b2e7254cb9dcc4ec331468f06cc29c47f45ea857c1dc49ded3496b9313a06073848abc782576c46d0bfcd410099ababdc5571a19cccc28
+  data.tar.gz: de5dd05943415b655efc290399417853a68477a81a88c098b4812d908e83a19ff06594dbb143f6b3120a41caca2cbbe8d86ef27a8eee449e2d34bc05b1da5140

data/Readme.md

@@ -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/models/dashboard.rb

@@ -34,14 +34,6 @@ module Kennel
           super
 
           widgets_pairs(expected, actual).each do |pair|
-            # datadog always adds 2 to slo widget height
-            # need to check fir layout since some monitors have height/width in their definition
-            pair[1].each do |widget|
-              if widget.dig(:definition, :type) == "slo" && widget.dig(:layout, :height)
-                widget[:layout][:height] -= 2
-              end
-            end
-
             # conditional_formats ordering is randomly changed by datadog, compare a stable ordering
             pair.each do |widgets|
               widgets.each do |widget|
@@ -124,6 +116,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|

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)
@@ -199,7 +205,7 @@ module Kennel
           allowed = data.fetch(:query)[/by\s*{([^\}]+)}/, 1].to_s.split(/\s*,\s*/)
           unsupported = used - allowed
           if unsupported.any?
-            invalid! "is_match used with unsupported dimensions #{unsupported}, allowed dimensions are #{allowed}"
+            invalid! "is_match used with #{unsupported}, but metric is only grouped by #{allowed}"
           end
         end
       end

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/settings_as_methods.rb

@@ -25,8 +25,7 @@ module Kennel
         names.each do |name|
           next if method_defined?(name)
           define_method name do
-            message = "Trying to call #{name} for #{self.class} but it was never set or passed as option"
-            raise_with_location ArgumentError, message
+            raise_with_location ArgumentError, "'#{name}' on #{self.class} was not set or passed as option"
           end
         end
       end

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

@@ -111,12 +111,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"
@@ -130,6 +136,14 @@ namespace :kennel do
     require "kennel"
     gem "dotenv"
     require "dotenv"
-    Dotenv.load
+    source = ".env"
+
+    # warn when users have things like DATADOG_TOKEN already set and it will not be loaded from .env
+    unless ENV["KENNEL_SILENCE_UPDATED_ENV"]
+      updated = Dotenv.parse(source).select { |k, v| ENV[k] && ENV[k] != v }
+      warn "Environment variables #{updated.keys.join(", ")} need to be unset to be sourced from #{source}" if updated.any?
+    end
+
+    Dotenv.load(source)
   end
 end

data/lib/kennel/utils.rb

@@ -142,6 +142,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.66.2"
+  VERSION = "1.70.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.66.2
+  version: 1.70.0
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-26 00:00:00.000000000 Z
+date: 2020-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: net-http-persistent-retry
+  name: net-http-persistent
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
 description: 
 email: michael@grosser.it
 executables: []
@@ -101,8 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: Keep datadog monitors/dashboards/etc in version control, avoid chaotic management