kennel 1.138.1 → 1.139.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e344f2fab0aa5769a5f3baee97afed596a11cad4ab70fc395f1f3a752b9d54d
-  data.tar.gz: 669cf17997c36cbb5f1fa0f8afdf4241adbca108dee8d5a9d7f392ebb0f19098
+  metadata.gz: 33d7570c6b4d70c6d50f89d0111d8db96e6c0c0ba9273d00bb0975acfef12526
+  data.tar.gz: ea89fdf62138917a204e9c619a7a1182acca1e8d898f22e16707d0a02685cd26
 SHA512:
-  metadata.gz: ad8d65bc645f5499a4b4da18457100d31a2915ec3103f8daefd0c440879b889521177a425d36e94d8670543a2ef111f2b774a4b17cf741920c61b8e5f6cdf689
-  data.tar.gz: 13f5f3cce0a002036381de98c58a5002af272f5bfbf5ae710502fb3caeb1ac292d38554e8462cc43dae59936eca351ca47d4cc9f4e8ad23c4c5332263b2c2d51
+  metadata.gz: de01f19064531cb09615b63056b1eaa82118a4734fbdd9afa44eef56019923a736b45f9f4440da584cd0939231f7d7928f9a819cbfdb2f014336e82ee0f66c7e
+  data.tar.gz: ec59ee486794d91f5af93e8b3f77134ff206b6f653cc424c3e337b6893fefef1a6fb92a401029e2f5fd4ca83db49c1d284bf556105ad6d38667b3825667bb973

data/lib/kennel/models/dashboard.rb

@@ -3,6 +3,7 @@ module Kennel
   module Models
     class Dashboard < Record
       include TemplateVariables
+      include TagsValidation
 
       READONLY_ATTRIBUTES = superclass::READONLY_ATTRIBUTES + [
         :author_handle, :author_name, :modified_at, :deleted_at, :url, :is_read_only, :notify_list, :restricted_roles
@@ -158,7 +159,7 @@ module Kennel
           template_variables: render_template_variables,
           template_variable_presets: template_variable_presets,
           widgets: all_widgets,
-          tags: tags.grep(TAG_PREFIX).uniq
+          tags: tags.grep(TAG_PREFIX)
         )
 
         json[:reflow_type] = reflow_type if reflow_type # setting nil breaks create with "ordered"
@@ -222,8 +223,6 @@ module Kennel
       def validate_json(data)
         super
 
-        validate_template_variables data
-
         # Avoid diff from datadog presets sorting.
         presets = data[:template_variable_presets]
         if presets && presets != presets.sort_by { |p| p[:name] }

data/lib/kennel/models/monitor.rb

@@ -2,6 +2,8 @@
 module Kennel
   module Models
     class Monitor < Record
+      include TagsValidation
+
       RENOTIFY_INTERVALS = [0, 10, 20, 30, 40, 50, 60, 90, 120, 180, 240, 300, 360, 720, 1440].freeze # minutes
       OPTIONAL_SERVICE_CHECK_THRESHOLDS = [:ok, :warning].freeze
       READONLY_ATTRIBUTES = superclass::READONLY_ATTRIBUTES + [
@@ -67,7 +69,7 @@ module Kennel
           type: type,
           query: query.strip,
           message: message.strip,
-          tags: tags.uniq,
+          tags: tags,
           priority: priority,
           options: {
             timeout_h: timeout_h,

data/lib/kennel/models/record.rb

@@ -162,7 +162,7 @@ module Kennel
       def as_json
         # A courtesy to those tests that still expect as_json to perform validation and raise on error
         build if @unfiltered_validation_errors.nil?
-        raise UnvalidatedRecordError, "#{safe_tracking_id} as_json called on invalid part" unless filtered_validation_errors.empty?
+        raise UnvalidatedRecordError, "#{safe_tracking_id} as_json called on invalid part" if filtered_validation_errors.any?
 
         @as_json
       end

data/lib/kennel/models/slo.rb

@@ -2,6 +2,8 @@
 module Kennel
   module Models
     class Slo < Record
+      include TagsValidation
+
       READONLY_ATTRIBUTES = superclass::READONLY_ATTRIBUTES + [:type_id, :monitor_tags, :target_threshold, :timeframe, :warning_threshold]
       TRACKING_FIELD = :description
       DEFAULTS = {
@@ -29,7 +31,7 @@ module Kennel
           description: description,
           thresholds: thresholds,
           monitor_ids: monitor_ids,
-          tags: tags.uniq,
+          tags: tags,
           type: type
         )
 
@@ -84,6 +86,13 @@ module Kennel
       def validate_json(data)
         super
 
+        # datadog does not allow uppercase tags for slos
+        bad_tags = data[:tags].grep(/[A-Z]/)
+        if bad_tags.any?
+          invalid! :tags_are_upper_case, "Tags must not be upper case (bad tags: #{bad_tags.sort.inspect})"
+        end
+
+        # warning must be <= critical
         if data[:thresholds].any? { |t| t[:warning] && t[:warning].to_f <= t[:critical].to_f }
           invalid! :warning_must_be_gt_critical, "Threshold warning must be greater-than critical value"
         end

data/lib/kennel/models/synthetic_test.rb

@@ -2,6 +2,8 @@
 module Kennel
   module Models
     class SyntheticTest < Record
+      include TagsValidation
+
       TRACKING_FIELD = :message
       DEFAULTS = {}.freeze
       READONLY_ATTRIBUTES = superclass::READONLY_ATTRIBUTES + [:status, :monitor_id]

data/lib/kennel/optional_validations.rb

@@ -73,7 +73,7 @@ module Kennel
 
         unused_ignores = ignored_errors - unfiltered_validation_errors.map(&:tag)
 
-        unless unused_ignores.empty?
+        if unused_ignores.any?
           to_report << ValidationMessage.new(UNIGNORABLE, "Unused ignores #{unused_ignores.map(&:inspect).sort.uniq.join(" ")}. Remove these from `ignored_errors`")
         end
 

data/lib/kennel/tags_validation.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module Kennel
+  module TagsValidation
+    def validate_json(data)
+      super
+
+      # ideally we'd avoid duplicated tags, but that happens regularly when importing existing monitors
+      data[:tags] = data[:tags].uniq
+
+      # keep tags clean (TODO: reduce this list)
+      bad_tags = data[:tags].grep(/[^A-Za-z:_0-9.\/*@!#-]/)
+      invalid! :tags_invalid, "Only use A-Za-z:_0-9./*@!#- in tags (bad tags: #{bad_tags.sort.inspect})" if bad_tags.any?
+    end
+  end
+end

data/lib/kennel/template_variables.rb

@@ -16,7 +16,7 @@ module Kennel
 
     # check for queries that do not use the variables and would be misleading
     # TODO: do the same check for apm_query and their group_by
-    def validate_template_variables(data)
+    def validate_json(data)
       variables = (data[:template_variables] || []).map { |v| "$#{v.fetch(:name)}" }
       return if variables.empty?
 

data/lib/kennel/version.rb

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

data/lib/kennel.rb

@@ -13,6 +13,7 @@ require "kennel/filter"
 require "kennel/parts_serializer"
 require "kennel/projects_provider"
 require "kennel/attribute_differ"
+require "kennel/tags_validation"
 require "kennel/syncer"
 require "kennel/id_map"
 require "kennel/api"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kennel
 version: !ruby/object:Gem::Version
-  version: 1.138.1
+  version: 1.139.0
 platform: ruby
 authors:
 - Michael Grosser
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-19 00:00:00.000000000 Z
+date: 2023-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diff-lcs
@@ -116,6 +116,7 @@ files:
 - lib/kennel/syncer/plan_displayer.rb
 - lib/kennel/syncer/resolver.rb
 - lib/kennel/syncer/types.rb
+- lib/kennel/tags_validation.rb
 - lib/kennel/tasks.rb
 - lib/kennel/template_variables.rb
 - lib/kennel/unmuted_alerts.rb