kennel 1.103.0 → 1.105.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1325abc55c593c6537608b629a7a98de7ce05487bc3a066782bb1be1164268dd
-  data.tar.gz: 966282e916764aaaae5b6718a72d4070070d1ad3c2f6a43bbdf01c10e325d63c
+  metadata.gz: 15372f06919044f4751bb25a9aea5b965a16253145841c6b964ee8d109e14d26
+  data.tar.gz: 7f658ed4facabdf0100650a1298e83de855a35000b3ed4da8b12f23d7e108894
 SHA512:
-  metadata.gz: fec764b934ecad2aa76a9282eb937ceef1774d19d50b56d1597846c04afd050dac9fcc51566618169929eb0da77c25d6eb3ac18c9993872229d5404b5d6e3127
-  data.tar.gz: 85201a83ceed329e4bf71b4392ec086c3d18714d5f76eda00dbe2fa6a7e05482523b91e40405241241666f9982eddb5c167bd6b3bd9448a56d39f30392ccadba
+  metadata.gz: 6bf58efda2f995a5903c52f3e0ed58f756638c28009d3e172b34b456f3fc64c494f0bdbb789d147f368ab30ad004453c7a969c6eb644e610557a3874c0c56da7
+  data.tar.gz: d1e3d4eca303de897dee30c357f0e0a03ac0ff7fee9a1de8904c1749c43eb093aa309b0063e7146782d19928664ea0d6e497da7ed8dc92ca0d87da437db97ed2

data/Readme.md

@@ -10,7 +10,7 @@ Manage Datadog Monitors / Dashboards / Slos as code
  - No copy-pasting of ids to create new resources
  - Automated cleanup when removing code
  - [Helpers](#helpers) for automating common tasks
- 
+
 ### Applying changes
 
 ![](template/github/screen.png?raw=true)
@@ -49,8 +49,8 @@ class Bar < Kennel::Models::Project
   )
 end
 ```
-
 <!-- NOT IN template/Readme.md  -->
+
 ## Installation
  - create a new private `kennel` repo for your organization (do not fork this repo)
  - use the template folder as starting point:
@@ -74,6 +74,7 @@ end
 
 ## Workflows
 <!-- ONLY IN template/Readme.md
+
 ### Setup
  - clone the repo
  - `gem install bundler && bundle install`
@@ -81,7 +82,7 @@ end
  - open [Datadog API Settings](https://app.datadoghq.com/account/settings#api)
  - create a `API Key` or get an existing one from an admin, then add it to `.env` as `DATADOG_API_KEY`
  - open [Datadog API Settings](https://app.datadoghq.com/access/application-keys) and create a new key, then add it to `.env` as `DATADOG_APP_KEY=`
- - change the `DATADOG_SUBDOMAIN=app` in `.env` to your companies subdomain if you have one
+ - if you have a custom subdomain, change the `DATADOG_SUBDOMAIN=app` in `.env`
  - verify it works by running `rake plan`, it might show some diff, but should not crash
 -->
 
@@ -148,6 +149,10 @@ end
  - make a PR ... get reviewed ... merge
  - datadog is updated by CI
 
+### Deleting
+
+Remove the code that created the resource. The next update will delete it (see above for PR workflow).
+
 ### Adding a new dashboard
  - go to [datadog dashboard UI](https://app.datadoghq.com/dashboard/lists) and click on _New Dashboard_ to create a dashboard
  - see below

data/lib/kennel/api.rb

@@ -8,7 +8,8 @@ module Kennel
     def initialize(app_key, api_key)
       @app_key = app_key
       @api_key = api_key
-      @client = Faraday.new(url: "https://app.datadoghq.com") { |c| c.adapter :net_http_persistent }
+      url = Utils.path_to_url("", subdomain: "app")
+      @client = Faraday.new(url: url) { |c| c.adapter :net_http_persistent }
     end
 
     def show(api_resource, id, params = {})

data/lib/kennel/importer.rb

@@ -137,8 +137,8 @@ module Kennel
             pretty = convert_strings_to_heredoc(pretty)
 
             "\n#{pretty}\n  "
-          elsif k == :message
-            "\n    <<~TEXT\n#{v.each_line.map { |l| l.strip.empty? ? "\n" : "      #{l}" }.join}\n      \#{super()}\n    TEXT\n  "
+          elsif [:message, :description].include?(k)
+            "\n    <<~TEXT\n#{v.to_s.each_line.map { |l| l.strip.empty? ? "\n" : "      #{l}" }.join}\n      \#{super()}\n    TEXT\n  "
           elsif k == :tags
             " super() + #{v.inspect} "
           else

data/lib/kennel/models/dashboard.rb

@@ -6,7 +6,7 @@ module Kennel
       include OptionalValidations
 
       READONLY_ATTRIBUTES = superclass::READONLY_ATTRIBUTES + [
-        :author_handle, :author_name, :modified_at, :url, :is_read_only, :notify_list, :restricted_roles
+        :author_handle, :author_name, :modified_at, :deleted_at, :url, :is_read_only, :notify_list, :restricted_roles
       ]
       TRACKING_FIELD = :description
       REQUEST_DEFAULTS = {

data/lib/kennel/settings_as_methods.rb

@@ -40,7 +40,7 @@ module Kennel
       private
 
       def validate_setting_exist(name)
-        return if !@settings || @settings.include?(name)
+        return if @settings.include?(name)
         supported = @settings.map(&:inspect)
         raise ArgumentError, "Unsupported setting #{name.inspect}, supported settings are #{supported.join(", ")}"
       end

data/lib/kennel/syncer.rb

@@ -3,7 +3,6 @@ module Kennel
   class Syncer
     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
-    DEFAULT_BRANCH = "master"
 
     def initialize(api, expected, project: nil)
       @api = api
@@ -28,7 +27,6 @@ module Kennel
     def confirm
       return false if noop?
       return true if ENV["CI"] || !STDIN.tty?
-      warn_about_deleting_resources_with_id if @project_filter
       Utils.ask("Execute Plan ?")
     end
 
@@ -61,30 +59,6 @@ module Kennel
 
     private
 
-    # this is brittle/hacky since it relies on knowledge from the generation + git + branch knowledge
-    def warn_about_deleting_resources_with_id
-      @delete.each do |_, _, a|
-        tracking_id = a.fetch(:tracking_id)
-        api_resource = a.fetch(:klass).api_resource
-
-        file = "generated/#{tracking_id.sub(":", "/")}.json"
-        old = `true && git show #{DEFAULT_BRANCH}:#{file.shellescape} 2>&1` # true && to not crash on missing git
-
-        next unless $?.success?
-        old =
-          begin
-            JSON.parse(old)
-          rescue StandardError
-            false
-          end
-        next if !old || !old["id"]
-
-        Kennel.out.puts(
-          Utils.color(:red, "WARNING: deleting #{api_resource} #{tracking_id} will break #{DEFAULT_BRANCH} branch")
-        )
-      end
-    end
-
     # loop over items until everything is resolved or crash when we get stuck
     # this solves cases like composite monitors depending on each other or monitor->monitor slo->slo monitor chains
     def each_resolved(list)

data/lib/kennel/utils.rb

@@ -96,12 +96,9 @@ module Kennel
         result
       end
 
-      def path_to_url(path)
-        if subdomain = ENV["DATADOG_SUBDOMAIN"]
-          "https://#{subdomain}.datadoghq.com#{path}"
-        else
-          path
-        end
+      def path_to_url(path, subdomain: nil)
+        subdomain ||= (ENV["DATADOG_SUBDOMAIN"] || "app")
+        "https://#{subdomain}.datadoghq.com#{path}"
       end
 
       def parallel(items, max: 10)

data/lib/kennel/version.rb

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

data/lib/kennel.rb

@@ -2,7 +2,6 @@
 require "faraday"
 require "json"
 require "zeitwerk"
-require "shellwords"
 require "English"
 
 require "kennel/version"

data/template/Readme.md

@@ -10,7 +10,7 @@ Manage Datadog Monitors / Dashboards / Slos as code
  - No copy-pasting of ids to create new resources
  - Automated cleanup when removing code
  - [Helpers](#helpers) for automating common tasks
- 
+
 ### Applying changes
 
 ![](github/screen.png?raw=true)
@@ -50,7 +50,6 @@ class Bar < Kennel::Models::Project
 end
 ```
 
-
 ## Structure
  - `projects/` monitors/dashboards/etc scoped by project
  - `teams/` team definitions
@@ -58,6 +57,7 @@ end
  - `generated/` projects as json, to show current state and proposed changes in PRs
 
 ## Workflows
+
 ### Setup
  - clone the repo
  - `gem install bundler && bundle install`
@@ -131,6 +131,10 @@ end
  - make a PR ... get reviewed ... merge
  - datadog is updated by CI
 
+### Deleting
+
+Remove the code that created the resource. The next update will delete it (see above for PR workflow).
+
 ### Adding a new dashboard
  - go to [datadog dashboard UI](https://app.datadoghq.com/dashboard/lists) and click on _New Dashboard_ to create a dashboard
  - see below

metadata

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