kennel 1.117.1 → 1.118.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cb7a96d8fed145f6db8ab76ee7cac6287f24af57ee8bc785707830548e07a76
-  data.tar.gz: '076522890c0d40993b8f6a676e106da15b145df4e3361e851f7bc70d38ed096c'
+  metadata.gz: 307545b12b594343bcd2fdc3ec46736e76c2cbc44a16e13eec8d9fd1ab7071b9
+  data.tar.gz: dae53fe1fc68395b4945eb3c664afc7655abe5f8434385e634b39760fbc5fd5e
 SHA512:
-  metadata.gz: 18c8879eaa8aff627087b164156127ac6358060985e1adb79d1a8fe9994b23647d17fe629bdd99fb8c2410f8685c17500e4a890611dd5d028f43185caef1e0e8
-  data.tar.gz: 1ab7202e9152b7e71aee2d40b42b3fdf91ea2c2af5290152f147254895e79c83b40da015efef7e5b8855b72fe49cde96c0c4e127ba80108a388966ccae4dbe39
+  metadata.gz: 347f7c2611e987fb30335917cbd14281111f0083f5aef023422881c8e3d86b0ad71d5d71daa60a686b69e08454aec43fcc9499a49b02a01117f17fbd8e80aa29
+  data.tar.gz: e5205665b571cd51c82ad48f34e56bd1813d94632fa3e71f0318e0eb26c36b04e7d9ce057af8e20d14fd568f826d6df499805be1b77e5584c61ef36a4111ac70

data/lib/kennel/compatibility.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Kennel
+  module Compatibility
+    def self.included(into)
+      class << into
+        %I[out out= err err= strict_imports strict_imports= generate plan update].each do |sym|
+          define_method(sym) { |*args| instance.public_send(sym, *args) }
+        end
+
+        def build_default
+          Kennel::Engine.new
+        end
+
+        def instance
+          @instance ||= build_default
+        end
+
+        private
+
+        def api
+          instance.send(:api)
+        end
+      end
+    end
+  end
+end

data/lib/kennel/models/record.rb

@@ -2,6 +2,22 @@
 module Kennel
   module Models
     class Record < Base
+      # Apart from if you just don't like the default for some reason,
+      # overriding MARKER_TEXT allows for namespacing within the same
+      # Datadog account. If you run one Kennel setup with marker text
+      # A and another with marker text B (assuming that A isn't a
+      # substring of B and vice versa), then the two Kennel setups will
+      # operate independently of each other, not trampling over each
+      # other's objects.
+      #
+      # This could be useful for allowing multiple products / projects
+      # / teams to share a Datadog account but otherwise largely
+      # operate independently of each other. In particular, it can be
+      # useful for running a "dev" or "staging" instance of Kennel
+      # in the same account as, but mostly isolated from, a "production"
+      # instance.
+      MARKER_TEXT = ENV.fetch("KENNEL_MARKER_TEXT", "Managed by kennel")
+
       LOCK = "\u{1F512}"
       TRACKING_FIELDS = [:message, :description].freeze
       READONLY_ATTRIBUTES = [
@@ -28,14 +44,14 @@ module Kennel
         end
 
         def parse_tracking_id(a)
-          a[self::TRACKING_FIELD].to_s[/-- Managed by kennel (#{ALLOWED_KENNEL_ID_FULL})/, 1]
+          a[self::TRACKING_FIELD].to_s[/-- #{Regexp.escape(MARKER_TEXT)} (#{ALLOWED_KENNEL_ID_FULL})/, 1]
         end
 
         # TODO: combine with parse into a single method or a single regex
         def remove_tracking_id(a)
           value = a[self::TRACKING_FIELD]
           a[self::TRACKING_FIELD] =
-            value.dup.sub!(/\n?-- Managed by kennel .*/, "") ||
+            value.dup.sub!(/\n?-- #{Regexp.escape(MARKER_TEXT)} .*/, "") ||
             raise("did not find tracking id in #{value}")
         end
 
@@ -92,11 +108,11 @@ module Kennel
       def add_tracking_id
         json = as_json
         if self.class.parse_tracking_id(json)
-          invalid! "remove \"-- Managed by kennel\" line it from #{self.class::TRACKING_FIELD} to copy a resource"
+          invalid! "remove \"-- #{MARKER_TEXT}\" line it from #{self.class::TRACKING_FIELD} to copy a resource"
         end
         json[self.class::TRACKING_FIELD] =
           "#{json[self.class::TRACKING_FIELD]}\n" \
-          "-- Managed by kennel #{tracking_id} in #{project.class.file_location}, do not modify manually".lstrip
+          "-- #{MARKER_TEXT} #{tracking_id} in #{project.class.file_location}, do not modify manually".lstrip
       end
 
       def remove_tracking_id

data/lib/kennel/syncer.rb

@@ -7,6 +7,9 @@ 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(:noop?, :no_change, :create, :update, :delete, keyword_init: true)
+    Update = Struct.new(:update_log, keyword_init: true)
+
     def initialize(api, expected, project_filter: nil, tracking_id_filter: nil)
       @api = api
       @project_filter = project_filter
@@ -27,6 +30,14 @@ module Kennel
         print_plan "Update", @update, :yellow
         print_plan "Delete", @delete, :red
       end
+
+      Plan.new(
+        noop?: noop?,
+        no_change: @no_change,
+        create: @create,
+        update: @update,
+        delete: @delete
+      )
     end
 
     def confirm
@@ -36,12 +47,15 @@ module Kennel
     end
 
     def update
+      update_log = []
+
       each_resolved @create do |_, e|
         message = "#{e.class.api_resource} #{e.tracking_id}"
         Kennel.out.puts "Creating #{message}"
         reply = @api.create e.class.api_resource, e.as_json
         cache_metadata reply, e.class
         id = reply.fetch(:id)
+        update_log << [:create, e.class.api_resource, id]
         populate_id_map [], [reply] # allow resolving ids we could previously no resolve
         Kennel.out.puts "#{LINE_UP}Created #{message} #{e.class.url(id)}"
       end
@@ -50,6 +64,7 @@ module Kennel
         message = "#{e.class.api_resource} #{e.tracking_id} #{e.class.url(id)}"
         Kennel.out.puts "Updating #{message}"
         @api.update e.class.api_resource, id, e.as_json
+        update_log << [:update, e.class.api_resource, id]
         Kennel.out.puts "#{LINE_UP}Updated #{message}"
       end
 
@@ -58,8 +73,11 @@ module Kennel
         message = "#{klass.api_resource} #{a.fetch(:tracking_id)} #{id}"
         Kennel.out.puts "Deleting #{message}"
         @api.delete klass.api_resource, id
+        update_log << [:delete, klass.api_resource, id]
         Kennel.out.puts "#{LINE_UP}Deleted #{message}"
       end
+
+      Update.new(update_log: update_log)
     end
 
     private
@@ -103,6 +121,7 @@ module Kennel
       @warnings = []
       @update = []
       @delete = []
+      @no_change = []
       @id_map = IdMap.new
 
       actual = Progress.progress("Downloading definitions") { download_definitions }
@@ -133,7 +152,11 @@ module Kennel
           id = a.fetch(:id)
           if e
             diff = e.diff(a) # slow ...
-            @update << [id, e, a, diff] if diff.any?
+            if diff.any?
+              @update << [id, e, a, diff]
+            else
+              @no_change << [id, e, a]
+            end
           elsif a.fetch(:tracking_id) # was previously managed
             @delete << [id, nil, a]
           end

data/lib/kennel/tasks.rb

@@ -12,6 +12,44 @@ module Kennel
         Kennel.err.puts message if message
         raise SystemExit.new(1), message
       end
+
+      def load_environment
+        @load_environment ||= begin
+          require "kennel"
+          gem "dotenv"
+          require "dotenv"
+          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)
+          true
+        end
+      end
+
+      def ci
+        environment
+
+        if on_default_branch? && git_push?
+          Kennel.strict_imports = false
+          Kennel.update
+        else
+          Kennel.plan # show plan in CI logs
+        end
+      end
+
+      def on_default_branch?
+        branch = (ENV["TRAVIS_BRANCH"] || ENV["GITHUB_REF"]).to_s.sub(/^refs\/heads\//, "")
+        (branch == (ENV["DEFAULT_BRANCH"] || "master"))
+      end
+
+      def git_push?
+        (ENV["TRAVIS_PULL_REQUEST"] == "false" || ENV["GITHUB_EVENT_NAME"] == "push")
+      end
     end
   end
 end
@@ -71,18 +109,7 @@ namespace :kennel do
 
   desc "update on push to the default branch, otherwise show plan"
   task :ci do
-    branch = (ENV["TRAVIS_BRANCH"] || ENV["GITHUB_REF"]).to_s.sub(/^refs\/heads\//, "")
-    on_default_branch = (branch == (ENV["DEFAULT_BRANCH"] || "master"))
-    is_push = (ENV["TRAVIS_PULL_REQUEST"] == "false" || ENV["GITHUB_EVENT_NAME"] == "push")
-    task_name =
-      if on_default_branch && is_push
-        Kennel.strict_imports = false
-        "kennel:update_datadog"
-      else
-        "kennel:plan" # show plan in CI logs
-      end
-
-    Rake::Task[task_name].invoke
+    Kennel::Tasks.ci
   end
 
   desc "show unmuted alerts filtered by TAG, for example TAG=team:foo"
@@ -123,7 +150,7 @@ namespace :kennel do
 
     if ENV["FORMAT"] == "json"
       report = monitors.map do |m|
-        match = m[:message].to_s.match(/-- Managed by kennel (\S+:\S+) in (\S+), /) || []
+        match = m[:message].to_s.match(/-- #{Regexp.escape(Kennel::Models::Record::MARKER_TEXT)} (\S+:\S+) in (\S+), /) || []
         m.slice(:url, :name, :tags, :days_in_no_data).merge(
           kennel_tracking_id: match[1],
           kennel_source: match[2]
@@ -207,17 +234,6 @@ namespace :kennel do
   end
 
   task :environment do
-    require "kennel"
-    gem "dotenv"
-    require "dotenv"
-    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)
+    Kennel::Tasks.load_environment
   end
 end

data/lib/kennel/version.rb

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

data/lib/kennel.rb

@@ -5,6 +5,7 @@ require "zeitwerk"
 require "English"
 
 require "kennel/version"
+require "kennel/compatibility"
 require "kennel/utils"
 require "kennel/progress"
 require "kennel/syncer"
@@ -39,11 +40,17 @@ module Kennel
   class ValidationError < RuntimeError
   end
 
-  @out = $stdout
-  @err = $stderr
-  @strict_imports = true
+  include Kennel::Compatibility
+
+  UpdateResult = Struct.new(:plan, :update, keyword_init: true)
+
+  class Engine
+    def initialize
+      @out = $stdout
+      @err = $stderr
+      @strict_imports = true
+    end
 
-  class << self
     attr_accessor :out, :err, :strict_imports
 
     def generate
@@ -57,8 +64,12 @@ module Kennel
     end
 
     def update
-      syncer.plan
-      syncer.update if syncer.confirm
+      the_plan = syncer.plan
+      the_update = syncer.update if syncer.confirm
+      UpdateResult.new(
+        plan: the_plan,
+        update: the_update
+      )
     end
 
     private
@@ -164,6 +175,16 @@ module Kennel
     end
 
     def load_all
+      # load_all's purpose is to "require" all the .rb files under './projects',
+      # also with reference to ./teams and ./parts. What happens if you call it
+      # more than once?
+      #
+      # For a reason yet to be investigated, Zeitwerk rejects second and subsequent calls.
+      # But even if we skip over the Zeitwerk part, the nature of 'require' is
+      # somewhat one-way: we're not providing any mechanism to *un*load things.
+      # As long as the contents of `./projects`, `./teams` and `./parts` doesn't
+      # change between calls, then simply by no-op'ing subsequent calls to `load_all`
+      # we can have `load_all` appear to be idempotent.
       loader = Zeitwerk::Loader.new
       Dir.exist?("teams") && loader.push_dir("teams", namespace: Teams)
       Dir.exist?("parts") && loader.push_dir("parts")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kennel
 version: !ruby/object:Gem::Version
-  version: 1.117.1
+  version: 1.118.0
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-05 00:00:00.000000000 Z
+date: 2022-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diff-lcs
@@ -89,6 +89,7 @@ files:
 - Readme.md
 - lib/kennel.rb
 - lib/kennel/api.rb
+- lib/kennel/compatibility.rb
 - lib/kennel/file_cache.rb
 - lib/kennel/github_reporter.rb
 - lib/kennel/id_map.rb