kennel 1.114.0 → 1.116.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1266c924cd004d26036f81424b92ca52cf0720f041a6cc1ee0a7d1533b19f93
-  data.tar.gz: 250117caacd886189bde046f5a8166746a8cd6b87c7330fc106954cf4c7fae20
+  metadata.gz: 593a47b9f5fd48c679f9980ce91e3c70e0255e6431412882b502b646ac68a6bb
+  data.tar.gz: f4db29cc39cfea1f06d7e46db25f41c164ee7396a9739765750d4172adb8e7b0
 SHA512:
-  metadata.gz: aba95188ef4c6c2b7e974f53ba60ad3aac21b29dcb353bc6b05790374ba0a0c4113c0dd316e1e84975723a8d4d4e117102c13d18e18ddf7050fa97931b506af8
-  data.tar.gz: 15903c3da36d10fd42220431da69ac76c7c95d1407771e2f7c5c6bb0dfe132c2054e32131ba12b149eb41c52ebfb17f3004bdc78aab6a54c7f28600515a08632
+  metadata.gz: 89183dd1763b2387b67f82b08e99433fdaf237a30dd89795dd97e338a17a7fc5109bac860b2ade4e0839b4f9a058d772e489fee670202b564ee1e883999b648e
+  data.tar.gz: 91da9b2df7e862bd7926cca5e7db1e97ffe02ad334e888b3ba51ee31ac41370c10934d2d4e1b5223e4f0f6d9e71ee1ba655f51b10fdfba4b02f677fc8fafd445

data/Readme.md

@@ -289,23 +289,27 @@ Remove the code that created the resource. The next update will delete it (see a
  ```
 
 ### Updating existing resources with id
-
 Setting `id` makes kennel take over a manually created datadog resource.
 When manually creating to import, it is best to remove the `id` and delete the manually created resource.
 
 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 many projects
-Having many projects (and their sub-resources) can quickly get out of hand.
+### Organizing projects with many resources
+When project files get too long, this structure can keep things bite-sized.
 
-Use this class structure to keep things organized:
 ```Ruby
 # projects/project_a/base.rb
 module ProjectA
   class Base < Kennel::Models::Project
     defaults(
       kennel_id: -> { "project_a" },
+      parts: -> {
+        [
+          Monitors::FooAlert.new(self),
+          ...
+        ]
+      }
       ...
 
 # projects/project_a/monitors/foo_alert.rb
@@ -315,6 +319,17 @@ module ProjectA
       ...
 ```
 
+### Updating a single project or resource
+
+- Use `PROJECT=<kennel_id>` for single project:
+
+  Use the projects `kennel_id` (and if none is set then snake_case of the class name including modules)
+  to refer to the project. For example for `class ProjectA` use `PROJECT=project_a` but for `Foo::ProjectA` use `foo_project_a`.
+
+- Use `TRACKING_ID=<project-kennel_id>:<resource-kennel_id>` for single resource:
+
+  Use the project kennel_id and the resources kennel_id, for example `class ProjectA` and `FooAlert` would give `project_a:foo_alert`.
+
 ### Skipping validations
 Some validations might be too strict for your usecase or just wrong, please [open an issue](https://github.com/grosser/kennel/issues) and
 to unblock use the `validate: -> { false }` option.
@@ -335,7 +350,7 @@ so they can be created in a single update and can be re-created if any of them i
 
 ### Debugging changes locally
  - rebase on updated `master` to not undo other changes
- - figure out project name by converting the class name to snake-case
+ - figure out project name by converting the class name to snake_case
  - run `PROJECT=foo bundle exec rake kennel:update_datadog` to test changes for a single project (monitors: remove mentions while debugging to avoid alert spam)
    - use `PROJECT=foo,bar,...` for multiple projects
 

data/lib/kennel/models/project.rb

@@ -11,18 +11,29 @@ module Kennel
       def self.file_location
         @file_location ||= begin
           method_in_file = instance_methods(false).first
+          return if method_in_file.nil?
+
           instance_method(method_in_file).source_location.first.sub("#{Bundler.root}/", "")
         end
       end
 
       def validated_parts
         all = parts
+        unless all.is_a?(Array) && all.all? { |part| part.is_a?(Record) }
+          invalid! "#parts must return an array of Records"
+        end
+
         validate_parts(all)
         all
       end
 
       private
 
+      # let users know which project/resource failed when something happens during diffing where the backtrace is hidden
+      def invalid!(message)
+        raise ValidationError, "#{kennel_id} #{message}"
+      end
+
       # hook for users to add custom validations via `prepend`
       def validate_parts(parts)
       end

data/lib/kennel/progress.rb

@@ -7,12 +7,12 @@ module Kennel
     def self.progress(name)
       Kennel.err.print "#{name} ... "
 
-      animation = "-\\|/"
-      count = 0
       stop = false
       result = nil
 
       spinner = Thread.new do
+        animation = "-\\|/"
+        count = 0
         loop do
           break if stop
           Kennel.err.print animation[count % animation.size]
@@ -30,7 +30,7 @@ module Kennel
 
       result
     ensure
-      stop = true
+      stop = true # make thread stop without killing it
     end
   end
 end

data/lib/kennel/settings_as_methods.rb

@@ -4,11 +4,15 @@ module Kennel
     SETTING_OVERRIDABLE_METHODS = [].freeze
 
     AS_PROCS = ->(options) do
+      # Fragile; depends on the fact that in both locations where AS_PROCS is
+      # used, we're 2 frames away from the user code.
+      file, line, = caller(2..2).first.split(":", 3)
+
       options.transform_values do |v|
         if v.class == Proc
           v
         else
-          -> { v }
+          eval "-> { v }", nil, file, line.to_i
         end
       end
     end

data/lib/kennel/syncer.rb

@@ -4,9 +4,10 @@ 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
 
-    def initialize(api, expected, project_filter: nil)
+    def initialize(api, expected, project_filter: nil, tracking_id_filter: nil)
       @api = api
       @project_filter = project_filter
+      @tracking_id_filter = tracking_id_filter
       @expected = Set.new expected # need set to speed up deletion
       calculate_diff
       validate_plan
@@ -105,7 +106,7 @@ module Kennel
 
       Progress.progress "Diffing" do
         populate_id_map @expected, actual
-        filter_actual_by_project! actual
+        filter_actual! actual
         resolve_linked_tracking_ids! @expected # resolve dependencies to avoid diff
 
         @expected.each(&:add_tracking_id) # avoid diff with actual
@@ -261,11 +262,12 @@ module Kennel
         next unless tracking_id = a.fetch(:tracking_id)
 
         # ignore when deleted from the codebase
-        # (when running with project filter we cannot see the other resources in the codebase)
+        # (when running with filters we cannot see the other resources in the codebase)
         api_resource = a.fetch(:klass).api_resource
         next if
           !@id_map.get(api_resource, tracking_id) &&
-          (!project_prefixes || tracking_id.start_with?(*project_prefixes))
+          (!project_prefixes || tracking_id.start_with?(*project_prefixes)) &&
+          (!@tracking_id_filter || @tracking_id_filter.include?(tracking_id))
 
         @id_map.set(api_resource, tracking_id, a.fetch(:id))
         if a[:klass].api_resource == "synthetics/tests"
@@ -278,12 +280,18 @@ module Kennel
       list.each { |e| e.resolve_linked_tracking_ids!(@id_map, force: force) }
     end
 
-    def filter_actual_by_project!(actual)
-      return unless @project_filter
-      project_prefixes = @project_filter&.map { |p| "#{p}:" }
-      actual.select! do |a|
-        tracking_id = a.fetch(:tracking_id)
-        !tracking_id || tracking_id.start_with?(*project_prefixes)
+    def filter_actual!(actual)
+      if @tracking_id_filter
+        actual.select! do |a|
+          tracking_id = a.fetch(:tracking_id)
+          !tracking_id || @tracking_id_filter.include?(tracking_id)
+        end
+      elsif @project_filter
+        project_prefixes = @project_filter.map { |p| "#{p}:" }
+        actual.select! do |a|
+          tracking_id = a.fetch(:tracking_id)
+          !tracking_id || tracking_id.start_with?(*project_prefixes)
+        end
       end
     end
   end

data/lib/kennel/version.rb

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

data/lib/kennel.rb

@@ -65,13 +65,22 @@ module Kennel
 
     def store(parts)
       Progress.progress "Storing" do
-        old = Dir["generated/{#{(project_filter || ["**"]).join(",")}}/*"]
+        old = Dir[[
+          "generated",
+          if project_filter || tracking_id_filter
+            [
+              "{" + (project_filter || ["*"]).join(",") + "}",
+              "{" + (tracking_id_filter || ["*"]).join(",") + "}.json"
+            ]
+          else
+            "**"
+          end
+        ].join("/")]
         used = []
 
         Utils.parallel(parts, max: 2) do |part|
           path = "generated/#{part.tracking_id.tr("/", ":").sub(":", "/")}.json"
-          used << File.dirname(path) # only 1 level of sub folders, so this is safe
-          used << path
+          used.concat [File.dirname(path), path] # only 1 level of sub folders, so this is safe
           payload = part.as_json.merge(api_resource: part.class.api_resource)
           write_file_if_necessary(path, JSON.pretty_generate(payload) << "\n")
         end
@@ -94,7 +103,7 @@ module Kennel
     end
 
     def syncer
-      @syncer ||= Syncer.new(api, generated, project_filter: project_filter)
+      @syncer ||= Syncer.new(api, generated, project_filter: project_filter, tracking_id_filter: tracking_id_filter)
     end
 
     def api
@@ -105,22 +114,12 @@ module Kennel
       @generated ||= begin
         Progress.progress "Generating" do
           load_all
-          known = []
-          filter = project_filter
-
-          parts = Utils.parallel(Models::Project.recursive_subclasses) do |project_class|
-            project = project_class.new
-            kennel_id = project.kennel_id
-            if filter
-              known << kennel_id
-              next [] unless filter.include?(kennel_id)
-            end
-            project.validated_parts
-          end.flatten(1)
-
-          if filter && parts.empty?
-            raise "#{filter.join(", ")} does not match any projects, try any of these:\n#{known.uniq.sort.join("\n")}"
-          end
+
+          projects = Models::Project.recursive_subclasses.map(&:new)
+          filter_resources!(projects, :kennel_id, project_filter, "projects", "PROJECT")
+
+          parts = Utils.parallel(projects, &:validated_parts).flatten(1)
+          filter_resources!(parts, :tracking_id, tracking_id_filter, "resources", "TRACKING_ID")
 
           parts.group_by(&:tracking_id).each do |tracking_id, same|
             next if same.size == 1
@@ -139,7 +138,25 @@ module Kennel
     end
 
     def project_filter
-      ENV["PROJECT"]&.split(",")
+      raise "either use PROJECT= or TRACKING_ID=" if ENV["PROJECT"] && ENV["TRACKING_ID"]
+      ENV["PROJECT"]&.split(",") || tracking_id_filter&.map { |id| id.split(":", 2).first }
+    end
+
+    def tracking_id_filter
+      (tracking_id = ENV["TRACKING_ID"]) && tracking_id.split(",")
+    end
+
+    def filter_resources!(resources, by, against, name, env)
+      return unless against
+
+      before = resources.dup
+      resources.select! { |p| against.include?(p.send(by)) }
+      return if resources.size == against.size
+
+      raise <<~MSG.rstrip
+        #{env}=#{against.join(",")} matched #{resources.size} #{name}, try any of these:
+        #{before.map(&by).sort.uniq.join("\n")}
+      MSG
     end
 
     def load_all
@@ -148,7 +165,7 @@ module Kennel
       Dir.exist?("parts") && loader.push_dir("parts")
       loader.setup
 
-      # TODO: also do projects and update expected path too
+      # TODO: also auto-load projects and update expected path too
       ["projects"].each do |folder|
         Dir["#{folder}/**/*.rb"].sort.each { |f| require "./#{f}" }
       end

data/template/Readme.md

@@ -271,23 +271,27 @@ Remove the code that created the resource. The next update will delete it (see a
  ```
 
 ### Updating existing resources with id
-
 Setting `id` makes kennel take over a manually created datadog resource.
 When manually creating to import, it is best to remove the `id` and delete the manually created resource.
 
 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 many projects
-Having many projects (and their sub-resources) can quickly get out of hand.
+### Organizing projects with many resources
+When project files get too long, this structure can keep things bite-sized.
 
-Use this class structure to keep things organized:
 ```Ruby
 # projects/project_a/base.rb
 module ProjectA
   class Base < Kennel::Models::Project
     defaults(
       kennel_id: -> { "project_a" },
+      parts: -> {
+        [
+          Monitors::FooAlert.new(self),
+          ...
+        ]
+      }
       ...
 
 # projects/project_a/monitors/foo_alert.rb
@@ -297,6 +301,17 @@ module ProjectA
       ...
 ```
 
+### Updating a single project or resource
+
+- Use `PROJECT=<kennel_id>` for single project:
+
+  Use the projects `kennel_id` (and if none is set then snake_case of the class name including modules)
+  to refer to the project. For example for `class ProjectA` use `PROJECT=project_a` but for `Foo::ProjectA` use `foo_project_a`.
+
+- Use `TRACKING_ID=<project-kennel_id>:<resource-kennel_id>` for single resource:
+
+  Use the project kennel_id and the resources kennel_id, for example `class ProjectA` and `FooAlert` would give `project_a:foo_alert`.
+
 ### Skipping validations
 Some validations might be too strict for your usecase or just wrong, please [open an issue](https://github.com/grosser/kennel/issues) and
 to unblock use the `validate: -> { false }` option.
@@ -317,7 +332,7 @@ so they can be created in a single update and can be re-created if any of them i
 
 ### Debugging changes locally
  - rebase on updated `master` to not undo other changes
- - figure out project name by converting the class name to snake-case
+ - figure out project name by converting the class name to snake_case
  - run `PROJECT=foo bundle exec rake kennel:update_datadog` to test changes for a single project (monitors: remove mentions while debugging to avoid alert spam)
    - use `PROJECT=foo,bar,...` for multiple projects
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kennel
 version: !ruby/object:Gem::Version
-  version: 1.114.0
+  version: 1.116.0
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-11 00:00:00.000000000 Z
+date: 2022-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday