kennel 1.16.2 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 617e550ae31d28ef32f0e46948246f78156fddde356a0c42bd6dfcacf63eac8d
-  data.tar.gz: d7e3b335b847c8bfe3d9a1cf2a4d967160539137ebe64704a5d71c7b5ac2ccda
+  metadata.gz: d354b23d7d94b5204db458729029fea0b9d2cce10689059b7818cfb42da4101b
+  data.tar.gz: 0c364c6db65fdf0d1fe462bc91930b6fbfeafc05f7ab152fe3d4584796fd1d57
 SHA512:
-  metadata.gz: 723d7464968287acb6157a59f3cebc30322c17c92dfad47a9e1a49c63a4c5ab3a490b1a13bc179591c30c424b57ac28410526c493bc80ca34b5084ec8f3b65ba
-  data.tar.gz: 62cf68ab5ef460ece823a3ac014542692afabb8980c84f584af1b5de73230508039ab634bfcfa480f1608b6a7b9039734de5ef98b337e82a596540d82092d3b5
+  metadata.gz: 21149b9899661a927d688f5db2b71702cecf6ced3998b40d7ed03917487bcaa63c11fe581004959840c319f3b5fc228a7b8ae59f3639bdb67ee77b1d14ff5f12
+  data.tar.gz: 9e7e174417f5a884acf06f45a03dee86fc23fe95d41cd2df993ca1e4e20fa7e72eaffc754becc0f4452ea2d3a75037dd9d43eb11ea722ed7788d62a06d17a1c3

data/Readme.md

@@ -15,7 +15,7 @@ Keep datadog monitors/dashboards/etc in version control, avoid chaotic managemen
 
  - create a new private `kennel` repo for your organization (do not fork this repo)
  - use the template folder as starting point:
-    ```
+    ```Bash
     git clone git@github.com:your-org/kennel.git
     git clone git@github.com:grosser/kennel.git seed
     mv seed/teamplate/* kennel/
@@ -47,7 +47,7 @@ Keep datadog monitors/dashboards/etc in version control, avoid chaotic managemen
 
 ### Adding a team
 
-```ruby
+```Ruby
 # teams/my_team.rb
 module Teams
   class MyTeam < Kennel::Models::Team
@@ -145,6 +145,14 @@ end
   end
  ```
 
+### Importing an existing resources
+
+```Bash
+RESOURCE=dash ID=12345 rake kennel:import
+```
+
+Put returned definition into a project of your choice.
+
 ### Adding a new screenboard
  - similar to `dash.rb`
  - add to `parts:` list
@@ -164,7 +172,7 @@ end
 
 ### Skipping validations
 
-Some validations might be too strict for your usecase or just wrong, please open an issue and
+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.
 
 ### Debugging locally
@@ -208,7 +216,7 @@ end
 
 ### Integration testing
 
-```
+```Bash
 rake play
 cd template
 rake kennel:plan

data/lib/kennel/importer.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Kennel
+  class Importer
+    SORT_ORDER = [:title, :id, :description, :template_variables].freeze
+
+    # TODO: make model diff normalization reusable
+    IGNORED = Models::Base::READONLY_ATTRIBUTES - [:id] + [:created_by, :read_only]
+
+    def initialize(api)
+      @api = api
+    end
+
+    def import(resource, id)
+      data = @api.show(resource, id)
+      case resource
+      when "dash"
+        data = data[:dash]
+        IGNORED.each { |k| data.delete(k) }
+        <<~RUBY
+          Kennel::Models::Dash.new(
+            self,
+            #{pretty_print(data).lstrip}
+          )
+        RUBY
+      else
+        raise ArgumentError, "#{resource} is not supported"
+      end
+    end
+
+    private
+
+    def pretty_print(hash)
+      list = hash.sort_by { |k, _| SORT_ORDER.index(k) || 999 }
+      list.map do |k, v|
+        case v
+        when Hash, Array
+          pretty = JSON.pretty_generate(v)
+            .gsub(/(^\s*)"(.*?)":/, "\\1\\2:") # "foo": 1 -> foo: 1
+            .gsub(/^/, "    ") # indent
+          "  #{k}: -> {\n#{pretty}\n  }"
+        else
+          "  #{k}: -> { #{v.inspect} }"
+        end
+      end.join(",\n")
+    end
+  end
+end

data/lib/kennel/models/dash.rb

@@ -34,7 +34,7 @@ module Kennel
           id: id,
           title: "#{title}#{LOCK}",
           description: description,
-          read_only: false,
+          read_only: false, # TODO: delete it instead
           template_variables: render_template_variables,
           graphs: render_graphs
         }
@@ -102,6 +102,7 @@ module Kennel
           graph
         end + graphs
 
+        # TODO: solve this via ignore-defaults
         all.each do |g|
           g[:definition][:autoscale] = true unless g[:definition].key?(:autoscale)
         end

data/lib/kennel/tasks.rb

@@ -2,6 +2,7 @@
 require "English"
 require "kennel"
 require "kennel/unmuted_alerts"
+require "kennel/importer"
 
 namespace :kennel do
   desc "Ensure there are no uncommited changes that would be hidden from PR reviewers"
@@ -49,6 +50,13 @@ namespace :kennel do
     Kennel::UnmutedAlerts.print(Kennel.send(:api), tag)
   end
 
+  desc "Covert existing resources to copy-pastable definitions to import existing resources RESOURCE=dash ID=1234"
+  task import: :environment do
+    resource = ENV["RESOURCE"] || abort("Call with RESOURCE=dash") # TODO: add others
+    id = Integer(ENV["ID"] || abort("Call with ID=1234"))
+    puts Kennel::Importer.new(Kennel.send(:api)).import(resource, id)
+  end
+
   task :environment do
     require "kennel"
     gem "dotenv"

data/lib/kennel/version.rb

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

data/template/Readme.md

@@ -29,7 +29,7 @@ Keep datadog monitors/dashboards/etc in version control, avoid chaotic managemen
 
 ### Adding a team
 
-```ruby
+```Ruby
 # teams/my_team.rb
 module Teams
   class MyTeam < Kennel::Models::Team
@@ -127,6 +127,14 @@ end
   end
  ```
 
+### Importing an existing resources
+
+```Bash
+RESOURCE=dash ID=12345 rake kennel:import
+```
+
+Put returned definition into a project of your choice.
+
 ### Adding a new screenboard
  - similar to `dash.rb`
  - add to `parts:` list
@@ -146,7 +154,7 @@ end
 
 ### Skipping validations
 
-Some validations might be too strict for your usecase or just wrong, please open an issue and
+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.
 
 ### Debugging locally

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kennel
 version: !ruby/object:Gem::Version
-  version: 1.16.2
+  version: 1.17.0
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-09 00:00:00.000000000 Z
+date: 2018-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -49,6 +49,7 @@ files:
 - lib/kennel/api.rb
 - lib/kennel/file_cache.rb
 - lib/kennel/github_reporter.rb
+- lib/kennel/importer.rb
 - lib/kennel/models/base.rb
 - lib/kennel/models/dash.rb
 - lib/kennel/models/monitor.rb